UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::MovieScene::FSequenceUpdater_Flat Struct Reference
+ Inheritance diagram for UE::MovieScene::FSequenceUpdater_Flat:

Public Member Functions

 FSequenceUpdater_Flat (FMovieSceneCompiledDataID InCompiledDataID)
 
 ~FSequenceUpdater_Flat ()
 
virtual void PopulateUpdateFlags (TSharedRef< const FSharedPlaybackState > SharedPlaybackState, ESequenceInstanceUpdateFlags &OutUpdateFlags) override
 
virtual void DissectContext (TSharedRef< const FSharedPlaybackState > SharedPlaybackState, const FMovieSceneContext &Context, TArray< TRange< FFrameTime > > &OutDissections) override
 
virtual void Start (TSharedRef< const FSharedPlaybackState > SharedPlaybackState, const FMovieSceneContext &InContext) override
 
virtual void Update (TSharedRef< const FSharedPlaybackState > SharedPlaybackState, const FMovieSceneContext &Context) override
 
virtual bool CanFinishImmediately (TSharedRef< const FSharedPlaybackState > SharedPlaybackState) const override
 
virtual void Finish (TSharedRef< const FSharedPlaybackState > SharedPlaybackState) override
 
virtual void InvalidateCachedData (TSharedRef< const FSharedPlaybackState > SharedPlaybackState, ESequenceInstanceInvalidationType InvalidationType) override
 
virtual void Destroy (TSharedRef< const FSharedPlaybackState > SharedPlaybackState) override
 
virtual TUniquePtr< ISequenceUpdaterMigrateToHierarchical () override
 
virtual FInstanceHandle FindSubInstance (FMovieSceneSequenceID SubSequenceID) const override
 
virtual void OverrideRootSequence (TSharedRef< const FSharedPlaybackState > SharedPlaybackState, FMovieSceneSequenceID NewRootOverrideSequenceID) override
 
virtual bool EvaluateCondition (const FGuid &BindingID, const FMovieSceneSequenceID &SequenceID, const UMovieSceneCondition *Condition, UObject *ConditionOwnerObject, TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState) const override
 
- Public Member Functions inherited from UE::MovieScene::ISequenceUpdater
virtual ~ISequenceUpdater ()
 
MOVIESCENE_API void InvalidateCachedData (TSharedRef< const FSharedPlaybackState > SharedPlaybackState)
 

Additional Inherited Members

- Static Public Member Functions inherited from UE::MovieScene::ISequenceUpdater
static void FactoryInstance (TUniquePtr< ISequenceUpdater > &OutPtr, UMovieSceneCompiledDataManager *CompiledDataManager, FMovieSceneCompiledDataID CompiledDataID)
 

Detailed Description

Flat sequence updater (ie, no hierarchy)

Constructor & Destructor Documentation

◆ FSequenceUpdater_Flat()

UE::MovieScene::FSequenceUpdater_Flat::FSequenceUpdater_Flat ( FMovieSceneCompiledDataID  InCompiledDataID)
explicit

◆ ~FSequenceUpdater_Flat()

UE::MovieScene::FSequenceUpdater_Flat::~FSequenceUpdater_Flat ( )

Member Function Documentation

◆ CanFinishImmediately()

bool UE::MovieScene::FSequenceUpdater_Flat::CanFinishImmediately ( TSharedRef< const FSharedPlaybackState SharedPlaybackState) const
overridevirtual

Returns whether this instance can be finished immediately without any last update.

Parameters
LinkerThe linker that owns this sequence instance
RootInstanceHandleThe handle to the root instance
Returns
Whether the instance can be finished immediately

Implements UE::MovieScene::ISequenceUpdater.

◆ Destroy()

void UE::MovieScene::FSequenceUpdater_Flat::Destroy ( TSharedRef< const FSharedPlaybackState SharedPlaybackState)
overridevirtual

Called right before this updater's sequence instance is about to be destroyed completely

Parameters
InLinkerThe linker that is owns this sequence

Implements UE::MovieScene::ISequenceUpdater.

◆ DissectContext()

void UE::MovieScene::FSequenceUpdater_Flat::DissectContext ( TSharedRef< const FSharedPlaybackState SharedPlaybackState,
const FMovieSceneContext InContext,
TArray< TRange< FFrameTime > > &  OutDissections 
)
overridevirtual

Called before any updates to the sequence to allow this updater to dissect the context into smaller ranges that should be evaluated independently for the purpose of ensuring determinism. If the resulting array is empty the whole context will be used by default.

Parameters
InLinkerThe linker that is evaluating this sequence
InPlayerThe movie scene player instance playing this sequence
InContextThe total root-level context for the next evaluation to be dissected
OutDissections(Out) Array to populate with dissected ranges

Implements UE::MovieScene::ISequenceUpdater.

◆ EvaluateCondition()

bool UE::MovieScene::FSequenceUpdater_Flat::EvaluateCondition ( const FGuid BindingID,
const FMovieSceneSequenceID SequenceID,
const UMovieSceneCondition Condition,
UObject ConditionOwnerObject,
TSharedRef< const UE::MovieScene::FSharedPlaybackState SharedPlaybackState 
) const
overridevirtual

◆ FindSubInstance()

virtual FInstanceHandle UE::MovieScene::FSequenceUpdater_Flat::FindSubInstance ( FMovieSceneSequenceID  SubSequenceID) const
inlineoverridevirtual

Find a sub sequence instance from its ID (if it exists)

Implements UE::MovieScene::ISequenceUpdater.

◆ Finish()

void UE::MovieScene::FSequenceUpdater_Flat::Finish ( TSharedRef< const FSharedPlaybackState SharedPlaybackState)
overridevirtual

Called before evaluation when this updater's sequence is no longer required to be evaluated

Parameters
InLinkerThe linker that is evaluating this sequence
InInstanceHandleThe instance handle for the top level sequence instance that this updater belongs to
InPlayerThe movie scene player instance playing this sequence

Implements UE::MovieScene::ISequenceUpdater.

◆ InvalidateCachedData()

void UE::MovieScene::FSequenceUpdater_Flat::InvalidateCachedData ( TSharedRef< const FSharedPlaybackState SharedPlaybackState,
ESequenceInstanceInvalidationType  InvalidationType 
)
overridevirtual

Invalidate any cached information that depends on the compiled sequence data due to the compiled data changing

Parameters
InLinkerThe linker that is evaluating this sequence
InInstanceHandleThe instance handle for the top level sequence instance that this updater belongs to

Implements UE::MovieScene::ISequenceUpdater.

◆ MigrateToHierarchical()

TUniquePtr< ISequenceUpdater > UE::MovieScene::FSequenceUpdater_Flat::MigrateToHierarchical ( )
overridevirtual

Migrate this updater to one that can represent hierarchical data.

Returns
A new instance capable of dealing with hierarchical data, or nullptr if this already does.

Implements UE::MovieScene::ISequenceUpdater.

◆ OverrideRootSequence()

virtual void UE::MovieScene::FSequenceUpdater_Flat::OverrideRootSequence ( TSharedRef< const FSharedPlaybackState SharedPlaybackState,
FMovieSceneSequenceID  NewRootOverrideSequenceID 
)
inlineoverridevirtual

Override the sequence ID that should be considered the root sequence for this updater

Parameters
InLinkerThe linker that is owns this sequence
InstanceHandleThe instance handle for the root sequence
NewRootOverrideSequenceIDThe new sequence ID to treat as the root

Implements UE::MovieScene::ISequenceUpdater.

◆ PopulateUpdateFlags()

void UE::MovieScene::FSequenceUpdater_Flat::PopulateUpdateFlags ( TSharedRef< const FSharedPlaybackState SharedPlaybackState,
ESequenceInstanceUpdateFlags OutUpdateFlags 
)
overridevirtual

Called to initialize the flag structure that denotes what functions need to be called on this updater

Implements UE::MovieScene::ISequenceUpdater.

◆ Start()

void UE::MovieScene::FSequenceUpdater_Flat::Start ( TSharedRef< const FSharedPlaybackState SharedPlaybackState,
const FMovieSceneContext InContext 
)
overridevirtual

Called if this updater has not been evaluated before, or has since been Finished.

Parameters
InLinkerThe linker that is evaluating this sequence
InInstanceHandleThe instance handle for the top level sequence instance that this updater belongs to
InPlayerThe movie scene player instance playing this sequence
InContextThe root-level context for the current evaluation.

Implements UE::MovieScene::ISequenceUpdater.

◆ Update()

void UE::MovieScene::FSequenceUpdater_Flat::Update ( TSharedRef< const FSharedPlaybackState SharedPlaybackState,
const FMovieSceneContext InContext 
)
overridevirtual

Called in order that this updater may make any changes to the linker's environment before its sequence is evaluated (ie, initialize or unlink any entity instantiations)

Parameters
InLinkerThe linker that is evaluating this sequence
InInstanceHandleThe instance handle for the top level sequence instance that this updater belongs to
InPlayerThe movie scene player instance playing this sequence
InContextThe root-level context for the current evaluation.

Implements UE::MovieScene::ISequenceUpdater.


The documentation for this struct was generated from the following file: