1. Epic GamesDeveloper
  3. FRemoteControlPresetLayout

FRemoteControlPresetLayout

Layout that holds groups of fields.

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 ()  
struct FRemoteControlPresetLayout

Remarks

Layout that holds groups of fields.

Constructors

  Type Name Description
Public function    
Public function    

Functions

  Type Name Description
Public function TArray< FRemoteControlPresetGroup > & 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 FRemoteControlPresetGroup &

CreateGroup ( FName GroupName,
FGuid GroupId
)

 Create a group by giving it a name and ID
Public function FRemoteControlPresetGroup &

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 FRemoteControlPresetGroup * Find the group that holds the specified field. Search for a group that contains a certain field.
Public function FRemoteControlPresetGroup & Get or create the default group.
Public function TArray< FGuid > & Return the DefaultGroupOrder
Public function FRemoteControlPresetGroup *

GetGroup ( FGuid GroupId
)

 Get a group by searching by ID.
Public function FRemoteControlPresetGroup *

GetGroupByName ( FName GroupName
)

 Get a group by searching by name.
Public function Const const TArray< FRemoteControlPresetGroup > & Get this layout's groups.
Public function URemoteControlPreset * Get the preset that owns this layout.
Public function FLinearColor

GetTagColor ( FGuid GroupId
)

 Returns the tag color of the given group id.
Public function void

InsertFieldAt ( FGuid GroupId,
FGuid FieldId,
int32 Index
)

 Insert a field in the group.
Public function Const bool

IsDefaultGroup ( FGuid GroupId
)

 Returns true when the given group id is a default one.
Public function FOnFieldAdded &  
Public function FOnFieldDeleted &  
Public function FOnFieldOrderChanged &  
Public function FOnGroupAdded &  
Public function FOnGroupDeleted &  
Public function FOnGroupOrderChanged &  
Public function FOnGroupRenamed &  
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

SetDefaultGroupOrder ( const TArray< FGuid >& InNewDefaultGroupOrder
)

 Set the All group order
Public function void

SwapFields ( const FFieldSwapArgs& InFieldSwapArgs
)

 Swap fields across groups or in the same one.
Public function void

SwapFieldsDefaultGroup ( const FFieldSwapArgs& FieldSwapArgs,
const FGuid InFieldRealGroup,
TArray< FGuid > InEntities
)

 Swap fields across groups or in the same one for the default group.
Public function void

SwapGroups ( FGuid OriginGroupId,
FGuid TargetGroupId
)

 Swap two groups.
Public function void

UpdateEntityIds ( const TMap< FGuid, FGuid >& InEntityIdMap
)

 Called internally when entity Ids are renewed.

Classes

  Type Name Description
Public struct FFieldSwapArgs Arguments for swapping fields across groups.  

Typedefs

Name Description
FOnFieldAdded  
FOnFieldDeleted  
FOnFieldOrderChanged  
FOnGroupAdded Layout operation delegates.
FOnGroupDeleted  
FOnGroupOrderChanged  
FOnGroupRenamed  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page