1. Epic GamesDeveloper
  3. FDMXEditorModule

FDMXEditorModule

Implements the DMX Editor Module.

API > API/Plugins > API/Plugins/DMXEditor

Implements the DMX Editor Module.

   
Name FDMXEditorModule
Type class
Header File /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXEditor/Public/DMXEditorModule.h
Include Path #include "DMXEditorModule.h"

Syntax

class FDMXEditorModule :  
    public IModuleInterface ,  
    public IHasMenuExtensibility,  
    public IHasToolBarExtensibility

Implements Interfaces

Constants

Name Type Remarks Include Path
DMXEditorAppIdentifier const FName DataTable Editor app identifier string DMXEditorModule.h
DMXEditorAssetCategory EAssetTypeCategories::Type The DMX Editor asset category DMXEditorModule.h
LevelEditorToolbarDMXMenuExtender TSharedPtr< FExtender > Extender for the Level Editor Toolbar Menu DMXEditorModule.h
ModuleName const FName The module DMX Editor Module name DMXEditorModule.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
MenuExtensibilityManager TSharedPtr< FExtensibilityManager >   DMXEditorModule.h  
ToolBarExtensibilityManager TSharedPtr< FExtensibilityManager >   DMXEditorModule.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
DMXLevelEditorMenuCommands TSharedPtr< class FUICommandList > Command list for the DMX level editor menu DMXEditorModule.h  
PIEManager TUniquePtr< FDMXPIEManager > Helper to track when the editor is in PIE DMXEditorModule.h  
RegisteredAssetTypeActions TArray< TSharedPtr< IAssetTypeActions > > All created asset type actions that must be unregistered when the module shuts down DMXEditorModule.h  
RegisteredClassNames TSet< FName > List of registered class that must be unregistered when the module shuts down DMXEditorModule.h  
RegisteredNomadTabNames TSet< FName > Names of all registered nomad tabs DMXEditorModule.h  
RegisteredPropertyTypes TSet< FName > List of registered property types that must be unregistered when the module shuts down DMXEditorModule.h  
RegisteredSequencerTrackHandles TSet< FDelegateHandle > All custom sequencer track handles DMXEditorModule.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedRef< FDMXEditor > CreateEditor ( const EToolkitMode::Type Mode,
const TSharedPtr< class IToolkitHost >& InitToolkitHost,
UDMXLibrary* DMXLibrary
)

 Creates an instance of a DMX Library editor object. DMXEditorModule.h  

void ExportDMXLibraryAsMVRFile ( UDMXLibrary* DMXLibrary,
const FString& DesiredName
) const

 Exports a DMX Library as MVR file DMXEditorModule.h  

TSharedPtr< FExtender > GetLevelEditorToolbarDMXMenuExtender()

 Get Level Editor Toolbar Menu extender DMXEditorModule.h  

virtual TSharedPtr< FExtensibilityManager > GetMenuExtensibilityManager()

   DMXEditorModule.h  

virtual TSharedPtr< FExtensibilityManager > GetToolBarExtensibilityManager()

   DMXEditorModule.h  

Overridden from IModuleInterface

Name Remarks Include Path Unreal Specifiers

virtual void ShutdownModule()

   DMXEditorModule.h  

virtual void StartupModule()

   DMXEditorModule.h  

Protected

Name Remarks Include Path Unreal Specifiers

void RegisterAssetTypeActions()

 Registers asset types actions DMXEditorModule.h  

void RegisterAssetTypeCategories()

 Registers asset types categories DMXEditorModule.h  

void RegisterClassCustomizations()

 Registers global class customizations DMXEditorModule.h  

void RegisterNomadTabSpawners()

 Registers nomad tab spawners DMXEditorModule.h  

void RegisterPropertyTypeCustomizations()

 Registers global property type customizations DMXEditorModule.h  

void RegisterSequencerTypes()

 Registers sequencer related types DMXEditorModule.h  

void StartupPIEManager()

 Starts up the pie manager DMXEditorModule.h  

Static

Name Remarks Include Path Unreal Specifiers

static void FixGDTFAssetNames ()

 Before 5.4, GDTF assets could be stored containing invalid characters such as @ common to most GDTFs. DMXEditorModule.h  

static TSharedRef< class SWidget > GenerateDMXLevelEditorToolbarMenu()

 Generates the level editor toolbar DMX Menu DMXEditorModule.h  

static FDMXEditorModule & Get()

 Get the instance of this module. DMXEditorModule.h  

static EAssetTypeCategories::Type GetAssetCategory()

   DMXEditorModule.h  

static bool IsReceiveDMXEnabled()

 Returns true if receive dmx is enabled DMXEditorModule.h  

static bool IsSendDMXEnabled()

 Returns true if send dmx is enabled DMXEditorModule.h  

static TSharedRef< class SDockTab > OnSpawnActivityMonitorTab ( const FSpawnTabArgs& InSpawnTabArgs
)

 Called when the nomad tab spawner tries to spawn an activity monitor tab DMXEditorModule.h  

static TSharedRef< class SDockTab > OnSpawnChannelsMonitorTab ( const FSpawnTabArgs& InSpawnTabArgs
)

 Called when the nomad tab spawner tries to spawn a channels monitor tab DMXEditorModule.h  

static TSharedRef< class SDockTab > OnSpawnConflictMonitorTab ( const FSpawnTabArgs& InSpawnTabArgs
)

 Called when the nomad tab spawner tries to spawn an activity monitor tab DMXEditorModule.h  

static TSharedRef< class SDockTab > OnSpawnPatchToolTab ( const FSpawnTabArgs& InSpawnTabArgs
)

 Called when the nomad tab spawner tries to spawn a patch tool tab DMXEditorModule.h  

static void OnToggleReceiveDMX()

 Called when the Toggle Receive DMX menu command is selected DMXEditorModule.h  

static void OnToggleSendDMX()

 Called when the Toggle Receive DMX menu command is selected DMXEditorModule.h  

static void OpenActivityMonitor()

 Opens the activity monitor DMXEditorModule.h  

static void OpenChannelsMonitor()

 Opens the channel monitor DMXEditorModule.h  

static void OpenConflictMonitor()

 Opens the conflict monitor DMXEditorModule.h  

static void OpenPatchTool()

 Opens the patch tool DMXEditorModule.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page