Open 3D Engine LyShine 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 Types | Protected Member Functions | Protected Attributes | List of all members
CUiAnimNode Class Reference

#include <AnimNode.h>

Inherits IUiAnimNode.

Inherited by CUiAnimAzEntityNode, CUiAnimEventNode, and CUiAnimNodeGroup.

Classes

struct  SParamInfo
 

Public Member Functions

 AZ_RTTI (CUiAnimNode, "{1ECF3B73-FCED-464D-82E8-CFAF31BB63DC}", IUiAnimNode)
 
 CUiAnimNode (const CUiAnimNode &other)
 
 CUiAnimNode (const int id, EUiAnimNodeType nodeType)
 
EUiAnimNodeType GetType () const override
 
void add_ref () override
 
void release () override
 
void SetName (const char *name) override
 Set node name.
 
AZStd::string GetName () override
 Get node name.
 
void SetSequence (IUiAnimSequence *pSequence) override
 
IUiAnimSequence * GetSequence () const override
 
void SetFlags (int flags) override
 
int GetFlags () const override
 
IUiAnimationSystem * GetUiAnimationSystem () const override
 
virtual void OnStart ()
 
void OnReset () override
 
virtual void OnResetHard ()
 
virtual void OnPause ()
 
virtual void OnResume ()
 
virtual void OnStop ()
 
virtual void OnLoop ()
 
virtual Matrix34 GetReferenceMatrix () const
 
bool IsParamValid (const CUiAnimParamType &paramType) const override
 
AZStd::string GetParamName (const CUiAnimParamType &param) const override
 
EUiAnimValue GetParamValueType (const CUiAnimParamType &paramType) const override
 
IUiAnimNode::ESupportedParamFlags GetParamFlags (const CUiAnimParamType &paramType) const override
 
unsigned int GetParamCount () const override
 
bool SetParamValue (float time, CUiAnimParamType param, float val) override
 
bool SetParamValue (float time, CUiAnimParamType param, const Vec3 &val) override
 
bool SetParamValue (float time, CUiAnimParamType param, const Vec4 &val) override
 
bool GetParamValue (float time, CUiAnimParamType param, float &val) override
 
bool GetParamValue (float time, CUiAnimParamType param, Vec3 &val) override
 
bool GetParamValue (float time, CUiAnimParamType param, Vec4 &val) override
 
void SetTarget ([[maybe_unused]] IUiAnimNode *node)
 
IUiAnimNode * GetTarget () const
 
void StillUpdate () override
 Evaluate animation node while not playing animation.
 
void Animate (SUiAnimContext &ec) override
 Evaluate animation to the given time.
 
virtual void PrecacheStatic ([[maybe_unused]] float startTime)
 
virtual void PrecacheDynamic ([[maybe_unused]] float time)
 
void Serialize (XmlNodeRef &xmlNode, bool bLoading, bool bLoadEmptyTracks) override
 
void SerializeUiAnims (XmlNodeRef &xmlNode, bool bLoading, bool bLoadEmptyTracks) override
 
void SetNodeOwner (IUiAnimNodeOwner *pOwner) override
 
IUiAnimNodeOwner * GetNodeOwner () override
 
void Activate (bool bActivate) override
 
void SetParent (IUiAnimNode *pParent) override
 
IUiAnimNode * GetParent () const override
 
IUiAnimNode * HasDirectorAsParent () const override
 
void UpdateDynamicParams () override
 
int GetTrackCount () const override
 
IUiAnimTrack * GetTrackByIndex (int nIndex) const override
 
IUiAnimTrack * GetTrackForParameter (const CUiAnimParamType &paramType) const override
 
IUiAnimTrack * GetTrackForParameter (const CUiAnimParamType &paramType, uint32 index) const override
 
uint32 GetTrackParamIndex (const IUiAnimTrack *track) const override
 
IUiAnimTrack * GetTrackForAzField ([[maybe_unused]] const UiAnimParamData &param) const override
 
IUiAnimTrack * CreateTrackForAzField ([[maybe_unused]] const UiAnimParamData &param) override
 
void SetTrack (const CUiAnimParamType &paramType, IUiAnimTrack *track) override
 
IUiAnimTrack * CreateTrack (const CUiAnimParamType &paramType) override
 
void SetTimeRange (Range timeRange) override
 
void AddTrack (IUiAnimTrack *track) override
 
bool RemoveTrack (IUiAnimTrack *track) override
 
void CreateDefaultTracks () override
 
void InitPostLoad (IUiAnimSequence *pSequence, bool remapIds, LyShine::EntityIdMap *entityIdMap) override
 
virtual void PostLoad ()
 
int GetId () const
 
void SetId (int id)
 
const char * GetNameFast () const
 
void Render () override
 
- Public Member Functions inherited from IUiAnimNode
virtual bool SetParamValueAz ([[maybe_unused]] float time, [[maybe_unused]] const UiAnimParamData &param, [[maybe_unused]] float value)
 
virtual bool SetParamValueAz ([[maybe_unused]] float time, [[maybe_unused]] const UiAnimParamData &param, [[maybe_unused]] bool value)
 
virtual bool SetParamValueAz ([[maybe_unused]] float time, [[maybe_unused]] const UiAnimParamData &param, [[maybe_unused]] int value)
 
virtual bool SetParamValueAz ([[maybe_unused]] float time, [[maybe_unused]] const UiAnimParamData &param, [[maybe_unused]] unsigned int value)
 
virtual bool SetParamValueAz ([[maybe_unused]] float time, [[maybe_unused]] const UiAnimParamData &param, [[maybe_unused]] const AZ::Vector2 &value)
 
virtual bool SetParamValueAz ([[maybe_unused]] float time, [[maybe_unused]] const UiAnimParamData &param, [[maybe_unused]] const AZ::Vector3 &value)
 
virtual bool SetParamValueAz ([[maybe_unused]] float time, [[maybe_unused]] const UiAnimParamData &param, [[maybe_unused]] const AZ::Vector4 &value)
 
virtual bool SetParamValueAz ([[maybe_unused]] float time, [[maybe_unused]] const UiAnimParamData &param, [[maybe_unused]] const AZ::Color &value)
 
virtual bool GetParamValueAz ([[maybe_unused]] float time, [[maybe_unused]] const UiAnimParamData &param, [[maybe_unused]] float &value)
 
virtual CUiAnimParamType GetParamType (unsigned int nIndex) const =0
 
virtual AZStd::string GetParamNameForTrack (const CUiAnimParamType &paramType, [[maybe_unused]] const IUiAnimTrack *track) const
 
virtual IUiAnimTrack * GetTrackForAzField (const UiAnimParamData &param) const =0
 
virtual IUiAnimTrack * CreateTrackForAzField (const UiAnimParamData &param)=0
 

Static Public Member Functions

static void Reflect (AZ::SerializeContext *serializeContext)
 

Protected Types

typedef AZStd::vector< AZStd::intrusive_ptr< IUiAnimTrack > > AnimTracks
 

Protected Member Functions

virtual bool GetParamInfoFromType ([[maybe_unused]] const CUiAnimParamType &paramType, [[maybe_unused]] SParamInfo &info) const
 
int NumTracks () const
 
UiAnimationSystem * GetUiAnimationSystemImpl () const
 
void RegisterTrack (IUiAnimTrack *track)
 
bool NeedToRender () const override
 

Protected Attributes

int m_refCount
 
EUiAnimNodeType m_nodeType
 
int m_id
 
AZStd::string m_name
 
IUiAnimSequence * m_pSequence
 
IUiAnimNodeOwner * m_pOwner
 
IUiAnimNode * m_pParentNode
 
int m_parentNodeId
 
int m_nLoadedParentNodeId
 
int m_flags
 
unsigned int m_bIgnoreSetParam: 1
 
AnimTracks m_tracks
 

Additional Inherited Members

- Public Types inherited from IUiAnimNode
enum  ESupportedParamFlags { eSupportedParamFlags_MultipleTracks = 0x01 }
 

Detailed Description

Base class for all Animation nodes, can host multiple animation tracks, and execute them other time. Animation node is reference counted.

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