1. Epic GamesDeveloper
  3. FPropertyAnimatorCoreData

FPropertyAnimatorCoreData

Serializable struct that contains the property and the owner with accessors

API > API/Plugins > API/Plugins/PropertyAnimatorCore

Serializable struct that contains the property and the owner with accessors

   
Name FPropertyAnimatorCoreData
Type struct
Header File /Engine/Plugins/VirtualProduction/PropertyAnimatorCore/Source/PropertyAnimatorCore/Public/Properties/PropertyAnimatorCoreData.h
Include Path #include "Properties/PropertyAnimatorCoreData.h"

Syntax

USTRUCT (BlueprintType )  
struct FPropertyAnimatorCoreData

Constructors

Name Remarks Include Path Unreal Specifiers

FPropertyAnimatorCoreData ( UObject* InObject,
const TArray< FProperty* >& InChainProperties,
TSubclassOf< UPropertyAnimatorCoreResolver > InResolverClass
)

 Take the owner and the full property chain, from member property to inner property Properties/PropertyAnimatorCoreData.h  

FPropertyAnimatorCoreData ( AActor* InActor,
const FString& InPropertyLocatorPath
)

 Takes an actor and a locator path, tries to resolve property and owner Properties/PropertyAnimatorCoreData.h  
  Properties/PropertyAnimatorCoreData.h  

FPropertyAnimatorCoreData ( UObject* InObject,
FProperty* InMemberProperty,
FProperty* InProperty,
TSubclassOf< UPropertyAnimatorCoreResolver > InResolverClass
)

 Takes the owner, the member property and the inner property inside Properties/PropertyAnimatorCoreData.h  

FPropertyAnimatorCoreData ( UObject* InObject,
const TArray< FProperty* >& InChainProperties,
FProperty* InProperty,
TSubclassOf< UPropertyAnimatorCoreResolver > InResolverClass
)

 Take the owner, the property chain until the inner property and lastly the inner property Properties/PropertyAnimatorCoreData.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bSetterFunctionCached bool   Properties/PropertyAnimatorCoreData.h
  • Transient
ChainProperties TArray< TFieldPath< FProperty > > Chain from member property to inner property Properties/PropertyAnimatorCoreData.h  
LocatorPath FString Property locator path to find the property and owner on any actor Properties/PropertyAnimatorCoreData.h  
OwnerWeak TWeakObjectPtr< UObject > Owner of the property Properties/PropertyAnimatorCoreData.h  
PathHash FString DEPRECATED, use locator path instead, Previously used to quickly compare struct of this type, replaced by LocatorPath Properties/PropertyAnimatorCoreData.h  
PropertyDisplayName FString The cached friendly display name of the property we are controlling Properties/PropertyAnimatorCoreData.h
  • Transient
PropertyHandler TObjectPtr< UPropertyAnimatorCoreHandlerBase > Used by properties to get/set value with a property bag without knowing the underlying type Properties/PropertyAnimatorCoreData.h  
PropertyResolverClass TSubclassOf< UPropertyAnimatorCoreResolver > Used by virtual properties to resolve Properties/PropertyAnimatorCoreData.h  
SetterFunctionWeak TWeakObjectPtr< UFunction > Matching Setter ufunction found when no setter is specified Properties/PropertyAnimatorCoreData.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

void GeneratePropertyPath()

 Internal use only, (re)creates the property path, locator path, display name Properties/PropertyAnimatorCoreData.h  

TArray< FProperty * > GetChainProperties()

 The chain properties from member to inner property Properties/PropertyAnimatorCoreData.h  

TArray< FName > GetChainPropertyNames()

 The chain property names from member to inner property Properties/PropertyAnimatorCoreData.h  

TOptional< FPropertyAnimatorCoreData > GetChildOf ( const FPropertyAnimatorCoreData& InOtherProperty
) const

 Tries to find, based on this property, the direct child of other property Properties/PropertyAnimatorCoreData.h  

TArray< FPropertyAnimatorCoreData > GetChildrenProperties ( int32 InDepthSearch
) const

 Gets the children of this property Properties/PropertyAnimatorCoreData.h  

FProperty * GetLeafProperty()

 The last property in the chain, could be member property if there is only one Properties/PropertyAnimatorCoreData.h  

FName GetLeafPropertyName()

 The leaf property name Properties/PropertyAnimatorCoreData.h  

FName GetLeafPropertyTypeName()

   Properties/PropertyAnimatorCoreData.h  

FString GetLocatorPath()

 The path to retrieve owner and property on any actor Properties/PropertyAnimatorCoreData.h  

FName GetLocatorPathHash()

 Hash used to store property, based on the locator path Properties/PropertyAnimatorCoreData.h  

FProperty * GetMemberProperty()

 The member property of the owner, top property inside the owner itself Properties/PropertyAnimatorCoreData.h  

FName GetMemberPropertyName()

 The member property name Properties/PropertyAnimatorCoreData.h  

FName GetMemberPropertyTypeName()

   Properties/PropertyAnimatorCoreData.h  

TArray< UObject * > GetOuters ( const UObject* InStopOuter
) const

 Returns chain of owner until it reaches StopOuter Properties/PropertyAnimatorCoreData.h  

UObject * GetOwner()

 The owner object of the member property Properties/PropertyAnimatorCoreData.h  

TWeakObjectPtr< UObject > GetOwnerWeak()

   Properties/PropertyAnimatorCoreData.h  

AActor * GetOwningActor()

 Returns the owning actor from this owner object Properties/PropertyAnimatorCoreData.h  

UActorComponent * GetOwningComponent()

 Returns the owning component from this owner object if any Properties/PropertyAnimatorCoreData.h  
Returns the parent of this property if there is one Properties/PropertyAnimatorCoreData.h  

FString GetPathHash()

 DEPRECATED, use GetLocatorPath instead The full path of a property with its owner Properties/PropertyAnimatorCoreData.h  

FString GetPropertyDisplayName()

 The friendly display name from the member property to the inner property Properties/PropertyAnimatorCoreData.h  

UPropertyAnimatorCoreHandlerBase * GetPropertyHandler()

 Gets the property handler to perform operation on property without knowing the type Properties/PropertyAnimatorCoreData.h  

UPropertyAnimatorCoreResolver * GetPropertyResolver()

 Get the linked property resolver for resolvable properties Properties/PropertyAnimatorCoreData.h  

TSubclassOf< UPropertyAnimatorCoreResolver > GetPropertyResolverClass()

 Get the property resolver class Properties/PropertyAnimatorCoreData.h  

void GetPropertyValuePtr ( OutValueType* OutValue
) const

 Gets the value ptr for this property will use getter if available, otherwise directly access the property address Properties/PropertyAnimatorCoreData.h  
Returns the top most parent / member property if there is one Properties/PropertyAnimatorCoreData.h  

bool HasA()

 Checks if this property contains a specific type Properties/PropertyAnimatorCoreData.h  

bool HasSetter()

 Checks if the property is settable via setter Properties/PropertyAnimatorCoreData.h  

bool IsA()

 Checks if this property is of a specific type Properties/PropertyAnimatorCoreData.h  

bool IsChildOf ( const FPropertyAnimatorCoreData& InOtherProperty
) const

 Checks if we are contained inside this other property directly Properties/PropertyAnimatorCoreData.h  

bool IsOwning ( const FPropertyAnimatorCoreData& InOtherProperty
) const

 Checks if we own this other nested property Properties/PropertyAnimatorCoreData.h  

bool IsParentOf ( const FPropertyAnimatorCoreData& InOtherProperty
) const

 Checks if we contain this other property directly Properties/PropertyAnimatorCoreData.h  

bool IsResolvable()

 Is this a resolvable property that uses a custom resolver Properties/PropertyAnimatorCoreData.h  

bool IsResolved()

 Checks if the property is resolved and can be used Properties/PropertyAnimatorCoreData.h  

bool IsTransient()

 Returns true if the owner or the property is transient Properties/PropertyAnimatorCoreData.h  

void SetPropertyValuePtr ( InValueType* InValue
) const

 Sets the value ptr for this property, will use setter if available, otherwise directly set the property address Properties/PropertyAnimatorCoreData.h  

Static

Name Remarks Include Path Unreal Specifiers

static void CopyPropertyValue ( const FProperty* InProperty,
const void* InSrc,
void* OutDest
)

   Properties/PropertyAnimatorCoreData.h  

static FName GetPropertyTypeName ( const FProperty* InProperty
)

   Properties/PropertyAnimatorCoreData.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator== ( const FPropertyAnimatorCoreData& InOther
) const

   Properties/PropertyAnimatorCoreData.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page