1. Epic GamesDeveloper
  3. FMovieSceneEvaluationRange

FMovieSceneEvaluationRange

MovieScene evaluation context.

Unreal Engine C++ API Reference > Runtime > MovieScene > Evaluation

Inheritance Hierarchy

References

   
Module MovieScene
Header /Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieScenePlayback.h
Include #include "Evaluation/MovieScenePlayback.h"

Syntax

struct FMovieSceneEvaluationRange

Remarks

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

Variables

  Type Name Description
Protected variable FFrameRate CurrentFrameRate The framerate of the current sequence.
Protected variable EPlayDirection Direction Whether to evaluate the range forwards, or backwards
Protected variable TRange< FFrameTime > EvaluationRange The range to evaluate
Protected variable FFrameNumber TimeOverride Overridden current time (doesn't manipulate the actual evaluated range)

Constructors

  Type Name Description
Public function   Construct this range from a single fixed time
Public function  

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

 Construct this range from a raw range and a direction
Public function  

FMovieSceneEvaluationRange ( FFrameTime InCurrentTime,
FFrameTime InPreviousTime,
FFrameRate InFrameRate,
bool bInclusivePreviousTime
)

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

Functions

  Type Name Description
Public function Const FFrameTime Get the absolute amount of time that has passed since the last update (will always be >= 0)
Public function Const EPlayDirection Get the direction to evaluate our range
Public function Const FFrameNumber Get the current time to use for looking up within an evaluation field.
Public function Const TRange< FFrameNumber > Get the range of frame numbers traversed over this evaluation range, not including partial frames
Public function Const FFrameRate Get the framerate that this context's times are in
Public function Const FFrameTime

GetOffsetTime ( FFrameTime InOffset
)

 Get the current time offset by the specified amount in the direction of play
Public function Const FFrameTime Get the previous time of evaluation. Should not generally be used. Prefer GetRange instead.
Public function Const TRange< FFrameTime > Get the range that we should be evaluating
Public function Const FFrameTime

GetTime ()

 Get the current time of evaluation.
Public function Const TRange< FFrameNumber > Get the range of frame numbers traversed over this evaluation range by flooring the lower bound, and ceiling the upper bound.
Public function Static TRange< FFrameTime >

NumberRangeToTimeRange ( const TRange< FFrameNumber >& InFrameTimeRange
)

 Convert a frame number range to a frame time range
Public function void

OverrideTime ( FFrameNumber InTimeOverride
)

 Override the time that we're actually evaluating at
Public function void

ResetRange ( const TRange< FFrameTime >& NewRange
)

 Reset this range to a new range while retaining the current framerate and direction
Public function Static TRange< FFrameNumber >

TimeRangeToNumberRange ( const TRange< FFrameTime >& InFrameTimeRange
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page