1. Epic GamesDeveloper
  3. URCVirtualPropertyBase

URCVirtualPropertyBase

Base class for dynamic virtual properties Remote Control Virtual Properties using Property Bag and [FInstancedPropertyBag](API\Runtime\CoreUObject\FInstancedPropertyBag) to serialize FProperties values and [UStruct](API\Runtime\CoreUObject\UStruct)

API > API/Plugins > API/Plugins/RemoteControl

Base class for dynamic virtual properties Remote Control Virtual Properties using Property Bag and FInstancedPropertyBag to serialize FProperties values and UStruct

   
Name URCVirtualPropertyBase
Type class
Header File /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RCVirtualProperty.h
Include Path #include "RCVirtualProperty.h"

Syntax

UCLASS (BlueprintType)  
class URCVirtualPropertyBase : public UObject

Inheritance Hierarchy

Derived Classes

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Description FText Controller description RCVirtualProperty.h  
DisplayIndex int32 User configurable Display Index for this Virtual Property (as Logic Controller) when represented as a row in the RC Logic Controllers list RCVirtualProperty.h  
DisplayName FName Unique user friendly name of the controller, used as identifier in some API. RCVirtualProperty.h  
FieldId FName Property Field Id RCVirtualProperty.h  
Id FGuid Property Id RCVirtualProperty.h  
Metadata TMap< FName, FString >   RCVirtualProperty.h  
PresetWeakPtr TWeakObjectPtr< URemoteControlPreset > Pointer to Remote Control Preset RCVirtualProperty.h  
PropertyName FName Unique property name RCVirtualProperty.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CopyCompleteValue ( const FProperty* InTargetProperty,
uint8* InTargetValuePtr,
bool bPassByteEnumPropertyComparison
)

 Copy this virtual property's data onto a given FProperty RCVirtualProperty.h  

bool CopyCompleteValue ( const FProperty* InTargetProperty,
uint8* InTargetValuePtr
)

 Copy this virtual property's data onto a given FProperty RCVirtualProperty.h  

bool CopyCompleteValue ( URCVirtualPropertyBase* InVirtualProperty
)

 Copy this virtual property's data onto a given Virtual Property RCVirtualProperty.h  

bool DeserializeFromBackend ( IStructDeserializerBackend& InBackend
)

 Deserialize Virtual Property from a given Backend RCVirtualProperty.h  

FString GetDisplayValueAsString()

 Infers correct type internally, fetches value from memory and returns the value as a string that can be immediately used for dispaly (without needing to create a generic readonly property widget) RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"
Get the meta-data matching the given key. RCVirtualProperty.h  

virtual FProperty * GetProperty ()

 Returns FProperty for this RC virtual property RCVirtualProperty.h  

virtual const FProperty * GetProperty ()

 Returns const FProperty for this RC virtual property RCVirtualProperty.h  

FName GetPropertyName()

 Get FProperty Name RCVirtualProperty.h
  • BlueprintPure
  • Category="Remote Control Behaviour"

bool GetValueBool ( bool& OutBoolValue
) const

 Get Bool value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool GetValueByte ( uint8& OutByte
) const

 Get Byte value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool GetValueColor ( FColor& OutColor
) const

 Get Color value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool GetValueDouble ( double& OutDouble
) const

 Get Double value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool GetValueEnum ( uint8& OutByte
) const

 Get raw Enum value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool GetValueFloat ( float& OutFloat
) const

 Get Float value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool GetValueInt16 ( int16& OutInt16
) const

 Get Int16 value from Virtual Property RCVirtualProperty.h  

bool GetValueInt32 ( int32& OutInt32
) const

 Get Int32 value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool GetValueInt64 ( int64& OuyInt64
) const

 Get Int64 value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool GetValueInt8 ( int8& OutInt8
) const

 Get Int8 value from Virtual Property RCVirtualProperty.h  

bool GetValueLinearColor ( FLinearColor& OutLinearColor
) const

 Get LinearColor value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool GetValueName ( FName& OutNameValue
) const

 Get Name value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool GetValueNumericInteger ( int64& OutInt64Value
) const

 Get Numeric value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

UObject * GetValueObject()

 Get Object value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool GetValueRotator ( FRotator& OutRotator
) const

 Get Rotator value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool GetValueString ( FString& OutStringValue
) const

 Get String value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool GetValueText ( FText& OutTextValue
) const

 Get Text value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

EPropertyBagPropertyType GetValueType()

 Return property bag property type RCVirtualProperty.h  

const UObject * GetValueTypeObjectWeakPtr()

 Return pointer to object that defines the Enum, Struct, or Class. RCVirtualProperty.h  

bool GetValueUint16 ( uint16& OutUInt16
) const

 Get Uint16 value from Virtual Property RCVirtualProperty.h  

bool GetValueUInt32 ( uint32& OutUInt32
) const

 Get Uint32 value from Virtual Property RCVirtualProperty.h  

bool GetValueUint64 ( uint64& OuyUInt64
) const

 Get Uint64 value from Virtual Property RCVirtualProperty.h  

bool GetValueVector ( FVector& OutVector
) const

 Get Vector value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool GetValueVector2D ( FVector2D& OutVector2D
) const

 Get Vector2D value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

virtual void Init()

 Initialization routine. Called after the parent container has setup data for this property RCVirtualProperty.h  

virtual void InitPropertyBagPropertyDescription ( FPropertyBagPropertyDesc& InOutPropertyDesc
)

   RCVirtualProperty.h  

bool IsColorType()

 Whether this Virtual Property represents an FColor RCVirtualProperty.h  

bool IsLinearColorType()

 Whether this Virtual Property represents an FColor RCVirtualProperty.h  

bool IsNumericType()

 Whether this Virtual Property is a numeric type, i.e. an Integral or Floating point type RCVirtualProperty.h  

bool IsRotatorType()

 Whether this Virtual Property represents an FRotator RCVirtualProperty.h  

bool IsValueEqual ( URCVirtualPropertyBase* InVirtualProperty
) const

 Compare this virtual property value with given property value RCVirtualProperty.h  

bool IsValueGreaterThan ( URCVirtualPropertyBase* InVirtualProperty
) const

 Operator > comparison of self with a given virtual property RCVirtualProperty.h  

bool IsValueGreaterThanOrEqualTo ( URCVirtualPropertyBase* InVirtualProperty
) const

 Operator >= comparison of self with a given virtual property RCVirtualProperty.h  

bool IsValueLesserThan ( URCVirtualPropertyBase* InVirtualProperty
) const

 Operator < comparison of self with a given virtual property RCVirtualProperty.h  

bool IsValueLesserThanOrEqualTo ( URCVirtualPropertyBase* InVirtualProperty
) const

 Operator <= comparison of self with a given virtual property RCVirtualProperty.h  

bool IsVector2DType()

 Whether this Virtual Property represents an FVector2D RCVirtualProperty.h  

bool IsVectorType()

 Whether this Virtual Property represents an FVector RCVirtualProperty.h  

void RemoveMetadataValue ( FName Key
)

 Removes the meta-data matching the given key. RCVirtualProperty.h  

void SerializeToBackend ( IStructSerializerBackend& OutBackend
)

 Serialize Virtual Property to given Backend RCVirtualProperty.h  

void SetDisplayIndex ( const int32 InDisplayIndex
)

 Updates the display index of the virtual property (transaction aware) RCVirtualProperty.h  

void SetMetadataValue ( FName Key,
FString Data
)

 Adds/sets the meta-data with the given key and value. RCVirtualProperty.h  

bool SetValueBool ( const bool InBoolValue
)

 Set Bool value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool SetValueByte ( const uint8 InByte
)

 Set Byte value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool SetValueColor ( const FColor& InColor
)

 Set Color value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool SetValueDouble ( const double InDouble
)

 Set Double value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool SetValueFloat ( const float InFloat
)

 Set Float value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool SetValueInt16 ( const int16 InInt16
)

 Set Int16 value from Virtual Property RCVirtualProperty.h  

bool SetValueInt32 ( const int32 InInt32
)

 Set Int32 value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool SetValueInt64 ( const int64 InInt64
)

 Set Int64 value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool SetValueInt8 ( const int8 InInt8
)

 Set Int8 value from Virtual Property RCVirtualProperty.h  

bool SetValueLinearColor ( const FLinearColor& InLinearColor
)

 Set LinearColor value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool SetValueName ( const FName& InNameValue
)

 Set Name value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool SetValueNumericInteger ( const int64 InInt64Value
)

 Set Numeric value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool SetValueRotator ( const FRotator& InRotator
)

 Set Rotator value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool SetValueString ( const FString& InStringValue
)

 Set String value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool SetValueText ( const FText& InTextValue
)

 Set Text value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool SetValueUint16 ( const uint16 InUInt16
)

 Set Uint16 value from Virtual Property RCVirtualProperty.h  

bool SetValueUInt32 ( const uint32 InUInt32
)

 Set Uint32 value from Virtual Property RCVirtualProperty.h  

bool SetValueUint64 ( const uint64 InUInt64
)

 Set Uint64 value from Virtual Property RCVirtualProperty.h  

bool SetValueVector ( const FVector& InVector
)

 Set Vector value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

bool SetValueVector2D ( const FVector2D& InVector2D
)

 Set Vector2D value from Virtual Property RCVirtualProperty.h
  • BlueprintCallable
  • Category="Remote Control Behaviour"

virtual void UpdateEntityIds ( const TMap< FGuid, FGuid >& InEntityIdMap
)

 Called internally when entity Ids are renewed. RCVirtualProperty.h  

virtual void UpdateEntityUsage ( const URemoteControlPreset* InPreset,
TMap< FGuid, TSet< UObject* > >& InEntityToBehavior
) const

   RCVirtualProperty.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual const FPropertyBagPropertyDesc * GetBagPropertyDesc()

 Return Pointer to Bag Property Description RCVirtualProperty.h  

virtual uint8 * GetContainerPtr ()

 Return pointer to memory container RCVirtualProperty.h  

virtual const uint8 * GetContainerPtr ()

 Return pointer to memory const container RCVirtualProperty.h  

virtual const FInstancedPropertyBag * GetPropertyBagInstance()

 Pointer to Instanced property which is holds bag of properties RCVirtualProperty.h  

virtual const uint8 * GetValuePtr ()

 Return pointer to const value RCVirtualProperty.h  

virtual uint8 * GetValuePtr ()

 Return pointer to value RCVirtualProperty.h  

virtual void OnModifyPropertyValue()

 Notifies post change for Virtual Property value RCVirtualProperty.h  

virtual void OnPreChangePropertyValue()

 Notifies pre change for Virtual Property value RCVirtualProperty.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName GetVirtualPropertyTypeDisplayName ( const EPropertyBagPropertyType InValueType,
UObject* InValueTypeObject
)

 Fetches a user-friendly representation of the Virtual Property's type name (i.e. Controller type), given a Property Bag type and value object (for structures) RCVirtualProperty.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page