@cornerstonejs/core 1.24.0 → 1.26.0

package/src/enums/VideoViewport.ts

@@ -0,0 +1,9 @@
+/**
+ * video viewport speed units
+ */
+enum SpeedUnit {
+  FRAME = 'f',
+  SECOND = 's',
+}
+
+export { SpeedUnit };

package/src/enums/ViewportType.ts

@@ -16,6 +16,7 @@ enum ViewportType {
   /** Perspective Viewport: Not Implemented yet */
   PERSPECTIVE = 'perspective',
   VOLUME_3D = 'volume3d',
+  VIDEO = 'video',
 }
 
 export default ViewportType;

package/src/enums/index.ts

@@ -11,6 +11,7 @@ import VOILUTFunctionType from './VOILUTFunctionType';
 import DynamicOperatorType from './DynamicOperatorType';
 import CalibrationTypes from './CalibrationTypes';
 import ViewportStatus from './ViewportStatus';
+import * as VideoViewport from './VideoViewport';
 
 export {
   Events,
@@ -26,4 +27,5 @@ export {
   VOILUTFunctionType,
   DynamicOperatorType,
   ViewportStatus,
+  VideoViewport,
 };

package/src/getEnabledElement.ts

@@ -1,7 +1,7 @@
 import getRenderingEngine, {
   getRenderingEngines,
 } from './RenderingEngine/getRenderingEngine';
-import { IEnabledElement } from './types';
+import { IEnabledElement, IStackViewport, IVolumeViewport } from './types';
 
 /**
  * A convenience method to find an EnabledElement given a reference to its
@@ -67,7 +67,9 @@ export function getEnabledElementByIds(
     return;
   }
 
-  const viewport = renderingEngine.getViewport(viewportId);
+  const viewport = renderingEngine.getViewport(viewportId) as
+    | IStackViewport
+    | IVolumeViewport;
 
   if (!viewport) {
     return;

package/src/index.ts

@@ -12,6 +12,7 @@ import VolumeViewport from './RenderingEngine/VolumeViewport';
 import VolumeViewport3D from './RenderingEngine/VolumeViewport3D';
 import BaseVolumeViewport from './RenderingEngine/BaseVolumeViewport';
 import StackViewport from './RenderingEngine/StackViewport';
+import VideoViewport from './RenderingEngine/VideoViewport';
 import Viewport from './RenderingEngine/Viewport';
 import eventTarget from './eventTarget';
 import {
@@ -80,6 +81,7 @@ export {
   VolumeViewport3D,
   Viewport,
   StackViewport,
+  VideoViewport,
   RenderingEngine,
   ImageVolume,
   // Helpers

package/src/types/IEnabledElement.ts

@@ -6,7 +6,10 @@ import type IVolumeViewport from './IVolumeViewport';
  * Cornerstone Enabled Element interface
  */
 interface IEnabledElement {
-  /** Cornerstone Viewport instance - can be Stack or Volume Viewport as of now */
+  /** Cornerstone Viewport instance - can be Stack or Volume, or Video Viewport as of now.
+   * For the moment, need to cast to unknown first before casting to IVideoViewport
+   * (TODO) - this will be done as part of adding annotation tools for video
+   */
   viewport: IStackViewport | IVolumeViewport;
   /** Cornerstone Rendering Engine instance */
   renderingEngine: IRenderingEngine;

package/src/types/IRenderingEngine.ts

@@ -1,6 +1,8 @@
 import IStackViewport from './IStackViewport';
 import { PublicViewportInput } from './IViewport';
 import IVolumeViewport from './IVolumeViewport';
+import { IViewport } from './IViewport';
+import IVideoViewport from './IVideoViewport';
 
 export default interface IRenderingEngine {
   id: string;
@@ -9,8 +11,8 @@ export default interface IRenderingEngine {
   offScreenCanvasContainer: any;
   setViewports(viewports: Array<PublicViewportInput>): void;
   resize(immediate?: boolean, keepCamera?: boolean): void;
-  getViewport(id: string): IStackViewport | IVolumeViewport;
-  getViewports(): Array<IStackViewport | IVolumeViewport>;
+  getViewport(id: string): IViewport;
+  getViewports(): Array<IViewport>;
   render(): void;
   renderViewports(viewportIds: Array<string>): void;
   renderViewport(viewportId: string): void;
@@ -23,6 +25,7 @@ export default interface IRenderingEngine {
   disableElement(viewportId: string): void;
   getStackViewports(): Array<IStackViewport>;
   getVolumeViewports(): Array<IVolumeViewport>;
+  getVideoViewports(): Array<IVideoViewport>;
   destroy(): void;
   _debugRender(): void;
 }

package/src/types/IVideoViewport.ts

@@ -0,0 +1,35 @@
+import { IViewport } from './IViewport';
+import VideoViewportProperties from './VideoViewportProperties';
+
+/**
+ * Interface for Stack Viewport
+ */
+export default interface IVideoViewport extends IViewport {
+  /**
+   * Resizes the viewport - only used in CPU fallback for StackViewport. The
+   * GPU resizing happens inside the RenderingEngine.
+   */
+  resize: () => void;
+  /**
+   * Sets the properties for the viewport on the default actor.
+   */
+  setProperties(props: VideoViewportProperties, suppressEvents?: boolean): void;
+  /**
+   * Retrieve the viewport properties
+   */
+  getProperties: () => VideoViewportProperties;
+
+  setVideoURL: (url: string) => void;
+
+  play: () => void;
+
+  pause: () => void;
+  /**
+   * Reset the viewport properties to the default values
+   */
+  resetProperties(): void;
+  /**
+   * Centers Pan and resets the zoom for stack viewport.
+   */
+  resetCamera(resetPan?: boolean, resetZoom?: boolean): boolean;
+}

package/src/types/VideoViewportProperties.ts

@@ -0,0 +1,17 @@
+import { ViewportProperties } from './ViewportProperties';
+import Point2 from './Point2';
+
+/**
+ * Stack Viewport Properties
+ */
+type VideoViewportProperties = ViewportProperties & {
+  loop?: boolean;
+  muted?: boolean;
+  pan?: Point2;
+  playbackRate?: number;
+  // The zoom factor, naming consistent with vtk cameras for now,
+  // but this isn't necessarily necessary.
+  parallelScale?: number;
+};
+
+export default VideoViewportProperties;

package/src/types/VideoViewportTypes.ts

@@ -0,0 +1,20 @@
+import { ViewportType } from '../enums';
+import Point2 from './Point2';
+
+export type InternalVideoCamera = {
+  panWorld?: Point2;
+  parallelScale?: number;
+};
+
+export type VideoViewportInput = {
+  id: string;
+  renderingEngineId: string;
+  type: ViewportType;
+  element: HTMLDivElement;
+  sx: number;
+  sy: number;
+  sWidth: number;
+  sHeight: number;
+  defaultOptions: any;
+  canvas: HTMLCanvasElement;
+};

package/src/types/index.ts

@@ -83,6 +83,12 @@ import type { PixelDataTypedArray } from './PixelDataTypedArray';
 import type { ImagePixelModule } from './ImagePixelModule';
 import type { ImagePlaneModule } from './ImagePlaneModule';
 import type { AffineMatrix } from './AffineMatrix';
+import type VideoViewportProperties from './VideoViewportProperties';
+import type IVideoViewport from './IVideoViewport';
+import type {
+  InternalVideoCamera,
+  VideoViewportInput,
+} from './VideoViewportTypes';
 
 export type {
   // config
@@ -90,6 +96,7 @@ export type {
   //
   ICamera,
   IStackViewport,
+  IVideoViewport,
   IVolumeViewport,
   IEnabledElement,
   ICache,
@@ -136,6 +143,7 @@ export type {
   Mat3,
   Plane,
   ViewportInputOptions,
+  VideoViewportProperties,
   VOIRange,
   VOI,
   DisplayArea,
@@ -180,4 +188,7 @@ export type {
   ImagePixelModule,
   ImagePlaneModule,
   AffineMatrix,
+  // video
+  InternalVideoCamera,
+  VideoViewportInput,
 };