1. Epic GamesDeveloper
  3. FMovieSceneObjectCache

FMovieSceneObjectCache

Object cache that looks up, resolves, and caches object bindings for a specific sequence

API > API/Runtime > API/Runtime/MovieScene

Object cache that looks up, resolves, and caches object bindings for a specific sequence

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

Syntax

struct FMovieSceneObjectCache

Structs

Name Remarks
FBoundObjects  
TFastGuidKeyFuncs  

Typedefs

Name Type Remarks Include Path
FGuidArray TArray< FGuid, TInlineAllocator< 4 > > Map of child bindings for any given object binding Evaluation/MovieSceneEvaluationState.h
FOnBindingInvalidated TMulticastDelegate_OneParam< void, const FGuid & >   Evaluation/MovieSceneEvaluationState.h
FSharedPlaybackState UE::MovieScene::FSharedPlaybackState   Evaluation/MovieSceneEvaluationState.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnBindingInvalidated FOnBindingInvalidated Invoked when a binding is either explicitly invalidated (as a result of a spawnable being spawned, or a binding override being added) or when a previously resolved binding becomes invalid Evaluation/MovieSceneEvaluationState.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
BoundObjects TMap< FGuid, FBoundObjects, FDefaultSetAllocator, TFastGuidKeyFuncs< FBoundObjects > > A map of bound objects Evaluation/MovieSceneEvaluationState.h  
bReentrantUpdate bool   Evaluation/MovieSceneEvaluationState.h  
ChildBindings TMap< FGuid, FGuidArray, FDefaultSetAllocator, TFastGuidKeyFuncs< FGuidArray > >   Evaluation/MovieSceneEvaluationState.h  
InactiveBindingIds TSet< FGuid > A set of inactive binding ids based on Binding Lifetime track. Evaluation/MovieSceneEvaluationState.h  
ReverseMappedBindings TMap< FMovieSceneObjectBindingID, FGuidArray, FDefaultSetAllocator > For possessables in this scene that map to a binding in another scene (for example to a spawnable in another scene). Evaluation/MovieSceneEvaluationState.h  
SequenceID FMovieSceneSequenceID The sequence ID of the sequence within the root sequence Evaluation/MovieSceneEvaluationState.h  
SerialNumber uint32 Serial number for this cache Evaluation/MovieSceneEvaluationState.h  
WeakSequence TWeakObjectPtr< UMovieSceneSequence > The sequence that we're caching objects for Evaluation/MovieSceneEvaluationState.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Clear ( IMovieScenePlayer& Player
)

   Evaluation/MovieSceneEvaluationState.h  

void Clear ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Completely erase all knowledge of, anc caches for all object bindings 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& InBindingID,
IMovieScenePlayer& Player
)

   Evaluation/MovieSceneEvaluationState.h  

TArrayView< TWeakObjectPtr<> > FindBoundObjects ( const FGuid& InBindingID,
TSharedRef< const FSharedPlaybackState > InSharedPlaybackState
)

 Find all objects that are bound to the specified binding ID Evaluation/MovieSceneEvaluationState.h  
  Evaluation/MovieSceneEvaluationState.h  

FGuid FindCachedObjectId ( UObject& InObject,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

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

FGuid FindObjectId ( UObject& InObject,
IMovieScenePlayer& Player
)

   Evaluation/MovieSceneEvaluationState.h  

FGuid FindObjectId ( UObject& InObject,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

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

bool GetBindingActivation ( const FGuid& InGuid
) const

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

UMovieSceneSequence * GetSequence()

 Get the sequence that this cache relates to Evaluation/MovieSceneEvaluationState.h  

uint32 GetSerialNumber()

 Get the current serial number of this cache Evaluation/MovieSceneEvaluationState.h  

void Invalidate ( const FGuid& InGuid
)

 Invalidate the object bindings for a specific object binding ID in this sequence Evaluation/MovieSceneEvaluationState.h  

void Invalidate ( const FGuid& InGuid,
FMovieSceneSequenceIDRef InSequenceID
)

 Invalidate the object bindings for a specific object binding ID in the specified sequence ID. Evaluation/MovieSceneEvaluationState.h  

void InvalidateExpiredObjects()

 Invalidate any object bindings for objects that have been destroyed Evaluation/MovieSceneEvaluationState.h  

void InvalidateIfValid ( const FGuid& InGuid
)

 Invalidate the object bindings for a specific object binding ID if they are not already invalidated Evaluation/MovieSceneEvaluationState.h  

TArrayView< const TWeakObjectPtr<> > IterateBoundObjects ( const FGuid& InBindingID
) const

 Find all objects that are bound to the specified binding ID Evaluation/MovieSceneEvaluationState.h  

void SetBindingActivation ( const FGuid& InGuid,
bool bActive
)

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

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

 Set the sequence that this cache applies to Evaluation/MovieSceneEvaluationState.h  

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

   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