UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::MovieScene::FRelativeObjectBindingID Struct Reference

#include <MovieSceneObjectBindingID.h>

Public Member Functions

 FRelativeObjectBindingID (const FGuid &InGuid)
 
 FRelativeObjectBindingID (const FGuid &InGuid, FMovieSceneSequenceID InSequenceID)
 
 FRelativeObjectBindingID (const FGuid &InGuid, FMovieSceneSequenceID InSequenceID, int32 InParentIndex)
 
MOVIESCENE_API FRelativeObjectBindingID (FMovieSceneSequenceID SourceSequenceID, FMovieSceneSequenceID TargetSequenceID, const FGuid &TargetGuid, UMovieSceneSequence *RootSequence)
 
MOVIESCENE_API FRelativeObjectBindingID (FMovieSceneSequenceID SourceSequenceID, FMovieSceneSequenceID TargetSequenceID, const FGuid &TargetGuid, const FMovieSceneSequenceHierarchy *Hierarchy)
 
MOVIESCENE_API FRelativeObjectBindingID (FMovieSceneSequenceID SourceSequenceID, FMovieSceneSequenceID TargetSequenceID, const FGuid &TargetGuid, TSharedRef< const FSharedPlaybackState > SharedPlaybackState)
 
MOVIESCENE_API FRelativeObjectBindingID (FMovieSceneSequenceID SourceSequenceID, FMovieSceneSequenceID TargetSequenceID, const FGuid &TargetGuid, IMovieScenePlayer &Player)
 

Public Attributes

FGuid Guid
 
FMovieSceneSequenceID SequenceID
 
int32 ResolveParentIndex
 

Detailed Description

A binding ID whose target is resolved relative to the owner of this ID (either internal or external to that sequence through a parent or grandparent) Should be used for asignment to any serialized FMovieSceneObjectBindingID Represented by a local object binding ID and a parent index to which it is relative

Constructor & Destructor Documentation

◆ FRelativeObjectBindingID() [1/7]

UE::MovieScene::FRelativeObjectBindingID::FRelativeObjectBindingID ( const FGuid InGuid)
inline

◆ FRelativeObjectBindingID() [2/7]

UE::MovieScene::FRelativeObjectBindingID::FRelativeObjectBindingID ( const FGuid InGuid,
FMovieSceneSequenceID  InSequenceID 
)
inline

◆ FRelativeObjectBindingID() [3/7]

UE::MovieScene::FRelativeObjectBindingID::FRelativeObjectBindingID ( const FGuid InGuid,
FMovieSceneSequenceID  InSequenceID,
int32  InParentIndex 
)
inline

◆ FRelativeObjectBindingID() [4/7]

UE::MovieScene::FRelativeObjectBindingID::FRelativeObjectBindingID ( FMovieSceneSequenceID  SourceSequenceID,
FMovieSceneSequenceID  TargetSequenceID,
const FGuid TargetGuid,
UMovieSceneSequence RootSequence 
)

Construction from a root sequence asset

Parameters
SourceSequenceIDAbsolute sequence ID within RootSequence that represents the start of the path (ie, the sequence that this binding ID is serialized within)
TargetSequenceIDAbsolute sequence ID within RootSequence that holds the target object
TargetGuidThe GUID of the object binding within TargetSequenceID that represents the object at runtime
RootSequenceThe root sequence asset

◆ FRelativeObjectBindingID() [5/7]

UE::MovieScene::FRelativeObjectBindingID::FRelativeObjectBindingID ( FMovieSceneSequenceID  SourceSequenceID,
FMovieSceneSequenceID  TargetSequenceID,
const FGuid TargetGuid,
const FMovieSceneSequenceHierarchy Hierarchy 
)

Construction from a root sequence Hierarchy

Parameters
SourceSequenceIDAbsolute sequence ID within Hierarchy that represents the start of the path (ie, the sequence that this binding ID is serialized within)
TargetSequenceIDAbsolute sequence ID within Hierarchy that holds the target object
TargetGuidThe GUID of the object binding within TargetSequenceID that represents the object at runtime
HierarchyThe hierachy to use for computation of the relative path. Many be nullptr where Source and Targets are both MovieSceneSequenceID::Root

◆ FRelativeObjectBindingID() [6/7]

UE::MovieScene::FRelativeObjectBindingID::FRelativeObjectBindingID ( FMovieSceneSequenceID  SourceSequenceID,
FMovieSceneSequenceID  TargetSequenceID,
const FGuid TargetGuid,
TSharedRef< const FSharedPlaybackState SharedPlaybackState 
)

Construction from a root sequence Player

Parameters
SourceSequenceIDAbsolute sequence ID within Player's root sequence hierarchy that represents the start of the path (ie, the sequence that this binding ID is serialized within)
TargetSequenceIDAbsolute sequence ID within Player's root sequence hierarchy that holds the target object
TargetGuidThe GUID of the object binding within TargetSequenceID that represents the object at runtime
PlayerThe movie scene player that is currently playing the root sequence

◆ FRelativeObjectBindingID() [7/7]

UE::MovieScene::FRelativeObjectBindingID::FRelativeObjectBindingID ( FMovieSceneSequenceID  SourceSequenceID,
FMovieSceneSequenceID  TargetSequenceID,
const FGuid TargetGuid,
IMovieScenePlayer Player 
)

Member Data Documentation

◆ Guid

FGuid UE::MovieScene::FRelativeObjectBindingID::Guid

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

◆ ResolveParentIndex

int32 UE::MovieScene::FRelativeObjectBindingID::ResolveParentIndex

The parent index denoting where to resolve this binding from

◆ SequenceID

FMovieSceneSequenceID UE::MovieScene::FRelativeObjectBindingID::SequenceID

The sequence ID that the object binding is found within - relative to nth parent specified by ResolveParentIndex


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