Navigation
API > API/Runtime > API/Runtime/MovieScene
Helper class designed to abstract the complexity of calculating evaluation ranges for previous times and fixed time intervals
| Name | FMovieScenePlaybackPosition |
| Type | struct |
| Header File | /Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieScenePlayback.h |
| Include Path | #include "Evaluation/MovieScenePlayback.h" |
Syntax
struct FMovieScenePlaybackPosition
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMovieScenePlaybackPosition() |
Evaluation/MovieScenePlayback.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CurrentPosition | FFrameTime | The current time position set, in 'InputRate' time-space. | Evaluation/MovieScenePlayback.h | |
| EvaluationType | EMovieSceneEvaluationType | The type of evaluation to use | Evaluation/MovieScenePlayback.h | |
| InputRate | FFrameRate | The framerate to be used when interpreting frame time values provided to this class (i.e. moviescene display rate) | Evaluation/MovieScenePlayback.h | |
| LastRange | TOptional< FMovieSceneEvaluationRange > | The previously evaluated range if available, in 'OutputRate' time-space | Evaluation/MovieScenePlayback.h | |
| OutputRate | FFrameRate | The framerate to be used when returning frame time values from this class (i.e. moviescene tick resolution) | Evaluation/MovieScenePlayback.h | |
| PreviousPlayEvalPosition | TOptional< FFrameTime > | The previously evaluated position when playing, in 'InputRate' time-space. | Evaluation/MovieScenePlayback.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FFrameTime GetCurrentPosition() |
Get the last position that was set, in InputRate space | Evaluation/MovieScenePlayback.h | |
FMovieSceneEvaluationRange GetCurrentPositionAsRange() |
Get a range encompassing only the current time, if available (in OutputRate space) | Evaluation/MovieScenePlayback.h | |
EMovieSceneEvaluationType GetEvaluationType() |
Evaluation/MovieScenePlayback.h | ||
FFrameRate GetInputRate() |
Evaluation/MovieScenePlayback.h | ||
TOptional< FFrameTime > GetLastPlayEvalPostition() |
Get the last actual time that was evaluated during playback, in InputRate space. | Evaluation/MovieScenePlayback.h | |
TOptional< FMovieSceneEvaluationRange > GetLastRange() |
Get a range that encompasses the last evaluated range in OutputRate space. | Evaluation/MovieScenePlayback.h | |
FFrameRate GetOutputRate() |
Evaluation/MovieScenePlayback.h | ||
FMovieSceneEvaluationRange JumpTo
(
FFrameTime NewPosition, |
Jump to the specified input time. | Evaluation/MovieScenePlayback.h | |
FMovieSceneEvaluationRange PlayTo
(
FFrameTime NewPosition, |
Play from the previously evaluated play time, to the specified time | Evaluation/MovieScenePlayback.h | |
void Reset
(
FFrameTime StartPos |
Reset this position to the specified time. | Evaluation/MovieScenePlayback.h | |
void SetTimeBase
(
FFrameRate InInputRate, |
Assign the input and output rates that frame times should be interpreted as. | Evaluation/MovieScenePlayback.h |