CUiAnimSequence Class Reference

Inherits IUiAnimSequence.

Public Member Functions
	AZ_RTTI (CUiAnimSequence, "{AA5AB4ED-CB98-4166-953E-0FE1EF7AC61F}", IUiAnimSequence)
	CUiAnimSequence (IUiAnimationSystem *pUiAnimationSystem, uint32 id)
void	add_ref () override
void	release () override
IUiAnimationSystem *	GetUiAnimationSystem () const override
	Set the animation system for the canvas containing this sequence.
void	SetName (const char *name) override
	Set the name of this sequence. (ex. "Intro" in the same case as above)
const char *	GetName () const override
	Get the name of this sequence. (ex. "Intro" in the same case as above)
uint32	GetId () const override
	Get the ID (unique in a level and consistent across renaming) of this sequence.
float	GetTime () const
void	SetOwner (IUiAnimSequenceOwner *pOwner) override
IUiAnimSequenceOwner *	GetOwner () const override
void	SetActiveDirector (IUiAnimNode *pDirectorNode) override
	Set the currently active director node.
IUiAnimNode *	GetActiveDirector () const override
	Get the currently active director node, if any.
void	SetFlags (int flags) override
	Set animation sequence flags.
int	GetFlags () const override
	Get animation sequence flags.
int	GetCutSceneFlags (const bool localFlags=false) const override
	Get cutscene related animation sequence flags.
void	SetParentSequence (IUiAnimSequence *pParentSequence) override
	Set parent animation sequence.
const IUiAnimSequence *	GetParentSequence () const override
	Get parent animation sequence.
bool	IsAncestorOf (const IUiAnimSequence *pSequence) const override
	Check whether this sequence has the given sequence as a descendant through one of its sequence tracks.
void	SetTimeRange (Range timeRange) override
	Set time range of this sequence.
Range	GetTimeRange () override
	Get time range of this sequence.
void	AdjustKeysToTimeRange (const Range &timeRange) override
int	GetNodeCount () const override
	Return number of animation nodes in sequence.
IUiAnimNode *	GetNode (int index) const override
	Get specified animation node.
IUiAnimNode *	FindNodeByName (const char *sNodeName, const IUiAnimNode *pParentDirector) override
IUiAnimNode *	FindNodeById (int nNodeId)
void	ReorderNode (IUiAnimNode *node, IUiAnimNode *pPivotNode, bool next) override
void	Reset (bool bSeekToStart) override
	Resets the sequence.
void	ResetHard () override
	This can have more time-consuming tasks performed additional to tasks of the usual 'Reset()' method.
void	Pause () override
void	Resume () override
bool	IsPaused () const override
virtual void	OnStart ()
virtual void	OnStop ()
void	OnLoop () override
bool	AddNode (IUiAnimNode *node) override
	Add animation node to sequence.
IUiAnimNode *	CreateNode (EUiAnimNodeType nodeType) override
IUiAnimNode *	CreateNode (XmlNodeRef node) override
void	RemoveNode (IUiAnimNode *node) override
	Remove animation node from sequence.
void	RemoveAll () override
	Add scene node to sequence.
void	Activate () override
bool	IsActivated () const override
void	Deactivate () override
void	PrecacheData (float startTime) override
void	PrecacheStatic (const float startTime)
void	PrecacheDynamic (float time)
void	StillUpdate () override
void	Animate (const SUiAnimContext &ec) override
void	Render () override
void	Serialize (XmlNodeRef &xmlNode, bool bLoading, bool bLoadEmptyTracks=true, uint32 overrideId=0, bool bResetLightAnimSet=false) override
void	InitPostLoad (IUiAnimationSystem *pUiAnimationSystem, bool remapIds, LyShine::EntityIdMap *entityIdMap) override
void	CopyNodes (XmlNodeRef &xmlNode, IUiAnimNode **pSelectedNodes, uint32 count) override
void	PasteNodes (const XmlNodeRef &xmlNode, IUiAnimNode *pParent) override
bool	AddTrackEvent (const char *szEvent) override
	Add/remove track events in sequence.
bool	RemoveTrackEvent (const char *szEvent) override
bool	RenameTrackEvent (const char *szEvent, const char *szNewEvent) override
bool	MoveUpTrackEvent (const char *szEvent) override
bool	MoveDownTrackEvent (const char *szEvent) override
void	ClearTrackEvents () override
int	GetTrackEventsCount () const override
	Get the track events in the sequence.
char const *	GetTrackEvent (int iIndex) const override
IUiAnimStringTable *	GetTrackEventStringTable () override
void	TriggerTrackEvent (const char *event, const char *param=nullptr) override
	Call to trigger a track event.
void	AddTrackEventListener (IUiTrackEventListener *pListener) override
	Track event listener.
void	RemoveTrackEventListener (IUiTrackEventListener *pListener) override
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 Member Functions
static void	Reflect (AZ::SerializeContext *serializeContext)

Additional Inherited Members
Public Types inherited from IUiAnimSequence
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...
Static Public Attributes inherited from IUiAnimSequence
static const int	kSequenceVersion = 3

Member Function Documentation

Activate()

void CUiAnimSequence::Activate ( )

overridevirtual

Implements IUiAnimSequence.

add_ref()

void CUiAnimSequence::add_ref ( )

overridevirtual

Implements IUiAnimSequence.

AddNode()

bool CUiAnimSequence::AddNode ( IUiAnimNode *  node )

overridevirtual

Add animation node to sequence.

Implements IUiAnimSequence.

AddTrackEvent()

bool CUiAnimSequence::AddTrackEvent ( const char *  szEvent )

overridevirtual

Add/remove track events in sequence.

Implements IUiAnimSequence.

AddTrackEventListener()

void CUiAnimSequence::AddTrackEventListener ( IUiTrackEventListener *  pListener )

overridevirtual

Track event listener.

Implements IUiAnimSequence.

AdjustKeysToTimeRange()

void CUiAnimSequence::AdjustKeysToTimeRange ( const Range &  timeRange )

overridevirtual

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

Implements IUiAnimSequence.

Animate()

void CUiAnimSequence::Animate ( const SUiAnimContext &  ec )

overridevirtual

Implements IUiAnimSequence.

ClearTrackEvents()

void CUiAnimSequence::ClearTrackEvents ( )

overridevirtual

Implements IUiAnimSequence.

CopyNodes()

void CUiAnimSequence::CopyNodes ( XmlNodeRef &  xmlNode, IUiAnimNode **  pSelectedNodes, uint32  count  )

overridevirtual

Implements IUiAnimSequence.

CreateNode() [1/2]

IUiAnimNode * CUiAnimSequence::CreateNode ( EUiAnimNodeType  nodeType )

overridevirtual

Implements IUiAnimSequence.

CreateNode() [2/2]

IUiAnimNode * CUiAnimSequence::CreateNode ( XmlNodeRef  node )

overridevirtual

Implements IUiAnimSequence.

Deactivate()

void CUiAnimSequence::Deactivate ( )

overridevirtual

Implements IUiAnimSequence.

FindNodeByName()

IUiAnimNode * CUiAnimSequence::FindNodeByName ( const char *  sNodeName, const IUiAnimNode *  pParentDirector  )

overridevirtual

Implements IUiAnimSequence.

GetActiveDirector()

IUiAnimNode * CUiAnimSequence::GetActiveDirector ( ) const

overridevirtual

Get the currently active director node, if any.

Implements IUiAnimSequence.

GetCutSceneFlags()

int CUiAnimSequence::GetCutSceneFlags ( const bool  localFlags = false ) const

overridevirtual

Get cutscene related animation sequence flags.

Implements IUiAnimSequence.

GetFlags()

int CUiAnimSequence::GetFlags ( ) const

overridevirtual

Get animation sequence flags.

Implements IUiAnimSequence.

GetId()

uint32 CUiAnimSequence::GetId ( ) const

inlineoverridevirtual

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

Implements IUiAnimSequence.

GetName()

const char * CUiAnimSequence::GetName ( ) const

overridevirtual

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

Implements IUiAnimSequence.

GetNode()

IUiAnimNode * CUiAnimSequence::GetNode ( int  index ) const

overridevirtual

Get specified animation node.

Implements IUiAnimSequence.

GetNodeCount()

int CUiAnimSequence::GetNodeCount ( ) const

overridevirtual

Return number of animation nodes in sequence.

Implements IUiAnimSequence.

GetOwner()

IUiAnimSequenceOwner * CUiAnimSequence::GetOwner ( ) const

inlineoverridevirtual

Implements IUiAnimSequence.

GetParentSequence()

const IUiAnimSequence * CUiAnimSequence::GetParentSequence ( ) const

overridevirtual

Get parent animation sequence.

Implements IUiAnimSequence.

GetTimeRange()

Range CUiAnimSequence::GetTimeRange ( )

inlineoverridevirtual

Get time range of this sequence.

Implements IUiAnimSequence.

GetTrackEvent()

char const * CUiAnimSequence::GetTrackEvent ( int  iIndex ) const

overridevirtual

Implements IUiAnimSequence.

GetTrackEventsCount()

int CUiAnimSequence::GetTrackEventsCount ( ) const

overridevirtual

Get the track events in the sequence.

Implements IUiAnimSequence.

GetTrackEventStringTable()

IUiAnimStringTable * CUiAnimSequence::GetTrackEventStringTable ( )

inlineoverridevirtual

Implements IUiAnimSequence.

GetUiAnimationSystem()

IUiAnimationSystem * CUiAnimSequence::GetUiAnimationSystem ( ) const

inlineoverridevirtual

Set the animation system for the canvas containing this sequence.

Implements IUiAnimSequence.

InitPostLoad()

void CUiAnimSequence::InitPostLoad ( IUiAnimationSystem *  pUiAnimationSystem, bool  remapIds, LyShine::EntityIdMap *  entityIdMap  )

overridevirtual

Implements IUiAnimSequence.

IsActivated()

bool CUiAnimSequence::IsActivated ( ) const

inlineoverridevirtual

Check if sequence is activated

Implements IUiAnimSequence.

IsAncestorOf()

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

overridevirtual

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

Implements IUiAnimSequence.

IsPaused()

bool CUiAnimSequence::IsPaused ( ) const

overridevirtual

Called to check if sequence is paused.

Implements IUiAnimSequence.

MoveDownTrackEvent()

bool CUiAnimSequence::MoveDownTrackEvent ( const char *  szEvent )

overridevirtual

Implements IUiAnimSequence.

MoveUpTrackEvent()

bool CUiAnimSequence::MoveUpTrackEvent ( const char *  szEvent )

overridevirtual

Implements IUiAnimSequence.

OnLoop()

void CUiAnimSequence::OnLoop ( )

overridevirtual

Called when a sequence is looped.

Implements IUiAnimSequence.

PasteNodes()

void CUiAnimSequence::PasteNodes ( const XmlNodeRef &  xmlNode, IUiAnimNode *  pParent  )

overridevirtual

Implements IUiAnimSequence.

Pause()

void CUiAnimSequence::Pause ( )

overridevirtual

Implements IUiAnimSequence.

PrecacheData()

void CUiAnimSequence::PrecacheData ( float  startTime )

overridevirtual

Implements IUiAnimSequence.

release()

void CUiAnimSequence::release ( )

overridevirtual

Implements IUiAnimSequence.

RemoveAll()

void CUiAnimSequence::RemoveAll ( )

overridevirtual

Add scene node to sequence.

Implements IUiAnimSequence.

RemoveNode()

void CUiAnimSequence::RemoveNode ( IUiAnimNode *  node )

overridevirtual

Remove animation node from sequence.

Implements IUiAnimSequence.

RemoveTrackEvent()

bool CUiAnimSequence::RemoveTrackEvent ( const char *  szEvent )

overridevirtual

Implements IUiAnimSequence.

RemoveTrackEventListener()

void CUiAnimSequence::RemoveTrackEventListener ( IUiTrackEventListener *  pListener )

overridevirtual

Implements IUiAnimSequence.

RenameTrackEvent()

bool CUiAnimSequence::RenameTrackEvent ( const char *  szEvent, const char *  szNewEvent  )

overridevirtual

Implements IUiAnimSequence.

Render()

void CUiAnimSequence::Render ( )

overridevirtual

Implements IUiAnimSequence.

ReorderNode()

void CUiAnimSequence::ReorderNode ( IUiAnimNode *  node, IUiAnimNode *  pPivotNode, bool  next  )

overridevirtual

Implements IUiAnimSequence.

Reset()

void CUiAnimSequence::Reset ( bool  bSeekToStart )

overridevirtual

Resets the sequence.

Implements IUiAnimSequence.

ResetHard()

void CUiAnimSequence::ResetHard ( )

overridevirtual

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

Implements IUiAnimSequence.

Resume()

void CUiAnimSequence::Resume ( )

overridevirtual

Implements IUiAnimSequence.

Serialize()

void CUiAnimSequence::Serialize ( XmlNodeRef &  xmlNode, bool  bLoading, bool  bLoadEmptyTracks = true, uint32  overrideId = 0, bool  bResetLightAnimSet = false  )

overridevirtual

Implements IUiAnimSequence.

SetActiveDirector()

void CUiAnimSequence::SetActiveDirector ( IUiAnimNode *  pDirectorNode )

overridevirtual

Set the currently active director node.

Implements IUiAnimSequence.

SetFlags()

void CUiAnimSequence::SetFlags ( int  flags )

overridevirtual

Set animation sequence flags.

Implements IUiAnimSequence.

SetName()

void CUiAnimSequence::SetName ( const char *  name )

overridevirtual

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

Implements IUiAnimSequence.

SetOwner()

void CUiAnimSequence::SetOwner ( IUiAnimSequenceOwner *  pOwner )

inlineoverridevirtual

Implements IUiAnimSequence.

SetParentSequence()

void CUiAnimSequence::SetParentSequence ( IUiAnimSequence *  pParentSequence )

overridevirtual

Set parent animation sequence.

Implements IUiAnimSequence.

SetTimeRange()

void CUiAnimSequence::SetTimeRange ( Range  timeRange )

overridevirtual

Set time range of this sequence.

Implements IUiAnimSequence.

StillUpdate()

void CUiAnimSequence::StillUpdate ( )

overridevirtual

Implements IUiAnimSequence.

TriggerTrackEvent()

void CUiAnimSequence::TriggerTrackEvent ( const char *  event, const char *  param = nullptr  )

overridevirtual

Call to trigger a track event.

Implements IUiAnimSequence.

---

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

• Gems/LyShine/Code/Source/Animation/AnimSequence.h