Navigation
API > API/Plugins > API/Plugins/BaseCharacterFXEditor
Inheritance Hierarchy
- FBaseToolkit
- TSharedFromThis
- FModeToolkit
- FBaseCharacterFXEditorModeToolkit
- FExampleCharacterFXEditorModeToolkit
References
| Module | BaseCharacterFXEditor |
| Header | /Engine/Plugins/Experimental/CharacterFXEditor/BaseCharacterFXEditor/Source/BaseCharacterFXEditor/Public/BaseCharacterFXEditorModeToolkit.h |
| Include | #include "BaseCharacterFXEditorModeToolkit.h" |
Syntax
class FBaseCharacterFXEditorModeToolkit : public FModeToolkit
Remarks
The editor mode toolkit is responsible for the panel on the side in the editor that shows mode and tool properties. Tool buttons would go in Init().
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
const FSlateBrush * | ActiveToolIcon | |
 |
FStatusBarMessageHandle | ActiveToolMessageHandle | |
 |
FText | ActiveToolName | Tool name, icon and message to display in viewport. |
 |
TSharedPtr< SBorder > | ToolDetailsContainer | A container for the tool settings that is populated by the DetailsView managed in FModeToolkit. |
 |
TSharedPtr< STextBlock > | ToolWarningArea | A place for tools to write out any warnings. |
 |
TSharedPtr< SWidget > | ViewportOverlayWidget | Contains the widget container for the Accept/Cancel buttons, etc. for tools. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Destructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | ||
  |
void | ClearWarning () |
|
   |
const FSlateBrush * | GetActiveToolIcon
(
const FString& Identifier |
Should be implemented in the concrete subclass since it will likely have to know where to look for UI resources. |
 |
void | InvalidateCachedDetailPanelState
(
UObject* ChangedObject |
|
  |
void | PostNotification
(
const FText& Message |
Set/clear notification message area |
  |
void | PostWarning
(
const FText& Message |
Set/clear warning message area |
 |
void |
Overridden from FModeToolkit
| Type | Name | Description | |
|---|---|---|---|
   |
FText | Active tool name to display in the ViewportOverlay | |
   |
FText | GetToolPaletteDisplayName
(
FName PaletteName |
Returns human readable name for the specific palette tool category |
   |
void | GetToolPaletteNames
(
TArray< FName >& InPaletteName |
Returns the Mode specific tabs in the mode toolbar |
   |
bool | Exclusive Tool Palettes only allow users to use tools from one palette at a time | |
   |
bool | Informs the built-in FModeToolkit palette building routines about how we want the toolbars to be set up | |
  |
void | Init
(
const TSharedPtr< IToolkitHost >& InitToolkitHost, |
FModeToolkit. |
  |
void | OnToolEnded
(
UInteractiveToolManager* Manager, |
|
  |
void | OnToolStarted
(
UInteractiveToolManager* Manager, |
FModeToolkit. |
Overridden from IToolkit
| Type | Name | Description | |
|---|---|---|---|
   |
TSharedPtr< class SWidget > | Returns the mode's toolbox |
Constants
| Name | Description |
|---|---|
| PaletteNames_Standard | |
| ToolsTabName | The editor can have multiple tabs in the mode toolbar. |