1. Epic GamesDeveloper
  3. IRemoteControlUIModule

IRemoteControlUIModule

A Remote Control module that allows exposing objects and properties from the editor.

API > API/Plugins > API/Plugins/RemoteControlUI

Inheritance Hierarchy

References

   
Module RemoteControlUI
Header /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControlUI/Public/IRemoteControlUIModule.h
Include #include "IRemoteControlUIModule.h"

Syntax

class IRemoteControlUIModule : public IModuleInterface

Remarks

A Remote Control module that allows exposing objects and properties from the editor.

Functions

  Type Name Description
Public function FDelegateHandle

AddPropertyFilter ( FOnDisplayExposeIcon OnDisplayExposeIcon
)

 Add a property filter that indicates if the property handle should be displayed or not.
Public function Const TSharedPtr< SWidget >

CreateCustomControllerWidget ( URCVirtualPropertyBase* InController,
TSharedPtr< IPropertyHandle > InOriginalPropertyHandle
)

 Tries to retrieve a Custom Controller Widget for the specified Controller
Public function Static IRemoteControlUIModule &

Get ()

 Singleton-like access to this module's interface.
Public function Const URemoteControlPreset * Get the preset currently being edited in the editor.
Public function FOnGenerateExtensions & Get the toolbar extension generators.
Public function Const uint32 Retrieves the advanced asset category type registered by Remote Control Module.
Public function Const void If a details panel is open, highlight a property specified by the path in it.
Public function FOnAddControllerExtensionColumn & Delegate called when a Remote Control Preset panel is created/opened for the specified Remote Control Preset
Public function FOnGenerateControllerExtensionsWidgets & Delegate called when a Remote Control Preset panel is created/opened for the specified Remote Control Preset
Public function FOnRemoteControlPresetOpened &  
Public function void Registers a widget factory a column in an exposed entities group row.
Public function void Registers the given settings for an exposed entities list.
Public function void Registers the given customization for an exposed entities panel.
Public function void Registers a widget factory a column in an exposed entity row.
Public function void

RegisterMetadataCustomization ( FName MetadataKey,
FOnCustomizeMetadataEntry OnCustomizeCallback
)

 Register a delegate to customize how an entry is displayed in the entity details panel.
Public function void Register the given signature customization to extend the Signature Panel capabilities like Drag/Drop handling
Public function void

RegisterWidgetFactoryForType ( UScriptStruct* RemoteControlEntityType,
const FOnGenerateRCWidget& OnGenerateRCWidgetDelegate
)

 Register a widget factory to handle creating a widget in the control panel.
Public function void

RemovePropertyFilter ( const FDelegateHandle& FilterDelegateHandle
)

 Remove a property filter using its id.
Public function Const void

SelectObjects ( const TArray< UObject* >& Objects
)

 Set the list of selected objects.
Public function void Unregisters the given widget factory.
Public function void Unregisters the given settings for an exposed entities list.
Public function void Unregisters the given exposed entities panel customization.
Public function void Unregisters the given customization for a exposed entity.
Public function void Unregister the delegate used to customize how an entry is displayed in the entity details panel.
Public function void Unregisters the given signature customization
Public function void

UnregisterWidgetFactoryForType ( UScriptStruct* RemoteControlEntityType
)

 Unregister a previously registered widget factory.

Typedefs

Name Description
FOnRemoteControlPresetOpened Delegate called when a Remote Control Preset panel is created/opened for the specified Remote Control Preset

Constants

Name Description
SettingsIniSection The section of EditorPerProjectUserSettings in which to save filter settings

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page