Inherits TUiAnimTrack< IEventKey >.

Public Member Functions
	AZ_CLASS_ALLOCATOR (CUiTrackEventTrack, AZ::SystemAllocator)

	AZ_RTTI (CUiTrackEventTrack, "{18AB327E-02EA-43D9-BA3B-FB93B6C15837}", IUiAnimTrack)

	CUiTrackEventTrack (IUiAnimStringTable *pStrings)

void	GetKeyInfo (int key, const char *&description, float &duration) override

void	SerializeKey (IEventKey &key, XmlNodeRef &keyNode, bool bLoading) override

void	SetKey (int index, IKey *key) override

void	InitPostLoad (IUiAnimSequence *sequence) override

Public Member Functions inherited from TUiAnimTrack< IEventKey >
	AZ_RTTI ((TUiAnimTrack, "{5513FA16-991D-40DD-99B2-9C5531AC872C}", IEventKey), IUiAnimTrack)

EUiAnimCurveType	GetCurveType () override

EUiAnimValue	GetValueType () override

int	GetSubTrackCount () const override

IUiAnimTrack *	GetSubTrack (int nIndex) const override

AZStd::string	GetSubTrackName (int nIndex) const override

void	SetSubTrackName (int nIndex, const char *name) override

const CUiAnimParamType &	GetParameterType () const override

void	SetParameterType (CUiAnimParamType type) override

const UiAnimParamData &	GetParamData () const override

void	SetParamData (const UiAnimParamData &param) override

void	add_ref () override

void	release () override

bool	IsKeySelected (int key) const override

void	SelectKey (int key, bool select) override

int	GetNumKeys () const override
	Return number of keys in track.

bool	HasKeys () const override
	Return true if keys exists in this track.

void	SetNumKeys (int numKeys) override

void	RemoveKey (int num) override
	Remove specified key.

int	CreateKey (float time) override

int	CloneKey (int fromKey) override

int	CopyKey (IUiAnimTrack *pFromTrack, int nFromKey) override

void	GetKey (int index, IKey *key) const override

float	GetKeyTime (int index) const override

int	FindKey (float time) override

int	GetKeyFlags (int index) override

void	SetKey (int index, IKey *key) override

void	SetKeyTime (int index, float time) override
	Set time of specified key.

void	SetKeyFlags (int index, int flags) override
	Set flags of specified key.

void	SortKeys () override
	Sort keys in track (after time of keys was modified).

int	GetFlags () override
	Get track flags.

bool	IsMasked (const uint32 mask) const override
	Check if track is masked.

void	SetFlags (int flags) override
	Set track flags.

void	GetValue (float time, float &value) override

void	GetValue (float time, Vec3 &value) override

void	GetValue (float time, Vec4 &value) override

void	GetValue (float time, Quat &value) override

void	GetValue (float time, bool &value) override

void	GetValue (float time, AZ::Vector2 &value) override

void	GetValue (float time, AZ::Vector3 &value) override

void	GetValue (float time, AZ::Vector4 &value) override

void	GetValue (float time, AZ::Color &value) override

void	SetValue (float time, const float &value, bool bDefault=false) override

void	SetValue (float time, const Vec3 &value, bool bDefault=false) override

void	SetValue (float time, const Vec4 &value, bool bDefault=false) override

void	SetValue (float time, const Quat &value, bool bDefault=false) override

void	SetValue (float time, const bool &value, bool bDefault=false) override

void	SetValue (float time, const AZ::Vector2 &value, bool bDefault=false) override

void	SetValue (float time, const AZ::Vector3 &value, bool bDefault=false) override

void	SetValue (float time, const AZ::Vector4 &value, bool bDefault=false) override

void	SetValue (float time, const AZ::Color &value, bool bDefault=false) override

void	OffsetKeyPosition (const Vec3 &value) override

void	SetTimeRange (const Range &timeRange) override

bool	Serialize (IUiAnimationSystem *uiAnimationSystem, XmlNodeRef &xmlNode, bool bLoading, bool bLoadEmptyTracks=true) override

bool	SerializeSelection (XmlNodeRef &xmlNode, bool bLoading, bool bCopySelected=false, float fTimeOffset=0) override

virtual void	SerializeKey (IEventKey &key, XmlNodeRef &keyNode, bool bLoading)=0

int	GetActiveKey (float time, IEventKey *key)

void	GetKeyValueRange (float &fMin, float &fMax) const override

void	SetKeyValueRange (float fMin, float fMax) override

Public Member Functions inherited from IUiAnimTrack
virtual void	add_ref ()=0

virtual void	release ()=0

virtual EUiAnimCurveType	GetCurveType ()=0

virtual EUiAnimValue	GetValueType ()=0

virtual ColorB	GetCustomColor () const =0

virtual void	SetCustomColor (ColorB color)=0

virtual bool	HasCustomColor () const =0

virtual void	ClearCustomColor ()=0

virtual const CUiAnimParamType &	GetParameterType () const =0

virtual void	SetParameterType (CUiAnimParamType type)=0

virtual const UiAnimParamData &	GetParamData () const =0

virtual void	SetParamData (const UiAnimParamData &param)=0

virtual int	GetSubTrackCount () const =0

virtual IUiAnimTrack *	GetSubTrack (int nIndex) const =0

virtual AZStd::string	GetSubTrackName (int nIndex) const =0

virtual void	SetSubTrackName (int nIndex, const char *name)=0

virtual void	GetKeyValueRange (float &fMin, float &fMax) const =0

virtual void	SetKeyValueRange (float fMin, float fMax)=0

virtual int	GetNumKeys () const =0
	Return number of keys in track.

virtual bool	HasKeys () const =0
	Return true if keys exists in this track.

virtual void	SetNumKeys (int numKeys)=0

virtual void	RemoveKey (int num)=0
	Remove specified key.

virtual void	GetKey (int index, IKey *key) const =0

virtual float	GetKeyTime (int index) const =0

virtual int	FindKey (float time)=0

virtual int	GetKeyFlags (int index)=0

virtual void	SetKey (int index, IKey *key)=0

virtual void	SetKeyTime (int index, float time)=0
	Set time of specified key.

virtual void	SetKeyFlags (int index, int flags)=0
	Set flags of specified key.

virtual void	SortKeys ()=0
	Sort keys in track (after time of keys was modified).

virtual int	GetFlags ()=0
	Get track flags.

virtual bool	IsMasked (const uint32 mask) const =0
	Check if track is masked by mask.

virtual void	SetFlags (int flags)=0
	Set track flags.

virtual int	CreateKey (float time)=0

virtual int	CloneKey (int key)=0

virtual int	CopyKey (IUiAnimTrack *pFromTrack, int nFromKey)=0

virtual void	GetKeyInfo (int key, const char *&description, float &duration)=0

virtual void	GetValue (float time, float &value)=0

virtual void	GetValue (float time, Vec3 &value)=0

virtual void	GetValue (float time, Vec4 &value)=0

virtual void	GetValue (float time, Quat &value)=0

virtual void	GetValue (float time, bool &value)=0

virtual void	GetValue (float time, AZ::Vector2 &value)=0

virtual void	GetValue (float time, AZ::Vector3 &value)=0

virtual void	GetValue (float time, AZ::Vector4 &value)=0

virtual void	GetValue (float time, AZ::Color &value)=0

virtual void	SetValue (float time, const float &value, bool bDefault=false)=0

virtual void	SetValue (float time, const Vec3 &value, bool bDefault=false)=0

virtual void	SetValue (float time, const Vec4 &value, bool bDefault=false)=0

virtual void	SetValue (float time, const Quat &value, bool bDefault=false)=0

virtual void	SetValue (float time, const bool &value, bool bDefault=false)=0

virtual void	SetValue (float time, const AZ::Vector2 &value, bool bDefault=false)=0

virtual void	SetValue (float time, const AZ::Vector3 &value, bool bDefault=false)=0

virtual void	SetValue (float time, const AZ::Vector4 &value, bool bDefault=false)=0

virtual void	SetValue (float time, const AZ::Color &value, bool bDefault=false)=0

virtual void	OffsetKeyPosition (const Vec3 &value)=0

virtual void	SetTimeRange (const Range &timeRange)=0

virtual bool	Serialize (IUiAnimationSystem *uiAnimationSystem, XmlNodeRef &xmlNode, bool bLoading, bool bLoadEmptyTracks=true)=0

virtual bool	SerializeSelection (XmlNodeRef &xmlNode, bool bLoading, bool bCopySelected=false, float fTimeOffset=0)=0

virtual void	InitPostLoad (IUiAnimSequence *)

virtual void	Animate (SUiAnimContext &ec)
	For custom track animate parameters.

virtual ISplineInterpolator *	GetSpline () const

virtual bool	IsKeySelected (int key) const

virtual void	SelectKey (int key, bool select)

virtual int	NextKeyByTime (int key) const

virtual int	GetAnimationLayerIndex () const
	Get the animation layer index assigned. (only for character/look-at tracks ATM)

virtual void	SetAnimationLayerIndex (int index)
	Set the animation layer index. (only for character/look-at tracks ATM)

Static Public Member Functions
static void	Reflect (AZ::SerializeContext *serializeContext)

Static Public Member Functions inherited from TUiAnimTrack< IEventKey >
static void	Reflect (AZ::SerializeContext *serializeContext)

Additional Inherited Members
Public Types inherited from IUiAnimTrack
enum	EUiAnimTrackFlags { eUiAnimTrackFlags_Linear = BIT(1) , eUiAnimTrackFlags_Loop = BIT(2) , eUiAnimTrackFlags_Cycle = BIT(3) , eUiAnimTrackFlags_Disabled = BIT(4) , eUiAnimTrackFlags_Hidden = BIT(5) , eUiAnimTrackFlags_Muted = BIT(8) }
	Flags that can be set on animation track. More...

Protected Types inherited from TUiAnimTrack< IEventKey >
typedef AZStd::vector< IEventKey >	Keys

Protected Member Functions inherited from TUiAnimTrack< IEventKey >
void	CheckValid ()

void	Invalidate ()

Protected Attributes inherited from TUiAnimTrack< IEventKey >
int	m_refCount

Keys	m_keys

Range	m_timeRange

CUiAnimParamType	m_nParamType

unsigned int	m_currKey

unsigned int	m_bModified

float	m_lastTime

int	m_flags

UiAnimParamData	m_componentParamData

float	m_fMinKeyValue

float	m_fMaxKeyValue

Static Protected Attributes inherited from TUiAnimTrack< IEventKey >
static constexpr unsigned int	InvalidKey

Member Function Documentation

◆ GetKeyInfo()

void CUiTrackEventTrack::GetKeyInfo	(	int	key,
		const char *&	description,
		float &	duration
	)

overridevirtual

Get info about specified key.

Parameters

Short	human readable text description of this key.
duration	of this key in seconds.

Implements IUiAnimTrack.

◆ InitPostLoad()

void CUiTrackEventTrack::InitPostLoad ( IUiAnimSequence * sequence )

overridevirtual

Reimplemented from IUiAnimTrack.

◆ SerializeKey()

void CUiTrackEventTrack::SerializeKey	(	IEventKey &	key,
		XmlNodeRef &	keyNode,
		bool	bLoading
	)

overridevirtual

Serialize single key of this track. Override this in derived classes. Do not save time attribute, it is already saved in Serialize of the track.

Implements TUiAnimTrack< IEventKey >.

◆ SetKey()

void CUiTrackEventTrack::SetKey	(	int	index,
		IKey *	key
	)

overridevirtual

Set key at specified location.

Parameters

key	Must be valid pointer to compatible key structure.

Implements IUiAnimTrack.

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

Gems/LyShine/Code/Source/Animation/TrackEventTrack.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ GetKeyInfo()

◆ InitPostLoad()

◆ SerializeKey()

◆ SetKey()