Navigation
API > API/Plugins > API/Plugins/BaseCharacterFXEditor
Inheritance Hierarchy
- FBaseAssetToolkit
- FBaseCharacterFXEditorToolkit
- FDataflowEditorToolkit
- FExampleCharacterFXEditorToolkit
References
| Module | BaseCharacterFXEditor |
| Header | /Engine/Plugins/Experimental/CharacterFXEditor/BaseCharacterFXEditor/Source/BaseCharacterFXEditor/Public/BaseCharacterFXEditorToolkit.h |
| Include | #include "BaseCharacterFXEditorToolkit.h" |
Syntax
class FBaseCharacterFXEditorToolkit : public FBaseAssetToolkit
Remarks
The toolkit is supposed to act as the UI manager for the asset editor. It's responsible for setting up viewports and most toolbars, except for the internals of the mode panel. However, because the toolkit also sets up the mode manager, and much of the important state is held in the mode managed by the mode manager, the toolkit also ends up initializing the mode. Thus, the FBaseCharacterFXEditorToolkit ends up being the central place for the CharacterFX Asset Editor setup.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
bool | bForceViewportTab | Boolean to force the construction of the viewport tab even if the layout is not adding it. |
 |
TSharedPtr< FWorkspaceItem > | EditorMenuCategory | A default "CharacterFXEditor" category is created in RegisterTabSpawners. Override that function to set this to a concrete class type. |
 |
TSharedPtr< FBaseCharacterFXEditorModeUILayer > | ModeUILayer | Handles the hosting of additional toolkits, such as the mode toolkit. |
 |
TUniquePtr< FPreviewScene > | ObjectScene | PreviewScene showing the objects being edited. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FBaseCharacterFXEditorToolkit
(
UAssetEditor* InOwningAssetEditor, |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | AddViewportOverlayWidget
(
TSharedRef< SWidget > InViewportOverlayWidget, |
|
  |
void | Called from FBaseAssetToolkit::CreateWidgets. | |
  |
void | Override this to create the concrete CharacterFXEditorModeUILayer. | |
   |
TSharedPtr< FEditorViewportClient > | Called from FBaseAssetToolkit::CreateWidgets to populate ViewportClient, but otherwise only used in our own viewport delegate | |
   |
FEditorModeID | Override this to get the Mode ID of the concrete CharacterFXEditorMode. | |
  |
AssetEditorViewportFactoryFunction | ||
  |
void | InitializeEdMode
(
UBaseCharacterFXEditorMode* EdMode |
Override this to provide the EdMode with any custom data it needs. |
  |
bool | OnRequestClose
(
EAssetEditorCloseReason InCloseReason |
|
  |
void | OnToolkitHostingFinished
(
const TSharedRef< IToolkit >& Toolkit |
|
  |
void | OnToolkitHostingStarted
(
const TSharedRef< IToolkit >& Toolkit |
|
  |
void | ||
  |
void | RegisterTabSpawners
(
const TSharedRef< FTabManager >& InTabManager |
|
  |
void | RemoveViewportOverlayWidget
(
TSharedRef< SWidget > InViewportOverlayWidget |