Navigation
API > API/Plugins > API/Plugins/DMXEditor
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
| Type | Name | Description | |
|---|---|---|---|
 |
void | CommonInitialization
(
UDMXLibrary* DMXLibrary |
Should be called when initializing |
  |
void | Create Default Commands | |
  |
void | CreateDefaultTabContents
(
UDMXLibrary* DMXLibrary |
Creates the widgets that go into the tabs (note: does not create the tabs themselves) |
  |
UDMXLibrary * | Get the DMX library being edited | |
  |
TSharedRef< SDMXLibraryEditorTab > | ||
  |
TSharedPtr< SDMXEntityEditor > | GetEditorWidgetForEntityType
(
TSubclassOf< UDMXEntity > InEntityClass |
Gets the content widget for the tab that edits Entities from InEntityClass |
  |
TSharedRef< SDMXFixturePatchEditor > | ||
  |
const TSharedPtr< FDMXFixturePatchSharedData > & | Gets the Fixture Patch shared Data Instance | |
  |
TSharedRef< SDMXFixtureTypeEditor > | ||
  |
TSharedPtr< FDMXFixtureTypeSharedData > | Gets the fixture type shared data instance | |
  |
TArray< UDMXEntity * > | GetSelectedEntitiesFromTypeTab
(
TSubclassOf< UDMXEntity > InEntityClass |
Get the selected entities from the tab that stores the passed in type |
 |
TSharedPtr< FDMXEditorToolbar > | ||
  |
void | Called during initialization of the DMX editor to register commands and extenders. | |
  |
void | InitEditor
(
const EToolkitMode::Type Mode, |
Edits the specified DMX library |
 |
bool | InvokeEditorTabFromEntityType
(
TSubclassOf< UDMXEntity > InEntityClass |
Activate the editor tab suited to edit Entities of type InEntityClass |
  |
bool | NewEntity_IsVisibleForType
(
TSubclassOf< UDMXEntity > InEntityClass |
|
 |
void | OnAddNewEntity
(
TSubclassOf< UDMXEntity > InEntityClass |
Adds a new Entity to this DMX Library |
 |
FReply | OnAddNewEntity_OnClick
(
TSubclassOf< UDMXEntity > InEntityClass |
|
  |
void | RegisterApplicationModes
(
UDMXLibrary* DMXLibrary, |
Called during initialization of the DMX editor to register any application modes. |
 |
void | RegisterToolbarTab
(
const TSharedRef< class FTabManager >& TabManager |
|
 |
void | RenameNewlyAddedEntity
(
UDMXEntity* InEntity, |
Utility function to handle all steps required to rename a newly added Entity |
 |
void | SelectEntitiesInTypeTab
(
const TArray< UDMXEntity* >& InEntities, |
Switch to the correct tab for the first Entity's type and select the Entities |
 |
void | SelectEntityInItsTypeTab
(
UDMXEntity* InEntity, |
Switch to the correct tab to select an Entity for editing |
Overridden from IToolkit
| Type | Name | Description | |
|---|---|---|---|
   |
FText | Returns the localized name of this toolkit type (typically just " |
|
   |
FName | Returns the invariant name of this toolkit type | |
   |
FLinearColor | ||
   |
FString | 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
| Type | Name | Description | |
|---|---|---|---|
  |
bool | CanAddNewEntity
(
TSubclassOf< UDMXEntity > InEntityClass |
Deprecated, this always yields true. |
 |
FOnGetBaseNameForNewEntity & | Deprecated since naming is now handled consistently when creating new entities via UDMXEntityFixtureType::CreateFixtureType or UDMXEntityFixturePatch::CreateFixturePatch. | |
 |
FOnSetupNewEntity & | Deprecated in favor of UDMXLibrary::OnEntitiesAddedOrRemoved |