@cornerstonejs/core 1.45.1 → 1.47.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/core",
-  "version": "1.45.1",
+  "version": "1.47.0",
   "description": "",
   "main": "src/index.ts",
   "types": "dist/types/index.d.ts",
@@ -47,5 +47,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "acd22f0138a44d468688195e5f074dd6932e57ba"
+  "gitHead": "b1235a2e36cda555341dfbd164ef45e519c4efd5"
 }

package/src/RenderingEngine/BaseVolumeViewport.ts

@@ -35,6 +35,7 @@ import type {
   VOIRange,
   EventTypes,
   VolumeViewportProperties,
+  TargetSpecifier,
 } from '../types';
 import { VoiModifiedEventDetail } from '../types/EventTypes';
 import type { ViewportInput } from '../types/IViewport';
@@ -1382,10 +1383,28 @@ abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
     return imageVolume.imageIds;
   };
 
-  abstract getCurrentImageIdIndex(): number;
-
   abstract getCurrentImageId(): string;
 
+  public getTargetId(specifier: TargetSpecifier = {}): string {
+    let { volumeId, sliceIndex } = specifier;
+    if (!volumeId) {
+      const actorEntries = this.getActors();
+      if (!actorEntries) {
+        return;
+      }
+      // find the first image actor of instance type vtkVolume
+      volumeId = actorEntries.find(
+        (actorEntry) => actorEntry.actor.getClassName() === 'vtkVolume'
+      )?.uid;
+    }
+
+    sliceIndex ??= this.getCurrentImageIdIndex();
+    const { viewPlaneNormal, focalPoint } = this.getCamera();
+    return `volumeId:${volumeId}?sliceIndex=${sliceIndex}&viewPlaneNormal=${viewPlaneNormal.join(
+      ','
+    )}&focalPoint=${focalPoint.join(',')}`;
+  }
+
   abstract setBlendMode(
     blendMode: BlendModes,
     filterActorUIDs?: Array<string>,

package/src/RenderingEngine/StackViewport.ts

@@ -35,7 +35,7 @@ import type {
   VOIRange,
   VolumeActor,
 } from '../types';
-import { ViewportInput } from '../types/IViewport';
+import { TargetSpecifier, ViewportInput } from '../types/IViewport';
 import {
   actorIsA,
   colormap as colormapUtils,
@@ -2812,6 +2812,11 @@ class StackViewport extends Viewport implements IStackViewport, IImagesLoader {
     return this.currentImageIdIndex;
   };
 
+  public getTargetId(specifier: TargetSpecifier = {}): string {
+    const { sliceIndex: imageIdIndex = this.currentImageIdIndex } = specifier;
+    return `imageId:${this.imageIds[imageIdIndex]}`;
+  }
+
   /**
    *
    * Returns the imageIdIndex that is targeted to be loaded, in case of debounced

package/src/RenderingEngine/VideoViewport.ts

@@ -4,7 +4,7 @@ import {
   VideoViewport as VideoViewportEnum,
   MetadataModules,
 } from '../enums';
-import {
+import type {
   IVideoViewport,
   VideoViewportProperties,
   Point3,
@@ -13,6 +13,7 @@ import {
   InternalVideoCamera,
   VideoViewportInput,
   VOIRange,
+  TargetSpecifier,
 } from '../types';
 import * as metaData from '../metaData';
 import { Transform } from './helpers/cpuFallback/rendering/transform';
@@ -633,15 +634,34 @@ class VideoViewport extends Viewport implements IVideoViewport {
     const current = this.imageId.replace(
       '/frames/1',
       this.isPlaying
-        ? `/frames/1-${this.numberOfFrames}`
+        ? `/frames/${this.frameRange[0]}-${this.frameRange[1]}`
         : `/frames/${this.getFrameNumber()}`
     );
     return current;
   }
 
+  public getTargetId(specifier: TargetSpecifier = {}): string {
+    const { sliceIndex } = specifier;
+    if (sliceIndex === undefined) {
+      return `videoId:${this.getCurrentImageId()}`;
+    }
+    const baseTarget = this.imageId.replace(
+      '/frames/1',
+      `/frames/${1 + sliceIndex}`
+    );
+    return `videoId:${baseTarget}`;
+  }
+
+  /**
+   * Gets the 1 based frame number (ala DICOM value), eg `1+ currentImageIdIndex`
+   */
   public getFrameNumber() {
     // Need to round this as the fps/time isn't exact
-    return 1 + Math.round(this.videoElement.currentTime * this.fps);
+    return 1 + this.getCurrentImageIdIndex();
+  }
+
+  public getCurrentImageIdIndex() {
+    return Math.round(this.videoElement.currentTime * this.fps);
   }
 
   public getCamera(): ICamera {

package/src/RenderingEngine/Viewport.ts

@@ -30,7 +30,11 @@ import type {
   EventTypes,
   DisplayArea,
 } from '../types';
-import type { ViewportInput, IViewport } from '../types/IViewport';
+import type {
+  ViewportInput,
+  IViewport,
+  TargetSpecifier,
+} from '../types/IViewport';
 import type { vtkSlabCamera } from './vtkClasses/vtkSlabCamera';
 import { getConfiguration } from '../init';
 import IImageCalibration from '../types/IImageCalibration';
@@ -884,6 +888,14 @@ class Viewport implements IViewport {
     return result;
   }
 
+  public getCurrentImageIdIndex(): number {
+    throw new Error('Not implemented');
+  }
+
+  public getTargetId(specifier?: TargetSpecifier): string {
+    return null;
+  }
+
   /**
    * Sets the canvas pan value relative to the initial view position of 0,0
    * Modifies the camera to perform the pan.

package/src/types/IViewport.ts

@@ -7,6 +7,20 @@ import ViewportType from '../enums/ViewportType';
 import ViewportStatus from '../enums/ViewportStatus';
 import DisplayArea from './displayArea';
 
+/**
+ * Specifies what image to get a reference for.
+ */
+export type TargetSpecifier = {
+  /** The slice index within the current viewport camera to get a reference for */
+  sliceIndex?: number;
+  /** True to get a frame of reference UID reference instead of a regular image one */
+  forFrameOfReference?: boolean;
+  /** Set of points to get a reference for, in world space */
+  points?: Point3[];
+  /** The volumeId to reference */
+  volumeId?: string;
+};
+
 /**
  * Viewport interface for cornerstone viewports
  */
@@ -107,6 +121,10 @@ interface IViewport {
   setCamera(cameraInterface: ICamera, storeAsInitialCamera?: boolean): void;
   /** Gets the number of slices in the current camera orientation */
   getNumberOfSlices(): number;
+  /** Gets the current slice in the current camera orientation */
+  getCurrentImageIdIndex(): number;
+  /** Gets a referenced image url of some sort - could be a real image id, or could be a URL with parameters */
+  getTargetId(forTarget?: TargetSpecifier): string;
   /** whether the viewport has custom rendering */
   customRenderViewportToCanvas: () => unknown;
   _getCorners(bounds: Array<number>): Array<number>[];

package/src/types/index.ts

@@ -13,7 +13,11 @@ import type VolumeLoaderFn from './VolumeLoaderFn';
 import type IRegisterImageLoader from './IRegisterImageLoader';
 import type IStreamingVolumeProperties from './IStreamingVolumeProperties';
 import type CustomEventType from './CustomEventType';
-import type { IViewport, PublicViewportInput } from './IViewport';
+import type {
+  IViewport,
+  PublicViewportInput,
+  TargetSpecifier,
+} from './IViewport';
 import type { VolumeActor, Actor, ActorEntry, ImageActor } from './IActor';
 import type {
   IImageLoadObject,
@@ -141,6 +145,7 @@ export type {
   IRegisterImageLoader,
   IStreamingVolumeProperties,
   IViewport,
+  TargetSpecifier,
   StackViewportProperties,
   VolumeViewportProperties,
   ViewportProperties,