@cornerstonejs/tools 1.25.0 → 1.26.0

package/src/tools/base/AnnotationDisplayTool.ts

@@ -1,9 +1,9 @@
 import {
   utilities,
   getEnabledElement,
-  VolumeViewport,
   StackViewport,
   cache,
+  VideoViewport,
 } from '@cornerstonejs/core';
 import type { Types } from '@cornerstonejs/core';
 
@@ -123,7 +123,7 @@ abstract class AnnotationDisplayTool extends BaseTool {
   };
 
   protected getReferencedImageId(
-    viewport: Types.IStackViewport | Types.IVolumeViewport,
+    viewport: Types.IViewport,
     worldPos: Types.Point3,
     viewPlaneNormal: Types.Point3,
     viewUp: Types.Point3
@@ -132,7 +132,10 @@ abstract class AnnotationDisplayTool extends BaseTool {
 
     let referencedImageId;
 
-    if (viewport instanceof StackViewport) {
+    if (
+      viewport instanceof StackViewport ||
+      viewport instanceof VideoViewport
+    ) {
       referencedImageId = targetId.split('imageId:')[1];
     } else {
       const volumeId = targetId.split('volumeId:')[1];

package/src/tools/base/AnnotationTool.ts

@@ -219,7 +219,7 @@ abstract class AnnotationTool extends AnnotationDisplayTool {
           canvasCoords[1] <= canvasBoundingBox.bottomRight[1]
         ) {
           data.handles.activeHandleIndex = null;
-          return textBox;
+          return textBox as ToolHandle;
         }
       }
     }

package/src/tools/base/BaseTool.ts

@@ -2,6 +2,7 @@ import {
   StackViewport,
   utilities,
   BaseVolumeViewport,
+  VideoViewport,
 } from '@cornerstonejs/core';
 import { Types } from '@cornerstonejs/core';
 import { ToolModes } from '../../enums';
@@ -205,6 +206,8 @@ abstract class BaseTool implements IBaseTool {
       return `imageId:${viewport.getCurrentImageId()}`;
     } else if (viewport instanceof BaseVolumeViewport) {
       return `volumeId:${this.getTargetVolumeId(viewport)}`;
+    } else if (viewport instanceof VideoViewport) {
+      return '';
     } else {
       throw new Error(
         'getTargetId: viewport must be a StackViewport or VolumeViewport'

package/src/types/AnnotationTypes.ts

@@ -65,7 +65,7 @@ type Annotation = {
         /** the world location of the text box */
         worldPosition: Types.Point3;
         /** text box bounding box information */
-        worldBoundingBox: {
+        worldBoundingBox?: {
           /** Top left location of the text box in the world space */
           topLeft: Types.Point3;
           /** Top right location of the text box in the world space */

package/src/types/ToolSpecificAnnotationTypes.ts

@@ -368,3 +368,24 @@ export interface ScaleOverlayAnnotation extends Annotation {
     viewportId: string;
   };
 }
+
+export interface VideoRedactionAnnotation extends Annotation {
+  metadata: {
+    viewPlaneNormal: Types.Point3;
+    viewUp: Types.Point3;
+    FrameOfReferenceUID: string;
+    referencedImageId: string;
+    toolName: string;
+  };
+  data: {
+    invalidated: boolean;
+    handles: {
+      points: Types.Point3[];
+      activeHandleIndex: number | null;
+    };
+    cachedStats: {
+      [key: string]: any; // Can be more specific if the structure is known
+    };
+    active: boolean;
+  };
+}

package/src/utilities/planar/filterAnnotationsForDisplay.ts

@@ -1,6 +1,7 @@
 import {
   StackViewport,
   VolumeViewport,
+  VideoViewport,
   Types,
   utilities as csUtils,
 } from '@cornerstonejs/core';
@@ -50,6 +51,12 @@ export default function filterAnnotationsForDisplay(
       const referenceImageURI = imageId.substring(colonIndex + 1);
       return referenceImageURI === imageURI;
     });
+  } else if (viewport instanceof VideoViewport) {
+    const frameOfReferenceUID: string = viewport.getFrameOfReferenceUID();
+
+    return annotations.filter((toolData) => {
+      return toolData.metadata.FrameOfReferenceUID === frameOfReferenceUID;
+    });
   } else if (viewport instanceof VolumeViewport) {
     const camera = viewport.getCamera();
 

package/src/utilities/scroll.ts

@@ -6,6 +6,7 @@ import {
   EVENTS,
   utilities as csUtils,
   getEnabledElement,
+  VideoViewport,
 } from '@cornerstonejs/core';
 import { ScrollOptions, EventTypes } from '../types';
 
@@ -19,7 +20,7 @@ import { ScrollOptions, EventTypes } from '../types';
  * @returns
  */
 export default function scroll(
-  viewport: Types.IStackViewport | Types.IVolumeViewport,
+  viewport: Types.IViewport,
   options: ScrollOptions
 ): void {
   // check if viewport is disabled then throw error
@@ -43,6 +44,8 @@ export default function scroll(
     viewport.scroll(delta, options.debounceLoading, options.loop);
   } else if (viewport instanceof VolumeViewport) {
     scrollVolume(viewport, volumeId, delta);
+  } else if (viewport instanceof VideoViewport) {
+    viewport.scroll(delta);
   } else {
     throw new Error(`Not implemented for Viewport Type: ${viewportType}`);
   }

package/src/utilities/viewportFilters/filterViewportsWithFrameOfReferenceUID.ts

@@ -10,7 +10,7 @@ import type { Types } from '@cornerstonejs/core';
  * @returns A filtered array of viewports.
  */
 export default function filterViewportsWithFrameOfReferenceUID(
-  viewports: Array<Types.IStackViewport | Types.IVolumeViewport>,
+  viewports: Array<Types.IViewport>,
   FrameOfReferenceUID: string
 ): Array<Types.IStackViewport | Types.IVolumeViewport> {
   const numViewports = viewports.length;

package/src/utilities/viewportFilters/filterViewportsWithToolEnabled.ts

@@ -14,7 +14,7 @@ const { Active, Passive, Enabled } = ToolModes;
  * @returns A filtered array of viewports.
  */
 export default function filterViewportsWithToolEnabled(
-  viewports: Array<Types.IStackViewport | Types.IVolumeViewport>,
+  viewports: Array<Types.IViewport>,
   toolName: string
 ): Array<Types.IStackViewport | Types.IVolumeViewport> {
   const numViewports = viewports.length;