1. Epic GamesDeveloper
  3. FRemoteControlProtocolMapping

FRemoteControlProtocolMapping

Mapping of the range of the values for the protocol This class holds a generic range buffer.

API > API/Plugins > API/Plugins/RemoteControl

Mapping of the range of the values for the protocol This class holds a generic range buffer. For example, it could be FFloatProperty 4 bytes Or it could be any UScripStruct, like FVector - 12 bytes Or any custom struct, arrays, maps, sets, or primitive properties

   
Name FRemoteControlProtocolMapping
Type struct
Header File /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlProtocolBinding.h
Include Path #include "RemoteControlProtocolBinding.h"

Syntax

USTRUCT ()  
struct FRemoteControlProtocolMapping

Constructors

Name Remarks Include Path Unreal Specifiers
  RemoteControlProtocolBinding.h  

FRemoteControlProtocolMapping ( FProperty* InProperty,
uint8 InRangeValueSize,
const FGuid& InMappingId
)

   RemoteControlProtocolBinding.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BoundPropertyPath TFieldPath< FProperty > Holds the bound property path RemoteControlProtocolBinding.h  
Id FGuid Unique Id of the current binding RemoteControlProtocolBinding.h  
InterpolationMappingPropertyData TArray< uint8 > Holds the serialized mapped property data. RemoteControlProtocolBinding.h  
InterpolationMappingPropertyDataCache TArray< uint8 > Holds the mapped property data buffer. RemoteControlProtocolBinding.h
  • Transient
InterpolationMappingPropertyElementNum int32 The element count if the Mapping is an array. RemoteControlProtocolBinding.h  
InterpolationRangePropertyData TArray< uint8 > The current integer value of the mapping range. RemoteControlProtocolBinding.h  
InterpolationRangePropertyDataCache TArray< uint8 > Holds the range property data buffer. RemoteControlProtocolBinding.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanGetMappingValueAsPrimitive()

 Returns true if one can get mapping value as primitive for the specified type RemoteControlProtocolBinding.h  

bool CopyRawMappingData ( const TSharedPtr< IPropertyHandle >& InPropertyHandle
)

 Copies the underlying InterpolationMappingPropertyData to the given destination, using the input property for type information RemoteControlProtocolBinding.h  

bool CopyRawRangeData ( const TSharedPtr< IPropertyHandle >& InPropertyHandle
)

 Copies the underlying InterpolationRangePropertyData to the given destination, using the input property for type information RemoteControlProtocolBinding.h  

const FGuid & GetId()

 Get Binding Range Id. RemoteControlProtocolBinding.h  

TSharedPtr< FStructOnScope > GetMappingPropertyAsStructOnScope()

 Get Mapping value as a Struct on Scope, only in case BoundProperty is FStructProperty RemoteControlProtocolBinding.h  

TEnableIfRemoteControlTypeTraits::TIsStringLikeValue< ValueType >::Value, ValueType >::Type GetMappingValueAsPrimitive ()

 Get Mapping Property Value as a primitive type RemoteControlProtocolBinding.h  
Get Mapping Property String-like Value as a primitive type RemoteControlProtocolBinding.h  

TEnableIf< std::is_same_v< FStructProperty, PropertyType >, ValueType >::Type GetMappingValueAsPrimitive ()

 Get Mapping Property Struct Value as a primitive type RemoteControlProtocolBinding.h  

ValueType GetRangeValue ()

 Get Binding Range Value RemoteControlProtocolBinding.h  

TEnableIf< std::is_same_v< FStructProperty, PropertyType >, ValueType >::Type GetRangeValue ()

 Get Binding Range Struct Value RemoteControlProtocolBinding.h  

bool IsValid()

 Get validity of the mapping (based on the Id) RemoteControlProtocolBinding.h  

void SetMappingValueAsPrimitive ( FString InMappingPropertyValue
)

 Set primitive Mapping Property String Value based on template value input RemoteControlProtocolBinding.h  

void SetMappingValueAsPrimitive ( ValueType InMappingPropertyValue
)

 Set primitive Mapping Property Value based on template value input RemoteControlProtocolBinding.h  

TEnableIf< std::is_same_v< FStructProperty, PropertyType >, void >::Type SetMappingValueAsPrimitive ( ValueType InMappingPropertyValue
)

 Set primitive Mapping Property Struct Value based on template value input RemoteControlProtocolBinding.h  

void SetMappingValueAsPrimitive ( FName InMappingPropertyValue
)

 Set primitive Mapping Property Name Value based on template value input RemoteControlProtocolBinding.h  

void SetMappingValueAsPrimitive ( FText InMappingPropertyValue
)

 Set primitive Mapping Property Text Value based on template value input RemoteControlProtocolBinding.h  

void SetRangeValue ( ValueType InRangeValue
)

 Set Binding Range Value based on template value input RemoteControlProtocolBinding.h  

TEnableIf< std::is_same_v< FStructProperty, PropertyType >, void >::Type SetRangeValue ( ValueType InRangeValue
)

 Set Binding Range Struct Value based on templated value input RemoteControlProtocolBinding.h  

bool SetRawMappingData ( const TSharedPtr< IPropertyHandle >& InPropertyHandle
)

 Sets the underlying InterpolationMappingPropertyData to the given source, using the input property for type information RemoteControlProtocolBinding.h  

bool SetRawMappingData ( URemoteControlPreset* InOwningPreset,
const FProperty* InProperty,
const void* InSource
)

 Sets the underlying InterpolationMappingPropertyData to the given source, using the input property for type information RemoteControlProtocolBinding.h  

bool SetRawRangeData ( const TSharedPtr< IPropertyHandle >& InPropertyHandle
)

 Sets the underlying InterpolationRangePropertyData to the given source, using the input property for type information RemoteControlProtocolBinding.h  

bool SetRawRangeData ( URemoteControlPreset* InOwningPreset,
const FProperty* InProperty,
const void* InSource
)

 Sets the underlying InterpolationRangePropertyData to the given source, using the input property for type information RemoteControlProtocolBinding.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator== ( const FRemoteControlProtocolMapping& InProtocolMapping
) const

   RemoteControlProtocolBinding.h  

bool operator== ( FGuid InProtocolMappingId
) const

   RemoteControlProtocolBinding.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page