FMovieSceneObjectBindingID | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/MovieScene

Persistent identifier to a specific object binding within a sequence hierarchy.

Binding IDs come in 3 flavors with Local and External being preferred as they are reslilient towards sequences being authored in isolation or included in other root sequences: Local: (ResolveParentIndex == 0) SequenceID relates to this sequence's local hierarchy; represents an object binding within the same sequence as the ID is resolved, or inside one of its sub-sequences. Sequence ID must be remapped at runtime. External: (ResolveParentIndex > 0) SequenceID is local to the parent sequence of this one denoted by the parent index (ie, 1 = parent, 2 = grandparent etc). Sequence ID must be remapped at runtime. Fixed: Represents a binding anywhere in the sequence; always resolved from the root sequence.

Fixed bindings will break if the sequence is evaluated inside a different root sequence.


Name	FMovieSceneObjectBindingID
Type	struct
Header File	/Engine/Source/Runtime/MovieScene/Public/MovieSceneObjectBindingID.h
Include Path	#include "MovieSceneObjectBindingID.h"

Syntax

USTRUCT (BlueprintType , Meta=(HasNativeMake))  
struct FMovieSceneObjectBindingID

Constructors

Name	Remarks	Include Path
FMovieSceneObjectBindingID ( const UE::MovieScene::FFixedObjectBindingID& InID )	Construction from a fixed object binding ID	MovieSceneObjectBindingID.h
FMovieSceneObjectBindingID ( const UE::MovieScene::FRelativeObjectBindingID& InID )	Construction from an external object binding ID	MovieSceneObjectBindingID.h
FMovieSceneObjectBindingID ()	Default construction to a root empty.	MovieSceneObjectBindingID.h

Typedefs

Name	Type	Remarks	Include Path
FSharedPlaybackState	UE::MovieScene::FSharedPlaybackState		MovieSceneObjectBindingID.h

Constants

Name	Type	Remarks	Include Path
FixedRootSequenceParentIndex	int32		MovieSceneObjectBindingID.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
Guid	FGuid	Identifier for the object binding within the sequence	MovieSceneObjectBindingID.h	EditAnywhere Category="Binding"
ResolveParentIndex	int32	The parent index to resolve the sequence ID from.	MovieSceneObjectBindingID.h
SequenceID	int32	Sequence ID stored as an int32 so that it can be used in the blueprint VM	MovieSceneObjectBindingID.h

Functions

Public

Name	Remarks	Include Path
const FGuid & GetGuid()	Access the guid that identifies the object binding within the sequence	MovieSceneObjectBindingID.h
FMovieSceneSequenceID GetRelativeSequenceID ()	Get the relative sequence ID for this binding.	MovieSceneObjectBindingID.h
bool IsFixedBinding()	Check whether this binding is fixed to the root sequence - these bindings should be avoided or fixed up where possible to ensure portability	MovieSceneObjectBindingID.h
bool IsValid ()	Check whether this object binding ID has been set to something valied	MovieSceneObjectBindingID.h
void PostSerialize ( const FArchive& Ar )		MovieSceneObjectBindingID.h
UE::MovieScene::FFixedObjectBindingID ReinterpretAsFixed ()	Reinterpret this binding ID as a fixed binding.	MovieSceneObjectBindingID.h
TArrayView< TWeakObjectPtr<> > ResolveBoundObjects ( const UE::MovieScene::FSequenceInstance& SequenceInstance ) const	Resolve all the bound objects for this binding ID	MovieSceneObjectBindingID.h
TArrayView< TWeakObjectPtr<> > ResolveBoundObjects ( FMovieSceneSequenceID SourceSequenceID, TSharedRef< const FSharedPlaybackState > SharedPlaybackState ) const	Resolve all the bound objects for this binding ID	MovieSceneObjectBindingID.h
TArrayView< TWeakObjectPtr<> > ResolveBoundObjects ( FMovieSceneSequenceID SourceSequenceID, IMovieScenePlayer& Player ) const		MovieSceneObjectBindingID.h
FMovieSceneSequenceID ResolveSequenceID ( FMovieSceneSequenceID SourceSequenceID, TSharedRef< const FSharedPlaybackState > SharedPlaybackState ) const	Resolve the sequence ID for this binding for the root sequence	MovieSceneObjectBindingID.h
FMovieSceneSequenceID ResolveSequenceID ( FMovieSceneSequenceID SourceSequenceID, IMovieScenePlayer& Player ) const		MovieSceneObjectBindingID.h
FMovieSceneSequenceID ResolveSequenceID ( FMovieSceneSequenceID SourceSequenceID, const FMovieSceneSequenceHierarchy* Hierarchy ) const	Resolve the sequence ID for this binding for the root sequence	MovieSceneObjectBindingID.h
UE::MovieScene::FFixedObjectBindingID ResolveToFixed ( FMovieSceneSequenceID SourceSequenceID, TSharedRef< const FSharedPlaybackState > SharedPlaybackState ) const	Resolve this binding ID to a fixed object binding ID resolvable from the root sequence	MovieSceneObjectBindingID.h
UE::MovieScene::FFixedObjectBindingID ResolveToFixed ( FMovieSceneSequenceID SourceSequenceID, IMovieScenePlayer& Player ) const		MovieSceneObjectBindingID.h
void SetGuid ( const FGuid& InGuid )	Set the guid that identifies the object binding within the sequence	MovieSceneObjectBindingID.h

Operators

Name	Remarks	Include Path	Unreal Specifiers
FMovieSceneObjectBindingID & operator= ( const UE::MovieScene::FRelativeObjectBindingID& InID )	Assignment from an external object binding ID	MovieSceneObjectBindingID.h
FMovieSceneObjectBindingID & operator= ( const UE::MovieScene::FFixedObjectBindingID& InID )	Assignment from a fixed object binding ID	MovieSceneObjectBindingID.h

Navigation