1. Epic GamesDeveloper
  3. FTrackInstancePropertyBindings

FTrackInstancePropertyBindings

Manages bindings to keyed properties for a track instance.

API > API/Runtime > API/Runtime/MovieScene

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

   
Name FTrackInstancePropertyBindings
Type class
Header File /Engine/Source/Runtime/MovieScene/Public/MovieSceneCommonHelpers.h
Include Path #include "MovieSceneCommonHelpers.h"

Syntax

class FTrackInstancePropertyBindings

Constructors

Name Remarks Include Path Unreal Specifiers

FTrackInstancePropertyBindings ( FName InPropertyName,
const FString& InPropertyPath
)

   MovieSceneCommonHelpers.h  

Structs

Name Remarks
FResolvedProperty  
FResolvedPropertyAndFunction  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
FunctionName FName Name of the function to call to set values MovieSceneCommonHelpers.h  
NotifyFunctionName FName Name of a function to call when a value has been set MovieSceneCommonHelpers.h  
PropertyName FName Actual name of the property we are bound to MovieSceneCommonHelpers.h  
PropertyPath FString Path to the property we are bound to MovieSceneCommonHelpers.h  
RuntimeObjectToFunctionMap TMap< FObjectKey, FResolvedPropertyAndFunction > Mapping of objects to bound functions that will be called to update data on the track MovieSceneCommonHelpers.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CacheBinding ( const UObject& InRuntimeObject
)

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

void CallFunction ( UObject& InRuntimeObject,
typename TCallTraits< ValueType >::ParamType PropertyValue
)

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

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

 Explicit specializations for bools MovieSceneCommonHelpers.h  

void CallFunction ( UObject& InRuntimeObject,
UObject* PropertyValue
)

 Explicit specializations for object pointers MovieSceneCommonHelpers.h  

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

      

void CallFunction ( UObject& InRuntimeObject,
UObject* PropertyValue
)

      

void 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 MovieSceneCommonHelpers.h  

ValueType GetCurrentValue ( const UObject& Object
)

 Gets the current value of a property on an object MovieSceneCommonHelpers.h  

int64 GetCurrentValueForEnum ( const UObject& Object
)

 Gets the current value of a property on an object MovieSceneCommonHelpers.h  

TOptional< ValueType > GetOptionalValue ( const UObject& Object
)

 Optionally gets the current value of a property on an object MovieSceneCommonHelpers.h  

FProperty * GetProperty ( const UObject& Object
)

 Gets the FProperty that is bound to the track instance. MovieSceneCommonHelpers.h  

const FName & GetPropertyName()

   MovieSceneCommonHelpers.h  

const FString & GetPropertyPath()

   MovieSceneCommonHelpers.h  

const UStruct * GetPropertyStruct ( const UObject& Object
)

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

bool HasValidBinding ( const UObject& Object
)

 Returns whether this binding is valid for the given object. MovieSceneCommonHelpers.h  

void SetCurrentValue ( UObject& Object,
UObject* InValue
)

      

void SetCurrentValue ( UObject& Object,
typename TCallTraits< ValueType >::ParamType InValue
)

 Sets the current value of a property on an object MovieSceneCommonHelpers.h  

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

      

void SetCurrentValue ( UObject& Object,
UObject* InValue
)

   MovieSceneCommonHelpers.h  

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

   MovieSceneCommonHelpers.h  

Static

Name Remarks Include Path Unreal Specifiers

static void FindProperty ( FTrackInstancePropertyBindings& Bindings,
void* BasePointer,
UStruct* InStruct,
const FString& InPropertyName,
FResolvedProperty& OutResolvedProperty
)

   MovieSceneCommonHelpers.h  

static FProperty * FindProperty ( const UObject* Object,
const FString& InPropertyPath
)

   MovieSceneCommonHelpers.h  

static FResolvedProperty FindPropertyAndArrayIndex ( FTrackInstancePropertyBindings& Bindings,
void* BasePointer,
UStruct* InStruct,
const FString& PropertyName
)

   MovieSceneCommonHelpers.h  

static void InvokeSetterFunction ( UObject* InRuntimeObject,
UFunction* Setter,
T&& InPropertyValue
)

 Wrapper for UObject::ProcessEvent that attempts to pass the new property value directly to the function as a parameter, but handles cases where multiple parameters or a return value exists. MovieSceneCommonHelpers.h  

static FResolvedProperty ResolveProperty ( FTrackInstancePropertyBindings& Bindings,
const UObject& Object
)

   MovieSceneCommonHelpers.h  

static FResolvedProperty ResolvePropertyRecursive ( FTrackInstancePropertyBindings& Bindings,
void* BasePointer,
UStruct* InStruct,
TArray< FString >& InPropertyNames,
uint32 Index
)

   MovieSceneCommonHelpers.h  

static TOptional< ValueType > StaticValue ( const UObject* Object,
const FString& InPropertyPath
)

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

static bool TryGetPropertyValue ( const FResolvedProperty& ResolvedProperty,
ValueType& OutValue
)

   MovieSceneCommonHelpers.h  

static bool TryGetPropertyValue ( const FResolvedProperty& ResolvedProperty,
bool& OutValue
)

      

static bool TryGetPropertyValue ( const FResolvedProperty& ResolvedProperty,
UObject*& OutValue
)

      

static bool TryGetPropertyValue ( const FResolvedProperty& ResolvedProperty,
bool& OutValue
)

   MovieSceneCommonHelpers.h  

static bool TryGetPropertyValue ( const FResolvedProperty& ResolvedProperty,
UObject*& OutValue
)

   MovieSceneCommonHelpers.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page