Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
Manages ToolGroups for a single UInteractiveToolsContext.
UToolGroupManager is stored per-tools-context and is responsible for materializing per-context runtime state from immutable tool group descriptors.
Responsibilities:
- register immutable ToolGroup descriptors by name,
- enable/disable groups within this tools context,
- register/unregister tool types with UInteractiveToolManager,
- acquire/release shared features via FToolGroupFeatureRegistry,
- build/register per-context input behaviors with the context's InputRouter,
- answer queries like "which enabled group owns the currently active tool".
| Name | UToolGroupManager |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/ToolGroupManager.h |
| Include Path | #include "ToolGroupManager.h" |
Syntax
UCLASS (Transient)
class UToolGroupManager : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UToolGroupManager
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| EnabledGroups | TMap< FName, FEnabledToolGroupState > | Per-context runtime state for enabled groups. | ToolGroupManager.h |
|
| FeatureRegistry | FToolGroupFeatureRegistry | Ref-counted context-wide feature registry. | ToolGroupManager.h | |
| RegisteredGroups | TMap< FName, TSharedPtr< const FToolGroup > > | Registered immutable tool group descriptors by name. | ToolGroupManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DisableAllToolGroups() |
Disable all enabled tool groups in this context. | ToolGroupManager.h | |
bool DisableToolGroup
(
FName GroupName |
Disable (unregister + cleanup) the named tool group in this context. | ToolGroupManager.h | |
bool EnableToolGroup
(
FName GroupName |
Enable (materialize + register) the named tool group in this context. | ToolGroupManager.h | |
TOptional< FName > FindEnabledGroupOwningActiveTool
(
EToolSide Side |
Tool Ownership. | ToolGroupManager.h | |
| Returns the names of currently enabled groups. | ToolGroupManager.h | ||
bool HasAnyEnabledToolGroups() |
Returns true if any tool groups are enabled in this context. | ToolGroupManager.h | |
bool HasToolGroup
(
FName GroupName |
Returns true if a tool group descriptor with this name is registered. | ToolGroupManager.h | |
void Initialize() |
Initialize internal state. Must be called before registering/enabling groups. | ToolGroupManager.h | |
bool IsToolGroupEnabled
(
FName GroupName |
Lifecycle. | ToolGroupManager.h | |
bool RegisterToolGroup
(
FName GroupName, |
Register an immutable ToolGroup descriptor that can later be enabled in this context. | ToolGroupManager.h | |
void Shutdown() |
Shutdown and disable all enabled tool groups, unregistering their tool types. | ToolGroupManager.h |