@cornerstonejs/core 2.0.0-beta.8 → 2.0.0

package/src/RenderingEngine/VolumeViewport.ts

@@ -1,638 +0,0 @@
-import vtkPlane from '@kitware/vtk.js/Common/DataModel/Plane';
-import vtkVolume from '@kitware/vtk.js/Rendering/Core/Volume';
-
-import cache from '../cache';
-import { MPR_CAMERA_VALUES, RENDERING_DEFAULTS } from '../constants';
-import { BlendModes, OrientationAxis, Events } from '../enums';
-import type {
-  ActorEntry,
-  IImageVolume,
-  IVolumeInput,
-  OrientationVectors,
-  Point3,
-  EventTypes,
-  ViewReference,
-  ViewReferenceSpecifier,
-} from '../types';
-import type { ViewportInput } from '../types/IViewport';
-import {
-  actorIsA,
-  getClosestImageId,
-  getSliceRange,
-  getSpacingInNormalDirection,
-  isImageActor,
-  snapFocalPointToSlice,
-  triggerEvent,
-} from '../utilities';
-import BaseVolumeViewport from './BaseVolumeViewport';
-import setDefaultVolumeVOI from './helpers/setDefaultVolumeVOI';
-import { setTransferFunctionNodes } from '../utilities/transferFunctionUtils';
-import { ImageActor } from '../types/IActor';
-import getImageSliceDataForVolumeViewport from '../utilities/getImageSliceDataForVolumeViewport';
-import { vec3 } from 'gl-matrix';
-
-/**
- * An object representing a VolumeViewport. VolumeViewports are used to render
- * 3D volumes from which various orientations can be viewed. Since VolumeViewports
- * use SharedVolumeMappers behind the scene, memory footprint of visualizations
- * of the same volume in different orientations is very small.
- *
- * For setting volumes on viewports you need to use {@link addVolumesToViewports}
- * which will add volumes to the specified viewports.
- */
-class VolumeViewport extends BaseVolumeViewport {
-  private _useAcquisitionPlaneForViewPlane = false;
-  constructor(props: ViewportInput) {
-    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) {
-      this.applyViewOrientation(orientation);
-      return;
-    }
-
-    this._useAcquisitionPlaneForViewPlane = true;
-  }
-
-  /**
-   * Creates volume actors for all volumes defined in the `volumeInputArray`.
-   * For each entry, if a `callback` is supplied, it will be called with the new volume actor as input.
-   * For each entry, if a `blendMode` and/or `slabThickness` is defined, this will be set on the actor's
-   * `VolumeMapper`.
-   *
-   * @param volumeInputArray - The array of `VolumeInput`s which define the volumes to add.
-   * @param immediate - Whether the `Viewport` should be rendered as soon as volumes are added.
-   */
-  public async setVolumes(
-    volumeInputArray: Array<IVolumeInput>,
-    immediate = false,
-    suppressEvents = false
-  ): Promise<void> {
-    const firstImageVolume = cache.getVolume(volumeInputArray[0].volumeId);
-
-    if (!firstImageVolume) {
-      throw new Error(
-        `imageVolume with id: ${firstImageVolume.volumeId} does not exist`
-      );
-    }
-
-    if (this._useAcquisitionPlaneForViewPlane) {
-      this._setViewPlaneToAcquisitionPlane(firstImageVolume);
-      this._useAcquisitionPlaneForViewPlane = false;
-    }
-
-    return super.setVolumes(volumeInputArray, immediate, suppressEvents);
-  }
-
-  /** Gets the number of slices the volume is broken up into in the camera direction */
-  public getNumberOfSlices = (): number => {
-    const { numberOfSlices } = getImageSliceDataForVolumeViewport(this);
-    return numberOfSlices;
-  };
-
-  /**
-   * Creates and adds volume actors for all volumes defined in the `volumeInputArray`.
-   * For each entry, if a `callback` is supplied, it will be called with the new volume actor as input.
-   *
-   * @param volumeInputArray - The array of `VolumeInput`s which define the volumes to add.
-   * @param immediate - Whether the `Viewport` should be rendered as soon as volumes are added.
-   */
-  public async addVolumes(
-    volumeInputArray: Array<IVolumeInput>,
-    immediate = false,
-    suppressEvents = false
-  ): Promise<void> {
-    const firstImageVolume = cache.getVolume(volumeInputArray[0].volumeId);
-
-    if (!firstImageVolume) {
-      throw new Error(
-        `imageVolume with id: ${firstImageVolume.volumeId} does not exist`
-      );
-    }
-
-    if (this._useAcquisitionPlaneForViewPlane) {
-      this._setViewPlaneToAcquisitionPlane(firstImageVolume);
-      this._useAcquisitionPlaneForViewPlane = false;
-    }
-
-    return super.addVolumes(volumeInputArray, immediate, suppressEvents);
-  }
-
-  /**
-   * It sets the orientation for the camera, the orientation can be one of the
-   * following: axial, sagittal, coronal, default. Use the Enums.OrientationAxis
-   * to set the orientation. The "default" orientation is the orientation that
-   * the volume was acquired in (scan axis)
-   *
-   * @param orientation - The orientation to set the camera to.
-   * @param immediate - Whether the `Viewport` should be rendered as soon as the camera is set.
-   */
-  public setOrientation(
-    orientation: OrientationAxis | OrientationVectors,
-    immediate = true
-  ): void {
-    let viewPlaneNormal, viewUp;
-
-    // check if the orientation is a string or an object
-    if (typeof orientation === 'string') {
-      if (MPR_CAMERA_VALUES[orientation]) {
-        ({ viewPlaneNormal, viewUp } = MPR_CAMERA_VALUES[orientation]);
-      } else if (orientation === 'acquisition') {
-        ({ viewPlaneNormal, viewUp } = this._getAcquisitionPlaneOrientation());
-      } else {
-        throw new Error(
-          `Invalid orientation: ${orientation}. Use Enums.OrientationAxis instead.`
-        );
-      }
-
-      this.setCamera({
-        viewPlaneNormal,
-        viewUp,
-      });
-
-      this.viewportProperties.orientation = orientation;
-      this.resetCamera();
-    } else {
-      ({ viewPlaneNormal, viewUp } = orientation);
-      this.applyViewOrientation(orientation);
-    }
-
-    if (immediate) {
-      this.render();
-    }
-  }
-
-  private _getAcquisitionPlaneOrientation(): OrientationVectors {
-    const actorEntry = this.getDefaultActor();
-
-    if (!actorEntry) {
-      return;
-    }
-
-    // Todo: fix this after we add the volumeId reference to actorEntry later
-    // in the segmentation refactor
-    const volumeId = actorEntry.uid;
-
-    const imageVolume = cache.getVolume(volumeId);
-
-    if (!imageVolume) {
-      throw new Error(
-        `imageVolume with id: ${volumeId} does not exist in cache`
-      );
-    }
-
-    const { direction } = imageVolume;
-    const viewPlaneNormal = direction.slice(6, 9).map((x) => -x) as Point3;
-    const viewUp = (direction.slice(3, 6) as Point3).map((x) => -x) as Point3;
-
-    return {
-      viewPlaneNormal,
-      viewUp,
-    };
-  }
-
-  private _setViewPlaneToAcquisitionPlane(imageVolume: IImageVolume): void {
-    let viewPlaneNormal, viewUp;
-
-    if (imageVolume) {
-      const { direction } = imageVolume;
-      viewPlaneNormal = direction.slice(6, 9).map((x) => -x) as Point3;
-      viewUp = (direction.slice(3, 6) as Point3).map((x) => -x) as Point3;
-    } else {
-      ({ viewPlaneNormal, viewUp } = this._getAcquisitionPlaneOrientation());
-    }
-
-    this.setCamera({
-      viewPlaneNormal,
-      viewUp,
-    });
-
-    this.initialViewUp = viewUp;
-    this.resetCamera();
-  }
-
-  public setBlendMode(
-    blendMode: BlendModes,
-    filterActorUIDs = [],
-    immediate = false
-  ): void {
-    let actorEntries = this.getActors();
-
-    if (filterActorUIDs && filterActorUIDs.length > 0) {
-      actorEntries = actorEntries.filter((actorEntry: ActorEntry) => {
-        return filterActorUIDs.includes(actorEntry.uid);
-      });
-    }
-
-    actorEntries.forEach((actorEntry) => {
-      const { actor } = actorEntry;
-
-      const mapper = actor.getMapper();
-      // @ts-ignore vtk incorrect typing
-      mapper.setBlendMode?.(blendMode);
-    });
-
-    if (immediate) {
-      this.render();
-    }
-  }
-
-  /**
-   * Reset the camera for the volume viewport
-   */
-  public resetCamera(
-    resetPan = true,
-    resetZoom = true,
-    resetToCenter = true,
-    resetRotation = false,
-    supressEvents = false
-  ): boolean {
-    const { orientation } = this.viewportProperties;
-    if (orientation) {
-      this.applyViewOrientation(orientation, false);
-    }
-    super.resetCamera(resetPan, resetZoom, resetToCenter);
-
-    this.resetVolumeViewportClippingRange();
-
-    const activeCamera = this.getVtkActiveCamera();
-    const viewPlaneNormal = <Point3>activeCamera.getViewPlaneNormal();
-    const focalPoint = <Point3>activeCamera.getFocalPoint();
-
-    // always add clipping planes for the volume viewport. If a use case
-    // arises where we don't want clipping planes, you should use the volume_3d
-    // viewport instead.
-    const actorEntries = this.getActors();
-    actorEntries.forEach((actorEntry) => {
-      if (!actorEntry.actor) {
-        return;
-      }
-      const mapper = actorEntry.actor.getMapper();
-      const vtkPlanes = mapper.getClippingPlanes();
-
-      if (vtkPlanes.length === 0 && !actorEntry?.clippingFilter) {
-        const clipPlane1 = vtkPlane.newInstance();
-        const clipPlane2 = vtkPlane.newInstance();
-        const newVtkPlanes = [clipPlane1, clipPlane2];
-
-        let slabThickness = RENDERING_DEFAULTS.MINIMUM_SLAB_THICKNESS;
-        if (actorEntry.slabThickness) {
-          slabThickness = actorEntry.slabThickness;
-        }
-
-        this.setOrientationOfClippingPlanes(
-          newVtkPlanes,
-          slabThickness,
-          viewPlaneNormal,
-          focalPoint
-        );
-
-        mapper.addClippingPlane(clipPlane1);
-        mapper.addClippingPlane(clipPlane2);
-      }
-    });
-
-    //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,
-      });
-    }
-
-    if (!supressEvents) {
-      const eventDetail: EventTypes.CameraResetEventDetail = {
-        viewportId: this.id,
-        camera: this.getCamera(),
-        renderingEngineId: this.renderingEngineId,
-        element: this.element,
-      };
-
-      triggerEvent(this.element, Events.CAMERA_RESET, eventDetail);
-    }
-    return true;
-  }
-
-  /**
-   * It sets the slabThickness of the actors of the viewport. If filterActorUIDs are
-   * provided, only the actors with the given UIDs will be affected. If no
-   * filterActorUIDs are provided, all actors will be affected.
-   *
-   * @param slabThickness - The slab thickness to set.
-   * @param filterActorUIDs - Optional argument to filter the actors to apply
-   * the slab thickness to (if not provided, all actors will be affected).
-   */
-  public setSlabThickness(slabThickness: number, filterActorUIDs = []): void {
-    if (slabThickness < 0.1) {
-      // Cannot render zero thickness
-      slabThickness = 0.1;
-    }
-
-    let actorEntries = this.getActors();
-
-    if (filterActorUIDs && filterActorUIDs.length > 0) {
-      actorEntries = actorEntries.filter((actorEntry) => {
-        return filterActorUIDs.includes(actorEntry.uid);
-      });
-    }
-
-    actorEntries.forEach((actorEntry) => {
-      if (actorIsA(actorEntry, 'vtkVolume')) {
-        actorEntry.slabThickness = slabThickness;
-      }
-    });
-
-    const currentCamera = this.getCamera();
-    this.updateClippingPlanesForActors(currentCamera);
-    this.triggerCameraModifiedEventIfNecessary(currentCamera, currentCamera);
-    this.viewportProperties.slabThickness = slabThickness;
-  }
-
-  /**
-   * Uses the origin and focalPoint to calculate the slice index.
-
-
-
-   * Resets the slab thickness of the actors of the viewport to the default value.
-   */
-  public resetSlabThickness(): void {
-    const actorEntries = this.getActors();
-
-    actorEntries.forEach((actorEntry) => {
-      if (actorIsA(actorEntry, 'vtkVolume')) {
-        actorEntry.slabThickness = RENDERING_DEFAULTS.MINIMUM_SLAB_THICKNESS;
-      }
-    });
-
-    const currentCamera = this.getCamera();
-    this.updateClippingPlanesForActors(currentCamera);
-    this.triggerCameraModifiedEventIfNecessary(currentCamera, currentCamera);
-    this.viewportProperties.slabThickness = undefined;
-  }
-
-  /**
-   * Returns the imageId index of the current slice in the volume viewport.
-   * Note: this is not guaranteed to be the same as the slice index in the view
-   * To get the slice index in the view (scroll position), use getSliceIndex()
-   *
-   * In future we will even delete this method as it should not be used
-   * at all.
-   *
-   * @returns The slice index in the direction of the view
-   */
-  public getCurrentImageIdIndex = (volumeId?: string): number => {
-    const { viewPlaneNormal, focalPoint } = this.getCamera();
-
-    const imageData = this.getImageData(volumeId);
-
-    if (!imageData) {
-      return;
-    }
-
-    const { origin, direction, spacing } = imageData;
-
-    const spacingInNormal = getSpacingInNormalDirection(
-      { direction, spacing },
-      viewPlaneNormal
-    );
-    const sub = vec3.create();
-    vec3.sub(sub, focalPoint, origin);
-    const distance = vec3.dot(sub, viewPlaneNormal);
-
-    // divide by the spacing in the normal direction to get the
-    // number of steps, and subtract 1 to get the index
-    return Math.round(Math.abs(distance) / spacingInNormal);
-  };
-
-  /**
-   * Returns the image index associated with the volume viewport in the current view, the difference
-   * between this method and getCurrentImageIdIndex is that this method returns the index of the
-   * slice in the volume in view direction so at the top (scrollbar top) of the viewport the index
-   * will be 0 and at the bottom (scrollbar bottom) the index will be the number of slices - 1.
-   * But the getCurrentImageIdIndex returns the index of current image in the imageIds
-   * which is not guaranteed to be the same as the slice index in the view.
-   *
-   * @returns The image index.
-   */
-  public getSliceIndex = (): number => {
-    const { imageIndex } = getImageSliceDataForVolumeViewport(this);
-    return imageIndex;
-  };
-
-  /**
-   * Uses viewport camera and volume actor to decide if the viewport
-   * is looking at the volume in the direction of acquisition (imageIds).
-   * If so, it uses the origin and focalPoint to find which imageId is
-   * currently being viewed.
-   *
-   * @returns ImageId
-   */
-  public getCurrentImageId = (): string | undefined => {
-    const actorEntry = this.getDefaultActor();
-
-    if (!actorEntry || !actorIsA(actorEntry, 'vtkVolume')) {
-      return;
-    }
-
-    const { uid } = actorEntry;
-    const volume = cache.getVolume(uid);
-
-    if (!volume) {
-      return;
-    }
-
-    const { viewPlaneNormal, focalPoint } = this.getCamera();
-
-    return getClosestImageId(volume, focalPoint, viewPlaneNormal);
-  };
-
-  /**
-   * Gets a view target, allowing comparison between view positions as well
-   * as restoring views later.
-   * Add the referenced image id.
-   */
-  public getViewReference(
-    viewRefSpecifier: ViewReferenceSpecifier = {}
-  ): ViewReference {
-    const viewRef = super.getViewReference(viewRefSpecifier);
-    if (!viewRef?.volumeId) {
-      return;
-    }
-    const volume = cache.getVolume(viewRef.volumeId);
-    viewRef.referencedImageId = getClosestImageId(
-      volume,
-      viewRef.cameraFocalPoint,
-      viewRef.viewPlaneNormal
-    );
-    return viewRef;
-  }
-  /**
-   * Reset the viewport properties to the default values
-   *
-
-   * @param volumeId - Optional volume ID to specify which volume properties to reset.
-   * If not provided, it will reset the properties of the default actor.
-   *
-   * @returns void
-   */
-  public resetProperties(volumeId?: string): void {
-    this._resetProperties(volumeId);
-  }
-
-  private _resetProperties(volumeId?: string) {
-    // Get the actor based on the volumeId if provided, otherwise use the default actor.
-    const volumeActor = volumeId
-      ? this.getActor(volumeId)
-      : this.getDefaultActor();
-
-    if (!volumeActor) {
-      throw new Error(`No actor found for the given volumeId: ${volumeId}`);
-    }
-
-    // if a custom slabThickness was set, we need to reset it
-    if (volumeActor.slabThickness) {
-      volumeActor.slabThickness = RENDERING_DEFAULTS.MINIMUM_SLAB_THICKNESS;
-      this.viewportProperties.slabThickness = undefined;
-      this.updateClippingPlanesForActors(this.getCamera());
-    }
-
-    const imageVolume = cache.getVolume(volumeActor.uid);
-    if (!imageVolume) {
-      throw new Error(
-        `imageVolume with id: ${volumeActor.uid} does not exist in cache`
-      );
-    }
-    setDefaultVolumeVOI(volumeActor.actor as vtkVolume, imageVolume, false);
-
-    if (isImageActor(volumeActor)) {
-      const transferFunction = (volumeActor.actor as ImageActor)
-        .getProperty()
-        .getRGBTransferFunction(0);
-
-      setTransferFunctionNodes(
-        transferFunction,
-        this.initialTransferFunctionNodes
-      );
-    }
-
-    const eventDetails = {
-      ...super.getVOIModifiedEventDetail(volumeId),
-    };
-
-    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);
-  }
-
-  /**
-   * Retrieves the clipping planes for the slices in the volume viewport.
-   * @returns An array of vtkPlane objects representing the clipping planes, or an array of objects with normal and origin properties if raw is true.
-   */
-  getSlicesClippingPlanes(): Array<{
-    sliceIndex: number;
-    planes: Array<{
-      normal: Point3;
-      origin: Point3;
-    }>;
-  }> {
-    const focalPoints = this.getSlicePlaneCoordinates();
-    const { viewPlaneNormal } = this.getCamera();
-    const slabThickness = RENDERING_DEFAULTS.MINIMUM_SLAB_THICKNESS;
-
-    return focalPoints.map(({ point, sliceIndex }) => {
-      const vtkPlanes = [vtkPlane.newInstance(), vtkPlane.newInstance()];
-
-      this.setOrientationOfClippingPlanes(
-        vtkPlanes,
-        slabThickness,
-        viewPlaneNormal,
-        point
-      );
-
-      return {
-        sliceIndex,
-        planes: vtkPlanes.map((plane) => ({
-          normal: plane.getNormal(),
-          origin: plane.getOrigin(),
-        })),
-      };
-    });
-  }
-
-  /**
-   * Returns an array of 3D coordinates representing the slice plane positions.
-   * It starts by the focal point as a reference point on the current slice that
-   * the camera is looking at, and then it calculates the slice plane positions
-   * by moving the focal point in the direction of the view plane normal back and
-   * forward, and snaps them to the slice.
-   *
-   * @returns An array of Point3 representing the slice plane coordinates.
-   */
-  public getSlicePlaneCoordinates = (): Array<{
-    sliceIndex: number;
-    point: Point3;
-  }> => {
-    const actorEntry = this.getDefaultActor();
-
-    if (!actorEntry?.actor) {
-      console.warn('No image data found for calculating vtkPlanes.');
-      return [];
-    }
-
-    const volumeId = actorEntry.uid;
-    const imageVolume = cache.getVolume(volumeId);
-
-    const camera = this.getCamera();
-    const { focalPoint, position, viewPlaneNormal } = camera;
-    const spacingInNormalDirection = getSpacingInNormalDirection(
-      imageVolume,
-      viewPlaneNormal
-    );
-    const sliceRange = getSliceRange(
-      actorEntry.actor as vtkVolume,
-      viewPlaneNormal,
-      focalPoint
-    );
-
-    // calculate the number of slices that is possible to visit
-    // in the direction of the view back and forward
-    const numSlicesBackward = Math.round(
-      (sliceRange.current - sliceRange.min) / spacingInNormalDirection
-    );
-
-    const numSlicesForward = Math.round(
-      (sliceRange.max - sliceRange.current) / spacingInNormalDirection
-    );
-
-    const currentSliceIndex = this.getSliceIndex();
-    const focalPoints = [];
-
-    for (let i = -numSlicesBackward; i <= numSlicesForward; i++) {
-      const { newFocalPoint: point } = snapFocalPointToSlice(
-        focalPoint,
-        position,
-        sliceRange,
-        viewPlaneNormal,
-        spacingInNormalDirection,
-        i
-      );
-
-      focalPoints.push({ sliceIndex: currentSliceIndex + i, point });
-    }
-
-    return focalPoints;
-  };
-}
-
-export default VolumeViewport;

package/src/RenderingEngine/VolumeViewport3D.ts

@@ -1,73 +0,0 @@
-import { BlendModes, OrientationAxis } from '../enums';
-import type { ViewportInput } from '../types/IViewport';
-import BaseVolumeViewport from './BaseVolumeViewport';
-
-/**
- * An object representing a 3-dimensional volume viewport. VolumeViewport3Ds are used to render
- * 3D volumes in their entirety, and not just load a single slice at a time.
- *
- * For setting volumes on viewports you need to use {@link addVolumesToViewports}
- * which will add volumes to the specified viewports.
- */
-class VolumeViewport3D extends BaseVolumeViewport {
-  constructor(props: ViewportInput) {
-    super(props);
-
-    const { parallelProjection, orientation } = this.options;
-
-    const activeCamera = this.getVtkActiveCamera();
-
-    if (parallelProjection != null) {
-      activeCamera.setParallelProjection(parallelProjection);
-    }
-
-    if (orientation && orientation !== OrientationAxis.ACQUISITION) {
-      this.applyViewOrientation(orientation);
-    }
-  }
-
-  public resetCamera(
-    resetPan = true,
-    resetZoom = true,
-    resetToCenter = true
-  ): boolean {
-    super.resetCamera(resetPan, resetZoom, resetToCenter);
-    this.resetVolumeViewportClippingRange();
-    return;
-  }
-
-  getRotation = (): number => 0;
-
-  getCurrentImageIdIndex = (): number | undefined => {
-    return undefined;
-  };
-
-  getCurrentImageId = (): string => {
-    return null;
-  };
-
-  setSlabThickness(
-    slabThickness: number,
-    filterActorUIDs?: Array<string>
-  ): void {
-    return null;
-  }
-
-  setBlendMode(
-    blendMode: BlendModes,
-    filterActorUIDs?: string[],
-    immediate?: boolean
-  ): void {
-    return null;
-  }
-
-  resetProperties(volumeId?: string): void {
-    return null;
-  }
-
-  resetSlabThickness(): void {
-    return null;
-  }
-}
-
-export default VolumeViewport3D;