Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > BaseCharacterFXEditor > FBaseCharacterFXEditorToolkit

Light Theme

Dark Theme

FBaseCharacterFXEditorToolkit

The toolkit is supposed to act as the UI manager for the asset editor.

Inheritance Hierarchy

IAssetEditorInstance

FBaseToolkit

TSharedFromThis

FAssetEditorToolkit

FBaseAssetToolkit

FBaseCharacterFXEditorToolkit

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

	Name	Description
TSharedPtr< FWo...	EditorMenuCategory	A default "CharacterFXEditor" category is created in RegisterTabSpawners. Override that function to set this to a concrete class type.
TSharedPtr< FBa...	ModeUILayer	Handles the hosting of additional toolkits, such as the mode toolkit.
TUniquePtr< FPr...	ObjectScene	PreviewScene showing the objects being edited.

Constructors

	Name	Description
	FBaseCharacterFXEditorToolkit ( UAssetEditor* InOwningAssetEdi..., const FName& ModuleName )

Functions

	Name	Description
void	CreateEditorModeUILayer()	Override this to create the concrete CharacterFXEditorModeUILayer.
FEditorModeI...	GetEditorModeId()	Override this to get the Mode ID of the concrete CharacterFXEditorMode.
void	InitializeEdMode ( UBaseCharacterFXEditorMode* Ed... )	Override this to provide the EdMode with any custom data it needs.

Overridden from FBaseAssetToolkit

		Name	Description
	TSharedPtr< ...	CreateEditorViewportClient()	Called from FBaseAssetToolkit::CreateWidgets to populate ViewportClient, but otherwise only used in our own viewport delegate
	AssetEditorV...	GetViewportDelegate()

Overridden from FAssetEditorToolkit

	Name	Description
void	AddViewportOverlayWidget ( TSharedRef< SWidget > InViewportOve... )	Called when a toolkit requests an overlay widget to be added to the viewport.
bool	OnRequestClose()	Called when this toolkit is requested to close. Returns false if closing should be prevented.
void	OnToolkitHostingFinished ( const TSharedRef< IToolkit >& Tool... )	Called when another toolkit (such as a ed mode toolkit) is no longer being hosted in this asset editor toolkit.
void	OnToolkitHostingStarted ( const TSharedRef< IToolkit >& Tool... )	Called when another toolkit (such as a ed mode toolkit) is being hosted in this asset editor toolkit.
void	PostInitAssetEditor()	Perform any initialization that should happen after the basic toolkit needs are created for the asset editor.
void	RemoveViewportOverlayWidget ( TSharedRef< SWidget > InViewportOve... )	Called when a toolkit requests the overlay widget to be removed.

Overridden from FBaseToolkit

		Name	Description
	void	CreateEditorModeManager()	Called from FBaseAssetToolkit::CreateWidgets.

Overridden from IToolkit

		Name	Description
	void	RegisterTabSpawners ( const TSharedRef< FTabManager >& T... )	IToolkit interface

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel