FMovieSceneObjectCache

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

Windows
MacOS
Linux

References

Module

MovieScene

Header

/Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneEvaluationState.h

Include

#include "Evaluation/MovieSceneEvaluationState.h"

Syntax

struct FMovieSceneObjectCache

Remarks

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

Variables

Name Description

Public variable

FOnBindingInval...

 

OnBindingInvalidated

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

Functions

Name Description

Public function

void

 

Clear

(
    IMovieScenePlayer& Player
)

Completely erase all knowledge of, anc caches for all object bindings

Public function

void

 

FilterObjectBindings

(
    UObject* PredicateObject,
    IMovieScenePlayer& Player,
    TArray< FMovieSceneObjectBindingID ...
)

Filter all the object bindings in this object cache that contain the specified predicate object

Public function

TArrayView< ...

 

FindBoundObjects

(
    const FGuid& InBindingID,
    IMovieScenePlayer& Player
)

Find all objects that are bound to the specified binding ID @note Will look up, and cache any objects if the cache has been invalidated

Public function

FGuid

 

FindCachedObjectId

(
    UObject& InObject,
    IMovieScenePlayer& Player
)

Attempt deduce the posessable or spawnable that relates to the specified object @note Does not clear the existing cache

Public function

FGuid

 

FindObjectId

(
    UObject& InObject,
    IMovieScenePlayer& Player
)

Attempt deduce the posessable or spawnable that relates to the specified object @note Will forcably resolve any out of date bindings in the entire sequence

Public function Const

UMovieSceneS...

 

GetSequence()

Get the sequence that this cache relates to

Public function Const

uint32

 

GetSerialNumber()

Get the current serial number of this cache

Public function

void

 

Invalidate

(
    const FGuid& InGuid
)

Invalidate the object bindings for a specific object binding ID

Public function

void

 

InvalidateExpiredObjects()

Invalidate any object bindings for objects that have been destroyed

Public function

void

 

InvalidateIfValid

(
    const FGuid& InGuid
)

Invalidate the object bindings for a specific object binding ID if they are not already invalidated

Public function Const

TArrayView< ...

 

IterateBoundObjects

(
    const FGuid& InBindingID
)

Find all objects that are bound to the specified binding ID @note Does not update bindings if they are out of date, or invalid

Public function

void

 

SetSequence

(
    UMovieSceneSequence& InSequence,
    FMovieSceneSequenceIDRef InSequence...,
    IMovieScenePlayer& Player
)

Set the sequence that this cache applies to

Typedefs

Name

Description

FGuidArray

Map of child bindings for any given object binding

FOnBindingInvalidated
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss