Navigation
API > API/Editor > API/Editor/EditorInteractiveToolsFramework
FInteractiveToolStack represents a bundle of tools that may or may not share the same input chord Should some tools share a chord the most recently used tool will be activated by the chord. If no tools have been activated yet, the chord will go by order added to the stack.
To use tool stacks, simply add a UToolStackContext to your relevant interactive tools context. This can be done by calling 'AddContextObject' to the context object store of your tool context. See: 'UWidgetEditorToolPaletteMode::Enter' as reference.
| Name | FInteractiveToolStack |
| Type | struct |
| Header File | /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/InteractiveToolStack.h |
| Include Path | #include "InteractiveToolStack.h" |
Syntax
USTRUCT ()
struct FInteractiveToolStack
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 AddTool
(
const FString& InToolName, |
Add the tool to our internal tool array | InteractiveToolStack.h | |
const FString GetLastActiveTool() |
Get most recently activated tool within this stack | InteractiveToolStack.h | |
const FString GetLastActiveToolByChord
(
const FInputChord& InInputChord |
Get Tool that should be activated for the given input chord | InteractiveToolStack.h | |
const FText & GetLastActiveToolDescription() |
Get most recently activated tool's description within this stack | InteractiveToolStack.h | |
const FSlateIcon & GetLastActiveToolIcon() |
Get most recently activated tool's icon within this stack | InteractiveToolStack.h | |
const FText & GetLastActiveToolLabel() |
Get most recently activated tool's label within this stack | InteractiveToolStack.h | |
const TArray< TPair< FString, TSharedPtr< FUICommandInfo > > > & GetStack() |
Get the original tool stack | InteractiveToolStack.h | |
void NotifyToolActivated
(
const FString& InToolName |
Signal that a tool was activated increasing its priority in the toolstack for future chord inputs | InteractiveToolStack.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AddToolToStack
(
UEdMode* EdMode, |
Helper method to add tools to stacks | InteractiveToolStack.h | |
static void RegisterToolStack
(
UEdMode* EdMode, |
Helper method to generate tool stacks | InteractiveToolStack.h |