@cornerstonejs/tools 2.0.0-beta.10 → 2.0.0-beta.11

package/src/tools/annotation/VideoRedactionTool.ts

@@ -129,10 +129,7 @@ class VideoRedactionTool extends AnnotationTool {
 
     evt.preventDefault();
 
-    triggerAnnotationRenderForViewportIds(
-      renderingEngine,
-      viewportUIDsToRender
-    );
+    triggerAnnotationRenderForViewportIds(viewportUIDsToRender);
 
     return annotation;
   };
@@ -211,13 +208,7 @@ class VideoRedactionTool extends AnnotationTool {
 
     hideElementCursor(element);
 
-    const enabledElement = getEnabledElement(element);
-    const { renderingEngine } = enabledElement;
-
-    triggerAnnotationRenderForViewportIds(
-      renderingEngine,
-      viewportUIDsToRender
-    );
+    triggerAnnotationRenderForViewportIds(viewportUIDsToRender);
 
     evt.preventDefault();
   };
@@ -259,13 +250,7 @@ class VideoRedactionTool extends AnnotationTool {
 
     hideElementCursor(element);
 
-    const enabledElement = getEnabledElement(element);
-    const { renderingEngine } = enabledElement;
-
-    triggerAnnotationRenderForViewportIds(
-      renderingEngine,
-      viewportUIDsToRender
-    );
+    triggerAnnotationRenderForViewportIds(viewportUIDsToRender);
 
     evt.preventDefault();
   };
@@ -291,7 +276,6 @@ class VideoRedactionTool extends AnnotationTool {
     resetElementCursor(element);
 
     const enabledElement = getEnabledElement(element);
-    const { renderingEngine } = enabledElement;
 
     this.editData = null;
     this.isDrawing = false;
@@ -303,10 +287,7 @@ class VideoRedactionTool extends AnnotationTool {
       removeAnnotation(annotation.annotationUID);
     }
 
-    triggerAnnotationRenderForViewportIds(
-      renderingEngine,
-      viewportUIDsToRender
-    );
+    triggerAnnotationRenderForViewportIds(viewportUIDsToRender);
   };
 
   _mouseDragCallback = (evt) => {
@@ -400,12 +381,8 @@ class VideoRedactionTool extends AnnotationTool {
     this.editData.hasMoved = true;
 
     const enabledElement = getEnabledElement(element);
-    const { renderingEngine } = enabledElement;
 
-    triggerAnnotationRenderForViewportIds(
-      renderingEngine,
-      viewportUIDsToRender
-    );
+    triggerAnnotationRenderForViewportIds(viewportUIDsToRender);
   };
 
   cancel(element) {
@@ -425,13 +402,7 @@ class VideoRedactionTool extends AnnotationTool {
     data.active = false;
     data.handles.activeHandleIndex = null;
 
-    const enabledElement = getEnabledElement(element);
-    const { renderingEngine } = enabledElement;
-
-    triggerAnnotationRenderForViewportIds(
-      renderingEngine,
-      viewportUIDsToRender
-    );
+    triggerAnnotationRenderForViewportIds(viewportUIDsToRender);
 
     this.editData = null;
     return annotation.metadata.annotationUID;

package/src/tools/annotation/planarFreehandROITool/closedContourEditLoop.ts

@@ -210,7 +210,7 @@ function mouseDragClosedContourEditCallback(
     this.finishEditAndStartNewEdit(evt);
   }
 
-  triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+  triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 }
 
 /**
@@ -252,7 +252,7 @@ function finishEditAndStartNewEdit(evt: EventTypes.InteractionEventType): void {
     snapIndex: undefined,
   };
 
-  triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+  triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 }
 
 /**
@@ -482,7 +482,7 @@ function completeClosedContourEdit(element: HTMLDivElement) {
   this.editData = undefined;
   this.commonData = undefined;
 
-  triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+  triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 
   this.deactivateClosedContourEdit(element);
 }

package/src/tools/annotation/planarFreehandROITool/drawLoop.ts

@@ -165,7 +165,7 @@ function mouseDragDrawCallback(evt: EventTypes.InteractionEventType): void {
     }
   }
 
-  triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+  triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 }
 
 /**
@@ -258,7 +258,7 @@ function completeDrawClosedContour(
   this.drawData = undefined;
   this.commonData = undefined;
 
-  triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+  triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 
   this.deactivateDraw(element);
 
@@ -358,7 +358,7 @@ function completeDrawOpenContour(
   this.drawData = undefined;
   this.commonData = undefined;
 
-  triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+  triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 
   this.deactivateDraw(element);
 
@@ -506,7 +506,7 @@ function haltDrawing(element: HTMLDivElement, canvasPoints: any): boolean {
     this.drawData = undefined;
     this.commonData = undefined;
 
-    triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+    triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 
     this.deactivateDraw(element);
 

package/src/tools/annotation/planarFreehandROITool/openContourEditLoop.ts

@@ -197,7 +197,7 @@ function mouseDragOpenContourEditCallback(
     this.openContourEditOverwriteEnd(evt);
   }
 
-  triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+  triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 }
 
 /**
@@ -528,7 +528,7 @@ function finishEditOpenOnSecondCrossing(
     editIndex: 0,
   };
 
-  triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+  triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 }
 
 /**
@@ -599,7 +599,7 @@ function completeOpenContourEdit(element: HTMLDivElement) {
   this.editData = undefined;
   this.commonData = undefined;
 
-  triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+  triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 
   this.deactivateOpenContourEdit(element);
 }

package/src/tools/segmentation/BrushTool.ts

@@ -227,7 +227,7 @@ class BrushTool extends BaseTool {
       // we used to take the first actor here but we should take the one that is
       // probably the same size as the segmentation volume
       const volumes = actors.map((actorEntry) =>
-        cache.getVolume(actorEntry.referenceId)
+        cache.getVolume(actorEntry.referencedId)
       );
 
       const segmentationVolume = cache.getVolume(volumeId);
@@ -288,7 +288,6 @@ class BrushTool extends BaseTool {
     const eventData = evt.detail;
     const { element } = eventData;
     const enabledElement = getEnabledElement(element);
-    const { renderingEngine } = enabledElement;
 
     this._editData = this.createEditData(element);
     this._activateDraw(element);
@@ -303,10 +302,7 @@ class BrushTool extends BaseTool {
 
     const hoverData = this._hoverData || this.createHoverData(element);
 
-    triggerAnnotationRenderForViewportUIDs(
-      renderingEngine,
-      hoverData.viewportIdsToRender
-    );
+    triggerAnnotationRenderForViewportUIDs(hoverData.viewportIdsToRender);
 
     this.applyActiveStrategyCallback(
       enabledElement,
@@ -475,10 +471,7 @@ class BrushTool extends BaseTool {
       return;
     }
 
-    triggerAnnotationRenderForViewportUIDs(
-      getEnabledElement(element).renderingEngine,
-      this._hoverData.viewportIdsToRender
-    );
+    triggerAnnotationRenderForViewportUIDs(this._hoverData.viewportIdsToRender);
   }
 
   private _dragCallback = (evt: EventTypes.InteractionEventType): void => {
@@ -491,10 +484,7 @@ class BrushTool extends BaseTool {
 
     const { viewportIdsToRender } = this._hoverData;
 
-    triggerAnnotationRenderForViewportUIDs(
-      renderingEngine,
-      viewportIdsToRender
-    );
+    triggerAnnotationRenderForViewportUIDs(viewportIdsToRender);
 
     const delta = vec2.distance(
       currentPoints.canvas,

package/src/tools/segmentation/CircleROIStartEndThresholdTool.ts

@@ -206,7 +206,7 @@ class CircleROIStartEndThresholdTool extends CircleROITool {
 
     evt.preventDefault();
 
-    triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+    triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 
     return annotation;
   };
@@ -254,10 +254,7 @@ class CircleROIStartEndThresholdTool extends CircleROITool {
       this._computePointsInsideVolume(annotation, imageVolume, enabledElement);
     }
 
-    triggerAnnotationRenderForViewportIds(
-      enabledElement.renderingEngine,
-      viewportIdsToRender
-    );
+    triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 
     if (newAnnotation) {
       triggerAnnotationCompleted(annotation);

package/src/tools/segmentation/CircleScissorsTool.ts

@@ -207,7 +207,7 @@ class CircleScissorsTool extends BaseTool {
 
     evt.preventDefault();
 
-    triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+    triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 
     return true;
   };
@@ -257,7 +257,7 @@ class CircleScissorsTool extends BaseTool {
 
     this.editData.hasMoved = true;
 
-    triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+    triggerAnnotationRenderForViewportIds(viewportIdsToRender);
   };
 
   _endCallback = (evt: EventTypes.InteractionEventType) => {

package/src/tools/segmentation/RectangleROIStartEndThresholdTool.ts

@@ -209,7 +209,7 @@ class RectangleROIStartEndThresholdTool extends RectangleROITool {
 
     evt.preventDefault();
 
-    triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+    triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 
     return annotation;
   };
@@ -252,10 +252,7 @@ class RectangleROIStartEndThresholdTool extends RectangleROITool {
       this._computePointsInsideVolume(annotation, imageVolume, enabledElement);
     }
 
-    triggerAnnotationRenderForViewportIds(
-      enabledElement.renderingEngine,
-      viewportIdsToRender
-    );
+    triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 
     if (newAnnotation) {
       triggerAnnotationCompleted(annotation);

package/src/tools/segmentation/RectangleROIThresholdTool.ts

@@ -152,7 +152,7 @@ class RectangleROIThresholdTool extends RectangleROITool {
 
     evt.preventDefault();
 
-    triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+    triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 
     return annotation;
   };

package/src/tools/segmentation/RectangleScissorsTool.ts

@@ -206,7 +206,7 @@ class RectangleScissorsTool extends BaseTool {
 
     evt.preventDefault();
 
-    triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+    triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 
     return true;
   };
@@ -285,7 +285,7 @@ class RectangleScissorsTool extends BaseTool {
 
     const { renderingEngine } = enabledElement;
 
-    triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+    triggerAnnotationRenderForViewportIds(viewportIdsToRender);
   };
 
   _endCallback = (evt: EventTypes.InteractionEventType) => {

package/src/tools/segmentation/SegmentSelectTool.ts

@@ -169,7 +169,7 @@ class SegmentSelectTool extends BaseTool {
 
     // update states
     triggerSegmentationModified(segmentationId);
-    triggerAnnotationRenderForViewportIds(renderingEngine, viewportIds);
+    triggerAnnotationRenderForViewportIds(viewportIds);
   }
 }
 

package/src/tools/segmentation/SphereScissorsTool.ts

@@ -204,7 +204,7 @@ class SphereScissorsTool extends BaseTool {
 
     evt.preventDefault();
 
-    triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+    triggerAnnotationRenderForViewportIds(viewportIdsToRender);
 
     return true;
   };
@@ -252,7 +252,7 @@ class SphereScissorsTool extends BaseTool {
 
     this.editData.hasMoved = true;
 
-    triggerAnnotationRenderForViewportIds(renderingEngine, viewportIdsToRender);
+    triggerAnnotationRenderForViewportIds(viewportIdsToRender);
   };
 
   _endCallback = (evt: EventTypes.InteractionEventType) => {

package/src/utilities/contours/AnnotationToPointData.ts

@@ -5,7 +5,7 @@ function validateAnnotation(annotation) {
     throw new Error('Tool data is empty');
   }
 
-  if (!annotation.metadata || annotation.metadata.referenceImageId) {
+  if (!annotation.metadata || annotation.metadata.referencedImageId) {
     throw new Error('Tool data is not associated with any imageId');
   }
 }

package/src/utilities/dynamicVolume/getDataInTime.ts

@@ -11,7 +11,7 @@ import pointInShapeCallback from '../pointInShapeCallback';
  * @param options - frameNumbers: which frames to use as timepoints, if left
  * blank, gets data timepoints over all frames
  * maskVolumeId: segmentationId to get timepoint data of
- * imageCoordinate: world coordinate to get timepoint data of
+ * worldCoordinate: world coordinate to get timepoint data of
  * @returns
  */
 function getDataInTime(
@@ -19,7 +19,7 @@ function getDataInTime(
   options: {
     frameNumbers?;
     maskVolumeId?;
-    imageCoordinate?;
+    worldCoordinate?;
   }
 ): number[] | number[][] {
   let dataInTime;
@@ -29,16 +29,16 @@ function getDataInTime(
     ...Array(dynamicVolume.numTimePoints).keys(),
   ];
 
-  // You only need to provide either maskVolumeId OR imageCoordinate.
-  // Throws error if neither maskVolumeId or imageCoordinate is given,
-  // throws error if BOTH maskVolumeId and imageCoordinate is given
-  if (!options.maskVolumeId && !options.imageCoordinate) {
+  // You only need to provide either maskVolumeId OR worldCoordinate.
+  // Throws error if neither maskVolumeId or worldCoordinate is given,
+  // throws error if BOTH maskVolumeId and worldCoordinate is given
+  if (!options.maskVolumeId && !options.worldCoordinate) {
     throw new Error(
       'You should provide either maskVolumeId or imageCoordinate'
     );
   }
 
-  if (options.maskVolumeId && options.imageCoordinate) {
+  if (options.maskVolumeId && options.worldCoordinate) {
     throw new Error('You can only use one of maskVolumeId or imageCoordinate');
   }
 
@@ -54,10 +54,10 @@ function getDataInTime(
     return [dataInTime, ijkCoords];
   }
 
-  if (options.imageCoordinate) {
+  if (options.worldCoordinate) {
     const dataInTime = _getTimePointDataCoordinate(
       frames,
-      options.imageCoordinate,
+      options.worldCoordinate,
       dynamicVolume
     );
 

package/src/utilities/getModalityUnit.ts

@@ -30,7 +30,7 @@ function _handlePTModality(imageId: string, options: ModalityUnitOptions) {
 
   const generalSeriesModule = metaData.get('generalSeriesModule', imageId);
 
-  // it might be possible that the referenceImageId is not the one
+  // it might be possible that the reference ImageId is not the one
   // that is being displayed. So we need to get the modality from imageId again
   if (generalSeriesModule?.modality === 'PT') {
     const petSeriesModule = metaData.get('petSeriesModule', imageId);

package/src/utilities/scroll.ts

@@ -106,7 +106,7 @@ export function scrollVolume(
 
     csUtils.triggerEvent(
       eventTarget,
-      EVENTS.VOLUME_SCROLL_OUT_OF_BOUNDS,
+      EVENTS.VOLUME_VIEWPORT_SCROLL_OUT_OF_BOUNDS,
       VolumeScrollEventDetail
     );
   } else {

package/src/utilities/segmentation/brushSizeForToolGroup.ts

@@ -50,7 +50,7 @@ export function setBrushSizeForToolGroup(
 
   const renderingEngine = getRenderingEngine(renderingEngineId);
 
-  triggerAnnotationRenderForViewportIds(renderingEngine, viewportIds);
+  triggerAnnotationRenderForViewportIds(viewportIds);
 }
 
 /**

package/src/utilities/segmentation/brushThresholdForToolGroup.ts

@@ -43,7 +43,7 @@ export function setBrushThresholdForToolGroup(
 
   const renderingEngine = getRenderingEngine(renderingEngineId);
 
-  triggerAnnotationRenderForViewportIds(renderingEngine, viewportIds);
+  triggerAnnotationRenderForViewportIds(viewportIds);
 }
 
 export function getBrushThresholdForToolGroup(toolGroupId: string) {

package/src/utilities/segmentation/invalidateBrushCursor.ts

@@ -44,5 +44,5 @@ export function invalidateBrushCursor(toolGroupId: string): void {
 
   const renderingEngine = getRenderingEngine(renderingEngineId);
 
-  triggerAnnotationRenderForViewportIds(renderingEngine, viewportIds);
+  triggerAnnotationRenderForViewportIds(viewportIds);
 }

package/src/utilities/stackPrefetch/stackContextPrefetch.ts

@@ -230,9 +230,6 @@ function prefetch(element) {
       targetBuffer: {
         type: useNativeDataType ? undefined : 'Float32Array',
       },
-      preScale: {
-        enabled: true,
-      },
       useNativeDataType,
       requestType,
     };

package/src/utilities/stackPrefetch/stackPrefetch.ts

@@ -178,9 +178,6 @@ function prefetch(element) {
       targetBuffer: {
         type: useNativeDataType ? undefined : 'Float32Array',
       },
-      preScale: {
-        enabled: true,
-      },
       useNativeDataType,
       requestType,
     };

package/src/utilities/triggerAnnotationRenderForViewportIds.ts

@@ -1,16 +1,15 @@
-import type { Types } from '@cornerstonejs/core';
+import { getEnabledElementByViewportId } from '@cornerstonejs/core';
 import triggerAnnotationRender from './triggerAnnotationRender';
 
 export function triggerAnnotationRenderForViewportIds(
-  renderingEngine: Types.IRenderingEngine,
   viewportIdsToRender: string[]
 ): void {
-  if (!viewportIdsToRender.length || !renderingEngine) {
+  if (!viewportIdsToRender.length) {
     return;
   }
 
   viewportIdsToRender.forEach((viewportId) => {
-    const viewport = renderingEngine.getViewport(viewportId);
+    const { viewport } = getEnabledElementByViewportId(viewportId);
     if (!viewport) {
       console.warn(`Viewport not available for ${viewportId}`);
       return;