Navigation
Unreal Engine C++ API Reference > Runtime > MovieScene > Evaluation
Inheritance Hierarchy
- FMovieSceneEvaluationRange
- FMovieSceneContext
References
Module | MovieScene |
Header | /Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieScenePlayback.h |
Include | #include "Evaluation/MovieScenePlayback.h" |
Syntax
struct FMovieSceneContext : public 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 | |
---|---|---|---|
![]() |
bool: 1 | bHasJumped | Whether this evaluation frame is happening as part of a large jump |
![]() |
bool: 1 | bHasPostRollStartTime | True if the value of PrePostRollStartEndTime has been set, and refers to the time at which postroll started. |
![]() |
bool: 1 | bHasPreRollEndTime | True if the value of PrePostRollStartEndTime has been set, and refers to the time at which preroll will end. |
![]() |
bool: 1 | bSectionPostRoll | True if we should explicitly postroll the section. Already reconciled with play direction. |
![]() |
bool: 1 | bSectionPreRoll | True if we should explicitly preroll the section. Already reconciled with play direction. |
![]() |
bool: 1 | bSilent | Whether this evaluation should happen silently |
![]() |
int32 | HierarchicalBias | Hierachical bias. Higher bias should take precedence. |
![]() |
FFrameNumber | PrePostRollStartEndTime | When bHasPreRollEndTime or bHasPostRollStartTime is true, this defines either the frame at which 'real' evaluation commences, or finished |
![]() |
FMovieSceneSequenceTransform | RootToSequenceTransform | The transform from the root sequence to the current sequence space |
![]() |
FMovieSceneWarpCounter | RootToSequenceWarpCounter | The current warp count for any sub-sequence in the current sequence's hierarchy |
![]() |
EMovieScenePlayerStatus::Type | Status | The current playback status |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
Construction from an evaluation range, and a current status | ||
![]() |
FMovieSceneContext
(
FMovieSceneEvaluationRange InRange |
Construction from an evaluation range, and a current status | |
![]() |
FMovieSceneContext
(
FMovieSceneEvaluationRange InRange, |
Construction from an evaluation range, and a current status |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
void | ApplySectionPrePostRoll
(
bool bInLeadingRegion, |
Apply section pre and post roll based on whether we're in the leading (preroll), or trailing (postroll) region for the section, and the current play direction |
![]() ![]() |
FMovieSceneContext | Clamp
(
TRange< FFrameTime > NewRange |
Clamp the current evaluation range to the specified range (in the current transform space) |
![]() ![]() |
int32 | Get the hierarchical bias for the current context | |
![]() ![]() |
FFrameNumber | Access the time at which post roll started (or in other terms: when evaluation stopped) | |
![]() ![]() |
FFrameNumber | Access the time at which preroll will stop, and evaluation will commence | |
![]() ![]() |
const FMovieSceneSequenceTransform & | Get the current root to sequence transform for the current sub sequence | |
![]() ![]() |
const FMovieSceneWarpCounter & | Get the current root to sequence warp counter for the current sub sequence | |
![]() ![]() |
FMovieSceneTimeTransform | Get the inverse transform of the current sub sequence, to transform local times back to root times. | |
![]() ![]() |
EMovieScenePlayerStatus::Type | GetStatus () |
Get the playback status |
![]() ![]() |
bool | HasJumped () |
Check whether we've just jumped to a different time |
![]() ![]() |
bool | Check whether we have an externally supplied time at which postroll started. | |
![]() ![]() |
bool | Check whether we have an externally supplied time at which preroll will end. | |
![]() ![]() |
bool | IsPostRoll () |
Check if we're in any kind of postroll (either postrolling section specifically, or as part of a sub-section) |
![]() ![]() |
bool | IsPreRoll () |
Check if we're in any kind of preroll (either prerolling section specifically, or as part of a sub-section) |
![]() ![]() |
bool | IsSilent () |
Check whether we're evaluating in silent mode (no audio or mutating eval) |
![]() |
void | ReportOuterSectionRanges
(
TRange< FFrameNumber > InLeadingRange, |
Report the outer section pre and post roll ranges for the current context |
![]() |
FMovieSceneContext & | SetHasJumped
(
bool bInHasJumped |
Indicate that we've just jumped to a different time |
![]() |
void | SetHierarchicalBias
(
int32 InHierarchicalBias |
Get the hierarchical bias for the current context |
![]() |
FMovieSceneContext & | SetIsSilent
(
bool bInIsSilent |
Set the context to silent mode |
![]() ![]() |
FMovieSceneContext | Transform
(
const FMovieSceneSequenceTransform& InTransform, |
Transform this context to a different sub sequence space |