1. Epic GamesDeveloper
  3. RemoteControlCommon

RemoteControlCommon

API > API/Plugins

   
Name RemoteControlCommon
Type Plugin
Part of Plugins Remote Control API
Location /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControlCommon/
Module Build Rules RemoteControlCommon.Build.cs

Classes

Name Remarks
FRCPropertyVariant Container that can hold either a PropertyHandle, or Property/Data pair.
URCPropertyContainerBase  
URCPropertyContainerRegistry A subsystem to provide and cache dynamically created PropertyContainer classes.
URemoteControlSettings Global remote control settings

Structs

Name Remarks
CNumerical Concept to check if T has NumericLimits
CPropertyHasTCppType Concept to check if PropertyType has a TCppType
CPropertyValuePair Concept to check if PropertyType::TCppType matches ValueType
FRCNetworkAddress Utility struct to represent IPv4 Network addresses.
FRCNetworkAddressRange Utility struct to represent range of IPv4 Network addresses.
FRCPassphrase Passphrase Struct
FRCPropertyContainerKey Minimal information needed to lookup a unique property container class
TIsStringLikeProperty Catch-all for string-like property types
TIsStringLikeValue Catch-all for string-like value types
TRCTypeNameToType  
TRemoteControlPropertyTypeTraits Various RemoteControl property type traits
TRemoteControlTypeTraits Various RemoteControl type traits

Enums

Public

Name Remarks
ERCMask  
ERCProtocolBinding::Op  

Constants

Name Type Remarks Include Path
RemoteControlPropertyUtilities::CachedSetterFunctions TMap< TWeakFieldPtr< const FProperty >, TWeakObjectPtr< UFunction > >   RCPropertyUtilities.h
RemoteControlTypeUtilities::ClampMaxKey FName   RCTypeUtilities.h
RemoteControlTypeUtilities::ClampMinKey FName Metadata Keys. RCTypeUtilities.h
RemoteControlTypeUtilities::MaxOp auto Delegated Max operator. RCTypeUtilities.h
RemoteControlTypeUtilities::MinOp auto Delegated Min operator. RCTypeUtilities.h
RemoteControlTypeUtilities::UIMaxKey FName   RCTypeUtilities.h
RemoteControlTypeUtilities::UIMinKey FName   RCTypeUtilities.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
TNumericValueConstraint_V bool Ensures ValueType is a numeric type. RCTypeTraits.h  
TPropertyConstraint_V bool Various RemoteControl property type Traits (wraps internal implementations). RCTypeUtilities.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

ENUM_CLASS_FLAGS ( ERCMask
)

   RemoteControlCommon.h  

uint64 GetTypeHash ( const FRCPropertyContainerKey& InValue
)

   RCPropertyContainer.h  

bool operator!= ( const FRCPropertyContainerKey& Lhs,
const FRCPropertyContainerKey& Rhs
)

   RCPropertyContainer.h  

bool operator== ( const FRCPropertyContainerKey& Lhs,
const FRCPropertyContainerKey& Rhs
)

   RCPropertyContainer.h  

TEnableIf<(TIsDerivedFrom< PropertyType, FProperty >::Value &&!std::is_same_v< PropertyType, FProperty > &&!std::is_same_v< PropertyType, FNumericProperty >)||std::is_same_v< PropertyType, FEnumProperty >, bool >::Type RemoteControlPropertyUtilities::Deserialize ( const FRCPropertyVariant& InSrc,
FRCPropertyVariant& OutDst
)

 Reads the raw data from InSrc and deserializes to OutDst.    

TEnableIf< std::is_same_v< PropertyType, FProperty >||std::is_same_v< PropertyType, FNumericProperty >, bool >::Type RemoteControlPropertyUtilities::Deserialize ( const FRCPropertyVariant& InSrc,
FRCPropertyVariant& OutDst
)

 Specialization for FProperty casts and forwards to specializations.    

TEnableIf<(TIsDerivedFrom< PropertyType, FProperty >::Value &&!std::is_same_v< PropertyType, FProperty > &&!std::is_same_v< PropertyType, FNumericProperty >)||std::is_same_v< PropertyType, FEnumProperty >, bool >::Type RemoteControlPropertyUtilities::Serialize ( const FRCPropertyVariant& InSrc,
FRCPropertyVariant& OutDst
)

 Reads the property value from InSrc and serializes to OutDst.    

TEnableIf< std::is_same_v< PropertyType, FProperty >||std::is_same_v< PropertyType, FNumericProperty >, bool >::Type RemoteControlPropertyUtilities::Serialize ( const FRCPropertyVariant& InSrc,
FRCPropertyVariant& OutDst
)

 Specialization for FProperty casts and forwards to specializations.    
Size of given property + data, accounting for item count (arrays, strings, etc.) RCTypeUtilities.h  

SIZE_T RemoteControlTypeUtilities::GetPropertySize ( const FProperty* InProperty,
void* InData
)

 Size of given property + data, accounting for item count (arrays, strings, etc.) RCTypeUtilities.h  

Static

Name Remarks Include Path Unreal Specifiers
LightComponent derived components use a lot of property setters, without specifying BlueprintSetter, so handle here. RCPropertyUtilities.h  
LightComponent derived components use a lot of property setters, without specifying BlueprintSetter, so handle here.    

static FProperty * RemoteControlPropertyUtilities::FindSetterArgument ( UFunction* SetterFunction,
const FProperty* PropertyToModify
)

   RCPropertyUtilities.h  

static FProperty * RemoteControlPropertyUtilities::FindSetterArgument ( UFunction* SetterFunction,
const FProperty* PropertyToModify
)

      
  RCPropertyUtilities.h  
     
  RCPropertyUtilities.h  
     

static const FName RemoteControlPropertyUtilities::NAME_BlueprintGetter ( TEXT("BlueprintGetter")
)

   RCPropertyUtilities.h  

static const FName RemoteControlPropertyUtilities::NAME_BlueprintSetter ( TEXT("BlueprintSetter")
)

   RCPropertyUtilities.h  

static ValueType RemoteControlTypeUtilities::ClampToPropertyType ( const FNumericProperty* InProperty,
ValueType& InOutValue
)

 Clamps the value to the PropertyType, for example if an int64 is requested but the PropertyType is UInt16Property. RCTypeUtilities.h  

static ValueType RemoteControlTypeUtilities::GetClampedValue ( Func InFunc,
const PropertyType* InProperty,
ValueType InValue,
const TArray< FName >& InMetaKeys
)

   RCTypeUtilities.h  
  RCTypeUtilities.h  

static ValueType RemoteControlTypeUtilities::GetDefaultMappingValueMax ( const FProperty* InProperty
)

   RCTypeUtilities.h  
  RCTypeUtilities.h  

static ValueType RemoteControlTypeUtilities::GetDefaultMappingValueMax ( const FProperty* InProperty
)

   RCTypeUtilities.h  
  RCTypeUtilities.h  

static ValueType RemoteControlTypeUtilities::GetDefaultMappingValueMin ( const FProperty* InProperty
)

   RCTypeUtilities.h  
  RCTypeUtilities.h  

static ValueType RemoteControlTypeUtilities::GetDefaultMappingValueMin ( const FProperty* InProperty
)

   RCTypeUtilities.h  
  RCTypeUtilities.h  

static ValueType RemoteControlTypeUtilities::GetDefaultRangeValueMax ( const FProperty* InProperty
)

   RCTypeUtilities.h  

static ValueType RemoteControlTypeUtilities::GetDefaultRangeValueMax ( const FProperty* InProperty
)

   RCTypeUtilities.h  
  RCTypeUtilities.h  

static ValueType RemoteControlTypeUtilities::GetDefaultRangeValueMin ( const FProperty* InProperty
)

   RCTypeUtilities.h  

static ValueType RemoteControlTypeUtilities::GetDefaultRangeValueMin ( const PropertyType* InProperty
)

   RCTypeUtilities.h  

static ValueType RemoteControlTypeUtilities::GetMetadataValue ( const PropertyType* InProperty,
const FName& InKey,
const ValueType& InDefaultValue
)

 Returns typed metadata for numeric property if it exists, otherwise returns the DefaultValue. RCTypeUtilities.h  

static bool RemoteControlTypeUtilities::IsSupportedMappingType ( const PropertyType* InProperty
)

 Is ValueType supported as a mapping (property output) value? RCTypeUtilities.h  

static bool RemoteControlTypeUtilities::IsSupportedRangeType ( const PropertyType* InProperty
)

 The utilities below wrap TRemoteControlTypeTraits RCTypeUtilities.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page