@cornerstonejs/tools 1.8.1 → 1.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "1.8.1",
+  "version": "1.9.0",
   "description": "Cornerstone3D Tools",
   "main": "dist/umd/index.js",
   "types": "dist/esm/index.d.ts",
@@ -29,7 +29,7 @@
     "webpack:watch": "webpack --mode development --progress --watch  --config ./.webpack/webpack.dev.js"
   },
   "dependencies": {
-    "@cornerstonejs/core": "^1.8.1",
+    "@cornerstonejs/core": "^1.9.0",
     "lodash.clonedeep": "4.5.0",
     "lodash.get": "^4.4.2"
   },
@@ -52,5 +52,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "04ab5157739660d5bd012ae6c558afb01e9b3565"
+  "gitHead": "9330feafe97d0b7ce13e94de98d3d136ff2533f0"
 }

package/src/store/SynchronizerManager/Synchronizer.ts

@@ -22,12 +22,14 @@ class Synchronizer {
   private _sourceViewports: Array<Types.IViewportId>;
   private _targetViewports: Array<Types.IViewportId>;
   private _viewportOptions: Record<string, Record<string, unknown>> = {};
+  private _options: any;
   public id: string;
 
   constructor(
     synchronizerId: string,
     eventName: string,
-    eventHandler: ISynchronizerEventHandler
+    eventHandler: ISynchronizerEventHandler,
+    options?: any
   ) {
     this._enabled = true;
     this._eventName = eventName;
@@ -35,6 +37,7 @@ class Synchronizer {
     this._ignoreFiredEvents = false;
     this._sourceViewports = [];
     this._targetViewports = [];
+    this._options = options || {};
 
     //
     this.id = synchronizerId;
@@ -212,7 +215,13 @@ class Synchronizer {
           continue;
         }
 
-        this._eventHandler(this, sourceViewport, targetViewport, sourceEvent);
+        this._eventHandler(
+          this,
+          sourceViewport,
+          targetViewport,
+          sourceEvent,
+          this._options
+        );
       }
     } catch (ex) {
       console.warn(`Synchronizer, for: ${this._eventName}`, ex);

package/src/store/SynchronizerManager/createSynchronizer.ts

@@ -9,12 +9,14 @@ import { ISynchronizerEventHandler } from '../../types';
  * synchronizer.
  * @param eventHandler - The event handler that will be
  * called when the event is emitted.
+ * @param options - Options for the synchronizer.
  * @returns A reference to the synchronizer.
  */
 function createSynchronizer(
   synchronizerId: string,
   eventName: string,
-  eventHandler: ISynchronizerEventHandler
+  eventHandler: ISynchronizerEventHandler,
+  options?: any
 ): Synchronizer {
   const synchronizerWithSameIdExists = state.synchronizers.some(
     (sync) => sync.id === synchronizerId
@@ -28,7 +30,8 @@ function createSynchronizer(
   const synchronizer = new Synchronizer(
     synchronizerId,
     eventName,
-    eventHandler
+    eventHandler,
+    options
   );
 
   // Update state

package/src/synchronizers/callbacks/voiSyncCallback.ts

@@ -13,12 +13,14 @@ import {
  * @param sourceViewport - The list of IDs defining the source viewport.
  * @param targetViewport - The list of IDs defining the target viewport.
  * @param voiModifiedEvent - The VOI_MODIFIED event.
+ * @param options - Options for the synchronizer.
  */
 export default function voiSyncCallback(
   synchronizerInstance,
   sourceViewport: Types.IViewportId,
   targetViewport: Types.IViewportId,
-  voiModifiedEvent: Types.EventTypes.VoiModifiedEvent
+  voiModifiedEvent: Types.EventTypes.VoiModifiedEvent,
+  options?: any
 ): void {
   const eventDetail = voiModifiedEvent.detail;
   const { volumeId, range, invertStateChanged, invert } = eventDetail;
@@ -37,7 +39,7 @@ export default function voiSyncCallback(
     voiRange: range,
   };
 
-  if (invertStateChanged) {
+  if (options.syncInvertState && invertStateChanged) {
     tProperties.invert = invert;
   }
 

package/src/synchronizers/synchronizers/createVOISynchronizer.ts

@@ -3,21 +3,30 @@ import { Enums } from '@cornerstonejs/core';
 import voiSyncCallback from '../callbacks/voiSyncCallback';
 import Synchronizer from '../../store/SynchronizerManager/Synchronizer';
 
+type VOISynchronizerOptions = {
+  syncInvertState: boolean;
+};
+
 /**
  * A helper that creates a new `Synchronizer`
  * which listens to the `VOI_MODIFIED` rendering event and calls the `voiSyncCallback`.
  *
  * @param synchronizerName - The name of the synchronizer.
+ * @param options - The options for the synchronizer. By default the voi
+ * synchronizer will also sync the invert state of the volume, but this can be
+ * disabled by setting `syncInvertState` to false.
  *
  * @returns A new `Synchronizer` instance.
  */
 export default function createVOISynchronizer(
-  synchronizerName: string
+  synchronizerName: string,
+  options = { syncInvertState: true } as VOISynchronizerOptions
 ): Synchronizer {
   const VOISynchronizer = createSynchronizer(
     synchronizerName,
     Enums.Events.VOI_MODIFIED,
-    voiSyncCallback
+    voiSyncCallback,
+    options
   );
 
   return VOISynchronizer;

package/src/types/ISynchronizerEventHandler.ts

@@ -6,6 +6,7 @@ export default interface ISynchronizerEventHandler {
     synchronizer: Synchronizer,
     sourceViewport: Types.IViewportId,
     targetViewport: Types.IViewportId,
-    sourceEvent: any
+    sourceEvent: any,
+    options?: any
   ): void;
 }