1. Epic GamesDeveloper
  3. FRemoteControlProtocolBinding

FRemoteControlProtocolBinding

Struct which holds the bound struct and serialized struct archive

API > API/Plugins > API/Plugins/RemoteControl

References

   
Module RemoteControl
Header /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlProtocolBinding.h
Include #include "RemoteControlProtocolBinding.h"

Syntax

USTRUCT&40;&41;  
struct FRemoteControlProtocolBinding

Remarks

Struct which holds the bound struct and serialized struct archive

Variables

  Type Name Description
Protected variable UProperty FGuid Id Binding Id
Protected variable UProperty FName MappingPropertyName Property name which we using for protocol range mapping
Protected variable UProperty FGuid PropertyId Property Unique ID
Protected variable UProperty FName ProtocolName Protocol name which we using for binding

Constructors

  Type Name Description
Public function    
Public function  

FRemoteControlProtocolBinding ( const FName InProtocolName,
const FGuid& InPropertyId,
TSharedPtr< TStructOnScope< FRemoteControlProtocolEntity >> InRemoteControlProtocolEntityPtr,
const FGuid& InBindingId
)

  

Functions

  Type Name Description
Public function void

AddMapping ( const FRemoteControlProtocolMapping& InProtocolMapping
)

 Add binding mapping to the protocol bound struct
Public function void Empty all mapping for the bound struct
Public function FRemoteControlProtocolMapping *

FindMapping ( const FGuid& InMappingId
)

 Remove the bound struct mapping based on given mapping id
Public function void Loop through all mappings
Public function Const const FGuid &

GetId ()

 Get protocol binding id
Public function Const const FGuid & Get exposed property id
Public function Const FName Get protocol bound protocol name, such as MIDI, DMX, OSC, etc
Public function Const TSharedPtr< TStructOnScope< FRemoteControlProtocolEntity > > Get pointer to the StructOnScope
Public function Const TSharedPtr< FStructOnScope > Get bound struct scope wrapper
Public function Static bool Checks if the given PropertyType (FProperty) is supported
Public function Static bool Checks if the given ValueType is supported
Public function int32

RemoveMapping ( const FGuid& InMappingId
)

 Remove the bound struct mapping based on given mapping id
Public function bool Custom struct serialize
Public function bool

SetPropertyDataToMapping ( const FGuid& InMappingId,
const void* InPropertyValuePtr
)

 Set mapping property data to bound mapping struct.
Public function bool

SetRangeToMapping ( const FGuid& InMappingId,
T InRangeValue
)

 Set range value which is bound to mapping struct

Operators

  Type Name Description
Public function Const bool

operator== ( const FRemoteControlProtocolBinding& InProtocolBinding
)

  
Public function Const bool

operator== ( FGuid InProtocolBindingId
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page