FMovieSceneEvaluationRange Struct Reference

#include <MovieScenePlayback.h>

Inheritance diagram for FMovieSceneEvaluationRange:

Public Member Functions
MOVIESCENE_API	FMovieSceneEvaluationRange (FFrameTime InTime, FFrameRate InFrameRate)
MOVIESCENE_API	FMovieSceneEvaluationRange (TRange< FFrameTime > InRange, FFrameRate InFrameRate, EPlayDirection InDirection)
MOVIESCENE_API	FMovieSceneEvaluationRange (FFrameTime InCurrentTime, FFrameTime InPreviousTime, FFrameRate InFrameRate, bool bInclusivePreviousTime=false, EPlayDirection PreferredDirection=EPlayDirection::Forwards)
TRange< FFrameTime >	GetRange () const
TRange< FFrameNumber >	GetFrameNumberRange () const
MOVIESCENE_API TRange< FFrameNumber >	GetTraversedFrameNumberRange () const
EPlayDirection	GetDirection () const
FFrameTime	GetTime () const
FFrameNumber	GetEvaluationFieldTime () const
FFrameTime	GetDelta () const
FFrameTime	GetPreviousTime () const
FFrameTime	GetOffsetTime (FFrameTime InOffset) const
void	OverrideTime (FFrameNumber InTimeOverride)
FFrameRate	GetFrameRate () const
MOVIESCENE_API void	ResetRange (const TRange< FFrameTime > &NewRange)

Static Public Member Functions
static MOVIESCENE_API TRange< FFrameNumber >	TimeRangeToNumberRange (const TRange< FFrameTime > &InFrameTimeRange)
static MOVIESCENE_API TRange< FFrameTime >	NumberRangeToTimeRange (const TRange< FFrameNumber > &InFrameTimeRange)

Protected Attributes
TRange< FFrameTime >	EvaluationRange
FFrameRate	CurrentFrameRate
EPlayDirection	Direction
FFrameNumber	TimeOverride

Detailed Description

MovieScene evaluation context. Should remain bitwise copyable, and contain no external state since this has the potential to be used on a thread

Constructor & Destructor Documentation

FMovieSceneEvaluationRange() [1/3]

FMovieSceneEvaluationRange::FMovieSceneEvaluationRange	(	FFrameTime	InTime,
		FFrameRate	InFrameRate
	)

Construct this range from a single fixed time

FMovieSceneEvaluationRange() [2/3]

FMovieSceneEvaluationRange::FMovieSceneEvaluationRange	(	TRange< FFrameTime >	InRange,
		FFrameRate	InFrameRate,
		EPlayDirection	InDirection
	)

Construct this range from a raw range and a direction

FMovieSceneEvaluationRange() [3/3]

FMovieSceneEvaluationRange::FMovieSceneEvaluationRange	(	FFrameTime	InCurrentTime,
		FFrameTime	InPreviousTime,
		FFrameRate	InFrameRate,
		bool	bInclusivePreviousTime = false,
		EPlayDirection	PreferredDirection = EPlayDirection::Forwards
	)

Construct this range from 2 times, and whether the range should include the previous time or not

Member Function Documentation

GetDelta()

FFrameTime FMovieSceneEvaluationRange::GetDelta ( ) const

inline

Get the absolute amount of time that has passed since the last update (will always be >= 0)

GetDirection()

EPlayDirection FMovieSceneEvaluationRange::GetDirection ( ) const

inline

Get the direction to evaluate our range

GetEvaluationFieldTime()

FFrameNumber FMovieSceneEvaluationRange::GetEvaluationFieldTime ( ) const

inline

Get the current time to use for looking up within an evaluation field. Subtly different from GetTime in that it returns the previous tick for exclusive boundaries

GetFrameNumberRange()

TRange< FFrameNumber > FMovieSceneEvaluationRange::GetFrameNumberRange ( ) const

inline

Get the range of frame numbers traversed over this evaluation range, not including partial frames

GetFrameRate()

FFrameRate FMovieSceneEvaluationRange::GetFrameRate ( ) const

inline

Get the framerate that this context's times are in

Returns

The framerate that all times are relative to

GetOffsetTime()

FFrameTime FMovieSceneEvaluationRange::GetOffsetTime ( FFrameTime  InOffset ) const

inline

Get the current time offset by the specified amount in the direction of play

GetPreviousTime()

FFrameTime FMovieSceneEvaluationRange::GetPreviousTime ( ) const

inline

Get the previous time of evaluation. Should not generally be used. Prefer GetRange instead.

GetRange()

TRange< FFrameTime > FMovieSceneEvaluationRange::GetRange ( ) const

inline

Get the range that we should be evaluating

GetTime()

FFrameTime FMovieSceneEvaluationRange::GetTime ( ) const

inline

Get the current time of evaluation.

GetTraversedFrameNumberRange()

TRange< FFrameNumber > FMovieSceneEvaluationRange::GetTraversedFrameNumberRange

(

)

const

Get the range of frame numbers traversed over this evaluation range by flooring the lower bound, and ceiling the upper bound. For example: a time range of [1.5, 5.6] will yield the equivalent of [1, 6). A time range of (2.0, 2.9) will yield the equivalent of [2,3).

NumberRangeToTimeRange()

TRange< FFrameTime > FMovieSceneEvaluationRange::NumberRangeToTimeRange ( const TRange< FFrameNumber > &  InFrameTimeRange )

static

Convert a frame number range to a frame time range

OverrideTime()

void FMovieSceneEvaluationRange::OverrideTime ( FFrameNumber  InTimeOverride )

inline

Override the time that we're actually evaluating at

ResetRange()

void FMovieSceneEvaluationRange::ResetRange

(

const TRange< FFrameTime > &

NewRange

)

Reset this range to a new range while retaining the current framerate and direction

TimeRangeToNumberRange()

TRange< FFrameNumber > FMovieSceneEvaluationRange::TimeRangeToNumberRange ( const TRange< FFrameTime > &  InFrameTimeRange )

static

Convert a frame time range to a frame number range comprising all the frame numbers traversed in the range

Member Data Documentation

CurrentFrameRate

FFrameRate FMovieSceneEvaluationRange::CurrentFrameRate

protected

The framerate of the current sequence.

Direction

EPlayDirection FMovieSceneEvaluationRange::Direction

protected

Whether to evaluate the range forwards, or backwards

EvaluationRange

TRange<FFrameTime> FMovieSceneEvaluationRange::EvaluationRange

protected

The range to evaluate

TimeOverride

FFrameNumber FMovieSceneEvaluationRange::TimeOverride

protected

Overridden current time (doesn't manipulate the actual evaluated range)

---

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