@cornerstonejs/tools 0.50.2 → 0.51.0

package/dist/cjs/types/CINETypes.d.ts

@@ -3,6 +3,7 @@ declare type PlayClipOptions = {
     frameTimeVector?: number[];
     reverse?: boolean;
     loop?: boolean;
+    dynamicCineEnabled?: boolean;
     frameTimeVectorSpeedMultiplier?: number;
 };
 interface ToolData {
@@ -15,5 +16,12 @@ interface ToolData {
     speed: number;
     reverse: boolean;
     loop: boolean;
+    dynamicCineEnabled?: boolean;
 }
-export type { PlayClipOptions, ToolData };
+declare type CinePlayContext = {
+    get numScrollSteps(): number;
+    get currentStepIndex(): number;
+    get frameTimeVectorEnabled(): boolean;
+    scroll(delta: number): void;
+};
+export type { PlayClipOptions, ToolData, CinePlayContext };

package/dist/cjs/utilities/cine/playClip.js

@@ -4,14 +4,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.stopClip = exports.playClip = void 0;
+const gl_matrix_1 = require("gl-matrix");
 const core_1 = require("@cornerstonejs/core");
 const events_1 = __importDefault(require("./events"));
 const state_1 = require("./state");
+const scroll_1 = __importDefault(require("../scroll"));
 const { triggerEvent } = core_1.utilities;
 const debounced = true;
 const loop = true;
+const dynamicVolumesPlayingMap = new Map();
 function playClip(element, playClipOptions) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e;
     let playClipTimeouts;
     let playClipIsTimeVarying;
     if (element === undefined) {
@@ -21,15 +24,16 @@ function playClip(element, playClipOptions) {
     if (!enabledElement) {
         throw new Error('playClip: element must be a valid Cornerstone enabled element');
     }
+    playClipOptions.dynamicCineEnabled =
+        (_a = playClipOptions.dynamicCineEnabled) !== null && _a !== void 0 ? _a : true;
     const { viewport } = enabledElement;
-    if (!(viewport instanceof core_1.StackViewport)) {
-        throw new Error('playClip: element must be a stack viewport, volume viewport playClip not yet implemented');
-    }
-    const stackData = {
-        targetImageIdIndex: viewport.getTargetImageIdIndex(),
-        imageIds: viewport.getImageIds(),
-    };
+    const volume = _getVolumeFromViewport(viewport);
+    const playClipContext = _createCinePlayContext(viewport, playClipOptions);
     let playClipData = (0, state_1.getToolState)(element);
+    const isDynamicCinePlaying = playClipOptions.dynamicCineEnabled && (volume === null || volume === void 0 ? void 0 : volume.isDynamicVolume());
+    if (isDynamicCinePlaying) {
+        _stopDynamicVolumeCine(element);
+    }
     if (!playClipData) {
         playClipData = {
             intervalId: undefined,
@@ -37,16 +41,17 @@ function playClip(element, playClipOptions) {
             lastFrameTimeStamp: undefined,
             ignoreFrameTimeVector: false,
             usingFrameTimeVector: false,
-            frameTimeVector: (_a = playClipOptions.frameTimeVector) !== null && _a !== void 0 ? _a : undefined,
-            speed: (_b = playClipOptions.frameTimeVectorSpeedMultiplier) !== null && _b !== void 0 ? _b : 1,
-            reverse: (_c = playClipOptions.reverse) !== null && _c !== void 0 ? _c : false,
-            loop: (_d = playClipOptions.loop) !== null && _d !== void 0 ? _d : true,
+            frameTimeVector: (_b = playClipOptions.frameTimeVector) !== null && _b !== void 0 ? _b : undefined,
+            speed: (_c = playClipOptions.frameTimeVectorSpeedMultiplier) !== null && _c !== void 0 ? _c : 1,
+            reverse: (_d = playClipOptions.reverse) !== null && _d !== void 0 ? _d : false,
+            loop: (_e = playClipOptions.loop) !== null && _e !== void 0 ? _e : true,
         };
         (0, state_1.addToolState)(element, playClipData);
     }
     else {
-        _stopClipWithData(playClipData);
+        _stopClip(element, isDynamicCinePlaying);
     }
+    playClipData.dynamicCineEnabled = playClipOptions.dynamicCineEnabled;
     if (playClipOptions.framesPerSecond < 0 ||
         playClipOptions.framesPerSecond > 0) {
         playClipData.framesPerSecond = Number(playClipOptions.framesPerSecond);
@@ -55,50 +60,42 @@ function playClip(element, playClipOptions) {
     }
     if (playClipData.ignoreFrameTimeVector !== true &&
         playClipData.frameTimeVector &&
-        playClipData.frameTimeVector.length === stackData.imageIds.length) {
+        playClipData.frameTimeVector.length === playClipContext.numScrollSteps &&
+        playClipContext.frameTimeVectorEnabled) {
         const { timeouts, isTimeVarying } = _getPlayClipTimeouts(playClipData.frameTimeVector, playClipData.speed);
         playClipTimeouts = timeouts;
         playClipIsTimeVarying = isTimeVarying;
     }
     const playClipAction = () => {
-        const stackData = {
-            targetImageIdIndex: viewport.getTargetImageIdIndex(),
-            imageIds: viewport.getImageIds(),
-        };
-        let newImageIdIndex = stackData.targetImageIdIndex;
-        const imageCount = stackData.imageIds.length;
-        if (playClipData.reverse) {
-            newImageIdIndex--;
-        }
-        else {
-            newImageIdIndex++;
-        }
-        if (!playClipData.loop &&
-            (newImageIdIndex < 0 || newImageIdIndex >= imageCount)) {
-            _stopClipWithData(playClipData);
-            const eventDetail = {
-                element,
-            };
+        const { numScrollSteps, currentStepIndex } = playClipContext;
+        let newStepIndex = currentStepIndex + (playClipData.reverse ? -1 : 1);
+        const newStepIndexOutOfRange = newStepIndex < 0 || newStepIndex >= numScrollSteps;
+        if (!loop && newStepIndexOutOfRange) {
+            _stopClip(element, isDynamicCinePlaying);
+            const eventDetail = { element };
             triggerEvent(element, events_1.default.CLIP_STOPPED, eventDetail);
             return;
         }
-        if (newImageIdIndex >= imageCount) {
-            newImageIdIndex = 0;
+        if (newStepIndex >= numScrollSteps) {
+            newStepIndex = 0;
         }
-        if (newImageIdIndex < 0) {
-            newImageIdIndex = imageCount - 1;
+        else if (newStepIndex < 0) {
+            newStepIndex = numScrollSteps - 1;
         }
-        if (newImageIdIndex !== stackData.targetImageIdIndex) {
-            const delta = newImageIdIndex - stackData.targetImageIdIndex;
-            viewport.scroll(delta, debounced, loop);
+        const delta = newStepIndex - currentStepIndex;
+        if (delta) {
+            playClipContext.scroll(delta);
         }
     };
+    if (isDynamicCinePlaying) {
+        dynamicVolumesPlayingMap.set(volume.volumeId, element);
+    }
     if (playClipTimeouts &&
         playClipTimeouts.length > 0 &&
         playClipIsTimeVarying) {
         playClipData.usingFrameTimeVector = true;
         playClipData.intervalId = window.setTimeout(function playClipTimeoutHandler() {
-            playClipData.intervalId = window.setTimeout(playClipTimeoutHandler, playClipTimeouts[stackData.targetImageIdIndex]);
+            playClipData.intervalId = window.setTimeout(playClipTimeoutHandler, playClipTimeouts[playClipContext.currentStepIndex]);
             playClipAction();
         }, 0);
     }
@@ -113,17 +110,33 @@ function playClip(element, playClipOptions) {
 }
 exports.playClip = playClip;
 function stopClip(element) {
+    _stopClip(element, true);
+}
+exports.stopClip = stopClip;
+function _stopClip(element, stopDynamicCine) {
     const enabledElement = (0, core_1.getEnabledElement)(element);
     if (!enabledElement)
         return;
     const { viewport } = enabledElement;
     const cineToolData = (0, state_1.getToolState)(viewport.element);
-    if (!cineToolData) {
-        return;
+    if (cineToolData) {
+        _stopClipWithData(cineToolData);
+    }
+    if (stopDynamicCine) {
+        _stopDynamicVolumeCine(element);
+    }
+}
+function _stopDynamicVolumeCine(element) {
+    const { viewport } = (0, core_1.getEnabledElement)(element);
+    const volume = _getVolumeFromViewport(viewport);
+    if (volume === null || volume === void 0 ? void 0 : volume.isDynamicVolume()) {
+        const dynamicCineElement = dynamicVolumesPlayingMap.get(volume.volumeId);
+        dynamicVolumesPlayingMap.delete(volume.volumeId);
+        if (dynamicCineElement && dynamicCineElement !== element) {
+            stopClip(dynamicCineElement);
+        }
     }
-    _stopClipWithData(cineToolData);
 }
-exports.stopClip = stopClip;
 function _getPlayClipTimeouts(vector, speed) {
     let i;
     let sample;
@@ -169,4 +182,97 @@ function _stopClipWithData(playClipData) {
         }
     }
 }
+function _getVolumeFromViewport(viewport) {
+    const actorEntry = viewport.getDefaultActor();
+    if (!actorEntry) {
+        console.warn('No actor found');
+        return;
+    }
+    const volumeId = actorEntry.uid;
+    return core_1.cache.getVolume(volumeId);
+}
+function _createStackViewportCinePlayContext(viewport) {
+    const imageIds = viewport.getImageIds();
+    return {
+        get numScrollSteps() {
+            return imageIds.length;
+        },
+        get currentStepIndex() {
+            return viewport.getTargetImageIdIndex();
+        },
+        get frameTimeVectorEnabled() {
+            return true;
+        },
+        scroll(delta) {
+            (0, scroll_1.default)(viewport, { delta, debounceLoading: debounced });
+        },
+    };
+}
+function _createVolumeViewportCinePlayContext(viewport, volume) {
+    const { volumeId } = volume;
+    const cachedScrollInfo = {
+        viewPlaneNormal: gl_matrix_1.vec3.create(),
+        scrollInfo: null,
+    };
+    const getScrollInfo = () => {
+        const camera = viewport.getCamera();
+        const updateCache = !cachedScrollInfo.scrollInfo ||
+            !gl_matrix_1.vec3.equals(camera.viewPlaneNormal, cachedScrollInfo.viewPlaneNormal);
+        if (updateCache) {
+            const scrollInfo = core_1.utilities.getVolumeViewportScrollInfo(viewport, volumeId);
+            cachedScrollInfo.viewPlaneNormal = camera.viewPlaneNormal;
+            cachedScrollInfo.scrollInfo = scrollInfo;
+        }
+        return cachedScrollInfo.scrollInfo;
+    };
+    return {
+        get numScrollSteps() {
+            return getScrollInfo().numScrollSteps;
+        },
+        get currentStepIndex() {
+            return getScrollInfo().currentStepIndex;
+        },
+        get frameTimeVectorEnabled() {
+            const camera = viewport.getCamera();
+            const volumeViewPlaneNormal = volume.direction
+                .slice(6, 9)
+                .map((x) => -x);
+            const dot = gl_matrix_1.vec3.dot(volumeViewPlaneNormal, camera.viewPlaneNormal);
+            return gl_matrix_1.glMatrix.equals(dot, 1);
+        },
+        scroll(delta) {
+            getScrollInfo().currentStepIndex += delta;
+            (0, scroll_1.default)(viewport, { delta });
+        },
+    };
+}
+function _createDynamicVolumeViewportCinePlayContext(volume) {
+    return {
+        get numScrollSteps() {
+            return volume.numTimePoints;
+        },
+        get currentStepIndex() {
+            return volume.timePointIndex;
+        },
+        get frameTimeVectorEnabled() {
+            return false;
+        },
+        scroll(delta) {
+            volume.timePointIndex += delta;
+        },
+    };
+}
+function _createCinePlayContext(viewport, playClipOptions) {
+    if (viewport instanceof core_1.StackViewport) {
+        return _createStackViewportCinePlayContext(viewport);
+    }
+    if (viewport instanceof core_1.VolumeViewport) {
+        const volume = _getVolumeFromViewport(viewport);
+        if (playClipOptions.dynamicCineEnabled && (volume === null || volume === void 0 ? void 0 : volume.isDynamicVolume())) {
+            return _createDynamicVolumeViewportCinePlayContext(volume);
+        }
+        return _createVolumeViewportCinePlayContext(viewport, volume);
+    }
+    throw new Error('Unknown viewport type');
+}
 //# sourceMappingURL=playClip.js.map

package/dist/cjs/utilities/cine/playClip.js.map

@@ -1 +1 @@
-{"version":3,"file":"playClip.js","sourceRoot":"","sources":["../../../../src/utilities/cine/playClip.ts"],"names":[],"mappings":";;;;;;AAAA,8CAI6B;AAC7B,sDAAmC;AACnC,mCAAqD;AAGrD,MAAM,EAAE,YAAY,EAAE,GAAG,gBAAS,CAAC;AAEnC,MAAM,SAAS,GAAG,IAAI,CAAC;AACvB,MAAM,IAAI,GAAG,IAAI,CAAC;AAQlB,SAAS,QAAQ,CACf,OAAuB,EACvB,eAA0C;;IAE1C,IAAI,gBAAgB,CAAC;IACrB,IAAI,qBAAqB,CAAC;IAE1B,IAAI,OAAO,KAAK,SAAS,EAAE;QACzB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;KAC5D;IAED,MAAM,cAAc,GAAG,IAAA,wBAAiB,EAAC,OAAO,CAAC,CAAC;IAElD,IAAI,CAAC,cAAc,EAAE;QACnB,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;KACH;IAED,MAAM,EAAE,QAAQ,EAAE,GAAG,cAAc,CAAC;IAEpC,IAAI,CAAC,CAAC,QAAQ,YAAY,oBAAa,CAAC,EAAE;QACxC,MAAM,IAAI,KAAK,CACb,0FAA0F,CAC3F,CAAC;KACH;IAED,MAAM,SAAS,GAAG;QAChB,kBAAkB,EAAE,QAAQ,CAAC,qBAAqB,EAAE;QACpD,QAAQ,EAAE,QAAQ,CAAC,WAAW,EAAE;KACjC,CAAC;IAEF,IAAI,YAAY,GAAG,IAAA,oBAAY,EAAC,OAAO,CAAC,CAAC;IAEzC,IAAI,CAAC,YAAY,EAAE;QACjB,YAAY,GAAG;YACb,UAAU,EAAE,SAAS;YACrB,eAAe,EAAE,EAAE;YACnB,kBAAkB,EAAE,SAAS;YAC7B,qBAAqB,EAAE,KAAK;YAC5B,oBAAoB,EAAE,KAAK;YAC3B,eAAe,EAAE,MAAA,eAAe,CAAC,eAAe,mCAAI,SAAS;YAC7D,KAAK,EAAE,MAAA,eAAe,CAAC,8BAA8B,mCAAI,CAAC;YAC1D,OAAO,EAAE,MAAA,eAAe,CAAC,OAAO,mCAAI,KAAK;YACzC,IAAI,EAAE,MAAA,eAAe,CAAC,IAAI,mCAAI,IAAI;SACnC,CAAC;QACF,IAAA,oBAAY,EAAC,OAAO,EAAE,YAAY,CAAC,CAAC;KACrC;SAAM;QAEL,iBAAiB,CAAC,YAAY,CAAC,CAAC;KACjC;IAGD,IACE,eAAe,CAAC,eAAe,GAAG,CAAC;QACnC,eAAe,CAAC,eAAe,GAAG,CAAC,EACnC;QACA,YAAY,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;QACvE,YAAY,CAAC,OAAO,GAAG,YAAY,CAAC,eAAe,GAAG,CAAC,CAAC;QAExD,YAAY,CAAC,qBAAqB,GAAG,IAAI,CAAC;KAC3C;IAGD,IACE,YAAY,CAAC,qBAAqB,KAAK,IAAI;QAC3C,YAAY,CAAC,eAAe;QAC5B,YAAY,CAAC,eAAe,CAAC,MAAM,KAAK,SAAS,CAAC,QAAQ,CAAC,MAAM,EACjE;QACA,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,oBAAoB,CACtD,YAAY,CAAC,eAAe,EAC5B,YAAY,CAAC,KAAK,CACnB,CAAC;QAEF,gBAAgB,GAAG,QAAQ,CAAC;QAC5B,qBAAqB,GAAG,aAAa,CAAC;KACvC;IAGD,MAAM,cAAc,GAAG,GAAG,EAAE;QAE1B,MAAM,SAAS,GAAG;YAChB,kBAAkB,EAAE,QAAQ,CAAC,qBAAqB,EAAE;YACpD,QAAQ,EAAE,QAAQ,CAAC,WAAW,EAAE;SACjC,CAAC;QAEF,IAAI,eAAe,GAAG,SAAS,CAAC,kBAAkB,CAAC;QACnD,MAAM,UAAU,GAAG,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC;QAE7C,IAAI,YAAY,CAAC,OAAO,EAAE;YACxB,eAAe,EAAE,CAAC;SACnB;aAAM;YACL,eAAe,EAAE,CAAC;SACnB;QAED,IACE,CAAC,YAAY,CAAC,IAAI;YAClB,CAAC,eAAe,GAAG,CAAC,IAAI,eAAe,IAAI,UAAU,CAAC,EACtD;YACA,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAChC,MAAM,WAAW,GAAG;gBAClB,OAAO;aACR,CAAC;YAEF,YAAY,CAAC,OAAO,EAAE,gBAAW,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;YAE7D,OAAO;SACR;QAGD,IAAI,eAAe,IAAI,UAAU,EAAE;YACjC,eAAe,GAAG,CAAC,CAAC;SACrB;QAED,IAAI,eAAe,GAAG,CAAC,EAAE;YACvB,eAAe,GAAG,UAAU,GAAG,CAAC,CAAC;SAClC;QAED,IAAI,eAAe,KAAK,SAAS,CAAC,kBAAkB,EAAE;YACpD,MAAM,KAAK,GAAG,eAAe,GAAG,SAAS,CAAC,kBAAkB,CAAC;YAC7D,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;SACzC;IACH,CAAC,CAAC;IAIF,IACE,gBAAgB;QAChB,gBAAgB,CAAC,MAAM,GAAG,CAAC;QAC3B,qBAAqB,EACrB;QACA,YAAY,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACzC,YAAY,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CACzC,SAAS,sBAAsB;YAC7B,YAAY,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CACzC,sBAAsB,EACtB,gBAAgB,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAC/C,CAAC;YACF,cAAc,EAAE,CAAC;QACnB,CAAC,EACD,CAAC,CACF,CAAC;KACH;SAAM;QAEL,YAAY,CAAC,oBAAoB,GAAG,KAAK,CAAC;QAC1C,YAAY,CAAC,UAAU,GAAG,MAAM,CAAC,WAAW,CAC1C,cAAc,EACd,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,eAAe,CAAC,CAC9C,CAAC;KACH;IAED,MAAM,WAAW,GAAG;QAClB,OAAO;KACR,CAAC;IAEF,YAAY,CAAC,OAAO,EAAE,gBAAW,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;AAC/D,CAAC;AAyFQ,4BAAQ;AAnFjB,SAAS,QAAQ,CAAC,OAAuB;IACvC,MAAM,cAAc,GAAG,IAAA,wBAAiB,EAAC,OAAO,CAAC,CAAC;IAClD,IAAI,CAAC,cAAc;QAAE,OAAO;IAC5B,MAAM,EAAE,QAAQ,EAAE,GAAG,cAAc,CAAC;IAEpC,MAAM,YAAY,GAAG,IAAA,oBAAY,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAEpD,IAAI,CAAC,YAAY,EAAE;QACjB,OAAO;KACR;IAED,iBAAiB,CAAC,YAAY,CAAC,CAAC;AAClC,CAAC;AAuEkB,4BAAQ;AA9D3B,SAAS,oBAAoB,CAAC,MAAgB,EAAE,KAAa;IAC3D,IAAI,CAAC,CAAC;IACN,IAAI,MAAM,CAAC;IACX,IAAI,KAAK,CAAC;IACV,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;IAC5B,MAAM,QAAQ,GAAG,EAAE,CAAC;IAGpB,IAAI,aAAa,GAAG,KAAK,CAAC;IAE1B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,IAAI,CAAC,EAAE;QAC3C,KAAK,GAAG,CAAC,CAAC;KACX;IAGD,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE;QAE1B,KAAK,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QACxC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,IAAI,CAAC,KAAK,CAAC,EAAE;YAEX,MAAM,GAAG,KAAK,CAAC;SAChB;aAAM,IAAI,KAAK,KAAK,MAAM,EAAE;YAC3B,aAAa,GAAG,IAAI,CAAC;SACtB;QAED,GAAG,IAAI,KAAK,CAAC;KACd;IAED,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;QACvB,IAAI,aAAa,EAAE;YAGjB,KAAK,GAAG,CAAC,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACrC;aAAM;YACL,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;SACrB;QAED,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KACtB;IAED,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;AACrC,CAAC;AAMD,SAAS,iBAAiB,CAAC,YAAY;IACrC,MAAM,EAAE,GAAG,YAAY,CAAC,UAAU,CAAC;IAEnC,IAAI,OAAO,EAAE,KAAK,WAAW,EAAE;QAC7B,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC;QACpC,IAAI,YAAY,CAAC,oBAAoB,EAAE;YACrC,YAAY,CAAC,EAAE,CAAC,CAAC;SAClB;aAAM;YACL,aAAa,CAAC,EAAE,CAAC,CAAC;SACnB;KACF;AACH,CAAC"}
+{"version":3,"file":"playClip.js","sourceRoot":"","sources":["../../../../src/utilities/cine/playClip.ts"],"names":[],"mappings":";;;;;;AAAA,yCAA2C;AAC3C,8CAM6B;AAG7B,sDAAmC;AACnC,mCAAqD;AAErD,uDAA+B;AAE/B,MAAM,EAAE,YAAY,EAAE,GAAG,gBAAO,CAAC;AAEjC,MAAM,SAAS,GAAG,IAAI,CAAC;AACvB,MAAM,IAAI,GAAG,IAAI,CAAC;AAClB,MAAM,wBAAwB,GAAG,IAAI,GAAG,EAAE,CAAC;AAS3C,SAAS,QAAQ,CACf,OAAuB,EACvB,eAA0C;;IAE1C,IAAI,gBAAgB,CAAC;IACrB,IAAI,qBAAqB,CAAC;IAE1B,IAAI,OAAO,KAAK,SAAS,EAAE;QACzB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;KAC5D;IAED,MAAM,cAAc,GAAG,IAAA,wBAAiB,EAAC,OAAO,CAAC,CAAC;IAElD,IAAI,CAAC,cAAc,EAAE;QACnB,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;KACH;IAGD,eAAe,CAAC,kBAAkB;QAChC,MAAA,eAAe,CAAC,kBAAkB,mCAAI,IAAI,CAAC;IAE7C,MAAM,EAAE,QAAQ,EAAE,GAAG,cAAc,CAAC;IACpC,MAAM,MAAM,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAChD,MAAM,eAAe,GAAG,sBAAsB,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;IAC1E,IAAI,YAAY,GAAG,IAAA,oBAAY,EAAC,OAAO,CAAC,CAAC;IAEzC,MAAM,oBAAoB,GACxB,eAAe,CAAC,kBAAkB,KAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,eAAe,EAAE,CAAA,CAAC;IAIlE,IAAI,oBAAoB,EAAE;QACxB,sBAAsB,CAAC,OAAO,CAAC,CAAC;KACjC;IAED,IAAI,CAAC,YAAY,EAAE;QACjB,YAAY,GAAG;YACb,UAAU,EAAE,SAAS;YACrB,eAAe,EAAE,EAAE;YACnB,kBAAkB,EAAE,SAAS;YAC7B,qBAAqB,EAAE,KAAK;YAC5B,oBAAoB,EAAE,KAAK;YAC3B,eAAe,EAAE,MAAA,eAAe,CAAC,eAAe,mCAAI,SAAS;YAC7D,KAAK,EAAE,MAAA,eAAe,CAAC,8BAA8B,mCAAI,CAAC;YAC1D,OAAO,EAAE,MAAA,eAAe,CAAC,OAAO,mCAAI,KAAK;YACzC,IAAI,EAAE,MAAA,eAAe,CAAC,IAAI,mCAAI,IAAI;SACnC,CAAC;QACF,IAAA,oBAAY,EAAC,OAAO,EAAE,YAAY,CAAC,CAAC;KACrC;SAAM;QAIL,SAAS,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;KAC1C;IAED,YAAY,CAAC,kBAAkB,GAAG,eAAe,CAAC,kBAAkB,CAAC;IAGrE,IACE,eAAe,CAAC,eAAe,GAAG,CAAC;QACnC,eAAe,CAAC,eAAe,GAAG,CAAC,EACnC;QACA,YAAY,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;QACvE,YAAY,CAAC,OAAO,GAAG,YAAY,CAAC,eAAe,GAAG,CAAC,CAAC;QAExD,YAAY,CAAC,qBAAqB,GAAG,IAAI,CAAC;KAC3C;IAGD,IACE,YAAY,CAAC,qBAAqB,KAAK,IAAI;QAC3C,YAAY,CAAC,eAAe;QAC5B,YAAY,CAAC,eAAe,CAAC,MAAM,KAAK,eAAe,CAAC,cAAc;QACtE,eAAe,CAAC,sBAAsB,EACtC;QACA,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,oBAAoB,CACtD,YAAY,CAAC,eAAe,EAC5B,YAAY,CAAC,KAAK,CACnB,CAAC;QAEF,gBAAgB,GAAG,QAAQ,CAAC;QAC5B,qBAAqB,GAAG,aAAa,CAAC;KACvC;IAGD,MAAM,cAAc,GAAG,GAAG,EAAE;QAC1B,MAAM,EAAE,cAAc,EAAE,gBAAgB,EAAE,GAAG,eAAe,CAAC;QAC7D,IAAI,YAAY,GAAG,gBAAgB,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACtE,MAAM,sBAAsB,GAC1B,YAAY,GAAG,CAAC,IAAI,YAAY,IAAI,cAAc,CAAC;QAErD,IAAI,CAAC,IAAI,IAAI,sBAAsB,EAAE;YAGnC,SAAS,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;YAEzC,MAAM,WAAW,GAAG,EAAE,OAAO,EAAE,CAAC;YAEhC,YAAY,CAAC,OAAO,EAAE,gBAAW,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;YAC7D,OAAO;SACR;QAGD,IAAI,YAAY,IAAI,cAAc,EAAE;YAClC,YAAY,GAAG,CAAC,CAAC;SAClB;aAAM,IAAI,YAAY,GAAG,CAAC,EAAE;YAC3B,YAAY,GAAG,cAAc,GAAG,CAAC,CAAC;SACnC;QAED,MAAM,KAAK,GAAG,YAAY,GAAG,gBAAgB,CAAC;QAE9C,IAAI,KAAK,EAAE;YACT,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SAC/B;IACH,CAAC,CAAC;IAEF,IAAI,oBAAoB,EAAE;QACxB,wBAAwB,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;KACxD;IAID,IACE,gBAAgB;QAChB,gBAAgB,CAAC,MAAM,GAAG,CAAC;QAC3B,qBAAqB,EACrB;QACA,YAAY,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACzC,YAAY,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CACzC,SAAS,sBAAsB;YAC7B,YAAY,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CACzC,sBAAsB,EACtB,gBAAgB,CAAC,eAAe,CAAC,gBAAgB,CAAC,CACnD,CAAC;YACF,cAAc,EAAE,CAAC;QACnB,CAAC,EACD,CAAC,CACF,CAAC;KACH;SAAM;QAEL,YAAY,CAAC,oBAAoB,GAAG,KAAK,CAAC;QAC1C,YAAY,CAAC,UAAU,GAAG,MAAM,CAAC,WAAW,CAC1C,cAAc,EACd,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,eAAe,CAAC,CAC9C,CAAC;KACH;IAED,MAAM,WAAW,GAAG;QAClB,OAAO;KACR,CAAC;IAEF,YAAY,CAAC,OAAO,EAAE,gBAAW,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;AAC/D,CAAC;AA4PQ,4BAAQ;AAtPjB,SAAS,QAAQ,CAAC,OAAuB;IACvC,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AAC3B,CAAC;AAoPkB,4BAAQ;AAlP3B,SAAS,SAAS,CAAC,OAAuB,EAAE,eAAwB;IAClE,MAAM,cAAc,GAAG,IAAA,wBAAiB,EAAC,OAAO,CAAC,CAAC;IAClD,IAAI,CAAC,cAAc;QAAE,OAAO;IAC5B,MAAM,EAAE,QAAQ,EAAE,GAAG,cAAc,CAAC;IACpC,MAAM,YAAY,GAAG,IAAA,oBAAY,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAEpD,IAAI,YAAY,EAAE;QAChB,iBAAiB,CAAC,YAAY,CAAC,CAAC;KACjC;IAED,IAAI,eAAe,EAAE;QACnB,sBAAsB,CAAC,OAAO,CAAC,CAAC;KACjC;AACH,CAAC;AAMD,SAAS,sBAAsB,CAAC,OAAO;IACrC,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,wBAAiB,EAAC,OAAO,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAKhD,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,eAAe,EAAE,EAAE;QAC7B,MAAM,kBAAkB,GAAG,wBAAwB,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAEzE,wBAAwB,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAEjD,IAAI,kBAAkB,IAAI,kBAAkB,KAAK,OAAO,EAAE;YACxD,QAAQ,CAAiB,kBAAkB,CAAC,CAAC;SAC9C;KACF;AACH,CAAC;AASD,SAAS,oBAAoB,CAAC,MAAgB,EAAE,KAAa;IAC3D,IAAI,CAAC,CAAC;IACN,IAAI,MAAM,CAAC;IACX,IAAI,KAAK,CAAC;IACV,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;IAC5B,MAAM,QAAQ,GAAG,EAAE,CAAC;IAGpB,IAAI,aAAa,GAAG,KAAK,CAAC;IAE1B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,IAAI,CAAC,EAAE;QAC3C,KAAK,GAAG,CAAC,CAAC;KACX;IAGD,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE;QAE1B,KAAK,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QACxC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,IAAI,CAAC,KAAK,CAAC,EAAE;YAEX,MAAM,GAAG,KAAK,CAAC;SAChB;aAAM,IAAI,KAAK,KAAK,MAAM,EAAE;YAC3B,aAAa,GAAG,IAAI,CAAC;SACtB;QAED,GAAG,IAAI,KAAK,CAAC;KACd;IAED,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;QACvB,IAAI,aAAa,EAAE;YAGjB,KAAK,GAAG,CAAC,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACrC;aAAM;YACL,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;SACrB;QAED,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KACtB;IAED,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;AACrC,CAAC;AAOD,SAAS,iBAAiB,CAAC,YAAY;IACrC,MAAM,EAAE,GAAG,YAAY,CAAC,UAAU,CAAC;IAEnC,IAAI,OAAO,EAAE,KAAK,WAAW,EAAE;QAC7B,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC;QACpC,IAAI,YAAY,CAAC,oBAAoB,EAAE;YACrC,YAAY,CAAC,EAAE,CAAC,CAAC;SAClB;aAAM;YACL,aAAa,CAAC,EAAE,CAAC,CAAC;SACnB;KACF;AACH,CAAC;AAED,SAAS,sBAAsB,CAAC,QAAQ;IACtC,MAAM,UAAU,GAAG,QAAQ,CAAC,eAAe,EAAE,CAAC;IAE9C,IAAI,CAAC,UAAU,EAAE;QACf,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC/B,OAAO;KACR;IAED,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC;IAChC,OAAO,YAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;AACnC,CAAC;AAED,SAAS,mCAAmC,CAC1C,QAAuB;IAEvB,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IAExC,OAAO;QACL,IAAI,cAAc;YAChB,OAAO,QAAQ,CAAC,MAAM,CAAC;QACzB,CAAC;QACD,IAAI,gBAAgB;YAClB,OAAO,QAAQ,CAAC,qBAAqB,EAAE,CAAC;QAC1C,CAAC;QACD,IAAI,sBAAsB;YAExB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,CAAC,KAAa;YAClB,IAAA,gBAAM,EAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC;QAC1D,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,oCAAoC,CAC3C,QAAwB,EACxB,MAA0B;IAE1B,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAC5B,MAAM,gBAAgB,GAAG;QACvB,eAAe,EAAE,gBAAI,CAAC,MAAM,EAAE;QAC9B,UAAU,EAAE,IAAI;KACjB,CAAC;IAEF,MAAM,aAAa,GAAG,GAAG,EAAE;QACzB,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,EAAE,CAAC;QACpC,MAAM,WAAW,GACf,CAAC,gBAAgB,CAAC,UAAU;YAC5B,CAAC,gBAAI,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;QAKzE,IAAI,WAAW,EAAE;YACf,MAAM,UAAU,GAAG,gBAAO,CAAC,2BAA2B,CACpD,QAAQ,EACR,QAAQ,CACT,CAAC;YAEF,gBAAgB,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;YAC1D,gBAAgB,CAAC,UAAU,GAAG,UAAU,CAAC;SAC1C;QAED,OAAO,gBAAgB,CAAC,UAAU,CAAC;IACrC,CAAC,CAAC;IAEF,OAAO;QACL,IAAI,cAAc;YAChB,OAAO,aAAa,EAAE,CAAC,cAAc,CAAC;QACxC,CAAC;QACD,IAAI,gBAAgB;YAClB,OAAO,aAAa,EAAE,CAAC,gBAAgB,CAAC;QAC1C,CAAC;QACD,IAAI,sBAAsB;YACxB,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,EAAE,CAAC;YACpC,MAAM,qBAAqB,GAAG,MAAM,CAAC,SAAS;iBAC3C,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;iBACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAiB,CAAC;YAClC,MAAM,GAAG,GAAG,gBAAI,CAAC,GAAG,CAAC,qBAAqB,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;YAIpE,OAAO,oBAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACjC,CAAC;QACD,MAAM,CAAC,KAAa;YAClB,aAAa,EAAE,CAAC,gBAAgB,IAAI,KAAK,CAAC;YAC1C,IAAA,gBAAM,EAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC9B,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,2CAA2C,CAClD,MAAiC;IAEjC,OAAO;QACL,IAAI,cAAc;YAChB,OAAO,MAAM,CAAC,aAAa,CAAC;QAC9B,CAAC;QACD,IAAI,gBAAgB;YAClB,OAAO,MAAM,CAAC,cAAc,CAAC;QAC/B,CAAC;QACD,IAAI,sBAAsB;YAExB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,CAAC,KAAa;YAElB,MAAM,CAAC,cAAc,IAAI,KAAK,CAAC;QACjC,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB,CAC7B,QAAQ,EACR,eAA0C;IAE1C,IAAI,QAAQ,YAAY,oBAAa,EAAE;QACrC,OAAO,mCAAmC,CAAC,QAAQ,CAAC,CAAC;KACtD;IAED,IAAI,QAAQ,YAAY,qBAAc,EAAE;QACtC,MAAM,MAAM,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAC;QAEhD,IAAI,eAAe,CAAC,kBAAkB,KAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,eAAe,EAAE,CAAA,EAAE;YACnE,OAAO,2CAA2C,CACrB,MAAM,CAClC,CAAC;SACH;QAED,OAAO,oCAAoC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;KAC/D;IAED,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;AAC3C,CAAC"}

package/dist/cjs/utilities/scroll.js

@@ -17,19 +17,12 @@ function scroll(viewport, options) {
 }
 exports.default = scroll;
 function scrollVolume(viewport, volumeId, delta) {
-    const camera = viewport.getCamera();
-    const { focalPoint, viewPlaneNormal, position } = camera;
-    const { spacingInNormalDirection, actorUID } = core_1.utilities.getTargetVolumeAndSpacingInNormalDir(viewport, camera, volumeId);
-    if (!actorUID) {
-        throw new Error(`Could not find image volume with id ${volumeId} in the viewport`);
-    }
-    const actorEntry = viewport.getActor(actorUID);
-    if (!actorEntry) {
-        console.warn('No actor found for with actorUID of', actorUID);
+    const sliceRangeInfo = core_1.utilities.getVolumeSliceRangeInfo(viewport, volumeId);
+    if (!sliceRangeInfo) {
         return;
     }
-    const volumeActor = actorEntry.actor;
-    const sliceRange = core_1.utilities.getSliceRange(volumeActor, viewPlaneNormal, focalPoint);
+    const { sliceRange, spacingInNormalDirection, camera } = sliceRangeInfo;
+    const { focalPoint, viewPlaneNormal, position } = camera;
     const { newFocalPoint, newPosition } = core_1.utilities.snapFocalPointToSlice(focalPoint, position, sliceRange, viewPlaneNormal, spacingInNormalDirection, delta);
     viewport.setCamera({
         focalPoint: newFocalPoint,

package/dist/cjs/utilities/scroll.js.map

@@ -1 +1 @@
-{"version":3,"file":"scroll.js","sourceRoot":"","sources":["../../../src/utilities/scroll.ts"],"names":[],"mappings":";;;AAAA,8CAK6B;AAY7B,SAAwB,MAAM,CAC5B,QAAsD,EACtD,OAAsB;IAEtB,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,QAAQ,CAAC;IACxC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAEpC,IAAI,QAAQ,YAAY,oBAAa,EAAE;QACrC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;KACjD;SAAM,IAAI,QAAQ,YAAY,qBAAc,EAAE;QAC7C,YAAY,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;KACzC;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,sCAAsC,YAAY,EAAE,CAAC,CAAC;KACvE;AACH,CAAC;AAdD,yBAcC;AAED,SAAgB,YAAY,CAC1B,QAAwB,EACxB,QAAgB,EAChB,KAAa;IAEb,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,EAAE,CAAC;IACpC,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IACzD,MAAM,EAAE,wBAAwB,EAAE,QAAQ,EAAE,GAC1C,gBAAO,CAAC,oCAAoC,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAE3E,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CACb,uCAAuC,QAAQ,kBAAkB,CAClE,CAAC;KACH;IAED,MAAM,UAAU,GAAG,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAE/C,IAAI,CAAC,UAAU,EAAE;QACf,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,QAAQ,CAAC,CAAC;QAC9D,OAAO;KACR;IAED,MAAM,WAAW,GAAG,UAAU,CAAC,KAA0B,CAAC;IAC1D,MAAM,UAAU,GAAG,gBAAO,CAAC,aAAa,CACtC,WAAW,EACX,eAAe,EACf,UAAU,CACX,CAAC;IAEF,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,gBAAO,CAAC,qBAAqB,CAClE,UAAU,EACV,QAAQ,EACR,UAAU,EACV,eAAe,EACf,wBAAwB,EACxB,KAAK,CACN,CAAC;IAEF,QAAQ,CAAC,SAAS,CAAC;QACjB,UAAU,EAAE,aAAa;QACzB,QAAQ,EAAE,WAAW;KACtB,CAAC,CAAC;IACH,QAAQ,CAAC,MAAM,EAAE,CAAC;AACpB,CAAC;AA5CD,oCA4CC"}
+{"version":3,"file":"scroll.js","sourceRoot":"","sources":["../../../src/utilities/scroll.ts"],"names":[],"mappings":";;;AAAA,8CAK6B;AAY7B,SAAwB,MAAM,CAC5B,QAAsD,EACtD,OAAsB;IAEtB,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,QAAQ,CAAC;IACxC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAEpC,IAAI,QAAQ,YAAY,oBAAa,EAAE;QACrC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;KACjD;SAAM,IAAI,QAAQ,YAAY,qBAAc,EAAE;QAC7C,YAAY,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;KACzC;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,sCAAsC,YAAY,EAAE,CAAC,CAAC;KACvE;AACH,CAAC;AAdD,yBAcC;AAED,SAAgB,YAAY,CAC1B,QAAwB,EACxB,QAAgB,EAChB,KAAa;IAEb,MAAM,cAAc,GAAG,gBAAO,CAAC,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAE3E,IAAI,CAAC,cAAc,EAAE;QACnB,OAAO;KACR;IAED,MAAM,EAAE,UAAU,EAAE,wBAAwB,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC;IACxE,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAEzD,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,gBAAO,CAAC,qBAAqB,CAClE,UAAU,EACV,QAAQ,EACR,UAAU,EACV,eAAe,EACf,wBAAwB,EACxB,KAAK,CACN,CAAC;IAEF,QAAQ,CAAC,SAAS,CAAC;QACjB,UAAU,EAAE,aAAa;QACzB,QAAQ,EAAE,WAAW;KACtB,CAAC,CAAC;IACH,QAAQ,CAAC,MAAM,EAAE,CAAC;AACpB,CAAC;AA5BD,oCA4BC"}

package/dist/esm/types/CINETypes.d.ts

@@ -3,6 +3,7 @@ declare type PlayClipOptions = {
     frameTimeVector?: number[];
     reverse?: boolean;
     loop?: boolean;
+    dynamicCineEnabled?: boolean;
     frameTimeVectorSpeedMultiplier?: number;
 };
 interface ToolData {
@@ -15,5 +16,12 @@ interface ToolData {
     speed: number;
     reverse: boolean;
     loop: boolean;
+    dynamicCineEnabled?: boolean;
 }
-export type { PlayClipOptions, ToolData };
+declare type CinePlayContext = {
+    get numScrollSteps(): number;
+    get currentStepIndex(): number;
+    get frameTimeVectorEnabled(): boolean;
+    scroll(delta: number): void;
+};
+export type { PlayClipOptions, ToolData, CinePlayContext };

package/dist/esm/utilities/cine/playClip.js

@@ -1,9 +1,12 @@
-import { utilities, getEnabledElement, StackViewport, } from '@cornerstonejs/core';
+import { glMatrix, vec3 } from 'gl-matrix';
+import { utilities as csUtils, getEnabledElement, StackViewport, VolumeViewport, cache, } from '@cornerstonejs/core';
 import CINE_EVENTS from './events';
 import { addToolState, getToolState } from './state';
-const { triggerEvent } = utilities;
+import scroll from '../scroll';
+const { triggerEvent } = csUtils;
 const debounced = true;
 const loop = true;
+const dynamicVolumesPlayingMap = new Map();
 function playClip(element, playClipOptions) {
     let playClipTimeouts;
     let playClipIsTimeVarying;
@@ -14,15 +17,16 @@ function playClip(element, playClipOptions) {
     if (!enabledElement) {
         throw new Error('playClip: element must be a valid Cornerstone enabled element');
     }
+    playClipOptions.dynamicCineEnabled =
+        playClipOptions.dynamicCineEnabled ?? true;
     const { viewport } = enabledElement;
-    if (!(viewport instanceof StackViewport)) {
-        throw new Error('playClip: element must be a stack viewport, volume viewport playClip not yet implemented');
-    }
-    const stackData = {
-        targetImageIdIndex: viewport.getTargetImageIdIndex(),
-        imageIds: viewport.getImageIds(),
-    };
+    const volume = _getVolumeFromViewport(viewport);
+    const playClipContext = _createCinePlayContext(viewport, playClipOptions);
     let playClipData = getToolState(element);
+    const isDynamicCinePlaying = playClipOptions.dynamicCineEnabled && volume?.isDynamicVolume();
+    if (isDynamicCinePlaying) {
+        _stopDynamicVolumeCine(element);
+    }
     if (!playClipData) {
         playClipData = {
             intervalId: undefined,
@@ -38,8 +42,9 @@ function playClip(element, playClipOptions) {
         addToolState(element, playClipData);
     }
     else {
-        _stopClipWithData(playClipData);
+        _stopClip(element, isDynamicCinePlaying);
     }
+    playClipData.dynamicCineEnabled = playClipOptions.dynamicCineEnabled;
     if (playClipOptions.framesPerSecond < 0 ||
         playClipOptions.framesPerSecond > 0) {
         playClipData.framesPerSecond = Number(playClipOptions.framesPerSecond);
@@ -48,50 +53,42 @@ function playClip(element, playClipOptions) {
     }
     if (playClipData.ignoreFrameTimeVector !== true &&
         playClipData.frameTimeVector &&
-        playClipData.frameTimeVector.length === stackData.imageIds.length) {
+        playClipData.frameTimeVector.length === playClipContext.numScrollSteps &&
+        playClipContext.frameTimeVectorEnabled) {
         const { timeouts, isTimeVarying } = _getPlayClipTimeouts(playClipData.frameTimeVector, playClipData.speed);
         playClipTimeouts = timeouts;
         playClipIsTimeVarying = isTimeVarying;
     }
     const playClipAction = () => {
-        const stackData = {
-            targetImageIdIndex: viewport.getTargetImageIdIndex(),
-            imageIds: viewport.getImageIds(),
-        };
-        let newImageIdIndex = stackData.targetImageIdIndex;
-        const imageCount = stackData.imageIds.length;
-        if (playClipData.reverse) {
-            newImageIdIndex--;
-        }
-        else {
-            newImageIdIndex++;
-        }
-        if (!playClipData.loop &&
-            (newImageIdIndex < 0 || newImageIdIndex >= imageCount)) {
-            _stopClipWithData(playClipData);
-            const eventDetail = {
-                element,
-            };
+        const { numScrollSteps, currentStepIndex } = playClipContext;
+        let newStepIndex = currentStepIndex + (playClipData.reverse ? -1 : 1);
+        const newStepIndexOutOfRange = newStepIndex < 0 || newStepIndex >= numScrollSteps;
+        if (!loop && newStepIndexOutOfRange) {
+            _stopClip(element, isDynamicCinePlaying);
+            const eventDetail = { element };
             triggerEvent(element, CINE_EVENTS.CLIP_STOPPED, eventDetail);
             return;
         }
-        if (newImageIdIndex >= imageCount) {
-            newImageIdIndex = 0;
+        if (newStepIndex >= numScrollSteps) {
+            newStepIndex = 0;
         }
-        if (newImageIdIndex < 0) {
-            newImageIdIndex = imageCount - 1;
+        else if (newStepIndex < 0) {
+            newStepIndex = numScrollSteps - 1;
         }
-        if (newImageIdIndex !== stackData.targetImageIdIndex) {
-            const delta = newImageIdIndex - stackData.targetImageIdIndex;
-            viewport.scroll(delta, debounced, loop);
+        const delta = newStepIndex - currentStepIndex;
+        if (delta) {
+            playClipContext.scroll(delta);
         }
     };
+    if (isDynamicCinePlaying) {
+        dynamicVolumesPlayingMap.set(volume.volumeId, element);
+    }
     if (playClipTimeouts &&
         playClipTimeouts.length > 0 &&
         playClipIsTimeVarying) {
         playClipData.usingFrameTimeVector = true;
         playClipData.intervalId = window.setTimeout(function playClipTimeoutHandler() {
-            playClipData.intervalId = window.setTimeout(playClipTimeoutHandler, playClipTimeouts[stackData.targetImageIdIndex]);
+            playClipData.intervalId = window.setTimeout(playClipTimeoutHandler, playClipTimeouts[playClipContext.currentStepIndex]);
             playClipAction();
         }, 0);
     }
@@ -105,15 +102,31 @@ function playClip(element, playClipOptions) {
     triggerEvent(element, CINE_EVENTS.CLIP_STARTED, eventDetail);
 }
 function stopClip(element) {
+    _stopClip(element, true);
+}
+function _stopClip(element, stopDynamicCine) {
     const enabledElement = getEnabledElement(element);
     if (!enabledElement)
         return;
     const { viewport } = enabledElement;
     const cineToolData = getToolState(viewport.element);
-    if (!cineToolData) {
-        return;
+    if (cineToolData) {
+        _stopClipWithData(cineToolData);
+    }
+    if (stopDynamicCine) {
+        _stopDynamicVolumeCine(element);
+    }
+}
+function _stopDynamicVolumeCine(element) {
+    const { viewport } = getEnabledElement(element);
+    const volume = _getVolumeFromViewport(viewport);
+    if (volume?.isDynamicVolume()) {
+        const dynamicCineElement = dynamicVolumesPlayingMap.get(volume.volumeId);
+        dynamicVolumesPlayingMap.delete(volume.volumeId);
+        if (dynamicCineElement && dynamicCineElement !== element) {
+            stopClip(dynamicCineElement);
+        }
     }
-    _stopClipWithData(cineToolData);
 }
 function _getPlayClipTimeouts(vector, speed) {
     let i;
@@ -160,5 +173,98 @@ function _stopClipWithData(playClipData) {
         }
     }
 }
+function _getVolumeFromViewport(viewport) {
+    const actorEntry = viewport.getDefaultActor();
+    if (!actorEntry) {
+        console.warn('No actor found');
+        return;
+    }
+    const volumeId = actorEntry.uid;
+    return cache.getVolume(volumeId);
+}
+function _createStackViewportCinePlayContext(viewport) {
+    const imageIds = viewport.getImageIds();
+    return {
+        get numScrollSteps() {
+            return imageIds.length;
+        },
+        get currentStepIndex() {
+            return viewport.getTargetImageIdIndex();
+        },
+        get frameTimeVectorEnabled() {
+            return true;
+        },
+        scroll(delta) {
+            scroll(viewport, { delta, debounceLoading: debounced });
+        },
+    };
+}
+function _createVolumeViewportCinePlayContext(viewport, volume) {
+    const { volumeId } = volume;
+    const cachedScrollInfo = {
+        viewPlaneNormal: vec3.create(),
+        scrollInfo: null,
+    };
+    const getScrollInfo = () => {
+        const camera = viewport.getCamera();
+        const updateCache = !cachedScrollInfo.scrollInfo ||
+            !vec3.equals(camera.viewPlaneNormal, cachedScrollInfo.viewPlaneNormal);
+        if (updateCache) {
+            const scrollInfo = csUtils.getVolumeViewportScrollInfo(viewport, volumeId);
+            cachedScrollInfo.viewPlaneNormal = camera.viewPlaneNormal;
+            cachedScrollInfo.scrollInfo = scrollInfo;
+        }
+        return cachedScrollInfo.scrollInfo;
+    };
+    return {
+        get numScrollSteps() {
+            return getScrollInfo().numScrollSteps;
+        },
+        get currentStepIndex() {
+            return getScrollInfo().currentStepIndex;
+        },
+        get frameTimeVectorEnabled() {
+            const camera = viewport.getCamera();
+            const volumeViewPlaneNormal = volume.direction
+                .slice(6, 9)
+                .map((x) => -x);
+            const dot = vec3.dot(volumeViewPlaneNormal, camera.viewPlaneNormal);
+            return glMatrix.equals(dot, 1);
+        },
+        scroll(delta) {
+            getScrollInfo().currentStepIndex += delta;
+            scroll(viewport, { delta });
+        },
+    };
+}
+function _createDynamicVolumeViewportCinePlayContext(volume) {
+    return {
+        get numScrollSteps() {
+            return volume.numTimePoints;
+        },
+        get currentStepIndex() {
+            return volume.timePointIndex;
+        },
+        get frameTimeVectorEnabled() {
+            return false;
+        },
+        scroll(delta) {
+            volume.timePointIndex += delta;
+        },
+    };
+}
+function _createCinePlayContext(viewport, playClipOptions) {
+    if (viewport instanceof StackViewport) {
+        return _createStackViewportCinePlayContext(viewport);
+    }
+    if (viewport instanceof VolumeViewport) {
+        const volume = _getVolumeFromViewport(viewport);
+        if (playClipOptions.dynamicCineEnabled && volume?.isDynamicVolume()) {
+            return _createDynamicVolumeViewportCinePlayContext(volume);
+        }
+        return _createVolumeViewportCinePlayContext(viewport, volume);
+    }
+    throw new Error('Unknown viewport type');
+}
 export { playClip, stopClip };
 //# sourceMappingURL=playClip.js.map