fix(events): ANNOTATION_REMOVED event listener on removing ALL annota…

…tions. (#1236)

* Fix ANNOTATION_REMOVED event listener on removing ALL annotations.

* I think the tests expect the annotation to be removed BEFORE the event fires

* This should work if the removeAnnotation code is correct.

* retrigger checks

* Move events into annotationState

* Make annotationState function more in-line with other functions

* make api consistent

* api

---------

Co-authored-by: Alireza <ar.sedghi@gmail.com>

common/reviews/api/tools.api.md

@@ -2463,11 +2463,11 @@ class FrameOfReferenceSpecificAnnotationManager implements IAnnotationManager {
     // (undocumented)
     _imageVolumeModifiedHandler: (evt: Types_2.EventTypes.ImageVolumeModifiedEvent) => void;
     // (undocumented)
-    removeAllAnnotations: () => void;
+    removeAllAnnotations: () => Annotations;
     // (undocumented)
     removeAnnotation: (annotationUID: string) => void;
     // (undocumented)
-    removeAnnotations: (groupKey: string, toolName?: string) => void;
+    removeAnnotations: (groupKey: string, toolName?: string) => Annotations;
     // (undocumented)
     restoreAnnotations: (state: AnnotationState | GroupSpecificAnnotations | Annotations, groupKey?: string, toolName?: string) => void;
     // (undocumented)
@@ -4565,6 +4565,9 @@ function removeAllAnnotations(): void;
 // @public (undocumented)
 function removeAnnotation(annotationUID: string): void;
 
+// @public (undocumented)
+function removeAnnotations(toolName: string, annotationGroupSelector: AnnotationGroupSelector): void;
+
 // @public (undocumented)
 function removeColorLUT(colorLUTIndex: number): void;
 
@@ -5283,6 +5286,7 @@ declare namespace state_2 {
         addAnnotation,
         getAnnotation,
         removeAnnotation,
+        removeAnnotations,
         removeAllAnnotations,
         setAnnotationManager,
         getAnnotationManager,

packages/tools/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;
   };
 }
 

packages/tools/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,

packages/tools/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,