Navigation
API > API/Plugins > API/Plugins/WorkspaceEditor
| Name | IWorkspaceEditor |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Workspace/Source/WorkspaceEditor/Public/IWorkspaceEditor.h |
| Include Path | #include "IWorkspaceEditor.h" |
Syntax
class IWorkspaceEditor : public FBaseAssetToolkit
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FAssetEditorToolkit → FBaseAssetToolkit → IWorkspaceEditor
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IWorkspaceEditor
(
UAssetEditor* InOwningAssetEditor |
IWorkspaceEditor.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnOutlinerSelectionChanged | TMulticastDelegate< void(TConstArrayView< FWorkspaceOutlinerItemExport > InExports)> | Delegate fired when selection changes in the workspace outliner. | IWorkspaceEditor.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CloseObjects
(
TConstArrayView< UObject* > InObjects |
Close the supplied objects if they are open for editing within the workspace editor. | IWorkspaceEditor.h | |
void GetAssets
(
TArray< FAssetData >& OutAssets, |
Get the current set of assets in this workspace editor. | IWorkspaceEditor.h | |
TSharedPtr< IDetailsView > GetDetailsView() |
Retrieves the common DetailsView widget. | IWorkspaceEditor.h | |
const FWorkspaceDocument & GetFocusedDocumentOfClass
(
const TObjectPtr< UClass > InClass |
Get the currently focused document. | IWorkspaceEditor.h | |
const FWorkspaceDocument & GetFocusedWorkspaceDocument() |
Returns the currently focused workspace document (last user activated tab), unset in case of none is focused. | IWorkspaceEditor.h | |
void GetOpenedAssets
(
TArray< UObject* >& OutObjects |
Get the current set of opened (loaded) assets. | IWorkspaceEditor.h | |
void GetOpenedAssets
(
TArray< UObject* >& OutObjects |
Get the current set of opened (loaded) assets. | IWorkspaceEditor.h | |
void GetOpenedAssetsOfClass
(
TSubclassOf< UObject > InClass, |
Get the current set of opened (loaded) assets of the specified class. | IWorkspaceEditor.h | |
bool GetOutlinerSelection
(
TArray< FWorkspaceOutlinerItemExport >& OutExports |
Get the current single selection of the outliner. | IWorkspaceEditor.h | |
FString GetPackageName() |
Returns the name of the package where the workspace is located. | IWorkspaceEditor.h | |
UWorkspaceViewportSceneDescription * GetSceneDescription() |
Get the current scene description config. | IWorkspaceEditor.h | |
UWorkspaceSchema * GetSchema() |
Exposes the editor WorkspaceSchema. | IWorkspaceEditor.h | |
UObject * GetWorkspaceAsset() |
Returns the workspace asset. | IWorkspaceEditor.h | |
FOnFocusedDocumentChanged & OnFocusedDocumentChanged() |
Multicast delegate broadcast whenever the document focus of the WorkspaceEditor changes. | IWorkspaceEditor.h | |
FOnOutlinerSelectionChanged & OnOutlinerSelectionChanged() |
IWorkspaceEditor.h | ||
void OpenAssets
(
TConstArrayView< FAssetData > InAssets |
Open the supplied assets for editing within the workspace editor. | IWorkspaceEditor.h | |
void OpenExports
(
TConstArrayView< FWorkspaceOutlinerItemExport > InExports, |
Open the supplied exports for editing within the workspace editor. | IWorkspaceEditor.h | |
void OpenObjects
(
TConstArrayView< UObject* > InObjects, |
Open the supplied objects for editing within the workspace editor. | IWorkspaceEditor.h | |
void RefreshDetails() |
Refresh the workspace editor details panel. | IWorkspaceEditor.h | |
| Show the supplied objects in the workspace editor details panel. | IWorkspaceEditor.h | ||
void SetGlobalSelection
(
FGlobalSelectionId SelectionId, |
Set the current global selection (last SWidget with selection set) with delegate to clear it selection on next SetGlobalSelection() | IWorkspaceEditor.h | |
void SetSceneDescription
(
TObjectPtr< UWorkspaceViewportSceneDescription > InSceneDescription |
Set a new scene description config. | IWorkspaceEditor.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName GetWorkspaceEditorToolkitName() |
Name of EditorToolkit, used for testing against FAssetEditorToolkit::GetToolkitFName. | IWorkspaceEditor.h |