1. Epic GamesDeveloper
  3. FAssetEditorToolkit

FAssetEditorToolkit

Base class for toolkits that are used for asset editing (abstract)

API > API/Editor > API/Editor/UnrealEd > API/Editor/UnrealEd/Toolkits

Inheritance Hierarchy

References

   
Module UnrealEd
Header /Engine/Source/Editor/UnrealEd/Public/Toolkits/AssetEditorToolkit.h
Include #include "Toolkits/AssetEditorToolkit.h"

Syntax

class FAssetEditorToolkit :  
    public IAssetEditorInstance,  
    public FBaseToolkit,  
    public TSharedFromThis< FAssetEditorToolkit >

Remarks

Base class for toolkits that are used for asset editing (abstract)

Variables

  Type Name Description
Protected variable TSharedPtr< FWorkspaceItem > AssetEditorTabsCategory The base category that tabs are registered to, allows for child classes to register to the same point.
Protected variable bool bCheckDirtyOnAssetSave Whether only dirty assets should be prompted about on save - otherwise all edited assets will be prompted to the user for save/check-out
Protected variable TSharedPtr< FEditorModeTools > EditorModeManager The editor mode manager
Protected variable TArray< TSharedPtr< FLayoutExtender > > LayoutExtenders Array of layout extenders
Protected variable TWeakPtr< IToolkitHost > PreviousWorldCentricToolkitHost For standalone asset editing tool-kits that were switched from world-centric mode on the fly, this stores the toolkit host (level editor) that hosted this toolkit last.
Protected variable TSharedPtr< FTabManager > TabManager Controls our internal layout

Constructors

  Type Name Description
Public function   Default constructor
Public function    

Destructors

  Type Name Description
Public function Virtual   Virtual destructor, so that we can clean up our app when destroyed

Functions

  Type Name Description
Protected function Virtual void Adds an item to the Editing Objects list
Public function Virtual Const void  
Public function void Adds or removes extenders to the default menu or the toolbar menu this asset editor
Public function void  
Public function void Adds or removes widgets from the default toolbar in this asset editor
Public function Virtual void

AddViewportOverlayWidget ( TSharedRef< SWidget > InViewportOverlayWidget
)

 Called when a toolkit requests an overlay widget to be added to the viewport.
Protected function Virtual Const void Called when "Browse Documentation" is clicked for this asset
Protected function Virtual Const bool Called to test if "Find in Content Browser" should be enabled for this asset
Protected function Virtual Const bool

CanReimport ( UObject* EditingObject
)

 Called to check to see if there's an asset capable of being reimported
Protected function Virtual Const bool Called to check to see if there's an asset capable of being reimported
Protected function Virtual Const bool Called to test if "Save" should be enabled for this asset
Protected function Virtual Const bool Called to test if "Save As" should be enabled for this asset
Public function void Fills in the supplied menu with commands for modifying this asset that are generally common to most asset editors
Public function void Fills in the supplied menu with commands for working with this asset file
Public function void Fills in the supplied menu with commands for working with this asset file
Public function void Fills in the supplied menu with commands for the help menu
Protected function Virtual void Called when "Find in Content Browser" is clicked for this asset
Protected function UToolMenu * Generate the toolbar for common asset actions like Save
Public function void Makes a default asset editing toolbar
Protected function Virtual Const FLinearColor  
Protected function Virtual Const const FSlateBrush *  
Protected function Virtual Const FString  
Protected function Const UObject * Returns the single object currently being edited.
Protected function TArray< TObjectPtr< UObject > > &  
Protected function Const const TArray< UObject * > & Returns an array of all the objects currently being edited. Asserts if editing no objects
Public function Static FText

GetLabelForObject ( const UObject* InObject
)

 Gets the text to display in a toolkit titlebar for an object
Public function TSharedPtr< IToolkitHost >  
Protected function Virtual Const void

GetSaveableObjects ( TArray< UObject* >& OutObjects
)

 Get the collection of edited objects that can be saved.
Public function Static TSharedPtr< FExtensibilityManager > Returns the default extensibility managers, these are applied for all asset types
Public function Static TSharedPtr< FExtensibilityManager >  
Public function TSharedPtr< FTabManager >  
Public function Const FName  
Public function Const FName  
Public function Virtual Const FName

GetToolMenuToolbarName ( FName& OutParentName
)

 Get name used by tool menu
Public function Const FName  
Public function Static FText

GetToolTipTextForObject ( const UObject* InObject
)

 Gets the text to display in a toolkit tooltip for an object
Protected function Const bool Returns true if this toolkit has any objects being edited
Public function void

InitAssetEditor ( const EToolkitMode::Type Mode,
const TSharedPtr< IToolkitHost >& InitToolkitHost,
const FName AppIdentifier,
const TSharedRef< FTabManager::FLayout >& StandaloneDefaultLayout,
const bool bCreateDefaultStandaloneMenu,
const bool bCreateDefaultToolbar,
const TArray< UObject* >& ObjectsToEdit,
const bool bInIsToolbarFocusable,
const bool bInUseSmallToolbarIcons
)

 Initializes this asset editor.
Public function void

InitAssetEditor ( const EToolkitMode::Type Mode,
const TSharedPtr< IToolkitHost >& InitToolkitHost,
const FName AppIdentifier,
const TSharedRef< FTabManager::FLayout >& StandaloneDefaultLayout,
const bool bCreateDefaultStandaloneMenu,
const bool bCreateDefaultToolbar,
UObject* ObjectToEdit,
const bool bInIsToolbarFocusable,
const bool bInUseSmallToolbarIcons
)

 Initializes this asset editor.
Public function Virtual void  
Public function Virtual void

InvokeTab ( const FTabId& TabId
)

  
Public function Const bool True if this actually is editing an asset
Protected function Virtual Const bool Called to test if "Find in Content Browser" should be visible for this asset
Protected function Virtual void

OnAssetsSavedAs ( const TArray< UObject* >& SavedObjects
)

 Called from SaveAssetAs_Execute when assets have been saved
Protected function Virtual void

OnClose ()

 Called when this toolkit is being closed
Protected function Virtual bool

OnRequestClose ( EAssetEditorCloseReason InCloseReason
)

 Called when this toolkit is requested to close. Returns false if closing should be prevented.
Public function Virtual void Called when another toolkit (such as a ed mode toolkit) is no longer being hosted in this asset editor toolkit.
Public function Virtual void Called when another toolkit (such as a ed mode toolkit) is being hosted in this asset editor toolkit.
Protected function Virtual void Perform any initialization that should happen after the basic toolkit needs are created for the asset editor.
Public function Virtual void Called at the end of RegenerateMenusAndToolbars()
Public function void Regenerates the menubar and toolbar widgets
Public function Static void Registers default tool bar
Public function void

RegisterDrawer ( FWidgetDrawerConfig&& Drawer,
int32 SlotIndex
)

 Registers a drawer for the asset editor status bar
Protected function Virtual void Called when "Reimport" is clicked for this asset
Protected function Virtual void

Reimport_Execute ( UObject* EditingObject
)

 Called when "Reimport" is clicked for this asset
Public function void  
Protected function Virtual void Removes an item from the Editing Objects list
Public function void  
Public function void  
Public function Virtual void

RemoveViewportOverlayWidget ( TSharedRef< SWidget > InViewportOverlayWidget
)

 Called when a toolkit requests the overlay widget to be removed.
Public function void Applies the passed in layout (or the saved user-modified version if available).
Protected function Virtual void Called when "Save" is clicked for this asset
Protected function Virtual void Called when "Save As" is clicked for this asset
Public function void Allows the caller to set a menu overlay, displayed to the far right of the editor's menu bar
Public function Static void Static: Used internally to set the world-centric toolkit host for a newly-created standalone asset editing toolkit
Protected function Virtual Const bool Called to determine if the user should be prompted for a new file if one is missing during an asset reload
Protected function Virtual Const bool Whether to open a new asset editor for the newly-saved Asset.
Protected function Static void Static: Called when "Switch to Standalone Editor" is clicked for the asset editor
Protected function Static void Static: Called when "Switch to World-Centric Editor" is clicked for the asset editor

Overridden from IAssetEditorInstance

  Type Name Description
Public function Virtual bool

CloseWindow ( EAssetEditorCloseReason InCloseReason
)

  
Public function Virtual void

FocusWindow ( UObject* ObjectToFocusOn
)

  
Public function Virtual TSharedPtr< FTabManager >  
Public function Virtual Const FName  
Public function Virtual Const FName IAssetEditorInstance interface
Public function Virtual double  
Public function Virtual Const bool  
Public function Virtual void  

Overridden from FBaseToolkit

  Type Name Description
Protected function Virtual void Creates the Editor mode manager for your class. Default is to create none, for legacy reasons.

Overridden from IToolkit

  Type Name Description
Public function Const FText Returns the localized name of this toolkit type (typically just " editor")
Public function Virtual Const FEditorModeTools & Gets the mode manager for this toolkit
Public function Virtual Const const TArray< UObject * > * For asset editor toolkits, returns the UObjects for the assets currently being edited
Public function Virtual Const FText Returns the localized tab suffix
Public function Const FName Returns the invariant name of this toolkit type
Public function Virtual Const FText Returns the localized name of this toolkit
Public function Virtual Const FText Returns the localized tooltip text of this toolkit
Public function Const FString Returns the localize prefix string to use for tab labels in world-centric mode.
Public function Virtual Const bool 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 >& TabManager
)

 IToolkit interface
Public function Virtual void

UnregisterTabSpawners ( const TSharedRef< FTabManager >& TabManager
)

 Unregister tabs that this toolkit can spawn

Operators

  Type Name Description
Public function FAssetEditorToolkit &  

Constants

Name Description
DefaultAssetEditorToolBarName  
PreviousWorldCentricToolkitHostForNewAssetEditor Static: World centric toolkit host to use for the next created asset editing toolkit
SharedMenuExtensibilityManager The extensibility managers shared by all asset types
SharedToolBarExtensibilityManager  

Deprecated Variables

  Type Name Description
Protected variable FAssetEditorModeManager * AssetEditorModeManager Use EditorModeManager instead.

Deprecated Functions

  Type Name Description
Public function Virtual bool Use CloseWindow that takes in an EAssetEditorCloseReason instead
Public function Const FAssetEditorModeManager * Use GetEditorModeManager instead.
Protected function Virtual bool Use OnRequestClose that takes in an EAssetEditorCloseReason instead
Public function void Override CreateEditorModeManager on the toolkit class instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page