Navigation
Unreal Engine C++ API Reference > Editor > EditorInteractiveToolsFramework > ToolContexts
Inheritance Hierarchy
References
Module | EditorInteractiveToolsFramework |
Header | /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/ToolContexts/ToolStackContext.h |
Include | #include "ToolContexts/ToolStackContext.h" |
Syntax
class UToolStackContext : public [UObject](API\Runtime\CoreUObject\UObject\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<... | EdMode | EdMode owning the tools referenced by this stack |
TArray< TPair< ... | RegisteredEditorTools | List of Tools this Mode has registered in the EditorToolsContext, to be unregistered on Mode shutdown |
TArray< TPair< ... | RegisteredEditorToolStacks | List of Tools stacks this Mode has registered in the EditorToolsContext, to be unregistered on Mode shutdown |
EToolsContextSc... | ToolContextScope | Scope for this context object |
TMap< FString, ... | ToolStacks | Current set of named ToolStacks |
Destructors
No destructors are accessible with public or protected access.
Functions
Type | Name | Description |
---|---|---|
FInteractive... | AccessToolStack ( const FString& Identifier ) | Access an existing tool stack |
void | AddToolToStack ( TSharedPtr< FUICommandInfo > UIComm..., const FString& ToolStackIdentifier, const FString& ToolIdentifier, UInteractiveToolBuilder* Build..., EToolsContextScope ToolScope ) | Registers and maps the provided UI command to actions that control a tool within a tool stack |
void | RegisterToolStack ( TSharedPtr< FUICommandInfo > UIComm..., const FString& ToolStackIdentifier, EToolsContextScope ToolScope ) | 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 |