@cornerstonejs/tools 1.59.2 → 1.61.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "1.59.2",
+  "version": "1.61.0",
   "description": "Cornerstone3D Tools",
   "main": "src/index.ts",
   "types": "dist/types/index.d.ts",
@@ -29,7 +29,7 @@
     "webpack:watch": "webpack --mode development --progress --watch  --config ./.webpack/webpack.dev.js"
   },
   "dependencies": {
-    "@cornerstonejs/core": "^1.59.2",
+    "@cornerstonejs/core": "^1.61.0",
     "@icr/polyseg-wasm": "0.4.0",
     "@types/offscreencanvas": "2019.7.3",
     "comlink": "^4.4.1",
@@ -59,5 +59,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "ad8b39627c4f37c1a6007c39e358966b716f52bb"
+  "gitHead": "1d273f1e4ab80b7416020a4b801fbacbcb5f1ff7"
 }

package/src/index.ts

@@ -69,6 +69,7 @@ import {
   OrientationMarkerTool,
   OverlayGridTool,
   SegmentationIntersectionTool,
+  EraserTool,
   SegmentSelectTool,
 } from './tools';
 
@@ -126,6 +127,7 @@ export {
   ReferenceCursors,
   ReferenceLines,
   ScaleOverlayTool,
+  EraserTool,
   // Segmentation Display
   SegmentationDisplayTool,
   // Segmentation Editing Tools

package/src/tools/AnnotationEraserTool.ts

@@ -0,0 +1,96 @@
+import { BaseTool } from './base';
+import { EventTypes, PublicToolProps, ToolProps } from '../types';
+import { ToolGroupManager } from '../store';
+import {
+  getAnnotations,
+  removeAnnotation,
+} from '../stateManagement/annotation/annotationState';
+import { setAnnotationSelected } from '../stateManagement/annotation/annotationSelection';
+
+class AnnotationEraserTool extends BaseTool {
+  static toolName;
+  constructor(
+    toolProps: PublicToolProps = {},
+    defaultToolProps: ToolProps = {
+      supportedInteractionTypes: ['Mouse', 'Touch'],
+    }
+  ) {
+    super(toolProps, defaultToolProps);
+  }
+  preMouseDownCallback = (evt: EventTypes.InteractionEventType): boolean => {
+    return this._deleteNearbyAnnotations(evt, 'mouse');
+  };
+  preTouchStartCallback = (evt: EventTypes.InteractionEventType): boolean => {
+    return this._deleteNearbyAnnotations(evt, 'touch');
+  };
+
+  _deleteNearbyAnnotations(
+    evt: EventTypes.InteractionEventType,
+    interactionType: string
+  ): boolean {
+    const { renderingEngineId, viewportId, element, currentPoints } =
+      evt.detail;
+
+    const toolGroup = ToolGroupManager.getToolGroupForViewport(
+      viewportId,
+      renderingEngineId
+    );
+
+    if (!toolGroup) {
+      return false;
+    }
+
+    const tools = toolGroup._toolInstances;
+    const annotationsToRemove = [];
+
+    for (const toolName in tools) {
+      const toolInstance = tools[toolName];
+
+      if (
+        typeof toolInstance.isPointNearTool !== 'function' ||
+        typeof toolInstance.filterInteractableAnnotationsForElement !==
+          'function'
+      ) {
+        continue;
+      }
+
+      const annotations = getAnnotations(toolName, element);
+
+      if (!annotations) {
+        continue;
+      }
+
+      const interactableAnnotations =
+        toolInstance.filterInteractableAnnotationsForElement(
+          element,
+          annotations
+        );
+
+      for (const annotation of interactableAnnotations) {
+        if (
+          toolInstance.isPointNearTool(
+            element,
+            annotation,
+            currentPoints.canvas,
+            10,
+            interactionType
+          )
+        ) {
+          annotationsToRemove.push(annotation.annotationUID);
+        }
+      }
+    }
+
+    for (const annotationUID of annotationsToRemove) {
+      setAnnotationSelected(annotationUID);
+      removeAnnotation(annotationUID);
+    }
+
+    evt.preventDefault();
+
+    return true;
+  }
+}
+
+AnnotationEraserTool.toolName = 'Eraser';
+export default AnnotationEraserTool;

package/src/tools/index.ts

@@ -37,6 +37,7 @@ import AngleTool from './annotation/AngleTool';
 import CobbAngleTool from './annotation/CobbAngleTool';
 import UltrasoundDirectionalTool from './annotation/UltrasoundDirectionalTool';
 import KeyImageTool from './annotation/KeyImageTool';
+import AnnotationEraserTool from './AnnotationEraserTool';
 
 // Segmentation DisplayTool
 import SegmentationDisplayTool from './displayTools/SegmentationDisplayTool';
@@ -90,6 +91,7 @@ export {
   CobbAngleTool,
   UltrasoundDirectionalTool,
   KeyImageTool,
+  AnnotationEraserTool as EraserTool,
   // Segmentations Display
   SegmentationDisplayTool,
   // Segmentations Tools

package/src/utilities/scroll.ts

@@ -86,14 +86,8 @@ export function scrollVolume(
 
   const desiredStepIndex = currentStepIndex + delta;
 
-  if (
-    (desiredStepIndex > numScrollSteps || desiredStepIndex < 0) &&
-    viewport.getCurrentImageId() // Check that we are in the plane of acquistion
-  ) {
-    // One common use case of this trigger might be to load the next
-    // volume in a time series or the next segment of a partially loaded volume.
-
-    const VolumeScrollEventDetail = {
+  const VolumeScrollEventDetail: EventTypes.VolumeScrollOutOfBoundsEventDetail =
+    {
       volumeId,
       viewport,
       delta,
@@ -103,10 +97,23 @@ export function scrollVolume(
       currentImageId: viewport.getCurrentImageId(),
     };
 
+  if (
+    (desiredStepIndex > numScrollSteps || desiredStepIndex < 0) &&
+    viewport.getCurrentImageId() // Check that we are in the plane of acquistion
+  ) {
+    // One common use case of this trigger might be to load the next
+    // volume in a time series or the next segment of a partially loaded volume.
+
     csUtils.triggerEvent(
       eventTarget,
       EVENTS.VOLUME_SCROLL_OUT_OF_BOUNDS,
-      VolumeScrollEventDetail as EventTypes.VolumeScrollOutOfBoundsEventDetail
+      VolumeScrollEventDetail
+    );
+  } else {
+    csUtils.triggerEvent(
+      eventTarget,
+      EVENTS.VOLUME_VIEWPORT_SCROLL,
+      VolumeScrollEventDetail
     );
   }
 }