FRemoteControlPresetLayout

Layout that holds groups of fields.

Windows
MacOS
Linux

References

Module

RemoteControl

Header

/Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlPreset.h

Include

#include "RemoteControlPreset.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
struct FRemoteControlPresetLayout

Remarks

Layout that holds groups of fields.

Constructors

Functions

Name Description

Public function

TArray< FRem...

 

AccessGroups()

Non-Const getter for this layout's groups.

Public function

void

 

AddField

(
    FGuid GroupId,
    FGuid FieldId
)

Append a field to the group's field list.

Public function

FRemoteContr...

 

CreateGroup

(
    FName GroupName
)

Create a group in the layout with a given name.

Public function

void

 

DeleteGroup

(
    FGuid GroupId
)

Delete a group from the layout.

Public function

FRemoteContr...

 

FindGroupFromField

(
    FGuid FieldId
)

Find the group that holds the specified field. Search for a group that contains a certain field.

Public function

FRemoteContr...

 

GetDefaultGroup()

Get or create the default group.

Public function

FRemoteContr...

 

GetGroup

(
    FGuid GroupId
)

Get a group by searching by ID.

Public function

FRemoteContr...

 

GetGroupByName

(
    FName GroupName
)

Get a group by searching by name.

Public function Const

const TArray...

 

GetGroups()

Get this layout's groups.

Public function

URemoteContr...

 

GetOwner()

Get the preset that owns this layout.

Public function

void

 

InsertFieldAt

(
    FGuid GroupId,
    FGuid FieldId,
    int32 Index
)

Insert a field in the group.

Public function

bool

 

MoveField

(
    FGuid FieldId,
    FGuid TargetGroupId
)

Move field to a group.

Public function

FOnFieldAdde...

 

OnFieldAdded()

Public function

FOnFieldDele...

 

OnFieldDeleted()

Public function

FOnFieldOrde...

 

OnFieldOrderChanged()

Public function

FOnGroupAdde...

 

OnGroupAdded()

Public function

FOnGroupDele...

 

OnGroupDeleted()

Public function

FOnGroupOrde...

 

OnGroupOrderChanged()

Public function

FOnGroupRena...

 

OnGroupRenamed()

Public function

void

 

RemoveField

(
    FGuid GroupId,
    FGuid FieldId
)

Remove a field using the field's name.

Public function

void

 

RemoveFieldAt

(
    FGuid GroupId,
    int32 Index
)

Remove a field at a provided index.

Public function

void

 

RenameGroup

(
    FGuid GroupId,
    FName NewGroupName
)

Rename a group in the layout.

Public function

void

 

SwapFields

(
    const FFieldSwapArgs& FieldSwapArg...
)

Swap fields across groups or in the same one.

Public function

void

 

SwapGroups

(
    FGuid OriginGroupId,
    FGuid TargetGroupId
)

Swap two groups.

Classes

Name

Description

Public struct

FFieldSwapArgs

Arguments for swapping fields across groups.

Typedefs

Deprecated Functions

Name Description

Public function

FRemoteContr...

 

CreateGroup

(
    FName GroupName,
    FGuid GroupId
)

This function was deprecated, use the overload that doesn't accept a group id.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss