Navigation
API > API/Plugins > API/Plugins/UVEditor
Inheritance Hierarchy
- IAssetEditorInstance
- FBaseToolkit
- TSharedFromThis
- FAssetEditorToolkit
- FBaseAssetToolkit
- FUVEditorToolkit
References
| Module | UVEditor |
| Header | /Engine/Plugins/Editor/UVEditor/Source/UVEditor/Public/UVEditorToolkit.h |
| Include | #include "UVEditorToolkit.h" |
Syntax
class FUVEditorToolkit : 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 UUVEditorMode managed by the mode manager, the toolkit also ends up initializing the UV mode. Thus, the FUVEdiotrToolkit ends up being the central place for the UV Asset editor setup.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TSharedPtr< FAssetEditorModeManager > | LivePreviewEditorModeManager | |
 |
TObjectPtr< UInputRouter > | LivePreviewInputRouter | |
 |
TUniquePtr< FAdvancedPreviewScene > | LivePreviewScene | Scene in which the 3D preview meshes of the assets live. |
 |
TSharedPtr< class FEditorViewportTabContent > | LivePreviewTabContent | These are related to the 3D "live preview" viewport. |
 |
TSharedPtr< FEditorViewportClient > | LivePreviewViewportClient | |
 |
AssetEditorViewportFactoryFunction | LivePreviewViewportDelegate | |
 |
TSharedPtr< FUVEditorModeUILayer > | ModeUILayer | |
 |
TUniquePtr< FPreviewScene > | UnwrapScene | Scene in which the 2D unwrapped uv meshes live. |
 |
TWeakPtr< SEditorViewport > | UVEditor2DViewport | |
 |
TSharedPtr< FWorkspaceItem > | UVEditorMenuCategory | |
 |
UUVTool2DViewportAPI * | UVTool2DViewportAPI | |
 |
UUVToolViewportButtonsAPI * | ViewportButtonsAPI |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FUVEditorToolkit
(
UAssetEditor* InOwningAssetEditor |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
FPreviewScene * | ||
 |
TSharedRef< SDockTab > | SpawnTab_InteractiveToolsPanel
(
const FSpawnTabArgs& Args |
|
 |
TSharedRef< SDockTab > | SpawnTab_LivePreview
(
const FSpawnTabArgs& Args |
Overridden from FBaseAssetToolkit
| Type | Name | Description | |
|---|---|---|---|
   |
TSharedPtr< FEditorViewportClient > | ||
  |
void | FBaseAssetToolkit. | |
  |
AssetEditorViewportFactoryFunction | FBaseAssetToolkit. |
Overridden from FAssetEditorToolkit
| Type | Name | Description | |
|---|---|---|---|
  |
void | AddViewportOverlayWidget
(
TSharedRef< SWidget > InViewportOverlayWidget |
FAssetEditorToolkit. |
   |
bool | CanSaveAsset () |
Called to test if "Save" should be enabled for this asset |
   |
bool | Called to test if "Save As" should be enabled for this asset | |
   |
FLinearColor | ||
   |
const FSlateBrush * | ||
  |
void | OnClose () |
Called when this toolkit is being closed |
  |
bool | OnRequestClose
(
EAssetEditorCloseReason InCloseReason |
Called when this toolkit is requested to close. Returns false if closing should be prevented. |
  |
void | OnToolkitHostingFinished
(
const TSharedRef< IToolkit >& Toolkit |
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 >& Toolkit |
Called when another toolkit (such as a ed mode toolkit) is being hosted in this asset editor toolkit. |
  |
void | FAssetEditorToolkit. | |
  |
void | RemoveViewportOverlayWidget
(
TSharedRef< SWidget > InViewportOverlayWidget |
Called when a toolkit requests the overlay widget to be removed. |
  |
void | Called when "Save" is clicked for this asset |
Overridden from IAssetEditorInstance
| Type | Name | Description | |
|---|---|---|---|
   |
bool | IAssetEditorInstance This is important because if this returns true, attempting to edit a static mesh that is open in the UV editor may open the UV editor instead of opening the static mesh editor. |
Overridden from FBaseToolkit
| Type | Name | Description | |
|---|---|---|---|
  |
void | Creates the Editor mode manager for your class. Default is to create none, for legacy reasons. |
Overridden from IToolkit
| Type | Name | Description | |
|---|---|---|---|
   |
FText | Returns the localized name of this toolkit type (typically just " |
|
   |
FName | Returns the invariant name of this toolkit type | |
   |
FText | Returns the localized name of this toolkit | |
   |
FText | Returns the localized tooltip text of this toolkit | |
  |
void | RegisterTabSpawners
(
const TSharedRef< FTabManager >& TabManager |
IToolkit interface |
Constants
| Name | Description |
|---|---|
| InteractiveToolsPanelTabID | |
| LivePreviewTabID |