Navigation
API > API/Editor > API/Editor/EditorInteractiveToolsFramework
Context needed to support tool stacks, add this to your ContextObjectStore if you want to use tool stacks
| Name | UToolStackContext |
| Type | class |
| Header File | /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/ToolContexts/ToolStackContext.h |
| Include Path | #include "ToolContexts/ToolStackContext.h" |
Syntax
UCLASS (MinimalAPI, Transient)
class UToolStackContext : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UToolStackContext
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UToolStackContext() |
ToolContexts/ToolStackContext.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| EdMode | TWeakObjectPtr< UEdMode > | EdMode owning the tools referenced by this stack | ToolContexts/ToolStackContext.h | |
| ToolContextScope | EToolsContextScope | Scope for this context object | ToolContexts/ToolStackContext.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInteractiveToolStack * AccessToolStack
(
const FString& Identifier |
Access an existing tool stack | ToolContexts/ToolStackContext.h | |
virtual void AddToolToStack
(
TSharedPtr< FUICommandInfo > UICommand, |
Registers and maps the provided UI command to actions that control a tool within a tool stack | ToolContexts/ToolStackContext.h | |
virtual void RegisterToolStack
(
TSharedPtr< FUICommandInfo > UICommand, |
Registers and maps the provided UI command to actions that start / stop multiple tools within a tool stack Later on this UI command can be referenced to add the tool stack to a toolbar. | ToolContexts/ToolStackContext.h | |
virtual void UnregisterToolStack
(
const FString& Identifier |
Unregister a Tool stack, unregistration of individual tools is handled seperately Note: Currently this is never called since we properly free resources on destruction | ToolContexts/ToolStackContext.h |