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

Inheritance Hierarchy

References

   
Module MovieScene
Header /Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneEvaluationState.h
Include #include "Evaluation/MovieSceneEvaluationState.h"

Syntax

struct FMovieSceneEvaluationState : public UE::MovieScene::IPlaybackCapability

Remarks

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

Variables

  Type Name Description
Public variable TMap< FMovieSceneEvaluationKey, TUniquePtr< IPersistentEvaluationData > > PersistentEntityData A map of persistent evaluation data mapped by movie scene evaluation entity (i.e, a given track or section)
Public variable TMap< FSharedPersistentDataKey, TUniquePtr< IPersistentEvaluationData > > PersistentSharedData A map of persistent evaluation data mapped by shared evaluation key.

Functions

  Type Name Description
Public function void

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

 Assign a sequence to a specific ID
Public function void  
Public function void  
Public function void

ClearObjectCaches ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Forcably clear all object caches
Public function void

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

  
Public function 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
Public function TArrayView< TWeakObjectPtr<> >

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

 Locate objects bound to the specified object guid, in the specified sequence
Public function TArrayView< TWeakObjectPtr<> >

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

 Locate objects bound to the specified sequence operand
Public function FGuid

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

  
Public function FGuid

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

 Attempt deduce the posessable or spawnable that relates to the specified object
Public function Const const FMovieSceneObjectCache * Find an object cache pertaining to the specified sequence
Public function FMovieSceneObjectCache * Find an object cache pertaining to the specified sequence
Public function FGuid

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

  
Public function FGuid

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

 Attempt deduce the posessable or spawnable that relates to the specified object
Public function Const UMovieSceneSequence * Attempt to locate a sequence from its ID
Public function Const FMovieSceneSequenceID Attempt to locate a sequence ID from a sequence
Public function Const FMovieSceneSequenceID

FindSequenceId ( const UMovieSceneSequence* InSequence
)

  
Public function Const bool

GetBindingActivation ( const FGuid& InGuid,
FMovieSceneSequenceIDRef InSequenceID
)

 Gets the current activation on the provided binding.
Public function FMovieSceneObjectCache & Get an object cache pertaining to the specified sequence
Public function uint32 Get the serial number for this state.
Public function void

Invalidate ( const FGuid& InGuid,
FMovieSceneSequenceIDRef InSequenceID
)

 Forcably invalidate the specified object binding in the specified sequence
Public function void Invalidate any object caches that may now contain expired objects
Public function void

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

 Sets the binding to either active or inactive.

Overridden from IPlaybackCapability

  Type Name Description
Public function Virtual void

Initialize ( TSharedRef< const FSharedPlaybackState > Owner
)

 IPlaybackCapability members
Public function 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

Typedefs

Name Description
FSharedPlaybackState  

Constants

Name Description
ID  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page