@cornerstonejs/tools 0.59.1 → 0.60.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "0.59.1",
+  "version": "0.60.0",
   "description": "Cornerstone3D Tools",
   "main": "dist/umd/index.js",
   "types": "dist/esm/index.d.ts",
@@ -26,7 +26,7 @@
     "webpack:watch": "webpack --mode development --progress --watch  --config ./.webpack/webpack.dev.js"
   },
   "dependencies": {
-    "@cornerstonejs/core": "^0.38.0",
+    "@cornerstonejs/core": "^0.39.0",
     "lodash.clonedeep": "4.5.0",
     "lodash.get": "^4.4.2"
   },
@@ -52,5 +52,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "9afbe1a42ec510313a29c0c5b6f953bb26813079"
+  "gitHead": "efb03afb227a0628c3c056ca762bf061b632c55b"
 }

package/src/types/EventTypes.ts

@@ -380,6 +380,19 @@ type MouseWheelEventDetail = NormalizedInteractionEventDetail &
     points: IPoints;
   };
 
+/**
+ * Volume Scroll Out of Bounds event detail
+ */
+type VolumeScrollOutOfBoundsEventDetail = {
+  volumeId: string;
+  viewport: Types.IVolumeViewport;
+  desiredStepIndex: number;
+  currentStepIndex: number;
+  delta: number; // difference between the desired and current frame
+  numScrollSteps: number; // total scroll steps in the volume
+  currentImageId: string; // get ImageId (ImageIndex for in-plane acquisition)
+};
+
 /////////////////////////////
 //
 //
@@ -585,6 +598,12 @@ type MouseDoubleClickEventType =
  */
 type MouseWheelEventType = Types.CustomEventType<MouseWheelEventDetail>;
 
+/**
+ * Event for volume scroll out of bounds
+ */
+type VolumeScrollOutOfBoundsEventType =
+  Types.CustomEventType<VolumeScrollOutOfBoundsEventDetail>;
+
 export {
   InteractionStartType,
   InteractionEndType,
@@ -654,4 +673,6 @@ export {
   MouseDoubleClickEventType,
   MouseWheelEventDetail,
   MouseWheelEventType,
+  VolumeScrollOutOfBoundsEventDetail,
+  VolumeScrollOutOfBoundsEventType,
 };

package/src/utilities/scroll.ts

@@ -2,9 +2,11 @@ import {
   StackViewport,
   Types,
   VolumeViewport,
+  eventTarget,
+  EVENTS,
   utilities as csUtils,
 } from '@cornerstonejs/core';
-import { ScrollOptions } from '../types';
+import { ScrollOptions, EventTypes } from '../types';
 
 /**
  * It scrolls one slice in the Stack or Volume Viewport, it uses the options provided
@@ -36,7 +38,8 @@ export function scrollVolume(
   volumeId: string,
   delta: number
 ) {
-  const sliceRangeInfo = csUtils.getVolumeSliceRangeInfo(viewport, volumeId);
+  const { numScrollSteps, currentStepIndex, sliceRangeInfo } =
+    csUtils.getVolumeViewportScrollInfo(viewport, volumeId);
 
   if (!sliceRangeInfo) {
     return;
@@ -59,4 +62,30 @@ export function scrollVolume(
     position: newPosition,
   });
   viewport.render();
+
+  const desiredStepIndex = currentStepIndex + delta;
+
+  if (
+    (desiredStepIndex > numScrollSteps || desiredStepIndex < 0) &&
+    viewport.getCurrentImageId() // Check that we are in the plane of acquistion
+  ) {
+    // One common use case of this trigger might be to load the next
+    // volume in a time series or the next segment of a partially loaded volume.
+
+    const VolumeScrollEventDetail = {
+      volumeId,
+      viewport,
+      delta,
+      desiredStepIndex,
+      currentStepIndex,
+      numScrollSteps,
+      currentImageId: viewport.getCurrentImageId(),
+    };
+
+    csUtils.triggerEvent(
+      eventTarget,
+      EVENTS.VOLUME_SCROLL_OUT_OF_BOUNDS,
+      VolumeScrollEventDetail as EventTypes.VolumeScrollOutOfBoundsEventDetail
+    );
+  }
 }