FRemoteControlProtocolEntity

These structures serve both as properties mapping as well as UI generation Protocols should implement it based on the parameters they need.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

RemoteControl

Header

/Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlProtocolBinding.h

Include

#include "RemoteControlProtocolBinding.h"

Syntax

USTRUCT()
struct FRemoteControlProtocolEntity

Remarks

These structures serve both as properties mapping as well as UI generation Protocols should implement it based on the parameters they need.

Variables

Name Description

Protected variable

bool

 

bIsEnabled

State of the binding, set to false to ignore input.

Protected variable UProperty

TSet< FRemoteCo...

 

Mappings

Property mapping ranges set Stores protocol mapping for this protocol binding entity

Protected variable UProperty

TWeakObjectPtr<...

 

Owner

The preset that owns this entity.

Protected variable UProperty

FGuid

 

PropertyId

Exposed property Id

Destructors

Functions

Name Description

Public function

bool

 

ApplyProtocolValueToProperty

(
    double InProtocolValue
)

Interpolate and apply protocol value to the property

Public function Const

ERCBindingSt...

 

GetBindingStatus()

Get current binding state of the entity

Public function Const

const FGuid ...

 

GetPropertyId()

Get exposed property id

Public function Virtual Const

const FStrin...

 

GetRangePropertyMaxValue()

Get the upper most value for the range property type, used for normalization

Public function Virtual Const

FName

 

GetRangePropertyName()

Get bound range property.

Public function Virtual Const

uint8

 

GetRangePropertySize()

Get Size of the range property value

Public function

void

 

Init

(
    URemoteControlPreset* InOwner,
    FGuid InPropertyId
)

Initialize after allocation

Public function Const

bool

 

IsEnabled()

Get the state of the binding.

Public function Virtual

bool

 

IsSame

(
    const FRemoteControlProtocolEntity ...
)

Checks if this entity has the same values as the Other. Used to check for duplicate inputs.

Public function

void

 

ResetDefaultBindingState()

Reset the binding set to default

Public function

void

 

SetEnabled

(
    bool bInEnable
)

Set to enable or disable input.

Public function

ERCBindingSt...

 

ToggleBindingStatus()

Toggle the binding

Classes

Name

Description

Public struct

FRangeMappingData

Container for range and mapping value pointers, and an optional number of elements (arrays, strings).

Public struct

TRangeMappingData

Templated container for range and mapping values.