Inherits MCore::Command, EMotionFX::ParameterMixinActorId, and EMotionFX::ParameterMixinJointName.

Public Member Functions
AZ_CLASS_ALLOCATOR_DECL	CommandAddCollider (MCore::Command *orgCommand=nullptr)

	CommandAddCollider (AZ::u32 actorId, const AZStd::string &jointName, PhysicsSetup::ColliderConfigType configType, const AZ::TypeId &colliderType, MCore::Command *orgCommand=nullptr)

	CommandAddCollider (AZ::u32 actorId, const AZStd::string &jointName, PhysicsSetup::ColliderConfigType configType, const AZStd::string &contents, size_t insertAtIndex, MCore::Command *orgCommand=nullptr)

bool	Execute (const MCore::CommandLine &parameters, AZStd::string &outResult) override

bool	Undo (const MCore::CommandLine &parameters, AZStd::string &outResult) override

void	InitSyntax () override

bool	SetCommandParameters (const MCore::CommandLine &parameters) override

bool	GetIsUndoable () const override

const char *	GetHistoryName () const override

const char *	GetDescription () const override

MCore::Command *	Create () override

Public Member Functions inherited from MCore::Command
	Command (AZStd::string commandName, Command *originalCommand)

virtual	~Command ()

virtual bool	Execute (const CommandLine &parameters, AZStd::string &outResult)=0

virtual bool	Undo (const CommandLine &parameters, AZStd::string &outResult)

virtual Command *	Create ()=0

virtual bool	GetIsUndoable () const

virtual void	InitSyntax ()

virtual bool	SetCommandParameters (const CommandLine &parameters)

virtual const char *	GetDescription () const

virtual const char *	GetHistoryName () const

const char *	GetName () const

const AZStd::string &	GetNameString () const

MCORE_INLINE CommandSyntax &	GetSyntax ()

size_t	GetNumCallbacks () const

size_t	CalcNumPreCommandCallbacks () const

size_t	CalcNumPostCommandCallbacks () const

MCORE_INLINE Command::Callback *	GetCallback (size_t index)

void	AddCallback (Command::Callback *callback)

bool	CheckIfHasCallback (Command::Callback *callback) const

void	RemoveCallback (Command::Callback *callback, bool delFromMem=true)

void	RemoveAllCallbacks ()

void	SetOriginalCommand (Command *orgCommand)

MCORE_INLINE Command *	GetOriginalCommand ()

template<class T >
void	ExecuteParameter (AZStd::optional< T > &oldParameter, AZStd::optional< T > &parameter, T &value)

Public Member Functions inherited from EMotionFX::ParameterMixinActorId
	ParameterMixinActorId (AZ::u32 actorId)

void	InitSyntax (MCore::CommandSyntax &syntax, bool isParameterRequired=true)

bool	SetCommandParameters (const MCore::CommandLine &parameters)

void	SetActorId (AZ::u32 actorId)

AZ::u32	GetActorId () const

Actor *	GetActor (const MCore::Command *command, AZStd::string &outResult) const

Public Member Functions inherited from EMotionFX::ParameterMixinJointName
	ParameterMixinJointName (const AZStd::string &jointName)

void	InitSyntax (MCore::CommandSyntax &syntax, bool isParameterRequired=true)

bool	SetCommandParameters (const MCore::CommandLine &parameters)

void	SetJointName (const AZStd::string &jointName)

const AZStd::string &	GetJointName () const

Static Public Member Functions
static void	Reflect (AZ::ReflectContext *context)

Static Public Member Functions inherited from MCore::Command
static void	Reflect (AZ::ReflectContext *context)

Static Public Member Functions inherited from EMotionFX::ParameterMixinActorId
static void	Reflect (AZ::ReflectContext *context)

Static Public Member Functions inherited from EMotionFX::ParameterMixinJointName
static void	Reflect (AZ::ReflectContext *context)

Static Public Attributes
static const char *	s_commandName

static const char *	s_colliderConfigTypeParameterName

static const char *	s_colliderTypeParameterName

static const char *	s_contentsParameterName

static const char *	s_insertAtIndexParameterName

Static Public Attributes inherited from EMotionFX::ParameterMixinActorId
static const char *	s_actorIdParameterName = "actorId"

Static Public Attributes inherited from EMotionFX::ParameterMixinJointName
static const char *	s_jointNameParameterName = "jointName"

Additional Inherited Members
Protected Attributes inherited from EMotionFX::ParameterMixinActorId
AZ::u32	m_actorId = MCORE_INVALIDINDEX32

Protected Attributes inherited from EMotionFX::ParameterMixinJointName
AZStd::string	m_jointName

Member Function Documentation

◆ Create()

MCore::Command * EMotionFX::CommandAddCollider::Create ( )

inlineoverridevirtual

This will be called by the CommandManager when the command is executed. The function will return an instance of the command implementation which will be stored in the command history. An instance of the called command is needed to be able to store information for the undo.

Returns: The instance of the command.

Implements MCore::Command.

◆ Execute()

bool EMotionFX::CommandAddCollider::Execute	(	const MCore::CommandLine &	parameters,
		AZStd::string &	outResult
	)

overridevirtual

The do it method should call redo it to make the command happen. The redo it method should do the actual work. This is a pure virtual method, and must be overridden in derived commands.

Parameters

parameters	A list of the passed command arguments.
outResult	The result/return value of the command.

Returns: True if the command execution succeeded, false if not.

Implements MCore::Command.

◆ GetDescription()

const char * EMotionFX::CommandAddCollider::GetDescription ( ) const

overridevirtual

Get the command optional description. This can contain additional detailed information about the command.

Returns: A string containing the description of the command, which is optional. On default it is an empty string.

Reimplemented from MCore::Command.

◆ GetHistoryName()

const char * EMotionFX::CommandAddCollider::GetHistoryName ( ) const

inlineoverridevirtual

Get the name of the command as it can be shown in the command history. This can be a nicer name than the actual command name. For example some "MyAPILoadActor" command could be shown in the command history to the user with a more friendly name like "Load Actor". The "Load Actor" string could be returned by this function. On default the command name is returned.

Returns: The user-friendly name of the command.

Reimplemented from MCore::Command.

◆ GetIsUndoable()

bool EMotionFX::CommandAddCollider::GetIsUndoable ( ) const

inlineoverridevirtual

This method is used to specify whether or not the command is undoable. On default, when not overloaded, it always returns false. If you are writing a command that might be eligible for undo, you should override this method. The is undoable method will be called and used to indicate whether or not the command will be saved in the command history in the command manager.

Returns: True if the command is undoable and should be saved in the command history, false if not.

Reimplemented from MCore::Command.

◆ InitSyntax()

void EMotionFX::CommandAddCollider::InitSyntax ( )

overridevirtual

Initialize the command syntax. This is automatically called by the command constructor. On default the syntax will be empty, which means the command would have no parameters.

Reimplemented from MCore::Command.

◆ SetCommandParameters()

bool EMotionFX::CommandAddCollider::SetCommandParameters ( const MCore::CommandLine & parameters )

overridevirtual

Reimplemented from MCore::Command.

◆ Undo()

bool EMotionFX::CommandAddCollider::Undo	(	const MCore::CommandLine &	parameters,
		AZStd::string &	outResult
	)

overridevirtual

This method should undo the work done be the redo it method. This is a pure virtual method, and must be overridden in derived commands.

Parameters

parameters	A list of the passed command arguments.
outResult	The result/return value of the command.

Returns: True if the command undo succeeded, false if not.

Reimplemented from MCore::Command.

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

Gems/EMotionFX/Code/EMotionFX/CommandSystem/Source/ColliderCommands.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Function Documentation

◆ Create()

◆ Execute()

◆ GetDescription()

◆ GetHistoryName()

◆ GetIsUndoable()

◆ InitSyntax()

◆ SetCommandParameters()

◆ Undo()