@cornerstonejs/tools 1.66.3 → 1.66.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "1.66.3",
+  "version": "1.66.4",
   "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.66.3",
+    "@cornerstonejs/core": "^1.66.4",
     "@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": "5dcb513f1cf32f85739c47416879eb4fe1a0afc4"
+  "gitHead": "4d12d9d2ecf38805e7c9ca7e93bf36372bfe85ff"
 }

package/src/store/ToolGroupManager/ToolGroup.ts

@@ -90,6 +90,15 @@ export default class ToolGroup implements IToolGroup {
     return toolInstance;
   }
 
+  /**
+   * Retrieves the tool instances associated with this tool group.
+   *
+   * @returns A record containing the tool instances, where the keys are the tool names and the values are the tool instances.
+   */
+  public getToolInstances(): Record<string, any> {
+    return this._toolInstances;
+  }
+
   /**
    * Check if a tool is already added to the tool group
    * @param toolName - Tool name
@@ -658,7 +667,8 @@ export default class ToolGroup implements IToolGroup {
     configuration: ToolConfiguration,
     overwrite?: boolean
   ): boolean {
-    if (this._toolInstances[toolName] === undefined) {
+    const toolInstance = this._toolInstances[toolName];
+    if (toolInstance === undefined) {
       console.warn(
         `Tool ${toolName} not present, can't set tool configuration.`
       );
@@ -673,13 +683,14 @@ export default class ToolGroup implements IToolGroup {
       // We should not deep copy here, it is the job of the application to
       // deep copy the configuration before passing it to the toolGroup, otherwise
       // some strange appending behaviour happens for the arrays
-      _configuration = Object.assign(
-        this._toolInstances[toolName].configuration,
-        configuration
-      );
+      _configuration = Object.assign(toolInstance.configuration, configuration);
     }
 
-    this._toolInstances[toolName].configuration = _configuration;
+    toolInstance.configuration = _configuration;
+
+    if (typeof toolInstance.onSetToolConfiguration === 'function') {
+      toolInstance.onSetToolConfiguration();
+    }
 
     this._renderViewports();
 

package/src/tools/CrosshairsTool.ts

@@ -311,6 +311,28 @@ class CrosshairsTool extends AnnotationTool {
     });
   }
 
+  resetCrosshairs = () => {
+    const viewportsInfo = this._getViewportsInfo();
+    viewportsInfo.forEach(({ viewportId, renderingEngineId }) => {
+      const enabledElement = getEnabledElementByIds(
+        viewportId,
+        renderingEngineId
+      );
+      const { viewport } = enabledElement;
+      const { element } = viewport;
+      let annotations = this._getAnnotations(enabledElement);
+      annotations = this.filterInteractableAnnotationsForElement(
+        element,
+        annotations
+      );
+      if (annotations.length) {
+        removeAnnotation(annotations[0].annotationUID);
+      }
+    });
+
+    this.computeToolCenter(viewportsInfo);
+  };
+
   /**
    * When activated, it initializes the crosshairs. It begins by computing
    * the intersection of viewports associated with the crosshairs instance.

package/src/tools/ReferenceLinesTool.ts

@@ -4,7 +4,7 @@ import {
   CONSTANTS,
   utilities as csUtils,
 } from '@cornerstonejs/core';
-import type { Types } from '@cornerstonejs/core';
+import { type Types, getEnabledElementByViewportId } from '@cornerstonejs/core';
 
 import { addAnnotation } from '../stateManagement/annotation/annotationState';
 
@@ -21,7 +21,6 @@ const { EPSILON } = CONSTANTS;
 /**
  * @public
  */
-
 class ReferenceLines extends AnnotationDisplayTool {
   static toolName;
 
@@ -30,7 +29,7 @@ class ReferenceLines extends AnnotationDisplayTool {
   _throttledCalculateCachedStats: any;
   editData: {
     renderingEngine: any;
-    sourceViewport: any;
+    sourceViewportId: string;
     annotation: ReferenceLineAnnotation;
   } | null = {} as any;
   isDrawing: boolean;
@@ -71,7 +70,7 @@ class ReferenceLines extends AnnotationDisplayTool {
       this.configuration.sourceViewportId
     ) as Types.IVolumeViewport;
 
-    if (!sourceViewport || !sourceViewport.getImageData()) {
+    if (!sourceViewport?.getImageData()) {
       return;
     }
 
@@ -110,7 +109,7 @@ class ReferenceLines extends AnnotationDisplayTool {
     }
 
     this.editData = {
-      sourceViewport,
+      sourceViewportId: sourceViewport.id,
       renderingEngine,
       annotation,
     };
@@ -127,6 +126,10 @@ class ReferenceLines extends AnnotationDisplayTool {
     this._init();
   };
 
+  onSetToolConfiguration = (): void => {
+    this._init();
+  };
+
   onCameraModified = (evt: Types.EventTypes.CameraModifiedEvent): void => {
     // If the camera is modified, we need to update the reference lines
     // we really don't care which viewport triggered the
@@ -148,10 +151,15 @@ class ReferenceLines extends AnnotationDisplayTool {
     svgDrawingHelper: SVGDrawingHelper
   ): boolean => {
     const { viewport: targetViewport } = enabledElement;
-    const { annotation, sourceViewport } = this.editData;
+    const { annotation, sourceViewportId } = this.editData;
 
     let renderStatus = false;
 
+    // we need to grab the viewport again since there might have been
+    // a change in the viewport state since the last time we cached it
+    const { viewport: sourceViewport } =
+      getEnabledElementByViewportId(sourceViewportId) || {};
+
     if (!sourceViewport) {
       return renderStatus;
     }

package/src/tools/segmentation/RectangleROIStartEndThresholdTool.ts

@@ -395,7 +395,7 @@ class RectangleROIStartEndThresholdTool extends RectangleROITool {
 
   _calculateCachedStatsTool(annotation, enabledElement) {
     const data = annotation.data;
-    const { element, viewport } = enabledElement;
+    const { viewport } = enabledElement;
 
     const { cachedStats } = data;
     const targetId = this.getTargetId(viewport);
@@ -409,7 +409,7 @@ class RectangleROIStartEndThresholdTool extends RectangleROITool {
     annotation.invalidated = false;
 
     // Dispatching annotation modified
-    triggerAnnotationModified(annotation, element);
+    triggerAnnotationModified(annotation, viewport.element);
 
     return cachedStats;
   }

package/src/utilities/cine/playClip.ts

@@ -11,7 +11,7 @@ import {
 
 import { Types } from '@cornerstonejs/core';
 import CINE_EVENTS from './events';
-import { addToolState, getToolState } from './state';
+import { addToolState, getToolState, getToolStateByViewportId } from './state';
 import { CINETypes } from '../../types';
 import scroll from '../scroll';
 
@@ -83,7 +83,10 @@ function playClip(
     // Make sure the specified clip is not running before any property update.
     // If a 3D CINE was playing it passes isDynamicCinePlaying as FALSE to
     // prevent stopping a 4D CINE in case it is playing on another viewport.
-    _stopClip(element, isDynamicCinePlaying);
+    _stopClip(element, {
+      stopDynamicCine: !isDynamicCinePlaying,
+      viewportId: viewport.id,
+    });
   }
 
   playClipData.dynamicCineEnabled = playClipOptions.dynamicCineEnabled;
@@ -125,7 +128,10 @@ function playClip(
     if (!loop && newStepIndexOutOfRange) {
       // If a 3D CINE was playing it passes isDynamicCinePlaying as FALSE to
       // prevent stopping a 4D CINE in case it is playing on another viewport.
-      _stopClip(element, isDynamicCinePlaying);
+      _stopClip(element, {
+        stopDynamicCine: !isDynamicCinePlaying,
+        viewportId: viewport.id,
+      });
 
       const eventDetail = { element };
 
@@ -189,23 +195,40 @@ function playClip(
  * Stops an already playing clip.
  * @param element - HTML Element
  */
-function stopClip(element: HTMLDivElement): void {
-  _stopClip(element, true);
+function stopClip(element: HTMLDivElement, viewportId?: string): void {
+  _stopClip(element, {
+    stopDynamicCine: true,
+    viewportId,
+  });
 }
 
-function _stopClip(element: HTMLDivElement, stopDynamicCine: boolean): void {
+function _stopClip(
+  element: HTMLDivElement,
+  options = { stopDynamicCine: true, viewportId: undefined }
+) {
+  const { stopDynamicCine, viewportId } = options;
   const enabledElement = getEnabledElement(element);
+
+  let toolState;
   if (!enabledElement) {
-    return;
+    if (viewportId) {
+      toolState = getToolStateByViewportId(viewportId);
+    } else {
+      return;
+    }
+  } else {
+    const { viewport } = enabledElement;
+    toolState = getToolState(viewport.element);
   }
-  const { viewport } = enabledElement;
-  const cineToolData = getToolState(viewport.element);
 
-  if (cineToolData) {
-    _stopClipWithData(cineToolData);
+  if (toolState) {
+    _stopClipWithData(toolState);
   }
 
-  if (stopDynamicCine && viewport instanceof BaseVolumeViewport) {
+  if (
+    stopDynamicCine &&
+    enabledElement?.viewport instanceof BaseVolumeViewport
+  ) {
     _stopDynamicVolumeCine(element);
   }
 }

package/src/utilities/cine/state.ts

@@ -15,4 +15,10 @@ function getToolState(element: HTMLDivElement): CINETypes.ToolData | undefined {
   return state[viewportId];
 }
 
-export { addToolState, getToolState };
+function getToolStateByViewportId(
+  viewportId: string
+): CINETypes.ToolData | undefined {
+  return state[viewportId];
+}
+
+export { addToolState, getToolState, getToolStateByViewportId };