Cogs.Core
Public Member Functions | Protected Attributes | List of all members
Cogs::Core::AbstractLiveUpdateCommand Struct Referenceabstract
Inheritance diagram for Cogs::Core::AbstractLiveUpdateCommand:
Cogs::Core::ModalEditorCommand Cogs::Core::EditorCommand Cogs::Core::GenerateNormalsCommand Cogs::Core::UniqueVerticesCommand

Public Member Functions

 AbstractLiveUpdateCommand (EditorState *state, uint32_t primitiveMask=~0u)
 
void beginModal () override
 Called when the command is initiated.
 
bool continueModal () override
 Shall return true while the GUI should still be shown. False when.
 
void showGui () override
 Display custom ImGUI.
 
void undo () override
 
virtual bool issueTask ()=0
 
- 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.
 

Protected Attributes

UnpackOptions opts
 
uint32_t primitiveMask
 
bool modal = false
 
bool dirty = false
 
std::atomic< bool > running = false
 
std::atomic< bool > cancel = false
 
MeshItems items
 
MeshReps meshes
 
MeshReps newMeshes
 
std::vector< MeshHandleoriginalMeshes
 
TaskId task = NoTask
 
- Protected Attributes inherited from Cogs::Core::EditorCommand
EditorStatestate = nullptr
 
Contextcontext = nullptr
 

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.
 

Detailed Description

Definition at line 31 of file MeshOpCommands.h.

Constructor & Destructor Documentation

◆ AbstractLiveUpdateCommand()

Cogs::Core::AbstractLiveUpdateCommand::AbstractLiveUpdateCommand ( EditorState state,
uint32_t  primitiveMask = ~0u 
)
inline

Definition at line 33 of file MeshOpCommands.h.

Member Function Documentation

◆ beginModal()

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

Called when the command is initiated.

Implements Cogs::Core::ModalEditorCommand.

Definition at line 65 of file MeshOpCommands.cpp.

◆ continueModal()

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

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

Implements Cogs::Core::ModalEditorCommand.

Definition at line 79 of file MeshOpCommands.cpp.

◆ showGui()

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

◆ undo()

void Cogs::Core::AbstractLiveUpdateCommand::undo ( )
overridevirtual

Implements Cogs::Core::EditorCommand.

Definition at line 97 of file MeshOpCommands.cpp.

Member Data Documentation

◆ cancel

std::atomic<bool> Cogs::Core::AbstractLiveUpdateCommand::cancel = false
protected

Definition at line 49 of file MeshOpCommands.h.

◆ dirty

bool Cogs::Core::AbstractLiveUpdateCommand::dirty = false
protected

Definition at line 47 of file MeshOpCommands.h.

◆ items

MeshItems Cogs::Core::AbstractLiveUpdateCommand::items
protected

Definition at line 50 of file MeshOpCommands.h.

◆ meshes

MeshReps Cogs::Core::AbstractLiveUpdateCommand::meshes
protected

Definition at line 51 of file MeshOpCommands.h.

◆ modal

bool Cogs::Core::AbstractLiveUpdateCommand::modal = false
protected

Definition at line 46 of file MeshOpCommands.h.

◆ newMeshes

MeshReps Cogs::Core::AbstractLiveUpdateCommand::newMeshes
protected

Definition at line 52 of file MeshOpCommands.h.

◆ opts

UnpackOptions Cogs::Core::AbstractLiveUpdateCommand::opts
protected

Definition at line 44 of file MeshOpCommands.h.

◆ originalMeshes

std::vector<MeshHandle> Cogs::Core::AbstractLiveUpdateCommand::originalMeshes
protected

Definition at line 53 of file MeshOpCommands.h.

◆ primitiveMask

uint32_t Cogs::Core::AbstractLiveUpdateCommand::primitiveMask
protected

Definition at line 45 of file MeshOpCommands.h.

◆ running

std::atomic<bool> Cogs::Core::AbstractLiveUpdateCommand::running = false
protected

Definition at line 48 of file MeshOpCommands.h.

◆ task

TaskId Cogs::Core::AbstractLiveUpdateCommand::task = NoTask
protected

Definition at line 55 of file MeshOpCommands.h.


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