Navigation
API > API/Plugins > API/Plugins/RemoteControl
References
| Module | RemoteControl |
| Header | /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlPreset.h |
| Include | #include "RemoteControlPreset.h" |
Syntax
USTRUCT&40;&41;
struct FRemoteControlPresetLayout
Remarks
Layout that holds groups of fields.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
|||
 |
FRemoteControlPresetLayout
(
URemoteControlPreset* OwnerPreset |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
TArray< FRemoteControlPresetGroup > & | AccessGroups () |
Non-Const getter for this layout's groups. |
 |
void | Append a field to the group's field list. | |
 |
FRemoteControlPresetGroup & | CreateGroup
(
FName GroupName |
Create a group in the layout with a given name. |
 |
void | DeleteGroup
(
FGuid GroupId |
Delete a group from the layout. |
 |
FRemoteControlPresetGroup * | FindGroupFromField
(
FGuid FieldId |
Find the group that holds the specified field. Search for a group that contains a certain field. |
 |
FRemoteControlPresetGroup & | Get or create the default group. | |
 |
FRemoteControlPresetGroup * | Get a group by searching by ID. | |
 |
FRemoteControlPresetGroup * | GetGroupByName
(
FName GroupName |
Get a group by searching by name. |
  |
const TArray< FRemoteControlPresetGroup > & | GetGroups () |
Get this layout's groups. |
 |
URemoteControlPreset * | GetOwner () |
Get the preset that owns this layout. |
 |
FLinearColor | GetTagColor
(
FGuid GroupId |
Returns the tag color of the given group id. |
 |
void | InsertFieldAt
(
FGuid GroupId, |
Insert a field in the group. |
  |
bool | IsDefaultGroup
(
FGuid GroupId |
Returns true when the given group id is a default one. |
 |
bool | Move field to a group. | |
 |
FOnFieldAdded & | OnFieldAdded () |
|
 |
FOnFieldDeleted & | ||
 |
FOnFieldOrderChanged & | ||
 |
FOnGroupAdded & | OnGroupAdded () |
|
 |
FOnGroupDeleted & | ||
 |
FOnGroupOrderChanged & | ||
 |
FOnGroupRenamed & | ||
 |
void | RemoveField
(
FGuid GroupId, |
Remove a field using the field's name. |
 |
void | RemoveFieldAt
(
FGuid GroupId, |
Remove a field at a provided index. |
 |
void | RenameGroup
(
FGuid GroupId, |
Rename a group in the layout. |
 |
void | SwapFields
(
const FFieldSwapArgs& FieldSwapArgs |
Swap fields across groups or in the same one. |
 |
void | SwapGroups
(
FGuid OriginGroupId, |
Swap two groups. |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FFieldSwapArgs | Arguments for swapping fields across groups. |
Typedefs
| Name | Description |
|---|---|
| FOnFieldAdded | |
| FOnFieldDeleted | |
| FOnFieldOrderChanged | |
| FOnGroupAdded | Layout operation delegates. |
| FOnGroupDeleted | |
| FOnGroupOrderChanged | |
| FOnGroupRenamed |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
 |
FRemoteControlPresetGroup & | CreateGroup
(
FName GroupName, |
This function was deprecated, use the overload that doesn't accept a group id. |