@cornerstonejs/core 2.0.0-beta.2 → 2.0.0-beta.21

package/src/types/Cornerstone3DConfig.ts

@@ -1,56 +0,0 @@
-import type { TierResult, GetGPUTier } from 'detect-gpu';
-
-type Cornerstone3DConfig = {
-  /**
-   * It is used to store the device information,
-   * we use it if provided if not a network call is performed.
-   * Its type is the `TierResult` in the `detect-gpu` library.
-   * https://github.com/pmndrs/detect-gpu/blob/master/src/index.ts#L82
-   */
-  gpuTier?: TierResult;
-  /**
-   * When the `gpuTier` is not provided, the `detectGPUConfig` is passed as
-   * an argument to the `getGPUTier` method.
-   * Its type is the `GetGPUTier` in the `detect-gpu` library.
-   * https://github.com/pmndrs/detect-gpu/blob/master/src/index.ts#L20
-   */
-  detectGPUConfig: GetGPUTier;
-  rendering: {
-    // vtk.js supports 8bit integer textures and 32bit float textures.
-    // However, if the client has norm16 textures (it can be seen by visiting
-    // the webGl report at https://webglreport.com/?v=2), vtk will be default
-    // to use it to improve memory usage. However, if the client don't have
-    // it still another level of optimization can happen by setting the
-    // preferSizeOverAccuracy since it will reduce the size of the texture to half
-    // float at the cost of accuracy in rendering. This is a tradeoff that the
-    // client can decide.
-    //
-    // Read more in the following Pull Request:
-    // 1. HalfFloat: https://github.com/Kitware/vtk-js/pull/2046
-    // 2. Norm16: https://github.com/Kitware/vtk-js/pull/2058
-    preferSizeOverAccuracy: boolean;
-    // Whether the EXT_texture_norm16 extension is supported by the browser.
-    // WebGL 2 report (link: https://webglreport.com/?v=2) can be used to check
-    // if the browser supports this extension.
-    // In case the browser supports this extension, instead of using 32bit float
-    // textures, 16bit float textures will be used to reduce the memory usage where
-    // possible.
-    // Norm16 may not work currently due to the two active bugs in chrome + safari
-    // https://bugs.chromium.org/p/chromium/issues/detail?id=1408247
-    // https://bugs.webkit.org/show_bug.cgi?id=252039
-    useNorm16Texture: boolean;
-    useCPURendering: boolean;
-    /**
-     * flag to control whether to use fallback behavior for z-spacing calculation in
-     * volume viewports when the necessary metadata is missing. If enabled,
-     * we will fall back to using slice thickness or a default value of 1 to render
-     * the volume viewport when z-spacing cannot be calculated from images
-     * This can help improve the usability and robustness of the visualization
-     * in scenarios where the metadata is incomplete or missing, but
-     * it might be wrong assumption in certain scenarios.
-     */
-    strictZSpacingForVolumeViewport: boolean;
-  };
-};
-
-export default Cornerstone3DConfig;

package/src/types/CustomEventType.ts

@@ -1,14 +0,0 @@
-interface CustomEvent<T = any> extends Event {
-  /**
-   * Returns any custom data event was created with. Typically used for synthetic events.
-   */
-  readonly detail: T;
-  initCustomEvent(
-    typeArg: string,
-    canBubbleArg: boolean,
-    cancelableArg: boolean,
-    detailArg: T
-  ): void;
-}
-
-export default CustomEvent;

package/src/types/EventTypes.ts

@@ -1,454 +0,0 @@
-import type { mat4 } from 'gl-matrix';
-import type { vtkImageData } from '@kitware/vtk.js/Common/DataModel/ImageData';
-import type CustomEventType from '../types/CustomEventType';
-import type ICachedImage from './ICachedImage';
-import type ICachedVolume from './ICachedVolume';
-import type ICamera from './ICamera';
-import type IImage from './IImage';
-import type IImageVolume from './IImageVolume';
-import type { VOIRange } from './voi';
-import type VOILUTFunctionType from '../enums/VOILUTFunctionType';
-import type ViewportStatus from '../enums/ViewportStatus';
-import type DisplayArea from './displayArea';
-import IImageCalibration from './IImageCalibration';
-
-/**
- * CAMERA_MODIFIED Event's data
- */
-type CameraModifiedEventDetail = {
-  /** Previous camera properties */
-  previousCamera: ICamera;
-  /** Current camera properties */
-  camera: ICamera;
-  /** Viewport HTML element in the DOM */
-  element: HTMLDivElement;
-  /** Viewport Unique ID in the renderingEngine */
-  viewportId: string;
-  /** Unique ID for the renderingEngine */
-  renderingEngineId: string;
-  /** Rotation Optional */
-  rotation?: number;
-};
-
-/**
- * VOI_MODIFIED Event's data
- */
-type VoiModifiedEventDetail = {
-  /** Viewport Unique ID in the renderingEngine */
-  viewportId: string;
-  /** new VOI range */
-  range: VOIRange;
-  /** Unique ID for the volume in the cache */
-  volumeId?: string;
-  /** VOILUTFunction */
-  VOILUTFunction?: VOILUTFunctionType;
-  /** inverted */
-  invert?: boolean;
-  /** Indicates if the 'invert' state has changed from the previous state */
-  invertStateChanged?: boolean;
-};
-
-/**
- * DISPLAY_AREA_MODIFIED Event's data
- */
-type DisplayAreaModifiedEventDetail = {
-  /** Viewport Unique ID in the renderingEngine */
-  viewportId: string;
-  /** new display area */
-  displayArea: DisplayArea;
-  /** Unique ID for the volume in the cache */
-  volumeId?: string;
-  /** Whether displayArea was stored as initial view */
-  storeAsInitialCamera?: boolean;
-};
-
-/**
- * ELEMENT_DISABLED Event's data
- */
-type ElementDisabledEventDetail = {
-  /** Viewport HTML element in the DOM */
-  element: HTMLDivElement;
-  /** Viewport Unique ID in the renderingEngine */
-  viewportId: string;
-  /** Unique ID for the renderingEngine */
-  renderingEngineId: string;
-};
-
-/**
- * ELEMENT_Enabled Event's data
- */
-type ElementEnabledEventDetail = {
-  /** Viewport HTML element in the DOM */
-  element: HTMLDivElement;
-  /** Viewport Unique ID in the renderingEngine */
-  viewportId: string;
-  /** Unique ID for the renderingEngine */
-  renderingEngineId: string;
-};
-
-/**
- * IMAGE_RENDERED Event's data
- */
-type ImageRenderedEventDetail = {
-  /** Viewport HTML element in the DOM */
-  element: HTMLDivElement;
-  /** Viewport Unique ID in the renderingEngine */
-  viewportId: string;
-  /** Unique ID for the renderingEngine */
-  renderingEngineId: string;
-  /** Whether to suppress the event */
-  suppressEvents?: boolean;
-  /** Include information on whether this is a real rendering or just background */
-  viewportStatus: ViewportStatus;
-};
-/**
- * IMAGE_VOLUME_MODIFIED Event's data
- */
-type ImageVolumeModifiedEventDetail = {
-  /** the modified volume */
-  imageVolume: IImageVolume;
-  /** FrameOfReferenceUID where the volume belongs to */
-  FrameOfReferenceUID: string;
-};
-
-/**
- * IMAGE_VOLUME_LOADING_COMPLETED Event's data
- */
-type ImageVolumeLoadingCompletedEventDetail = {
-  /** the loaded volume */
-  volumeId: string;
-  /** FrameOfReferenceUID where the volume belongs to */
-  FrameOfReferenceUID: string;
-};
-
-/**
- * IMAGE_LOADED Event's data
- */
-type ImageLoadedEventDetail = {
-  /** the loaded image */
-  image: IImage;
-};
-
-/**
- * IMAGE_LOADED_FAILED Event's data
- */
-type ImageLoadedFailedEventDetail = {
-  /** the imageId for the image */
-  imageId: string;
-  error: unknown;
-};
-
-/**
- * VOLUME_LOADED Event's data
- */
-type VolumeLoadedEventDetail = {
-  /** the loaded volume */
-  volume: IImageVolume;
-};
-
-/**
- * VOLUME_LOADED_FAILED Event's data
- */
-type VolumeLoadedFailedEventDetail = {
-  /** the volumeId for the volume */
-  volumeId: string;
-  error: unknown;
-};
-
-/**
- * IMAGE_CACHE_IMAGE_REMOVED Event's data
- */
-type ImageCacheImageRemovedEventDetail = {
-  /** the removed image id */
-  imageId: string;
-};
-
-/**
- * IMAGE_CACHE_IMAGE_ADDED Event's data
- */
-type ImageCacheImageAddedEventDetail = {
-  /** the added image */
-  image: ICachedImage;
-};
-
-/**
- * VOLUME_CACHE_VOLUME_REMOVED Event's data
- */
-type VolumeCacheVolumeRemovedEventDetail = {
-  /** the removed volume id */
-  volumeId: string;
-};
-
-/**
- * VOLUME_CACHE_VOLUME_ADDED Event's data
- */
-type VolumeCacheVolumeAddedEventDetail = {
-  /** the added volume */
-  volume: ICachedVolume;
-};
-
-/**
- * PRE_STACK_NEW_IMAGE Event's data
- */
-type PreStackNewImageEventDetail = {
-  /** the image imageId */
-  imageId: string;
-  /** the index of imageId in the stack */
-  imageIdIndex: number;
-  /** unique id for the viewport */
-  viewportId: string;
-  /** unique id for the renderingEngine */
-  renderingEngineId: string;
-};
-
-/**
- * STACK_NEW_IMAGE Event's data
- */
-type StackNewImageEventDetail = {
-  /** the new image set on the stack viewport */
-  image: IImage;
-  /** the image imageId */
-  imageId: string;
-  /** the index of imageId in the stack */
-  imageIdIndex: number;
-  /** unique id for the viewport */
-  viewportId: string;
-  /** unique id for the renderingEngine */
-  renderingEngineId: string;
-};
-
-/**
- * VOLUME_NEW_IMAGE Event's data
- */
-type VolumeNewImageEventDetail = {
-  /** image index */
-  imageIndex: number;
-  /** number of slices */
-  numberOfSlices: number;
-  /** unique id for the viewport */
-  viewportId: string;
-  /** unique id for the renderingEngine */
-  renderingEngineId: string;
-};
-
-/**
- * IMAGE_SPACING_CALIBRATED Event's data
- */
-type ImageSpacingCalibratedEventDetail = {
-  element: HTMLDivElement;
-  viewportId: string;
-  renderingEngineId: string;
-  imageId: string;
-  /** calibration contains the scaling information as well as other calibration info */
-  calibration: IImageCalibration;
-  imageData: vtkImageData;
-  worldToIndex: mat4;
-};
-
-/**
- * IMAGE_LOAD_PROGRESS Event's data. Note this is only for one image load and NOT volume load.
- */
-type ImageLoadProgressEventDetail = {
-  /** url we are loading from */
-  url: string;
-  /** loading image image id */
-  imageId: string;
-  /** the bytes browser receive */
-  loaded: number;
-  /** the total bytes settled by the header */
-  total: number;
-  /** loaded divided by total * 100 - shows the percentage of the image loaded */
-  percent: number;
-};
-
-/**
- * The STACK_VIEWPORT_NEW_STACK event's data, when a new stack is set on a StackViewport
- */
-type StackViewportNewStackEventDetail = {
-  imageIds: string[];
-  viewportId: string;
-  element: HTMLDivElement;
-  currentImageIdIndex: number;
-};
-
-/**
- * Stack Scroll event detail
- */
-type StackViewportScrollEventDetail = {
-  /** the new imageId index in the stack that we just scroll to */
-  newImageIdIndex: number;
-  /** the new imageId in the stack that we just scroll to */
-  imageId: string;
-  /** direction of the scroll */
-  direction: number;
-};
-
-/**
- * CameraModified Event type
- */
-type CameraModifiedEvent = CustomEventType<CameraModifiedEventDetail>;
-
-/**
- * VOI_MODIFIED Event type
- */
-type VoiModifiedEvent = CustomEventType<VoiModifiedEventDetail>;
-
-/**
- * DISPLAY_AREA_MODIFIED Event type
- */
-type DisplayAreaModifiedEvent = CustomEventType<DisplayAreaModifiedEventDetail>;
-
-/**
- * ELEMENT_DISABLED Event type
- */
-type ElementDisabledEvent = CustomEventType<ElementDisabledEventDetail>;
-
-/**
- * ELEMENT_ENABLED Event type
- */
-type ElementEnabledEvent = CustomEventType<ElementEnabledEventDetail>;
-
-/**
- * IMAGE_RENDERED Event type
- */
-type ImageRenderedEvent = CustomEventType<ElementEnabledEventDetail>;
-
-/**
- * IMAGE_VOLUME_MODIFIED Event type
- */
-type ImageVolumeModifiedEvent = CustomEventType<ImageVolumeModifiedEventDetail>;
-
-/**
- * IMAGE_VOLUME_LOADING_COMPLETED Event type
- * This event is fired when a volume is fully loaded, means all the frames
- * are loaded and cached.
- */
-type ImageVolumeLoadingCompletedEvent =
-  CustomEventType<ImageVolumeLoadingCompletedEventDetail>;
-
-/**
- * IMAGE_LOADED Event type
- */
-type ImageLoadedEvent = CustomEventType<ImageLoadedEventDetail>;
-
-/**
- * IMAGE_LOADED_FAILED Event type
- */
-type ImageLoadedFailedEvent = CustomEventType<ImageLoadedFailedEventDetail>;
-
-/**
- * VOLUME_LOADED Event type
- */
-type VolumeLoadedEvent = CustomEventType<VolumeLoadedEventDetail>;
-
-/**
- * VOLUME_LOADED_FAILED Event type
- */
-type VolumeLoadedFailedEvent = CustomEventType<VolumeLoadedFailedEventDetail>;
-
-/**
- * IMAGE_CACHE_IMAGE_ADDED Event type
- */
-type ImageCacheImageAddedEvent =
-  CustomEventType<ImageCacheImageAddedEventDetail>;
-
-/**
- * IMAGE_CACHE_IMAGE_REMOVED Event type
- */
-type ImageCacheImageRemovedEvent =
-  CustomEventType<ImageCacheImageRemovedEventDetail>;
-
-/**
- * VOLUME_CACHE_VOLUME_ADDED Event type
- */
-type VolumeCacheVolumeAddedEvent =
-  CustomEventType<VolumeCacheVolumeAddedEventDetail>;
-
-/**
- * VOLUME_CACHE_VOLUME_REMOVED Event type
- */
-type VolumeCacheVolumeRemovedEvent =
-  CustomEventType<VolumeCacheVolumeRemovedEventDetail>;
-
-/**
- * START_NEW_IMAGE
- */
-type StackNewImageEvent = CustomEventType<StackNewImageEventDetail>;
-
-/**
- * VOLUME_NEW_IMAGE
- */
-type VolumeNewImageEvent = CustomEventType<VolumeNewImageEventDetail>;
-
-/**
- * START_NEW_IMAGE
- */
-type PreStackNewImageEvent = CustomEventType<PreStackNewImageEventDetail>;
-
-/**
- * IMAGE_SPACING_CALIBRATED
- */
-type ImageSpacingCalibratedEvent =
-  CustomEventType<ImageSpacingCalibratedEventDetail>;
-
-/**
- * IMAGE_LOAD_PROGRESS
- */
-type ImageLoadProgressEvent = CustomEventType<ImageLoadProgressEventDetail>;
-
-/**
- * STACK_VIEWPORT_NEW_STACK
- */
-type StackViewportNewStackEvent =
-  CustomEventType<StackViewportNewStackEventDetail>;
-
-type StackViewportScrollEvent = CustomEventType<StackViewportScrollEventDetail>;
-
-export type {
-  CameraModifiedEventDetail,
-  CameraModifiedEvent,
-  VoiModifiedEvent,
-  VoiModifiedEventDetail,
-  DisplayAreaModifiedEvent,
-  DisplayAreaModifiedEventDetail,
-  ElementDisabledEvent,
-  ElementDisabledEventDetail,
-  ElementEnabledEvent,
-  ElementEnabledEventDetail,
-  ImageRenderedEventDetail,
-  ImageRenderedEvent,
-  ImageVolumeModifiedEvent,
-  ImageVolumeModifiedEventDetail,
-  ImageVolumeLoadingCompletedEvent,
-  ImageVolumeLoadingCompletedEventDetail,
-  ImageLoadedEvent,
-  ImageLoadedEventDetail,
-  ImageLoadedFailedEventDetail,
-  ImageLoadedFailedEvent,
-  VolumeLoadedEvent,
-  VolumeLoadedEventDetail,
-  VolumeLoadedFailedEvent,
-  VolumeLoadedFailedEventDetail,
-  ImageCacheImageAddedEvent,
-  ImageCacheImageAddedEventDetail,
-  ImageCacheImageRemovedEvent,
-  ImageCacheImageRemovedEventDetail,
-  VolumeCacheVolumeAddedEvent,
-  VolumeCacheVolumeAddedEventDetail,
-  VolumeCacheVolumeRemovedEvent,
-  VolumeCacheVolumeRemovedEventDetail,
-  StackNewImageEvent,
-  StackNewImageEventDetail,
-  PreStackNewImageEvent,
-  PreStackNewImageEventDetail,
-  ImageSpacingCalibratedEvent,
-  ImageSpacingCalibratedEventDetail,
-  ImageLoadProgressEvent,
-  ImageLoadProgressEventDetail,
-  VolumeNewImageEvent,
-  VolumeNewImageEventDetail,
-  StackViewportNewStackEvent,
-  StackViewportNewStackEventDetail,
-  StackViewportScrollEvent,
-  StackViewportScrollEventDetail,
-};

package/src/types/FlipDirection.ts

@@ -1,9 +0,0 @@
-/**
- * Flip direction which can be horizontal or vertical.
- */
-type FlipDirection = {
-  flipHorizontal?: boolean;
-  flipVertical?: boolean;
-};
-
-export default FlipDirection;

package/src/types/IActor.ts

@@ -1,23 +0,0 @@
-import type vtkActor from '@kitware/vtk.js/Rendering/Core/Actor';
-import vtkImageSlice from '@kitware/vtk.js/Rendering/Core/ImageSlice';
-import type vtkVolume from '@kitware/vtk.js/Rendering/Core/Volume';
-
-export type Actor = vtkActor;
-export type VolumeActor = vtkVolume;
-export type ImageActor = vtkImageSlice;
-
-/**
- * Cornerstone Actor Entry including actor uid, actual Actor, and
- * slabThickness for the actor. ActorEntry is the object that
- * is retrieved from viewport when calling viewport.getActor(s)
- */
-export type ActorEntry = {
-  /** actor UID */
-  uid: string;
-  /** actual actor object */
-  actor: Actor | VolumeActor | ImageActor;
-  /** the id of the reference volume from which this actor is derived or created*/
-  referenceId?: string;
-  /** slab thickness for the actor */
-  slabThickness?: number;
-};

package/src/types/ICache.ts

@@ -1,28 +0,0 @@
-import { IImageLoadObject, IVolumeLoadObject } from './ILoadObject';
-
-interface ICache {
-  /** Set the maximum cache size  */
-  setMaxCacheSize: (maxCacheSize: number) => void;
-  /** Get the maximum cache size  */
-  getMaxCacheSize: () => number;
-  /** Get the current cache size  */
-  getCacheSize: () => number;
-  /** Stores the imageLoad Object inside the cache */
-  putImageLoadObject: (
-    imageId: string,
-    imageLoadObject: IImageLoadObject
-  ) => Promise<any>;
-  /** Retrieves the imageLoad Object from the cache */
-  getImageLoadObject: (imageId: string) => IImageLoadObject | void;
-  /** Stores the volumeLoad Object inside the cache */
-  putVolumeLoadObject: (
-    volumeId: string,
-    volumeLoadObject: IVolumeLoadObject
-  ) => Promise<any>;
-  /** Retrieves the volumeLoad Object from the cache */
-  getVolumeLoadObject: (volumeId: string) => IVolumeLoadObject | void;
-  /** Purge cache both image and volume */
-  purgeCache: () => void;
-}
-
-export default ICache;

package/src/types/ICachedGeometry.ts

@@ -1,13 +0,0 @@
-import IGeometry from './IGeometry';
-import { IGeometryLoadObject } from './ILoadObject';
-
-interface ICachedGeometry {
-  geometryId: string;
-  geometryLoadObject: IGeometryLoadObject;
-  loaded: boolean;
-  timeStamp: number;
-  sizeInBytes: number;
-  geometry?: IGeometry;
-}
-
-export default ICachedGeometry;

package/src/types/ICachedImage.ts

@@ -1,13 +0,0 @@
-import { IImage, IImageLoadObject } from '../types';
-
-interface ICachedImage {
-  image?: IImage;
-  imageId: string;
-  imageLoadObject: IImageLoadObject;
-  loaded: boolean;
-  sharedCacheKey?: string;
-  timeStamp: number;
-  sizeInBytes: number;
-}
-
-export default ICachedImage;

package/src/types/ICachedVolume.ts

@@ -1,12 +0,0 @@
-import { IImageVolume, IVolumeLoadObject } from '../types';
-
-interface ICachedVolume {
-  volume?: IImageVolume;
-  volumeId: string;
-  volumeLoadObject: IVolumeLoadObject;
-  loaded: boolean;
-  timeStamp: number;
-  sizeInBytes: number;
-}
-
-export default ICachedVolume;

package/src/types/ICamera.ts

@@ -1,36 +0,0 @@
-import Point3 from './Point3';
-import Point2 from './Point2';
-
-/**
- * Camera Interface. See {@link https://kitware.github.io/vtk-examples/site/VTKBook/03Chapter3/#35-cameras} if you
- * want to know more about the camera.
- */
-interface ICamera {
-  /** Camera Focal point */
-  focalPoint?: Point3;
-  /** Camera Parallel Projection flag - whether camera is using parallel projection */
-  parallelProjection?: boolean;
-  /** Camera parallel scale - used for parallel projection zoom, smaller values zoom in */
-  parallelScale?: number;
-  /**
-   * Scale factor for the camera, it is the ratio of how much an image pixel takes
-   * up one screen pixel
-   */
-  scale?: number;
-  /** Camera position */
-  position?: Point3;
-  /** Camera view angle - 90 degrees is orthographic */
-  viewAngle?: number;
-  /** Camera viewPlaneNormal - negative of the direction the camera is pointing or directionOfProjection*/
-  viewPlaneNormal?: Point3;
-  /** Camera viewUp - the direction of viewUP in camera */
-  viewUp?: Point3;
-  /** flip Horizontal */
-  flipHorizontal?: boolean;
-  /** flip Vertical */
-  flipVertical?: boolean;
-  /** clipping range */
-  clippingRange?: Point2;
-}
-
-export default ICamera;

package/src/types/IContour.ts

@@ -1,18 +0,0 @@
-import { Point3 } from '.';
-import { ContourType } from '../enums';
-
-export interface IContour {
-  readonly id: string;
-  readonly sizeInBytes: number;
-  points: Point3[];
-  color: any;
-  _getSizeInBytes(): number;
-  /**
-   * It returns the value of the points property of the data object
-   * @returns The points property of the data object.
-   */
-  getPoints(): Point3[];
-  getColor(): Point3;
-  getType(): ContourType;
-  getFlatPointsArray(): number[];
-}