Inherits IUiAnimTrack.

Public Member Functions
	AZ_RTTI (UiCompoundSplineTrack, "{91947B8B-65B7-451D-9D04-0C821C82014E}", IUiAnimTrack)

	UiCompoundSplineTrack (int nDims, EUiAnimValue inValueType, CUiAnimParamType subTrackParamTypes[MAX_SUBTRACKS])

void	add_ref () override

void	release () 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

EUiAnimCurveType	GetCurveType () override

EUiAnimValue	GetValueType () override

const CUiAnimParamType &	GetParameterType () const override

void	SetParameterType (CUiAnimParamType type) override

const UiAnimParamData &	GetParamData () const override

void	SetParamData (const UiAnimParamData &param) override

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

void	SetNumKeys ([[maybe_unused]] int numKeys) override

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

void	RemoveKey (int num) override
	Remove specified key.

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

int	CreateKey ([[maybe_unused]] float time) override

int	CloneKey ([[maybe_unused]] int fromKey) override

int	CopyKey ([[maybe_unused]] IUiAnimTrack *pFromTrack, [[maybe_unused]] int nFromKey) override

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

float	GetKeyTime (int index) const override

int	FindKey ([[maybe_unused]] float time) override

int	GetKeyFlags ([[maybe_unused]] int index) override

void	SetKey ([[maybe_unused]] int index, [[maybe_unused]] IKey *key) override

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

void	SetKeyFlags ([[maybe_unused]] int index, [[maybe_unused]] int flags) override

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

bool	IsKeySelected (int key) const override

void	SelectKey (int key, bool select) override

int	GetFlags () override
	Get track flags.

bool	IsMasked ([[maybe_unused]] const uint32 mask) const override

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, 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	GetValue ([[maybe_unused]] float time, [[maybe_unused]] bool &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 ([[maybe_unused]] float time, [[maybe_unused]] const bool &value, [[maybe_unused]] 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 AZ::Vector3 &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

int	NextKeyByTime (int key) const override

void	SetSubTrackName (const int i, const AZStd::string &name)

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

void	SetKeyValueRange (float fMin, float fMax) override

Public Member Functions inherited from IUiAnimTrack
virtual ColorB	GetCustomColor () const =0

virtual void	SetCustomColor (ColorB color)=0

virtual bool	HasCustomColor () const =0

virtual void	ClearCustomColor ()=0

virtual void	SetNumKeys (int numKeys)=0

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

virtual int	FindKey (float time)=0

virtual int	GetKeyFlags (int index)=0

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

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

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

virtual int	CreateKey (float time)=0

virtual int	CloneKey (int key)=0

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

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

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

virtual void	InitPostLoad (IUiAnimSequence *)

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

virtual ISplineInterpolator *	GetSpline () const

virtual bool	IsKeySelected ([[maybe_unused]] int key) const

virtual void	SelectKey ([[maybe_unused]] int key, [[maybe_unused]] bool select)

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

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

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

Protected Member Functions
void	PrepareNodeForSubTrackSerialization (XmlNodeRef &subTrackNode, XmlNodeRef &xmlNode, int i, bool bLoading)

float	PreferShortestRotPath (float degree, float degree0) const

int	GetSubTrackIndex (int &key) const

Protected Attributes
int	m_refCount

EUiAnimValue	m_valueType

int	m_nDimensions

AZStd::array< AZStd::intrusive_ptr< IUiAnimTrack >, MAX_SUBTRACKS >	m_subTracks

int	m_flags

CUiAnimParamType	m_nParamType

AZStd::array< AZStd::string, MAX_SUBTRACKS >	m_subTrackNames

UiAnimParamData	m_componentParamData

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...

Member Function Documentation

◆ GetKeyInfo()

void UiCompoundSplineTrack::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.

◆ GetKeyTime()

float UiCompoundSplineTrack::GetKeyTime ( int index ) const

overridevirtual

Get time of specified key.

Returns: key time.

Implements IUiAnimTrack.

◆ NextKeyByTime()

int UiCompoundSplineTrack::NextKeyByTime ( int key ) const

overridevirtual

Return the index of the key which lies right after the given key in time.

Parameters

key	Index of of key.

Returns: Index of the next key in time. If the last key given, this returns -1.

Reimplemented from IUiAnimTrack.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ GetKeyInfo()

◆ GetKeyTime()

◆ NextKeyByTime()