FControlRigOverrideValue | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/ControlRig

A single value used to represent an override on a subject. The value serialized the data using binary serialization based on the last property in the property chain. The value can be copied on to the subject or from the subject as well as copied from and to string. This data-structure is not thread-safe for writing.


Name	FControlRigOverrideValue
Type	struct
Header File	/Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/ControlRigOverride.h
Include Path	#include "ControlRigOverride.h"

Syntax

USTRUCT (BlueprintType )  
struct FControlRigOverrideValue

Constructors

Name	Remarks	Include Path
FControlRigOverrideValue ( const FString& InPath, const UStruct* InOwnerStruct, const FString& InValueAsString, const FName& InSubjectKey, const FControlRigOverrideValueErrorPipe::TReportFunction& InReportFunction )	Constructor given the path, the owning structure as well as the value as string	ControlRigOverride.h
FControlRigOverrideValue ( const FString& InPath, const UStruct* InOwnerStruct, const void* InSubjectPtr, const FName& InSubjectKey )	Constructor given the path, the owning structure as well as the container	ControlRigOverride.h
FControlRigOverrideValue ( const FControlRigOverrideValue& InOther )		ControlRigOverride.h
FControlRigOverrideValue ()		ControlRigOverride.h
FControlRigOverrideValue ( const FString& InPath, const UObject* InSubject )	Constructor given the path and the subject (the instance representing the memory)	ControlRigOverride.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
~FControlRigOverrideValue()		ControlRigOverride.h

Structs

Name	Remarks
FPropertyInfo

Constants

Name	Type	Include Path
ArraySeparator	TCHAR	ControlRigOverride.h
PathSeparator	const FString	ControlRigOverride.h
PathSeparatorLength	int32	ControlRigOverride.h

Variables

Protected

Name	Type	Include Path
CachedStringValue	TOptional< FString >	ControlRigOverride.h
DataArray	TArray< uint8, TAlignedHeapAllocator< 16 > >	ControlRigOverride.h
DataPropertyHash	uint32	ControlRigOverride.h
Hash	uint32	ControlRigOverride.h
Path	TOptional< FString >	ControlRigOverride.h
Properties	TArray< FPropertyInfo >	ControlRigOverride.h
SubjectKey	TOptional< FName >	ControlRigOverride.h

Functions

Public

Name	Remarks	Include Path
void AddStructReferencedObjects ( FReferenceCollector& Collector ) const		ControlRigOverride.h
bool ContainsProperty ( const FProperty* InProperty ) const		ControlRigOverride.h
bool CopyToSubject ( void* InSubjectPtr, const UStruct* InSubjectStruct ) const	Copies the override value onto a container	ControlRigOverride.h
void CopyToUObject ( UObject* InSubjectPtr ) const	Copies the override value onto a container	ControlRigOverride.h
int32 GetArrayIndex ( int32 InIndex ) const	Returns the array index for a given property	ControlRigOverride.h
void * GetData ()	Returns the raw data of this value	ControlRigOverride.h
const T * GetData ()	Returns the raw data of this value	ControlRigOverride.h
T * GetData ()	Returns the raw data of this value	ControlRigOverride.h
const void * GetData ()	Returns the raw data of this value	ControlRigOverride.h
const FProperty * GetLeafProperty()	Returns the leaf property represented by this value (potentially leaf == root property)	ControlRigOverride.h
int32 GetNumProperties()	Number of properties in the override	ControlRigOverride.h
const FString & GetPath()	Returns the path this value represents	ControlRigOverride.h
const FProperty * GetProperty ( int32 InIndex ) const	Returns a given property	ControlRigOverride.h
const FProperty * GetRootProperty()	Returns the root property represented by this value	ControlRigOverride.h
const FName & GetSubjectKey()	Returns the name of the subject	ControlRigOverride.h
bool Identical ( const FControlRigOverrideValue& InOtherValue ) const	Returns true if the stored value matches the provided value	ControlRigOverride.h
bool IdenticalValue ( const void* InValuePtr ) const	Returns true if the stored value matches the provided value memory	ControlRigOverride.h
bool IdenticalValueInSubject ( const void* InSubjectPtr ) const	Returns true if the stored value matches the provided value memory	ControlRigOverride.h
bool IsValid()	Returns true if this value is valid - meaning if the property chain is valid and the value has been set	ControlRigOverride.h
void Reset()	Resets the contents of this value	ControlRigOverride.h
bool Serialize ( FArchive& Ar )		ControlRigOverride.h
bool SetFromString ( const FString& InValue, const FControlRigOverrideValueErrorPipe::TReportFunction& InReportFunction )	Sets the contents of this value from string	ControlRigOverride.h
bool SetFromSubject ( const void* InSubjectPtr, const UStruct* InSubjectStruct )	Copies the value from a container into this override value	ControlRigOverride.h
void SetFromUObject ( const UObject* InSubjectPtr )	Copies the value from a container into this override value	ControlRigOverride.h
uint8 * SubjectPtrToValuePtr ( const void* InSubjectPtr, bool bResizeArrays ) const	Converts a memory pointer from the subject to the leaf property.	ControlRigOverride.h
TSharedPtr< FPropertyPath > ToPropertyPath()	Helper conversion used mainly for user interface code	ControlRigOverride.h
const FString & ToString()	Returns the value of this override as a string (or an empty string)	ControlRigOverride.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static FProperty * FindProperty ( const UStruct* InStruct, const FString& InNameOrDisplayName )	Helper method to look up a property under a structure	ControlRigOverride.h
static uint32 GetPropertyHash ( const FProperty* InProperty )		ControlRigOverride.h

Operators

Name	Remarks	Include Path	Unreal Specifiers
FControlRigOverrideValue & operator= ( const FControlRigOverrideValue& InOther )		ControlRigOverride.h
bool operator== ( const FControlRigOverrideValue& InOtherValue ) const		ControlRigOverride.h

Navigation