@cornerstonejs/tools 1.33.0 → 1.35.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "1.33.0",
+  "version": "1.35.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.33.0",
+    "@cornerstonejs/core": "^1.35.0",
     "comlink": "^4.4.1",
     "lodash.clonedeep": "4.5.0",
     "lodash.get": "^4.4.2"
@@ -53,5 +53,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "bcfcf24cacbc6d230a3ddc722823d5ecc05cbb6d"
+  "gitHead": "115719df9d081849d8ee1c3d9c39b3c2249be17c"
 }

package/src/eventDispatchers/mouseEventHandlers/mouseDown.ts

@@ -82,6 +82,14 @@ export default function mouseDown(evt: EventTypes.MouseDownEventType) {
     ...(passiveToolsIfEventWasPrimaryMouseButton || []),
   ];
 
+  // Actions need to run before tool/handle selected callbacks otherwise actions
+  // like the one from SplineTool to remove/add control points would not work.
+  const actionExecuted = mouseDownAnnotationAction(evt);
+
+  if (actionExecuted) {
+    return;
+  }
+
   const eventDetail = evt.detail;
   const { element } = eventDetail;
 
@@ -151,12 +159,6 @@ export default function mouseDown(evt: EventTypes.MouseDownEventType) {
     }
   }
 
-  const actionExecuted = mouseDownAnnotationAction(evt);
-
-  if (actionExecuted) {
-    return;
-  }
-
   // Don't stop propagation so that mouseDownActivate can handle the event
 }
 

package/src/eventDispatchers/shared/getToolsWithActionsForMouseEvent.ts

@@ -41,14 +41,15 @@ export default function getToolsWithActionsForMouseEvent(
   for (let j = 0; j < toolGroupToolNames.length; j++) {
     const toolName = toolGroupToolNames[j];
     const tool = toolGroup.getToolInstance(toolName);
-    const actions = tool.configuration?.actions;
+    const actionsConfig = tool.configuration?.actions ?? {};
+    const actions = Object.values(actionsConfig);
 
     if (!actions?.length || !toolModes.includes(tool.mode)) {
       continue;
     }
 
     const action = actions.find(
-      (action) =>
+      (action: any) =>
         action.bindings.length &&
         action.bindings.some(
           (binding) =>

package/src/index.ts

@@ -39,6 +39,7 @@ import {
   RectangleROITool,
   EllipticalROITool,
   CircleROITool,
+  SplineROITool,
   BidirectionalTool,
   PlanarFreehandROITool,
   ArrowAnnotateTool,
@@ -102,6 +103,7 @@ export {
   RectangleROITool,
   EllipticalROITool,
   CircleROITool,
+  SplineROITool,
   BidirectionalTool,
   PlanarFreehandROITool,
   ArrowAnnotateTool,

package/src/store/SynchronizerManager/Synchronizer.ts

@@ -17,6 +17,7 @@ class Synchronizer {
   //
   private _enabled: boolean;
   private _eventName: string;
+  private _auxiliaryEventNames: string[];
   private _eventHandler: ISynchronizerEventHandler;
   private _ignoreFiredEvents: boolean;
   private _sourceViewports: Array<Types.IViewportId>;
@@ -38,6 +39,7 @@ class Synchronizer {
     this._sourceViewports = [];
     this._targetViewports = [];
     this._options = options || {};
+    this._auxiliaryEventNames = this._options.auxiliaryEventNames || [];
 
     //
     this.id = synchronizerId;
@@ -89,11 +91,26 @@ class Synchronizer {
 
     const { renderingEngineId, viewportId } = viewportInfo;
 
-    const { element } =
+    const viewport =
       getRenderingEngine(renderingEngineId).getViewport(viewportId);
 
-    // @ts-ignore
+    if (!viewport) {
+      console.warn(
+        `Synchronizer.addSource: No viewport for ${renderingEngineId} ${viewportId}`
+      );
+      return;
+    }
+
+    const element = viewport.element;
+
     element.addEventListener(this._eventName, this._onEvent.bind(this));
+
+    if (this._auxiliaryEventNames.length) {
+      this._auxiliaryEventNames.forEach((eventName) => {
+        element.addEventListener(eventName, this._onEvent.bind(this));
+      });
+    }
+
     this._updateDisableHandlers();
 
     this._sourceViewports.push(viewportInfo);
@@ -157,8 +174,16 @@ class Synchronizer {
     const element = _getViewportElement(viewportInfo);
 
     this._sourceViewports.splice(index, 1);
-    // @ts-ignore
+
+    //@ts-ignore
     element.removeEventListener(this._eventName, this._eventHandler);
+
+    if (this._auxiliaryEventNames) {
+      this._auxiliaryEventNames.forEach((eventName) => {
+        //@ts-ignore
+        element.removeEventListener(eventName, this._eventHandler);
+      });
+    }
     this._updateDisableHandlers();
   }
 

package/src/synchronizers/callbacks/areViewportsCoplanar .ts

@@ -2,8 +2,8 @@ import { vec3 } from 'gl-matrix';
 import { Types } from '@cornerstonejs/core';
 
 export default function areViewportsCoplanar(
-  viewport1: Types.IStackViewport,
-  viewport2: Types.IStackViewport
+  viewport1: Types.IStackViewport | Types.IVolumeViewport,
+  viewport2: Types.IStackViewport | Types.IVolumeViewport
 ): boolean {
   const { viewPlaneNormal: viewPlaneNormal1 } = viewport1.getCamera();
   const { viewPlaneNormal: viewPlaneNormal2 } = viewport2.getCamera();

package/src/synchronizers/callbacks/{stackImageSyncCallback.ts → imageSliceSyncCallback.ts}

@@ -4,6 +4,7 @@ import {
   Types,
   metaData,
   utilities,
+  VolumeViewport,
 } from '@cornerstonejs/core';
 import { Synchronizer } from '../../store';
 import { jumpToSlice } from '../../utilities';
@@ -37,7 +38,7 @@ const getSpatialRegistration = (targetId, sourceId) =>
  *   the same as sourceViewport.
  * @param cameraModifiedEvent - The CAMERA_MODIFIED event.
  */
-export default async function stackImageSyncCallback(
+export default async function imageSliceSyncCallback(
   synchronizerInstance: Synchronizer,
   sourceViewport: Types.IViewportId,
   targetViewport: Types.IViewportId
@@ -49,9 +50,9 @@ export default async function stackImageSyncCallback(
     );
   }
 
-  const sViewport = renderingEngine.getViewport(
-    sourceViewport.viewportId
-  ) as Types.IStackViewport;
+  const sViewport = renderingEngine.getViewport(sourceViewport.viewportId) as
+    | Types.IVolumeViewport
+    | Types.IStackViewport;
 
   const options = synchronizerInstance.getOptions(targetViewport.viewportId);
 
@@ -59,9 +60,9 @@ export default async function stackImageSyncCallback(
     return;
   }
 
-  const tViewport = renderingEngine.getViewport(
-    targetViewport.viewportId
-  ) as Types.IStackViewport;
+  const tViewport = renderingEngine.getViewport(targetViewport.viewportId) as
+    | Types.IVolumeViewport
+    | Types.IStackViewport;
 
   const imageId1 = sViewport.getCurrentImageId();
   const imagePlaneModule1 = metaData.get('imagePlaneModule', imageId1);
@@ -116,12 +117,19 @@ export default async function stackImageSyncCallback(
     targetImageIds
   );
 
+  let imageIndexToSet = closestImageIdIndex2.index;
+  if (tViewport instanceof VolumeViewport) {
+    // since in case of volume viewport our stack is reversed, we should
+    // reverse the index as well
+    imageIndexToSet = targetImageIds.length - closestImageIdIndex2.index - 1;
+  }
+
   if (
     closestImageIdIndex2.index !== -1 &&
     tViewport.getCurrentImageIdIndex() !== closestImageIdIndex2.index
   ) {
     await jumpToSlice(tViewport.element, {
-      imageIndex: closestImageIdIndex2.index,
+      imageIndex: imageIndexToSet,
     });
   }
 }

package/src/synchronizers/index.ts

@@ -1,11 +1,15 @@
 import createCameraPositionSynchronizer from './synchronizers/createCameraPositionSynchronizer';
 import createVOISynchronizer from './synchronizers/createVOISynchronizer';
 import createZoomPanSynchronizer from './synchronizers/createZoomPanSynchronizer';
-import createStackImageSynchronizer from './synchronizers/createStackImageSynchronizer';
+import createImageSliceSynchronizer from './synchronizers/createImageSliceSynchronizer';
+
+// for backward compatibility
+const createStackImageSynchronizer = createImageSliceSynchronizer;
 
 export {
   createCameraPositionSynchronizer,
   createVOISynchronizer,
   createZoomPanSynchronizer,
+  createImageSliceSynchronizer,
   createStackImageSynchronizer,
 };

package/src/synchronizers/synchronizers/{createStackImageSynchronizer.ts → createImageSliceSynchronizer.ts}

@@ -1,24 +1,27 @@
 import { createSynchronizer } from '../../store/SynchronizerManager';
 import { Enums } from '@cornerstonejs/core';
-import stackImageSyncCallback from '../callbacks/stackImageSyncCallback';
+import imageSliceSyncCallback from '../callbacks/imageSliceSyncCallback';
 import Synchronizer from '../../store/SynchronizerManager/Synchronizer';
 
-const { STACK_NEW_IMAGE } = Enums.Events;
+const { STACK_NEW_IMAGE, VOLUME_NEW_IMAGE } = Enums.Events;
 
 /**
  * A helper that creates a new `Synchronizer` which listens to the `STACK_NEW_IMAGE`
- * rendering event and calls the `stackImageSyncCallback`.
+ * rendering event and calls the `ImageSliceSyncCallback`.
  *
  * @param synchronizerName - The name of the synchronizer.
  * @returns A new `Synchronizer` instance.
  */
-export default function createStackImageSynchronizer(
+export default function createImageSliceSynchronizer(
   synchronizerName: string
 ): Synchronizer {
   const stackImageSynchronizer = createSynchronizer(
     synchronizerName,
     STACK_NEW_IMAGE,
-    stackImageSyncCallback
+    imageSliceSyncCallback,
+    {
+      auxiliaryEventNames: [VOLUME_NEW_IMAGE],
+    }
   );
 
   return stackImageSynchronizer;

package/src/synchronizers/synchronizers/index.ts

@@ -1,11 +1,14 @@
 import createCameraPositionSynchronizer from './createCameraPositionSynchronizer';
 import createVOISynchronizer from './createVOISynchronizer';
 import createZoomPanSynchronizer from './createZoomPanSynchronizer';
-import createStackImageSynchronizer from './createStackImageSynchronizer';
+import createImageSliceSynchronizer from './createImageSliceSynchronizer';
 
+// for backward compatibility
+const createStackImageSynchronizer = createImageSliceSynchronizer;
 export {
   createCameraPositionSynchronizer,
   createVOISynchronizer,
   createZoomPanSynchronizer,
+  createImageSliceSynchronizer,
   createStackImageSynchronizer,
 };

package/src/tools/AdvancedMagnifyTool.ts

@@ -41,8 +41,13 @@ import { getCanvasCircleRadius } from '../utilities/math/circle';
 import AdvancedMagnifyViewportManager from './AdvancedMagnifyViewportManager';
 import type { AutoPanCallbackData } from './AdvancedMagnifyViewport';
 
+enum AdvancedMagnifyToolActions {
+  ShowZoomFactorsList = 'showZoomFactorsList',
+}
+
 class AdvancedMagnifyTool extends AnnotationTool {
   static toolName;
+  static Actions = AdvancedMagnifyToolActions;
 
   magnifyViewportManager: AdvancedMagnifyViewportManager;
   touchDragCallback: any;
@@ -71,8 +76,8 @@ class AdvancedMagnifyTool extends AnnotationTool {
             padding: 10, // px
           },
         },
-        actions: [
-          {
+        actions: {
+          showZoomFactorsList: {
             method: 'showZoomFactorsList',
             bindings: [
               {
@@ -81,7 +86,7 @@ class AdvancedMagnifyTool extends AnnotationTool {
               },
             ],
           },
-        ],
+        },
       },
     }
   ) {