1. Epic GamesDeveloper
  3. IRemoteControlPropertyHandle

IRemoteControlPropertyHandle

A handle to a property which is used to read and write the value

API > API/Plugins > API/Plugins/RemoteControl

Inheritance Hierarchy

References

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

Syntax

class IRemoteControlPropertyHandle : public TSharedFromThis< IRemoteControlPropertyHandle >

Remarks

A handle to a property which is used to read and write the value

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function TSharedPtr< IRemoteControlPropertyHandleArray >

AsArray ()

 Returns this handle as an array if possible
Public function TSharedPtr< IRemoteControlPropertyHandleMap >

AsMap ()

  
Public function TSharedPtr< IRemoteControlPropertyHandleSet >

AsSet ()

  
Public function Const TSharedPtr< IRemoteControlPropertyHandle >

GetChildHandle ( FName ChildName,
bool bRecurse
)

 Gets a child handle of this handle.
Public function Const TSharedPtr< IRemoteControlPropertyHandle >

GetChildHandle ( int32 Index
)

 Gets a child handle of this handle. Useful for accessing properties in structs.
Public function TSharedPtr< IRemoteControlPropertyHandle >

GetChildHandleByFieldPath ( const FString& InFieldPath
)

 Gets handle by full field path For example the property could be ArrayOfVectors and the ArrayOfVectors[0].Y path needed for access of Y property from index 0
Public function Const const FString & Gets the path from a UObject to a field
Public function Const int32  
Public function Const int32  
Public function Const const FString & Gets the path from a UObject to a parent field
Public function Const FProperty * Gets the parent property being edited
Public function Const FProperty * Gets the property being edited
Public function Static TSharedPtr< IRemoteControlPropertyHandle >

GetPropertyHandle ( FName PresetName,
FName PropertyLabel
)

 Get the property handle based on field path
Public function Static TSharedPtr< IRemoteControlPropertyHandle >

GetPropertyHandle ( FName PresetName,
FGuid PropertyId
)

 Get the property handle based on field path
Public function Const TSharedPtr< FRemoteControlProperty >  
Public function Const bool

GetValue ( FName& OutValue
)

  
Public function Const bool

GetValue ( FVector& OutValue
)

  
Public function Const bool

GetValue ( FVector2D& OutValue
)

  
Public function Const bool

GetValue ( FString& OutValue
)

  
Public function Const bool

GetValue ( FVector4& OutValue
)

  
Public function Const bool

GetValue ( FLinearColor& OutValue
)

  
Public function Const bool

GetValue ( FRotator& OutValue
)

  
Public function Const bool

GetValue ( FColor& OutValue
)

  
Public function Const bool

GetValue ( uint64& OutValue
)

  
Public function Const bool

GetValue ( UObject* OutValue
)

  
Public function Const bool

GetValue ( FQuat& OutValue
)

  
Public function Const bool

GetValue ( uint32& OutValue
)

  
Public function Const bool

GetValue ( FText& OutValue
)

  
Public function Const bool

GetValue ( uint8& OutValue
)

  
Public function Const bool

GetValue ( int64& OutValue
)

  
Public function Const bool

GetValue ( int32& OutValue
)

  
Public function Const bool

GetValue ( int16& OutValue
)

  
Public function Const bool

GetValue ( int8& OutValue
)

  
Public function Const bool

GetValue ( bool& OutValue
)

  
Public function Const bool

GetValue ( double& OutValue
)

  
Public function Const bool

GetValue ( float& OutValue
)

 Gets the typed value of a property.
Public function Const bool

GetValue ( uint16& OutValue
)

  
Public function Const bool

GetValueInArray ( UObject* OutValue,
int32 InIndex
)

  
Public function void

SetGenerateTransaction ( bool bInGenerateTransaction
)

 Set transaction generation for this property handle.
Public function bool

SetValue ( const FText& InValue
)

  
Public function bool

SetValue ( const FName& InValue
)

  
Public function bool

SetValue ( FVector InValue
)

  
Public function bool

SetValue ( FVector2D InValue
)

  
Public function bool

SetValue ( FRotator InValue
)

  
Public function bool

SetValue ( FQuat InValue
)

  
Public function bool

SetValue ( const FString& InValue
)

  
Public function bool

SetValue ( FColor InValue
)

  
Public function bool

SetValue ( FLinearColor InValue
)

  
Public function bool

SetValue ( FVector4 InValue
)

  
Public function bool

SetValue ( uint64 InValue
)

  
Public function bool

SetValue ( int16 InValue
)

  
Public function bool

SetValue ( uint16 InValue
)

  
Public function bool

SetValue ( uint8 InValue
)

  
Public function bool

SetValue ( int64 InValue
)

  
Public function bool

SetValue ( int32 InValue
)

  
Public function bool

SetValue ( int8 InValue
)

  
Public function bool

SetValue ( bool InValue
)

  
Public function bool

SetValue ( double InValue
)

  
Public function bool

SetValue ( float InValue
)

 Sets the typed value of a property.
Public function bool

SetValue ( const TCHAR* InValue
)

  
Public function bool

SetValue ( uint32 InValue
)

  
Public function bool

SetValue ( UObject* InValue
)

  
Public function bool

SetValueInArray ( UObject* InValue,
int32 InIndex
)

  
Public function Const bool Should the property handle generate transactions.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page