1. Epic GamesDeveloper
  3. FDMXEditor

FDMXEditor

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

Unreal Engine C++ API Reference > Plugins > DMXEditor

Inheritance Hierarchy

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 ***

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const bool

CanAddNewEntity ( TSubclassOf< UDMXEntity > InEntityClass
)

  
Public function void Should be called when initializing
Protected function Virtual void Create Default Commands
Protected function Virtual void Creates the widgets that go into the tabs (note: does not create the tabs themselves)
Public function Virtual Const FText  
Public function Const UDMXLibrary * Get the DMX library being edited
Public function Const TSharedRef< SDMXLibraryEditorTab >  
Public function Const TSharedPtr< SDMXEntityEditor > Gets the content widget for the tab that edits Entities from InEntityClass
Public function Const TSharedRef< SDMXFixturePatchEditor >  
Public function Const const TSharedPtr< FDMXFixturePatchSharedData > & Gets the Fixture Patch shared Data Instance
Public function Const TSharedRef< SDMXFixtureTypeEditor >  
Public function Const TSharedPtr< FDMXFixtureTypeSharedData > Gets the fixture type shared data instance
Public function FOnGetBaseNameForNewEntity &  
Public function FOnSetupNewEntity &  
Public function Const TArray< UDMXEntity * > Get the selected entities from the tab that stores the passed in type
Public function TSharedPtr< FDMXEditorToolbar >  
Public function Virtual Const FName  
Public function Virtual Const FLinearColor  
Public function Virtual Const FString  
Protected function Virtual void Called during initialization of the DMX editor to register commands and extenders.
Public function Virtual void

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

 Edits the specified DMX library
Public function bool Activate the editor tab suited to edit Entities of type InEntityClass
Public function Const bool  
Public function void

OnAddNewEntity ( TSubclassOf< UDMXEntity > InEntityClass
)

 Adds a new Entity to this DMX Library
Public function FReply  
Protected function Virtual void

RegisterApplicationModes ( UDMXLibrary* DMXLibrary,
bool bShouldOpenInDefaultsMode,
bool bNewlyCreated
)

 Called during initialization of the DMX editor to register any application modes.
Public function void

RegisterToolbarTab ( const TSharedRef< class FTabManager >& TabManager
)

  
Public function void

RenameNewlyAddedEntity ( UDMXEntity* InEntity,
TSubclassOf< UDMXEntity > InEntityClass
)

 Utility function to handle all steps required to rename a newly added Entity
Public function void

SelectEntitiesInTypeTab ( const TArray< UDMXEntity* >& InEntities,
ESelectInfo::Type InSelectionType
)

 Switch to the correct tab for the first Entity's type and select the Entities
Public function void

SelectEntityInItsTypeTab ( UDMXEntity* InEntity,
ESelectInfo::Type InSelectionType
)

 Switch to the correct tab to select an Entity for editing

Constants

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page