Navigation
API > API/Runtime > API/Runtime/MovieScene
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 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.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Default construction to a root empty. | ||
 |
FMovieSceneObjectBindingID
(
const UE::MovieScene::FRelativeObjectBindingID& InID |
Construction from an external object binding ID | |
 |
FMovieSceneObjectBindingID
(
const UE::MovieScene::FFixedObjectBindingID& InID |
Construction from a fixed object binding ID |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
const FGuid & | GetGuid () |
Access the guid that identifies the object binding within the sequence |
  |
FMovieSceneSequenceID | Get the relative sequence ID for this binding. | |
  |
bool | 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 |
 |
void | PostSerialize
(
const FArchive& Ar |
|
  |
UE::MovieScene::FFixedObjectBindingID | Reinterpret this binding ID as a fixed binding. | |
  |
TArrayView< TWeakObjectPtr<> > | ResolveBoundObjects
(
const UE::MovieScene::FSequenceInstance& SequenceInstance |
Resolve all the bound objects for this binding ID |
  |
TArrayView< TWeakObjectPtr<> > | ResolveBoundObjects
(
FMovieSceneSequenceID SourceSequenceID, |
Resolve all the bound objects for this binding ID |
  |
FMovieSceneSequenceID | ResolveSequenceID
(
FMovieSceneSequenceID SourceSequenceID, |
Resolve the sequence ID for this binding for the root sequence |
  |
FMovieSceneSequenceID | ResolveSequenceID
(
FMovieSceneSequenceID SourceSequenceID, |
Resolve the sequence ID for this binding for the root sequence |
  |
UE::MovieScene::FFixedObjectBindingID | ResolveToFixed
(
FMovieSceneSequenceID SourceSequenceID, |
Resolve this binding ID to a fixed object binding ID resolvable from the root sequence |
 |
void | Set the guid that identifies the object binding within the sequence |
Operators
| Type | Name | Description | |
|---|---|---|---|
 |
FMovieSceneObjectBindingID & | operator=
(
const UE::MovieScene::FRelativeObjectBindingID& InID |
Assignment from an external object binding ID |
 |
FMovieSceneObjectBindingID & | operator=
(
const UE::MovieScene::FFixedObjectBindingID& InID |
Assignment from a fixed object binding ID |
Constants
| Name | Description |
|---|---|
| FixedRootSequenceParentIndex |