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.
EMotionFX::AnimGraphSymbolicFollowerParameterAction Class Reference

#include <AnimGraphSymbolicFollowerParameterAction.h>

Inherits EMotionFX::AnimGraphTriggerAction, and AZ::Data::AssetBus::MultiHandler.

Public Member Functions

 AnimGraphSymbolicFollowerParameterAction (AnimGraph *animGraph)
 
bool InitAfterLoading (AnimGraph *animGraph) override
 
void GetSummary (AZStd::string *outResult) const override
 
void GetTooltip (AZStd::string *outResult) const override
 
const char * GetPaletteName () const override
 
void TriggerAction (AnimGraphInstance *animGraphInstance) const override
 
AnimGraphGetRefAnimGraph () const
 
void OnAssetReady (AZ::Data::Asset< AZ::Data::AssetData > asset) override
 
void OnAssetReloaded (AZ::Data::Asset< AZ::Data::AssetData > asset) override
 
- Public Member Functions inherited from EMotionFX::AnimGraphTriggerAction
bool InitAfterLoading (AnimGraph *animGraph) override
 
virtual void TriggerAction (AnimGraphInstance *animGraphInstance) const =0
 
virtual void Reset (AnimGraphInstance *animGraphInstance)
 
ECategory GetPaletteCategory () const override
 
EMode GetTriggerMode () const
 
- Public Member Functions inherited from EMotionFX::AnimGraphObject
 AnimGraphObject (AnimGraph *animGraph)
 
virtual void Reinit ()
 
virtual void RecursiveReinit ()
 
virtual AnimGraphObjectDataCreateUniqueData (AnimGraphInstance *animGraphInstance)
 
void InvalidateUniqueDatas ()
 Calls InvalidateUniqueData() for the given object for all anim graph instances. (Used by reflection context)
 
virtual void InvalidateUniqueData (AnimGraphInstance *animGraphInstance)
 
virtual void RecursiveInvalidateUniqueDatas (AnimGraphInstance *animGraphInstance)
 
void ResetUniqueDatas ()
 
void ResetUniqueData (AnimGraphInstance *animGraphInstance)
 
virtual bool InitAfterLoading (AnimGraph *animGraph)=0
 
virtual void RegisterAttributes ()
 
virtual void Unregister ()
 
virtual const char * GetPaletteName () const =0
 
virtual void GetSummary (AZStd::string *outResult) const
 
virtual void GetTooltip (AZStd::string *outResult) const
 
virtual const char * GetHelpUrl () const
 
virtual ECategory GetPaletteCategory () const =0
 
virtual void Update (AnimGraphInstance *animGraphInstance, float timePassedInSeconds)
 
virtual void OnChangeMotionSet (AnimGraphInstance *animGraphInstance, MotionSet *newMotionSet)
 
virtual void OnRemoveNode (AnimGraph *animGraph, AnimGraphNode *nodeToRemove)
 
virtual void RecursiveOnChangeMotionSet (AnimGraphInstance *animGraphInstance, MotionSet *newMotionSet)
 
virtual void OnActorMotionExtractionNodeChanged ()
 
MCORE_INLINE size_t GetObjectIndex () const
 
MCORE_INLINE void SetObjectIndex (size_t index)
 
MCORE_INLINE AnimGraphGetAnimGraph () const
 
MCORE_INLINE void SetAnimGraph (AnimGraph *animGraph)
 
size_t SaveUniqueData (AnimGraphInstance *animGraphInstance, uint8 *outputBuffer) const
 
size_t LoadUniqueData (AnimGraphInstance *animGraphInstance, const uint8 *dataBuffer)
 
virtual void RecursiveCollectObjects (AZStd::vector< AnimGraphObject * > &outObjects) const
 
bool GetHasErrorFlag (AnimGraphInstance *animGraphInstance) const
 
void SetHasErrorFlag (AnimGraphInstance *animGraphInstance, bool hasError)
 
void SyncVisualObject ()
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from EMotionFX::AnimGraphTriggerAction
static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from EMotionFX::AnimGraphObject
static const char * GetCategoryName (ECategory category)
 
static void CalculateMotionExtractionDelta (EExtractionMode extractionMode, AnimGraphRefCountedData *sourceRefData, AnimGraphRefCountedData *targetRefData, float weight, bool hasMotionExtractionNodeInMask, Transform &outTransform, Transform &outTransformMirrored)
 
static void CalculateMotionExtractionDeltaAdditive (EExtractionMode extractionMode, AnimGraphRefCountedData *sourceRefData, AnimGraphRefCountedData *targetRefData, const Transform &basePoseTransform, float weight, bool hasMotionExtractionNodeInMask, Transform &outTransform, Transform &outTransformMirrored)
 
static void Reflect (AZ::ReflectContext *context)
 

Additional Inherited Members

- Public Types inherited from EMotionFX::AnimGraphTriggerAction
enum  EMode : AZ::u8 { MODE_TRIGGERONENTER = 0 , MODE_TRIGGERONEXIT = 1 }
 
- Public Types inherited from EMotionFX::AnimGraphObject
enum  { FLAG_DISABLED = 1 << 0 }
 
enum  ECategory {
  CATEGORY_SOURCES = 0 , CATEGORY_BLENDING = 1 , CATEGORY_CONTROLLERS = 2 , CATEGORY_PHYSICS = 3 ,
  CATEGORY_LOGIC = 4 , CATEGORY_MATH = 5 , CATEGORY_MISC = 6 , CATEGORY_TRANSITIONS = 10 ,
  CATEGORY_TRANSITIONCONDITIONS = 11 , CATEGORY_TRIGGERACTIONS = 12
}
 
enum  ESyncMode : AZ::u8 { SYNCMODE_DISABLED = 0 , SYNCMODE_TRACKBASED = 1 , SYNCMODE_CLIPBASED = 2 }
 
enum  EEventMode : AZ::u8 {
  EVENTMODE_LEADERONLY = 0 , EVENTMODE_FOLLOWERONLY = 1 , EVENTMODE_BOTHNODES = 2 , EVENTMODE_MOSTACTIVE = 3 ,
  EVENTMODE_NONE = 4
}
 
enum  EExtractionMode : AZ::u8 { EXTRACTIONMODE_BLEND = 0 , EXTRACTIONMODE_TARGETONLY = 1 , EXTRACTIONMODE_SOURCEONLY = 2 }
 
- Protected Attributes inherited from EMotionFX::AnimGraphObject
AnimGraphm_animGraph
 
size_t m_objectIndex
 

Detailed Description

AnimGraphSymbolicFollowerParameterAction is a specific type of trigger action that send a parameter (change) event to the follower graph. Compare to AnimGraphFollowerParameterAction, this action use a parameter from the main graph to sync its value to the follower graph's parameter.

Member Function Documentation

◆ GetPaletteName()

const char * EMotionFX::AnimGraphSymbolicFollowerParameterAction::GetPaletteName ( ) const
overridevirtual

◆ GetSummary()

void EMotionFX::AnimGraphSymbolicFollowerParameterAction::GetSummary ( AZStd::string *  outResult) const
overridevirtual

Reimplemented from EMotionFX::AnimGraphObject.

◆ GetTooltip()

void EMotionFX::AnimGraphSymbolicFollowerParameterAction::GetTooltip ( AZStd::string *  outResult) const
overridevirtual

Reimplemented from EMotionFX::AnimGraphObject.

◆ InitAfterLoading()

bool EMotionFX::AnimGraphSymbolicFollowerParameterAction::InitAfterLoading ( AnimGraph animGraph)
overridevirtual

◆ TriggerAction()

void EMotionFX::AnimGraphSymbolicFollowerParameterAction::TriggerAction ( AnimGraphInstance animGraphInstance) const
overridevirtual

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