1. Epic GamesDeveloper
  3. FRCPropertyVariant

FRCPropertyVariant

Container that can hold either a PropertyHandle, or Property/Data pair. Similar to FFieldVariant

API > API/Plugins > API/Plugins/RemoteControlCommon

References

   
Module RemoteControlCommon
Header /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControlCommon/Public/RCPropertyUtilities.h
Include #include "RCPropertyUtilities.h"

Syntax

class FRCPropertyVariant

Remarks

Container that can hold either a PropertyHandle, or Property/Data pair. Similar to FFieldVariant

Constructors

  Type Name Description
Public function    
Public function  

FRCPropertyVariant ( const TSharedPtr< IPropertyHandle >& InPropertyHandle
)

 Construct from an IPropertyHandle.
Public function  

FRCPropertyVariant ( const FProperty* InProperty,
const void* InPropertyData,
const int32& InNumElements
)

 Construct from a Property, PropertyData ptr, and the expected element count (needed for arrays, strings, etc.).
Public function  

FRCPropertyVariant ( const FProperty* InProperty,
TArray< uint8 >& InPropertyData,
const int32& InNumElements
)

 Construct from a Property and backing data array. Preferred over a raw ptr.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const int32 Gets individual element size (for arrays, etc.).
Public function Const PropertyType * Gets the typed property, returns nullptr if not cast.
Public function Const FProperty * Gets the property.
Public function Const TArray< uint8 > * Gets the property container (byte array), if available.
Public function Const void *

GetPropertyData ( const FProperty* InContainer,
int32 InIdx
)

 Gets the data pointer
Public function Const ValueType *

GetPropertyValue ( const FProperty* InContainer,
int32 InIdx
)

 Returns the data as the ValueType.
Public function Const FString *

GetPropertyValue ( const FProperty* InContainer,
int32 InIdx
)

  
Public function Const FString *

GetPropertyValue ( const FProperty* InContainer,
int32 InIdx
)

  
Public function void

InferNum ( const FRCPropertyVariant* InOtherProperty
)

 Calculate number of elements based on available info.
Public function void

Init ( int32 InSize
)

 Initialize/allocate if necessary.
Public function Const bool Is this backed by an IPropertyHandle?
Public function Const int32

Num ()

 Gets the number of elements, more than 1 if an array.
Public function Const int32

Size ()

 Gets the size of the underlying data.

Operators

  Type Name Description
Public function Const bool

operator!= ( const FRCPropertyVariant& InOther
)

  
Public function Const bool

operator== ( const FRCPropertyVariant& InOther
)

 Comparison is by property, not by property instance value.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page