Open 3D Engine AzToolsFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzToolsFramework::Prefab::PrefabUndoEntityUpdate Class Reference

Undo class for handling update of an entity to a prefab template. More...

#include <PrefabUndo.h>

Inherits AzToolsFramework::Prefab::PrefabUndoBase.

Public Member Functions

 AZ_RTTI (PrefabUndoEntityUpdate, "{6D60C5A6-9535-45B3-8897-E5F6382FDC93}", PrefabUndoBase)
 
 AZ_CLASS_ALLOCATOR (PrefabUndoEntityUpdate, AZ::SystemAllocator)
 
 PrefabUndoEntityUpdate (const AZStd::string &undoOperationName)
 
void Capture (const PrefabDomValue &initialState, const PrefabDomValue &endState, AZ::EntityId entity, bool updateCache=true)
 
void Undo () override
 
void Redo () override
 
void Redo (InstanceOptionalConstReference instanceToExclude) override
 Overload to allow to apply the change, but prevent instanceToExclude from being refreshed.
 
- Public Member Functions inherited from AzToolsFramework::Prefab::PrefabUndoBase
 AZ_RTTI (PrefabUndoBase, "{C86BFA2B-E042-40FC-B5C6-1838030B34BF}", UndoSystem::URSequencePoint)
 
 AZ_CLASS_ALLOCATOR (PrefabUndoBase, AZ::SystemAllocator)
 
 PrefabUndoBase (const AZStd::string &undoOperationName)
 
bool Changed () const override
 
void Undo () override
 
void Redo () override
 
virtual void Redo (InstanceOptionalConstReference instanceToExclude)
 Overload to allow to apply the change, but prevent instanceToExclude from being refreshed.
 
- Public Member Functions inherited from AzToolsFramework::UndoSystem::URSequencePoint
 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
 
URSequencePointFind (URCommandID id, const AZ::Uuid &typeOfCommand)
 
void SetName (const AZStd::string &friendlyName)
 
AZStd::string & GetName ()
 
void SetParent (URSequencePoint *parent)
 
URSequencePointGetParent () 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
 

Additional Inherited Members

- Public Types inherited from AzToolsFramework::UndoSystem::URSequencePoint
typedef AZStd::vector< URSequencePoint * > ChildVec
 
typedef AZStd::function< void(URSequencePoint *) > ApplyOperationCB
 
- Public Attributes inherited from AzToolsFramework::UndoSystem::URSequencePoint
friend UndoStack
 
- Protected Member Functions inherited from AzToolsFramework::UndoSystem::URSequencePoint
void AddChild (URSequencePoint *)
 
void RemoveChild (URSequencePoint *)
 
- Protected Attributes inherited from AzToolsFramework::Prefab::PrefabUndoBase
PrefabDom m_redoPatch
 
PrefabDom m_undoPatch
 
TemplateId m_templateId
 
InstanceToTemplateInterfacem_instanceToTemplateInterface = nullptr
 
InstanceDomGeneratorInterfacem_instanceDomGeneratorInterface = nullptr
 
PrefabSystemComponentInterfacem_prefabSystemComponentInterface = nullptr
 
bool m_changed
 
- Protected Attributes inherited from AzToolsFramework::UndoSystem::URSequencePoint
AZStd::string m_friendlyName
 
URCommandID m_id
 
ChildVec m_children
 
URSequencePointm_parent
 
bool m_isPosted
 

Detailed Description

Undo class for handling update of an entity to a prefab template.

Member Function Documentation

◆ Redo() [1/2]

void AzToolsFramework::Prefab::PrefabUndoEntityUpdate::Redo ( )
overridevirtual

◆ Redo() [2/2]

void AzToolsFramework::Prefab::PrefabUndoEntityUpdate::Redo ( InstanceOptionalConstReference  instanceToExclude)
overridevirtual

Overload to allow to apply the change, but prevent instanceToExclude from being refreshed.

Reimplemented from AzToolsFramework::Prefab::PrefabUndoBase.

◆ Undo()

void AzToolsFramework::Prefab::PrefabUndoEntityUpdate::Undo ( )
overridevirtual

Usage: override with class specific actions

Reimplemented from AzToolsFramework::UndoSystem::URSequencePoint.


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