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::SliceDetachEntityCommand Class Reference

#include <SliceDetachEntityCommand.h>

Inherits AzToolsFramework::BaseSliceCommand.

Public Member Functions

 AZ_CLASS_ALLOCATOR (SliceDetachEntityCommand, AZ::SystemAllocator)
 
 AZ_RTTI (SliceDetachEntityCommand, "{FD26D09E-FD95-4D8C-8575-E01DA7100240}")
 
 SliceDetachEntityCommand (const AzToolsFramework::EntityIdList &entityIds, const AZStd::string &friendlyName)
 
void Undo () override
 
void Redo () override
 
- Public Member Functions inherited from AzToolsFramework::BaseSliceCommand
 AZ_CLASS_ALLOCATOR (BaseSliceCommand, AZ::SystemAllocator)
 
 AZ_RTTI (BaseSliceCommand, "{87CB1C80-7D75-423B-964A-CF1964A9AB26}")
 
 BaseSliceCommand (const AZStd::string &friendlyName)
 
void Undo () override=0
 
void Redo () override=0
 
bool Changed () const override
 
- 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
 

Protected Attributes

AzToolsFramework::EntityIdList m_entityIds
 
- Protected Attributes inherited from AzToolsFramework::BaseSliceCommand
AZ::SliceComponent::EntityRestoreInfoList m_entityRedoRestoreInfoArray
 
AZ::SliceComponent::EntityRestoreInfoList m_entityUndoRestoreInfoArray
 
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
 

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::BaseSliceCommand
bool CaptureRestoreInfoForUndo (const AZ::EntityId &entityId)
 
void RestoreEntities (AZ::SliceComponent::EntityRestoreInfoList &entitiesToRestore, bool clearRestoreList=false, SliceEntityRestoreType restoreType=SliceEntityRestoreType::Detached)
 
- Protected Member Functions inherited from AzToolsFramework::UndoSystem::URSequencePoint
void AddChild (URSequencePoint *)
 
void RemoveChild (URSequencePoint *)
 

Detailed Description

Stores information about Entities that are being detached from their slice

Member Function Documentation

◆ Redo()

void AzToolsFramework::SliceDetachEntityCommand::Redo ( )
overridevirtual

◆ Undo()

void AzToolsFramework::SliceDetachEntityCommand::Undo ( )
overridevirtual

Usage: override with class specific actions

Implements AzToolsFramework::BaseSliceCommand.


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