feat(tools): custom keybinds and layer independent tool keybinds #464

chrisj · 2023-05-12T18:38:14Z

🔥 Preview 🔥: https://neuroglancer--pr464-jqtohdii.web.app
Updated at Thu Feb 22 2024 17:27:49 GMT+0000 (Coordinated Universal Time) for commit bc4f166
Expires: Invalid Date

jbms · 2023-05-12T18:44:19Z

src/neuroglancer/ui/default_viewer_setup.ts

 declare var NEUROGLANCER_DEFAULT_STATE_FRAGMENT: string|undefined;

+type CustomBinding = {
+  layer: string, tool: string, protocol?: string,


tool should be a json object, not just a string, as some tools support options

jbms · 2023-05-12T18:45:57Z

src/neuroglancer/ui/default_viewer_setup.ts

+    });
+  }
+
+  const nameToLayer: {[key: string]: UserLayerConstructor|undefined} = {};


This already exists as layerTypes in neuroglancer/layer.ts

jakobtroidl · 2023-10-05T14:33:05Z

@jbms, is it possible to get this merged? We need this feature in ng for proofreading H01 with CAVE.

chrisj · 2024-02-22T17:32:09Z

Updated this pull request with the ability to unbind existing keybinds with a false value and also with the latest code formatting.

Side note: I am curious if you have vs code (if that is what you use) config set up to automatically do correct imports. My current issue is that I have to manually add the # before src, fix import order, and split out type only imports.

Example config

{
  "keym": {
    "action": {
      "layerType": "segmentation",
      "tool": "grapheneMergeSegments",
      "provider": "graphene"
    }
  },
  "keyx": {
    "action": false
  },
  "control+shift+keyx": {
    "action": "clear-segments",
    "context": "sliceView"
  }
}

jbms · 2025-02-20T19:20:27Z

src/ui/default_viewer_setup.ts

+  [key: string]: CustomToolBinding | string | boolean;
+};
+
+declare const CUSTOM_BINDINGS: CustomBindings | undefined;


Please rename to NEUROGLANCER_CUSTOM_INPUT_BINDINGS

jbms · 2025-02-20T19:22:22Z

src/ui/default_viewer_setup.ts

+      } else {
+        viewer.inputEventBindings.global.set(key, `tool-${val.tool}`);
+        const layerConstructor = layerTypes.get(val.layer);
+        if (layerConstructor) {


Probably should throw or log an error if layerConstructor not found to avoid silently ignoring invalid input. Since this is a build time option better to ensure it is correct.

jbms · 2025-02-20T19:24:59Z

src/ui/default_viewer_setup.ts

+  if (hasCustomBindings) {
+    for (const [key, val] of Object.entries(CUSTOM_BINDINGS!)) {
+      if (typeof val === "string") {
+        viewer.inputEventBindings.global.set(key, val);


Note that in addition to the global map there are several others that are relevant in default_input_event_bindings.ts --- in particular the default slice view and perspective view bindings. Perhaps this should account for that?

I added a "context" property, one of "global" | "perspectiveView" | "sliceView". I could also call it map or actionMap. Restructured the json object to support it.

{ "keym": { "action": { "layerType": "segmentation", "tool": "grapheneMergeSegments", "provider": "graphene" } }, "keyx": { "action": false }, "control+shift+keyx": { "action": "clear-segments", "context": "sliceView" } }

jbms · 2025-02-20T19:26:04Z

src/ui/default_viewer_setup.ts

+              const protocol = viewer.dataSourceProvider.getProvider(
+                dataSource.spec.url,
+              )[2];
+              if (protocol === desiredProvider) {


With the kvstore changes getProvider is not exactly the right method anymore. Perhaps just have a regexp that matches on the URL?

I switched it to use the schemePattern from "#src/kvstore/url.js"; does that seem fine?

jbms · 2025-02-20T19:31:06Z

src/ui/tool.ts

-  activate(key: string): Borrowed<Tool> | undefined {
-    const tool = this.get(key);
+  activate(key: string, tool?: Tool<object>): Borrowed<Tool> | undefined {
+    tool = tool || this.get(key);


Please use tool ?? this.get(key) instead --- not necessary here but avoids thinking about javascript truthyness complications

jbms · 2025-02-20T19:35:37Z

src/ui/tool.ts

    this.debounceDeactivate.cancel();
    const activeTool = this.activeTool_;
-    if (tool === activeTool?.tool) {
+    if (tool.toJSON() === activeTool?.tool.toJSON()) {


We can't compare the json like this because it can be an object rather than a plain string. Instead we need to compare the serialized json. However, it would be better if we can avoid having to insert the json comparison here, and instead just ensure that the same tool object is passed. Is your logic involving previousTool not sufficient?

I think originally my previousTool was for deactivation but then I realized if you have a custom binding and an user specified binding for the same tool+layer. It is a bit awkward. It is not a big deal because very few users would swap between both so this code can be removed but I made it so they can deactivate each other. For example if c is bound to multicut tool and the user binds shift+a to multicut, they can activate it with either bind and deactivate it with the other.

activeTool.tool.constructor === tool.constructor && activeTool.tool.context === tool.context

I think this logic is cleaner, let me know. If you prefer, I'm fine with removing it. Also because of this logic, previousTool has less value, really just a cache for restoreTool. I could remove it and call restoreTool with every keypress.

jbms · 2025-02-20T19:39:02Z

Regarding your question about the imports, in case you haven't already figured it out ---

npm run lint:fix fixes some things.

I don't use vscode --- but the typescript language server does have some options for configuring how it spells imports that it generates. Unfortunately as far as I am aware there is no standard way to specify those configuration options --- instead they need to be specified in some editor-specific way. If there is a way to configure it for vscode with a config file I'm happy to include such a configuration file in this repo.

jbms · 2025-02-20T19:40:11Z

src/ui/default_viewer_setup.ts

 declare let NEUROGLANCER_DEFAULT_STATE_FRAGMENT: string | undefined;

+type CustomToolBinding = {
+  layer: string;


rename to layerType for consistency with the tool palette queries.

chrisj · 2025-03-19T14:12:54Z

Thanks for going over this, I didn't notice you had reviewed it until recently.

chrisj · 2025-06-02T17:13:45Z

@jbms if you have time, could you take a look at this PR again? I pushed changes after your review and responded here: #464 (comment)

chrisj · 2025-11-05T21:42:12Z

I forgot to add this addition to the spec, being able to pass an array of bindings per identifier. I used this for our custom annotation iteration keybinds to re-bind the bracket keys.

"bracketleft": [
    { "action": false, "context": "sliceView" },
    { "action": false, "context": "perspectiveView" },
    { "action": "select-previous" }
  ]

…perspectiveView, sliceView) cleaned up code, addressed PR comments

…ier, allowing multiple contexts to be modified

jbms reviewed May 12, 2023

View reviewed changes

chrisj force-pushed the cj-custom-keybinds branch from 9428faa to bc4f166 Compare February 22, 2024 17:26

jbms reviewed Feb 20, 2025

View reviewed changes

chrisj force-pushed the cj-custom-keybinds branch from bc4f166 to 7c55342 Compare March 19, 2025 13:59

chrisj mentioned this pull request Sep 3, 2025

fix(datasource/graphene) swap selected layer when activating merge tool #821

Open

chrisj added 3 commits December 22, 2025 13:16

feat(tools): custom keybinds and layer independent tool keybinds

215797f

custom keybinds now supports modifying the other actionMap contexts (…

a627649

…perspectiveView, sliceView) cleaned up code, addressed PR comments

custom keybinds now optionally takes an array of bindings per identif…

6a84179

…ier, allowing multiple contexts to be modified

chrisj force-pushed the cj-custom-keybinds branch from de33dc9 to 6a84179 Compare December 22, 2025 18:17

feat(tools): custom keybinds and layer independent tool keybinds #464

Are you sure you want to change the base?

feat(tools): custom keybinds and layer independent tool keybinds #464

Uh oh!

Conversation

chrisj commented May 12, 2023 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jakobtroidl commented Oct 5, 2023

Uh oh!

chrisj commented Feb 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jbms commented Feb 20, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chrisj commented Mar 19, 2025

Uh oh!

chrisj commented Jun 2, 2025

Uh oh!

chrisj commented Nov 5, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

chrisj commented May 12, 2023 •

edited by github-actions bot

Loading

chrisj commented Feb 22, 2024 •

edited

Loading