@cornerstonejs/core 1.25.0 → 1.26.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/core",
-  "version": "1.25.0",
+  "version": "1.26.1",
   "description": "",
   "main": "src/index.ts",
   "types": "dist/esm/index.d.ts",
@@ -46,5 +46,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "d3a8801264dd9284a1839aa74ec4d3685240e163"
+  "gitHead": "ae311e637fc7751c06e14c71d704d58ce572a7d4"
 }

package/src/RenderingEngine/BaseVolumeViewport.ts

@@ -31,7 +31,6 @@ import type {
   Point2,
   Point3,
   VOIRange,
-  ViewportProperties,
   VolumeViewportProperties,
 } from '../types';
 import { VoiModifiedEventDetail } from '../types/EventTypes';
@@ -79,7 +78,7 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
     VolumeViewportProperties
   >();
 
-  private viewportProperties: VolumeViewportProperties = {};
+  protected viewportProperties: VolumeViewportProperties = {};
 
   constructor(props: ViewportInput) {
     super(props);
@@ -606,9 +605,7 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
 
     if (properties.slabThickness !== undefined) {
       this.setSlabThickness(properties.slabThickness);
-      //We need to set the current slabthickness here since setSlabThickness is define in VolumeViewport
-      // this.currentViewportProperties.get(volumeId).slabThickness =
-      //   properties.slabThickness;
+      //We need to set the current slabThickness here since setSlabThickness is define in VolumeViewport
       this.viewportProperties.slabThickness = properties.slabThickness;
     }
 

package/src/RenderingEngine/RenderingEngine.ts

@@ -11,8 +11,13 @@ import viewportTypeUsesCustomRenderingPipeline from './helpers/viewportTypeUsesC
 import getOrCreateCanvas from './helpers/getOrCreateCanvas';
 import { getShouldUseCPURendering, isCornerstoneInitialized } from '../init';
 import type IStackViewport from '../types/IStackViewport';
+import type IVideoViewport from '../types/IVideoViewport';
 import type IRenderingEngine from '../types/IRenderingEngine';
 import type IVolumeViewport from '../types/IVolumeViewport';
+import type { IViewport } from '../types/IViewport';
+import VideoViewport from './VideoViewport';
+import viewportTypeToViewportClass from './helpers/viewportTypeToViewportClass';
+
 import type * as EventTypes from '../types/EventTypes';
 import type {
   ViewportInput,
@@ -20,7 +25,7 @@ import type {
   InternalViewportInput,
   NormalizedViewportInput,
 } from '../types/IViewport';
-import { OrientationAxis, ViewportStatus } from '../enums';
+import { OrientationAxis } from '../enums';
 import VolumeViewport3D from './VolumeViewport3D';
 
 type ViewportDisplayCoords = {
@@ -73,7 +78,7 @@ class RenderingEngine implements IRenderingEngine {
   public hasBeenDestroyed: boolean;
   public offscreenMultiRenderWindow: any;
   readonly offScreenCanvasContainer: any; // WebGL
-  private _viewports: Map<string, IStackViewport | IVolumeViewport>;
+  private _viewports: Map<string, IViewport>;
   private _needsRender: Set<string> = new Set();
   private _animationFrameSet = false;
   private _animationFrameHandle: number | null = null;
@@ -346,7 +351,7 @@ class RenderingEngine implements IRenderingEngine {
    *
    * @returns viewport
    */
-  public getViewport(viewportId: string): IStackViewport | IVolumeViewport {
+  public getViewport(viewportId: string): IViewport {
     return this._viewports.get(viewportId);
   }
 
@@ -355,7 +360,7 @@ class RenderingEngine implements IRenderingEngine {
    *
    * @returns Array of viewports
    */
-  public getViewports(): Array<IStackViewport | IVolumeViewport> {
+  public getViewports(): Array<IViewport> {
     this._throwIfDestroyed();
 
     return this._getViewportsAsArray();
@@ -371,12 +376,30 @@ class RenderingEngine implements IRenderingEngine {
     const viewports = this.getViewports();
 
     const isStackViewport = (
-      viewport: IStackViewport | IVolumeViewport
+      viewport: IViewport
     ): viewport is StackViewport => {
       return viewport instanceof StackViewport;
     };
 
-    return viewports.filter(isStackViewport);
+    return viewports.filter(isStackViewport) as Array<IStackViewport>;
+  }
+
+  /**
+   * Filters all the available viewports and return the stack viewports
+   * @returns stack viewports registered on the rendering Engine
+   */
+  public getVideoViewports(): Array<IVideoViewport> {
+    this._throwIfDestroyed();
+
+    const viewports = this.getViewports();
+
+    const isVideoViewport = (
+      viewport: IViewport
+    ): viewport is VideoViewport => {
+      return viewport instanceof VideoViewport;
+    };
+
+    return viewports.filter(isVideoViewport) as Array<IVideoViewport>;
   }
 
   /**
@@ -389,7 +412,7 @@ class RenderingEngine implements IRenderingEngine {
     const viewports = this.getViewports();
 
     const isVolumeViewport = (
-      viewport: IStackViewport | IVolumeViewport
+      viewport: IViewport
     ): viewport is BaseVolumeViewport => {
       return viewport instanceof BaseVolumeViewport;
     };
@@ -822,15 +845,9 @@ class RenderingEngine implements IRenderingEngine {
     };
 
     // 4. Create a proper viewport based on the type of the viewport
+    const ViewportType = viewportTypeToViewportClass[type];
 
-    if (type !== ViewportType.STACK) {
-      // In the future these will need to be pluggable, but we aren't there yet
-      // and these are just Stacks for now.
-      throw new Error('Support for fully custom viewports not yet implemented');
-    }
-
-    // 4.a Create stack viewport
-    const viewport = new StackViewport(viewportInput);
+    const viewport = new ViewportType(viewportInput);
 
     // 5. Storing the viewports
     this._viewports.set(viewportId, viewport);
@@ -961,7 +978,7 @@ class RenderingEngine implements IRenderingEngine {
    * @returns _xOffset the final offset which will be used for the next viewport
    */
   private _resize(
-    viewportsDrivenByVtkJs: Array<IStackViewport | IVolumeViewport>,
+    viewportsDrivenByVtkJs: Array<IViewport>,
     offScreenCanvasWidth: number,
     offScreenCanvasHeight: number
   ): number {
@@ -1018,7 +1035,7 @@ class RenderingEngine implements IRenderingEngine {
    * @param _xOffset - xOffSet to draw
    */
   private _getViewportCoordsOnOffScreenCanvas(
-    viewport: InternalViewportInput | IStackViewport | IVolumeViewport,
+    viewport: InternalViewportInput | IViewport,
     offScreenCanvasWidth: number,
     offScreenCanvasHeight: number,
     _xOffset: number
@@ -1177,7 +1194,7 @@ class RenderingEngine implements IRenderingEngine {
    * @param viewport - The viewport to render
    */
   private renderViewportUsingCustomOrVtkPipeline(
-    viewport: IStackViewport | IVolumeViewport
+    viewport: IViewport
   ): EventTypes.ImageRenderedEventDetail[] {
     let eventDetail;
 
@@ -1187,7 +1204,7 @@ class RenderingEngine implements IRenderingEngine {
       viewport.sWidth < VIEWPORT_MIN_SIZE ||
       viewport.sHeight < VIEWPORT_MIN_SIZE
     ) {
-      console.log('Viewport is too small', viewport.sWidth, viewport.sHeight);
+      console.warn('Viewport is too small', viewport.sWidth, viewport.sHeight);
       return;
     }
     if (viewportTypeUsesCustomRenderingPipeline(viewport.type) === true) {
@@ -1221,7 +1238,7 @@ class RenderingEngine implements IRenderingEngine {
    * @param offScreenCanvas - The offscreen canvas to render from.
    */
   private _renderViewportFromVtkCanvasToOnscreenCanvas(
-    viewport: IStackViewport | IVolumeViewport,
+    viewport: IViewport,
     offScreenCanvas
   ): EventTypes.ImageRenderedEventDetail {
     const {
@@ -1267,7 +1284,7 @@ class RenderingEngine implements IRenderingEngine {
    *
    * @param viewport - The `Viewport` to render.
    */
-  private _resetViewport(viewport: IStackViewport | IVolumeViewport) {
+  private _resetViewport(viewport: IViewport) {
     const renderingEngineId = this.id;
 
     const { element, canvas, id: viewportId } = viewport;