Open 3D Engine LyShine 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 Types | Public Member Functions | List of all members
IUiAnimNode Struct Referenceabstract

#include <IUiAnimation.h>

Inherited by CUiAnimNode.

Public Types

enum  ESupportedParamFlags { eSupportedParamFlags_MultipleTracks = 0x01 }
 

Public Member Functions

virtual void add_ref ()=0
 
virtual void release ()=0
 
virtual void SetName (const char *name)=0
 Set node name.
 
virtual AZStd::string GetName ()=0
 Get node name.
 
virtual EUiAnimNodeType GetType () const =0
 
virtual IUiAnimSequence * GetSequence () const =0
 
virtual void SetSequence (IUiAnimSequence *sequence)=0
 
virtual void Activate (bool bActivate)=0
 
virtual void SetFlags (int flags)=0
 
virtual int GetFlags () const =0
 
virtual IUiAnimationSystem * GetUiAnimationSystem () const =0
 
virtual bool SetParamValue (float time, CUiAnimParamType param, float value)=0
 
virtual bool SetParamValue (float time, CUiAnimParamType param, const Vec3 &value)=0
 
virtual bool SetParamValue (float time, CUiAnimParamType param, const Vec4 &value)=0
 
virtual bool GetParamValue (float time, CUiAnimParamType param, float &value)=0
 
virtual bool GetParamValue (float time, CUiAnimParamType param, Vec3 &value)=0
 
virtual bool GetParamValue (float time, CUiAnimParamType param, Vec4 &value)=0
 
virtual bool SetParamValueAz (float time, const UiAnimParamData &param, float value)
 
virtual bool SetParamValueAz (float time, const UiAnimParamData &param, bool value)
 
virtual bool SetParamValueAz (float time, const UiAnimParamData &param, int value)
 
virtual bool SetParamValueAz (float time, const UiAnimParamData &param, unsigned int value)
 
virtual bool SetParamValueAz (float time, const UiAnimParamData &param, const AZ::Vector2 &value)
 
virtual bool SetParamValueAz (float time, const UiAnimParamData &param, const AZ::Vector3 &value)
 
virtual bool SetParamValueAz (float time, const UiAnimParamData &param, const AZ::Vector4 &value)
 
virtual bool SetParamValueAz (float time, const UiAnimParamData &param, const AZ::Color &value)
 
virtual bool GetParamValueAz (float time, const UiAnimParamData &param, float &value)
 
virtual void StillUpdate ()=0
 Evaluate animation node while not playing animation.
 
virtual void Animate (SUiAnimContext &ec)=0
 Evaluate animation to the given time.
 
virtual unsigned int GetParamCount () const =0
 
virtual CUiAnimParamType GetParamType (unsigned int nIndex) const =0
 
virtual bool IsParamValid (const CUiAnimParamType &paramType) const =0
 
virtual AZStd::string GetParamName (const CUiAnimParamType &paramType) const =0
 
virtual AZStd::string GetParamNameForTrack (const CUiAnimParamType &paramType, const IUiAnimTrack *track) const
 
virtual EUiAnimValue GetParamValueType (const CUiAnimParamType &paramType) const =0
 
virtual ESupportedParamFlags GetParamFlags (const CUiAnimParamType &paramType) const =0
 
virtual void OnReset ()=0
 
virtual int GetTrackCount () const =0
 
virtual IUiAnimTrack * GetTrackByIndex (int nIndex) const =0
 
virtual IUiAnimTrack * GetTrackForParameter (const CUiAnimParamType &paramType) const =0
 
virtual IUiAnimTrack * GetTrackForParameter (const CUiAnimParamType &paramType, uint32 index) const =0
 
virtual uint32 GetTrackParamIndex (const IUiAnimTrack *pTrack) const =0
 
virtual IUiAnimTrack * CreateTrack (const CUiAnimParamType &paramType)=0
 
virtual IUiAnimTrack * GetTrackForAzField (const UiAnimParamData &param) const =0
 
virtual IUiAnimTrack * CreateTrackForAzField (const UiAnimParamData &param)=0
 
virtual void SetTrack (const CUiAnimParamType &paramType, IUiAnimTrack *track)=0
 
virtual void SetTimeRange (Range timeRange)=0
 
virtual void AddTrack (IUiAnimTrack *pTrack)=0
 
virtual bool RemoveTrack (IUiAnimTrack *pTrack)=0
 
virtual void CreateDefaultTracks ()=0
 
virtual void SetNodeOwner (IUiAnimNodeOwner *pOwner)=0
 
virtual IUiAnimNodeOwner * GetNodeOwner ()=0
 
virtual void SerializeUiAnims (XmlNodeRef &xmlNode, bool bLoading, bool bLoadEmptyTracks)=0
 
virtual void Serialize (XmlNodeRef &xmlNode, bool bLoading, bool bLoadEmptyTracks)=0
 
virtual void InitPostLoad (IUiAnimSequence *pSequence, bool remapIds, LyShine::EntityIdMap *entityIdMap)=0
 
virtual void SetParent (IUiAnimNode *pParent)=0
 
virtual IUiAnimNode * GetParent () const =0
 
virtual IUiAnimNode * HasDirectorAsParent () const =0
 
virtual void Render ()=0
 
virtual bool NeedToRender () const =0
 
virtual void UpdateDynamicParams ()=0
 

Detailed Description

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

Member Function Documentation

◆ Animate()

virtual void IUiAnimNode::Animate ( SUiAnimContext &  ec)
pure virtual

Evaluate animation to the given time.

Implemented in CUiAnimEventNode, CUiAnimNode, and CUiAnimAzEntityNode.

◆ GetName()

virtual AZStd::string IUiAnimNode::GetName ( )
pure virtual

Get node name.

Implemented in CUiAnimNode.

◆ SetName()

virtual void IUiAnimNode::SetName ( const char *  name)
pure virtual

Set node name.

Implemented in CUiAnimNode.

◆ StillUpdate()

virtual void IUiAnimNode::StillUpdate ( )
pure virtual

Evaluate animation node while not playing animation.

Implemented in CUiAnimNode, and CUiAnimAzEntityNode.

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