1. Epic GamesDeveloper
  3. FMovieSceneContext

FMovieSceneContext

MovieScene evaluation context.

API > API/Runtime > API/Runtime/MovieScene > API/Runtime/MovieScene/Evaluation

Inheritance Hierarchy

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
Protected variable bool: 1 bHasJumped Whether this evaluation frame is happening as part of a large jump
Protected variable bool: 1 bHasPostRollStartTime True if the value of PrePostRollStartEndTime has been set, and refers to the time at which postroll started.
Protected variable bool: 1 bHasPreRollEndTime True if the value of PrePostRollStartEndTime has been set, and refers to the time at which preroll will end.
Protected variable bool: 1 bSectionPostRoll True if we should explicitly postroll the section. Already reconciled with play direction.
Protected variable bool: 1 bSectionPreRoll True if we should explicitly preroll the section. Already reconciled with play direction.
Protected variable bool: 1 bSilent Whether this evaluation should happen silently
Protected variable int32 HierarchicalBias Hierachical bias. Higher bias should take precedence.
Protected variable FFrameNumber PrePostRollStartEndTime When bHasPreRollEndTime or bHasPostRollStartTime is true, this defines either the frame at which 'real' evaluation commences, or finished
Protected variable FMovieSceneSequenceTransform RootToSequenceTransform The transform from the root sequence to the current sequence space
Protected variable FMovieSceneWarpCounter RootToSequenceWarpCounter The current warp count for any sub-sequence in the current sequence's hierarchy
Protected variable EMovieScenePlayerStatus::Type Status The current playback status

Constructors

  Type Name Description
Public function   Construction from an evaluation range, and a current status
Public function   Construction from an evaluation range, and a current status
Public function   Construction from an evaluation range, and a current status

Functions

  Type Name Description
Public function void

ApplySectionPrePostRoll ( bool bInLeadingRegion,
bool bInTrailingRegion
)

 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
Public function Const FMovieSceneContext

Clamp ( TRange< FFrameTime > NewRange
)

 Clamp the current evaluation range to the specified range (in the current transform space)
Public function Const int32 Get the hierarchical bias for the current context
Public function Const FFrameNumber Access the time at which post roll started (or in other terms: when evaluation stopped)
Public function Const FFrameNumber Access the time at which preroll will stop, and evaluation will commence
Public function Const const FMovieSceneSequenceTransform & Get the current root to sequence transform for the current sub sequence
Public function Const const FMovieSceneWarpCounter & Get the current root to sequence warp counter for the current sub sequence
Public function Const FMovieSceneTimeTransform Get the inverse transform of the current sub sequence, to transform local times back to root times.
Public function Const EMovieScenePlayerStatus::Type Get the playback status
Public function Const bool Check whether we've just jumped to a different time
Public function Const bool Check whether we have an externally supplied time at which postroll started.
Public function Const bool Check whether we have an externally supplied time at which preroll will end.
Public function Const bool Check if we're in any kind of postroll (either postrolling section specifically, or as part of a sub-section)
Public function Const bool Check if we're in any kind of preroll (either prerolling section specifically, or as part of a sub-section)
Public function Const bool Check whether we're evaluating in silent mode (no audio or mutating eval)
Public function void

ReportOuterSectionRanges ( TRange< FFrameNumber > InLeadingRange,
TRange< FFrameNumber > InTrailingRange
)

 Report the outer section pre and post roll ranges for the current context
Public function FMovieSceneContext &

SetHasJumped ( bool bInHasJumped
)

 Indicate that we've just jumped to a different time
Public function void

SetHierarchicalBias ( int32 InHierarchicalBias
)

 Get the hierarchical bias for the current context
Public function FMovieSceneContext &

SetIsSilent ( bool bInIsSilent
)

 Set the context to silent mode
Public function Const FMovieSceneContext

Transform ( const FMovieSceneSequenceTransform& InTransform,
FFrameRate NewFrameRate
)

 Transform this context to a different sub sequence space

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page