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 > API/Runtime/MovieScene/EntitySystem

References

   
Module MovieScene
Header /Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneSequenceUpdaters.h
Include #include "EntitySystem/MovieSceneSequenceUpdaters.h"

Syntax

struct ISequenceUpdater

Remarks

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

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function Const bool

CanFinishImmediately ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

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

Destroy ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Called right before this updater's sequence instance is about to be destroyed completely
Public function 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.
Public function 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.
Public function Const FInstanceHandle Find a sub sequence instance from its ID (if it exists)
Public function void

Finish ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

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

InvalidateCachedData ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Invalidate any cached information that depends on the compiled sequence data due to the compiled data changing
Public function TUniquePtr< ISequenceUpdater > Migrate this updater to one that can represent hierarchical data.
Public function void

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

 Override the sequence ID that should be considered the root sequence for this updater
Public function 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
Public function void

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

 Called if this updater has not been evaluated before, or has since been Finished.
Public function 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)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page