Navigation
API > API/Plugins > API/Plugins/RemoteControl
Inheritance Hierarchy
- FRemoteControlProtocolEntity
- FRemoteControlDMXProtocolEntity
- FRemoteControlMIDIProtocolEntity
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
| Type | Name | Description | |
|---|---|---|---|
 |
bool | bIsEnabled | State of the binding, set to false to ignore input. |
 |
TMap< FName, FName > | ColumnsToProperties | Holds column specific properties for this protocol. |
  |
TSet< FRemoteControlProtocolMapping > | Mappings | Property mapping ranges set Stores protocol mapping for this protocol binding entity |
  |
ERCMask | OverridenMasks | Holds the overriden masks. |
  |
TWeakObjectPtr< URemoteControlPreset > | Owner | The preset that owns this entity. |
  |
FGuid | PropertyId | Exposed property Id |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
bool | ApplyProtocolValueToProperty
(
const double InProtocolValue |
Interpolate and apply protocol value to the property |
  |
void | Masking Support Disables the given mask. | |
  |
void | EnableMask
(
ERCMask InMaskBit |
Enables the given mask. |
  |
ERCBindingStatus | Get current binding state of the entity | |
  |
const TWeakObjectPtr< URemoteControlPreset > & | GetOwner () |
Returns the preset that owns this protocol entity |
  |
const FGuid & | Get exposed property id | |
 |
const FName | GetPropertyName
(
const FName& ForColumnName |
Retrieves the name of property corresponding to the given column name. |
   |
const FString & | Get the upper most value for the range property type, used for normalization | |
   |
FName | Get bound range property. | |
   |
uint8 | Get Size of the range property value | |
   |
bool | Returns true if the given mask is enabled, false otherwise. | |
 |
void | Init
(
URemoteControlPreset* InOwner, |
Initialize after allocation |
  |
bool | IsEnabled () |
Get the state of the binding. |
  |
bool | IsSame
(
const FRemoteControlProtocolEntity* InOther |
Checks if this entity has the same values as the Other. Used to check for duplicate inputs. |
  |
void | Register(s) all the properties (to be exposed) of this protocol entity. | |
 |
void | Reset the binding set to default | |
 |
void | SetEnabled
(
bool bInEnable |
Set to enable or disable input. |
 |
ERCBindingStatus | Toggle the binding |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FRangeMappingData | Container for range and mapping value pointers, and an optional number of elements (arrays, strings). | |
 |
TRangeMappingData | Templated container for range and mapping values. |