UiAnimationSystem Class Reference

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

overridevirtual

Implements IUiAnimationSystem.

PostUpdate()

void UiAnimationSystem::PostUpdate ( const float dt )

overridevirtual

Implements IUiAnimationSystem.

PreUpdate()

void UiAnimationSystem::PreUpdate ( const float dt )

overridevirtual

Implements IUiAnimationSystem.

Release()

void UiAnimationSystem::Release ( )

inlineoverridevirtual

Release UI animation system.

Implements IUiAnimationSystem.

RemoveAllSequences()

void UiAnimationSystem::RemoveAllSequences ( )

overridevirtual

Implements IUiAnimationSystem.

RemoveSequence()

void UiAnimationSystem::RemoveSequence ( IUiAnimSequence * pSequence )

overridevirtual

Implements IUiAnimationSystem.

RemoveUiAnimationListener()

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

overridevirtual

Implements IUiAnimationSystem.

Render()

void UiAnimationSystem::Render ( )

overridevirtual

Implements IUiAnimationSystem.

Reset()

void UiAnimationSystem::Reset ( bool bPlayOnReset, bool bSeekToStart )

overridevirtual

Resets playback state of UI animation system, usually called after loading of level,

Implements IUiAnimationSystem.

Resume()

void UiAnimationSystem::Resume ( )

overridevirtual

Implements IUiAnimationSystem.

Serialize()

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

overridevirtual

Implements IUiAnimationSystem.

SerializeParamData()

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

overridevirtual

Implements IUiAnimationSystem.

SerializeParamType()

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

overridevirtual

Implements IUiAnimationSystem.

SetCallback()

void UiAnimationSystem::SetCallback ( IUiAnimationCallback * pCallback )

inlineoverridevirtual

Implements IUiAnimationSystem.

SetPlayingSpeed()

bool UiAnimationSystem::SetPlayingSpeed ( IUiAnimSequence * pSeq, float fTime )

overridevirtual

Implements IUiAnimationSystem.

SetPlayingTime()

bool UiAnimationSystem::SetPlayingTime ( IUiAnimSequence * pSeq, float fTime )

overridevirtual

Implements IUiAnimationSystem.

SetRecording()

void UiAnimationSystem::SetRecording ( bool recording )

inlineoverridevirtual

Implements IUiAnimationSystem.

SetSequenceStopBehavior()

void UiAnimationSystem::SetSequenceStopBehavior ( ESequenceStopBehavior behavior )

overridevirtual

Implements IUiAnimationSystem.

SetStartEndTime()

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

overridevirtual

Implements IUiAnimationSystem.

StillUpdate()

void UiAnimationSystem::StillUpdate ( )

overridevirtual

Implements IUiAnimationSystem.

StopAllCutScenes()

void UiAnimationSystem::StopAllCutScenes ( )

overridevirtual

Implements IUiAnimationSystem.

StopAllSequences()

void UiAnimationSystem::StopAllSequences ( )

overridevirtual

Implements IUiAnimationSystem.

StopSequence() [1/2]

bool UiAnimationSystem::StopSequence ( const char * sequence )

overridevirtual

Implements IUiAnimationSystem.

StopSequence() [2/2]

bool UiAnimationSystem::StopSequence ( IUiAnimSequence * seq )

overridevirtual

Implements IUiAnimationSystem.

---

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

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