Navigation
API > API/Plugins > API/Plugins/RemoteControl
These structures serve both as properties mapping as well as UI generation Protocols should implement it based on the parameters they need.
| Name | FRemoteControlProtocolEntity |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlProtocolBinding.h |
| Include Path | #include "RemoteControlProtocolBinding.h" |
Syntax
USTRUCT ()
struct FRemoteControlProtocolEntity
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FRemoteControlProtocolEntity() |
RemoteControlProtocolBinding.h |
Structs
| Name | Remarks |
|---|---|
| FRangeMappingData | Container for range and mapping value pointers, and an optional number of elements (arrays, strings). |
| TRangeMappingData | Templated container for range and mapping values. |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ProtocolValue | double | The current protocol value. Useful to test if the value changed | RemoteControlProtocolBinding.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BindingStatus | ERCBindingStatus | Binding status of this protocol entity | RemoteControlProtocolBinding.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool ApplyProtocolValueToProperty
(
const double InProtocolValue |
Interpolate and apply protocol value to the property | RemoteControlProtocolBinding.h | |
virtual void ClearMask
(
ERCMask InMaskBit |
Masking Support Disables the given mask. | RemoteControlProtocolBinding.h | |
virtual void EnableMask
(
ERCMask InMaskBit |
Enables the given mask. | RemoteControlProtocolBinding.h | |
ERCBindingStatus GetBindingStatus() |
Get current binding state of the entity | RemoteControlProtocolBinding.h | |
ERCMask GetOverridenMask() |
Returns the overriden masks. | RemoteControlProtocolBinding.h | |
const TWeakObjectPtr< URemoteControlPreset > & GetOwner() |
Returns the preset that owns this protocol entity | RemoteControlProtocolBinding.h | |
const FGuid & GetPropertyId() |
Get exposed property id | RemoteControlProtocolBinding.h | |
| Retrieves the name of property corresponding to the given column name. | RemoteControlProtocolBinding.h | ||
TArray< FRangeMappingData > GetRangeMappingBuffers() |
Get Ranges and Mapping Value pointers | RemoteControlProtocolBinding.h | |
virtual const FString & GetRangePropertyMaxValue() |
Get the upper most value for the range property type, used for normalization | RemoteControlProtocolBinding.h | |
virtual FName GetRangePropertyName () |
Get bound range property. | RemoteControlProtocolBinding.h | |
virtual uint8 GetRangePropertySize() |
Get Size of the range property value | RemoteControlProtocolBinding.h | |
virtual bool HasMask
(
ERCMask InMaskBit |
Returns true if the given mask is enabled, false otherwise. | RemoteControlProtocolBinding.h | |
void Init
(
URemoteControlPreset* InOwner, |
Initialize after allocation | RemoteControlProtocolBinding.h | |
bool IsEnabled() |
Get the state of the binding. | RemoteControlProtocolBinding.h | |
virtual bool IsSame
(
const FRemoteControlProtocolEntity* InOther |
Checks if this entity has the same values as the Other. Used to check for duplicate inputs. | RemoteControlProtocolBinding.h | |
virtual void RegisterProperties() |
Register(s) all the properties (to be exposed) of this protocol entity. | RemoteControlProtocolBinding.h | |
void ResetDefaultBindingState() |
Reset the binding set to default | RemoteControlProtocolBinding.h | |
void SetEnabled
(
bool bInEnable |
Set to enable or disable input. | RemoteControlProtocolBinding.h | |
ERCBindingStatus ToggleBindingStatus() |
Toggle the binding | RemoteControlProtocolBinding.h |