Navigation
API > API/Editor > API/Editor/EditorInteractiveToolsFramework > API/Editor/EditorInteractiveToolsFramework/ToolContexts
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UToolStackContext
References
| Module | EditorInteractiveToolsFramework |
| Header | /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/ToolContexts/ToolStackContext.h |
| Include | #include "ToolContexts/ToolStackContext.h" |
Syntax
class UToolStackContext : public UObject
Remarks
Context needed to support tool stacks, add this to your ContextObjectStore if you want to use tool stacks
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TWeakObjectPtr< UEdMode > | EdMode | EdMode owning the tools referenced by this stack |
 |
TArray< TPair< TSharedPtr< FUICommandInfo >, FString > > | RegisteredEditorTools | List of Tools this Mode has registered in the EditorToolsContext, to be unregistered on Mode shutdown |
 |
TArray< TPair< TSharedPtr< FUICommandInfo >, FString > > | RegisteredEditorToolStacks | List of Tools stacks this Mode has registered in the EditorToolsContext, to be unregistered on Mode shutdown |
 |
EToolsContextScope | ToolContextScope | Scope for this context object |
 |
TMap< FString, FInteractiveToolStack > | ToolStacks | Current set of named ToolStacks |
Destructors
No destructors are accessible with public or protected access.
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FInteractiveToolStack * | AccessToolStack
(
const FString& Identifier |
Access an existing tool stack |
  |
void | AddToolToStack
(
TSharedPtr< FUICommandInfo > UICommand, |
Registers and maps the provided UI command to actions that control a tool within a tool stack |
  |
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. |
  |
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 |