#include <MovieSceneEvaluationState.h>

Inheritance diagram for FMovieSceneEvaluationState:

Public Types
using	FSharedPlaybackState = UE::MovieScene::FSharedPlaybackState

Public Member Functions
	FMovieSceneEvaluationState ()=default

	FMovieSceneEvaluationState (const FMovieSceneEvaluationState &)=delete

FMovieSceneEvaluationState &	operator= (const FMovieSceneEvaluationState &)=delete

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

MOVIESCENE_API UMovieSceneSequence *	FindSequence (FMovieSceneSequenceIDRef InSequenceID) const

MOVIESCENE_API FMovieSceneSequenceID	FindSequenceId (UMovieSceneSequence *InSequence) const

MOVIESCENE_API FMovieSceneSequenceID	FindSequenceId (const UMovieSceneSequence *InSequence) const

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

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

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

FMovieSceneObjectCache *	FindObjectCache (FMovieSceneSequenceIDRef SequenceID)

const FMovieSceneObjectCache *	FindObjectCache (FMovieSceneSequenceIDRef SequenceID) const

FMovieSceneObjectCache &	GetObjectCache (FMovieSceneSequenceIDRef SequenceID)

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

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

MOVIESCENE_API void	InvalidateExpiredObjects ()

MOVIESCENE_API void	Invalidate (const FGuid &InGuid, FMovieSceneSequenceIDRef InSequenceID)

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

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

MOVIESCENE_API void	ClearObjectCaches (TSharedRef< const FSharedPlaybackState > SharedPlaybackState)

MOVIESCENE_API uint32	GetSerialNumber ()

virtual MOVIESCENE_API void	Initialize (TSharedRef< const FSharedPlaybackState > Owner) override

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

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

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

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

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

MOVIESCENE_API void	ClearObjectCaches (IMovieScenePlayer &Player)

Public Member Functions inherited from UE::MovieScene::IPlaybackCapability
virtual	~IPlaybackCapability ()

virtual void	InvalidateCachedData (UMovieSceneEntitySystemLinker *Linker)

Public Attributes
TMap< FMovieSceneEvaluationKey, TUniquePtr< IPersistentEvaluationData > >	PersistentEntityData

TMap< FSharedPersistentDataKey, TUniquePtr< IPersistentEvaluationData > >	PersistentSharedData

Detailed Description

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

Member Typedef Documentation

◆ FSharedPlaybackState

using FMovieSceneEvaluationState::FSharedPlaybackState = UE::MovieScene::FSharedPlaybackState

Constructor & Destructor Documentation

◆ FMovieSceneEvaluationState() [1/2]

FMovieSceneEvaluationState::FMovieSceneEvaluationState ( )

default

◆ FMovieSceneEvaluationState() [2/2]

FMovieSceneEvaluationState::FMovieSceneEvaluationState ( const FMovieSceneEvaluationState & )

delete

Member Function Documentation

◆ AssignSequence() [1/2]

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

◆ AssignSequence() [2/2]

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

Assign a sequence to a specific ID

Parameters

InSequenceID	The sequence ID to assign to
InSequence	The sequence to assign

◆ ClearObjectCaches() [1/2]

void FMovieSceneEvaluationState::ClearObjectCaches ( IMovieScenePlayer & Player )

◆ ClearObjectCaches() [2/2]

void FMovieSceneEvaluationState::ClearObjectCaches ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState )

Forcably clear all object caches

◆ FilterObjectBindings() [1/2]

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

◆ FilterObjectBindings() [2/2]

void FMovieSceneEvaluationState::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

Parameters

PredicateObject	The object to filter by. Any bindings referencing this object will be added to the output array.
Player	The movie scene player that is playing back the sequence
OutBindings	(mandatory) Array to populate with bindings that relate to the object

◆ FindBoundObjects() [1/2]

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

inline

Locate objects bound to the specified object guid, in the specified sequence

Note: : Objects lists are cached internally until they are invalidate.

Parameters

ObjectBindingID	The object to resolve
SequenceID	ID of the sequence to resolve for

Returns: Iterable list of weak object pointers pertaining to the specified GUID

◆ FindBoundObjects() [2/2]

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

inline

Locate objects bound to the specified sequence operand

Note: : Objects lists are cached internally until they are invalidate.

Parameters

Operand The movie scene operand to resolve

Returns: Iterable list of weak object pointers pertaining to the specified GUID

◆ FindCachedObjectId() [1/2]

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

◆ FindCachedObjectId() [2/2]

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

Attempt deduce the posessable or spawnable that relates to the specified object

Note: Does not clear the existing cache

Parameters

InObject	The object whose binding ID is to be find
Player	The movie scene player that is playing back the sequence

Returns: The object's spawnable or possessable GUID, or a zero GUID if it was not found

◆ FindObjectCache() [1/2]

FMovieSceneObjectCache * FMovieSceneEvaluationState::FindObjectCache ( FMovieSceneSequenceIDRef SequenceID )

inline

Find an object cache pertaining to the specified sequence

Parameters

InSequenceID The sequence ID to lookup

◆ FindObjectCache() [2/2]

const FMovieSceneObjectCache * FMovieSceneEvaluationState::FindObjectCache ( FMovieSceneSequenceIDRef SequenceID ) const

inline

Find an object cache pertaining to the specified sequence

Parameters

InSequenceID The sequence ID to lookup

◆ FindObjectId() [1/2]

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

◆ FindObjectId() [2/2]

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

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

Parameters

InObject	The object whose binding ID is to be find
Player	The movie scene player that is playing back the sequence

Returns: The object's spawnable or possessable GUID, or a zero GUID if it was not found

◆ FindSequence()

UMovieSceneSequence * FMovieSceneEvaluationState::FindSequence ( FMovieSceneSequenceIDRef InSequenceID ) const

Attempt to locate a sequence from its ID

Parameters

InSequenceID The sequence ID to lookup

◆ FindSequenceId() [1/2]

FMovieSceneSequenceID FMovieSceneEvaluationState::FindSequenceId ( const UMovieSceneSequence * InSequence ) const

◆ FindSequenceId() [2/2]

FMovieSceneSequenceID FMovieSceneEvaluationState::FindSequenceId ( UMovieSceneSequence * InSequence ) const

Attempt to locate a sequence ID from a sequence

Parameters

InSequence The sequence to look up

◆ GetBindingActivation()

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

◆ GetObjectCache()

FMovieSceneObjectCache & FMovieSceneEvaluationState::GetObjectCache ( FMovieSceneSequenceIDRef SequenceID )

inline

Get an object cache pertaining to the specified sequence

Parameters

InSequenceID The sequence ID to lookup

◆ GetSerialNumber()

uint32 FMovieSceneEvaluationState::GetSerialNumber ( )

Get the serial number for this state.

◆ Initialize()

void FMovieSceneEvaluationState::Initialize ( TSharedRef< const FSharedPlaybackState > Owner )

overridevirtual

IPlaybackCapability members

Reimplemented from UE::MovieScene::IPlaybackCapability.

◆ Invalidate()

void FMovieSceneEvaluationState::Invalidate	(	const FGuid &	InGuid,
		FMovieSceneSequenceIDRef	InSequenceID
	)

Forcably invalidate the specified object binding in the specified sequence

Parameters

InGuid	The object binding ID to invalidate
InSequenceID	The sequence ID to which the object binding belongs

◆ InvalidateExpiredObjects()

void FMovieSceneEvaluationState::InvalidateExpiredObjects ( )

Invalidate any object caches that may now contain expired objects

◆ OnSubInstanceCreated()

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

overridevirtual

Called when a new sequence instance has been created and added to the sequence hierarchy

Reimplemented from UE::MovieScene::IPlaybackCapability.

◆ operator=()

FMovieSceneEvaluationState & FMovieSceneEvaluationState::operator= ( const FMovieSceneEvaluationState & )

delete

◆ SetBindingActivation()

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

Member Data Documentation

◆ PersistentEntityData

TMap<FMovieSceneEvaluationKey, TUniquePtr<IPersistentEvaluationData> > FMovieSceneEvaluationState::PersistentEntityData

A map of persistent evaluation data mapped by movie scene evaluation entity (i.e, a given track or section)

◆ PersistentSharedData

TMap<FSharedPersistentDataKey, TUniquePtr<IPersistentEvaluationData> > FMovieSceneEvaluationState::PersistentSharedData

A map of persistent evaluation data mapped by shared evaluation key. Such data can be accessed from anywhere given an operand and a unique identifier.

The documentation for this struct was generated from the following files:

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

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ FSharedPlaybackState

Constructor & Destructor Documentation

◆ FMovieSceneEvaluationState() [1/2]

◆ FMovieSceneEvaluationState() [2/2]

Member Function Documentation

◆ AssignSequence() [1/2]

◆ AssignSequence() [2/2]

◆ ClearObjectCaches() [1/2]

◆ ClearObjectCaches() [2/2]

◆ FilterObjectBindings() [1/2]

◆ FilterObjectBindings() [2/2]

◆ FindBoundObjects() [1/2]

◆ FindBoundObjects() [2/2]

◆ FindCachedObjectId() [1/2]

◆ FindCachedObjectId() [2/2]

◆ FindObjectCache() [1/2]

◆ FindObjectCache() [2/2]

◆ FindObjectId() [1/2]

◆ FindObjectId() [2/2]

◆ FindSequence()

◆ FindSequenceId() [1/2]

◆ FindSequenceId() [2/2]

◆ GetBindingActivation()

◆ GetObjectCache()

◆ GetSerialNumber()

◆ Initialize()

◆ Invalidate()

◆ InvalidateExpiredObjects()

◆ OnSubInstanceCreated()

◆ operator=()

◆ SetBindingActivation()

Member Data Documentation

◆ PersistentEntityData

◆ PersistentSharedData