1. Epic GamesDeveloper
  3. FDMXEditor

FDMXEditor

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

API > API/Plugins > API/Plugins/DMXEditor

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

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

Syntax

class FDMXEditor :  
    public FWorkflowCentricApplication,  
    public FNotifyHook

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FDMXEditor()

   DMXEditor.h  

Constants

Name Type Remarks Include Path
ToolkitFName const FName The name given to all instances of this type of editor DMXEditor.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AnalyticsProvider UE::DMX::FDMXEditorToolAnalyticsProvider The analytics provider for this tool DMXEditor.h  
DMXLibraryEditorTab TSharedPtr< SDMXLibraryEditorTab > UI for the "DMX Library Editor" tab DMXEditor.h  
FixturePatchEditor TSharedPtr< SDMXFixturePatchEditor > UI for the "DMX Fixture Patch" tab DMXEditor.h  
FixturePatchSharedData TSharedPtr< FDMXFixturePatchSharedData > Shared Data for Fixture Patch editors DMXEditor.h  
FixtureTypeEditor TSharedPtr< SDMXFixtureTypeEditor > UI for the "DMX Fixture Types" tab DMXEditor.h  
FixtureTypeSharedData TSharedPtr< FDMXFixtureTypeSharedData > Fixture type shared data instance DMXEditor.h  
OnGetBaseNameForNewEntity FOnGetBaseNameForNewEntity   DMXEditor.h  
OnSetupNewEntity FOnSetupNewEntity   DMXEditor.h  
Toolbar TSharedPtr< FDMXEditorToolbar > The toolbar builder class DMXEditor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanAddNewEntity ( TSubclassOf< UDMXEntity > InEntityClass
) const

   DMXEditor.h  

void CommonInitialization ( UDMXLibrary* DMXLibrary
)

 Should be called when initializing DMXEditor.h  

virtual FText GetBaseToolkitName()

   DMXEditor.h  

UDMXLibrary * GetDMXLibrary()

 Get the DMX library being edited DMXEditor.h  

TSharedRef< SDMXLibraryEditorTab > GetDMXLibraryEditorTab()

   DMXEditor.h  

TSharedPtr< SDMXEntityEditor > GetEditorWidgetForEntityType ( TSubclassOf< UDMXEntity > InEntityClass
) const

 Gets the content widget for the tab that edits Entities from InEntityClass DMXEditor.h  

TSharedRef< SDMXFixturePatchEditor > GetFixturePatchEditor()

   DMXEditor.h  

const TSharedPtr< FDMXFixturePatchSharedData > & GetFixturePatchSharedData()

 Gets the Fixture Patch shared Data Instance DMXEditor.h  

TSharedRef< SDMXFixtureTypeEditor > GetFixtureTypeEditor()

   DMXEditor.h  

TSharedPtr< FDMXFixtureTypeSharedData > GetFixtureTypeSharedData()

 Gets the fixture type shared data instance DMXEditor.h  

FOnGetBaseNameForNewEntity & GetOnGetBaseNameForNewEntity()

   DMXEditor.h  

FOnSetupNewEntity & GetOnSetupNewEntity()

   DMXEditor.h  

TArray< UDMXEntity * > GetSelectedEntitiesFromTypeTab ( TSubclassOf< UDMXEntity > InEntityClass
) const

 Get the selected entities from the tab that stores the passed in type DMXEditor.h  

TSharedPtr< FDMXEditorToolbar > GetToolbarBuilder()

   DMXEditor.h  

virtual FName GetToolkitFName()

   DMXEditor.h  

virtual FLinearColor GetWorldCentricTabColorScale()

   DMXEditor.h  

virtual FString GetWorldCentricTabPrefix()

   DMXEditor.h  

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

 Edits the specified DMX library DMXEditor.h  

bool InvokeEditorTabFromEntityType ( TSubclassOf< UDMXEntity > InEntityClass
)

 Activate the editor tab suited to edit Entities of type InEntityClass DMXEditor.h  

bool NewEntity_IsVisibleForType ( TSubclassOf< UDMXEntity > InEntityClass
) const

   DMXEditor.h  

void OnAddNewEntity ( TSubclassOf< UDMXEntity > InEntityClass
)

 Adds a new Entity to this DMX Library DMXEditor.h  

FReply OnAddNewEntity_OnClick ( TSubclassOf< UDMXEntity > InEntityClass
)

   DMXEditor.h  

void RegisterToolbarTab ( const TSharedRef< class FTabManager >& TabManager
)

   DMXEditor.h  

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

 Utility function to handle all steps required to rename a newly added Entity DMXEditor.h  

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

 Switch to the correct tab for the first Entity's type and select the Entities DMXEditor.h  

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

 Switch to the correct tab to select an Entity for editing DMXEditor.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void CreateDefaultCommands()

 Create Default Commands DMXEditor.h  

virtual void CreateDefaultTabContents ( UDMXLibrary* DMXLibrary
)

 Creates the widgets that go into the tabs (note: does not create the tabs themselves) DMXEditor.h  

virtual void InitalizeExtenders()

 Called during initialization of the DMX editor to register commands and extenders. DMXEditor.h  

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

 Called during initialization of the DMX editor to register any application modes. DMXEditor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page