Cogs::Core::ModalEditorCommand Struct Reference

Abstract base class for all editor commands showing GUI in interactive mode. More...

#include <EditorCommand.h>

Inheritance diagram for Cogs::Core::ModalEditorCommand:

Public Member Functions
	ModalEditorCommand (EditorState *state)
virtual void	beginModal ()=0
	Called when the command is initiated.
virtual void	showGui ()=0
	Display custom ImGUI.
virtual bool	continueModal ()=0
	Shall return true while the GUI should still be shown. False when.
Public Member Functions inherited from Cogs::Core::EditorCommand
	EditorCommand (EditorState *state, Context *context)
virtual void	apply ()=0
	Run the command.
virtual void	undo ()=0
virtual void	redo ()
virtual bool	mergeWith (const EditorCommand *)
virtual MeshHandle	applyMesh (MeshHandle)
	Workaround for having extendable mesh processing available without linking (e.g command -> RR).
virtual void	close ()
	Close command, i.e. prevent merging with another command.
bool	isClosed () const
bool	merge (const EditorCommand *command)
	Merge into this if not this is closed.

Additional Inherited Members
Public Attributes inherited from Cogs::Core::EditorCommand
std::vector< ParsedValue >	options
	Options passed to the command when running in batch mode.
bool	permanentUndo = false
	True if cannot Redo after Undo.
Protected Attributes inherited from Cogs::Core::EditorCommand
EditorState *	state = nullptr
Context *	context = nullptr

Detailed Description

Abstract base class for all editor commands showing GUI in interactive mode.

Definition at line 39 of file EditorCommand.h.

Constructor & Destructor Documentation

ModalEditorCommand()

Cogs::Core::ModalEditorCommand::ModalEditorCommand ( EditorState *  state )

inline

Definition at line 41 of file EditorCommand.h.

Member Function Documentation

beginModal()

virtual void Cogs::Core::ModalEditorCommand::beginModal ( )

pure virtual

Called when the command is initiated.

Implemented in Cogs::Core::AboutCommand, Cogs::Core::LoadRvmCommand, Cogs::Core::NoOpModalCommand, Cogs::Core::AbstractLiveUpdateCommand, Cogs::Core::ShowLicensesCommand, Cogs::Core::RRMultiSimplifyCommand, Cogs::Core::RRSaveAllLodCommand, and Cogs::Core::RRSimplifiyCommand.

continueModal()

virtual bool Cogs::Core::ModalEditorCommand::continueModal ( )

pure virtual

Shall return true while the GUI should still be shown. False when.

Implemented in Cogs::Core::AboutCommand, Cogs::Core::LoadRvmCommand, Cogs::Core::NoOpModalCommand, Cogs::Core::AbstractLiveUpdateCommand, Cogs::Core::ShowLicensesCommand, Cogs::Core::RRMultiSimplifyCommand, Cogs::Core::RRSaveAllLodCommand, and Cogs::Core::RRSimplifiyCommand.

showGui()

virtual void Cogs::Core::ModalEditorCommand::showGui ( )

pure virtual

Display custom ImGUI.

Implemented in Cogs::Core::AboutCommand, Cogs::Core::LoadRvmCommand, Cogs::Core::NoOpModalCommand, Cogs::Core::AbstractLiveUpdateCommand, Cogs::Core::GenerateNormalsCommand, Cogs::Core::UniqueVerticesCommand, Cogs::Core::ShowLicensesCommand, Cogs::Core::RRMultiSimplifyCommand, Cogs::Core::RRSaveAllLodCommand, and Cogs::Core::RRSimplifiyCommand.

---

The documentation for this struct was generated from the following file:

• Extensions/Editor/Source/Commands/EditorCommand.h