Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > DMXEditor > FDMXEditor

Light Theme

Dark Theme

FDMXEditor

Windows

MacOS

Linux

Inheritance Hierarchy

FWorkflowCentricApplication

FNotifyHook

FDMXEditor

References

Module	DMXEditor
Header	/Engine/Plugins/Experimental/DigitalMultiplex/DMXEngine/Source/DMXEditor/Public/DMXEditor.h
Include	#include "DMXEditor.h"

Syntax

class FDMXEditor :
public FWorkflowCentricApplication,
public FNotifyHook

Constructors

	Name	Description
	FDMXEditor()

Destructors

	Name	Description
	~FDMXEditor()

Functions

	Name	Description
bool	CanAddNewEntity ( TSubclassOf< UDMXEntity > InEntityC... )	Checks if adding a new Entity is allowed in the current list
void	CommonInitialization ( UDMXLibrary* DMXLibrary )	Should be called when initializing
void	CreateDefaultCommands()	Create Default Commands
void	CreateDefaultTabContents ( UDMXLibrary* DMXLibrary )	Creates the widgets that go into the tabs (note: does not create the tabs themselves)
TSharedRef< ...	GetControllersTab()
UDMXLibrary ...	GetDMXLibrary()	Get the DMX library being edited
TSharedPtr< ...	GetEditorWidgetForEntityType ( TSubclassOf< UDMXEntity > InEntityC... )	Gets the content widget for the tab that edits Entities from InEntityClass
TSharedRef< ...	GetFixturePatchTab()
TSharedRef< ...	GetFixtureTypesTab()
TSharedRef< ...	GetInputConsoleTab()
FOnGetBaseNa...	GetOnGetBaseNameForNewEntity()	Called before a new Entity creation to set its base name.
FOnSetupNewE...	GetOnSetupNewEntity()	Called right after a new Entity is created, to set its values up before it gets selected and renamed.
TSharedRef< ...	GetOutputConsoleTab()
TArray< UDMX...	GetSelectedEntitiesFromTypeTab ( TSubclassOf< UDMXEntity > InEntityC... )	Get the selected entities from the tab that stores the passed in type
TSharedPtr< ...	GetToolbarBuilder()
void	InitalizeExtenders()	Called during initialization of the DMX editor to register commands and extenders.
void	InitEditor ( const EToolkitMode::Type Mode, const TSharedPtr< class IToolkitHos..., UDMXLibrary* DMXLibrary )	Edits the specified DMX library
bool	InvokeEditorTabFromEntityType ( TSubclassOf< UDMXEntity > InEntityC... )	Activate the editor tab suited to edit Entities of type InEntityClass
bool	NewEntity_IsVisibleForType ( TSubclassOf< UDMXEntity > InEntityC... )
void	OnAddNewEntity ( TSubclassOf< UDMXEntity > InEntityC... )	Adds a new Entity to this DMX Library
FReply	OnAddNewEntity_OnClick ( TSubclassOf< UDMXEntity > InEntityC... )
void	RegisterApplicationModes ( UDMXLibrary* DMXLibrary, bool bShouldOpenInDefaultsMode, bool bNewlyCreated )	Called during initialization of the DMX editor to register any application modes.
void	RegisterToolbarTab ( const TSharedRef< class FTabManager... )
void	RenameNewlyAddedEntity ( UDMXEntity* InEntity, TSubclassOf< UDMXEntity > InEntityC... )	Utility function to handle all steps required to rename a newly added Entity
void	SelectEntitiesInTypeTab ( const TArray< UDMXEntity* >& ..., ESelectInfo::Type InSelectionType )	Switch to the correct tab for the first Entity's type and select the Entities
void	SelectEntityInItsTypeTab ( UDMXEntity* InEntity, ESelectInfo::Type InSelectionType )	Switch to the correct tab to select an Entity for editing

Overridden from IToolkit

	Name	Description
FText	GetBaseToolkitName()	Returns the localized name of this toolkit type (typically just " editor")
FName	GetToolkitFName()	Returns the invariant name of this toolkit type
FLinearColor	GetWorldCentricTabColorScale()
FString	GetWorldCentricTabPrefix()	Returns the localize prefix string to use for tab labels in world-centric mode.

Constants

Name	Description
ToolkitFName	The name given to all instances of this type of editor

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss