1. Epic GamesDeveloper
  3. ISequenceUpdater

ISequenceUpdater

Interface for an object that will update a sequence based on the current context.

API > API/Runtime > API/Runtime/MovieScene

Interface for an object that will update a sequence based on the current context. It holds several responsibilities:

Handle dissection of evaluation contexts based on determinism fences

To add pending instantiations to FInstanceRegistry for newly-evaluated source entities

To add the Unlink tag for any linker entities that are now longer required for evaluation (ie, have just finished evaluating)

To handle 1 and 2 for any sub sequences that may or may not be required for the context

To handle legacy track template evaluation

   
Name ISequenceUpdater
Type struct
Header File /Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneSequenceUpdaters.h
Include Path #include "EntitySystem/MovieSceneSequenceUpdaters.h"

Syntax

struct ISequenceUpdater

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ISequenceUpdater()

 Virtual destructor EntitySystem/MovieSceneSequenceUpdaters.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanFinishImmediately ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState
) const

 Returns whether this instance can be finished immediately without any last update. EntitySystem/MovieSceneSequenceUpdaters.h  

void Destroy ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Called right before this updater's sequence instance is about to be destroyed completely EntitySystem/MovieSceneSequenceUpdaters.h  

void DissectContext ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState,
const FMovieSceneContext& InContext,
TArray< TRange< FFrameTime > >& OutDissections
)

 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. EntitySystem/MovieSceneSequenceUpdaters.h  

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

 Evaluate a condition on this sequence instance hierarchy, utilizing any cache as relevant. EntitySystem/MovieSceneSequenceUpdaters.h  

FInstanceHandle FindSubInstance ( FMovieSceneSequenceID SubSequenceID
) const

 Find a sub sequence instance from its ID (if it exists) EntitySystem/MovieSceneSequenceUpdaters.h  

void Finish ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Called before evaluation when this updater's sequence is no longer required to be evaluated EntitySystem/MovieSceneSequenceUpdaters.h  

void InvalidateCachedData ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

   EntitySystem/MovieSceneSequenceUpdaters.h  

void InvalidateCachedData ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState,
ESequenceInstanceInvalidationType InvalidationType
)

 Invalidate any cached information that depends on the compiled sequence data due to the compiled data changing EntitySystem/MovieSceneSequenceUpdaters.h  

TUniquePtr< ISequenceUpdater > MigrateToHierarchical()

 Migrate this updater to one that can represent hierarchical data. EntitySystem/MovieSceneSequenceUpdaters.h  

void OverrideRootSequence ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState,
FMovieSceneSequenceID NewRootOverrideSequenceID
)

 Override the sequence ID that should be considered the root sequence for this updater EntitySystem/MovieSceneSequenceUpdaters.h  

void PopulateUpdateFlags ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState,
ESequenceInstanceUpdateFlags& OutUpdateFlags
)

 Called to initialize the flag structure that denotes what functions need to be called on this updater EntitySystem/MovieSceneSequenceUpdaters.h  

void Start ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState,
const FMovieSceneContext& InContext
)

 Called if this updater has not been evaluated before, or has since been Finished. EntitySystem/MovieSceneSequenceUpdaters.h  

void Update ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState,
const FMovieSceneContext& InContext
)

 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) EntitySystem/MovieSceneSequenceUpdaters.h  

Static

Name Remarks Include Path Unreal Specifiers

static void FactoryInstance ( TUniquePtr< ISequenceUpdater >& OutPtr,
UMovieSceneCompiledDataManager* CompiledDataManager,
FMovieSceneCompiledDataID CompiledDataID
)

 Entry-point for creating or updating a new ISequenceUpdater interface based on the requirements of the compiled data. EntitySystem/MovieSceneSequenceUpdaters.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page