UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMovieSceneBinding Struct Reference

#include <MovieSceneBinding.h>

+ Inheritance diagram for FMovieSceneBinding:

Public Member Functions

 FMovieSceneBinding ()
 
void SetObjectGuid (const FGuid &InObjectGuid)
 
const FGuidGetObjectGuid () const
 
void SetName (const FString &InBindingName)
 
const FString & GetName () const
 
MOVIESCENE_API void AddTrack (UMovieSceneTrack &NewTrack, UMovieScene *Owner)
 
MOVIESCENE_API bool RemoveTrack (UMovieSceneTrack &Track, UMovieScene *Owner)
 
MOVIESCENE_API void RemoveNullTracks ()
 
const TArray< UMovieSceneTrack * > & GetTracks () const
 
MOVIESCENE_API TArray< UMovieSceneTrack * > StealTracks (UMovieScene *Owner)
 
MOVIESCENE_API void SetTracks (TArray< UMovieSceneTrack * > &&InTracks, UMovieScene *Owner)
 
bool operator< (const FMovieSceneBinding &RHS) const
 
bool operator< (const FGuid &InGuid) const
 
- Public Member Functions inherited from FMovieSceneDecorationContainer
MOVIESCENE_API UObjectFindDecoration (const TSubclassOf< UObject > &InClass) const
 
MOVIESCENE_API void AddDecoration (UObject *InDecoration, UObject *Outer, TFunctionRef< void(UObject *)> Event)
 
MOVIESCENE_API UObjectGetOrCreateDecoration (const TSubclassOf< UObject > &InClass, UObject *Outer, TFunctionRef< void(UObject *)> Event)
 
MOVIESCENE_API void RemoveDecoration (const TSubclassOf< UObject > &InClass, TFunctionRef< void(UObject *)> Event)
 
MOVIESCENE_API TArrayView< const TObjectPtr< UObject > > GetDecorations () const
 
template<typename DecorationType >
DecorationTypeFindDecoration () const
 
template<typename DecorationType >
DecorationTypeGetOrCreateDecoration (UObject *Outer, TFunctionRef< void(UObject *)> Event)
 
template<typename DecorationType >
void RemoveDecoration ()
 
void RemoveNulls ()
 

Friends

class UMovieScene
 
bool operator< (const FGuid &InGuid, const FMovieSceneBinding &RHS)
 

Additional Inherited Members

- Protected Attributes inherited from FMovieSceneDecorationContainer
TArray< TObjectPtr< UObject > > Decorations
 

Detailed Description

A set of tracks bound to runtime objects

Constructor & Destructor Documentation

◆ FMovieSceneBinding()

FMovieSceneBinding::FMovieSceneBinding ( )
inline

Default constructor.

Member Function Documentation

◆ AddTrack()

void FMovieSceneBinding::AddTrack ( UMovieSceneTrack NewTrack,
UMovieScene Owner 
)

Adds a new track to this binding

Parameters
NewTrackThe track to add

◆ GetName()

const FString & FMovieSceneBinding::GetName ( ) const
inline

◆ GetObjectGuid()

const FGuid & FMovieSceneBinding::GetObjectGuid ( ) const
inline
Returns
The guid of runtime objects in this binding

◆ GetTracks()

const TArray< UMovieSceneTrack * > & FMovieSceneBinding::GetTracks ( ) const
inline
Returns
All tracks in this binding

◆ operator<() [1/2]

bool FMovieSceneBinding::operator< ( const FGuid InGuid) const
inline

◆ operator<() [2/2]

bool FMovieSceneBinding::operator< ( const FMovieSceneBinding RHS) const
inline

◆ RemoveNullTracks()

void FMovieSceneBinding::RemoveNullTracks ( )

Removes all null tracks from this binding

◆ RemoveTrack()

bool FMovieSceneBinding::RemoveTrack ( UMovieSceneTrack Track,
UMovieScene Owner 
)

Removes a track from this binding

Parameters
TrackThe track to remove
Returns
true if the track was successfully removed, false if the track could not be found

◆ SetName()

void FMovieSceneBinding::SetName ( const FString &  InBindingName)
inline

◆ SetObjectGuid()

void FMovieSceneBinding::SetObjectGuid ( const FGuid InObjectGuid)
inline

◆ SetTracks()

void FMovieSceneBinding::SetTracks ( TArray< UMovieSceneTrack * > &&  InTracks,
UMovieScene Owner 
)

Assign all tracks in this binding

◆ StealTracks()

TArray< UMovieSceneTrack * > FMovieSceneBinding::StealTracks ( UMovieScene Owner)

Reset all tracks in this binding, returning the previous array of tracks

Friends And Related Symbol Documentation

◆ operator<

bool operator< ( const FGuid InGuid,
const FMovieSceneBinding RHS 
)
friend

◆ UMovieScene

friend class UMovieScene
friend

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