Navigation
API > API/Plugins > API/Plugins/BaseCharacterFXEditor
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().
| Name | FBaseCharacterFXEditorModeToolkit |
| Type | class |
| Header File | /Engine/Plugins/Experimental/CharacterFXEditor/BaseCharacterFXEditor/Source/BaseCharacterFXEditor/Public/BaseCharacterFXEditorModeToolkit.h |
| Include Path | #include "BaseCharacterFXEditorModeToolkit.h" |
Syntax
class FBaseCharacterFXEditorModeToolkit : public FModeToolkit
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FModeToolkit → FBaseCharacterFXEditorModeToolkit
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBaseCharacterFXEditorModeToolkit() |
BaseCharacterFXEditorModeToolkit.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FBaseCharacterFXEditorModeToolkit() |
BaseCharacterFXEditorModeToolkit.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| PaletteNames_Standard | const TArray< FName > | BaseCharacterFXEditorModeToolkit.h | |
| ToolsTabName | const FName | The editor can have multiple tabs in the mode toolbar. | BaseCharacterFXEditorModeToolkit.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ClearNotification() |
BaseCharacterFXEditorModeToolkit.h | ||
virtual void ClearWarning() |
BaseCharacterFXEditorModeToolkit.h | ||
virtual FText GetActiveToolDisplayName() |
Active tool name to display in the ViewportOverlay | BaseCharacterFXEditorModeToolkit.h | |
virtual TSharedPtr< class SWidget > GetInlineContent() |
Returns the mode's toolbox | BaseCharacterFXEditorModeToolkit.h | |
virtual FText GetToolPaletteDisplayName
(
FName PaletteName |
Returns human readable name for the specific palette tool category | BaseCharacterFXEditorModeToolkit.h | |
virtual void GetToolPaletteNames
(
TArray< FName >& InPaletteName |
Returns the Mode specific tabs in the mode toolbar | BaseCharacterFXEditorModeToolkit.h | |
virtual bool HasExclusiveToolPalettes() |
BaseCharacterFXEditorModeToolkit.h | ||
virtual bool HasIntegratedToolPalettes() |
Informs the built-in FModeToolkit palette building routines about how we want the toolbars to be set up | BaseCharacterFXEditorModeToolkit.h | |
virtual void Init
(
const TSharedPtr< IToolkitHost >& InitToolkitHost, |
FModeToolkit. | BaseCharacterFXEditorModeToolkit.h | |
virtual void PostNotification
(
const FText& Message |
Set/clear notification message area | BaseCharacterFXEditorModeToolkit.h | |
virtual void PostWarning
(
const FText& Message |
Set/clear warning message area | BaseCharacterFXEditorModeToolkit.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual 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. | BaseCharacterFXEditorModeToolkit.h | |
void InvalidateCachedDetailPanelState
(
UObject* ChangedObject |
BaseCharacterFXEditorModeToolkit.h | ||
virtual void OnToolEnded
(
UInteractiveToolManager* Manager, |
BaseCharacterFXEditorModeToolkit.h | ||
virtual void OnToolStarted
(
UInteractiveToolManager* Manager, |
FModeToolkit. | BaseCharacterFXEditorModeToolkit.h | |
void UpdateActiveToolProperties() |
BaseCharacterFXEditorModeToolkit.h |