FDMXEditor

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

Choose your operating system:

Windows

macOS

Linux

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

Functions

Name Description

Public function

void

 

CommonInitialization

(
    UDMXLibrary* DMXLibrary
)

Should be called when initializing

Protected function Virtual

void

 

CreateDefaultCommands()

Create Default Commands

Protected function Virtual

void

 

CreateDefaultTabContents

(
    UDMXLibrary* DMXLibrary
)

Creates the widgets that go into the tabs (

does not create the tabs themselves)

Public function Const

UDMXLibrary ...

 

GetDMXLibrary()

Get the DMX library being edited

Public function Const

TSharedRef< ...

 

GetDMXLibraryEditorTab()

Public function Const

TSharedPtr< ...

 

GetEditorWidgetForEntityType

(
    TSubclassOf< UDMXEntity > InEntityC...
)

Gets the content widget for the tab that edits Entities from InEntityClass

Public function Const

TSharedRef< ...

 

GetFixturePatchEditor()

Public function Const

const TShare...

 

GetFixturePatchSharedData()

Gets the Fixture Patch shared Data Instance

Public function Const

TSharedRef< ...

 

GetFixtureTypeEditor()

Public function Const

TSharedPtr< ...

 

GetFixtureTypeSharedData()

Gets the fixture type shared data instance

Public function Const

TArray< UDMX...

 

GetSelectedEntitiesFromTypeTab

(
    TSubclassOf< UDMXEntity > InEntityC...
)

Get the selected entities from the tab that stores the passed in type

Public function

TSharedPtr< ...

 

GetToolbarBuilder()

Protected function Virtual

void

 

InitalizeExtenders()

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

Public function Virtual

void

 

InitEditor

(
    const EToolkitMode::Type Mode,
    const TSharedPtr< class IToolkitHos...,
    UDMXLibrary* DMXLibrary
)

Edits the specified DMX library

Public function

bool

 

InvokeEditorTabFromEntityType

(
    TSubclassOf< UDMXEntity > InEntityC...
)

Activate the editor tab suited to edit Entities of type InEntityClass

Public function Const

bool

 

NewEntity_IsVisibleForType

(
    TSubclassOf< UDMXEntity > InEntityC...
)

Public function

void

 

OnAddNewEntity

(
    TSubclassOf< UDMXEntity > InEntityC...
)

Adds a new Entity to this DMX Library

Public function

FReply

 

OnAddNewEntity_OnClick

(
    TSubclassOf< UDMXEntity > InEntityC...
)

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...
)

Public function

void

 

RenameNewlyAddedEntity

(
    UDMXEntity* InEntity,
    TSubclassOf< UDMXEntity > InEntityC...
)

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

Public function

void

 

SelectEntitiesInTypeTab

(
    const TArray< UDMXEntity* >& ...,
    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

Overridden from IToolkit

Name Description

Public function Virtual Const

FText

 

GetBaseToolkitName()

Returns the localized name of this toolkit type (typically just " editor")

Public function Virtual Const

FName

 

GetToolkitFName()

Returns the invariant name of this toolkit type

Public function Virtual Const

FLinearColor

 

GetWorldCentricTabColorScale()

Public function Virtual Const

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

Public function Const

bool

 

CanAddNewEntity

(
    TSubclassOf< UDMXEntity > InEntityC...
)

Deprecated, this always yields true.

Public function

FOnGetBaseNa...

 

GetOnGetBaseNameForNewEntity()

Deprecated since naming is now handled consistently when creating new entities via UDMXEntityFixtureType::CreateFixtureType or UDMXEntityFixturePatch::CreateFixturePatch.

Public function

FOnSetupNewE...

 

GetOnSetupNewEntity()

Deprecated in favor of UDMXLibrary::OnEntitiesAddedOrRemoved