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

* The DMX Library Editor, displayed when opening a DMX Library Asset *

Inheritance Hierarchy

FWorkflowCentricApplication

FNotifyHook

FDMXEditor

References

Module	DMXEditor
Header	/Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXEditor/Public/DMXEditor.h
Include	#include "DMXEditor.h"

Syntax

class FDMXEditor :
public FWorkflowCentricApplication,
public FNotifyHook

Remarks

*** The DMX Library Editor, displayed when opening a DMX Library Asset ***

Functions

	Name	Description
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)
UDMXLibrary ...	GetDMXLibrary()	Get the DMX library being edited
TSharedRef< ...	GetDMXLibraryEditorTab()
TSharedPtr< ...	GetEditorWidgetForEntityType ( TSubclassOf< UDMXEntity > InEntityC... )	Gets the content widget for the tab that edits Entities from InEntityClass
TSharedRef< ...	GetFixturePatchEditor()
const TShare...	GetFixturePatchSharedData()	Gets the Fixture Patch shared Data Instance
TSharedRef< ...	GetFixtureTypeEditor()
TSharedPtr< ...	GetFixtureTypeSharedData()	Gets the fixture type shared data instance
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

Deprecated Functions

	Name	Description
bool	CanAddNewEntity ( TSubclassOf< UDMXEntity > InEntityC... )	Deprecated, this always yields true.
FOnGetBaseNa...	GetOnGetBaseNameForNewEntity()	Deprecated since naming is now handled consistently when creating new entities via UDMXEntityFixtureType::CreateFixtureType or UDMXEntityFixturePatch::CreateFixturePatch.
FOnSetupNewE...	GetOnSetupNewEntity()	Deprecated in favor of UDMXLibrary::OnEntitiesAddedOrRemoved

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

Take our survey

Cancel