Open 3D Engine Maestro Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
CAnimComponentNode Class Reference

#include <AnimComponentNode.h>

Inherits CAnimNode, and Maestro::EditorSequenceAgentComponentNotificationBus::Handler.

Public Member Functions

 AZ_CLASS_ALLOCATOR (CAnimComponentNode, AZ::SystemAllocator)
 
 AZ_RTTI (CAnimComponentNode, "{722F3D0D-7AEB-46B7-BF13-D5C7A828E9BD}", CAnimNode)
 
 CAnimComponentNode (const int id)
 
AZ::EntityId GetParentAzEntityId () const
 
void Animate (SAnimContext &ac) override
 
void OnStart () override
 
void OnResume () override
 
void OnReset () override
 
void OnResetHard () override
 
CAnimParamType GetParamType (unsigned int nIndex) const override
 
void SetComponent (AZ::ComponentId componentId, const AZ::Uuid &typeId) override
 
AZ::ComponentId GetComponentId () const override
 
int SetKeysForChangedTrackValues (float time) override
 
void OnStartPlayInEditor () override
 
void OnStopPlayInEditor () override
 
void SetNodeOwner (IAnimNodeOwner *pOwner) override
 
void SetPos (float time, const AZ::Vector3 &pos) override
 
void SetRotate (float time, const AZ::Quaternion &quat) override
 
void SetScale (float time, const AZ::Vector3 &scale) override
 
Vec3 GetPos () override
 
Quat GetRotate () override
 
Quat GetRotate (float time) override
 
Vec3 GetScale () override
 
void Activate (bool bActivate) override
 
IAnimTrack * CreateTrack (const CAnimParamType &paramType) override
 
bool RemoveTrack (IAnimTrack *pTrack) override
 
void OnSequenceAgentConnected () override
 
void Serialize (XmlNodeRef &xmlNode, bool bLoading, bool bLoadEmptyTracks) override
 
const AZ::Uuid & GetComponentTypeId () const
 
void SetSkipComponentAnimationUpdates (bool skipAnimationUpdates)
 
- Public Member Functions inherited from CAnimNode
 AZ_CLASS_ALLOCATOR (CAnimNode, AZ::SystemAllocator)
 
 AZ_RTTI (CAnimNode, "{57736B48-5EE7-4530-8051-657ACC9BA1EE}", IAnimNode)
 
 CAnimNode (const CAnimNode &other)
 
 CAnimNode (const int id, AnimNodeType nodeType)
 
AnimNodeType GetType () const override
 
void add_ref () override
 
void release () override
 
void SetName (const char *name) override
 
const char * GetName () const override
 
void SetSequence (IAnimSequence *sequence) override
 
IAnimSequence * GetSequence () const override
 
void SetAzEntityId ([[maybe_unused]] const AZ::EntityId &id) override
 
AZ::EntityId GetAzEntityId () const override
 
void SetFlags (int flags) override
 
int GetFlags () const override
 
bool AreFlagsSetOnNodeOrAnyParent (EAnimNodeFlags flagsToCheck) const override
 
IMovieSystem * GetMovieSystem () const override
 
void OnReset () override
 
virtual void OnPause ()
 
virtual void OnStop ()
 
virtual void OnLoop ()
 
void SetPos ([[maybe_unused]] float time, [[maybe_unused]] const AZ::Vector3 &pos) override
 
void SetRotate ([[maybe_unused]] float time, [[maybe_unused]] const AZ::Quaternion &quat) override
 
void SetScale ([[maybe_unused]] float time, [[maybe_unused]] const AZ::Vector3 &scale) override
 
Vec3 GetPos () override
 
Quat GetRotate () override
 
Quat GetRotate (float) override
 
Vec3 GetScale () override
 
virtual Matrix34 GetReferenceMatrix () const
 
bool IsParamValid (const CAnimParamType &paramType) const override
 
AZStd::string GetParamName (const CAnimParamType &param) const override
 
AnimValueType GetParamValueType (const CAnimParamType &paramType) const override
 
IAnimNode::ESupportedParamFlags GetParamFlags (const CAnimParamType &paramType) const override
 
unsigned int GetParamCount () const override
 
bool SetParamValue (float time, CAnimParamType param, float val) override
 
bool SetParamValue (float time, CAnimParamType param, const Vec3 &val) override
 
bool SetParamValue (float time, CAnimParamType param, const Vec4 &val) override
 
bool GetParamValue (float time, CAnimParamType param, float &val) override
 
bool GetParamValue (float time, CAnimParamType param, Vec3 &val) override
 
bool GetParamValue (float time, CAnimParamType param, Vec4 &val) override
 
void SetTarget ([[maybe_unused]] IAnimNode *node)
 
IAnimNode * GetTarget () const
 
void StillUpdate () override
 
void Animate (SAnimContext &ec) override
 
virtual void PrecacheStatic ([[maybe_unused]] float startTime)
 
virtual void PrecacheDynamic ([[maybe_unused]] float time)
 
void Serialize (XmlNodeRef &xmlNode, bool bLoading, bool bLoadEmptyTracks) override
 
void InitPostLoad (IAnimSequence *sequence) override
 
void SetNodeOwner (IAnimNodeOwner *pOwner) override
 
IAnimNodeOwner * GetNodeOwner () override
 
void Activate (bool bActivate) override
 
void SetParent (IAnimNode *parent) override
 
IAnimNode * GetParent () const override
 
IAnimNode * HasDirectorAsParent () const override
 
int GetTrackCount () const override
 
IAnimTrack * GetTrackByIndex (int nIndex) const override
 
IAnimTrack * GetTrackForParameter (const CAnimParamType &paramType) const override
 
IAnimTrack * GetTrackForParameter (const CAnimParamType &paramType, uint32 index) const override
 
uint32 GetTrackParamIndex (const IAnimTrack *pTrack) const override
 
void SetTrack (const CAnimParamType &paramType, IAnimTrack *track) override
 
IAnimTrack * CreateTrack (const CAnimParamType &paramType) override
 
void InitializeTrackDefaultValue ([[maybe_unused]] IAnimTrack *pTrack, [[maybe_unused]] const CAnimParamType &paramType) override
 
void SetTimeRange (Range timeRange) override
 
void AddTrack (IAnimTrack *pTrack) override
 
bool RemoveTrack (IAnimTrack *pTrack) override
 
void CreateDefaultTracks () override
 
void SerializeAnims (XmlNodeRef &xmlNode, bool bLoading, bool bLoadEmptyTracks) override
 
virtual void PostLoad ()
 
int GetId () const override
 
void SetId (int id)
 
void Render () override
 
void UpdateDynamicParams () final
 
void TimeChanged (float newTime) override
 
void SetExpanded (bool expanded) override
 
bool GetExpanded () const override
 

Static Public Member Functions

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

Protected Member Functions

void UpdateDynamicParams_Editor ()
 
void UpdateDynamicParams_Game ()
 
void InitializeTrackDefaultValue (IAnimTrack *pTrack, const CAnimParamType &paramType) override
 
bool GetParamInfoFromType (const CAnimParamType &paramId, SParamInfo &info) const override
 
- Protected Member Functions inherited from CAnimNode
virtual bool GetParamInfoFromType ([[maybe_unused]] const CAnimParamType &paramType, [[maybe_unused]] SParamInfo &info) const
 
int NumTracks () const
 
void RegisterTrack (IAnimTrack *pTrack)
 
CMovieSystem * GetCMovieSystem () const
 
bool NeedToRender () const override
 
virtual void ResetSounds ()
 
virtual void ApplyAudioKey ([[maybe_unused]] char const *const sTriggerName, [[maybe_unused]] bool const bPlay=true)
 
void AnimateSound (std::vector< SSoundInfo > &nodeSoundInfo, SAnimContext &ec, IAnimTrack *pTrack, size_t numAudioTracks)
 

Additional Inherited Members

- Public Types inherited from CAnimNode
typedef AZStd::vector< AZStd::intrusive_ptr< IAnimTrack > > AnimTracks
 
- Protected Attributes inherited from CAnimNode
AnimTracks m_tracks
 
AnimNodeType m_nodeType
 
AZStd::string m_name
 
IAnimSequence * m_pSequence
 
IAnimNodeOwner * m_pOwner
 
IAnimNode * m_pParentNode
 
int m_refCount
 
int m_id
 
int m_nLoadedParentNodeId
 
int m_parentNodeId
 
int m_flags
 
unsigned int m_bIgnoreSetParam: 1
 
bool m_expanded
 

Detailed Description

CAnimComponentNode

All animation on AZ::Entity nodes are keyed to tracks on CAnimComponentNodes.

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