FMovieSceneTimeController Struct Reference

#include <MovieSceneTimeController.h>

Inheritance diagram for FMovieSceneTimeController:

Public Member Functions
virtual	~FMovieSceneTimeController ()
MOVIESCENE_API void	PrepareToPlay (const FQualifiedFrameTime &InStartTime)
MOVIESCENE_API bool	IsReadyToPlay ()
MOVIESCENE_API void	StartPlaying (const FQualifiedFrameTime &InStartTime)
MOVIESCENE_API void	StopPlaying (const FQualifiedFrameTime &InStopTime)
MOVIESCENE_API void	Tick (float DeltaSeconds, float InPlayRate)
MOVIESCENE_API FFrameTime	RequestCurrentTime (const FQualifiedFrameTime &InCurrentTime, float InPlayRate, FFrameRate InDisplayRate)
MOVIESCENE_API void	PlayerStatusChanged (EMovieScenePlayerStatus::Type InStatus, const FQualifiedFrameTime &InCurrentTime)
MOVIESCENE_API void	Reset (const FQualifiedFrameTime &InNewStartTime)

Protected Member Functions
virtual void	OnTick (float DeltaSeconds, float InPlayRate)
virtual void	OnPrepareToPlay (const FQualifiedFrameTime &InStartTime)
virtual bool	OnIsReadyToPlay ()
virtual void	OnStartPlaying (const FQualifiedFrameTime &InStartTime)
virtual void	OnStopPlaying (const FQualifiedFrameTime &InStopTime)
virtual FFrameTime	OnRequestCurrentTime (const FQualifiedFrameTime &InCurrentTime, float InPlayRate)=0
TOptional< FQualifiedFrameTime >	GetPlaybackStartTime () const
FFrameRate	GetDisplayRate () const

Constructor & Destructor Documentation

~FMovieSceneTimeController()

virtual FMovieSceneTimeController::~FMovieSceneTimeController ( )

inlinevirtual

Member Function Documentation

GetDisplayRate()

FFrameRate FMovieSceneTimeController::GetDisplayRate ( ) const

inlineprotected

GetPlaybackStartTime()

TOptional< FQualifiedFrameTime > FMovieSceneTimeController::GetPlaybackStartTime ( ) const

inlineprotected

IsReadyToPlay()

bool FMovieSceneTimeController::IsReadyToPlay

(

)

Called whenever a sequence starts or resumes playback from a non-playing state

OnIsReadyToPlay()

virtual bool FMovieSceneTimeController::OnIsReadyToPlay ( )

inlineprotectedvirtual

OnPrepareToPlay()

virtual void FMovieSceneTimeController::OnPrepareToPlay ( const FQualifiedFrameTime &  InStartTime )

inlineprotectedvirtual

OnRequestCurrentTime()

virtual FFrameTime FMovieSceneTimeController::OnRequestCurrentTime ( const FQualifiedFrameTime &  InCurrentTime, float  InPlayRate  )

protectedpure virtual

Implemented in FMovieSceneTimeController_ExternalClock, FMovieSceneTimeController_RelativeTimecodeClock, FMovieSceneTimeController_TimecodeClock, FMovieSceneTimeController_Tick, and FMovieSceneTimeController_PlayEveryFrame.

OnStartPlaying()

virtual void FMovieSceneTimeController::OnStartPlaying ( const FQualifiedFrameTime &  InStartTime )

inlineprotectedvirtual

Reimplemented in FMovieSceneTimeController_ExternalClock, FMovieSceneTimeController_Tick, and FMovieSceneTimeController_PlayEveryFrame.

OnStopPlaying()

virtual void FMovieSceneTimeController::OnStopPlaying ( const FQualifiedFrameTime &  InStopTime )

inlineprotectedvirtual

Reimplemented in FMovieSceneTimeController_ExternalClock, and FMovieSceneTimeController_RelativeTimecodeClock.

OnTick()

virtual void FMovieSceneTimeController::OnTick ( float  DeltaSeconds, float  InPlayRate  )

inlineprotectedvirtual

Reimplemented in FMovieSceneTimeController_Tick.

PlayerStatusChanged()

void FMovieSceneTimeController::PlayerStatusChanged	(	EMovieScenePlayerStatus::Type	InStatus,
		const FQualifiedFrameTime &	InCurrentTime
	)

Called when the status of the owning IMovieScenePlayer has changed

PrepareToPlay()

void FMovieSceneTimeController::PrepareToPlay

(

const FQualifiedFrameTime &

InStartTime

)

Called whenever a sequence starts or resumes playback from a non-playing state

RequestCurrentTime()

FFrameTime FMovieSceneTimeController::RequestCurrentTime	(	const FQualifiedFrameTime &	InCurrentTime,
		float	InPlayRate,
		FFrameRate	InDisplayRate
	)

Request the current time based on the specified existing time and play rate. Times should be returned in the same play rate as that specified by InCurrentTime

Parameters

InCurrentTime	The current time of the sequence
InPlayRate	The current play rate of the sequence, multiplied by any world actor settings global dilation

Reset()

void FMovieSceneTimeController::Reset

(

const FQualifiedFrameTime &

InNewStartTime

)

Called to stop and resume playback from the specified time

StartPlaying()

void FMovieSceneTimeController::StartPlaying

(

const FQualifiedFrameTime &

InStartTime

)

Called whenever a sequence starts or resumes playback from a non-playing state

StopPlaying()

void FMovieSceneTimeController::StopPlaying

(

const FQualifiedFrameTime &

InStopTime

)

Called whenever a sequence stops playback

Tick()

void FMovieSceneTimeController::Tick	(	float	DeltaSeconds,
		float	InPlayRate
	)

Ticks this controller

Parameters

DeltaSeconds	The tick delta in seconds, dilated by the current world settings global dilation
InPlayRate	The current play rate of the sequence

---

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

• Engine/Source/Runtime/MovieScene/Public/MovieSceneTimeController.h
• Engine/Source/Runtime/MovieScene/Private/MovieSceneTimeController.cpp