fix: Cursor disappearing when multiple tools active (#2493)

* fix: Cursor disappearing

* fix: Tool cursor disappearing

* Fix npe on dynamic threshold

* Use non-calibrated image for starting point

* Change to isPrimary

* docs: Cursor drawing

Author: wayfarer3130

packages/tools/examples/labelmapSegmentationTools/index.ts

@@ -14,7 +14,6 @@ import {
   addDropdownToToolbar,
   addSliderToToolbar,
   setCtTransferFunctionForVolumeActor,
-  getLocalUrl,
 } from '../../../../utils/demo/helpers';
 import * as cornerstoneTools from '@cornerstonejs/tools';
 
@@ -307,17 +306,17 @@ async function run() {
     }
   );
   toolGroup.addToolInstance(
-    brushInstanceNames.CircularEraser,
+    brushInstanceNames.SphereBrush,
     BrushTool.toolName,
     {
-      activeStrategy: brushStrategies.CircularEraser,
+      activeStrategy: brushStrategies.SphereBrush,
     }
   );
   toolGroup.addToolInstance(
-    brushInstanceNames.SphereBrush,
+    brushInstanceNames.CircularEraser,
     BrushTool.toolName,
     {
-      activeStrategy: brushStrategies.SphereBrush,
+      activeStrategy: brushStrategies.CircularEraser,
     }
   );
   toolGroup.addToolInstance(
@@ -352,10 +351,19 @@ async function run() {
     bindings: [{ mouseButton: MouseBindings.Primary }],
   });
 
+  toolGroup.setToolActive(brushInstanceNames.CircularEraser, {
+    bindings: [
+      {
+        mouseButton: MouseBindings.Primary,
+        modifierKey: KeyboardBindings.Shift,
+      },
+    ],
+  });
+
   toolGroup.setToolActive(ZoomTool.toolName, {
     bindings: [
       {
-        mouseButton: MouseBindings.Primary, // Shift Left Click
+        mouseButton: MouseBindings.Auxiliary, // Shift Middle
         modifierKey: KeyboardBindings.Shift,
       },
     ],

packages/tools/src/store/ToolGroupManager/ToolGroup.ts

@@ -404,9 +404,11 @@ export default class ToolGroup {
         const cursor = MouseCursor.getDefinedCursor('default');
         this._setCursorForViewports(cursor);
       }
+      toolInstance.isPrimary = false;
     } else {
       // reset the mouse cursor if tool has left click binding
       this.setViewportsCursorByToolName(toolName);
+      toolInstance.isPrimary = true;
     }
 
     // if it is a primary tool binding, we should store it as the previous primary tool
@@ -496,6 +498,7 @@ export default class ToolGroup {
 
     this.toolOptions[toolName] = toolOptions;
     toolInstance.mode = mode;
+    toolInstance.isPrimary = false;
 
     if (typeof toolInstance.onSetToolPassive === 'function') {
       toolInstance.onSetToolPassive();

packages/tools/src/tools/base/BaseTool.ts

@@ -13,6 +13,24 @@ const { DefaultHistoryMemo } = csUtils.HistoryMemo;
  */
 abstract class BaseTool {
   static toolName;
+
+  /**
+   * Set to the tool that is currently drawing the active cursor.  This
+   * will be either primary mouse button tool if no tool is currently
+   * being directly interacted with, OR the tool that is directly interacted
+   * with.  This logic ensures that there is only a single tool at a time
+   * drawing, which prevents tools not getting mouse updates from over-writing
+   * the cursor.
+   *
+   * - If the tool bound to the primary button is a cursor drawing tool,
+   *   use that tool and there is NOT a tool currently drawing directly
+   * - If there is a tool currently drawing directly, then that tool should
+   *   display a cursor EVEN if it normally doesn't have a custom cursor
+   * - When a tool finishes drawing direct, it should stop being the active
+   *   cursor tool unless it is also the primary tool
+   */
+  public static activeCursorTool;
+
   /** Supported Interaction Types - currently only Mouse */
   public supportedInteractionTypes: InteractionTypes[];
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -21,6 +39,9 @@ abstract class BaseTool {
   public toolGroupId: string;
   /** Tool Mode - Active/Passive/Enabled/Disabled/ */
   public mode: ToolModes;
+  /** Primary tool - this is set to true when this tool is primary */
+  public isPrimary = false;
+
   /**
    * A memo recording the starting state of a tool.  This will be updated
    * as changes are made, and reflects the fact that a memo has been created.

packages/tools/src/tools/segmentation/BrushTool.ts

@@ -22,7 +22,6 @@ import {
   fillInsideCircle,
 } from './strategies/fillCircle';
 import { eraseInsideCircle } from './strategies/eraseCircle';
-import { drawCircle as drawCircleSvg } from '../../drawingSvg';
 import {
   resetElementCursor,
   hideElementCursor,
@@ -249,6 +248,9 @@ class BrushTool extends LabelmapBaseTool {
    * The preview also needs to be cancelled on changing tools.
    */
   mouseMoveCallback = (evt: EventTypes.InteractionEventType): void => {
+    if (!this.isPrimary) {
+      return;
+    }
     if (this.mode === ToolModes.Active) {
       this.updateCursor(evt);
       if (!this.configuration.preview.enabled) {
@@ -355,6 +357,7 @@ class BrushTool extends LabelmapBaseTool {
       return;
     }
 
+    BrushTool.activeCursorTool = this;
     triggerAnnotationRenderForViewportUIDs(this._hoverData.viewportIdsToRender);
   }
 
@@ -619,7 +622,7 @@ class BrushTool extends LabelmapBaseTool {
     enabledElement: Types.IEnabledElement,
     svgDrawingHelper: SVGDrawingHelper
   ): void {
-    if (!this._hoverData) {
+    if (!this._hoverData || BrushTool.activeCursorTool !== this) {
       return;
     }