UE::MovieScene::FFixedObjectBindingID Struct Reference

#include <MovieSceneObjectBindingID.h>

Public Member Functions
	FFixedObjectBindingID ()
	FFixedObjectBindingID (const FGuid &InGuid, FMovieSceneSequenceID InSequenceID)
MOVIESCENE_API FRelativeObjectBindingID	ConvertToRelative (FMovieSceneSequenceID SourceSequenceID, TSharedRef< const FSharedPlaybackState > SharedPlaybackState) const
MOVIESCENE_API FRelativeObjectBindingID	ConvertToRelative (FMovieSceneSequenceID SourceSequenceID, IMovieScenePlayer &InPlayer) const
MOVIESCENE_API FRelativeObjectBindingID	ConvertToRelative (FMovieSceneSequenceID SourceSequenceID, const FMovieSceneSequenceHierarchy *Hierarchy) const

Public Attributes
FGuid	Guid
FMovieSceneSequenceID	SequenceID

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

Detailed Description

A binding ID that is only resolveable through a fixed root sequence. Use of this type should be reserved for editor code dealing with a specific sequence hierarchy where hashing or comparison is required. The SequenceID member is always an absolute sequence ID

Constructor & Destructor Documentation

FFixedObjectBindingID() [1/2]

UE::MovieScene::FFixedObjectBindingID::FFixedObjectBindingID ( )

inline

FFixedObjectBindingID() [2/2]

UE::MovieScene::FFixedObjectBindingID::FFixedObjectBindingID ( const FGuid &  InGuid, FMovieSceneSequenceID  InSequenceID  )

inline

Member Function Documentation

ConvertToRelative() [1/3]

FRelativeObjectBindingID UE::MovieScene::FFixedObjectBindingID::ConvertToRelative	(	FMovieSceneSequenceID	SourceSequenceID,
		const FMovieSceneSequenceHierarchy *	Hierarchy
	)		const

Convert this fixed binding ID to one that is resolved relative to the specified Sequence.

Parameters

SourceSequenceID	The sequence ID to make this fixed ID relative to
Hierarchy	The hierarchy that represents the root sequence that SourceSequenceID is contained within

Returns

A new binding ID that will resolve relative to the specified sequence

ConvertToRelative() [2/3]

FRelativeObjectBindingID UE::MovieScene::FFixedObjectBindingID::ConvertToRelative	(	FMovieSceneSequenceID	SourceSequenceID,
		IMovieScenePlayer &	InPlayer
	)		const

ConvertToRelative() [3/3]

FRelativeObjectBindingID UE::MovieScene::FFixedObjectBindingID::ConvertToRelative	(	FMovieSceneSequenceID	SourceSequenceID,
		TSharedRef< const FSharedPlaybackState >	SharedPlaybackState
	)		const

Convert this fixed binding ID to one that is resolved relative to the specified Sequence.

Parameters

SourceSequenceID	The sequence ID to make this fixed ID relative to
InPlayer	The active movie scene player to retrieve a root sequence hierarchy from

Returns

A new binding ID that will resolve relative to the specified sequence

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FFixedObjectBindingID &  A )

friend

operator!=

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

friend

operator==

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

friend

Member Data Documentation

Guid

FGuid UE::MovieScene::FFixedObjectBindingID::Guid

GUID of the Object Binding (ie, FMovieSceneBinding::GetObjectGuid)

SequenceID

FMovieSceneSequenceID UE::MovieScene::FFixedObjectBindingID::SequenceID

The sequence ID that the object binding is found within

---

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