Undo command to track entering and leaving ComponentMode. More...

#include <ComponentModeCommand.h>

Inherits AzToolsFramework::UndoSystem::URSequencePoint.

Public Types
enum class	Transition { Enter , Leave }
	Type of transition - did we enter or leave ComponentMode.

Public Types inherited from AzToolsFramework::UndoSystem::URSequencePoint
typedef AZStd::vector< URSequencePoint * >	ChildVec

typedef AZStd::function< void(URSequencePoint *) >	ApplyOperationCB

Public Member Functions
	AZ_CLASS_ALLOCATOR (ComponentModeCommand, AZ::SystemAllocator)

	AZ_RTTI (ComponentModeCommand, "{6D574E94-4D67-47D8-8C93-825BF82E2A28}")

	ComponentModeCommand (Transition transition, const AZStd::string &friendlyName, const AZStd::vector< EntityAndComponentModeBuilders > &componentModeBuilders)

void	Undo () override

void	Redo () override

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

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

Additional Inherited Members
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::UndoSystem::URSequencePoint
AZStd::string	m_friendlyName

URCommandID	m_id

ChildVec	m_children

URSequencePoint *	m_parent

bool	m_isPosted

Detailed Description

Undo command to track entering and leaving ComponentMode.

Member Function Documentation

◆ Changed()

bool AzToolsFramework::ComponentModeFramework::ComponentModeCommand::Changed ( ) const

inlineoverridevirtual

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)

Implements AzToolsFramework::UndoSystem::URSequencePoint.