Inherited by AzToolsFramework::BaseSliceCommand, AzToolsFramework::ClearSliceDataFlagsBelowAddressCommand, AzToolsFramework::ComponentModeFramework::ComponentModeCommand, AzToolsFramework::EntityManipulatorCommand, AzToolsFramework::EntityStateCommand, AzToolsFramework::Prefab::PrefabFocusUndo, AzToolsFramework::Prefab::PrefabUndoBase, AzToolsFramework::Prefab::PrefabUndoComponentPropertyOverride, AzToolsFramework::Prefab::PrefabUndoEntityOverrides, AzToolsFramework::Prefab::PrefabUndoRevertOverrides, AzToolsFramework::SelectionCommand, AzToolsFramework::SliceDataFlagsCommand, and AzToolsFramework::UndoSystem::BatchCommand.
|
| URSequencePoint (const AZStd::string &friendlyName, URCommandID id=0) |
|
| URSequencePoint (URCommandID id) |
|
virtual | ~URSequencePoint () |
|
void | RunUndo () |
|
void | RunRedo () |
|
virtual void | Undo () |
|
virtual void | Redo () |
|
virtual bool | Changed () const =0 |
|
URSequencePoint * | Find (URCommandID id, const AZ::Uuid &typeOfCommand) |
|
void | SetName (const AZStd::string &friendlyName) |
|
AZStd::string & | GetName () |
|
void | SetParent (URSequencePoint *parent) |
|
URSequencePoint * | GetParent () const |
|
const ChildVec & | GetChildren () const |
|
bool | HasRealChildren () const |
|
void | ApplyToTree (const ApplyOperationCB &applyCB) |
|
bool | IsPosted () const |
|
bool | operator== (const URCommandID id) const |
|
bool | operator== (const URSequencePoint *com) const |
|
|
AZStd::string | m_friendlyName |
|
URCommandID | m_id |
|
ChildVec | m_children |
|
URSequencePoint * | m_parent |
|
bool | m_isPosted |
|
◆ ApplyOperationCB
Usage: pass a function callback that eats a URSequencePoint*
this walks the child tree and applies the callback to each URSequencePoint
example commandPtr->ApplyToTree( AZStd::bind(&MyClass::DoSomethingWithCommandPtr, this, AZStd::placeholders::_1) );
◆ URSequencePoint() [1/2]
AzToolsFramework::UndoSystem::URSequencePoint::URSequencePoint |
( |
const AZStd::string & |
friendlyName, |
|
|
URCommandID |
id = 0 |
|
) |
| |
|
explicit |
Usage: construct a standalone command which can both implement undo+redo and have children commands
◆ URSequencePoint() [2/2]
AzToolsFramework::UndoSystem::URSequencePoint::URSequencePoint |
( |
URCommandID |
id | ) |
|
|
explicit |
Usage: construct a child command which can both implement undo+redo and have children commands plus automatically create a friendly child name and append to the parent's children NB: Parent takes ownership of the allocation
◆ ~URSequencePoint()
virtual AzToolsFramework::UndoSystem::URSequencePoint::~URSequencePoint |
( |
| ) |
|
|
virtual |
Usage: base implementation automatically deletes all children recursively therefore only a topmost parent needs to be deleted from outside
◆ Changed()
virtual bool AzToolsFramework::UndoSystem::URSequencePoint::Changed |
( |
| ) |
const |
|
pure virtual |
Usage: override with class specific change comparison between undo/redo state. This allows the undo system to remove commands that have no actual effect (Eg: a command that changes a value from 5 to 5 has no effect and can be removed)
Implemented in AzToolsFramework::BaseSliceCommand, AzToolsFramework::ComponentModeFramework::ComponentModeCommand, AzToolsFramework::EntityManipulatorCommand, AzToolsFramework::EntityStateCommand, AzToolsFramework::SelectionCommand, AzToolsFramework::Prefab::PrefabFocusUndo, AzToolsFramework::Prefab::PrefabUndoBase, AzToolsFramework::Prefab::PrefabUndoComponentPropertyEdit, AzToolsFramework::Prefab::PrefabUndoComponentPropertyOverride, AzToolsFramework::Prefab::PrefabUndoEntityOverrides, AzToolsFramework::Prefab::PrefabUndoRevertOverrides, AzToolsFramework::SliceDataFlagsCommand, AzToolsFramework::ClearSliceDataFlagsBelowAddressCommand, and AzToolsFramework::UndoSystem::BatchCommand.
◆ Find()
URSequencePoint * AzToolsFramework::UndoSystem::URSequencePoint::Find |
( |
URCommandID |
id, |
|
|
const AZ::Uuid & |
typeOfCommand |
|
) |
| |
Usage: return the first command in the parent/child tree with a matching id returns NULL on failure to make any match
◆ Undo()
virtual void AzToolsFramework::UndoSystem::URSequencePoint::Undo |
( |
| ) |
|
|
virtual |
Usage: override with class specific actions
Reimplemented in AzToolsFramework::ComponentModeFramework::ComponentModeCommand, AzToolsFramework::CreateSliceCommand, AzToolsFramework::DetachSubsliceInstanceCommand, AzToolsFramework::EntityManipulatorCommand, AzToolsFramework::EntityStateCommand, AzToolsFramework::EntityDeleteCommand, AzToolsFramework::EntityCreateCommand, AzToolsFramework::PushToSliceCommand, AzToolsFramework::SelectionCommand, AzToolsFramework::SliceDetachEntityCommand, AzToolsFramework::Prefab::PrefabFocusUndo, AzToolsFramework::Prefab::PrefabUndoEntityUpdate, AzToolsFramework::Prefab::PrefabUndoInstanceLink, AzToolsFramework::Prefab::PrefabUndoBase, AzToolsFramework::Prefab::PrefabUndoComponentPropertyEdit, AzToolsFramework::Prefab::PrefabUndoComponentPropertyOverride, AzToolsFramework::Prefab::PrefabUndoEntityOverrides, AzToolsFramework::Prefab::PrefabUndoRevertOverrides, AzToolsFramework::Prefab::PrefabUndoUpdateLink, AzToolsFramework::SliceDataFlagsCommand, AzToolsFramework::ClearSliceDataFlagsBelowAddressCommand, and AzToolsFramework::BaseSliceCommand.
The documentation for this class was generated from the following file:
- Code/Framework/AzToolsFramework/AzToolsFramework/Undo/UndoSystem.h