Open 3D Engine LyShine Gem API Reference 24.09.2
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
CUiAnimAzEntityNode Class Reference

Inherits CUiAnimNode, and UiAnimNodeBus::Handler.

Public Member Functions

 AZ_RTTI (CUiAnimAzEntityNode, "{1C6FAEE1-92E4-42ED-8EEB-3483C36A0B77}", CUiAnimNode)
 
 CUiAnimAzEntityNode (const int id)
 
void EnableEntityPhysics (bool bEnable)
 
EUiAnimNodeType GetType () const override
 
void AddTrack (IUiAnimTrack *track) override
 
AZ::EntityId GetAzEntityId () override
 
void SetAzEntity (AZ::Entity *entity) override
 
void StillUpdate () override
 Evaluate animation node while not playing animation.
 
void Animate (SUiAnimContext &ec) override
 Evaluate animation to the given time.
 
void CreateDefaultTracks () override
 
bool SetParamValueAz (float time, const UiAnimParamData &param, float value) override
 
bool SetParamValueAz (float time, const UiAnimParamData &param, bool value) override
 
bool SetParamValueAz (float time, const UiAnimParamData &param, int value) override
 
bool SetParamValueAz (float time, const UiAnimParamData &param, unsigned int value) override
 
bool SetParamValueAz (float time, const UiAnimParamData &param, const AZ::Vector2 &value) override
 
bool SetParamValueAz (float time, const UiAnimParamData &param, const AZ::Vector3 &value) override
 
bool SetParamValueAz (float time, const UiAnimParamData &param, const AZ::Vector4 &value) override
 
bool SetParamValueAz (float time, const UiAnimParamData &param, const AZ::Color &value) override
 
bool GetParamValueAz (float time, const UiAnimParamData &param, float &value) override
 
void PrecacheStatic (float startTime) override
 
void PrecacheDynamic (float time) override
 
Vec3 GetPos ()
 
Quat GetRotate ()
 
Vec3 GetScale ()
 
void Activate (bool bActivate) override
 
IUiAnimTrackGetTrackForAzField (const UiAnimParamData &param) const override
 
IUiAnimTrackCreateTrackForAzField (const UiAnimParamData &param) override
 
void Serialize (XmlNodeRef &xmlNode, bool bLoading, bool bLoadEmptyTracks) override
 
void InitPostLoad (IUiAnimSequence *pSequence, bool remapIds, LyShine::EntityIdMap *entityIdMap) override
 
void OnReset () override
 
void OnResetHard () override
 
void OnStart () override
 
void OnPause () override
 
void OnStop () override
 
unsigned int GetParamCount () const override
 
CUiAnimParamType GetParamType (unsigned int nIndex) const override
 
AZStd::string GetParamName (const CUiAnimParamType &param) const override
 
AZStd::string GetParamNameForTrack (const CUiAnimParamType &param, const IUiAnimTrack *track) const override
 
- Public Member Functions inherited from CUiAnimNode
 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
 
IUiAnimSequenceGetSequence () const override
 
void SetFlags (int flags) override
 
int GetFlags () const override
 
IUiAnimationSystemGetUiAnimationSystem () const override
 
void OnReset () override
 
virtual void OnResume ()
 
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)
 
IUiAnimNodeGetTarget () const
 
void StillUpdate () override
 Evaluate animation node while not playing animation.
 
void Animate (SUiAnimContext &ec) override
 Evaluate animation to the given time.
 
void Serialize (XmlNodeRef &xmlNode, bool bLoading, bool bLoadEmptyTracks) override
 
void SerializeUiAnims (XmlNodeRef &xmlNode, bool bLoading, bool bLoadEmptyTracks) override
 
void SetNodeOwner (IUiAnimNodeOwner *pOwner) override
 
IUiAnimNodeOwnerGetNodeOwner () override
 
void Activate (bool bActivate) override
 
void SetParent (IUiAnimNode *pParent) override
 
IUiAnimNodeGetParent () const override
 
IUiAnimNodeHasDirectorAsParent () const override
 
void UpdateDynamicParams () override
 
int GetTrackCount () const override
 
IUiAnimTrackGetTrackByIndex (int nIndex) const override
 
IUiAnimTrackGetTrackForParameter (const CUiAnimParamType &paramType) const override
 
IUiAnimTrackGetTrackForParameter (const CUiAnimParamType &paramType, uint32 index) const override
 
uint32 GetTrackParamIndex (const IUiAnimTrack *track) const override
 
IUiAnimTrackGetTrackForAzField (const UiAnimParamData &param) const override
 
IUiAnimTrackCreateTrackForAzField (const UiAnimParamData &param) override
 
void SetTrack (const CUiAnimParamType &paramType, IUiAnimTrack *track) override
 
IUiAnimTrackCreateTrack (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

Static Public Member Functions

static int GetParamCountStatic ()
 
static bool GetParamInfoStatic (int nIndex, SParamInfo &info)
 
static void Reflect (AZ::SerializeContext *serializeContext)
 
- Static Public Member Functions inherited from CUiAnimNode
static void Reflect (AZ::SerializeContext *serializeContext)
 

Protected Types

enum  EUpdateEntityFlags { eUpdateEntity_Position = 1 << 0 , eUpdateEntity_Rotation = 1 << 1 , eUpdateEntity_Animation = 1 << 2 }
 
- Protected Types inherited from CUiAnimNode
typedef AZStd::vector< AZStd::intrusive_ptr< IUiAnimTrack > > AnimTracks
 

Protected Member Functions

bool GetParamInfoFromType (const CUiAnimParamType &paramId, SParamInfo &info) const override
 
const AZ::SerializeContext::ClassElement * ComputeOffsetFromElementName (const AZ::SerializeContext::ClassData *classData, IUiAnimTrack *track, size_t baseOffset)
 
void ComputeOffsetsFromElementNames ()
 This is called on load to compute the offset into the component for each track.
 
void ReleaseSounds ()
 
void UpdateDynamicParams () override
 
virtual void UpdateDynamicParams_Editor ()
 
virtual void UpdateDynamicParams_PureGame ()
 
- Protected Member Functions inherited from CUiAnimNode
int NumTracks () const
 
UiAnimationSystemGetUiAnimationSystemImpl () const
 
void RegisterTrack (IUiAnimTrack *track)
 
bool NeedToRender () const override
 

Protected Attributes

Vec3 m_pos
 
Quat m_rotate
 
Vec3 m_scale
 
- Protected Attributes inherited from CUiAnimNode
int m_refCount
 
EUiAnimNodeType m_nodeType
 
int m_id
 
AZStd::string m_name
 
IUiAnimSequencem_pSequence
 
IUiAnimNodeOwnerm_pOwner
 
IUiAnimNodem_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 }
 

Member Function Documentation

◆ Activate()

void CUiAnimAzEntityNode::Activate ( bool bActivate)
overridevirtual

Implements IUiAnimNode.

◆ AddTrack()

void CUiAnimAzEntityNode::AddTrack ( IUiAnimTrack * track)
overridevirtual

Implements IUiAnimNode.

◆ Animate()

void CUiAnimAzEntityNode::Animate ( SUiAnimContext & ec)
overridevirtual

Evaluate animation to the given time.

Implements IUiAnimNode.

◆ ComputeOffsetFromElementName()

const AZ::SerializeContext::ClassElement * CUiAnimAzEntityNode::ComputeOffsetFromElementName ( const AZ::SerializeContext::ClassData * classData,
IUiAnimTrack * track,
size_t baseOffset )
protected

Given the class data definition and a track for a field within it, compute the offset for the field and set it in the track

◆ CreateDefaultTracks()

void CUiAnimAzEntityNode::CreateDefaultTracks ( )
overridevirtual

Implements IUiAnimNode.

◆ CreateTrackForAzField()

IUiAnimTrack * CUiAnimAzEntityNode::CreateTrackForAzField ( const UiAnimParamData & param)
overridevirtual

Implements IUiAnimNode.

◆ GetParamCount()

unsigned int CUiAnimAzEntityNode::GetParamCount ( ) const
overridevirtual

Implements IUiAnimNode.

◆ GetParamInfoFromType()

bool CUiAnimAzEntityNode::GetParamInfoFromType ( const CUiAnimParamType & paramId,
SParamInfo & info ) const
overrideprotectedvirtual

Reimplemented from CUiAnimNode.

◆ GetParamName()

AZStd::string CUiAnimAzEntityNode::GetParamName ( const CUiAnimParamType & param) const
overridevirtual

Implements IUiAnimNode.

◆ GetParamNameForTrack()

AZStd::string CUiAnimAzEntityNode::GetParamNameForTrack ( const CUiAnimParamType & param,
const IUiAnimTrack * track ) const
overridevirtual

Reimplemented from IUiAnimNode.

◆ GetParamType()

CUiAnimParamType CUiAnimAzEntityNode::GetParamType ( unsigned int nIndex) const
overridevirtual

Implements IUiAnimNode.

◆ GetParamValueAz()

bool CUiAnimAzEntityNode::GetParamValueAz ( float time,
const UiAnimParamData & param,
float & value )
overridevirtual

Reimplemented from IUiAnimNode.

◆ GetTrackForAzField()

IUiAnimTrack * CUiAnimAzEntityNode::GetTrackForAzField ( const UiAnimParamData & param) const
overridevirtual

Implements IUiAnimNode.

◆ GetType()

EUiAnimNodeType CUiAnimAzEntityNode::GetType ( ) const
inlineoverridevirtual

Implements IUiAnimNode.

◆ InitPostLoad()

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

Implements IUiAnimNode.

◆ OnPause()

void CUiAnimAzEntityNode::OnPause ( )
overridevirtual

Reimplemented from CUiAnimNode.

◆ OnReset()

void CUiAnimAzEntityNode::OnReset ( )
overridevirtual

Implements IUiAnimNode.

◆ OnResetHard()

void CUiAnimAzEntityNode::OnResetHard ( )
overridevirtual

Reimplemented from CUiAnimNode.

◆ OnStart()

void CUiAnimAzEntityNode::OnStart ( )
overridevirtual

Reimplemented from CUiAnimNode.

◆ OnStop()

void CUiAnimAzEntityNode::OnStop ( )
overridevirtual

Reimplemented from CUiAnimNode.

◆ PrecacheDynamic()

void CUiAnimAzEntityNode::PrecacheDynamic ( float time)
overridevirtual

Reimplemented from CUiAnimNode.

◆ PrecacheStatic()

void CUiAnimAzEntityNode::PrecacheStatic ( float startTime)
overridevirtual

Reimplemented from CUiAnimNode.

◆ Serialize()

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

Implements IUiAnimNode.

◆ SetParamValueAz() [1/8]

bool CUiAnimAzEntityNode::SetParamValueAz ( float time,
const UiAnimParamData & param,
bool value )
overridevirtual

Reimplemented from IUiAnimNode.

◆ SetParamValueAz() [2/8]

bool CUiAnimAzEntityNode::SetParamValueAz ( float time,
const UiAnimParamData & param,
const AZ::Color & value )
overridevirtual

Reimplemented from IUiAnimNode.

◆ SetParamValueAz() [3/8]

bool CUiAnimAzEntityNode::SetParamValueAz ( float time,
const UiAnimParamData & param,
const AZ::Vector2 & value )
overridevirtual

Reimplemented from IUiAnimNode.

◆ SetParamValueAz() [4/8]

bool CUiAnimAzEntityNode::SetParamValueAz ( float time,
const UiAnimParamData & param,
const AZ::Vector3 & value )
overridevirtual

Reimplemented from IUiAnimNode.

◆ SetParamValueAz() [5/8]

bool CUiAnimAzEntityNode::SetParamValueAz ( float time,
const UiAnimParamData & param,
const AZ::Vector4 & value )
overridevirtual

Reimplemented from IUiAnimNode.

◆ SetParamValueAz() [6/8]

bool CUiAnimAzEntityNode::SetParamValueAz ( float time,
const UiAnimParamData & param,
float value )
overridevirtual

Reimplemented from IUiAnimNode.

◆ SetParamValueAz() [7/8]

bool CUiAnimAzEntityNode::SetParamValueAz ( float time,
const UiAnimParamData & param,
int value )
overridevirtual

Reimplemented from IUiAnimNode.

◆ SetParamValueAz() [8/8]

bool CUiAnimAzEntityNode::SetParamValueAz ( float time,
const UiAnimParamData & param,
unsigned int value )
overridevirtual

Reimplemented from IUiAnimNode.

◆ StillUpdate()

void CUiAnimAzEntityNode::StillUpdate ( )
overridevirtual

Evaluate animation node while not playing animation.

Implements IUiAnimNode.

◆ UpdateDynamicParams()

void CUiAnimAzEntityNode::UpdateDynamicParams ( )
overrideprotectedvirtual

Implements IUiAnimNode.


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