#include <IUiAnimation.h>

Inherited by CUiAnimSequence.

Public Types
enum	EUiAnimSequenceFlags { eSeqFlags_PlayOnReset = BIT(0) , eSeqFlags_OutOfRangeConstant = BIT(1) , eSeqFlags_OutOfRangeLoop = BIT(2) , eSeqFlags_CutScene = BIT(3) , eSeqFlags_NoHUD = BIT(4) , eSeqFlags_NoPlayer = BIT(5) , eSeqFlags_16To9 = BIT(8) , eSeqFlags_NoGameSounds = BIT(9) , eSeqFlags_NoSeek = BIT(10) , eSeqFlags_NoAbort = BIT(11) , eSeqFlags_NoSpeed = BIT(13) , eSeqFlags_EarlyAnimationUpdate = BIT(15) , eSeqFlags_LightAnimationSet = BIT(16) , eSeqFlags_NoMPSyncingNeeded = BIT(17) }
	Flags used for SetFlags(),GetFlags(),SetParentFlags(),GetParentFlags() methods. More...

Public Member Functions
virtual void	add_ref ()=0

virtual void	release ()=0

virtual IUiAnimationSystem *	GetUiAnimationSystem () const =0
	Set the animation system for the canvas containing this sequence.

virtual void	SetName (const char *name)=0
	Set the name of this sequence. (ex. "Intro" in the same case as above)

virtual const char *	GetName () const =0
	Get the name of this sequence. (ex. "Intro" in the same case as above)

virtual uint32	GetId () const =0
	Get the ID (unique in a level and consistent across renaming) of this sequence.

virtual void	SetOwner (IUiAnimSequenceOwner *pOwner)=0

virtual IUiAnimSequenceOwner *	GetOwner () const =0

virtual void	SetActiveDirector (IUiAnimNode *pDirectorNode)=0
	Set the currently active director node.

virtual IUiAnimNode *	GetActiveDirector () const =0
	Get the currently active director node, if any.

virtual void	SetFlags (int flags)=0
	Set animation sequence flags.

virtual int	GetFlags () const =0
	Get animation sequence flags.

virtual int	GetCutSceneFlags (const bool localFlags=false) const =0
	Get cutscene related animation sequence flags.

virtual void	SetParentSequence (IUiAnimSequence *pParentSequence)=0
	Set parent animation sequence.

virtual const IUiAnimSequence *	GetParentSequence () const =0
	Get parent animation sequence.

virtual bool	IsAncestorOf (const IUiAnimSequence *sequence) const =0
	Check whether this sequence has the given sequence as a descendant through one of its sequence tracks.

virtual int	GetNodeCount () const =0
	Return number of animation nodes in sequence.

virtual IUiAnimNode *	GetNode (int index) const =0
	Get animation node at specified index.

virtual bool	AddNode (IUiAnimNode *node)=0

virtual void	ReorderNode (IUiAnimNode node, IUiAnimNode pPivotNode, bool next)=0

virtual IUiAnimNode *	CreateNode (EUiAnimNodeType nodeType)=0

virtual IUiAnimNode *	CreateNode (XmlNodeRef node)=0

virtual void	RemoveNode (IUiAnimNode *node)=0
	Remove animation node from sequence.

virtual IUiAnimNode *	FindNodeByName (const char sNodeName, const IUiAnimNode pParentDirector)=0

virtual void	RemoveAll ()=0
	Remove all nodes from sequence.

virtual void	Activate ()=0

virtual bool	IsActivated () const =0

virtual void	Deactivate ()=0

virtual void	PrecacheData (float startTime=0.0f)=0

virtual void	StillUpdate ()=0

virtual void	Render ()=0

virtual void	Animate (const SUiAnimContext &ec)=0

virtual void	SetTimeRange (Range timeRange)=0
	Set time range of this sequence.

virtual Range	GetTimeRange ()=0
	Get time range of this sequence.

virtual void	Reset (bool bSeekToStart)=0
	Resets the sequence.

virtual void	ResetHard ()=0
	This can have more time-consuming tasks performed additional to tasks of the usual 'Reset()' method.

virtual void	Pause ()=0

virtual void	Resume ()=0

virtual bool	IsPaused () const =0

virtual void	OnLoop ()=0

virtual void	AdjustKeysToTimeRange (const Range &timeRange)=0

virtual void	Serialize (XmlNodeRef &xmlNode, bool bLoading, bool bLoadEmptyTracks=true, uint32 overrideId=0, bool bUndo=false)=0

virtual void	InitPostLoad (IUiAnimationSystem pUiAnimationSystem, bool remapIds, LyShine::EntityIdMap entityIdMap)=0

virtual void	CopyNodes (XmlNodeRef &xmlNode, IUiAnimNode **pSelectedNodes, uint32 count)=0

virtual void	PasteNodes (const XmlNodeRef &xmlNode, IUiAnimNode *pParent)=0

virtual bool	AddTrackEvent (const char *szEvent)=0

virtual bool	RemoveTrackEvent (const char *szEvent)=0

virtual bool	RenameTrackEvent (const char szEvent, const char szNewEvent)=0

virtual bool	MoveUpTrackEvent (const char *szEvent)=0

virtual bool	MoveDownTrackEvent (const char *szEvent)=0

virtual void	ClearTrackEvents ()=0

virtual int	GetTrackEventsCount () const =0

virtual char const *	GetTrackEvent (int iIndex) const =0

virtual IUiAnimStringTable *	GetTrackEventStringTable ()=0

virtual void	TriggerTrackEvent (const char event, const char param=NULL)=0

virtual void	AddTrackEventListener (IUiTrackEventListener *pListener)=0
	Track event listener.

virtual void	RemoveTrackEventListener (IUiTrackEventListener *pListener)=0

Static Public Attributes
static const int	kSequenceVersion = 3

Detailed Description

Animation sequence, operates on animation nodes contained in it.

Member Enumeration Documentation

◆ EUiAnimSequenceFlags

enum IUiAnimSequence::EUiAnimSequenceFlags

Flags used for SetFlags(),GetFlags(),SetParentFlags(),GetParentFlags() methods.

Enumerator
eSeqFlags_PlayOnReset	Start playing this sequence immediately after reset of UI animation system(Level load).
eSeqFlags_OutOfRangeConstant	Constant Out-Of-Range,time continues normally past sequence time range.
eSeqFlags_OutOfRangeLoop	Loop Out-Of-Range,time wraps back to the start of range when reaching end of range.
eSeqFlags_CutScene	Cut scene sequence.
eSeqFlags_NoHUD	Deprecated: Don`t display HUD
eSeqFlags_NoPlayer	Disable input and drawing of player.
eSeqFlags_16To9	16:9 bars in sequence
eSeqFlags_NoGameSounds	Suppress all game sounds.
eSeqFlags_NoSeek	Cannot seek in sequence.
eSeqFlags_NoAbort	Cutscene can not be aborted.
eSeqFlags_NoSpeed	Cannot modify sequence speed - TODO: add interface control if required.
eSeqFlags_EarlyAnimationUpdate	Turn the 'sys_earlyUiAnimationUpdate' on during the sequence.
eSeqFlags_LightAnimationSet	A special unique sequence for light animations.
eSeqFlags_NoMPSyncingNeeded	this sequence doesn't require MP net syncing

Member Function Documentation

◆ AddNode()

virtual bool IUiAnimSequence::AddNode ( IUiAnimNode * node )

pure virtual

Add animation node to sequence.

Returns: True if node added, same node will not be added 2 times.

Implemented in CUiAnimSequence.

◆ AddTrackEvent()

virtual bool IUiAnimSequence::AddTrackEvent ( const char * szEvent )

pure virtual

Implemented in CUiAnimSequence.

◆ AddTrackEventListener()

virtual void IUiAnimSequence::AddTrackEventListener ( IUiTrackEventListener * pListener )

pure virtual

Track event listener.

Implemented in CUiAnimSequence.

◆ AdjustKeysToTimeRange()

virtual void IUiAnimSequence::AdjustKeysToTimeRange ( const Range & timeRange )

pure virtual

Move/Scale all keys in tracks from previous time range to new time range.

Implemented in CUiAnimSequence.

◆ GetActiveDirector()

virtual IUiAnimNode * IUiAnimSequence::GetActiveDirector ( ) const

pure virtual

Get the currently active director node, if any.

Implemented in CUiAnimSequence.

◆ GetCutSceneFlags()

virtual int IUiAnimSequence::GetCutSceneFlags ( const bool localFlags = false ) const

pure virtual

Get cutscene related animation sequence flags.

Implemented in CUiAnimSequence.

◆ GetFlags()

virtual int IUiAnimSequence::GetFlags ( ) const

pure virtual

Get animation sequence flags.

Implemented in CUiAnimSequence.

◆ GetId()

virtual uint32 IUiAnimSequence::GetId ( ) const

pure virtual

Get the ID (unique in a level and consistent across renaming) of this sequence.

Implemented in CUiAnimSequence.

◆ GetName()

virtual const char * IUiAnimSequence::GetName ( ) const

pure virtual

Get the name of this sequence. (ex. "Intro" in the same case as above)

Implemented in CUiAnimSequence.

◆ GetNode()

virtual IUiAnimNode * IUiAnimSequence::GetNode ( int index ) const

pure virtual

Get animation node at specified index.

Implemented in CUiAnimSequence.

◆ GetNodeCount()

virtual int IUiAnimSequence::GetNodeCount ( ) const

pure virtual

Return number of animation nodes in sequence.

Implemented in CUiAnimSequence.

◆ GetParentSequence()

virtual const IUiAnimSequence * IUiAnimSequence::GetParentSequence ( ) const

pure virtual

Get parent animation sequence.

Implemented in CUiAnimSequence.

◆ GetTimeRange()

virtual Range IUiAnimSequence::GetTimeRange ( )

pure virtual

Get time range of this sequence.

Implemented in CUiAnimSequence.

◆ GetTrackEventsCount()

virtual int IUiAnimSequence::GetTrackEventsCount ( ) const

pure virtual

Implemented in CUiAnimSequence.

◆ GetUiAnimationSystem()

virtual IUiAnimationSystem * IUiAnimSequence::GetUiAnimationSystem ( ) const

pure virtual

Set the animation system for the canvas containing this sequence.

Implemented in CUiAnimSequence.

◆ IsActivated()

virtual bool IUiAnimSequence::IsActivated ( ) const

pure virtual

Check if sequence is activated

Implemented in CUiAnimSequence.

◆ IsAncestorOf()

virtual bool IUiAnimSequence::IsAncestorOf ( const IUiAnimSequence * sequence ) const

pure virtual

Check whether this sequence has the given sequence as a descendant through one of its sequence tracks.

Implemented in CUiAnimSequence.

◆ IsPaused()

virtual bool IUiAnimSequence::IsPaused ( ) const

pure virtual

Called to check if sequence is paused.

Implemented in CUiAnimSequence.

◆ OnLoop()

virtual void IUiAnimSequence::OnLoop ( )

pure virtual

Called when a sequence is looped.

Implemented in CUiAnimSequence.

◆ RemoveAll()

virtual void IUiAnimSequence::RemoveAll ( )

pure virtual

Remove all nodes from sequence.

Implemented in CUiAnimSequence.

◆ RemoveNode()

virtual void IUiAnimSequence::RemoveNode ( IUiAnimNode * node )

pure virtual

Remove animation node from sequence.

Implemented in CUiAnimSequence.

◆ Reset()

virtual void IUiAnimSequence::Reset ( bool bSeekToStart )

pure virtual

Resets the sequence.

Implemented in CUiAnimSequence.

◆ ResetHard()

virtual void IUiAnimSequence::ResetHard ( )

pure virtual

This can have more time-consuming tasks performed additional to tasks of the usual 'Reset()' method.

Implemented in CUiAnimSequence.

◆ SetActiveDirector()

virtual void IUiAnimSequence::SetActiveDirector ( IUiAnimNode * pDirectorNode )

pure virtual

Set the currently active director node.

Implemented in CUiAnimSequence.

◆ SetFlags()

virtual void IUiAnimSequence::SetFlags ( int flags )

pure virtual

Set animation sequence flags.

Implemented in CUiAnimSequence.

◆ SetName()

virtual void IUiAnimSequence::SetName ( const char * name )

pure virtual

Set the name of this sequence. (ex. "Intro" in the same case as above)

Implemented in CUiAnimSequence.

◆ SetParentSequence()

virtual void IUiAnimSequence::SetParentSequence ( IUiAnimSequence * pParentSequence )

pure virtual

Set parent animation sequence.

Implemented in CUiAnimSequence.

◆ SetTimeRange()

virtual void IUiAnimSequence::SetTimeRange ( Range timeRange )

pure virtual

Set time range of this sequence.

Implemented in CUiAnimSequence.

◆ TriggerTrackEvent()

virtual void IUiAnimSequence::TriggerTrackEvent	(	const char *	event,
		const char *	param = `NULL`
	)

pure virtual

Implemented in CUiAnimSequence.

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

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

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ EUiAnimSequenceFlags

Member Function Documentation

◆ AddNode()

◆ AddTrackEvent()

◆ AddTrackEventListener()

◆ AdjustKeysToTimeRange()

◆ GetActiveDirector()

◆ GetCutSceneFlags()

◆ GetFlags()

◆ GetId()

◆ GetName()

◆ GetNode()

◆ GetNodeCount()

◆ GetParentSequence()

◆ GetTimeRange()

◆ GetTrackEventsCount()

◆ GetUiAnimationSystem()

◆ IsActivated()

◆ IsAncestorOf()

◆ IsPaused()

◆ OnLoop()

◆ RemoveAll()

◆ RemoveNode()

◆ Reset()

◆ ResetHard()

◆ SetActiveDirector()

◆ SetFlags()

◆ SetName()

◆ SetParentSequence()

◆ SetTimeRange()

◆ TriggerTrackEvent()