Open 3D Engine EMotionFX Gem 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.
Public Member Functions | Static Public Attributes | List of all members
EMotionFX::Integration::AnimGraphComponentRequests Class Referenceabstract

#include <AnimGraphComponentBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual EMotionFX::AnimGraphInstance * GetAnimGraphInstance ()
 
virtual size_t FindParameterIndex (const char *parameterName)=0
 
virtual const char * FindParameterName (size_t parameterIndex)=0
 
virtual void SetParameterFloat (size_t parameterIndex, float value)=0
 
virtual void SetParameterBool (size_t parameterIndex, bool value)=0
 
virtual void SetParameterString (size_t parameterIndex, const char *value)=0
 
virtual void SetParameterVector2 (size_t parameterIndex, const AZ::Vector2 &value)=0
 
virtual void SetParameterVector3 (size_t parameterIndex, const AZ::Vector3 &value)=0
 
virtual void SetParameterRotationEuler (size_t parameterIndex, const AZ::Vector3 &value)=0
 
virtual void SetParameterRotation (size_t parameterIndex, const AZ::Quaternion &value)=0
 
virtual void SetNamedParameterFloat (const char *parameterName, float value)=0
 
virtual void SetNamedParameterBool (const char *parameterName, bool value)=0
 
virtual void SetNamedParameterString (const char *parameterName, const char *value)=0
 
virtual void SetNamedParameterVector2 (const char *parameterName, const AZ::Vector2 &value)=0
 
virtual void SetNamedParameterVector3 (const char *parameterName, const AZ::Vector3 &value)=0
 
virtual void SetNamedParameterRotationEuler (const char *parameterName, const AZ::Vector3 &value)=0
 
virtual void SetNamedParameterRotation (const char *parameterName, const AZ::Quaternion &value)=0
 
virtual void SetVisualizeEnabled (bool enabled)=0
 Enable or disable debug draw visualization inside the anim graph instance.
 
virtual float GetParameterFloat (size_t parameterIndex)=0
 
virtual bool GetParameterBool (size_t parameterIndex)=0
 
virtual AZStd::string GetParameterString (size_t parameterIndex)=0
 
virtual AZ::Vector2 GetParameterVector2 (size_t parameterIndex)=0
 
virtual AZ::Vector3 GetParameterVector3 (size_t parameterIndex)=0
 
virtual AZ::Vector3 GetParameterRotationEuler (size_t parameterIndex)=0
 
virtual AZ::Quaternion GetParameterRotation (size_t parameterIndex)=0
 
virtual float GetNamedParameterFloat (const char *parameterName)=0
 
virtual bool GetNamedParameterBool (const char *parameterName)=0
 
virtual AZStd::string GetNamedParameterString (const char *parameterName)=0
 
virtual AZ::Vector2 GetNamedParameterVector2 (const char *parameterName)=0
 
virtual AZ::Vector3 GetNamedParameterVector3 (const char *parameterName)=0
 
virtual AZ::Vector3 GetNamedParameterRotationEuler (const char *parameterName)=0
 
virtual AZ::Quaternion GetNamedParameterRotation (const char *parameterName)=0
 
virtual bool GetVisualizeEnabled ()=0
 Check whether debug visualization is enabled or not.
 
virtual void SyncAnimGraph (AZ::EntityId leaderEntityId)=0
 
virtual void DesyncAnimGraph (AZ::EntityId leaderEntityId)=0
 
virtual void SetActiveMotionSet (const char *activeMotionSetName)=0
 Set the name of the active motion set.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 

Detailed Description

EmotionFX Anim Graph Component Request Bus Used for making requests to the EMotionFX Anim Graph Components.

Member Function Documentation

◆ DesyncAnimGraph()

virtual void EMotionFX::Integration::AnimGraphComponentRequests::DesyncAnimGraph ( AZ::EntityId  leaderEntityId)
pure virtual

Making a request to desync from the anim graph to its leader graph

Parameters
leaderEntityId- the entity id of another anim graph.

◆ FindParameterIndex()

virtual size_t EMotionFX::Integration::AnimGraphComponentRequests::FindParameterIndex ( const char *  parameterName)
pure virtual

Retrieve parameter index for a given parameter name. Retrieving the index and using it to set parameter values is more performant than setting by name.

Parameters
parameterName- name of parameter for which to retrieve the index.
Returns
parameter index

◆ FindParameterName()

virtual const char * EMotionFX::Integration::AnimGraphComponentRequests::FindParameterName ( size_t  parameterIndex)
pure virtual

Retrieve parameter name for a given parameter index.

Parameters
parameterName- index of parameter for which to retrieve the name.
Returns
parameter name

◆ GetAnimGraphInstance()

virtual EMotionFX::AnimGraphInstance * EMotionFX::Integration::AnimGraphComponentRequests::GetAnimGraphInstance ( )
inlinevirtual

Retrieves the component's live graph instance.

Returns
pointer to anim graph instance.

◆ GetNamedParameterBool()

virtual bool EMotionFX::Integration::AnimGraphComponentRequests::GetNamedParameterBool ( const char *  parameterName)
pure virtual

Retrieves a anim graph property as a boolean value.

Parameters
parameterName- name of parameter to get

◆ GetNamedParameterFloat()

virtual float EMotionFX::Integration::AnimGraphComponentRequests::GetNamedParameterFloat ( const char *  parameterName)
pure virtual

Retrieves a anim graph property as a float value.

Parameters
parameterName- name of parameter to get

◆ GetNamedParameterRotation()

virtual AZ::Quaternion EMotionFX::Integration::AnimGraphComponentRequests::GetNamedParameterRotation ( const char *  parameterName)
pure virtual

Retrieves a anim graph property as a quaternion value.

Parameters
parameterName- name of parameter to get

◆ GetNamedParameterRotationEuler()

virtual AZ::Vector3 EMotionFX::Integration::AnimGraphComponentRequests::GetNamedParameterRotationEuler ( const char *  parameterName)
pure virtual

Retrieves a anim graph property given as euler rotation values.

Parameters
parameterName- name of parameter to get

◆ GetNamedParameterString()

virtual AZStd::string EMotionFX::Integration::AnimGraphComponentRequests::GetNamedParameterString ( const char *  parameterName)
pure virtual

Retrieves a anim graph property given a string value.

Parameters
parameterName- name of parameter to get

◆ GetNamedParameterVector2()

virtual AZ::Vector2 EMotionFX::Integration::AnimGraphComponentRequests::GetNamedParameterVector2 ( const char *  parameterName)
pure virtual

Retrieves a anim graph property as a Vector2 value.

Parameters
parameterName- name of parameter to get

◆ GetNamedParameterVector3()

virtual AZ::Vector3 EMotionFX::Integration::AnimGraphComponentRequests::GetNamedParameterVector3 ( const char *  parameterName)
pure virtual

Retrieves a anim graph property as a Vector3 value.

Parameters
parameterName- name of parameter to get

◆ GetParameterBool()

virtual bool EMotionFX::Integration::AnimGraphComponentRequests::GetParameterBool ( size_t  parameterIndex)
pure virtual

Retrieves a anim graph property as a boolean value.

Parameters
parameterIndex- index of parameter to set

◆ GetParameterFloat()

virtual float EMotionFX::Integration::AnimGraphComponentRequests::GetParameterFloat ( size_t  parameterIndex)
pure virtual

Retrieves a anim graph property as a float value.

Parameters
parameterIndex- index of parameter to set

◆ GetParameterRotation()

virtual AZ::Quaternion EMotionFX::Integration::AnimGraphComponentRequests::GetParameterRotation ( size_t  parameterIndex)
pure virtual

Retrieves a anim graph property as a quaternion value.

Parameters
parameterIndex- index of parameter to set

◆ GetParameterRotationEuler()

virtual AZ::Vector3 EMotionFX::Integration::AnimGraphComponentRequests::GetParameterRotationEuler ( size_t  parameterIndex)
pure virtual

Retrieves a anim graph property given as euler rotation values.

Parameters
parameterIndex- index of parameter to set

◆ GetParameterString()

virtual AZStd::string EMotionFX::Integration::AnimGraphComponentRequests::GetParameterString ( size_t  parameterIndex)
pure virtual

Retrieves a anim graph property given a string value.

Parameters
parameterIndex- index of parameter to set

◆ GetParameterVector2()

virtual AZ::Vector2 EMotionFX::Integration::AnimGraphComponentRequests::GetParameterVector2 ( size_t  parameterIndex)
pure virtual

Retrieves a anim graph property as a Vector2 value.

Parameters
parameterIndex- index of parameter to set

◆ GetParameterVector3()

virtual AZ::Vector3 EMotionFX::Integration::AnimGraphComponentRequests::GetParameterVector3 ( size_t  parameterIndex)
pure virtual

Retrieves a anim graph property as a Vector3 value.

Parameters
parameterIndex- index of parameter to set

◆ SetNamedParameterBool()

virtual void EMotionFX::Integration::AnimGraphComponentRequests::SetNamedParameterBool ( const char *  parameterName,
bool  value 
)
pure virtual

Updates a anim graph property given a boolean value.

Parameters
parameterName- name of parameter to set
value

◆ SetNamedParameterFloat()

virtual void EMotionFX::Integration::AnimGraphComponentRequests::SetNamedParameterFloat ( const char *  parameterName,
float  value 
)
pure virtual

Updates a anim graph property given a float value.

Parameters
parameterName- name of parameter to set
value

◆ SetNamedParameterRotation()

virtual void EMotionFX::Integration::AnimGraphComponentRequests::SetNamedParameterRotation ( const char *  parameterName,
const AZ::Quaternion &  value 
)
pure virtual

Updates a anim graph property given a quaternion value.

Parameters
parameterName- name of parameter to set
value

◆ SetNamedParameterRotationEuler()

virtual void EMotionFX::Integration::AnimGraphComponentRequests::SetNamedParameterRotationEuler ( const char *  parameterName,
const AZ::Vector3 &  value 
)
pure virtual

Updates a anim graph property given euler rotation values.

Parameters
parameterName- name of parameter to set
value

◆ SetNamedParameterString()

virtual void EMotionFX::Integration::AnimGraphComponentRequests::SetNamedParameterString ( const char *  parameterName,
const char *  value 
)
pure virtual

Updates a anim graph property given a string value.

Parameters
parameterName- name of parameter to set
value

◆ SetNamedParameterVector2()

virtual void EMotionFX::Integration::AnimGraphComponentRequests::SetNamedParameterVector2 ( const char *  parameterName,
const AZ::Vector2 &  value 
)
pure virtual

Updates a anim graph property given a Vector2 value.

Parameters
parameterName- name of parameter to set
value

◆ SetNamedParameterVector3()

virtual void EMotionFX::Integration::AnimGraphComponentRequests::SetNamedParameterVector3 ( const char *  parameterName,
const AZ::Vector3 &  value 
)
pure virtual

Updates a anim graph property given a Vector3 value.

Parameters
parameterName- name of parameter to set
value

◆ SetParameterBool()

virtual void EMotionFX::Integration::AnimGraphComponentRequests::SetParameterBool ( size_t  parameterIndex,
bool  value 
)
pure virtual

Updates a anim graph property given a boolean value.

Parameters
parameterIndex- index of parameter to set
value- value to set

◆ SetParameterFloat()

virtual void EMotionFX::Integration::AnimGraphComponentRequests::SetParameterFloat ( size_t  parameterIndex,
float  value 
)
pure virtual

Updates a anim graph property given a float value.

Parameters
parameterIndex- index of parameter to set
value- value to set

◆ SetParameterRotation()

virtual void EMotionFX::Integration::AnimGraphComponentRequests::SetParameterRotation ( size_t  parameterIndex,
const AZ::Quaternion &  value 
)
pure virtual

Updates a anim graph property given a quaternion value.

Parameters
parameterIndex- index of parameter to set
value- value to set

◆ SetParameterRotationEuler()

virtual void EMotionFX::Integration::AnimGraphComponentRequests::SetParameterRotationEuler ( size_t  parameterIndex,
const AZ::Vector3 &  value 
)
pure virtual

Updates a anim graph property given euler rotation values.

Parameters
parameterIndex- index of parameter to set
value- value to set

◆ SetParameterString()

virtual void EMotionFX::Integration::AnimGraphComponentRequests::SetParameterString ( size_t  parameterIndex,
const char *  value 
)
pure virtual

Updates a anim graph property given a string value.

Parameters
parameterIndex- index of parameter to set
value- value to set

◆ SetParameterVector2()

virtual void EMotionFX::Integration::AnimGraphComponentRequests::SetParameterVector2 ( size_t  parameterIndex,
const AZ::Vector2 &  value 
)
pure virtual

Updates a anim graph property given a Vector2 value.

Parameters
parameterIndex- index of parameter to set
value- value to set

◆ SetParameterVector3()

virtual void EMotionFX::Integration::AnimGraphComponentRequests::SetParameterVector3 ( size_t  parameterIndex,
const AZ::Vector3 &  value 
)
pure virtual

Updates a anim graph property given a Vector3 value.

Parameters
parameterIndex- index of parameter to set
value- value to set

◆ SyncAnimGraph()

virtual void EMotionFX::Integration::AnimGraphComponentRequests::SyncAnimGraph ( AZ::EntityId  leaderEntityId)
pure virtual

Making a request to sync the anim graph with another animg graph

Parameters
leaderEntityId- the entity id of another anim graph.
The documentation for this class was generated from the following file: