Navigation
API > API/Plugins > API/Plugins/RemoteControlCommon
Container that can hold either a PropertyHandle, or Property/Data pair. Similar to FFieldVariant
| Name | FRCPropertyVariant |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControlCommon/Public/RCPropertyUtilities.h |
| Include Path | #include "RCPropertyUtilities.h" |
Syntax
class FRCPropertyVariant
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRCPropertyVariant
(
const FProperty* InProperty, |
Construct from a Property and backing data array. Preferred over a raw ptr. | RCPropertyUtilities.h | |
FRCPropertyVariant
(
const FProperty* InProperty, |
Construct from a Property, PropertyData ptr, and the expected element count (needed for arrays, strings, etc.). | RCPropertyUtilities.h | |
FRCPropertyVariant
(
const TSharedPtr< IPropertyHandle >& InPropertyHandle |
Construct from an IPropertyHandle. | RCPropertyUtilities.h | |
| RCPropertyUtilities.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FRCPropertyVariant() |
RCPropertyUtilities.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasHandle | bool | RCPropertyUtilities.h | ||
| NumElements | int32 | RCPropertyUtilities.h | ||
| Property | TWeakFieldPtr< const FProperty > | RCPropertyUtilities.h | ||
| PropertyContainer | TArray< uint8 > * | RCPropertyUtilities.h | ||
| PropertyData | void * | RCPropertyUtilities.h | ||
| PropertyHandle | TSharedPtr< IPropertyHandle > | RCPropertyUtilities.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetElementSize() |
Gets individual element size (for arrays, etc.). | RCPropertyUtilities.h | |
PropertyType * GetProperty () |
Gets the typed property, returns nullptr if not cast. | RCPropertyUtilities.h | |
FProperty * GetProperty () |
Gets the property. | RCPropertyUtilities.h | |
TArray< uint8 > * GetPropertyContainer() |
Gets the property container (byte array), if available. | RCPropertyUtilities.h | |
void * GetPropertyData
(
const FProperty* InContainer, |
Gets the data pointer | RCPropertyUtilities.h | |
ValueType * GetPropertyValue
(
const FProperty* InContainer, |
Returns the data as the ValueType. | RCPropertyUtilities.h | |
FString * GetPropertyValue
(
const FProperty* InContainer, |
|||
FString * GetPropertyValue
(
const FProperty* InContainer, |
RCPropertyUtilities.h | ||
void InferNum
(
const FRCPropertyVariant* InOtherProperty |
Calculate number of elements based on available info. | RCPropertyUtilities.h | |
void Init
(
int32 InSize |
Initialize/allocate if necessary. | RCPropertyUtilities.h | |
bool IsHandle() |
Is this backed by an IPropertyHandle? | RCPropertyUtilities.h | |
int32 Num() |
Gets the number of elements, more than 1 if an array. | RCPropertyUtilities.h | |
int32 Size() |
Gets the size of the underlying data. | RCPropertyUtilities.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FRCPropertyVariant& InOther |
RCPropertyUtilities.h | ||
bool operator==
(
const FRCPropertyVariant& InOther |
Comparison is by property, not by property instance value. | RCPropertyUtilities.h |