@cornerstonejs/tools 3.12.3 → 3.14.0

package/dist/esm/index.d.ts

@@ -3,6 +3,7 @@ import { addTool, removeTool, ToolGroupManager, SynchronizerManager, Synchronize
 import { state } from './store/state';
 import * as store from './store';
 import * as CONSTANTS from './constants';
+import { version } from './version';
 import * as synchronizers from './synchronizers';
 import * as drawing from './drawingSvg';
 import * as utilities from './utilities';
@@ -14,4 +15,4 @@ import * as splines from './tools/annotation/splines';
 import { BaseTool, AnnotationTool, AnnotationDisplayTool, PanTool, TrackballRotateTool, DragProbeTool, WindowLevelTool, ZoomTool, StackScrollTool, SegmentBidirectionalTool, PlanarRotateTool, MIPJumpToClickTool, LabelTool, LengthTool, HeightTool, ProbeTool, RectangleROITool, EllipticalROITool, CircleROITool, ETDRSGridTool, SplineROITool, SplineContourSegmentationTool, BidirectionalTool, PlanarFreehandROITool, PlanarFreehandContourSegmentationTool, LivewireContourTool, LivewireContourSegmentationTool, ArrowAnnotateTool, KeyImageTool, CrosshairsTool, ReferenceLinesTool, RectangleScissorsTool, CircleScissorsTool, SphereScissorsTool, RectangleROIThresholdTool, RectangleROIStartEndThresholdTool, CircleROIStartEndThresholdTool, BrushTool, AngleTool, CobbAngleTool, UltrasoundDirectionalTool, MagnifyTool, AdvancedMagnifyTool, ReferenceCursors, PaintFillTool, ScaleOverlayTool, OrientationMarkerTool, OverlayGridTool, SegmentationIntersectionTool, EraserTool, SculptorTool, SegmentSelectTool, WindowLevelRegionTool, VolumeRotateTool, RegionSegmentPlusTool, RegionSegmentTool, WholeBodySegmentTool, LabelmapBaseTool, SegmentLabelTool } from './tools';
 import VideoRedactionTool from './tools/annotation/VideoRedactionTool';
 import * as Enums from './enums';
-export { VideoRedactionTool, init, destroy, addTool, removeTool, cancelActiveManipulations, BaseTool, AnnotationTool, AnnotationDisplayTool, PanTool, SegmentBidirectionalTool, TrackballRotateTool, DragProbeTool, WindowLevelTool, WindowLevelRegionTool, ZoomTool, StackScrollTool, PlanarRotateTool, MIPJumpToClickTool, LabelTool, LengthTool, HeightTool, CrosshairsTool, ReferenceLinesTool, OverlayGridTool, SegmentationIntersectionTool, ProbeTool, RectangleROITool, EllipticalROITool, CircleROITool, ETDRSGridTool, SplineROITool, SplineContourSegmentationTool, BidirectionalTool, PlanarFreehandROITool, PlanarFreehandContourSegmentationTool, LivewireContourTool, LivewireContourSegmentationTool, ArrowAnnotateTool, AngleTool, CobbAngleTool, UltrasoundDirectionalTool, KeyImageTool, MagnifyTool, AdvancedMagnifyTool, ReferenceCursors, ScaleOverlayTool, SculptorTool, EraserTool, RectangleScissorsTool, CircleScissorsTool, SphereScissorsTool, RectangleROIThresholdTool, RectangleROIStartEndThresholdTool, CircleROIStartEndThresholdTool, BrushTool, OrientationMarkerTool, SegmentSelectTool, SegmentLabelTool, synchronizers, Synchronizer, SynchronizerManager, PaintFillTool, Types, state, ToolGroupManager, store, Enums, CONSTANTS, drawing, annotation, segmentation, utilities, cursors, VolumeRotateTool, RegionSegmentPlusTool, RegionSegmentTool, WholeBodySegmentTool, LabelmapBaseTool, splines, };
+export { VideoRedactionTool, init, destroy, addTool, removeTool, cancelActiveManipulations, BaseTool, AnnotationTool, AnnotationDisplayTool, PanTool, SegmentBidirectionalTool, TrackballRotateTool, DragProbeTool, WindowLevelTool, WindowLevelRegionTool, ZoomTool, StackScrollTool, PlanarRotateTool, MIPJumpToClickTool, LabelTool, LengthTool, HeightTool, CrosshairsTool, ReferenceLinesTool, OverlayGridTool, SegmentationIntersectionTool, ProbeTool, RectangleROITool, EllipticalROITool, CircleROITool, ETDRSGridTool, SplineROITool, SplineContourSegmentationTool, BidirectionalTool, PlanarFreehandROITool, PlanarFreehandContourSegmentationTool, LivewireContourTool, LivewireContourSegmentationTool, ArrowAnnotateTool, AngleTool, CobbAngleTool, UltrasoundDirectionalTool, KeyImageTool, MagnifyTool, AdvancedMagnifyTool, ReferenceCursors, ScaleOverlayTool, SculptorTool, EraserTool, RectangleScissorsTool, CircleScissorsTool, SphereScissorsTool, RectangleROIThresholdTool, RectangleROIStartEndThresholdTool, CircleROIStartEndThresholdTool, BrushTool, OrientationMarkerTool, SegmentSelectTool, SegmentLabelTool, synchronizers, Synchronizer, SynchronizerManager, PaintFillTool, Types, state, ToolGroupManager, store, Enums, CONSTANTS, drawing, annotation, segmentation, utilities, cursors, VolumeRotateTool, RegionSegmentPlusTool, RegionSegmentTool, WholeBodySegmentTool, LabelmapBaseTool, splines, version, };

package/dist/esm/index.js

@@ -3,6 +3,7 @@ import { addTool, removeTool, ToolGroupManager, SynchronizerManager, Synchronize
 import { state } from './store/state';
 import * as store from './store';
 import * as CONSTANTS from './constants';
+import { version } from './version';
 import * as synchronizers from './synchronizers';
 import * as drawing from './drawingSvg';
 import * as utilities from './utilities';
@@ -14,4 +15,4 @@ import * as splines from './tools/annotation/splines';
 import { BaseTool, AnnotationTool, AnnotationDisplayTool, PanTool, TrackballRotateTool, DragProbeTool, WindowLevelTool, ZoomTool, StackScrollTool, SegmentBidirectionalTool, PlanarRotateTool, MIPJumpToClickTool, LabelTool, LengthTool, HeightTool, ProbeTool, RectangleROITool, EllipticalROITool, CircleROITool, ETDRSGridTool, SplineROITool, SplineContourSegmentationTool, BidirectionalTool, PlanarFreehandROITool, PlanarFreehandContourSegmentationTool, LivewireContourTool, LivewireContourSegmentationTool, ArrowAnnotateTool, KeyImageTool, CrosshairsTool, ReferenceLinesTool, RectangleScissorsTool, CircleScissorsTool, SphereScissorsTool, RectangleROIThresholdTool, RectangleROIStartEndThresholdTool, CircleROIStartEndThresholdTool, BrushTool, AngleTool, CobbAngleTool, UltrasoundDirectionalTool, MagnifyTool, AdvancedMagnifyTool, ReferenceCursors, PaintFillTool, ScaleOverlayTool, OrientationMarkerTool, OverlayGridTool, SegmentationIntersectionTool, EraserTool, SculptorTool, SegmentSelectTool, WindowLevelRegionTool, VolumeRotateTool, RegionSegmentPlusTool, RegionSegmentTool, WholeBodySegmentTool, LabelmapBaseTool, SegmentLabelTool, } from './tools';
 import VideoRedactionTool from './tools/annotation/VideoRedactionTool';
 import * as Enums from './enums';
-export { VideoRedactionTool, init, destroy, addTool, removeTool, cancelActiveManipulations, BaseTool, AnnotationTool, AnnotationDisplayTool, PanTool, SegmentBidirectionalTool, TrackballRotateTool, DragProbeTool, WindowLevelTool, WindowLevelRegionTool, ZoomTool, StackScrollTool, PlanarRotateTool, MIPJumpToClickTool, LabelTool, LengthTool, HeightTool, CrosshairsTool, ReferenceLinesTool, OverlayGridTool, SegmentationIntersectionTool, ProbeTool, RectangleROITool, EllipticalROITool, CircleROITool, ETDRSGridTool, SplineROITool, SplineContourSegmentationTool, BidirectionalTool, PlanarFreehandROITool, PlanarFreehandContourSegmentationTool, LivewireContourTool, LivewireContourSegmentationTool, ArrowAnnotateTool, AngleTool, CobbAngleTool, UltrasoundDirectionalTool, KeyImageTool, MagnifyTool, AdvancedMagnifyTool, ReferenceCursors, ScaleOverlayTool, SculptorTool, EraserTool, RectangleScissorsTool, CircleScissorsTool, SphereScissorsTool, RectangleROIThresholdTool, RectangleROIStartEndThresholdTool, CircleROIStartEndThresholdTool, BrushTool, OrientationMarkerTool, SegmentSelectTool, SegmentLabelTool, synchronizers, Synchronizer, SynchronizerManager, PaintFillTool, Types, state, ToolGroupManager, store, Enums, CONSTANTS, drawing, annotation, segmentation, utilities, cursors, VolumeRotateTool, RegionSegmentPlusTool, RegionSegmentTool, WholeBodySegmentTool, LabelmapBaseTool, splines, };
+export { VideoRedactionTool, init, destroy, addTool, removeTool, cancelActiveManipulations, BaseTool, AnnotationTool, AnnotationDisplayTool, PanTool, SegmentBidirectionalTool, TrackballRotateTool, DragProbeTool, WindowLevelTool, WindowLevelRegionTool, ZoomTool, StackScrollTool, PlanarRotateTool, MIPJumpToClickTool, LabelTool, LengthTool, HeightTool, CrosshairsTool, ReferenceLinesTool, OverlayGridTool, SegmentationIntersectionTool, ProbeTool, RectangleROITool, EllipticalROITool, CircleROITool, ETDRSGridTool, SplineROITool, SplineContourSegmentationTool, BidirectionalTool, PlanarFreehandROITool, PlanarFreehandContourSegmentationTool, LivewireContourTool, LivewireContourSegmentationTool, ArrowAnnotateTool, AngleTool, CobbAngleTool, UltrasoundDirectionalTool, KeyImageTool, MagnifyTool, AdvancedMagnifyTool, ReferenceCursors, ScaleOverlayTool, SculptorTool, EraserTool, RectangleScissorsTool, CircleScissorsTool, SphereScissorsTool, RectangleROIThresholdTool, RectangleROIStartEndThresholdTool, CircleROIStartEndThresholdTool, BrushTool, OrientationMarkerTool, SegmentSelectTool, SegmentLabelTool, synchronizers, Synchronizer, SynchronizerManager, PaintFillTool, Types, state, ToolGroupManager, store, Enums, CONSTANTS, drawing, annotation, segmentation, utilities, cursors, VolumeRotateTool, RegionSegmentPlusTool, RegionSegmentTool, WholeBodySegmentTool, LabelmapBaseTool, splines, version, };

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

@@ -1,11 +1,12 @@
 type PlayClipOptions = {
     framesPerSecond?: number;
     frameTimeVector?: number[];
+    frameTimeVectorSpeedMultiplier?: number;
     reverse?: boolean;
     loop?: boolean;
     dynamicCineEnabled?: boolean;
-    frameTimeVectorSpeedMultiplier?: number;
     waitForRendered?: number;
+    bounce?: boolean;
 };
 interface ToolData {
     intervalId: number | undefined;
@@ -17,6 +18,7 @@ interface ToolData {
     speed: number;
     reverse: boolean;
     loop: boolean;
+    bounce: boolean;
     dynamicCineEnabled?: boolean;
 }
 type CinePlayContext = {

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

@@ -39,6 +39,7 @@ function playClip(element, playClipOptions) {
             speed: playClipOptions.frameTimeVectorSpeedMultiplier ?? 1,
             reverse: playClipOptions.reverse ?? false,
             loop: playClipOptions.loop ?? true,
+            bounce: playClipOptions.bounce ?? false,
         };
         addToolState(element, playClipData);
     }
@@ -63,24 +64,30 @@ function playClip(element, playClipOptions) {
         playClipTimeouts = timeouts;
         playClipIsTimeVarying = isTimeVarying;
     }
+    if (playClipOptions.bounce !== undefined) {
+        playClipData.bounce = playClipOptions.bounce;
+    }
     const playClipAction = () => {
         const { numScrollSteps, currentStepIndex } = playClipContext;
         let newStepIndex = currentStepIndex + (playClipData.reverse ? -1 : 1);
-        const newStepIndexOutOfRange = newStepIndex < 0 || newStepIndex >= numScrollSteps;
-        if (!playClipData.loop && newStepIndexOutOfRange) {
-            _stopClip(element, {
-                stopDynamicCine: !isDynamicCinePlaying,
-                viewportId: viewport.id,
-            });
-            const eventDetail = { element };
-            triggerEvent(element, CINE_EVENTS.CLIP_STOPPED, eventDetail);
-            return;
-        }
-        if (newStepIndex >= numScrollSteps) {
-            newStepIndex = 0;
-        }
-        else if (newStepIndex < 0) {
-            newStepIndex = numScrollSteps - 1;
+        const outOfRange = newStepIndex < 0 || newStepIndex >= numScrollSteps;
+        if (outOfRange) {
+            if (playClipData.bounce) {
+                playClipData.reverse = !playClipData.reverse;
+                newStepIndex = currentStepIndex + (playClipData.reverse ? -1 : 1);
+                newStepIndex = Math.max(0, Math.min(numScrollSteps - 1, newStepIndex));
+            }
+            else if (!playClipData.loop) {
+                _stopClip(element, {
+                    stopDynamicCine: !isDynamicCinePlaying,
+                    viewportId: viewport.id,
+                });
+                triggerEvent(element, CINE_EVENTS.CLIP_STOPPED, { element });
+                return;
+            }
+            else {
+                newStepIndex = playClipData.reverse ? numScrollSteps - 1 : 0;
+            }
         }
         const delta = newStepIndex - currentStepIndex;
         if (delta) {
@@ -90,8 +97,7 @@ function playClip(element, playClipOptions) {
             catch (e) {
                 console.warn('Play clip not scrolling', e);
                 _stopClipWithData(playClipData);
-                triggerEvent(element, CINE_EVENTS.CLIP_STOPPED, eventDetail);
-                return;
+                triggerEvent(element, CINE_EVENTS.CLIP_STOPPED, { element });
             }
         }
     };

package/dist/esm/version.d.ts

@@ -0,0 +1 @@
+export declare const version = "3.14.0";

package/dist/esm/version.js

@@ -0,0 +1 @@
+export const version = '3.14.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "3.12.3",
+  "version": "3.14.0",
   "description": "Cornerstone3D Tools",
   "types": "./dist/esm/index.d.ts",
   "module": "./dist/esm/index.js",
@@ -78,9 +78,14 @@
     },
     "./types/*": {
       "types": "./dist/esm/types/*.d.ts"
+    },
+    "./version": {
+      "import": "./dist/esm/version.js",
+      "types": "./dist/esm/version.d.ts"
     }
   },
   "scripts": {
+    "prebuild": "node ../../scripts/generate-version.js ./",
     "build:esm": "tsc --project ./tsconfig.json",
     "build:esm:watch": "tsc --project ./tsconfig.json --watch",
     "build:umd": "cross-env NODE_ENV=production webpack --config .webpack/webpack.prod.js",
@@ -103,7 +108,7 @@
     "canvas": "^3.1.0"
   },
   "peerDependencies": {
-    "@cornerstonejs/core": "^3.12.3",
+    "@cornerstonejs/core": "^3.14.0",
     "@kitware/vtk.js": "32.12.1",
     "@types/d3-array": "^3.0.4",
     "@types/d3-interpolate": "^3.0.1",
@@ -122,5 +127,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "bbebfa9b1df39b562dd4e1cf3e94ed0a496f2324"
+  "gitHead": "77cb34ca2e17c506bf6376f40bdf6cb934e176e3"
 }