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

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

   
Name IRemoteControlUIModule
Type class
Header File /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControlUI/Public/IRemoteControlUIModule.h
Include Path #include "IRemoteControlUIModule.h"

Syntax

class IRemoteControlUIModule : public IModuleInterface

Implements Interfaces

Typedefs

Name Type Remarks Include Path
FOnRemoteControlPresetOpened TMulticastDelegate_OneParam< void, URemoteControlPreset * > Delegate called when a Remote Control Preset panel is created/opened for the specified Remote Control Preset IRemoteControlUIModule.h

Constants

Name Type Remarks Include Path
SettingsIniSection const FString The section of EditorPerProjectUserSettings in which to save filter settings IRemoteControlUIModule.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

FDelegateHandle AddPropertyFilter ( FOnDisplayExposeIcon OnDisplayExposeIcon
)

 Add a property filter that indicates if the property handle should be displayed or not. IRemoteControlUIModule.h  

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

 Tries to retrieve a Custom Controller Widget for the specified Controller IRemoteControlUIModule.h  

URemoteControlPreset * GetActivePreset()

 Get the preset currently being edited in the editor. IRemoteControlUIModule.h  

FOnGenerateExtensions & GetExtensionGenerators ()

 Get the toolbar extension generators. IRemoteControlUIModule.h  

uint32 GetRemoteControlAssetCategory()

 Retrieves the advanced asset category type registered by Remote Control Module. IRemoteControlUIModule.h  

void HighlightPropertyInDetailsPanel ( const FPropertyPath& Path
) const

 If a details panel is open, highlight a property specified by the path in it. IRemoteControlUIModule.h  

FOnAddControllerExtensionColumn & OnAddControllerExtensionColumn()

 Delegate called when a Remote Control Preset panel is created/opened for the specified Remote Control Preset IRemoteControlUIModule.h  

FOnGenerateControllerExtensionsWidgets & OnGenerateControllerExtensionsWidgets()

 Delegate called when a Remote Control Preset panel is created/opened for the specified Remote Control Preset IRemoteControlUIModule.h  

FOnRemoteControlPresetOpened & OnRemoteControlPresetOpened()

   IRemoteControlUIModule.h  

void RegisterExposedEntitiesGroupWidgetFactory ( const TSharedRef< IRCPanelExposedEntitiesGroupWidgetFactory >& InFactory
)

 Registers a widget factory a column in an exposed entities group row. IRemoteControlUIModule.h  

void RegisterExposedEntitiesListSettingsForProtocol ( const TSharedRef< IRCPanelExposedEntitiesListSettingsForProtocol >& InSettings
)

 Registers the given settings for an exposed entities list. IRemoteControlUIModule.h  

void RegisterExposedEntitiesPanelExtender ( const TSharedRef< IRCExposedEntitiesPanelExtender >& InExtender
)

 Registers the given customization for an exposed entities panel. IRemoteControlUIModule.h  

void RegisterExposedEntityWidgetFactory ( const TSharedRef< IRCPanelExposedEntityWidgetFactory >& InFactory
)

 Registers a widget factory a column in an exposed entity row. IRemoteControlUIModule.h  

void RegisterMetadataCustomization ( FName MetadataKey,
FOnCustomizeMetadataEntry OnCustomizeCallback
)

 Register a delegate to customize how an entry is displayed in the entity details panel. IRemoteControlUIModule.h  

void RegisterPropertyResolver ( FName InResolverId,
const FRCPropertyResolver& InResolver
)

 Registers a property source resolution callback. IRemoteControlUIModule.h  

void RegisterSignatureCustomization ( const TSharedPtr< IRCSignatureCustomization >& InCustomization
)

 Register the given signature customization to extend the Signature Panel capabilities like Drag/Drop handling IRemoteControlUIModule.h  

void RegisterWidgetFactoryForType ( UScriptStruct* RemoteControlEntityType,
const FOnGenerateRCWidget& OnGenerateRCWidgetDelegate
)

 Register a widget factory to handle creating a widget in the control panel. IRemoteControlUIModule.h  

void RemovePropertyFilter ( const FDelegateHandle& FilterDelegateHandle
)

 Remove a property filter using its id. IRemoteControlUIModule.h  

void SelectObjects ( const TArray< UObject* >& Objects
) const

 Set the list of selected objects. IRemoteControlUIModule.h  

void UnregisterExposedEntitiesGroupWidgetFactory ( const TSharedRef< IRCPanelExposedEntitiesGroupWidgetFactory >& InFactory
)

 Unregisters the given widget factory. IRemoteControlUIModule.h  

void UnregisterExposedEntitiesListSettingsForProtocol ( const TSharedRef< IRCPanelExposedEntitiesListSettingsForProtocol >& InSettings
)

 Unregisters the given settings for an exposed entities list. IRemoteControlUIModule.h  

void UnregisterExposedEntitiesPanelExtender ( const TSharedRef< IRCExposedEntitiesPanelExtender >& InExtender
)

 Unregisters the given exposed entities panel customization. IRemoteControlUIModule.h  

void UnregisterExposedEntityWidgetFactory ( const TSharedRef< IRCPanelExposedEntityWidgetFactory >& InFactory
)

 Unregisters the given customization for a exposed entity. IRemoteControlUIModule.h  

void UnregisterMetadataCustomization ( FName MetadataKey
)

 Unregister the delegate used to customize how an entry is displayed in the entity details panel. IRemoteControlUIModule.h  

void UnregisterPropertyResolver ( FName InResolverId
)

 Unregisters a property source resolution callback. IRemoteControlUIModule.h  

void UnregisterSignatureCustomization ( const TSharedPtr< IRCSignatureCustomization >& InCustomization
)

 Unregisters the given signature customization IRemoteControlUIModule.h  

void UnregisterWidgetFactoryForType ( UScriptStruct* RemoteControlEntityType
)

 Unregister a previously registered widget factory. IRemoteControlUIModule.h  

Static

Name Remarks Include Path Unreal Specifiers
Singleton-like access to this module's interface. IRemoteControlUIModule.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page