TrizTech/ohif-viewer
17
0 Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

fix(ToolGroupService): Centralize tool binding persistence and provide API to add and remove persisted bindings. (#5989)

Browse Source 
* Reset crosshair modifier to default when resetting user preferences.

* Apply bindings when loading persisted bindings.
This commit is contained in:
Joe Boccanfuso authored and GitHub committed 2026-05-05 15:22:43 -04:00
1 parent 5bccf0a753
commit 979d619f7c
3 files changed
+174 -37
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

platform/docs/docs/platform/services/data/ToolGroupService.md
+8
View File
@@ -41,6 +41,14 @@ The `ToolGroupService` emits the following events:
- `createToolGroupAndAddTools(toolGroupId, tools)`: Creates a new tool group and adds the specified tools to it.
- `getToolConfiguration(toolGroupId, toolName)`: Retrieves the configuration for the specified tool in the given tool group.
- `setToolConfiguration(toolGroupId, toolName, config)`: Sets the configuration for the specified tool in the given tool group.
- `getActivePrimaryMouseButtonTool(toolGroupId?)`: Returns the active primary mouse button tool for the specified tool group, or for the active viewport's tool group when omitted.
- `getToolBindings(toolGroupId, toolName)`: Returns the bindings from the service's internal binding map for the specified tool in the given tool group.
- `setToolBindings(toolGroupId, toolName, bindings)`: Updates the service's internal binding map for the specified tool in the given tool group. This does not change the tool's active runtime mode by itself.
- `getAllToolBindings()`: Returns all bindings currently stored in the service's internal binding map across tool groups.
- `getDefaultToolBindings(toolGroupId, toolName)`: Returns the default bindings captured when the tool group was initialized.
- `applyToolBindings(toolGroupId, toolName, options?)`: Reads the currently tracked bindings for that tool and applies them to the underlying runtime tool instance (via tool activation). This can activate tools that are currently `Passive` or `Enabled`, since assigning bindings is treated as making the tool interactable. Use this after `setToolBindings` when you want runtime behavior to update. Set `options.replaceExisting` to `true` to clear previous active bindings before applying.
- `persistToolBindings(toolGroupId, toolName, bindings)`: Persists tool bindings for a specific tool in a tool group to user preferences storage.
- `removePersistedToolBindings(toolGroupId, toolName?)`: Removes persisted tool bindings for a specific tool, or for the whole tool group when `toolName` is omitted.
## Usage