|
Module |
|
|
Header |
/Engine/Source/Editor/UnrealEd/Public/Toolkits/AssetEditorToolkit.h |
|
Include |
#include "Toolkits/AssetEditorToolkit.h" |
class FAssetEditorToolkit :
public IAssetEditorInstance,
public FBaseToolkit,
public TSharedFromThis< FAssetEditorToolkit >
Base class for toolkits that are used for asset editing (abstract)
| Name | Description | ||
|---|---|---|---|
|
|
AssetEditorModeManager |
The asset editor mode manager |
|
|
|
TSharedPtr< FWo... |
AssetEditorTabsCategory |
The base category that tabs are registered to, allows for child classes to register to the same point. |
|
|
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 |
|
|
|
LayoutExtenders |
Array of layout extenders |
|
|
|
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. |
|
|
|
TSharedPtr< FTa... |
TabManager |
Controls our internal layout |
| Name | Description | |
|---|---|---|
|
|
FAssetEditorToolkit() |
Default constructor |
| Name | Description | |
|---|---|---|
|
|
~FAssetEditorToolkit() |
Virtual destructor, so that we can clean up our app when destroyed |
| Name | Description | ||
|---|---|---|---|
|
|
AddEditingObject ( |
Adds an item to the Editing Objects list |
|
|
|
AddGraphEditorPinActionsToContextMenu ( |
||
|
|
AddMenuExtender ( |
Adds or removes extenders to the default menu or the toolbar menu this asset editor |
|
|
|
AddToolbarExtender ( |
||
|
|
AddToolbarWidget ( |
Adds or removes widgets from the default toolbar in this asset editor |
|
|
|
BrowseDocumentation_Execute() |
Called when "Browse Documentation" is clicked for this asset |
|
|
|
CanFindInContentBrowser() |
Called to test if "Find in Content Browser" should be enabled for this asset |
|
|
|
CanReimport ( |
Called to check to see if there's an asset capable of being reimported |
|
|
|
CanReimport() |
Called to check to see if there's an asset capable of being reimported |
|
|
|
CanSaveAsset() |
Called to test if "Save" should be enabled for this asset |
|
|
|
CanSaveAssetAs() |
Called to test if "Save As" should be enabled for this asset |
|
|
|
FillDefaultAssetMenuCommands ( |
Fills in the supplied menu with commands for modifying this asset that are generally common to most asset editors |
|
|
|
FillDefaultFileMenuCommands ( |
Fills in the supplied menu with commands for working with this asset file |
|
|
|
FillDefaultHelpMenuCommands ( |
Fills in the supplied menu with commands for the help menu |
|
|
|
FindInContentBrowser_Execute() |
Called when "Find in Content Browser" is clicked for this asset |
|
|
|
GenerateToolbar() |
Makes a default asset editing toolbar |
|
|
|
FAssetEditor... |
GetAssetEditorModeManager() |
Get the asset editor mode manager we are using |
|
|
GetDefaultTabColor() |
||
|
|
const FSlate... |
GetDefaultTabIcon() |
|
|
|
GetDocumentationLink() |
||
|
|
UObject *... |
GetEditingObject() |
Returns the single object currently being edited. |
|
|
const TArray... |
GetEditingObjects() |
Returns an array of all the objects currently being edited. Asserts if editing no objects |
|
|
GetLabelForObject ( |
Gets the text to display in a toolkit titlebar for an object |
|
|
|
TSharedPtr< ... |
GetPreviousWorldCentricToolkitHost() |
|
|
|
GetSaveableObjects |
Get the collection of edited objects that can be saved. |
|
|
|
TSharedPtr< ... |
GetSharedMenuExtensibilityManager() |
Returns the default extensibility managers, these are applied for all asset types |
|
|
TSharedPtr< ... |
GetSharedToolBarExtensibilityManager() |
|
|
|
TSharedPtr< ... |
GetTabManager() |
|
|
|
GetToolMenuAppName() |
||
|
|
GetToolMenuName() |
||
|
|
GetToolMenuToolbarName() |
||
|
|
GetToolMenuToolbarName ( |
Get name used by tool menu |
|
|
|
GetToolTipTextForObject ( |
Gets the text to display in a toolkit tooltip for an object |
|
|
|
InitAssetEditor ( |
Initializes this asset editor. |
|
|
|
InitAssetEditor ( |
Initializes this asset editor. |
|
|
|
InitToolMenuContext ( |
||
|
|
InvokeTab ( |
||
|
|
IsActuallyAnAsset() |
True if this actually is editing an asset |
|
|
|
OnRequestClose() |
Called when this toolkit would close |
|
|
|
OnToolkitHostingFinished ( |
Called when another toolkit (such as a ed mode toolkit) is no longer being hosted in this asset editor toolkit. |
|
|
|
OnToolkitHostingStarted ( |
Called when another toolkit (such as a ed mode toolkit) is being hosted in this asset editor toolkit. |
|
|
|
PostRegenerateMenusAndToolbars() |
Called at the end of RegenerateMenusAndToolbars() |
|
|
|
RegenerateMenusAndToolbars() |
Regenerates the menubar and toolbar widgets |
|
|
|
RegisterDefaultToolBar() |
Registers default tool bar |
|
|
|
Reimport_Execute() |
Called when "Reimport" is clicked for this asset |
|
|
|
Reimport_Execute ( |
Called when "Reimport" is clicked for this asset |
|
|
|
RemoveAllToolbarWidgets() |
||
|
|
RemoveEditingObject ( |
Removes an item from the Editing Objects list |
|
|
|
RemoveMenuExtender ( |
||
|
|
RemoveToolbarExtender ( |
||
|
|
RestoreFromLayout ( |
Applies the passed in layout (or the saved user-modified version if available). |
|
|
|
SaveAsset_Execute() |
Called when "Save" is clicked for this asset |
|
|
|
SaveAssetAs_Execute() |
Called when "Save As" is clicked for this asset |
|
|
|
SetAssetEditorModeManager ( |
Set the asset editor mode manager we are using |
|
|
|
SetMenuOverlay ( |
Allows the caller to set a menu overlay, displayed to the far right of the editor's menu bar |
|
|
|
SetPreviousWorldCentricToolkitHostForNewAssetEditor ( |
Static: Used internally to set the world-centric toolkit host for a newly-created standalone asset editing toolkit |
|
|
|
ShouldPromptForNewFilesOnReload ( |
Called to determine if the user should be prompted for a new file if one is missing during an asset reload |
|
|
|
SwitchToStandaloneEditor_Execute ( |
Static: Called when "Switch to Standalone Editor" is clicked for the asset editor |
|
|
|
SwitchToWorldCentricEditor_Execute ( |
Static: Called when "Switch to World-Centric Editor" is clicked for the asset editor |
| Name | Description | ||
|---|---|---|---|
|
|
CloseWindow() |
||
|
|
FocusWindow ( |
||
|
|
TSharedPtr< ... |
GetAssociatedTabManager() |
|
|
|
GetEditorName() |
IAssetEditorInstance interface |
|
|
|
double |
GetLastActivationTime() |
|
|
|
GetToolbarTabId() |
||
|
|
IsPrimaryEditor() |
||
|
|
RemoveEditingAsset ( |
| Name | Description | ||
|---|---|---|---|
|
|
GetBaseToolkitName() |
Returns the localized name of this toolkit type (typically just " |
|
|
|
FEdMode *... |
GetEditorMode() |
|
|
|
GetEditorModeDisplayName() |
||
|
|
GetEditorModeIcon() |
||
|
|
const TArray... |
GetObjectsCurrentlyBeingEdited() |
For asset editor toolkits, returns the UObjects for the assets currently being edited |
|
|
UEdMode *... |
GetScriptableEditorMode() |
|
|
|
GetTabSuffix() |
Returns the localized tab suffix |
|
|
|
GetToolkitFName() |
Returns the invariant name of this toolkit type |
|
|
|
GetToolkitName() |
Returns the localized name of this toolkit |
|
|
|
GetToolkitToolTipText() |
Returns the localized tooltip text of this toolkit |
|
|
|
GetWorldCentricTabPrefix() |
Returns the localize prefix string to use for tab labels in world-centric mode. |
|
|
|
IsAssetEditor() |
Returns true if this toolkit is used to edit assets (even if it's not necessarily editing one right now.) |
|
|
|
RegisterTabSpawners ( |
IToolkit interface |
|
|
|
UnregisterTabSpawners ( |
Unregister tabs that this toolkit can spawn |
|
Name |
Description |
|---|---|
|
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 |
|
|
ToolbarTabId |
The tab ids for all the tabs used |