@cornerstonejs/tools 1.33.0 → 1.34.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "1.33.0",
+  "version": "1.34.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.34.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": "a1bdeb0d4083453272dbca7e8c5f445d30d1fd4c"
 }

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/dist/cjs/synchronizers/synchronizers/createStackImageSynchronizer.js

@@ -1,15 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const SynchronizerManager_1 = require("../../store/SynchronizerManager");
-const core_1 = require("@cornerstonejs/core");
-const stackImageSyncCallback_1 = __importDefault(require("../callbacks/stackImageSyncCallback"));
-const { STACK_NEW_IMAGE } = core_1.Enums.Events;
-function createStackImageSynchronizer(synchronizerName) {
-    const stackImageSynchronizer = (0, SynchronizerManager_1.createSynchronizer)(synchronizerName, STACK_NEW_IMAGE, stackImageSyncCallback_1.default);
-    return stackImageSynchronizer;
-}
-exports.default = createStackImageSynchronizer;
-//# sourceMappingURL=createStackImageSynchronizer.js.map

package/dist/cjs/synchronizers/synchronizers/createStackImageSynchronizer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"createStackImageSynchronizer.js","sourceRoot":"","sources":["../../../../src/synchronizers/synchronizers/createStackImageSynchronizer.ts"],"names":[],"mappings":";;;;;AAAA,yEAAqE;AACrE,8CAA4C;AAC5C,iGAAyE;AAGzE,MAAM,EAAE,eAAe,EAAE,GAAG,YAAK,CAAC,MAAM,CAAC;AASzC,SAAwB,4BAA4B,CAClD,gBAAwB;IAExB,MAAM,sBAAsB,GAAG,IAAA,wCAAkB,EAC/C,gBAAgB,EAChB,eAAe,EACf,gCAAsB,CACvB,CAAC;IAEF,OAAO,sBAAsB,CAAC;AAChC,CAAC;AAVD,+CAUC"}

package/dist/esm/synchronizers/callbacks/stackImageSyncCallback.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"stackImageSyncCallback.js","sourceRoot":"","sources":["../../../../src/synchronizers/callbacks/stackImageSyncCallback.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EACL,kBAAkB,EAElB,QAAQ,EACR,SAAS,GACV,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,oBAAoB,MAAM,yBAAyB,CAAC;AAE3D,MAAM,sBAAsB,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,CACpD,SAAS,CAAC,mCAAmC,CAAC,GAAG,CAC/C,2BAA2B,EAC3B,QAAQ,EACR,QAAQ,CACT,CAAC;AAuBJ,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,sBAAsB,CAClD,oBAAkC,EAClC,cAAiC,EACjC,cAAiC;IAEjC,MAAM,eAAe,GAAG,kBAAkB,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;IAC7E,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,KAAK,CACb,8BAA8B,cAAc,CAAC,iBAAiB,EAAE,CACjE,CAAC;KACH;IAED,MAAM,SAAS,GAAG,eAAe,CAAC,WAAW,CAC3C,cAAc,CAAC,UAAU,CACF,CAAC;IAE1B,MAAM,OAAO,GAAG,oBAAoB,CAAC,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAE3E,IAAI,OAAO,EAAE,QAAQ,EAAE;QACrB,OAAO;KACR;IAED,MAAM,SAAS,GAAG,eAAe,CAAC,WAAW,CAC3C,cAAc,CAAC,UAAU,CACF,CAAC;IAE1B,MAAM,QAAQ,GAAG,SAAS,CAAC,iBAAiB,EAAE,CAAC;IAC/C,MAAM,iBAAiB,GAAG,QAAQ,CAAC,GAAG,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;IACrE,MAAM,0BAA0B,GAAG,iBAAiB,CAAC,oBAAoB,CAAC;IAE1E,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE/C,IAAI,CAAC,oBAAoB,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE;QAC/C,OAAO;KACR;IAKD,IAAI,sBAAsB,GAAG,sBAAsB,CACjD,cAAc,CAAC,UAAU,EACzB,cAAc,CAAC,UAAU,CAC1B,CAAC;IAEF,IAAI,CAAC,sBAAsB,EAAE;QAC3B,MAAM,oBAAoB,GAAG,SAAS,CAAC,sBAAsB,EAAE,CAAC;QAChE,MAAM,oBAAoB,GAAG,SAAS,CAAC,sBAAsB,EAAE,CAAC;QAChE,IACE,oBAAoB,KAAK,oBAAoB;YAC7C,OAAO,EAAE,kBAAkB,KAAK,KAAK,EACrC;YACA,sBAAsB,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;SACvD;aAAM;YACL,SAAS,CAAC,qCAAqC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YACtE,sBAAsB,GAAG,sBAAsB,CAC7C,cAAc,CAAC,UAAU,EACzB,cAAc,CAAC,UAAU,CAC1B,CAAC;SACH;QACD,IAAI,CAAC,sBAAsB,EAAE;YAC3B,OAAO;SACR;KACF;IAID,MAAM,gDAAgD,GAAG,IAAI,CAAC,aAAa,CACzE,IAAI,CAAC,MAAM,EAAE,EACb,0BAA0B,EAC1B,sBAAsB,CACvB,CAAC;IAIF,MAAM,oBAAoB,GAAG,uBAAuB,CAClD,gDAAgD,EAChD,cAAc,CACf,CAAC;IAEF,IACE,oBAAoB,CAAC,KAAK,KAAK,CAAC,CAAC;QACjC,SAAS,CAAC,sBAAsB,EAAE,KAAK,oBAAoB,CAAC,KAAK,EACjE;QACA,MAAM,WAAW,CAAC,SAAS,CAAC,OAAO,EAAE;YACnC,UAAU,EAAE,oBAAoB,CAAC,KAAK;SACvC,CAAC,CAAC;KACJ;AACH,CAAC;AAED,SAAS,uBAAuB,CAAC,WAAW,EAAE,QAAQ;IAGpD,OAAO,QAAQ,CAAC,MAAM,CACpB,CAAC,mBAAmB,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;QACtC,MAAM,EAAE,oBAAoB,EAAE,GAAG,QAAQ,CAAC,GAAG,CAC3C,kBAAkB,EAClB,OAAO,CACR,CAAC;QACF,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,oBAAoB,EAAE,WAAW,CAAC,CAAC;QAElE,IAAI,QAAQ,GAAG,mBAAmB,CAAC,QAAQ,EAAE;YAC3C,OAAO;gBACL,QAAQ;gBACR,KAAK;aACN,CAAC;SACH;QACD,OAAO,mBAAmB,CAAC;IAC7B,CAAC,EACD;QACE,QAAQ,EAAE,QAAQ;QAClB,KAAK,EAAE,CAAC,CAAC;KACV,CACF,CAAC;AACJ,CAAC"}

package/dist/esm/synchronizers/synchronizers/createStackImageSynchronizer.js

@@ -1,9 +0,0 @@
-import { createSynchronizer } from '../../store/SynchronizerManager';
-import { Enums } from '@cornerstonejs/core';
-import stackImageSyncCallback from '../callbacks/stackImageSyncCallback';
-const { STACK_NEW_IMAGE } = Enums.Events;
-export default function createStackImageSynchronizer(synchronizerName) {
-    const stackImageSynchronizer = createSynchronizer(synchronizerName, STACK_NEW_IMAGE, stackImageSyncCallback);
-    return stackImageSynchronizer;
-}
-//# sourceMappingURL=createStackImageSynchronizer.js.map

package/dist/esm/synchronizers/synchronizers/createStackImageSynchronizer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"createStackImageSynchronizer.js","sourceRoot":"","sources":["../../../../src/synchronizers/synchronizers/createStackImageSynchronizer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAC5C,OAAO,sBAAsB,MAAM,qCAAqC,CAAC;AAGzE,MAAM,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC;AASzC,MAAM,CAAC,OAAO,UAAU,4BAA4B,CAClD,gBAAwB;IAExB,MAAM,sBAAsB,GAAG,kBAAkB,CAC/C,gBAAgB,EAChB,eAAe,EACf,sBAAsB,CACvB,CAAC;IAEF,OAAO,sBAAsB,CAAC;AAChC,CAAC"}

package/dist/types/synchronizers/callbacks/stackImageSyncCallback.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"stackImageSyncCallback.d.ts","sourceRoot":"","sources":["../../../../src/synchronizers/callbacks/stackImageSyncCallback.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,EAGN,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAgC3C,wBAA8B,sBAAsB,CAClD,oBAAoB,EAAE,YAAY,EAClC,cAAc,EAAE,KAAK,CAAC,WAAW,EACjC,cAAc,EAAE,KAAK,CAAC,WAAW,GAChC,OAAO,CAAC,IAAI,CAAC,CAmFf"}

package/dist/types/synchronizers/synchronizers/createStackImageSynchronizer.d.ts

@@ -1,3 +0,0 @@
-import Synchronizer from '../../store/SynchronizerManager/Synchronizer';
-export default function createStackImageSynchronizer(synchronizerName: string): Synchronizer;
-//# sourceMappingURL=createStackImageSynchronizer.d.ts.map

package/dist/types/synchronizers/synchronizers/createStackImageSynchronizer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createStackImageSynchronizer.d.ts","sourceRoot":"","sources":["../../../../src/synchronizers/synchronizers/createStackImageSynchronizer.ts"],"names":[],"mappings":"AAGA,OAAO,YAAY,MAAM,8CAA8C,CAAC;AAWxE,MAAM,CAAC,OAAO,UAAU,4BAA4B,CAClD,gBAAgB,EAAE,MAAM,GACvB,YAAY,CAQd"}