Cogs.Core
Public Member Functions | Private Attributes | List of all members
Cogs::Core::ShowLicensesCommand Struct Reference
Inheritance diagram for Cogs::Core::ShowLicensesCommand:
Cogs::Core::ModalEditorCommand Cogs::Core::EditorCommand

Public Member Functions

 ShowLicensesCommand (EditorState *state)
 
void apply () override
 Run the command.
 
void undo () override
 
void beginModal () override
 Called when the command is initiated.
 
void showGui () override
 Display custom ImGUI.
 
bool continueModal () override
 Shall return true while the GUI should still be shown. False when.
 
- Public Member Functions inherited from Cogs::Core::ModalEditorCommand
 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.
 

Private Attributes

bool modal = false
 
const char * licensesText = nullptr
 
ImGui::MarkdownConfig config
 

Additional Inherited Members

- Public Attributes inherited from Cogs::Core::EditorCommand
std::vector< ParsedValueoptions
 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
EditorStatestate = nullptr
 
Contextcontext = nullptr
 

Detailed Description

Definition at line 7 of file ShowLicensesCommand.h.

Constructor & Destructor Documentation

◆ ShowLicensesCommand()

Cogs::Core::ShowLicensesCommand::ShowLicensesCommand ( EditorState state)

Definition at line 14 of file ShowLicensesCommand.cpp.

Member Function Documentation

◆ apply()

void Cogs::Core::ShowLicensesCommand::apply ( )
inlineoverridevirtual

Run the command.

In batch scripts this method is called for all type of commands. In interactive mode this method is not called for model commands (subclasses of ModalEditorCommand)

Implements Cogs::Core::EditorCommand.

Definition at line 11 of file ShowLicensesCommand.h.

◆ beginModal()

void Cogs::Core::ShowLicensesCommand::beginModal ( )
overridevirtual

Called when the command is initiated.

Implements Cogs::Core::ModalEditorCommand.

Definition at line 22 of file ShowLicensesCommand.cpp.

◆ continueModal()

bool Cogs::Core::ShowLicensesCommand::continueModal ( )
overridevirtual

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

Implements Cogs::Core::ModalEditorCommand.

Definition at line 53 of file ShowLicensesCommand.cpp.

◆ showGui()

void Cogs::Core::ShowLicensesCommand::showGui ( )
overridevirtual

Display custom ImGUI.

Implements Cogs::Core::ModalEditorCommand.

Definition at line 27 of file ShowLicensesCommand.cpp.

◆ undo()

void Cogs::Core::ShowLicensesCommand::undo ( )
inlineoverridevirtual

Implements Cogs::Core::EditorCommand.

Definition at line 12 of file ShowLicensesCommand.h.

Member Data Documentation

◆ config

ImGui::MarkdownConfig Cogs::Core::ShowLicensesCommand::config
private

Definition at line 20 of file ShowLicensesCommand.h.

◆ licensesText

const char* Cogs::Core::ShowLicensesCommand::licensesText = nullptr
private

Definition at line 19 of file ShowLicensesCommand.h.

◆ modal

bool Cogs::Core::ShowLicensesCommand::modal = false
private

Definition at line 18 of file ShowLicensesCommand.h.


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