1. Epic GamesDeveloper
  3. FMovieSceneContext

FMovieSceneContext

MovieScene evaluation context.

API > API/Runtime > API/Runtime/MovieScene

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

   
Name FMovieSceneContext
Type struct
Header File /Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieScenePlayback.h
Include Path #include "Evaluation/MovieScenePlayback.h"

Syntax

struct FMovieSceneContext : public FMovieSceneEvaluationRange

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
Construction from an evaluation range, and a current status Evaluation/MovieScenePlayback.h  
Construction from an evaluation range, and a current status Evaluation/MovieScenePlayback.h  
Construction from an evaluation range, and a current status Evaluation/MovieScenePlayback.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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 Evaluation/MovieScenePlayback.h  

FMovieSceneContext Clamp ( TRange< FFrameTime > NewRange
) const

 Clamp the current evaluation range to the specified range (in the current transform space) Evaluation/MovieScenePlayback.h  

int32 GetHierarchicalBias()

 Get the hierarchical bias for the current context Evaluation/MovieScenePlayback.h  
Access the time at which post roll started (or in other terms: when evaluation stopped) Evaluation/MovieScenePlayback.h  
Access the time at which preroll will stop, and evaluation will commence Evaluation/MovieScenePlayback.h  

const FMovieSceneSequenceTransform & GetRootToSequenceTransform()

 Get the current root to sequence transform for the current sub sequence Evaluation/MovieScenePlayback.h  

const FMovieSceneWarpCounter & GetRootToSequenceWarpCounter()

 Get the current root to sequence warp counter for the current sub sequence Evaluation/MovieScenePlayback.h  

FMovieSceneInverseSequenceTransform GetSequenceToRootSequenceTransform()

 Get the inverse sequence transform of the current sub sequence, to transform local times back to root times. Evaluation/MovieScenePlayback.h  

FMovieSceneTimeTransform GetSequenceToRootTransform()

 Get the inverse transform of the current sub sequence, to transform local times back to root times. Evaluation/MovieScenePlayback.h  
Get the playback status Evaluation/MovieScenePlayback.h  

bool HasJumped()

 Check whether we've just jumped to a different time Evaluation/MovieScenePlayback.h  
Check whether we have an externally supplied time at which postroll started. Evaluation/MovieScenePlayback.h  
Check whether we have an externally supplied time at which preroll will end. Evaluation/MovieScenePlayback.h  

bool IsPostRoll ()

 Check if we're in any kind of postroll (either postrolling section specifically, or as part of a sub-section) Evaluation/MovieScenePlayback.h  

bool IsPreRoll ()

 Check if we're in any kind of preroll (either prerolling section specifically, or as part of a sub-section) Evaluation/MovieScenePlayback.h  

bool IsSilent()

 Check whether we're evaluating in silent mode (no audio or mutating eval) Evaluation/MovieScenePlayback.h  

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

 Report the outer section pre and post roll ranges for the current context Evaluation/MovieScenePlayback.h  

FMovieSceneContext & SetHasJumped ( bool bInHasJumped
)

 Indicate that we've just jumped to a different time Evaluation/MovieScenePlayback.h  

void SetHierarchicalBias ( int32 InHierarchicalBias
)

 Get the hierarchical bias for the current context Evaluation/MovieScenePlayback.h  

FMovieSceneContext & SetIsSilent ( bool bInIsSilent
)

 Set the context to silent mode Evaluation/MovieScenePlayback.h  

FMovieSceneContext Transform ( const FMovieSceneSequenceTransform& InTransform,
FFrameRate NewFrameRate
) const

 Transform this context to a different sub sequence space Evaluation/MovieScenePlayback.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page