Inherits IUiAnimationSystem.

Public Member Functions
void	Release () override
	Release UI animation system.

bool	Load (const char pszFile, const char pszMission) override
	Loads all nodes and sequences from a specific file (should be called when the level is loaded).

ISystem *	GetSystem () override

IUiAnimTrack *	CreateTrack (EUiAnimCurveType type) override

IUiAnimSequence *	CreateSequence (const char *sequence, bool bLoad=false, uint32 id=0) override

IUiAnimSequence *	LoadSequence (const char *pszFilePath)

IUiAnimSequence *	LoadSequence (XmlNodeRef &xmlNode, bool bLoadEmpty=true) override

void	AddSequence (IUiAnimSequence *pSequence) override

void	RemoveSequence (IUiAnimSequence *pSequence) override

IUiAnimSequence *	FindSequence (const char *sequence) const override

IUiAnimSequence *	FindSequenceById (uint32 id) const override

IUiAnimSequence *	GetSequence (int i) const override

int	GetNumSequences () const override

IUiAnimSequence *	GetPlayingSequence (int i) const override

int	GetNumPlayingSequences () const override

bool	IsCutScenePlaying () const override

uint32	GrabNextSequenceId () override

int	OnSequenceRenamed (const char before, const char after) override

int	OnCameraRenamed (const char before, const char after) override

bool	AddUiAnimationListener (IUiAnimSequence pSequence, IUiAnimationListener pListener) override

bool	RemoveUiAnimationListener (IUiAnimSequence pSequence, IUiAnimationListener pListener) override

void	RemoveAllSequences () override

void	PlaySequence (const char sequence, IUiAnimSequence parentSeq=NULL, bool bResetFX=true, bool bTrackedSequence=false, float startTime=-FLT_MAX, float endTime=-FLT_MAX) override

void	PlaySequence (IUiAnimSequence seq, IUiAnimSequence parentSeq=NULL, bool bResetFX=true, bool bTrackedSequence=false, float startTime=-FLT_MAX, float endTime=-FLT_MAX) override

void	PlayOnLoadSequences () override

bool	StopSequence (const char *sequence) override

bool	StopSequence (IUiAnimSequence *seq) override

bool	AbortSequence (IUiAnimSequence *seq, bool bLeaveTime=false) override

void	StopAllSequences () override

void	StopAllCutScenes () override

void	Pause (bool bPause)

void	Reset (bool bPlayOnReset, bool bSeekToStart) override

void	StillUpdate () override

void	PreUpdate (const float dt) override

void	PostUpdate (const float dt) override

void	Render () override

bool	IsPlaying (IUiAnimSequence *seq) const override

void	Pause () override

void	Resume () override

void	SetRecording (bool recording) override

bool	IsRecording () const override

void	SetCallback (IUiAnimationCallback *pCallback) override

IUiAnimationCallback *	GetCallback () override

void	Callback (IUiAnimationCallback::ECallbackReason Reason, IUiAnimNode *pNode)

void	Serialize (XmlNodeRef &xmlNode, bool bLoading, bool bRemoveOldNodes=false, bool bLoadEmpty=true) override

void	InitPostLoad (bool remapIds, LyShine::EntityIdMap *entityIdMap) override

void	SetSequenceStopBehavior (ESequenceStopBehavior behavior) override

IUiAnimationSystem::ESequenceStopBehavior	GetSequenceStopBehavior () override

float	GetPlayingTime (IUiAnimSequence *pSeq) override

bool	SetPlayingTime (IUiAnimSequence *pSeq, float fTime) override

float	GetPlayingSpeed (IUiAnimSequence *pSeq) override

bool	SetPlayingSpeed (IUiAnimSequence *pSeq, float fTime) override

bool	GetStartEndTime (IUiAnimSequence *pSeq, float &fStartTime, float &fEndTime) override

bool	SetStartEndTime (IUiAnimSequence *pSeq, const float fStartTime, const float fEndTime) override

void	GoToFrame (const char *seqName, float targetFrame) override

void	SerializeNodeType (EUiAnimNodeType &animNodeType, XmlNodeRef &xmlNode, bool bLoading, const uint version, int flags)

void	SerializeParamType (CUiAnimParamType &animParamType, XmlNodeRef &xmlNode, bool bLoading, const uint version) override

void	SerializeParamData (UiAnimParamData &animParamData, XmlNodeRef &xmlNode, bool bLoading) override

const char *	GetParamTypeName (const CUiAnimParamType &animParamType)

void	OnCameraCut ()

void	NotifyTrackEventListeners (const char eventName, const char valueName, IUiAnimSequence *pSequence) override

Public Member Functions inherited from IUiAnimationSystem
virtual void	Release ()=0
	Release UI animation system.

virtual bool	Load (const char pszFile, const char pszMission)=0
	Loads all nodes and sequences from a specific file (should be called when the level is loaded).

virtual IUiAnimTrack *	CreateTrack (EUiAnimCurveType type)=0

virtual IUiAnimSequence *	CreateSequence (const char *sequence, bool bLoad=false, uint32 id=0)=0

virtual IUiAnimSequence *	LoadSequence (XmlNodeRef &xmlNode, bool bLoadEmpty=true)=0

virtual void	AddSequence (IUiAnimSequence *pSequence)=0

virtual void	RemoveSequence (IUiAnimSequence *pSequence)=0

virtual IUiAnimSequence *	FindSequence (const char *sequence) const =0

virtual IUiAnimSequence *	FindSequenceById (uint32 id) const =0

virtual IUiAnimSequence *	GetSequence (int i) const =0

virtual int	GetNumSequences () const =0

virtual IUiAnimSequence *	GetPlayingSequence (int i) const =0

virtual int	GetNumPlayingSequences () const =0

virtual bool	IsCutScenePlaying () const =0

virtual uint32	GrabNextSequenceId ()=0

virtual int	OnSequenceRenamed (const char before, const char after)=0

virtual int	OnCameraRenamed (const char before, const char after)=0

virtual bool	AddUiAnimationListener (IUiAnimSequence pSequence, IUiAnimationListener pListener)=0

virtual bool	RemoveUiAnimationListener (IUiAnimSequence pSequence, IUiAnimationListener pListener)=0

virtual ISystem *	GetSystem ()=0

virtual void	RemoveAllSequences ()=0

virtual void	PlaySequence (const char pSequenceName, IUiAnimSequence pParentSeq, bool bResetFX, bool bTrackedSequence, float startTime=-FLT_MAX, float endTime=-FLT_MAX)=0

virtual void	PlaySequence (IUiAnimSequence pSequence, IUiAnimSequence pParentSeq, bool bResetFX, bool bTrackedSequence, float startTime=-FLT_MAX, float endTime=-FLT_MAX)=0

virtual bool	StopSequence (const char *pSequenceName)=0

virtual bool	StopSequence (IUiAnimSequence *pSequence)=0

virtual bool	AbortSequence (IUiAnimSequence *pSequence, bool bLeaveTime=false)=0

virtual void	StopAllSequences ()=0

virtual void	StopAllCutScenes ()=0

virtual bool	IsPlaying (IUiAnimSequence *seq) const =0

virtual void	Reset (bool bPlayOnReset, bool bSeekToStart)=0

virtual void	PlayOnLoadSequences ()=0

virtual void	StillUpdate ()=0

virtual void	PreUpdate (const float dt)=0

virtual void	PostUpdate (const float dt)=0

virtual void	Render ()=0

virtual void	SetRecording (bool recording)=0

virtual bool	IsRecording () const =0

virtual void	Pause ()=0

virtual void	Resume ()=0

virtual void	SetCallback (IUiAnimationCallback *pCallback)=0

virtual IUiAnimationCallback *	GetCallback ()=0

virtual void	Serialize (XmlNodeRef &xmlNode, bool bLoading, bool bRemoveOldNodes=false, bool bLoadEmpty=true)=0

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

virtual float	GetPlayingTime (IUiAnimSequence *pSeq)=0

virtual float	GetPlayingSpeed (IUiAnimSequence *pSeq)=0

virtual bool	SetPlayingTime (IUiAnimSequence *pSeq, float fTime)=0

virtual bool	SetPlayingSpeed (IUiAnimSequence *pSeq, float fSpeed)=0

virtual void	SetSequenceStopBehavior (ESequenceStopBehavior behavior)=0

virtual bool	GetStartEndTime (IUiAnimSequence *pSeq, float &fStartTime, float &fEndTime)=0

virtual bool	SetStartEndTime (IUiAnimSequence *pSeq, const float fStartTime, const float fEndTime)=0

virtual void	GoToFrame (const char *seqName, float targetFrame)=0

virtual IUiAnimationSystem::ESequenceStopBehavior	GetSequenceStopBehavior ()=0

virtual void	SerializeParamType (CUiAnimParamType &animParamType, XmlNodeRef &xmlNode, bool bLoading, const uint version)=0

virtual void	SerializeParamData (UiAnimParamData &animParamData, XmlNodeRef &xmlNode, bool bLoading)=0

virtual void	NotifyTrackEventListeners (const char eventName, const char valueName, IUiAnimSequence *pSequence)=0

virtual EUiAnimNodeType	GetNodeTypeFromString (const char *pString) const =0

virtual CUiAnimParamType	GetParamTypeFromString (const char *pString) const =0

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

Additional Inherited Members
Public Types inherited from IUiAnimationSystem
enum	ESequenceStopBehavior { eSSB_LeaveTime = 0 , eSSB_GotoEndTime = 1 , eSSB_GotoStartTime = 2 }

Member Function Documentation

◆ AbortSequence()

bool UiAnimationSystem::AbortSequence	(	IUiAnimSequence *	pSequence,
		bool	bLeaveTime = `false`
	)

overridevirtual

Aborts a currently playing sequence. Ignored if sequence is not playing. Calls IUiAnimationListener with aborted event (done event is NOT called) Returns true if sequence has been aborted. false otherwise

Parameters

sequence	Pointer to Valid sequence to stop.
bLeaveTime	If false, uses default stop behavior, otherwise leaves the sequence at time

Implements IUiAnimationSystem.

◆ AddSequence()

void UiAnimationSystem::AddSequence ( IUiAnimSequence * pSequence )

overridevirtual

Implements IUiAnimationSystem.

◆ AddUiAnimationListener()

bool UiAnimationSystem::AddUiAnimationListener	(	IUiAnimSequence *	pSequence,
		IUiAnimationListener *	pListener
	)

overridevirtual

Implements IUiAnimationSystem.

◆ CreateSequence()

IUiAnimSequence * UiAnimationSystem::CreateSequence	(	const char *	sequence,
		bool	bLoad = `false`,
		uint32	id = `0`
	)

overridevirtual

Implements IUiAnimationSystem.

◆ CreateTrack()

IUiAnimTrack * UiAnimationSystem::CreateTrack ( EUiAnimCurveType type )

overridevirtual

Implements IUiAnimationSystem.

◆ FindSequence()

IUiAnimSequence * UiAnimationSystem::FindSequence ( const char * sequence ) const

overridevirtual

Implements IUiAnimationSystem.

◆ FindSequenceById()

IUiAnimSequence * UiAnimationSystem::FindSequenceById ( uint32 id ) const

overridevirtual

Implements IUiAnimationSystem.

◆ GetCallback()

IUiAnimationCallback * UiAnimationSystem::GetCallback ( )

inlineoverridevirtual

Implements IUiAnimationSystem.

◆ GetNumPlayingSequences()

int UiAnimationSystem::GetNumPlayingSequences ( ) const

overridevirtual

Implements IUiAnimationSystem.

◆ GetNumSequences()

int UiAnimationSystem::GetNumSequences ( ) const

overridevirtual

Implements IUiAnimationSystem.

◆ GetPlayingSequence()

IUiAnimSequence * UiAnimationSystem::GetPlayingSequence ( int i ) const

overridevirtual

Implements IUiAnimationSystem.

◆ GetPlayingSpeed()

float UiAnimationSystem::GetPlayingSpeed ( IUiAnimSequence * pSeq )

overridevirtual

Implements IUiAnimationSystem.

◆ GetPlayingTime()

float UiAnimationSystem::GetPlayingTime ( IUiAnimSequence * pSeq )

overridevirtual

Implements IUiAnimationSystem.

◆ GetSequence()

IUiAnimSequence * UiAnimationSystem::GetSequence ( int i ) const

overridevirtual

Implements IUiAnimationSystem.

◆ GetSequenceStopBehavior()

IUiAnimationSystem::ESequenceStopBehavior UiAnimationSystem::GetSequenceStopBehavior ( )

overridevirtual

Implements IUiAnimationSystem.

◆ GetStartEndTime()

bool UiAnimationSystem::GetStartEndTime	(	IUiAnimSequence *	pSeq,
		float &	fStartTime,
		float &	fEndTime
	)

overridevirtual

Implements IUiAnimationSystem.

◆ GetSystem()

ISystem * UiAnimationSystem::GetSystem ( )

inlineoverridevirtual

Implements IUiAnimationSystem.

◆ GoToFrame()

void UiAnimationSystem::GoToFrame	(	const char *	seqName,
		float	targetFrame
	)

overridevirtual

Implements IUiAnimationSystem.

◆ GrabNextSequenceId()

uint32 UiAnimationSystem::GrabNextSequenceId ( )

inlineoverridevirtual

Implements IUiAnimationSystem.

◆ InitPostLoad()

void UiAnimationSystem::InitPostLoad	(	bool	remapIds,
		LyShine::EntityIdMap *	entityIdMap
	)

overridevirtual

Implements IUiAnimationSystem.

◆ IsCutScenePlaying()

bool UiAnimationSystem::IsCutScenePlaying ( ) const

overridevirtual

Implements IUiAnimationSystem.

◆ IsPlaying()

bool UiAnimationSystem::IsPlaying ( IUiAnimSequence * seq ) const

overridevirtual

Implements IUiAnimationSystem.

◆ IsRecording()

bool UiAnimationSystem::IsRecording ( ) const

inlineoverridevirtual

Implements IUiAnimationSystem.

◆ Load()

bool UiAnimationSystem::Load	(	const char *	pszFile,
		const char *	pszMission
	)

overridevirtual

Loads all nodes and sequences from a specific file (should be called when the level is loaded).

Implements IUiAnimationSystem.

◆ LoadSequence()

IUiAnimSequence * UiAnimationSystem::LoadSequence	(	XmlNodeRef &	xmlNode,
		bool	bLoadEmpty = `true`
	)

overridevirtual

Implements IUiAnimationSystem.

◆ NotifyTrackEventListeners()

void UiAnimationSystem::NotifyTrackEventListeners	(	const char *	eventName,
		const char *	valueName,
		IUiAnimSequence *	pSequence
	)

overridevirtual

Implements IUiAnimationSystem.

◆ OnCameraRenamed()

int UiAnimationSystem::OnCameraRenamed	(	const char *	before,
		const char *	after
	)

overridevirtual

Implements IUiAnimationSystem.

◆ OnSequenceRenamed()

int UiAnimationSystem::OnSequenceRenamed	(	const char *	before,
		const char *	after
	)

overridevirtual

Implements IUiAnimationSystem.

◆ Pause()

void UiAnimationSystem::Pause ( )

overridevirtual

Implements IUiAnimationSystem.

◆ PlayOnLoadSequences()

void UiAnimationSystem::PlayOnLoadSequences ( )

overridevirtual

Implements IUiAnimationSystem.

◆ PlaySequence() [1/2]

void UiAnimationSystem::PlaySequence	(	const char *	sequence,
		IUiAnimSequence *	parentSeq = `NULL`,
		bool	bResetFX = `true`,
		bool	bTrackedSequence = `false`,
		float	startTime = `-FLT_MAX`,
		float	endTime = `-FLT_MAX`
	)

overridevirtual

Implements IUiAnimationSystem.

◆ PlaySequence() [2/2]

void UiAnimationSystem::PlaySequence	(	IUiAnimSequence *	seq,
		IUiAnimSequence *	parentSeq = `NULL`,
		bool	bResetFX = `true`,
		bool	bTrackedSequence = `false`,
		float	startTime = `-FLT_MAX`,
		float	endTime = `-FLT_MAX`
	)