@kitware/vtk.js/Widgets/Widgets3D/ResliceCursorWidget.d.ts

Visualization Toolkit for the Web

import { mat4 } from 'gl-matrix';
import {
  vtkAbstractWidgetFactory,
  IAbstractWidgetFactoryInitialValues,
} from './../Core/AbstractWidgetFactory';
import { vtkResliceCursorWidgetDefaultInstance } from './ResliceCursorWidget/behavior';
import { vtkAbstractWidget } from './../Core/AbstractWidget';
import { vtkImageData } from './../../Common/DataModel/ImageData';
import { vtkImageReslice } from './../../Imaging/Core/ImageReslice';
import { vtkPlaneSource } from './../../Filters/Sources/PlaneSource';
import { vtkRenderer } from './../../Rendering/Core/Renderer';
import { vtkPlaneManipulator } from './../Manipulators/PlaneManipulator';
import { ViewTypes } from './../Core/WidgetManager/Constants';
import { Vector2, Vector3 } from './../../types';
import { IDisplayScaleParams } from './../Core/WidgetManager';

export interface vtkResliceCursorWidget<
  WidgetInstance extends vtkAbstractWidget = vtkResliceCursorWidgetDefaultInstance
> extends vtkAbstractWidgetFactory<WidgetInstance> {
  /**
   * @param {ViewTypes} viewType
   */
  getRepresentationsForViewType(viewType: ViewTypes): unknown;

  setImage(image: vtkImageData): void;

  setCenter(center: Vector3): void;

  updateCameraPoints(
    renderer: vtkRenderer,
    viewType: ViewTypes,
    resetFocalPoint: boolean,
    computeFocalPointOffset: boolean
  ): void;

  resetCamera(
    renderer: vtkRenderer,
    viewType: ViewTypes,
    resetFocalPoint: boolean,
    keepCenterFocalDistance: boolean
  ): void;

  getPlaneSource(viewType: ViewTypes): vtkPlaneSource;

  getResliceAxes(viewType: ViewTypes): mat4;

  updateReslicePlane(
    imageReslice: vtkImageReslice,
    viewType: ViewTypes
  ): boolean;

  getPlaneSourceFromViewType(type: ViewTypes): vtkPlaneSource;

  getPlaneNormalFromViewType(viewType: ViewTypes): Vector3;

  getOtherPlaneNormals(viewType: ViewTypes): Array<Vector3>;

  getResliceMatrix(): mat4;

  getDisplayScaleParams(): IDisplayScaleParams;

  setScaleInPixels(scale: boolean): boolean;

  getScaleInPixels(): boolean;

  setHoleWidth(holeWidth: number): boolean;

  getHoleWidth(): number;

  /**
   * Defines the length of the line
   * The scaling of each line representation always define the dimensions of the circle / elipse (X and Y axes)
   * The unit of this scaling is either in world coordinates or in pixels depending in scaleInPixels
   * When the line is finite, this scaling on the Z axis also defines the length of the line
   * When the line is infinite, the scaling on the Z axis is automatically huge
   * @param infiniteLine
   */
  setInfiniteLine(infiniteLine: boolean): boolean;

  getInfiniteLine(): boolean;

  setRotationHandlePosition(position: number): boolean;

  getRotationHandlePosition(): number;

  setManipulator(manipulator: vtkPlaneManipulator): boolean;

  getManipulator(): vtkPlaneManipulator;

  /**
   * Return an array of the first and the last possible points of the plane
   * along its normal.
   * @param {ViewTypes} viewType
   * @returns {Array<Vector3>} two Vector3 arrays (first and last points)
   */
  getPlaneExtremities(viewType: ViewTypes): Array<Vector3>;
}

export interface IResliceCursorWidgetInitialValues<
  WidgetInstance extends vtkAbstractWidget
> extends IAbstractWidgetFactoryInitialValues<WidgetInstance> {}

/**
 * Method used to decorate a given object (publicAPI+model) with vtkResliceCursorWidget characteristics.
 *
 * @param publicAPI object on which methods will be bounds (public)
 * @param model object on which data structure will be bounds (protected)
 * @param initialValues (default: {})
 */
export function extend<WidgetInstance extends vtkAbstractWidget>(
  publicAPI: object,
  model: object,
  initialValues?: IResliceCursorWidgetInitialValues<WidgetInstance>
): void;

/**
 * Method used to create a new instance of vtkResliceCursorWidget
 *
 * @param initialValues for pre-setting some of its content
 */
export function newInstance<
  WidgetInstance extends vtkAbstractWidget = vtkResliceCursorWidgetDefaultInstance
>(
  initialValues?: IResliceCursorWidgetInitialValues<WidgetInstance>
): vtkResliceCursorWidget<WidgetInstance>;

export declare const vtkResliceCursorWidget: {
  newInstance: typeof newInstance;
  extend: typeof extend;
};

export default vtkResliceCursorWidget;