feat(voiSync): add optoins to turn of invert sync for voisync (#708)

cornerstonejs · Jul 28, 2023 · 4f5b5c3 · 4f5b5c3
1 parent 04ab515
commit 4f5b5c3
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 14 deletions.
diff --git a/common/reviews/api/tools.api.md b/common/reviews/api/tools.api.md
@@ -1230,13 +1230,13 @@ function createMergedLabelmapForIndex(labelmaps: Array<Types_2.IImageVolume>, se
 function createStackImageSynchronizer(synchronizerName: string): Synchronizer;
 
 // @public (undocumented)
-function createSynchronizer(synchronizerId: string, eventName: string, eventHandler: ISynchronizerEventHandler): Synchronizer;
+function createSynchronizer(synchronizerId: string, eventName: string, eventHandler: ISynchronizerEventHandler, options?: any): Synchronizer;
 
 // @public (undocumented)
 function createToolGroup(toolGroupId: string): IToolGroup | undefined;
 
 // @public (undocumented)
-function createVOISynchronizer(synchronizerName: string): Synchronizer;
+function createVOISynchronizer(synchronizerName: string, options?: VOISynchronizerOptions): Synchronizer;
 
 // @public (undocumented)
 function createZoomPanSynchronizer(synchronizerName: string): Synchronizer;
@@ -2890,7 +2890,7 @@ function isViewportPreScaled(viewport: Types_2.IStackViewport | Types_2.IVolumeV
 // @public (undocumented)
 interface ISynchronizerEventHandler {
     // (undocumented)
-    (synchronizer: Synchronizer, sourceViewport: Types_2.IViewportId, targetViewport: Types_2.IViewportId, sourceEvent: any): void;
+    (synchronizer: Synchronizer, sourceViewport: Types_2.IViewportId, targetViewport: Types_2.IViewportId, sourceEvent: any, options?: any): void;
 }
 
 // @public (undocumented)
@@ -4945,7 +4945,7 @@ enum Swipe {
 
 // @public (undocumented)
 export class Synchronizer {
-    constructor(synchronizerId: string, eventName: string, eventHandler: ISynchronizerEventHandler);
+    constructor(synchronizerId: string, eventName: string, eventHandler: ISynchronizerEventHandler, options?: any);
     // (undocumented)
     add(viewportInfo: Types_2.IViewportId): void;
     // (undocumented)

diff --git a/packages/dicomImageLoader/.webpack/webpack-base.js b/packages/dicomImageLoader/.webpack/webpack-base.js
@@ -74,7 +74,7 @@ module.exports = {
         use: {
           loader: 'babel-loader',
           options: {
-            cacheDirectory: true,
+            cacheDirectory: false,
           },
         },
       },

diff --git a/packages/tools/src/store/SynchronizerManager/Synchronizer.ts b/packages/tools/src/store/SynchronizerManager/Synchronizer.ts
@@ -22,19 +22,22 @@ 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;
     this._eventHandler = eventHandler;
     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);

diff --git a/packages/tools/src/store/SynchronizerManager/createSynchronizer.ts b/packages/tools/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

diff --git a/packages/tools/src/synchronizers/callbacks/voiSyncCallback.ts b/packages/tools/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;
   }
 

diff --git a/packages/tools/src/synchronizers/synchronizers/createVOISynchronizer.ts b/packages/tools/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;

diff --git a/packages/tools/src/types/ISynchronizerEventHandler.ts b/packages/tools/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;
 }