Navigation
API > API/Plugins > API/Plugins/RemoteControl
A handle to a property which is used to read and write the value
| Name | IRemoteControlPropertyHandle |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/IRemoteControlPropertyHandle.h |
| Include Path | #include "IRemoteControlPropertyHandle.h" |
Syntax
class IRemoteControlPropertyHandle : public TSharedFromThis< IRemoteControlPropertyHandle >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → IRemoteControlPropertyHandle
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IRemoteControlPropertyHandle() |
IRemoteControlPropertyHandle.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< IRemoteControlPropertyHandleArray > AsArray() |
Returns this handle as an array if possible | IRemoteControlPropertyHandle.h | |
TSharedPtr< IRemoteControlPropertyHandleMap > AsMap() |
IRemoteControlPropertyHandle.h | ||
TSharedPtr< IRemoteControlPropertyHandleSet > AsSet() |
IRemoteControlPropertyHandle.h | ||
TSharedPtr< IRemoteControlPropertyHandle > GetChildHandle
(
FName ChildName, |
Gets a child handle of this handle. | IRemoteControlPropertyHandle.h | |
TSharedPtr< IRemoteControlPropertyHandle > GetChildHandle
(
int32 Index |
Gets a child handle of this handle. Useful for accessing properties in structs. | IRemoteControlPropertyHandle.h | |
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 | IRemoteControlPropertyHandle.h | |
const FString & GetFieldPath() |
Gets the path from a UObject to a field | IRemoteControlPropertyHandle.h | |
int32 GetIndexInArray() |
IRemoteControlPropertyHandle.h | ||
int32 GetNumChildren() |
IRemoteControlPropertyHandle.h | ||
const FString & GetParentFieldPath() |
Gets the path from a UObject to a parent field | IRemoteControlPropertyHandle.h | |
FProperty * GetParentProperty() |
Gets the parent property being edited | IRemoteControlPropertyHandle.h | |
FProperty * GetProperty() |
Gets the property being edited | IRemoteControlPropertyHandle.h | |
TSharedPtr< FRemoteControlProperty > GetRCProperty() |
IRemoteControlPropertyHandle.h | ||
| IRemoteControlPropertyHandle.h | |||
bool GetValue
(
FVector& OutValue |
IRemoteControlPropertyHandle.h | ||
bool GetValue
(
FVector2D& OutValue |
IRemoteControlPropertyHandle.h | ||
| IRemoteControlPropertyHandle.h | |||
bool GetValue
(
FVector4& OutValue |
IRemoteControlPropertyHandle.h | ||
bool GetValue
(
FLinearColor& OutValue |
IRemoteControlPropertyHandle.h | ||
bool GetValue
(
FRotator& OutValue |
IRemoteControlPropertyHandle.h | ||
| IRemoteControlPropertyHandle.h | |||
bool GetValue
(
uint64& OutValue |
IRemoteControlPropertyHandle.h | ||
| IRemoteControlPropertyHandle.h | |||
bool GetValue
(
FQuat& OutValue |
IRemoteControlPropertyHandle.h | ||
bool GetValue
(
uint32& OutValue |
IRemoteControlPropertyHandle.h | ||
| IRemoteControlPropertyHandle.h | |||
bool GetValue
(
uint8& OutValue |
IRemoteControlPropertyHandle.h | ||
bool GetValue
(
int64& OutValue |
IRemoteControlPropertyHandle.h | ||
bool GetValue
(
int32& OutValue |
IRemoteControlPropertyHandle.h | ||
bool GetValue
(
int16& OutValue |
IRemoteControlPropertyHandle.h | ||
bool GetValue
(
int8& OutValue |
IRemoteControlPropertyHandle.h | ||
bool GetValue
(
bool& OutValue |
IRemoteControlPropertyHandle.h | ||
bool GetValue
(
double& OutValue |
IRemoteControlPropertyHandle.h | ||
bool GetValue
(
float& OutValue |
Gets the typed value of a property. | IRemoteControlPropertyHandle.h | |
bool GetValue
(
uint16& OutValue |
IRemoteControlPropertyHandle.h | ||
bool GetValueInArray
(
UObject*& OutValue, |
IRemoteControlPropertyHandle.h | ||
void SetGenerateTransaction
(
bool bInGenerateTransaction |
Set transaction generation for this property handle. | IRemoteControlPropertyHandle.h | |
| IRemoteControlPropertyHandle.h | |||
| IRemoteControlPropertyHandle.h | |||
bool SetValue
(
FVector InValue |
IRemoteControlPropertyHandle.h | ||
bool SetValue
(
FVector2D InValue |
IRemoteControlPropertyHandle.h | ||
bool SetValue
(
FRotator InValue |
IRemoteControlPropertyHandle.h | ||
bool SetValue
(
FQuat InValue |
IRemoteControlPropertyHandle.h | ||
| IRemoteControlPropertyHandle.h | |||
| IRemoteControlPropertyHandle.h | |||
bool SetValue
(
FLinearColor InValue |
IRemoteControlPropertyHandle.h | ||
bool SetValue
(
FVector4 InValue |
IRemoteControlPropertyHandle.h | ||
bool SetValue
(
uint64 InValue |
IRemoteControlPropertyHandle.h | ||
bool SetValue
(
int16 InValue |
IRemoteControlPropertyHandle.h | ||
bool SetValue
(
uint16 InValue |
IRemoteControlPropertyHandle.h | ||
bool SetValue
(
uint8 InValue |
IRemoteControlPropertyHandle.h | ||
bool SetValue
(
int64 InValue |
IRemoteControlPropertyHandle.h | ||
bool SetValue
(
int32 InValue |
IRemoteControlPropertyHandle.h | ||
bool SetValue
(
int8 InValue |
IRemoteControlPropertyHandle.h | ||
bool SetValue
(
bool InValue |
IRemoteControlPropertyHandle.h | ||
bool SetValue
(
double InValue |
IRemoteControlPropertyHandle.h | ||
bool SetValue
(
float InValue |
Sets the typed value of a property. | IRemoteControlPropertyHandle.h | |
bool SetValue
(
const TCHAR* InValue |
IRemoteControlPropertyHandle.h | ||
bool SetValue
(
uint32 InValue |
IRemoteControlPropertyHandle.h | ||
| IRemoteControlPropertyHandle.h | |||
bool SetValueInArray
(
UObject* InValue, |
IRemoteControlPropertyHandle.h | ||
bool ShouldGenerateTransaction() |
Should the property handle generate transactions. | IRemoteControlPropertyHandle.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedPtr< IRemoteControlPropertyHandle > GetPropertyHandle
(
FName PresetName, |
Get the property handle based on field path | IRemoteControlPropertyHandle.h | |
static TSharedPtr< IRemoteControlPropertyHandle > GetPropertyHandle
(
FName PresetName, |
Get the property handle based on field path | IRemoteControlPropertyHandle.h |