FModeToolkit

This [FModeToolkit](API\Editor\UnrealEd\Toolkits\FModeToolkit) just creates a basic UI panel that allows various InteractiveTools to be initialized, and a DetailsView used to show properties of the active Tool.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Public/Toolkits/BaseToolkit.h

Include

#include "Toolkits/BaseToolkit.h"

Syntax

class FModeToolkit :
    public FBaseToolkit,
    public TSharedFromThis< FModeToolkit >

Remarks

This FModeToolkit just creates a basic UI panel that allows various InteractiveTools to be initialized, and a DetailsView used to show properties of the active Tool.

Variables

Name Description

Protected variable

TArray< FEdMode...

 

ActiveToolBarRows

All toolbar rows generated by active modes.

Protected variable

TArray< TShared...

 

CreatedTabs

Protected variable

FName

 

CurrentPaletteName

Protected variable

TSharedPtr< IDe...

 

DetailsView

Protected variable

TSharedPtr< SBo...

 

InlineContentHolder

Inline content area for editor modes

Protected variable

TSharedPtr< IDe...

 

ModeDetailsView

Protected variable

TWeakPtr< SVert...

 

ModeToolbarBox

The actual toolbar rows will be placed in this vertical box

Protected variable

TSharedPtr< SBo...

 

ModeToolBarContainer

The container holding the mode toolbar

Protected variable

TWeakPtr< SWidg...

 

ModeToolbarPaletteSwitcher

The modes palette toolbar

Protected variable

TWeakPtr< SDock...

 

ModeToolbarTab

The dock tab for any modes that generate a toolbar

Protected variable

TSharedPtr< SBo...

 

ModeToolHeader

The active tool header area

Protected variable

TWeakPtr< FAsse...

 

ModeUILayer

Protected variable

FOnPaletteChang...

 

OnPaletteChangedDelegate

Protected variable

TWeakObjectPtr<...

 

OwningEditorMode

Protected variable

TWeakPtr< SDock...

 

PrimaryTab

Protected variable

FMinorTabConfig

 

PrimaryTabInfo

Protected variable

FMinorTabConfig

 

ToolbarInfo

Protected variable

TSharedPtr< SWi...

 

ToolkitWidget

Destructors

Name Description

Public function

~FModeToolkit()

Functions

Name Description

Public function Virtual

void

 

BuildToolPalette

(
    FName Palette,
    FToolBarBuilder& ToolbarBuilder
)

Protected function

TSharedRef< ...

 

CreatePrimaryModePanel

(
    const FSpawnTabArgs& Args
)

Protected function Virtual

void

 

CustomizeDetailsViewArgs

(
    FDetailsViewArgs& ArgsInOut
)

Protected function Virtual

void

 

CustomizeModeDetailsViewArgs

(
    FDetailsViewArgs& ArgsInOut
)

Public function Virtual Const

FText

 

GetActiveToolDisplayName()

Public function Virtual Const

FText

 

GetActiveToolMessage()

Public function Const

FName

 

GetCurrentPalette()

Public function Virtual Const

FEdMode *...

 

GetEditorMode()

Public function Virtual Const

FText

 

GetEditorModeDisplayName()

Public function Virtual Const

FSlateIcon

 

GetEditorModeIcon()

Protected function Const

const FEdito...

 

GetEditorModeInfo()

Protected function Const

EVisibility

 

GetInlineContentHolderVisibility()

Protected function Const

EVisibility

 

GetNoToolSelectedTextVisibility()

Public function Virtual Const

TWeakObjectP...

 

GetScriptableEditorMode()

Public function Virtual Const

FText

 

GetToolPaletteDisplayName

(
    FName Palette
)

Public function Virtual Const

void

 

GetToolPaletteNames

(
    TArray< FName >& PaletteNames
)

Returns the number of Mode specific tabs in the mode toolbar

Public function Virtual Const

bool

 

HasExclusiveToolPalettes()

Exclusive Tool Palettes only allow users to use tools from one palette at a time

Public function Virtual Const

bool

 

HasIntegratedToolPalettes()

Integrated Tool Palettes show up in the same panel as their details

Public function Virtual

void

 

Init

(
    const TSharedPtr< IToolkitHost >& ...
)

Initializes the mode toolkit

Public function Virtual

void

 

Init

(
    const TSharedPtr< IToolkitHost >& ...,
    TWeakObjectPtr< UEdMode > InOwningM...
)

Initializes the mode toolkit

Public function Virtual

void

 

InvokeUI()

Protected function

TSharedRef< ...

 

MakeModeToolbarTab

(
    const FSpawnTabArgs& Args
)

Creates the mode toolbar tab if needed

Protected function

void

 

OnModeIDChanged

(
    const FEditorModeID& InID,
    bool bIsEntering
)

Public function

FOnPaletteCh...

 

OnPaletteChanged()

Protected function Virtual

void

 

OnToolEnded

(
    UInteractiveToolManager* Manag...,
    UInteractiveTool* Tool
)

Public function Virtual

void

 

OnToolPaletteChanged

(
    FName PaletteName
)

Protected function Virtual

void

 

OnToolStarted

(
    UInteractiveToolManager* Manag...,
    UInteractiveTool* Tool
)

Protected function

void

 

RebuildModeToolBar()

Protected function Virtual

void

 

RequestModeUITabs()

Public function

void

 

SetCurrentPalette

(
    FName InName
)

Public function

void

 

SetModeSettingsObject

(
    UObject* InSettingsObject
)

Protected function Const

bool

 

ShouldShowModeToolbar()

Whether or not the mode toolbar should be shown.

Protected function

void

 

SpawnOrUpdateModeToolbar()

Protected function

void

 

UpdatePrimaryModePanel()

Overridden from IToolkit

Name Description

Public function Virtual Const

FText

 

GetBaseToolkitName()

Returns the localized name of this toolkit type (typically just " editor")

Public function Virtual Const

FEditorModeT...

 

GetEditorModeManager()

Gets the mode manager for this toolkit

Public function Virtual Const

TSharedPtr< ...

 

GetInlineContent()

Public function Virtual Const

const TArray...

 

GetObjectsCurrentlyBeingEdited()

For asset editor toolkits, returns the UObjects for the assets currently being edited

Public function Virtual Const

FName

 

GetToolkitFName()

Returns the invariant name of this toolkit type

Public function Virtual Const

FText

 

GetToolkitName()

Returns the localized name of this toolkit

Public function Virtual Const

FText

 

GetToolkitToolTipText()

Returns the localized tooltip text of this toolkit

Public function Virtual Const

FLinearColor

 

GetWorldCentricTabColorScale()

Public function Virtual Const

FString

 

GetWorldCentricTabPrefix()

Returns the localize prefix string to use for tab labels in world-centric mode.

Public function Virtual Const

bool

 

IsAssetEditor()

Returns true if this toolkit is used to edit assets (even if it's not necessarily editing one right now.)

Public function Virtual

void

 

RegisterTabSpawners

(
    const TSharedRef< FTabManager >& T...
)

Register tabs that this toolkit can spawn with the TabManager

Public function Virtual

void

 

SetModeUILayer

(
    const TSharedPtr< FAssetEditorModeU...
)

Public function Virtual

void

 

UnregisterTabSpawners

(
    const TSharedRef< FTabManager >& T...
)

Unregister tabs that this toolkit can spawn

Classes

Name

Description

Protected struct

FEdModeToolbarRow

Typedefs

Name

Description

FOnPaletteChanged