#include <MovieSceneBindingReferences.h>

Inheritance diagram for FMovieSceneBindingReferences:

Public Member Functions
MOVIESCENE_API TArrayView< const FMovieSceneBindingReference >	GetAllReferences () const

MOVIESCENE_API TArrayView< FMovieSceneBindingReference >	GetAllReferences ()

MOVIESCENE_API TArrayView< const FMovieSceneBindingReference >	GetReferences (const FGuid &ObjectId) const

MOVIESCENE_API const FMovieSceneBindingReference *	GetReference (const FGuid &ObjectId, int32 BindingIndex) const

MOVIESCENE_API bool	HasBinding (const FGuid &ObjectId) const

MOVIESCENE_API UMovieSceneCustomBinding *	GetCustomBinding (const FGuid &ObjectId, int32 BindingIndex)

MOVIESCENE_API const UMovieSceneCustomBinding *	GetCustomBinding (const FGuid &ObjectId, int32 BindingIndex) const

MOVIESCENE_API void	RemoveBinding (const FGuid &ObjectId)

MOVIESCENE_API void	RemoveObjects (const FGuid &ObjectId, const TArray< UObject * > &InObjects, UObject *InContext)

MOVIESCENE_API void	RemoveInvalidObjects (const FGuid &ObjectId, UObject *InContext)

MOVIESCENE_API const FMovieSceneBindingReference *	AddBinding (const FGuid &ObjectId, FUniversalObjectLocator &&NewLocator)

const FMovieSceneBindingReference *	AddBinding (const FGuid &ObjectId, UMovieSceneCustomBinding *CustomBinding)

MOVIESCENE_API const FMovieSceneBindingReference *	AddBinding (const FGuid &ObjectId, FUniversalObjectLocator &&NewLocator, ELocatorResolveFlags InResolveFlags, UMovieSceneCustomBinding *CustomBinding=nullptr)

MOVIESCENE_API const FMovieSceneBindingReference *	AddOrReplaceBinding (const FGuid &ObjectId, UMovieSceneCustomBinding *NewCustomBinding, int32 BindingIndex)

MOVIESCENE_API const FMovieSceneBindingReference *	AddOrReplaceBinding (const FGuid &ObjectId, FUniversalObjectLocator &&NewLocator, int32 BindingIndex)

MOVIESCENE_API void	ResolveBinding (const FGuid &ObjectId, const UE::UniversalObjectLocator::FResolveParams &LocatorResolveParams, TArray< UObject *, TInlineAllocator< 1 > > &OutObjects) const

MOVIESCENE_API void	ResolveBinding (const FMovieSceneBindingResolveParams &BindingResolveParams, const UE::UniversalObjectLocator::FResolveParams &LocatorResolveParams, TSharedPtr< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState, TArray< UObject *, TInlineAllocator< 1 > > &OutObjects) const

MOVIESCENE_API void	ResolveSingleBinding (const FMovieSceneBindingResolveParams &BindingResolveParams, int32 BindingIndex, const UE::UniversalObjectLocator::FResolveParams &LocatorResolveParams, TSharedPtr< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState, TArray< UObject *, TInlineAllocator< 1 > > &OutObjects) const

MOVIESCENE_API UObject *	ResolveSingleBinding (const FMovieSceneBindingResolveParams &BindingResolveParams, int32 BindingIndex, const UE::UniversalObjectLocator::FResolveParams &LocatorResolveParams, TSharedPtr< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState) const

MOVIESCENE_API FGuid	FindBindingFromObject (UObject InObject, UObject InContext) const

MOVIESCENE_API void	RemoveInvalidBindings (const TSet< FGuid > &ValidBindingIDs)

void	UnloadBoundObject (const UE::UniversalObjectLocator::FResolveParams &ResolveParams, const FGuid &ObjectId, int32 BindingIndex)

Detailed Description

Structure that stores a one to many mapping from object binding ID, to object references that pertain to that ID.

Member Function Documentation

◆ AddBinding() [1/3]

const FMovieSceneBindingReference * FMovieSceneBindingReferences::AddBinding	(	const FGuid &	ObjectId,
		FUniversalObjectLocator &&	NewLocator
	)

Add a binding for the specified ID

Parameters

ObjectId	The ID to associate the object with
InContext	A context in which InObject resides (either a UWorld, or an AActor)

◆ AddBinding() [2/3]

const FMovieSceneBindingReference * FMovieSceneBindingReferences::AddBinding	(	const FGuid &	ObjectId,
		FUniversalObjectLocator &&	NewLocator,
		ELocatorResolveFlags	InResolveFlags,
		UMovieSceneCustomBinding *	CustomBinding = `nullptr`
	)

Add a binding for the specified ID

Parameters

ObjectId	The ID to associate the object with
InContext	A context in which InObject resides (either a UWorld, or an AActor)

◆ AddBinding() [3/3]

const FMovieSceneBindingReference * FMovieSceneBindingReferences::AddBinding	(	const FGuid &	ObjectId,
		UMovieSceneCustomBinding *	CustomBinding
	)

inline

Add a custom binding for the specified ID, no locator necessary.

Parameters

ObjectId	The ID to associate the object with
CustomBinding	A created custom binding for the object

◆ AddOrReplaceBinding() [1/2]

const FMovieSceneBindingReference * FMovieSceneBindingReferences::AddOrReplaceBinding	(	const FGuid &	ObjectId,
		FUniversalObjectLocator &&	NewLocator,
		int32	BindingIndex
	)

Replace the binding associated with the ObjectId at the given BindingIndex with a new possessable locator binding. If no such binding exists, then one will be created at the nearest new BindingIndex.

Parameters

ObjectId	The ID to associate the object with
NewLocator	A created locator for the object
BindingIndex	The binding index of the binding to replace.

◆ AddOrReplaceBinding() [2/2]

const FMovieSceneBindingReference * FMovieSceneBindingReferences::AddOrReplaceBinding	(	const FGuid &	ObjectId,
		UMovieSceneCustomBinding *	NewCustomBinding,
		int32	BindingIndex
	)

Replace the binding associated with the ObjectId at the given BindingIndex with a new custom binding. If no such binding exists, then one will be created at the nearest new BindingIndex.

Parameters

ObjectId	The ID to associate the object with
CustomBinding	A created custom binding for the object
BindingIndex	The binding index of the binding to replace.

◆ FindBindingFromObject()

FGuid FMovieSceneBindingReferences::FindBindingFromObject	(	UObject *	InObject,
		UObject *	InContext
	)		const

Resolve a binding for the specified ID using a given context

Parameters

ObjectId	The ID to associate the object with
InContext	A context in which InObject resides @oaram StreamedLevelAssetPath The path to the streamed level asset that contains the level sequence actor playing back the sequence. 'None' for any non-instance-level setups.
OutObjects	Array to populate with resolved object bindings

◆ GetAllReferences() [1/2]

TArrayView< FMovieSceneBindingReference > FMovieSceneBindingReferences::GetAllReferences ( )

◆ GetAllReferences() [2/2]

TArrayView< const FMovieSceneBindingReference > FMovieSceneBindingReferences::GetAllReferences ( ) const

◆ GetCustomBinding() [1/2]

UMovieSceneCustomBinding * FMovieSceneBindingReferences::GetCustomBinding	(	const FGuid &	ObjectId,
		int32	BindingIndex
	)

◆ GetCustomBinding() [2/2]

const UMovieSceneCustomBinding * FMovieSceneBindingReferences::GetCustomBinding	(	const FGuid &	ObjectId,
		int32	BindingIndex
	)		const

◆ GetReference()

const FMovieSceneBindingReference * FMovieSceneBindingReferences::GetReference	(	const FGuid &	ObjectId,
		int32	BindingIndex
	)		const

◆ GetReferences()

TArrayView< const FMovieSceneBindingReference > FMovieSceneBindingReferences::GetReferences ( const FGuid & ObjectId ) const

◆ HasBinding()

bool FMovieSceneBindingReferences::HasBinding ( const FGuid & ObjectId ) const

Check whether this map has a binding for the specified object id

Returns: true if this map contains a binding for the id, false otherwise

◆ RemoveBinding()

void FMovieSceneBindingReferences::RemoveBinding ( const FGuid & ObjectId )

Remove a binding for the specified ID

Parameters

ObjectId The ID to remove

◆ RemoveInvalidBindings()

void FMovieSceneBindingReferences::RemoveInvalidBindings ( const TSet< FGuid > & ValidBindingIDs )

Filter out any bindings that do not match the specified set of GUIDs

Parameters

ValidBindingIDs A set of GUIDs that are considered valid. Anything references not matching these will be removed.

◆ RemoveInvalidObjects()

void FMovieSceneBindingReferences::RemoveInvalidObjects	(	const FGuid &	ObjectId,
		UObject *	InContext
	)

Remove specific object references that do not resolve

Parameters

ObjectId	The ID to remove
InContext	A context in which InObject resides (either a UWorld, or an AActor)

◆ RemoveObjects()

void FMovieSceneBindingReferences::RemoveObjects	(	const FGuid &	ObjectId,
		const TArray< UObject * > &	InObjects,
		UObject *	InContext
	)

Remove specific object references

Parameters

ObjectId	The ID to remove
InObjects	The objects to remove
InContext	A context in which InObject resides (either a UWorld, or an AActor)

◆ ResolveBinding() [1/2]

void FMovieSceneBindingReferences::ResolveBinding	(	const FGuid &	ObjectId,
		const UE::UniversalObjectLocator::FResolveParams &	LocatorResolveParams,
		TArray< UObject *, TInlineAllocator< 1 > > &	OutObjects
	)		const

Resolve a binding for the specified ID using a given context. Calling this version will not resolve custom bindings/spawnables- to resolve those, please call the override with BindingResolveParams and SharedPlaybackState

Parameters

ObjectId	The ID to associate the object with
Params	Resolve parameters specifying the context and fragment-specific parameters
OutObjects	Array to populate with resolved object bindings

◆ ResolveBinding() [2/2]

void FMovieSceneBindingReferences::ResolveBinding	(	const FMovieSceneBindingResolveParams &	BindingResolveParams,
		const UE::UniversalObjectLocator::FResolveParams &	LocatorResolveParams,
		TSharedPtr< const UE::MovieScene::FSharedPlaybackState >	SharedPlaybackState,
		TArray< UObject *, TInlineAllocator< 1 > > &	OutObjects
	)		const

Resolve a binding for the specified ID using a given context

Parameters

ObjectId	The ID to associate the object with
BindingResolveParams	Resolve parameters
LocatorResolveParams	Locator-specific resolve parameters
SharedPlaybackState	Shared Playback State from the Sequencer
OutObjects	Array to populate with resolved object bindings

◆ ResolveSingleBinding() [1/2]

UObject * FMovieSceneBindingReferences::ResolveSingleBinding	(	const FMovieSceneBindingResolveParams &	BindingResolveParams,
		int32	BindingIndex,
		const UE::UniversalObjectLocator::FResolveParams &	LocatorResolveParams,
		TSharedPtr< const UE::MovieScene::FSharedPlaybackState >	SharedPlaybackState
	)		const

◆ ResolveSingleBinding() [2/2]

void FMovieSceneBindingReferences::ResolveSingleBinding	(	const FMovieSceneBindingResolveParams &	BindingResolveParams,
		int32	BindingIndex,
		const UE::UniversalObjectLocator::FResolveParams &	LocatorResolveParams,
		TSharedPtr< const UE::MovieScene::FSharedPlaybackState >	SharedPlaybackState,
		TArray< UObject *, TInlineAllocator< 1 > > &	OutObjects
	)		const

Resolve a binding for the specified ID and BindingIndex using a given context

Parameters

ObjectId	The ID to associate the object with
BindingResolveParams	Resolve parameters
LocatorResolveParams	Locator-specific resolve parameters
SharedPlaybackState	Shared Playback State from the Sequencer
OutObjects	Array to populate with resolved objectss

◆ UnloadBoundObject()

void FMovieSceneBindingReferences::UnloadBoundObject	(	const UE::UniversalObjectLocator::FResolveParams &	ResolveParams,
		const FGuid &	ObjectId,
		int32	BindingIndex
	)

inline

Unloads an object that has been loaded via a locator.

Parameters

ObjectId	The ID of the binding to unload
BindingIndex	The index of the binding to unload

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

Engine/Source/Runtime/MovieScene/Public/MovieSceneBindingReferences.h
Engine/Source/Runtime/MovieScene/Private/MovieSceneBindingReferences.cpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddBinding() [1/3]

◆ AddBinding() [2/3]

◆ AddBinding() [3/3]

◆ AddOrReplaceBinding() [1/2]

◆ AddOrReplaceBinding() [2/2]

◆ FindBindingFromObject()

◆ GetAllReferences() [1/2]

◆ GetAllReferences() [2/2]

◆ GetCustomBinding() [1/2]

◆ GetCustomBinding() [2/2]

◆ GetReference()

◆ GetReferences()

◆ HasBinding()

◆ RemoveBinding()

◆ RemoveInvalidBindings()

◆ RemoveInvalidObjects()

◆ RemoveObjects()

◆ ResolveBinding() [1/2]

◆ ResolveBinding() [2/2]

◆ ResolveSingleBinding() [1/2]

◆ ResolveSingleBinding() [2/2]

◆ UnloadBoundObject()