@cornerstonejs/tools 1.15.0 → 1.16.0

package/package.json

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

package/src/tools/displayTools/Labelmap/labelmapDisplay.ts

@@ -276,6 +276,9 @@ function _setLabelmapColorAndOpacity(
     isActiveLabelmap
   );
 
+  // Todo: the below loop probably can be optimized so that we don't hit it
+  // unless a config has changed. Right now we get into the following loop
+  // even for brush drawing which does not makes sense
   for (let i = 0; i < numColors; i++) {
     const segmentIndex = i;
     const segmentColor = colorLUT[segmentIndex];

package/src/tools/displayTools/SegmentationDisplayTool.ts

@@ -143,26 +143,20 @@ class SegmentationDisplayTool extends BaseTool {
         const config = this._getMergedRepresentationsConfig(toolGroupId);
 
         const viewportsRenderList = [];
+        const display =
+          representation.type === Representations.Labelmap
+            ? labelmapDisplay
+            : contourDisplay;
+
         for (const viewport of toolGroupViewports) {
-          if (representation.type == Representations.Labelmap) {
-            viewportsRenderList.push(
-              labelmapDisplay.render(
-                viewport as Types.IVolumeViewport,
-                representation,
-                config
-              )
-            );
-          } else if (representation.type == Representations.Contour) {
-            viewportsRenderList.push(
-              contourDisplay.render(
-                viewport as Types.IVolumeViewport,
-                representation,
-                config
-              )
-            );
-          }
-        }
+          const renderedViewport = display.render(
+            viewport as Types.IVolumeViewport,
+            representation,
+            config
+          );
 
+          viewportsRenderList.push(renderedViewport);
+        }
         return viewportsRenderList;
       }
     );

package/src/types/CINETypes.ts

@@ -1,5 +1,3 @@
-import { Types } from '@cornerstonejs/core';
-
 type PlayClipOptions = {
   framesPerSecond?: number;
   frameTimeVector?: number[];
@@ -7,6 +5,11 @@ type PlayClipOptions = {
   loop?: boolean;
   dynamicCineEnabled?: boolean;
   frameTimeVectorSpeedMultiplier?: number;
+  // How many CINE frames to wait for a rendered event to occur before
+  // trying to display the image after the next one
+  // A CINE frame is attempted every 1 / fps seconds
+  // The default is 30 tries, or 1.25 seconds at 24 fps
+  waitForRendered?: number;
 };
 
 interface ToolData {
@@ -26,6 +29,9 @@ type CinePlayContext = {
   get numScrollSteps(): number;
   get currentStepIndex(): number;
   get frameTimeVectorEnabled(): boolean;
+  // How many times has the wait for rendered been tried without showing
+  // the next image.
+  waitForRenderedCount?: number;
   scroll(delta: number): void;
 };
 

package/src/utilities/cine/playClip.ts

@@ -6,6 +6,7 @@ import {
   VolumeViewport,
   cache,
   BaseVolumeViewport,
+  Enums,
 } from '@cornerstonejs/core';
 
 import { Types } from '@cornerstonejs/core';
@@ -14,6 +15,7 @@ import { addToolState, getToolState } from './state';
 import { CINETypes } from '../../types';
 import scroll from '../scroll';
 
+const { ViewportStatus } = Enums;
 const { triggerEvent } = csUtils;
 
 const debounced = true;
@@ -315,7 +317,8 @@ function _getVolumeFromViewport(viewport): Types.IImageVolume {
 }
 
 function _createStackViewportCinePlayContext(
-  viewport: StackViewport
+  viewport: StackViewport,
+  waitForRendered: number
 ): CINETypes.CinePlayContext {
   const imageIds = viewport.getImageIds();
 
@@ -330,7 +333,16 @@ function _createStackViewportCinePlayContext(
       // It is always in acquired orientation
       return true;
     },
+    waitForRenderedCount: 0,
     scroll(delta: number): void {
+      if (
+        this.waitForRenderedCount <= waitForRendered &&
+        viewport.viewportStatus !== ViewportStatus.RENDERED
+      ) {
+        this.waitForRenderedCount++;
+        return;
+      }
+      this.waitForRenderedCount = 0;
       scroll(viewport, { delta, debounceLoading: debounced });
     },
   };
@@ -419,7 +431,10 @@ function _createCinePlayContext(
   playClipOptions: CINETypes.PlayClipOptions
 ): CINETypes.CinePlayContext {
   if (viewport instanceof StackViewport) {
-    return _createStackViewportCinePlayContext(viewport);
+    return _createStackViewportCinePlayContext(
+      viewport,
+      playClipOptions.waitForRendered ?? 30
+    );
   }
 
   if (viewport instanceof VolumeViewport) {

package/src/utilities/segmentation/brushSizeForToolGroup.ts

@@ -4,9 +4,17 @@ import triggerAnnotationRenderForViewportIds from '../triggerAnnotationRenderFor
 import { getRenderingEngine } from '@cornerstonejs/core';
 import getBrushToolInstances from './utilities';
 
+/**
+ * Sets the brush size for all brush-based tools in a given tool group.
+ * @param toolGroupId - The ID of the tool group to set the brush size for.
+ * @param brushSize - The new brush size to set.
+ * @param toolName - The name of the specific tool to set the brush size for (optional)
+ * If not provided, all brush-based tools in the tool group will be affected.
+ */
 export function setBrushSizeForToolGroup(
   toolGroupId: string,
-  brushSize: number
+  brushSize: number,
+  toolName?: string
 ): void {
   const toolGroup = getToolGroup(toolGroupId);
 
@@ -14,7 +22,7 @@ export function setBrushSizeForToolGroup(
     return;
   }
 
-  const brushBasedToolInstances = getBrushToolInstances(toolGroupId);
+  const brushBasedToolInstances = getBrushToolInstances(toolGroupId, toolName);
 
   brushBasedToolInstances.forEach((tool: BrushTool) => {
     tool.configuration.brushSize = brushSize;
@@ -45,7 +53,17 @@ export function setBrushSizeForToolGroup(
   triggerAnnotationRenderForViewportIds(renderingEngine, viewportIds);
 }
 
-export function getBrushSizeForToolGroup(toolGroupId: string): void {
+/**
+ * Gets the brush size for the first brush-based tool instance in a given tool group.
+ * @param toolGroupId - The ID of the tool group to get the brush size for.
+ * @param toolName - The name of the specific tool to get the brush size for (Optional)
+ * If not provided, the first brush-based tool instance in the tool group will be used.
+ * @returns The brush size of the selected tool instance, or undefined if no brush-based tool instance is found.
+ */
+export function getBrushSizeForToolGroup(
+  toolGroupId: string,
+  toolName?: string
+): void {
   const toolGroup = getToolGroup(toolGroupId);
 
   if (toolGroup === undefined) {
@@ -58,7 +76,7 @@ export function getBrushSizeForToolGroup(toolGroupId: string): void {
     return;
   }
 
-  const brushBasedToolInstances = getBrushToolInstances(toolGroupId);
+  const brushBasedToolInstances = getBrushToolInstances(toolGroupId, toolName);
 
   // one is enough as they share the same brush size
   const brushToolInstance = brushBasedToolInstances[0];

package/src/utilities/segmentation/utilities.ts

@@ -10,7 +10,10 @@ export type ThresholdInformation = {
   upper: number;
 };
 
-export default function getBrushToolInstances(toolGroupId) {
+export default function getBrushToolInstances(
+  toolGroupId: string,
+  toolName?: string
+) {
   const toolGroup = getToolGroup(toolGroupId);
 
   if (toolGroup === undefined) {
@@ -23,6 +26,10 @@ export default function getBrushToolInstances(toolGroupId) {
     return;
   }
 
+  if (toolName && toolInstances[toolName]) {
+    return [toolInstances[toolName]];
+  }
+
   // For each tool that has BrushTool as base class, set the brush size.
   const brushBasedToolInstances = Object.values(toolInstances).filter(
     (toolInstance) => toolInstance instanceof BrushTool