Navigation
API > API/Plugins > API/Plugins/IKRig
Single property override for a retarget op
| Name | FRetargetOpPropertyOverride |
| Type | struct |
| Header File | /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Retargeter/IKRetargetOverrides.h |
| Include Path | #include "Retargeter/IKRetargetOverrides.h" |
Syntax
USTRUCT ()
struct FRetargetOpPropertyOverride
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Retargeter/IKRetargetOverrides.h | |||
FRetargetOpPropertyOverride
(
const FString& InPropertyPath |
Retargeter/IKRetargetOverrides.h |
Structs
| Name | Remarks |
|---|---|
| FPropertySegment |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BoundCurveName | FName | The name of the curve this override is bound to, if any. | Retargeter/IKRetargetOverrides.h | |
| BoundVariableName | FName | The name of the variable this override is bound to, if any. | Retargeter/IKRetargetOverrides.h | |
| PropertyPath | FString | Property path using "->" separator like, "IKGoalSettings->BlendAlpha" and array syntax like, "Chains[0]->Weight" NOTE: this allows generic serialization of property overrides | Retargeter/IKRetargetOverrides.h |
|
| PropertyPathHash | uint32 | Retargeter/IKRetargetOverrides.h | ||
| ValueAsString | FString | Value serialized as string | Retargeter/IKRetargetOverrides.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FName GetBoundCurveName() |
Retargeter/IKRetargetOverrides.h | ||
FName GetBoundVariableName() |
Retargeter/IKRetargetOverrides.h | ||
const FString & GetPropertyPath() |
Get access to the path to this property | Retargeter/IKRetargetOverrides.h | |
uint32 GetPropertyPathHash() |
Get the hash of the property path (cached at construction) | Retargeter/IKRetargetOverrides.h | |
const FString & GetValueString() |
Get read-only access to the value of this override as a string | Retargeter/IKRetargetOverrides.h | |
FString & GetValueStringEditable() |
Get read/write access to the value of this override as a string | Retargeter/IKRetargetOverrides.h | |
bool IsValid
(
const UScriptStruct* InSettingsStruct |
Validate that this property exists and is accessible | Retargeter/IKRetargetOverrides.h | |
void SetBoundCurveName
(
const FName InCurveName |
Set the name of the curve to bind to this property NOTE: this must go through the retargeter controller | Retargeter/IKRetargetOverrides.h | |
void SetBoundVariableName
(
const FName InVariableName |
Set the name of the variable to bind to this property NOTE: this must go through the retargeter controller | Retargeter/IKRetargetOverrides.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Find a property by name with redirect support | Retargeter/IKRetargetOverrides.h | ||
static uint8 * GetDataPointerFromPathSegments
(
uint8* InStructPtr, |
Navigate from a struct pointer to the final property pointer | Retargeter/IKRetargetOverrides.h | |
static FProperty * GetLeafProperty
(
const TArray< FPropertySegment >& InSegments |
Get the leaf property from the segment chain | Retargeter/IKRetargetOverrides.h | |
static FName GetPropertyPathName() |
Reflection indirection because these are private | Retargeter/IKRetargetOverrides.h | |
static bool GetSegmentsFromProperyPath
(
const FString& InPath, |
Parse a property path string into segments | Retargeter/IKRetargetOverrides.h | |
static FName GetValeAsStringName() |
Retargeter/IKRetargetOverrides.h | ||
static bool IsStructPropertyAtDefault
(
const UScriptStruct* InStruct, |
Return true if the given property path is at the default value | Retargeter/IKRetargetOverrides.h |