RemoteControlCommon

Windows
MacOS
Linux

Classes

Name

Description

Public struct

CNumerical

Concept to check if T has NumericLimits

Public struct

CPropertyHasTCppType

Concept to check if PropertyType has a TCppType

Public struct

CPropertyValuePair

Concept to check if PropertyType::TCppType matches ValueType

Public struct UStruct

FRCPropertyContainerKey

Minimal information needed to lookup a unique property container class

Public class

FRCPropertyVariant

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

Public struct

TIsStringLikeProperty

Catch-all for string-like property types

Public struct

TIsStringLikeValue

Catch-all for string-like value types

Public struct

TRCTypeNameToType

Public struct

TRemoteControlPropertyTypeTraits

Various RemoteControl property type traits

Public struct

TRemoteControlTypeTraits

Various RemoteControl type traits

Public class UClass Abstract Transient

URCPropertyContainerBase

Public class UClass

URCPropertyContainerRegistry

A subsystem to provide and cache dynamically created PropertyContainer classes.

Constants

Typedefs

Name

Description

TNumericValueConstraint

Ensures ValueType is a numeric type.

TPropertyConstraint

Various RemoteControl property type Traits (wraps internal implementations).

Functions

Name Description

Public function

uint64

 

GetTypeHash

(
    const FRCPropertyContainerKey& InV...
)

Public function

bool

 

operator!=

(
    const FRCPropertyContainerKey& Lhs,
    const FRCPropertyContainerKey& Rhs
)

Public function

bool

 

operator==

(
    const FRCPropertyContainerKey& Lhs,
    const FRCPropertyContainerKey& Rhs
)

Public function

TEnableIf< T...

 

RemoteControlPropertyUtilities::Deserialize

(
    const FRCPropertyVariant& InSrc,
    FRCPropertyVariant& OutDst
)

Reads the raw data from InSrc and deserializes to OutDst.

Public function

TEnableIf< T...

 

RemoteControlPropertyUtilities::Deserialize

(
    const FRCPropertyVariant& InSrc,
    FRCPropertyVariant& OutDst
)

Specialization for FProperty casts and forwards to specializations.

Public function

TEnableIf< T...

 

RemoteControlPropertyUtilities::Serialize

(
    const FRCPropertyVariant& InSrc,
    FRCPropertyVariant& OutDst
)

Reads the property value from InSrc and serializes to OutDst.

Public function

TEnableIf< T...

 

RemoteControlPropertyUtilities::Serialize

(
    const FRCPropertyVariant& InSrc,
    FRCPropertyVariant& OutDst
)

Specialization for FProperty casts and forwards to specializations.

Public function Static

ValueType

 

RemoteControlTypeUtilities::ClampToPropertyType

(
    const FNumericProperty* InProp...,
    ValueType& InOutValue
)

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

Public function Static

ValueType

 

RemoteControlTypeUtilities::GetClampedValue

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

Public function Static

TPropertyCon...

 

RemoteControlTypeUtilities::GetDefaultMappingValueMax

(
    const FProperty* InProperty
)

Public function Static

constexpr Va...

 

RemoteControlTypeUtilities::GetDefaultMappingValueMax()

Public function Static

TEnableIf< T...

 

RemoteControlTypeUtilities::GetDefaultMappingValueMax

(
    const FProperty* InProperty
)

Public function Static

TEnableIf< R...

 

RemoteControlTypeUtilities::GetDefaultMappingValueMax

(
    const FProperty* InProperty
)

Public function Static

TEnableIf< T...

 

RemoteControlTypeUtilities::GetDefaultMappingValueMax

(
    const FStructProperty* InPrope...
)

Public function Static

TPropertyCon...

 

RemoteControlTypeUtilities::GetDefaultMappingValueMin

(
    const FProperty* InProperty
)

Public function Static

TEnableIf< T...

 

RemoteControlTypeUtilities::GetDefaultMappingValueMin

(
    const FStructProperty* InPrope...
)

Public function Static

TEnableIf< R...

 

RemoteControlTypeUtilities::GetDefaultMappingValueMin

(
    const FProperty* InProperty
)

Public function Static

constexpr Va...

 

RemoteControlTypeUtilities::GetDefaultMappingValueMin()

Public function Static

TEnableIf< T...

 

RemoteControlTypeUtilities::GetDefaultMappingValueMin

(
    const FProperty* InProperty
)

Public function Static

constexpr Va...

 

RemoteControlTypeUtilities::GetDefaultRangeValueMax()

Public function Static

TEnableIf< T...

 

RemoteControlTypeUtilities::GetDefaultRangeValueMax

(
    const FProperty* InProperty
)

Public function Static

TEnableIf< R...

 

RemoteControlTypeUtilities::GetDefaultRangeValueMax

(
    const FProperty* InProperty
)

Public function Static

TPropertyCon...

 

RemoteControlTypeUtilities::GetDefaultRangeValueMax

(
    const FProperty* InProperty
)

Public function Static

constexpr Va...

 

RemoteControlTypeUtilities::GetDefaultRangeValueMin()

Public function Static

TEnableIf< T...

 

RemoteControlTypeUtilities::GetDefaultRangeValueMin

(
    const FProperty* InProperty
)

Public function Static

TEnableIf< R...

 

RemoteControlTypeUtilities::GetDefaultRangeValueMin

(
    const FProperty* InProperty
)

Public function Static

TPropertyCon...

 

RemoteControlTypeUtilities::GetDefaultRangeValueMin

(
    const PropertyType* InProperty
)

Public function Static

constexpr TE...

 

RemoteControlTypeUtilities::GetMetadataValue

(
    const PropertyType* InProperty,
    const FName& InKey,
    const ValueType& InDefaultValue
)

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

Public function Static

constexpr TE...

 

RemoteControlTypeUtilities::GetMetadataValue

(
    const PropertyType* InProperty,
    const FName& InKey,
    const ValueType InDefaultValue
)

Returns typed metadata if it exists, otherwise returns the DefaultValue.

Public function

SIZE_T

 

RemoteControlTypeUtilities::GetPropertySize

(
    const TSharedPtr< IPropertyHandle >...
)

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

Public function

SIZE_T

 

RemoteControlTypeUtilities::GetPropertySize

(
    const FProperty* InProperty,
    void* InData
)

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

Public function Static

bool

 

RemoteControlTypeUtilities::IsSupportedMappingType

(
    const PropertyType* InProperty
)

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

Public function Static

bool

 

RemoteControlTypeUtilities::IsSupportedRangeType

(
    const PropertyType* InProperty
)

The utilities below wrap TRemoteControlTypeTraits

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss