#include <IUiAnimation.h>

Inherited by TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, TUiAnimSplineTrack< ValueType >, TUiAnimTrack< KeyType >, and UiCompoundSplineTrack.

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

Public Member Functions
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)

Detailed Description

Interface of Animation Track.

Member Enumeration Documentation

◆ EUiAnimTrackFlags

enum IUiAnimTrack::EUiAnimTrackFlags

Flags that can be set on animation track.

Enumerator
eUiAnimTrackFlags_Linear	Use only linear interpolation between keys.
eUiAnimTrackFlags_Loop	Play this track in a loop.
eUiAnimTrackFlags_Cycle	Cycle track.
eUiAnimTrackFlags_Disabled	Disable this track.
eUiAnimTrackFlags_Hidden	Set when track is hidden in UI Animation editor.
eUiAnimTrackFlags_Muted	Mute this sound track. This only affects the playback in editor.

Member Function Documentation

◆ CloneKey()

virtual int IUiAnimTrack::CloneKey ( int key )

pure virtual

Clone key at specified index. @retun Index of new key.

Implemented in TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, UiCompoundSplineTrack, TUiAnimSplineTrack< ValueType >, and TUiAnimSplineTrack< Vec2 >.

◆ CopyKey()

virtual int IUiAnimTrack::CopyKey	(	IUiAnimTrack *	pFromTrack,
		int	nFromKey
	)

pure virtual

Clone key at specified index from another track of SAME TYPE. @retun Index of new key.

Implemented in TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, and UiCompoundSplineTrack.

◆ CreateKey()

virtual int IUiAnimTrack::CreateKey ( float time )

pure virtual

Create key at given time, and return its index.

Returns: Index of new key.

Implemented in TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, and UiCompoundSplineTrack.

◆ FindKey()

virtual int IUiAnimTrack::FindKey ( float time )

pure virtual

Find key at given time.

Returns: Index of found key, or -1 if key with this time not found.

Implemented in TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, and UiCompoundSplineTrack.

◆ GetFlags()

virtual int IUiAnimTrack::GetFlags ( )

pure virtual

Get track flags.

Implemented in TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, and UiCompoundSplineTrack.

◆ GetKey()

virtual void IUiAnimTrack::GetKey	(	int	index,
		IKey *	key
	)		const

pure virtual

Get key at specified location.

Parameters

key	Must be valid pointer to compatible key structure, to be filled with specified key location.

Implemented in TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, and UiCompoundSplineTrack.

◆ GetKeyFlags()

virtual int IUiAnimTrack::GetKeyFlags ( int index )

pure virtual

Get flags of specified key.

Returns: key time.

Implemented in TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, and UiCompoundSplineTrack.

◆ GetKeyInfo()

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

pure virtual

Get info about specified key.

Parameters

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

Implemented in UiBoolTrack, TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, UiCompoundSplineTrack, and CUiTrackEventTrack.

◆ GetKeyTime()

virtual float IUiAnimTrack::GetKeyTime ( int index ) const

pure virtual

Get time of specified key.

Returns: key time.

Implemented in TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, and UiCompoundSplineTrack.

◆ GetNumKeys()

virtual int IUiAnimTrack::GetNumKeys ( ) const

pure virtual

Return number of keys in track.

Implemented in TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, and UiCompoundSplineTrack.

◆ HasKeys()

virtual bool IUiAnimTrack::HasKeys ( ) const

pure virtual

Return true if keys exists in this track.

Implemented in TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, and UiCompoundSplineTrack.

◆ IsMasked()

virtual bool IUiAnimTrack::IsMasked ( const uint32 mask ) const

pure virtual

Check if track is masked by mask.

Implemented in TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, and UiCompoundSplineTrack.

◆ NextKeyByTime()

virtual int IUiAnimTrack::NextKeyByTime ( int key ) const

inlinevirtual

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

◆ RemoveKey()

virtual void IUiAnimTrack::RemoveKey ( int num )

pure virtual

Remove specified key.

Implemented in TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, and UiCompoundSplineTrack.

◆ Serialize()

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

pure virtual

Implemented in TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, and TUiAnimTrack< IBoolKey >.

◆ SetFlags()

virtual void IUiAnimTrack::SetFlags ( int flags )

pure virtual

Set track flags.

Implemented in TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, and UiCompoundSplineTrack.

◆ SetKey()

virtual void IUiAnimTrack::SetKey	(	int	index,
		IKey *	key
	)

pure virtual

Set key at specified location.

Parameters

key	Must be valid pointer to compatible key structure.

Implemented in TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, UiCompoundSplineTrack, and CUiTrackEventTrack.

◆ SetKeyFlags()

virtual void IUiAnimTrack::SetKeyFlags	(	int	index,
		int	flags
	)

pure virtual

Set flags of specified key.

Implemented in TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, and UiCompoundSplineTrack.

◆ SetKeyTime()

virtual void IUiAnimTrack::SetKeyTime	(	int	index,
		float	time
	)

pure virtual

Set time of specified key.

Implemented in TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, and UiCompoundSplineTrack.

◆ SetNumKeys()

virtual void IUiAnimTrack::SetNumKeys ( int numKeys )

pure virtual

Set number of keys in track. If needed adds empty keys at end or remove keys from end.

Implemented in TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, and UiCompoundSplineTrack.

◆ SetTimeRange()

virtual void IUiAnimTrack::SetTimeRange ( const Range & timeRange )

pure virtual

Implemented in TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, and TUiAnimTrack< IBoolKey >.

◆ SortKeys()

virtual void IUiAnimTrack::SortKeys ( )

pure virtual

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

Implemented in TUiAnimSplineTrack< ValueType >, TUiAnimSplineTrack< Vec2 >, TUiAnimTrack< KeyType >, TUiAnimTrack< IEventKey >, TUiAnimTrack< IBoolKey >, and UiCompoundSplineTrack.

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

Gems/LyShine/Code/Include/LyShine/Animation/IUiAnimation.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ EUiAnimTrackFlags

Member Function Documentation

◆ CloneKey()

◆ CopyKey()

◆ CreateKey()

◆ FindKey()

◆ GetFlags()

◆ GetKey()

◆ GetKeyFlags()

◆ GetKeyInfo()

◆ GetKeyTime()

◆ GetNumKeys()

◆ HasKeys()

◆ IsMasked()

◆ NextKeyByTime()

◆ RemoveKey()

◆ Serialize()

◆ SetFlags()

◆ SetKey()

◆ SetKeyFlags()

◆ SetKeyTime()

◆ SetNumKeys()

◆ SetTimeRange()

◆ SortKeys()