@cornerstonejs/core 1.39.0 → 1.40.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/core",
-  "version": "1.39.0",
+  "version": "1.40.0",
   "description": "",
   "main": "src/index.ts",
   "types": "dist/types/index.d.ts",
@@ -47,5 +47,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "dfec4edcd4585f7a33884517071b77ec2c944cf6"
+  "gitHead": "28ed3eaf75ccd5cab7c7c0df0f4b09950cc42d7c"
 }

package/src/RenderingEngine/BaseVolumeViewport.ts

@@ -3,6 +3,8 @@ import vtkColorTransferFunction from '@kitware/vtk.js/Rendering/Core/ColorTransf
 import vtkColorMaps from '@kitware/vtk.js/Rendering/Core/ColorTransferFunction/ColorMaps';
 import vtkPiecewiseFunction from '@kitware/vtk.js/Common/DataModel/PiecewiseFunction';
 
+import { vec3 } from 'gl-matrix';
+
 import cache from '../cache';
 import {
   MPR_CAMERA_VALUES,
@@ -31,7 +33,9 @@ import type {
   Point2,
   Point3,
   VOIRange,
+  EventTypes,
   VolumeViewportProperties,
+  ICamera,
 } from '../types';
 import { VoiModifiedEventDetail } from '../types/EventTypes';
 import type { ViewportInput } from '../types/IViewport';
@@ -77,7 +81,8 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
     string,
     VolumeViewportProperties
   >();
-
+  // Camera properties
+  private initialViewUp: Point3;
   protected viewportProperties: VolumeViewportProperties = {};
 
   constructor(props: ViewportInput) {
@@ -95,6 +100,16 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
     const renderer = this.getRenderer();
 
     const camera = vtkSlabCamera.newInstance();
+
+    this.initialViewUp = <Point3>[0, -1, 0];
+    const viewPlaneNormal = <Point3>[0, 0, -1];
+
+    camera.setDirectionOfProjection(
+      -viewPlaneNormal[0],
+      -viewPlaneNormal[1],
+      -viewPlaneNormal[2]
+    );
+    camera.setViewUp(...this.initialViewUp);
     renderer.setActiveCamera(camera);
 
     switch (this.type) {
@@ -471,6 +486,33 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
     this.viewportProperties.voiRange = voiRangeToUse;
   }
 
+  private setRotation(rotation: number): void {
+    const previousCamera = this.getCamera();
+
+    this.rotateCamera(rotation);
+
+    // New camera after rotation
+    const camera = this.getCamera();
+
+    const eventDetail: EventTypes.CameraModifiedEventDetail = {
+      previousCamera,
+      camera,
+      element: this.element,
+      viewportId: this.id,
+      renderingEngineId: this.renderingEngineId,
+      rotation,
+    };
+
+    triggerEvent(this.element, Events.CAMERA_MODIFIED, eventDetail);
+    this.viewportProperties.rotation = rotation;
+  }
+
+  private rotateCamera(rotation: number): void {
+    const rotationToApply = rotation - this.getRotation();
+    // rotating camera to the new value
+    this.getVtkActiveCamera().roll(-rotationToApply);
+  }
+
   /**
    * Update the default properties for the volume viewport on the volume
    * @param ViewportProperties - The properties to set
@@ -525,6 +567,7 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
       preset,
       interpolationType,
       slabThickness,
+      rotation,
     }: VolumeViewportProperties = {},
     volumeId?: string,
     suppressEvents = false
@@ -538,6 +581,7 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
         colormap,
         preset,
         slabThickness,
+        rotation,
       });
     }
 
@@ -576,6 +620,10 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
       //We need to set the current slab thickness here since setSlabThickness is define in VolumeViewport
       this.viewportProperties.slabThickness = slabThickness;
     }
+
+    if (rotation !== undefined) {
+      this.setRotation(rotation);
+    }
   }
 
   /**
@@ -609,6 +657,10 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
       this.viewportProperties.slabThickness = properties.slabThickness;
     }
 
+    if (properties.rotation !== undefined) {
+      this.setRotation(properties.rotation);
+    }
+
     this.render();
   }
 
@@ -683,6 +735,7 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
       interpolationType,
       invert,
       slabThickness,
+      rotation,
     } = this.viewportProperties;
 
     const voiRanges = this.getActors()
@@ -711,6 +764,7 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
       interpolationType: interpolationType,
       invert: invert,
       slabThickness: slabThickness,
+      rotation: rotation,
     };
   };
 
@@ -937,6 +991,49 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
     return true;
   }
 
+  /**
+   * Gets the rotation resulting from the value set in setRotation AND taking into
+   * account any flips that occurred subsequently from the camera provided or the viewport.
+   *
+   * @returns the rotation resulting from the value set in setRotation AND taking into
+   * account any flips that occurred subsequently.
+   */
+  public getRotation = (): number => {
+    const {
+      viewUp: currentViewUp,
+      viewPlaneNormal,
+      flipVertical,
+    } = this.getCamera();
+
+    // The initial view up vector without any rotation, but incorporating vertical flip.
+    const initialViewUp = flipVertical
+      ? vec3.negate(vec3.create(), this.initialViewUp)
+      : this.initialViewUp;
+
+    // The angle between the initial and current view up vectors.
+    // TODO: check with VTK about rounding errors here.
+    const initialToCurrentViewUpAngle =
+      (vec3.angle(initialViewUp, currentViewUp) * 180) / Math.PI;
+
+    // Now determine if initialToCurrentViewUpAngle is positive or negative by comparing
+    // the direction of the initial/current view up cross product with the current
+    // viewPlaneNormal.
+
+    const initialToCurrentViewUpCross = vec3.cross(
+      vec3.create(),
+      initialViewUp,
+      currentViewUp
+    );
+
+    // The sign of the dot product of the start/end view up cross product and
+    // the viewPlaneNormal indicates a positive or negative rotation respectively.
+    const normalDot = vec3.dot(initialToCurrentViewUpCross, viewPlaneNormal);
+
+    return normalDot >= 0
+      ? initialToCurrentViewUpAngle
+      : (360 - initialToCurrentViewUpAngle) % 360;
+  };
+
   /**
    * gets the visible bounds of the viewport in the world coordinate system
    */
@@ -1209,6 +1306,7 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
       typeof orientation === 'string' &&
       MPR_CAMERA_VALUES[orientation]
     ) {
+      this.viewportProperties.orientation = orientation;
       return MPR_CAMERA_VALUES[orientation];
     } else {
       throw new Error(

package/src/RenderingEngine/Viewport.ts

@@ -18,7 +18,7 @@ import {
   isEqual,
 } from '../utilities';
 import hasNaNValues from '../utilities/hasNaNValues';
-import { EPSILON, RENDERING_DEFAULTS } from '../constants';
+import { RENDERING_DEFAULTS } from '../constants';
 import type {
   ICamera,
   ActorEntry,
@@ -1190,7 +1190,11 @@ class Viewport implements IViewport {
     updatedCamera: ICamera
   ): Promise<void> {
     const actorEntries = this.getActors();
-    const allPromises = actorEntries.map(async (actorEntry) => {
+    // Todo: this was using an async and promise wait all because of the
+    // new surface rendering use case, which broke the more important 3D
+    // volume rendering, so reverting this back for now until I can figure
+    // out a better way to handle this.
+    actorEntries.map((actorEntry) => {
       // we assume that the first two clipping plane of the mapper are always
       // the 'camera' clipping. Update clipping planes only if the actor is
       // a vtkVolume
@@ -1228,7 +1232,6 @@ class Viewport implements IViewport {
       });
     });
 
-    await Promise.all(allPromises);
     this.posProcessNewActors();
   }
 

package/src/RenderingEngine/VolumeViewport.ts

@@ -42,7 +42,6 @@ class VolumeViewport extends BaseVolumeViewport {
     super(props);
 
     const { orientation } = this.options;
-
     // if the camera is set to be acquisition axis then we need to skip
     // it for now until the volume is set
     if (orientation && orientation !== OrientationAxis.ACQUISITION) {
@@ -144,6 +143,7 @@ class VolumeViewport extends BaseVolumeViewport {
       viewUp,
     });
 
+    this.viewportProperties.orientation = orientation;
     this.resetCamera();
 
     if (immediate) {
@@ -231,7 +231,8 @@ class VolumeViewport extends BaseVolumeViewport {
   public resetCamera(
     resetPan = true,
     resetZoom = true,
-    resetToCenter = true
+    resetToCenter = true,
+    resetRotation = false
   ): boolean {
     super.resetCamera(resetPan, resetZoom, resetToCenter);
 
@@ -239,6 +240,7 @@ class VolumeViewport extends BaseVolumeViewport {
 
     const activeCamera = this.getVtkActiveCamera();
     const viewPlaneNormal = <Point3>activeCamera.getViewPlaneNormal();
+    const viewUp = <Point3>activeCamera.getViewUp();
     const focalPoint = <Point3>activeCamera.getFocalPoint();
 
     // always add clipping planes for the volume viewport. If a use case
@@ -274,6 +276,19 @@ class VolumeViewport extends BaseVolumeViewport {
       }
     });
 
+    //Only reset the rotation of the camera if wanted (so we don't reset everytime resetCamera is called) and also verify that the viewport has an orientation that we know (sagittal, coronal, axial)
+    if (
+      resetRotation &&
+      MPR_CAMERA_VALUES[this.viewportProperties.orientation] !== undefined
+    ) {
+      const viewToReset =
+        MPR_CAMERA_VALUES[this.viewportProperties.orientation];
+      this.setCameraNoEvent({
+        viewUp: viewToReset.viewUp,
+        viewPlaneNormal: viewToReset.viewPlaneNormal,
+      });
+    }
+
     return true;
   }
 
@@ -370,8 +385,6 @@ class VolumeViewport extends BaseVolumeViewport {
     return getClosestImageId(volume, focalPoint, viewPlaneNormal);
   };
 
-  getRotation = (): number => 0;
-
   /**
    * Reset the viewport properties to the default values
    *
@@ -433,6 +446,12 @@ class VolumeViewport extends BaseVolumeViewport {
       volumeId: volumeActor.uid,
     };
 
+    const resetPan = true;
+    const resetZoom = true;
+    const resetToCenter = true;
+    const resetCameraRotation = true;
+    this.resetCamera(resetPan, resetZoom, resetToCenter, resetCameraRotation);
+
     triggerEvent(this.element, Events.VOI_MODIFIED, eventDetails);
   }
 }

package/src/types/IViewport.ts

@@ -42,7 +42,7 @@ interface IViewport {
   isDisabled: boolean;
   /** The rendering state of this viewport */
   viewportStatus: ViewportStatus;
-  /** the rotation applied to the view */
+  /** get the rotation either from the camera provided or the viewport if not provided */
   getRotation: () => number;
   /** frameOfReferenceUID the viewport's default actor is rendering */
   getFrameOfReferenceUID: () => string;

package/src/types/IVolumeViewport.ts

@@ -136,7 +136,8 @@ export default interface IVolumeViewport extends IViewport {
   resetCamera(
     resetPan?: boolean,
     resetZoom?: boolean,
-    resetToCenter?: boolean
+    resetToCenter?: boolean,
+    resetRotation?: boolean
   ): boolean;
   /**
    * Sets the blendMode for actors of the viewport.

package/src/types/ViewportProperties.ts

@@ -16,6 +16,8 @@ type ViewportProperties = {
   colormap?: ColormapPublic;
   /** interpolation type */
   interpolationType?: InterpolationType;
+  /**Rotation of the camera */
+  rotation?: number;
 };
 
 export type { ViewportProperties };

package/src/types/VolumeViewportProperties.ts

@@ -1,4 +1,5 @@
 import { ViewportProperties } from './ViewportProperties';
+import { OrientationAxis } from '../enums';
 
 /**
  * Stack Viewport Properties
@@ -8,6 +9,8 @@ type VolumeViewportProperties = ViewportProperties & {
   preset?: string;
 
   slabThickness?: number;
+
+  orientation?: OrientationAxis;
 };
 
 export default VolumeViewportProperties;