FMovieSceneObjectBindingID Struct Reference

#include <MovieSceneObjectBindingID.h>

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

Public Member Functions
	FMovieSceneObjectBindingID ()
	FMovieSceneObjectBindingID (const UE::MovieScene::FRelativeObjectBindingID &InID)
	FMovieSceneObjectBindingID (const UE::MovieScene::FFixedObjectBindingID &InID)
FMovieSceneObjectBindingID &	operator= (const UE::MovieScene::FRelativeObjectBindingID &InID)
FMovieSceneObjectBindingID &	operator= (const UE::MovieScene::FFixedObjectBindingID &InID)
bool	IsValid () const
bool	IsFixedBinding () const
const FGuid &	GetGuid () const
void	SetGuid (const FGuid &InGuid)
FMovieSceneSequenceID	GetRelativeSequenceID () const
MOVIESCENE_API UE::MovieScene::FFixedObjectBindingID	ResolveToFixed (FMovieSceneSequenceID SourceSequenceID, TSharedRef< const FSharedPlaybackState > SharedPlaybackState) const
MOVIESCENE_API UE::MovieScene::FFixedObjectBindingID	ResolveToFixed (FMovieSceneSequenceID SourceSequenceID, IMovieScenePlayer &Player) const
MOVIESCENE_API FMovieSceneSequenceID	ResolveSequenceID (FMovieSceneSequenceID SourceSequenceID, TSharedRef< const FSharedPlaybackState > SharedPlaybackState) const
MOVIESCENE_API FMovieSceneSequenceID	ResolveSequenceID (FMovieSceneSequenceID SourceSequenceID, IMovieScenePlayer &Player) const
MOVIESCENE_API FMovieSceneSequenceID	ResolveSequenceID (FMovieSceneSequenceID SourceSequenceID, const FMovieSceneSequenceHierarchy *Hierarchy) const
MOVIESCENE_API TArrayView< TWeakObjectPtr<> >	ResolveBoundObjects (FMovieSceneSequenceID SourceSequenceID, TSharedRef< const FSharedPlaybackState > SharedPlaybackState) const
MOVIESCENE_API TArrayView< TWeakObjectPtr<> >	ResolveBoundObjects (FMovieSceneSequenceID SourceSequenceID, IMovieScenePlayer &Player) const
MOVIESCENE_API TArrayView< TWeakObjectPtr<> >	ResolveBoundObjects (const UE::MovieScene::FSequenceInstance &SequenceInstance) const
UE::MovieScene::FFixedObjectBindingID	ReinterpretAsFixed () const

Friends
uint32	GetTypeHash (const FMovieSceneObjectBindingID &A)
bool	operator== (const FMovieSceneObjectBindingID &A, const FMovieSceneObjectBindingID &B)
bool	operator!= (const FMovieSceneObjectBindingID &A, const FMovieSceneObjectBindingID &B)

Detailed Description

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.

Member Typedef Documentation

FSharedPlaybackState

using FMovieSceneObjectBindingID::FSharedPlaybackState = UE::MovieScene::FSharedPlaybackState

Constructor & Destructor Documentation

FMovieSceneObjectBindingID() [1/3]

FMovieSceneObjectBindingID::FMovieSceneObjectBindingID ( )

inline

Default construction to a root empty. Only to be used for UObject serialization and default UObject construction

FMovieSceneObjectBindingID() [2/3]

FMovieSceneObjectBindingID::FMovieSceneObjectBindingID ( const UE::MovieScene::FRelativeObjectBindingID &  InID )

inline

Construction from an external object binding ID

FMovieSceneObjectBindingID() [3/3]

FMovieSceneObjectBindingID::FMovieSceneObjectBindingID ( const UE::MovieScene::FFixedObjectBindingID &  InID )

inline

Construction from a fixed object binding ID

Member Function Documentation

GetGuid()

const FGuid & FMovieSceneObjectBindingID::GetGuid ( ) const

inline

Access the guid that identifies the object binding within the sequence

GetRelativeSequenceID()

FMovieSceneSequenceID FMovieSceneObjectBindingID::GetRelativeSequenceID ( ) const

inline

Get the relative sequence ID for this binding.

Note

: The meaning of this sequence ID is dependent upon ResolveParentIndex so should only be used where the context is known

IsFixedBinding()

bool FMovieSceneObjectBindingID::IsFixedBinding ( ) const

inline

Check whether this binding is fixed to the root sequence - these bindings should be avoided or fixed up where possible to ensure portability

IsValid()

bool FMovieSceneObjectBindingID::IsValid ( ) const

inline

Check whether this object binding ID has been set to something valied

Note

: does not imply that the ID resolves to a valid object

operator=() [1/2]

FMovieSceneObjectBindingID & FMovieSceneObjectBindingID::operator= ( const UE::MovieScene::FFixedObjectBindingID &  InID )

inline

Assignment from a fixed object binding ID

operator=() [2/2]

FMovieSceneObjectBindingID & FMovieSceneObjectBindingID::operator= ( const UE::MovieScene::FRelativeObjectBindingID &  InID )

inline

Assignment from an external object binding ID

ReinterpretAsFixed()

UE::MovieScene::FFixedObjectBindingID FMovieSceneObjectBindingID::ReinterpretAsFixed ( ) const

inline

Reinterpret this binding ID as a fixed binding. Should only be used when ResolveParentIndex == -1, although this is not enforced.

ResolveBoundObjects() [1/3]

TArrayView< TWeakObjectPtr<> > FMovieSceneObjectBindingID::ResolveBoundObjects

(

const UE::MovieScene::FSequenceInstance &

SequenceInstance

)

const

Resolve all the bound objects for this binding ID

Parameters

SequenceInstance

The sequence instance for the sub sequence that is resolving the binding

Returns

An array view of all bound objects

ResolveBoundObjects() [2/3]

TArrayView< TWeakObjectPtr<> > FMovieSceneObjectBindingID::ResolveBoundObjects	(	FMovieSceneSequenceID	SourceSequenceID,
		IMovieScenePlayer &	Player
	)		const

ResolveBoundObjects() [3/3]

TArrayView< TWeakObjectPtr<> > FMovieSceneObjectBindingID::ResolveBoundObjects	(	FMovieSceneSequenceID	SourceSequenceID,
		TSharedRef< const FSharedPlaybackState >	SharedPlaybackState
	)		const

Resolve all the bound objects for this binding ID

Parameters

SourceSequenceID	The source sequence ID that owns this binding ID
Hierarchy	The hierachy to use for computation of the relative path. Many be nullptr where Source and Targets are both MovieSceneSequenceID::Root

Returns

An array view of all bound objects

ResolveSequenceID() [1/3]

FMovieSceneSequenceID FMovieSceneObjectBindingID::ResolveSequenceID	(	FMovieSceneSequenceID	SourceSequenceID,
		const FMovieSceneSequenceHierarchy *	Hierarchy
	)		const

Resolve the sequence ID for this binding for the root sequence

Parameters

SourceSequenceID	The source sequence ID that owns this binding ID
Hierarchy	The hierachy to use for computation of the relative path. Many be nullptr where Source and Targets are both MovieSceneSequenceID::Root

Returns

The sequence ID that holds the target object

ResolveSequenceID() [2/3]

FMovieSceneSequenceID FMovieSceneObjectBindingID::ResolveSequenceID	(	FMovieSceneSequenceID	SourceSequenceID,
		IMovieScenePlayer &	Player
	)		const

ResolveSequenceID() [3/3]

FMovieSceneSequenceID FMovieSceneObjectBindingID::ResolveSequenceID	(	FMovieSceneSequenceID	SourceSequenceID,
		TSharedRef< const FSharedPlaybackState >	SharedPlaybackState
	)		const

Resolve the sequence ID for this binding for the root sequence

Parameters

SourceSequenceID	The source sequence ID that owns this binding ID
Player	The movie scene player that is currently playing the sequence

Returns

The sequence ID that holds the target object

ResolveToFixed() [1/2]

UE::MovieScene::FFixedObjectBindingID FMovieSceneObjectBindingID::ResolveToFixed	(	FMovieSceneSequenceID	SourceSequenceID,
		IMovieScenePlayer &	Player
	)		const

ResolveToFixed() [2/2]

UE::MovieScene::FFixedObjectBindingID FMovieSceneObjectBindingID::ResolveToFixed	(	FMovieSceneSequenceID	SourceSequenceID,
		TSharedRef< const FSharedPlaybackState >	SharedPlaybackState
	)		const

Resolve this binding ID to a fixed object binding ID resolvable from the root sequence

Parameters

SourceSequenceID	The source sequence ID that owns this binding ID
Player	The movie scene player that is currently playing the root sequence

Returns

A fixed binding ID whose SequenceID relates to the root sequence hierarchy

SetGuid()

void FMovieSceneObjectBindingID::SetGuid ( const FGuid &  InGuid )

inline

Set the guid that identifies the object binding within the sequence

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FMovieSceneObjectBindingID &  A )

friend

operator!=

bool operator!= ( const FMovieSceneObjectBindingID &  A, const FMovieSceneObjectBindingID &  B  )

friend

operator==

bool operator== ( const FMovieSceneObjectBindingID &  A, const FMovieSceneObjectBindingID &  B  )

friend

---

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

• Engine/Source/Runtime/MovieScene/Public/MovieSceneObjectBindingID.h
• Engine/Source/Runtime/MovieScene/Private/MovieSceneObjectBindingID.cpp