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 (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 (float startTime)
virtual void	PrecacheDynamic (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 (const UiAnimParamData &param) const override
IUiAnimTrack *	CreateTrackForAzField (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 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

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 (const CUiAnimParamType &paramType, 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.

Member Function Documentation

Activate()

void CUiAnimNode::Activate ( bool  bActivate )

overridevirtual

Implements IUiAnimNode.

add_ref()

void CUiAnimNode::add_ref ( )

overridevirtual

Implements IUiAnimNode.

AddTrack()

void CUiAnimNode::AddTrack ( IUiAnimTrack *  track )

overridevirtual

Implements IUiAnimNode.

Animate()

void CUiAnimNode::Animate ( SUiAnimContext &  ec )

overridevirtual

Evaluate animation to the given time.

Implements IUiAnimNode.

Reimplemented in CUiAnimEventNode, and CUiAnimAzEntityNode.

CreateDefaultTracks()

void CUiAnimNode::CreateDefaultTracks ( )

inlineoverridevirtual

Implements IUiAnimNode.

CreateTrack()

IUiAnimTrack * CUiAnimNode::CreateTrack ( const CUiAnimParamType &  paramType )

overridevirtual

Implements IUiAnimNode.

CreateTrackForAzField()

IUiAnimTrack * CUiAnimNode::CreateTrackForAzField ( const UiAnimParamData &  param )

inlineoverridevirtual

Implements IUiAnimNode.

GetFlags()

int CUiAnimNode::GetFlags ( ) const

overridevirtual

Implements IUiAnimNode.

GetName()

AZStd::string CUiAnimNode::GetName ( )

inlineoverridevirtual

Get node name.

Implements IUiAnimNode.

GetNodeOwner()

IUiAnimNodeOwner * CUiAnimNode::GetNodeOwner ( )

inlineoverridevirtual

Implements IUiAnimNode.

GetParamCount()

unsigned int CUiAnimNode::GetParamCount ( ) const

inlineoverridevirtual

Implements IUiAnimNode.

GetParamFlags()

IUiAnimNode::ESupportedParamFlags CUiAnimNode::GetParamFlags ( const CUiAnimParamType &  paramType ) const

overridevirtual

Implements IUiAnimNode.

GetParamName()

AZStd::string CUiAnimNode::GetParamName ( const CUiAnimParamType &  param ) const

overridevirtual

Implements IUiAnimNode.

GetParamValue() [1/3]

bool CUiAnimNode::GetParamValue ( float  time, CUiAnimParamType  param, float &  val  )

overridevirtual

Implements IUiAnimNode.

GetParamValue() [2/3]

bool CUiAnimNode::GetParamValue ( float  time, CUiAnimParamType  param, Vec3 &  val  )

overridevirtual

Implements IUiAnimNode.

GetParamValue() [3/3]

bool CUiAnimNode::GetParamValue ( float  time, CUiAnimParamType  param, Vec4 &  val  )

overridevirtual

Implements IUiAnimNode.

GetParamValueType()

EUiAnimValue CUiAnimNode::GetParamValueType ( const CUiAnimParamType &  paramType ) const

overridevirtual

Implements IUiAnimNode.

GetParent()

IUiAnimNode * CUiAnimNode::GetParent ( ) const

inlineoverridevirtual

Implements IUiAnimNode.

GetSequence()

IUiAnimSequence * CUiAnimNode::GetSequence ( ) const

inlineoverridevirtual

Implements IUiAnimNode.

GetTrackByIndex()

IUiAnimTrack * CUiAnimNode::GetTrackByIndex ( int  nIndex ) const

overridevirtual

Implements IUiAnimNode.

GetTrackCount()

int CUiAnimNode::GetTrackCount ( ) const

overridevirtual

Implements IUiAnimNode.

GetTrackForAzField()

IUiAnimTrack * CUiAnimNode::GetTrackForAzField ( const UiAnimParamData &  param ) const

inlineoverridevirtual

Implements IUiAnimNode.

GetTrackForParameter() [1/2]

IUiAnimTrack * CUiAnimNode::GetTrackForParameter ( const CUiAnimParamType &  paramType ) const

overridevirtual

Implements IUiAnimNode.

GetTrackForParameter() [2/2]

IUiAnimTrack * CUiAnimNode::GetTrackForParameter ( const CUiAnimParamType &  paramType, uint32  index  ) const

overridevirtual

Implements IUiAnimNode.

GetTrackParamIndex()

uint32 CUiAnimNode::GetTrackParamIndex ( const IUiAnimTrack *  track ) const

overridevirtual

Implements IUiAnimNode.

GetType()

EUiAnimNodeType CUiAnimNode::GetType ( ) const

inlineoverridevirtual

Implements IUiAnimNode.

GetUiAnimationSystem()

IUiAnimationSystem * CUiAnimNode::GetUiAnimationSystem ( ) const

inlineoverridevirtual

Implements IUiAnimNode.

HasDirectorAsParent()

IUiAnimNode * CUiAnimNode::HasDirectorAsParent ( ) const

overridevirtual

Implements IUiAnimNode.

InitPostLoad()

void CUiAnimNode::InitPostLoad ( IUiAnimSequence *  pSequence, bool  remapIds, LyShine::EntityIdMap *  entityIdMap  )

overridevirtual

Implements IUiAnimNode.

IsParamValid()

bool CUiAnimNode::IsParamValid ( const CUiAnimParamType &  paramType ) const

overridevirtual

Implements IUiAnimNode.

NeedToRender()

bool CUiAnimNode::NeedToRender ( ) const

inlineoverrideprotectedvirtual

Implements IUiAnimNode.

OnReset()

void CUiAnimNode::OnReset ( )

inlineoverridevirtual

Implements IUiAnimNode.

release()

void CUiAnimNode::release ( )

overridevirtual

Implements IUiAnimNode.

RemoveTrack()

bool CUiAnimNode::RemoveTrack ( IUiAnimTrack *  track )

overridevirtual

Implements IUiAnimNode.

Render()

void CUiAnimNode::Render ( )

inlineoverridevirtual

Implements IUiAnimNode.

Serialize()

void CUiAnimNode::Serialize ( XmlNodeRef &  xmlNode, bool  bLoading, bool  bLoadEmptyTracks  )

overridevirtual

Implements IUiAnimNode.

SerializeUiAnims()

void CUiAnimNode::SerializeUiAnims ( XmlNodeRef &  xmlNode, bool  bLoading, bool  bLoadEmptyTracks  )

overridevirtual

Implements IUiAnimNode.

SetFlags()

void CUiAnimNode::SetFlags ( int  flags )

overridevirtual

Implements IUiAnimNode.

SetName()

void CUiAnimNode::SetName ( const char *  name )

inlineoverridevirtual

Set node name.

Implements IUiAnimNode.

SetNodeOwner()

void CUiAnimNode::SetNodeOwner ( IUiAnimNodeOwner *  pOwner )

overridevirtual

Implements IUiAnimNode.

SetParamValue() [1/3]

bool CUiAnimNode::SetParamValue ( float  time, CUiAnimParamType  param, const Vec3 &  val  )

overridevirtual

Implements IUiAnimNode.

SetParamValue() [2/3]

bool CUiAnimNode::SetParamValue ( float  time, CUiAnimParamType  param, const Vec4 &  val  )

overridevirtual

Implements IUiAnimNode.

SetParamValue() [3/3]

bool CUiAnimNode::SetParamValue ( float  time, CUiAnimParamType  param, float  val  )

overridevirtual

Implements IUiAnimNode.

SetParent()

void CUiAnimNode::SetParent ( IUiAnimNode *  pParent )

overridevirtual

Implements IUiAnimNode.

SetSequence()

void CUiAnimNode::SetSequence ( IUiAnimSequence *  pSequence )

inlineoverridevirtual

Implements IUiAnimNode.

SetTimeRange()

void CUiAnimNode::SetTimeRange ( Range  timeRange )

overridevirtual

Implements IUiAnimNode.

SetTrack()

void CUiAnimNode::SetTrack ( const CUiAnimParamType &  paramType, IUiAnimTrack *  track  )

overridevirtual

Implements IUiAnimNode.

StillUpdate()

void CUiAnimNode::StillUpdate ( )

inlineoverridevirtual

Evaluate animation node while not playing animation.

Implements IUiAnimNode.

Reimplemented in CUiAnimAzEntityNode.

UpdateDynamicParams()

void CUiAnimNode::UpdateDynamicParams ( )

inlineoverridevirtual

Implements IUiAnimNode.

---

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

• Gems/LyShine/Code/Source/Animation/AnimNode.h