Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > MovieScene > FMovieSceneObjectBindingID

Light Theme

Dark Theme

FMovieSceneObjectBindingID

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

Windows

MacOS

Linux

References

Module	MovieScene
Header	/Engine/Source/Runtime/MovieScene/Public/MovieSceneObjectBindingID.h
Include	#include "MovieSceneObjectBindingID.h"

Syntax

struct FMovieSceneObjectBindingID

Remarks

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 master 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 master sequence.

Constructors

	Name	Description
	FMovieSceneObjectBindingID()	Default construction to a root empty.
	FMovieSceneObjectBindingID ( const UE::MovieScene::FRelativeObje... )	Construction from an external object binding ID
	FMovieSceneObjectBindingID ( const UE::MovieScene::FFixedObjectB... )	Construction from a fixed object binding ID

Functions

	Name	Description
const FGuid ...	GetGuid()	Access the guid that identifies the object binding within the sequence
FMovieSceneS...	GetRelativeSequenceID()	Get the relative sequence ID for this binding.
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
bool	IsValid()	Check whether this object binding ID has been set to something valied @note does not imply that the ID resolves to a valid object
void	PostSerialize ( const FArchive& Ar )
UE::MovieSce...	ReinterpretAsFixed()	Reinterpret this binding ID as a fixed binding.
TArrayView< ...	ResolveBoundObjects ( const UE::MovieScene::FSequenceInst... )	Resolve all the bound objects for this binding ID
TArrayView< ...	ResolveBoundObjects ( FMovieSceneSequenceID SourceSequenc..., IMovieScenePlayer& Player )	Resolve all the bound objects for this binding ID
FMovieSceneS...	ResolveSequenceID ( FMovieSceneSequenceID SourceSequenc..., IMovieScenePlayer& Player )	Resolve the sequence ID for this binding for the root master sequence
FMovieSceneS...	ResolveSequenceID ( FMovieSceneSequenceID SourceSequenc..., const FMovieSceneSequenceHierarchy ... )	Resolve the sequence ID for this binding for the root master sequence
UE::MovieSce...	ResolveToFixed ( FMovieSceneSequenceID SourceSequenc..., IMovieScenePlayer& Player )	Resolve this binding ID to a fixed object binding ID resolvable from the root master sequence
void	SetGuid ( const FGuid& InGuid )	Set the guid that identifies the object binding within the sequence

Operators

		Name	Description
	FMovieSceneO...	operator= ( const UE::MovieScene::FRelativeObje... )	Assignment from an external object binding ID
	FMovieSceneO...	operator= ( const UE::MovieScene::FFixedObjectB... )	Assignment from a fixed object binding ID

Constants

Name	Description
FixedRootSequenceParentIndex

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

Take our survey

Dismiss