Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > MovieScene > Evaluation > FMovieSceneContext

Light Theme

Dark Theme

FMovieSceneContext

MovieScene evaluation context.

Windows

MacOS

Linux

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

	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
FMovieSceneSequ...	RootToSequenceTransform	The transform from the root sequence to the current sequence space
EMovieScenePlay...	Status	The current playback status

Constructors

	Name	Description
	FMovieSceneContext ( FMovieSceneEvaluationRange InRange )	Construction from an evaluation range, and a current status
	FMovieSceneContext ( FMovieSceneEvaluationRange InRange, EMovieScenePlayerStatus::Type InSta... )	Construction from an evaluation range, and a current status

Functions

	Name	Description
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
FMovieSceneC...	Clamp ( TRange< FFrameTime > NewRange )	Clamp the current evaluation range to the specified range (in the current transform space)
int32	GetHierarchicalBias()	Get the hierarchical bias for the current context
FFrameNumber	GetPostRollStartFrame()	Access the time at which post roll started (or in other terms: when evaluation stopped)
FFrameNumber	GetPreRollEndFrame()	Access the time at which preroll will stop, and evaluation will commence
const FMovie...	GetRootToSequenceTransform()	Get the current root to sequence transform for the current sub sequence
EMovieSceneP...	GetStatus()	Get the playback status
bool	HasJumped()	Check whether we've just jumped to a different time
bool	HasPostRollStartTime()	Check whether we have an externally supplied time at which postroll started.
bool	HasPreRollEndTime()	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 > InLeadingRan..., TRange< FFrameNumber > InTrailingRa... )	Report the outer section pre and post roll ranges for the current context
FMovieSceneC...	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
FMovieSceneC...	SetIsSilent ( bool bInIsSilent )	Set the context to silent mode
FMovieSceneC...	Transform ( const FMovieSceneSequenceTransform ..., FFrameRate NewFrameRate )	Transform this context to a different sub sequence space

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss