@cornerstonejs/tools 1.77.10 → 1.77.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "1.77.10",
+  "version": "1.77.12",
   "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.77.10",
+    "@cornerstonejs/core": "^1.77.12",
     "@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": "5a8f63706edda3d61c78e6bb05aa3e494d3e5610"
+  "gitHead": "21f9869a43912ca4a1eb70391d439e9e11252f07"
 }

package/src/stateManagement/annotation/FrameOfReferenceSpecificAnnotationManager.ts

@@ -285,16 +285,34 @@ class FrameOfReferenceSpecificAnnotationManager implements IAnnotationManager {
    *
    * @param groupKey - The group key to remove annotations for (in default manager it is FrameOfReferenceUID).
    * @param toolName - Optional. The name of the tool to remove annotations for.
+   *
+   * @returns The removed annotations
    */
-  removeAnnotations = (groupKey: string, toolName?: string): void => {
+  removeAnnotations = (groupKey: string, toolName?: string): Annotations => {
     const annotations = this.annotations;
-    if (annotations[groupKey]) {
-      if (toolName) {
-        delete annotations[groupKey][toolName];
-      } else {
-        delete annotations[groupKey];
+    const removedAnnotations = [];
+
+    if (!annotations[groupKey]) {
+      return removedAnnotations;
+    }
+
+    if (toolName) {
+      const annotationsForTool = annotations[groupKey][toolName];
+      for (const annotation of annotationsForTool) {
+        this.removeAnnotation(annotation.annotationUID);
+        removedAnnotations.push(annotation);
+      }
+    } else {
+      for (const toolName in annotations[groupKey]) {
+        const annotationsForTool = annotations[groupKey][toolName];
+        for (const annotation of annotationsForTool) {
+          this.removeAnnotation(annotation.annotationUID);
+          removedAnnotations.push(annotation);
+        }
       }
     }
+
+    return removedAnnotations;
   };
 
   /**
@@ -407,9 +425,18 @@ class FrameOfReferenceSpecificAnnotationManager implements IAnnotationManager {
 
   /**
    * Removes all annotations in the annotation state.
+   *
+   * @returns The removed annotations
    */
-  removeAllAnnotations = (): void => {
-    this.annotations = {};
+  removeAllAnnotations = (): Annotations => {
+    const removedAnnotations = [];
+
+    for (const annotation of this.getAllAnnotations()) {
+      this.removeAnnotation(annotation.annotationUID);
+      removedAnnotations.push(annotation);
+    }
+
+    return removedAnnotations;
   };
 }
 

package/src/stateManagement/annotation/annotationState.ts

@@ -1,16 +1,12 @@
-import {
-  triggerEvent,
-  eventTarget,
-  utilities as csUtils,
-} from '@cornerstonejs/core';
-import { Events } from '../../enums';
+import { utilities as csUtils } from '@cornerstonejs/core';
 import { defaultFrameOfReferenceSpecificAnnotationManager } from './FrameOfReferenceSpecificAnnotationManager';
 import { Annotations, Annotation } from '../../types/AnnotationTypes';
-import { AnnotationRemovedEventDetail } from '../../types/EventTypes';
 import { AnnotationGroupSelector } from '../../types';
+
 import {
   triggerAnnotationAddedForElement,
   triggerAnnotationAddedForFOR,
+  triggerAnnotationRemoved,
 } from './helpers/state';
 
 // our default annotation manager
@@ -224,15 +220,7 @@ function removeAnnotation(annotationUID: string): void {
 
   manager.removeAnnotation(annotationUID);
 
-  // trigger annotation removed
-  const eventType = Events.ANNOTATION_REMOVED;
-
-  const eventDetail: AnnotationRemovedEventDetail = {
-    annotation,
-    annotationManagerUID: manager.uid,
-  };
-
-  triggerEvent(eventTarget, eventType, eventDetail);
+  triggerAnnotationRemoved({ annotation, annotationManagerUID: manager.uid });
 }
 
 /**
@@ -251,7 +239,36 @@ function getAnnotation(annotationUID: string): Annotation {
  */
 function removeAllAnnotations(): void {
   const manager = getAnnotationManager();
-  manager.removeAllAnnotations();
+  const removedAnnotations = manager.removeAllAnnotations();
+
+  for (const annotation of removedAnnotations) {
+    triggerAnnotationRemoved({
+      annotation,
+      annotationManagerUID: manager.uid,
+    });
+  }
+}
+
+/**
+ * Removes all annotations associated with the specified group (FrameOfReferenceUID) and tool, or
+ * all annotations for the group (FrameOfReferenceUID) if the tool name is not provided.
+ * @param toolName - Optional. The name of the tool to remove annotations for.
+ * @param annotationGroupSelector - The group (FrameOfReferenceUID) to remove annotations for.
+ */
+function removeAnnotations(
+  toolName: string,
+  annotationGroupSelector: AnnotationGroupSelector
+): void {
+  const manager = getAnnotationManager();
+  const groupKey = manager.getGroupKey(annotationGroupSelector);
+  const removedAnnotations = manager.removeAnnotations(groupKey, toolName);
+
+  for (const annotation of removedAnnotations) {
+    triggerAnnotationRemoved({
+      annotation,
+      annotationManagerUID: manager.uid,
+    });
+  }
 }
 
 /**
@@ -281,6 +298,7 @@ export {
   addAnnotation,
   getAnnotation,
   removeAnnotation,
+  removeAnnotations,
   removeAllAnnotations,
   // annotation manager
   setAnnotationManager,

package/src/stateManagement/annotation/helpers/state.ts

@@ -12,6 +12,7 @@ import {
   AnnotationModifiedEventDetail,
   AnnotationCompletedEventDetail,
   ContourAnnotationCompletedEventDetail,
+  AnnotationRemovedEventDetail,
 } from '../../../types/EventTypes';
 
 /**
@@ -81,6 +82,17 @@ function triggerAnnotationAddedForFOR(annotation: Annotation) {
   });
 }
 
+/**
+ * Triggers an annotation removed event.
+ * @param eventDetail - Event detail
+ */
+function triggerAnnotationRemoved(
+  eventDetail: AnnotationRemovedEventDetail
+): void {
+  const eventType = Events.ANNOTATION_REMOVED;
+  triggerEvent(eventTarget, eventType, eventDetail);
+}
+
 /**
  * Triggers an annotation modified event.
  */
@@ -143,6 +155,7 @@ function _triggerAnnotationCompleted(
 export {
   triggerAnnotationAddedForElement,
   triggerAnnotationAddedForFOR,
+  triggerAnnotationRemoved,
   triggerAnnotationModified,
   triggerAnnotationCompleted,
   triggerContourAnnotationCompleted,

package/src/utilities/stackPrefetch/stackContextPrefetch.ts

@@ -164,7 +164,7 @@ function prefetch(element) {
     imageLoadPoolManager.filterRequests(clearFromImageIds(stack));
   }
 
-  function doneCallback(imageId) {
+  function doneCallback(imageId: string) {
     const imageIdIndex = stack.imageIds.indexOf(imageId);
 
     removeFromList(imageIdIndex);
@@ -222,7 +222,7 @@ function prefetch(element) {
 
   const useNativeDataType = useNorm16Texture || preferSizeOverAccuracy;
 
-  indicesToRequestCopy.forEach((imageIdIndex) => {
+  stackPrefetch.indicesToRequest.forEach((imageIdIndex) => {
     const imageId = stack.imageIds[imageIdIndex];
     // IMPORTANT: Request type should be passed if not the 'interaction'
     // highest priority will be used for the request type in the imageRetrievalPool
@@ -360,7 +360,7 @@ function disable(element) {
   const stackPrefetchData = getToolState(element);
   // If there is actually something to disable, disable it
 
-  if (stackPrefetchData && stackPrefetchData.data.length) {
+  if (stackPrefetchData) {
     stackPrefetchData.enabled = false;
     // Don't worry about clearing the requests - there aren't that many too be bothersome
   }