@cornerstonejs/core 2.0.0-beta.10 → 2.0.0-beta.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/core",
-  "version": "2.0.0-beta.10",
+  "version": "2.0.0-beta.12",
   "description": "",
   "main": "src/index.ts",
   "types": "dist/types/index.d.ts",
@@ -52,5 +52,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "134ced7eda99db84aaeb01fe15327b9607110b25"
+  "gitHead": "b93fb8a56218822f744f1f2b702c8c2fc3f19f75"
 }

package/src/RenderingEngine/BaseVolumeViewport.ts

@@ -37,7 +37,6 @@ import type {
   VolumeViewportProperties,
   ViewReferenceSpecifier,
   ReferenceCompatibleOptions,
-  ViewPresentation,
   ViewReference,
   IVolumeViewport,
 } from '../types';
@@ -553,11 +552,9 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
       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 {
@@ -801,7 +798,6 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
       preset,
       interpolationType,
       slabThickness,
-      rotation,
     }: VolumeViewportProperties = {},
     volumeId?: string,
     suppressEvents = false
@@ -815,7 +811,6 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
         colormap,
         preset,
         slabThickness,
-        rotation,
       });
     }
 
@@ -854,10 +849,6 @@ 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);
-    }
   }
 
   /**
@@ -891,10 +882,6 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
       this.viewportProperties.slabThickness = properties.slabThickness;
     }
 
-    if (properties.rotation !== undefined) {
-      this.setRotation(properties.rotation);
-    }
-
     this.render();
   }
 
@@ -969,7 +956,7 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
   /**
    * Retrieve the viewport properties
    * @param volumeId - The volume id to get the properties for (if undefined, the first volume)
-   * @returns viewport properties including voi, interpolation type: TODO: slabThickness, invert, rotation, flip
+   * @returns viewport properties including voi, interpolation type: TODO: slabThickness, invert
    */
   public getProperties = (volumeId?: string): VolumeViewportProperties => {
     const applicableVolumeActorInfo = this._getApplicableVolumeActor(volumeId);
@@ -983,7 +970,6 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
       interpolationType,
       invert,
       slabThickness,
-      rotation,
       preset,
     } = this.viewportProperties;
 
@@ -1020,7 +1006,6 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
       interpolationType: interpolationType,
       invert: invert,
       slabThickness: slabThickness,
-      rotation: rotation,
       preset,
     };
   };
@@ -1110,7 +1095,7 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
         uid,
         actor,
         slabThickness,
-        referenceId: volumeId,
+        referencedId: volumeId,
       });
     }
 
@@ -1183,11 +1168,11 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
         actor,
         slabThickness,
         // although the actor UID is defined, we need to use the volumeId for the
-        // referenceId, since the actor UID is used to reference the actor in the
+        // referencedId, since the actor UID is used to reference the actor in the
         // viewport, however, the actor is created from its volumeId
         // and if later we need to grab the referenced volume from cache,
-        // we can use the referenceId to get the volume from the cache
-        referenceId: volumeId,
+        // we can use the referencedId to get the volume from the cache
+        referencedId: volumeId,
       });
     }
 
@@ -1319,7 +1304,7 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
       viewUp: currentViewUp,
       viewPlaneNormal,
       flipVertical,
-    } = this.getCamera();
+    } = this.getCameraNoRotation();
 
     // The initial view up vector without any rotation, but incorporating vertical flip.
     const initialViewUp = flipVertical

package/src/RenderingEngine/RenderingEngine.ts

@@ -630,14 +630,14 @@ class RenderingEngine implements IRenderingEngine {
       const resetZoom = true;
       const resetToCenter = true;
       const resetRotation = false;
-      const supressEvents = true;
-      vp.resetCamera(
+      const suppressEvents = true;
+      vp.resetCamera({
         resetPan,
         resetZoom,
         resetToCenter,
         resetRotation,
-        supressEvents
-      );
+        suppressEvents,
+      });
 
       const displayArea = vp.getDisplayArea();
 
@@ -649,7 +649,7 @@ class RenderingEngine implements IRenderingEngine {
             vp.setCamera({ flipHorizontal });
           }
           if (rotation) {
-            vp.setProperties({ rotation });
+            vp.setViewPresentation({ rotation });
           }
         } else {
           vp.setCamera(prevCamera);
@@ -872,7 +872,7 @@ class RenderingEngine implements IRenderingEngine {
     const viewport = new ViewportType(viewportInput);
 
     // 5. Storing the viewports
-    this._viewports.set(viewportId, viewport);
+    this._viewports.set(viewportId, viewport as IViewport);
 
     const eventDetail: EventTypes.ElementEnabledEventDetail = {
       element,

package/src/RenderingEngine/StackViewport.ts

@@ -9,7 +9,6 @@ import vtkImageSlice from '@kitware/vtk.js/Rendering/Core/ImageSlice';
 import { mat4, vec2, vec3 } from 'gl-matrix';
 import eventTarget from '../eventTarget';
 import * as metaData from '../metaData';
-import cloneDeep from 'lodash.clonedeep';
 import type {
   ActorEntry,
   CPUFallbackColormapData,
@@ -313,7 +312,7 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
   /**
    * Centers Pan and resets the zoom for stack viewport.
    */
-  public resetCamera: (resetPan?: boolean, resetZoom?: boolean) => boolean;
+  public resetCamera: (options?) => boolean;
 
   /**
    * canvasToWorld Returns the world coordinates of the given `canvasPos`
@@ -703,7 +702,6 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
       VOILUTFunction,
       invert,
       interpolationType,
-      rotation,
     }: StackViewportProperties = {},
     suppressEvents = false
   ): void {
@@ -718,7 +716,6 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
         VOILUTFunction,
         invert,
         interpolationType,
-        rotation,
       });
     }
 
@@ -743,20 +740,13 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
     if (typeof interpolationType !== 'undefined') {
       this.setInterpolationType(interpolationType);
     }
-
-    if (typeof rotation !== 'undefined') {
-      // TODO: check with VTK about rounding errors here.
-      if (this.getRotation() !== rotation) {
-        this.setRotation(rotation);
-      }
-    }
   }
 
   /**
    * Retrieve the viewport default properties
    * @param imageId If given, we retrieve the default properties of an image index if it exists
    * If not given,we return the global properties of the viewport
-   * @returns viewport properties including voi, invert, interpolation type, rotation, flip
+   * @returns viewport properties including voi, invert, interpolation type,
    */
   public getDefaultProperties = (imageId?: string): StackViewportProperties => {
     let imageProperties;
@@ -770,13 +760,12 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
 
     return {
       ...this.globalDefaultProperties,
-      rotation: this.getRotation(),
     };
   };
 
   /**
    * Retrieve the viewport properties
-   * @returns viewport properties including voi, invert, interpolation type, rotation, flip
+   * @returns viewport properties including voi, invert, interpolation type,
    */
   public getProperties = (): StackViewportProperties => {
     const {
@@ -787,7 +776,6 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
       invert,
       voiUpdatedWithSetProperties,
     } = this;
-    const rotation = this.getRotation();
 
     return {
       colormap,
@@ -795,7 +783,6 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
       VOILUTFunction,
       interpolationType,
       invert,
-      rotation,
       isComputedVOI: !voiUpdatedWithSetProperties,
     };
   };
@@ -838,10 +825,6 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
 
     this.setInterpolationType(InterpolationType.LINEAR);
 
-    if (this.getRotation() !== 0) {
-      this.setRotation(0);
-    }
-
     const transferFunction = this.getTransferFunction();
     setTransferFunctionNodes(
       transferFunction,
@@ -892,9 +875,6 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
 
     this.setVOI(voiRange);
 
-    if (this.getRotation() !== 0) {
-      this.setRotation(0);
-    }
     this.setInterpolationType(InterpolationType.LINEAR);
     this.setInvertColor(false);
 
@@ -1055,7 +1035,6 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
       element: this.element,
       viewportId: this.id,
       renderingEngineId: this.renderingEngineId,
-      rotation: this.getRotation(),
     };
 
     triggerEvent(this.element, Events.CAMERA_MODIFIED, eventDetail);
@@ -1119,7 +1098,7 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
       viewUp: currentViewUp,
       viewPlaneNormal,
       flipVertical,
-    } = this.getCamera();
+    } = this.getCameraNoRotation();
 
     // The initial view up vector without any rotation, but incorporating vertical flip.
     const initialViewUp = flipVertical
@@ -1170,7 +1149,6 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
       element: this.element,
       viewportId: this.id,
       renderingEngineId: this.renderingEngineId,
-      rotation,
     };
 
     triggerEvent(this.element, Events.CAMERA_MODIFIED, eventDetail);
@@ -1753,7 +1731,7 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
       currentImageIdIndex: currentImageIdIndex,
     };
 
-    triggerEvent(eventTarget, Events.STACK_VIEWPORT_NEW_STACK, eventDetail);
+    triggerEvent(this.element, Events.STACK_VIEWPORT_NEW_STACK, eventDetail);
 
     return imageId;
   }
@@ -1981,9 +1959,6 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
       const requestType = RequestType.Interaction;
       const additionalDetails = { imageId, imageIdIndex };
       const options = {
-        preScale: {
-          enabled: true,
-        },
         useRGBA: true,
         requestType,
       };
@@ -2085,9 +2060,6 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
       targetBuffer: {
         type: this.useNativeDataType ? undefined : 'Float32Array',
       },
-      preScale: {
-        enabled: true,
-      },
       useRGBA: false,
       transferSyntaxUID,
       useNativeDataType: this.useNativeDataType,
@@ -2553,7 +2525,7 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
     // For stack Viewport we since we have only one slice
     // it should be enough to reset the camera to the center of the image
     const resetToCenter = true;
-    return super.resetCamera(resetPan, resetZoom, resetToCenter);
+    return super.resetCamera({ resetPan, resetZoom, resetToCenter });
   }
 
   /**

package/src/RenderingEngine/Viewport.ts

@@ -535,7 +535,10 @@ class Viewport implements IViewport {
     actors.forEach((actor) => this.addActor(actor));
 
     // set the clipping planes for the actors
-    this.resetCamera(resetCameraPanAndZoom, resetCameraPanAndZoom);
+    this.resetCamera({
+      resetPan: resetCameraPanAndZoom,
+      resetZoom: resetCameraPanAndZoom,
+    });
   }
 
   /**
@@ -876,18 +879,22 @@ class Viewport implements IViewport {
    * resetPan and resetZoom are true it places the focal point at the center of
    * the volume (or slice); otherwise, only the camera zoom and camera Pan or Zoom
    * is reset for the current view.
-   * @param resetPan - If true, the camera focal point is reset to the center of the volume (slice)
-   * @param resetZoom - If true, the camera zoom is reset to the default zoom
-   * @param storeAsInitialCamera - If true, reset camera is stored as the initial camera (to allow differences to
+   * @param options - The reset options
+   * @param options.resetPan - If true, the camera focal point is reset to the center of the volume (slice)
+   * @param options.resetZoom - If true, the camera zoom is reset to the default zoom
+   * @param options.resetToCenter - If true, the camera is reset to the center of the volume (slice)
+   * @param options.storeAsInitialCamera - If true, reset camera is stored as the initial camera (to allow differences to
    *   be detected for pan/zoom values)
    * @returns boolean
    */
-  public resetCamera(
-    resetPan = true,
-    resetZoom = true,
-    resetToCenter = true,
-    storeAsInitialCamera = true
-  ): boolean {
+  public resetCamera(options?): boolean {
+    const {
+      resetPan = true,
+      resetZoom = true,
+      resetToCenter = true,
+      storeAsInitialCamera = true,
+    } = options || {};
+
     const renderer = this.getRenderer();
 
     // fix the flip right away, since we rely on the viewPlaneNormal and
@@ -1237,11 +1244,7 @@ class Viewport implements IViewport {
     return renderer.getActiveCamera();
   }
 
-  /**
-   * Get the camera's current state
-   * @returns The camera object.
-   */
-  public getCamera(): ICamera {
+  protected getCameraNoRotation(): ICamera {
     const vtkCamera = this.getVtkActiveCamera();
 
     return {
@@ -1257,6 +1260,19 @@ class Viewport implements IViewport {
     };
   }
 
+  /**
+   * Get the camera's current state
+   * @returns The camera object.
+   */
+  public getCamera(): ICamera {
+    const camera = this.getCameraNoRotation();
+
+    return {
+      ...camera,
+      rotation: this.getRotation(),
+    };
+  }
+
   /**
    * Set the camera parameters
    * @param cameraInterface - ICamera
@@ -1415,7 +1431,6 @@ class Viewport implements IViewport {
         element: this.element,
         viewportId: this.id,
         renderingEngineId: this.renderingEngineId,
-        rotation: this.getRotation(),
       };
 
       triggerEvent(this.element, Events.CAMERA_MODIFIED, eventDetail);

package/src/RenderingEngine/VolumeViewport.ts

@@ -242,18 +242,19 @@ class VolumeViewport extends BaseVolumeViewport {
   /**
    * Reset the camera for the volume viewport
    */
-  public resetCamera(
-    resetPan = true,
-    resetZoom = true,
-    resetToCenter = true,
-    resetRotation = false,
-    supressEvents = false
-  ): boolean {
+  public resetCamera(options?): boolean {
+    const {
+      resetPan = true,
+      resetZoom = true,
+      resetRotation = true,
+      resetToCenter = true,
+      suppressEvents = false,
+    } = options || {};
     const { orientation } = this.viewportProperties;
     if (orientation) {
       this.applyViewOrientation(orientation, false);
     }
-    super.resetCamera(resetPan, resetZoom, resetToCenter);
+    super.resetCamera({ resetPan, resetZoom, resetToCenter });
 
     this.resetVolumeViewportClippingRange();
 
@@ -294,7 +295,7 @@ 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)
+    //Only reset the rotation of the camera if wanted (so we don't reset every time 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
@@ -307,7 +308,7 @@ class VolumeViewport extends BaseVolumeViewport {
       });
     }
 
-    if (!supressEvents) {
+    if (!suppressEvents) {
       const eventDetail: EventTypes.CameraResetEventDetail = {
         viewportId: this.id,
         camera: this.getCamera(),
@@ -530,7 +531,12 @@ class VolumeViewport extends BaseVolumeViewport {
     const resetZoom = true;
     const resetToCenter = true;
     const resetCameraRotation = true;
-    this.resetCamera(resetPan, resetZoom, resetToCenter, resetCameraRotation);
+    this.resetCamera({
+      resetPan,
+      resetZoom,
+      resetToCenter,
+      resetCameraRotation,
+    });
 
     triggerEvent(this.element, Events.VOI_MODIFIED, eventDetails);
   }

package/src/RenderingEngine/VolumeViewport3D.ts

@@ -31,7 +31,7 @@ class VolumeViewport3D extends BaseVolumeViewport {
     resetZoom = true,
     resetToCenter = true
   ): boolean {
-    super.resetCamera(resetPan, resetZoom, resetToCenter);
+    super.resetCamera({ resetPan, resetZoom, resetToCenter });
     this.resetVolumeViewportClippingRange();
     return;
   }

package/src/enums/Events.ts

@@ -216,7 +216,7 @@ enum Events {
    * Triggers when the scroll function is called with a delta that is out of bounds.
    * This is usually for signaling that the user may want a different volume for partially loaded volumes which is meant to optimize memory.
    */
-  VOLUME_SCROLL_OUT_OF_BOUNDS = 'VOLUME_SCROLL_OUT_OF_BOUNDS',
+  VOLUME_VIEWPORT_SCROLL_OUT_OF_BOUNDS = 'VOLUME_VIEWPORT_SCROLL_OUT_OF_BOUNDS',
 
   /**
    * Triggers when the scroll function is called on a volume.

package/src/loaders/volumeLoader.ts

@@ -9,7 +9,6 @@ import cache from '../cache/cache';
 import Events from '../enums/Events';
 import eventTarget from '../eventTarget';
 import triggerEvent from '../utilities/triggerEvent';
-import cloneDeep from 'lodash.clonedeep';
 
 import {
   createUint16SharedArray,
@@ -242,13 +241,13 @@ export function loadVolume(
  *
  * @returns Volume Loader Object
  */
-export async function createAndCacheVolume(
+export async function createAndCacheEmptyVolume(
   volumeId: string,
   options?: VolumeLoaderOptions
 ): Promise<Record<string, any>> {
   if (volumeId === undefined) {
     throw new Error(
-      'createAndCacheVolume: parameter volumeId must not be undefined'
+      'createAndCacheEmptyVolume: parameter volumeId must not be undefined'
     );
   }
 

package/src/requestPool/imageLoadPoolManager.ts

@@ -19,9 +19,6 @@ import RequestType from '../enums/RequestType';
  *     offset: null,
  *     length: null,
  *   },
- *   preScale: {
- *     enabled: true,
- *   },
  * }
  *
  * imageLoadPoolManager.addRequest(

package/src/requestPool/requestPoolManager.ts

@@ -53,9 +53,6 @@ type RequestPool = {
  *     offset: null,
  *     length: null,
  *   },
- *   preScale: {
- *      enabled: true,
- *    },
  * }
  *
  * imageLoadPoolManager.addRequest(

package/src/types/EventTypes.ts

@@ -27,8 +27,6 @@ type CameraModifiedEventDetail = {
   viewportId: string;
   /** Unique ID for the renderingEngine */
   renderingEngineId: string;
-  /** Rotation Optional */
-  rotation?: number;
 };
 
 /**

package/src/types/IActor.ts

@@ -28,8 +28,8 @@ export type ActorEntry = {
   uid: string;
   /** actual actor object */
   actor: Actor | VolumeActor | ImageActor | ICanvasActor;
-  /** the id of the reference volume from which this actor is derived or created*/
-  referenceId?: string;
+  /** the id of the referenced object (e.g., volume) from which this actor is derived or created*/
+  referencedId?: string;
   /** slab thickness for the actor */
   slabThickness?: number;
   /** clipping filter applied to actor surfaces*/

package/src/types/ICamera.ts

@@ -25,6 +25,8 @@ interface ICamera {
   viewPlaneNormal?: Point3;
   /** Camera viewUp - the direction of viewUP in camera */
   viewUp?: Point3;
+  /** rotation  */
+  rotation?: number;
   /** flip Horizontal */
   flipHorizontal?: boolean;
   /** flip Vertical */

package/src/types/IVideoViewport.ts

@@ -1,87 +1,3 @@
-import { IViewport } from './IViewport';
-import VideoViewportProperties from './VideoViewportProperties';
+import type IVideoViewport from '../RenderingEngine/VideoViewport';
 
-/**
- * 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;
-
-  /**
-   * Sets the video to play.
-   * The video should have at least some metadata in the metadata provider,
-   * including:
-   *   * study/series/sop common module for UIDs
-   *   * `cineModule` for information on number of frames and playback rate
-   *   * `imageUrlModule` - to get the URL for the image under the `rendered` attribute
-   *
-   * Without these, other tools requiring metadata wont work, although basic
-   * playback does work if the setVideoURL is used instead.
-   */
-  setVideo: (imageIds: string, imageIdIndex?: number) => Promise<unknown>;
-
-  /**
-   * Displays a raw video, without any metadata associated with it.  Plays back,
-   * but does not permit tools to apply to the viewport, which requires providing
-   * additional metadata for the study.
-   *
-   * @param url - to display
-   */
-  setVideoURL: (url: string) => void;
-
-  play: () => void;
-
-  pause: () => void;
-
-  /**
-   * Reset the viewport properties to the default values
-   */
-  resetProperties(): void;
-
-  /**
-   * Gets the current image id, including frame selction or frameless.
-   */
-  getCurrentImageId(): string;
-
-  /**
-   * Gets the current frame, 1 based
-   */
-  getFrameNumber(): number;
-
-  /**
-   * Sets the current frame
-   */
-  setFrameNumber(frameNo: number);
-
-  /**
-   * Sets the current video time, in seconds
-   */
-  setTime(time: number);
-
-  /**
-   * Sets the range of frames for displaying.  This is the range of frames
-   * that are shown/looped over when the video is playing.
-   * Note that ability to playback a frame range depends on the server
-   * implementing byte range requests, OR the video being easily cached in memory.
-   */
-  setFrameRange(range?: [number, number]);
-
-  getFrameRange(): [number, number];
-
-  /**
-   * Centers Pan and resets the zoom for stack viewport.
-   */
-  resetCamera(resetPan?: boolean, resetZoom?: boolean): boolean;
-}
+export default IVideoViewport;