1. Epic GamesDeveloper
  3. FRemoteControlPresetLayout

FRemoteControlPresetLayout

Layout that holds groups of fields.

API > API/Plugins > API/Plugins/RemoteControl

Layout that holds groups of fields.

   
Name FRemoteControlPresetLayout
Type struct
Header File /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlPreset.h
Include Path #include "RemoteControlPreset.h"

Syntax

USTRUCT ()  
struct FRemoteControlPresetLayout

Constructors

Name Remarks Include Path Unreal Specifiers
  RemoteControlPreset.h  
  RemoteControlPreset.h  

Structs

Name Remarks
FFieldSwapArgs Arguments for swapping fields across groups.

Typedefs

Name Type Remarks Include Path
FOnFieldAdded TMulticastDelegate_ThreeParams< void, const FGuid &, const FGuid &, int32 >   RemoteControlPreset.h
FOnFieldDeleted TMulticastDelegate_ThreeParams< void, const FGuid &, const FGuid &, int32 >   RemoteControlPreset.h
FOnFieldOrderChanged TMulticastDelegate_TwoParams< void, const FGuid &, const TArray< FGuid > & >   RemoteControlPreset.h
FOnGroupAdded TMulticastDelegate_OneParam< void, const FRemoteControlPresetGroup & > Layout operation delegates. RemoteControlPreset.h
FOnGroupDeleted TMulticastDelegate_OneParam< void, FRemoteControlPresetGroup >   RemoteControlPreset.h
FOnGroupOrderChanged TMulticastDelegate_OneParam< void, const TArray< FGuid > & >   RemoteControlPreset.h
FOnGroupRenamed TMulticastDelegate_TwoParams< void, const FGuid &, FName >   RemoteControlPreset.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
DefaultGroupOrder TArray< FGuid > Keep the ALL group order since its not saved in the normal workflow RemoteControlPreset.h  
Groups TArray< FRemoteControlPresetGroup > The list of groups under this layout. RemoteControlPreset.h  
OnFieldAddedDelegate FOnFieldAdded   RemoteControlPreset.h  
OnFieldDeletedDelegate FOnFieldDeleted   RemoteControlPreset.h  
OnFieldOrderChangedDelegate FOnFieldOrderChanged   RemoteControlPreset.h  
OnGroupAddedDelegate FOnGroupAdded Layout operation delegates. RemoteControlPreset.h  
OnGroupDeletedDelegate FOnGroupDeleted   RemoteControlPreset.h  
OnGroupOrderChangedDelegate FOnGroupOrderChanged   RemoteControlPreset.h  
OnGroupRenamedDelegate FOnGroupRenamed   RemoteControlPreset.h  
Owner TWeakObjectPtr< URemoteControlPreset > The preset that owns this layout. RemoteControlPreset.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Non-Const getter for this layout's groups. RemoteControlPreset.h  

void AddField ( FGuid GroupId,
FGuid FieldId
)

 Append a field to the group's field list. RemoteControlPreset.h  
Create a group by giving it a name and ID RemoteControlPreset.h  
Create a group in the layout with a given name. RemoteControlPreset.h  

void DeleteGroup ( FGuid GroupId
)

 Delete a group from the layout. RemoteControlPreset.h  

FRemoteControlPresetGroup * FindGroupFromField ( FGuid FieldId
)

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

FRemoteControlPresetGroup & GetDefaultGroup()

 Get or create the default group. RemoteControlPreset.h  

TArray< FGuid > & GetDefaultGroupOrder()

 Return the DefaultGroupOrder RemoteControlPreset.h  

FRemoteControlPresetGroup * GetGroup ( FGuid GroupId
)

 Get a group by searching by ID. RemoteControlPreset.h  

FRemoteControlPresetGroup * GetGroupByName ( FName GroupName
)

 Get a group by searching by name. RemoteControlPreset.h  

const TArray< FRemoteControlPresetGroup > & GetGroups()

 Get this layout's groups. RemoteControlPreset.h  

URemoteControlPreset * GetOwner()

 Get the preset that owns this layout. RemoteControlPreset.h  

FLinearColor GetTagColor ( FGuid GroupId
)

 Returns the tag color of the given group id. RemoteControlPreset.h  

void InsertFieldAt ( FGuid GroupId,
FGuid FieldId,
int32 Index
)

 Insert a field in the group. RemoteControlPreset.h  

bool IsDefaultGroup ( FGuid GroupId
) const

 Returns true when the given group id is a default one. RemoteControlPreset.h  

FOnFieldAdded & OnFieldAdded()

   RemoteControlPreset.h  

FOnFieldDeleted & OnFieldDeleted()

   RemoteControlPreset.h  

FOnFieldOrderChanged & OnFieldOrderChanged()

   RemoteControlPreset.h  

FOnGroupAdded & OnGroupAdded()

   RemoteControlPreset.h  

FOnGroupDeleted & OnGroupDeleted()

   RemoteControlPreset.h  

FOnGroupOrderChanged & OnGroupOrderChanged()

   RemoteControlPreset.h  

FOnGroupRenamed & OnGroupRenamed()

   RemoteControlPreset.h  

void RemoveField ( FGuid GroupId,
FGuid FieldId
)

 Remove a field using the field's name. RemoteControlPreset.h  

void RemoveFieldAt ( FGuid GroupId,
int32 Index
)

 Remove a field at a provided index. RemoteControlPreset.h  

void RenameGroup ( FGuid GroupId,
FName NewGroupName
)

 Rename a group in the layout. RemoteControlPreset.h  

void SetDefaultGroupOrder ( const TArray< FGuid >& InNewDefaultGroupOrder
)

 Set the All group order RemoteControlPreset.h  

void SwapFields ( const FFieldSwapArgs& InFieldSwapArgs
)

 Swap fields across groups or in the same one. RemoteControlPreset.h  

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

 Swap fields across groups or in the same one for the default group. RemoteControlPreset.h  

void SwapGroups ( FGuid OriginGroupId,
FGuid TargetGroupId
)

 Swap two groups. RemoteControlPreset.h  

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

 Called internally when entity Ids are renewed. RemoteControlPreset.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page