UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FTrackInstancePropertyBindings Class Reference

#include <TrackInstancePropertyBindings.h>

Public Member Functions

MOVIESCENE_API FTrackInstancePropertyBindings (FName InPropertyName, const FString &InPropertyPath)
 
template<typename ValueType >
void CallFunction (UObject &InRuntimeObject, typename TCallTraits< ValueType >::ParamType PropertyValue)
 
MOVIESCENE_API void CallFunctionForEnum (UObject &InRuntimeObject, int64 PropertyValue)
 
MOVIESCENE_API void CacheBinding (const UObject &InRuntimeObject)
 
MOVIESCENE_API FPropertyGetProperty (const UObject &Object)
 
MOVIESCENE_API bool HasValidBinding (const UObject &Object)
 
MOVIESCENE_API const UStructGetPropertyStruct (const UObject &Object)
 
template<typename ValueType >
ValueType GetCurrentValue (const UObject &Object)
 
template<typename ValueType >
TOptional< ValueType > GetOptionalValue (const UObject &Object)
 
MOVIESCENE_API int64 GetCurrentValueForEnum (const UObject &Object)
 
template<typename ValueType >
void SetCurrentValue (UObject &Object, typename TCallTraits< ValueType >::ParamType InValue)
 
const FString & GetPropertyPath () const
 
const FNameGetPropertyName () const
 
template<>
void CallFunction (UObject &InRuntimeObject, TCallTraits< bool >::ParamType PropertyValue)
 
template<>
void SetCurrentValue (UObject &Object, TCallTraits< bool >::ParamType InValue)
 
template<>
void CallFunction (UObject &InRuntimeObject, UObject *PropertyValue)
 
template<>
void SetCurrentValue (UObject &Object, UObject *InValue)
 
template<>
MOVIESCENE_API void CallFunction (UObject &InRuntimeObject, TCallTraits< bool >::ParamType PropertyValue)
 
template<>
MOVIESCENE_API void SetCurrentValue (UObject &Object, TCallTraits< bool >::ParamType InValue)
 
template<>
MOVIESCENE_API void CallFunction (UObject &InRuntimeObject, UObject *PropertyValue)
 
template<>
MOVIESCENE_API void SetCurrentValue (UObject &Object, UObject *InValue)
 

Static Public Member Functions

static MOVIESCENE_API TOptional< UE::MovieScene::FSourcePropertyValueStaticValue (const UObject *Object, FStringView InPropertyPath)
 
static MOVIESCENE_API TOptional< TPair< const FProperty *, UE::MovieScene::FSourcePropertyValue > > StaticPropertyAndValue (const UObject *Object, FStringView InPropertyPath)
 
template<typename ValueType >
static TOptional< ValueType > StaticValue (const UObject *Object, FStringView InPropertyPath)
 
static MOVIESCENE_API FPropertyFindProperty (const UObject *Object, FStringView InPropertyPath)
 

Friends

class FTrackInstancePropertyBindingsTests
 

Detailed Description

Manages bindings to keyed properties for a track instance. Calls UFunctions to set the value on runtime objects

Constructor & Destructor Documentation

◆ FTrackInstancePropertyBindings()

FTrackInstancePropertyBindings::FTrackInstancePropertyBindings ( FName  InPropertyName,
const FString &  InPropertyPath 
)

Member Function Documentation

◆ CacheBinding()

void FTrackInstancePropertyBindings::CacheBinding ( const UObject InRuntimeObject)

Rebuilds the property and function mappings for a single runtime object, and adds them to the cache

Parameters
InRuntimeObjectThe object to cache mappings for

◆ CallFunction() [1/5]

template<>
void FTrackInstancePropertyBindings::CallFunction ( UObject InRuntimeObject,
TCallTraits< bool >::ParamType  PropertyValue 
)

◆ CallFunction() [2/5]

template<>
MOVIESCENE_API void FTrackInstancePropertyBindings::CallFunction ( UObject InRuntimeObject,
TCallTraits< bool >::ParamType  PropertyValue 
)

Explicit specializations for bools

◆ CallFunction() [3/5]

template<typename ValueType >
void FTrackInstancePropertyBindings::CallFunction ( UObject InRuntimeObject,
typename TCallTraits< ValueType >::ParamType  PropertyValue 
)
inline

Calls the setter function for a specific runtime object or if the setter function does not exist, the property is set directly

Parameters
InRuntimeObjectThe runtime object whose function to call
PropertyValueThe new value to assign to the property

◆ CallFunction() [4/5]

template<>
void FTrackInstancePropertyBindings::CallFunction ( UObject InRuntimeObject,
UObject PropertyValue 
)

◆ CallFunction() [5/5]

template<>
MOVIESCENE_API void FTrackInstancePropertyBindings::CallFunction ( UObject InRuntimeObject,
UObject PropertyValue 
)

Explicit specializations for object pointers

◆ CallFunctionForEnum()

void FTrackInstancePropertyBindings::CallFunctionForEnum ( UObject InRuntimeObject,
int64  PropertyValue 
)

Calls the setter function for a specific runtime object or if the setter function does not exist, the property is set directly

Parameters
InRuntimeObjectThe runtime object whose function to call
PropertyValueThe new value to assign to the property

◆ FindProperty()

FProperty * FTrackInstancePropertyBindings::FindProperty ( const UObject Object,
FStringView  InPropertyPath 
)
static

Finds the property at the end of the given property path.

◆ GetCurrentValue()

template<typename ValueType >
ValueType FTrackInstancePropertyBindings::GetCurrentValue ( const UObject Object)
inline

Gets the current value of a property on an object

Parameters
ObjectThe object to get the property from
Returns
ValueType The current value

◆ GetCurrentValueForEnum()

int64 FTrackInstancePropertyBindings::GetCurrentValueForEnum ( const UObject Object)

Gets the current value of a property on an object

Parameters
ObjectThe object to get the property from
Returns
ValueType The current value

◆ GetOptionalValue()

template<typename ValueType >
TOptional< ValueType > FTrackInstancePropertyBindings::GetOptionalValue ( const UObject Object)
inline

Optionally gets the current value of a property on an object

Parameters
ObjectThe object to get the property from
Returns
(Optional) The current value of the property on the object

◆ GetProperty()

FProperty * FTrackInstancePropertyBindings::GetProperty ( const UObject Object)

Gets the FProperty that is bound to the track instance.

Parameters
ObjectThe Object that owns the property
Returns
The property on the object if it exists

◆ GetPropertyName()

const FName & FTrackInstancePropertyBindings::GetPropertyName ( ) const
inline
Returns
the property name that this binding was initialized from

◆ GetPropertyPath()

const FString & FTrackInstancePropertyBindings::GetPropertyPath ( ) const
inline
Returns
the property path that this binding was initialized from

◆ GetPropertyStruct()

const UStruct * FTrackInstancePropertyBindings::GetPropertyStruct ( const UObject Object)

Gets the structure type of the bound property if it is a property of that type.

Parameters
ObjectThe Object that owns the property
Returns
The structure type

◆ HasValidBinding()

bool FTrackInstancePropertyBindings::HasValidBinding ( const UObject Object)

Returns whether this binding is valid for the given object.

Parameters
ObjectThe Object that owns the property
Returns
Whether the property binding is valid

◆ SetCurrentValue() [1/5]

template<>
void FTrackInstancePropertyBindings::SetCurrentValue ( UObject Object,
TCallTraits< bool >::ParamType  InValue 
)

◆ SetCurrentValue() [2/5]

template<>
MOVIESCENE_API void FTrackInstancePropertyBindings::SetCurrentValue ( UObject Object,
TCallTraits< bool >::ParamType  InValue 
)

◆ SetCurrentValue() [3/5]

template<typename ValueType >
void FTrackInstancePropertyBindings::SetCurrentValue ( UObject Object,
typename TCallTraits< ValueType >::ParamType  InValue 
)
inline

Sets the current value of a property on an object

Parameters
ObjectThe object to set the property on
InValueThe value to set

◆ SetCurrentValue() [4/5]

template<>
void FTrackInstancePropertyBindings::SetCurrentValue ( UObject Object,
UObject InValue 
)

◆ SetCurrentValue() [5/5]

template<>
MOVIESCENE_API void FTrackInstancePropertyBindings::SetCurrentValue ( UObject Object,
UObject InValue 
)

◆ StaticPropertyAndValue()

TOptional< TPair< const FProperty *, UE::MovieScene::FSourcePropertyValue > > FTrackInstancePropertyBindings::StaticPropertyAndValue ( const UObject Object,
FStringView  InPropertyPath 
)
static

◆ StaticValue() [1/2]

TOptional< UE::MovieScene::FSourcePropertyValue > FTrackInstancePropertyBindings::StaticValue ( const UObject Object,
FStringView  InPropertyPath 
)
static

Static function for accessing a property value on an object without caching its address

Parameters
ObjectThe object to get the property from
InPropertyPathThe path to the property to retrieve
Returns
(Optional) The current value of the property on the object

◆ StaticValue() [2/2]

template<typename ValueType >
static TOptional< ValueType > FTrackInstancePropertyBindings::StaticValue ( const UObject Object,
FStringView  InPropertyPath 
)
inlinestatic

Static function for accessing a property value on an object without caching its address

Parameters
ObjectThe object to get the property from
InPropertyPathThe path to the property to retrieve
Returns
(Optional) The current value of the property on the object

Friends And Related Symbol Documentation

◆ FTrackInstancePropertyBindingsTests

friend class FTrackInstancePropertyBindingsTests
friend

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