CUiAnimationContext Class Reference

#include <AnimationContext.h>

Inherits IEditorNotifyListener, IUndoManagerListener, and IUiAnimViewSequenceManagerListener.

Public Member Functions
	CUiAnimationContext ()
void	Init ()
void	AddListener (IUiAnimationContextListener *pListener)
void	RemoveListener (IUiAnimationContextListener *pListener)
IUiAnimationSystem *	GetUiAnimationSystem () const
void	ActiveCanvasChanged ()
	Called when the active canvas changes - possibly to no canvas.
float	GetTime () const
float	GetTimeScale () const
void	SetTimeScale (float fScale)
void	SetSequence (CUiAnimViewSequence *pSequence, bool bForce, bool bNoNotify, bool recordUndo=false)
CUiAnimViewSequence *	GetSequence () const
void	SetMarkers (Range Marker)
Range	GetMarkers ()
Range	GetTimeRange () const
bool	IsRecording () const
bool	IsPlaying () const
bool	IsPaused () const
bool	IsPlayMode () const
bool	IsRecordMode () const
bool	IsLoopMode () const
void	SetLoopMode (bool bLooping)
void	SetTime (float t)
void	SetResetTime (float t)
void	SetRecording (bool playing)
void	SetPlaying (bool playing)
void	Pause ()
void	TogglePlay ()
void	Resume ()
void	Update ()
void	ForceAnimation ()
void	OnPostRender ()
void	UpdateTimeRange ()
Public Member Functions inherited from IUiAnimViewSequenceManagerListener
virtual void	OnSequenceAdded ([[maybe_unused]] CUiAnimViewSequence *pSequence)
virtual void	OnSequenceRemoved ([[maybe_unused]] CUiAnimViewSequence *pSequence)

Detailed Description

CUiAnimationContext stores information about current editable animation sequence. Stores information about whenever animation is being recorded know, current sequence, current time in sequence etc.

Constructor & Destructor Documentation

CUiAnimationContext()

CUiAnimationContext::CUiAnimationContext

(

)

Constructor.

Member Function Documentation

ForceAnimation()

void CUiAnimationContext::ForceAnimation

(

)

Force animation for current sequence.

GetMarkers()

Range CUiAnimationContext::GetMarkers ( )

inline

Get time markers to play within.

GetSequence()

CUiAnimViewSequence* CUiAnimationContext::GetSequence ( ) const

inline

Get currently edited sequence.

GetTime()

float CUiAnimationContext::GetTime ( ) const

inline

Return current animation time in active sequence.

Returns

Current time.

GetTimeRange()

Range CUiAnimationContext::GetTimeRange ( ) const

inline

Get time range of active animation sequence.

IsLoopMode()

bool CUiAnimationContext::IsLoopMode ( ) const

inline

Returns true if currently looping as activated.

IsPaused()

bool CUiAnimationContext::IsPaused ( ) const

inline

Returns true if currently playing or recording is paused.

IsPlaying()

bool CUiAnimationContext::IsPlaying ( ) const

inline

Returns true if editor is playing animation now.

IsPlayMode()

bool CUiAnimationContext::IsPlayMode ( ) const

inline

Return if animation context is now in playing mode. In difference from IsPlaying function this function not affected by pause state.

IsRecording()

bool CUiAnimationContext::IsRecording ( ) const

inline

Returns true if editor is recording animations now.

IsRecordMode()

bool CUiAnimationContext::IsRecordMode ( ) const

inline

Return if animation context is now in recording mode. In difference from IsRecording function this function not affected by pause state.

Pause()

void CUiAnimationContext::Pause

(

)

Pause animation playing/recording.

Resume()

void CUiAnimationContext::Resume

(

)

Resume animation playing/recording.

SetLoopMode()

void CUiAnimationContext::SetLoopMode ( bool  bLooping )

inline

Enable/Disable looping.

SetMarkers()

void CUiAnimationContext::SetMarkers ( Range  Marker )

inline

Set time markers to play within.

SetPlaying()

void CUiAnimationContext::SetPlaying

(

bool

playing

)

Start/Stop animation playing. Automatically stop recording.

Parameters

playing

True to start playing, false to stop.

SetRecording()

void CUiAnimationContext::SetRecording

(

bool

playing

)

Start animation recorduing. Automatically stop playing.

Parameters

recording

True to start recording, false to stop.

SetResetTime()

void CUiAnimationContext::SetResetTime ( float  t )

inline

Set time in active sequence for reset animation.

Parameters

seq	New active time.

SetSequence()

void CUiAnimationContext::SetSequence	(	CUiAnimViewSequence *	pSequence,
		bool	bForce,
		bool	bNoNotify,
		bool	recordUndo = false
	)

Set active editing sequence.

Parameters

seq	New active sequence.

SetTime()

void CUiAnimationContext::SetTime

(

float

t

)

Set current animation time in active sequence.

Parameters

seq	New active time.

TogglePlay()

void CUiAnimationContext::TogglePlay

(

)

Toggle playback

Update()

void CUiAnimationContext::Update

(

)

Called every frame to update all animations if animation should be playing.

---

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

• Gems/LyShine/Code/Editor/Animation/AnimationContext.h