1. Epic GamesDeveloper
  3. FMovieSceneEvaluationState

FMovieSceneEvaluationState

Provides runtime evaluation functions with the ability to look up state from the main game environment

API > API/Runtime > API/Runtime/MovieScene

Provides runtime evaluation functions with the ability to look up state from the main game environment

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

Syntax

struct FMovieSceneEvaluationState : public UE::MovieScene::IPlaybackCapability

Constructors

Name Remarks Include Path Unreal Specifiers
  Evaluation/MovieSceneEvaluationState.h  
  Evaluation/MovieSceneEvaluationState.h  

Structs

Name Remarks
FVersionedObjectCache Object cache with a last known serial of it

Typedefs

Name Type Remarks Include Path
FSharedPlaybackState UE::MovieScene::FSharedPlaybackState   Evaluation/MovieSceneEvaluationState.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
PersistentEntityData TMap< FMovieSceneEvaluationKey, TUniquePtr< IPersistentEvaluationData > > A map of persistent evaluation data mapped by movie scene evaluation entity (i.e, a given track or section) Evaluation/MovieSceneEvaluationState.h  
PersistentSharedData TMap< FSharedPersistentDataKey, TUniquePtr< IPersistentEvaluationData > > A map of persistent evaluation data mapped by shared evaluation key. Evaluation/MovieSceneEvaluationState.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ObjectCaches TMap< FMovieSceneSequenceID, FVersionedObjectCache > Maps of bound objects, arranged by template ID Evaluation/MovieSceneEvaluationState.h  
SerialNumber uint32 Current serial number of this collection of caches Evaluation/MovieSceneEvaluationState.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AssignSequence ( FMovieSceneSequenceIDRef InSequenceID,
UMovieSceneSequence& InSequence,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Assign a sequence to a specific ID Evaluation/MovieSceneEvaluationState.h  

void AssignSequence ( FMovieSceneSequenceIDRef InSequenceID,
UMovieSceneSequence& InSequence,
IMovieScenePlayer& Player
)

   Evaluation/MovieSceneEvaluationState.h  

void ClearObjectCaches ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Forcably clear all object caches Evaluation/MovieSceneEvaluationState.h  
  Evaluation/MovieSceneEvaluationState.h  

void FilterObjectBindings ( UObject* PredicateObject,
IMovieScenePlayer& Player,
TArray< FMovieSceneObjectBindingID >* OutBindings
)

   Evaluation/MovieSceneEvaluationState.h  

void FilterObjectBindings ( UObject* PredicateObject,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState,
TArray< FMovieSceneObjectBindingID >* OutBindings
)

 Filter all the object bindings in this object cache that contain the specified predicate object Evaluation/MovieSceneEvaluationState.h  

TArrayView< TWeakObjectPtr<> > FindBoundObjects ( const FGuid& ObjectBindingID,
FMovieSceneSequenceIDRef SequenceID,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Locate objects bound to the specified object guid, in the specified sequence Evaluation/MovieSceneEvaluationState.h  

TArrayView< TWeakObjectPtr<> > FindBoundObjects ( const FMovieSceneEvaluationOperand& Operand,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Locate objects bound to the specified sequence operand Evaluation/MovieSceneEvaluationState.h  

FGuid FindCachedObjectId ( UObject& Object,
FMovieSceneSequenceIDRef InSequenceID,
IMovieScenePlayer& Player
)

   Evaluation/MovieSceneEvaluationState.h  

FGuid FindCachedObjectId ( UObject& Object,
FMovieSceneSequenceIDRef InSequenceID,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Attempt deduce the posessable or spawnable that relates to the specified object Evaluation/MovieSceneEvaluationState.h  

const FMovieSceneObjectCache * FindObjectCache ( FMovieSceneSequenceIDRef SequenceID
) const

 Find an object cache pertaining to the specified sequence Evaluation/MovieSceneEvaluationState.h  

FMovieSceneObjectCache * FindObjectCache ( FMovieSceneSequenceIDRef SequenceID
)

 Find an object cache pertaining to the specified sequence Evaluation/MovieSceneEvaluationState.h  

FGuid FindObjectId ( UObject& Object,
FMovieSceneSequenceIDRef InSequenceID,
IMovieScenePlayer& Player
)

   Evaluation/MovieSceneEvaluationState.h  

FGuid FindObjectId ( UObject& Object,
FMovieSceneSequenceIDRef InSequenceID,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Attempt deduce the posessable or spawnable that relates to the specified object Evaluation/MovieSceneEvaluationState.h  

UMovieSceneSequence * FindSequence ( FMovieSceneSequenceIDRef InSequenceID
) const

 Attempt to locate a sequence from its ID Evaluation/MovieSceneEvaluationState.h  
Attempt to locate a sequence ID from a sequence Evaluation/MovieSceneEvaluationState.h  
  Evaluation/MovieSceneEvaluationState.h  

bool GetBindingActivation ( const FGuid& InGuid,
FMovieSceneSequenceIDRef InSequenceID
) const

 Gets the current activation on the provided binding. Evaluation/MovieSceneEvaluationState.h  

FMovieSceneObjectCache & GetObjectCache ( FMovieSceneSequenceIDRef SequenceID
)

 Get an object cache pertaining to the specified sequence Evaluation/MovieSceneEvaluationState.h  

uint32 GetSerialNumber()

 Get the serial number for this state. Evaluation/MovieSceneEvaluationState.h  

void Invalidate ( const FGuid& InGuid,
FMovieSceneSequenceIDRef InSequenceID
)

 Forcably invalidate the specified object binding in the specified sequence Evaluation/MovieSceneEvaluationState.h  

void InvalidateExpiredObjects()

 Invalidate any object caches that may now contain expired objects Evaluation/MovieSceneEvaluationState.h  

void SetBindingActivation ( const FGuid& InGuid,
FMovieSceneSequenceIDRef InSequenceID,
bool bActive
)

 Sets the binding to either active or inactive. Evaluation/MovieSceneEvaluationState.h  

Overridden from IPlaybackCapability

Name Remarks Include Path Unreal Specifiers

virtual void Initialize ( TSharedRef< const FSharedPlaybackState > Owner
)

 IPlaybackCapability members Evaluation/MovieSceneEvaluationState.h  

virtual void OnSubInstanceCreated ( TSharedRef< const FSharedPlaybackState > Owner,
const UE::MovieScene::FInstanceHandle InstanceHandle
)

 Called when a new sequence instance has been created and added to the sequence hierarchy Evaluation/MovieSceneEvaluationState.h  

Static

Name Remarks Include Path Unreal Specifiers
  Evaluation/MovieSceneEvaluationState.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Evaluation/MovieSceneEvaluationState.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page