FMovieScenePlaybackPosition Struct Reference

#include <MovieScenePlayback.h>

Public Member Functions
	FMovieScenePlaybackPosition ()
EMovieSceneEvaluationType	GetEvaluationType () const
FFrameRate	GetInputRate () const
FFrameRate	GetOutputRate () const
MOVIESCENE_API void	SetTimeBase (FFrameRate InInputRate, FFrameRate InOutputRate, EMovieSceneEvaluationType InputEvaluationType)
MOVIESCENE_API void	Reset (FFrameTime StartPos)
FFrameTime	GetCurrentPosition () const
TOptional< FFrameTime >	GetLastPlayEvalPostition () const
MOVIESCENE_API FMovieSceneEvaluationRange	JumpTo (FFrameTime NewPosition, EPlayDirection PreferredDirection=EPlayDirection::Forwards)
MOVIESCENE_API FMovieSceneEvaluationRange	PlayTo (FFrameTime NewPosition, EPlayDirection PreferredDirection=EPlayDirection::Forwards)
MOVIESCENE_API TOptional< FMovieSceneEvaluationRange >	GetLastRange () const
MOVIESCENE_API FMovieSceneEvaluationRange	GetCurrentPositionAsRange () const

Detailed Description

Helper class designed to abstract the complexity of calculating evaluation ranges for previous times and fixed time intervals

Constructor & Destructor Documentation

FMovieScenePlaybackPosition()

FMovieScenePlaybackPosition::FMovieScenePlaybackPosition ( )

inline

Member Function Documentation

GetCurrentPosition()

FFrameTime FMovieScenePlaybackPosition::GetCurrentPosition ( ) const

inline

Get the last position that was set, in InputRate space

GetCurrentPositionAsRange()

FMovieSceneEvaluationRange FMovieScenePlaybackPosition::GetCurrentPositionAsRange

(

)

const

Get a range encompassing only the current time, if available (in OutputRate space)

Returns

An optional evaluation range in OutputRate space.

GetEvaluationType()

EMovieSceneEvaluationType FMovieScenePlaybackPosition::GetEvaluationType ( ) const

inline

Returns

Whether we are evaluating with sub frames, or frame-locked

GetInputRate()

FFrameRate FMovieScenePlaybackPosition::GetInputRate ( ) const

inline

Returns

The input frame rate that all frame times provided to this class will be interpreted as

GetLastPlayEvalPostition()

TOptional< FFrameTime > FMovieScenePlaybackPosition::GetLastPlayEvalPostition ( ) const

inline

Get the last actual time that was evaluated during playback, in InputRate space.

GetLastRange()

TOptional< FMovieSceneEvaluationRange > FMovieScenePlaybackPosition::GetLastRange

(

)

const

Get a range that encompasses the last evaluated range in OutputRate space.

Returns

An optional evaluation range in OutputRate space.

GetOutputRate()

FFrameRate FMovieScenePlaybackPosition::GetOutputRate ( ) const

inline

Returns

The output frame rate that all frame times returned from this class will be interpreted as

JumpTo()

FMovieSceneEvaluationRange FMovieScenePlaybackPosition::JumpTo	(	FFrameTime	NewPosition,
		EPlayDirection	PreferredDirection = EPlayDirection::Forwards
	)

Jump to the specified input time.

Note

Will reset previous play position. Any subsequent call to 'PlayTo' will include NewPosition.

Parameters

NewPosition

The new frame time to set, in InputRate space

Returns

A range encompassing only the specified time, in OutputRate space.

PlayTo()

FMovieSceneEvaluationRange FMovieScenePlaybackPosition::PlayTo	(	FFrameTime	NewPosition,
		EPlayDirection	PreferredDirection = EPlayDirection::Forwards
	)

Play from the previously evaluated play time, to the specified time

Parameters

NewPosition

The new frame time to set, in InputRate space

Returns

An evaluation range from the previously evaluated time to the specified time, in OutputRate space.

Reset()

void FMovieScenePlaybackPosition::Reset

(

FFrameTime

StartPos

)

Reset this position to the specified time.

Note

Future calls to 'PlayTo' will include this time in its resulting evaluation range

SetTimeBase()

void FMovieScenePlaybackPosition::SetTimeBase	(	FFrameRate	InInputRate,
		FFrameRate	InOutputRate,
		EMovieSceneEvaluationType	InputEvaluationType
	)

Assign the input and output rates that frame times should be interpreted as.

Parameters

InInputRate	The framerate to interpret any frame time provided to this class
InOutputRate	The framerate to use when returning any frame range from this class
InputEvaluationType	Whether we're using frame-locked or sub-frame evaluation

---

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

• Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieScenePlayback.h
• Engine/Source/Runtime/MovieScene/Private/Evaluation/MovieScenePlayback.cpp