@kitware/vtk.js 23.4.2 → 23.4.4

package/Interaction/Style/InteractorStyleManipulator.d.ts

@@ -0,0 +1,348 @@
+import vtkCompositeGestureManipulator from './../Manipulators/CompositeGestureManipulator';
+import vtkCompositeKeyboardManipulator from './../Manipulators/CompositeKeyboardManipulator';
+import vtkCompositeMouseManipulator from './../Manipulators/CompositeMouseManipulator';
+import vtkCompositeVRManipulator from './../Manipulators/CompositeVRManipulator';
+import vtkInteractorStyle from './../../Rendering/Core/InteractorStyle';
+import {
+  Device,
+  Input,
+} from './../../Rendering/Core/RenderWindowInteractor/Constants';
+import { Nullable, Vector3 } from './../../types';
+
+export interface vtkInteractorStyleManipulator extends vtkInteractorStyle {
+  /**
+   * Remove all manipulators.
+   */
+  removeAllManipulators(): void;
+
+  /**
+   * Remove mouse manipulators.
+   */
+  removeAllMouseManipulators(): void;
+
+  /**
+   * Remove keyboard manipulators.
+   */
+  removeAllKeyboardManipulators(): void;
+
+  /**
+   * Remove VR manipulators.
+   */
+  removeAllVRManipulators(): void;
+
+  /**
+   * Remove gesture manipulators.
+   */
+  removeAllGestureManipulators(): void;
+
+  /**
+   * Adds a mouse manipulator.
+   * @param manipulator the manipulator to add
+   * @returns whether the manipulator has been added
+   */
+  addMouseManipulator(manipulator: vtkCompositeMouseManipulator): boolean;
+
+  /**
+   * Adds a keyboard manipulator.
+   * @param manipulator the manipulator to add
+   * @returns whether the manipulator has been added
+   */
+  addKeyboardManipulator(manipulator: vtkCompositeKeyboardManipulator): boolean;
+
+  /**
+   * Adds a VR manipulator.
+   * @param manipulator the manipulator to add
+   * @returns whether the manipulator has been added
+   */
+  addVRManipulator(manipulator: vtkCompositeVRManipulator): boolean;
+
+  /**
+   * Adds a gesture manipulator.
+   * @param manipulator the manipulator to add
+   * @returns whether the manipulator has been added
+   */
+  addGestureManipulator(manipulator: vtkCompositeGestureManipulator): boolean;
+
+  /**
+   * Removes a mouse manipulator.
+   * @param manipulator the manipulator to remove
+   */
+  removeMouseManipulator(manipulator: vtkCompositeMouseManipulator): void;
+
+  /**
+   * Removes a keyboard manipulator.
+   * @param manipulator the manipulator to remove
+   */
+  removeKeyboardManipulator(manipulator: vtkCompositeKeyboardManipulator): void;
+
+  /**
+   * Removes a VR manipulator.
+   * @param manipulator the manipulator to remove
+   */
+  removeVRManipulator(manipulator: vtkCompositeVRManipulator): void;
+
+  /**
+   * Removes a gesture manipulator.
+   * @param manipulator the manipulator to remove
+   */
+  removeGestureManipulator(manipulator: vtkCompositeGestureManipulator): void;
+
+  /**
+   * Gets the number of mouse manipulators.
+   */
+  getNumberOfMouseManipulators(): number;
+
+  /**
+   * Gets the number of keyboard manipulators.
+   */
+  getNumberOfKeyboardManipulators(): number;
+
+  /**
+   * Gets the number of VR manipulators.
+   */
+  getNumberOfVRManipulators(): number;
+
+  /**
+   * Gets the number of gesture manipulators.
+   */
+  getNumberOfGestureManipulators(): number;
+
+  /**
+   * Resets/clears the current manipulator.
+   */
+  resetCurrentManipulator(): void;
+
+  /**
+   * Finds a mouse manipulator with a given control set.
+   * @param button which button
+   * @param shift shift enabled
+   * @param scroll scroll enabled
+   * @param alt alt enabled
+   */
+  findMouseManipulator(
+    button: number,
+    shift: boolean,
+    scroll: boolean,
+    alt: boolean
+  ): Nullable<vtkCompositeMouseManipulator>;
+
+  /**
+   * Finds a VR manipulator with a given device + input.
+   * @param device
+   * @param input
+   */
+  findVRManipulator(
+    device: Device,
+    input: Input
+  ): Nullable<vtkCompositeVRManipulator>;
+
+  /**
+   * Handles a left button press event.
+   * @param callData event data
+   */
+  handleLeftButtonPress(callData: unknown): void;
+
+  /**
+   * Handles a middle button press event.
+   * @param callData event data
+   */
+  handleMiddleButtonPress(callData: unknown): void;
+
+  /**
+   * Handles a right button press event.
+   * @param callData event data
+   */
+  handleRightButtonPress(callData: unknown): void;
+
+  /**
+   * Handles a left button release event.
+   * @param callData event data
+   */
+  handleLeftButtonRelease(callData: unknown): void;
+
+  /**
+   * Handles a middle button release event.
+   * @param callData event data
+   */
+  handleMiddleButtonRelease(callData: unknown): void;
+
+  /**
+   * Handles a right button release event.
+   * @param callData event data
+   */
+  handleRightButtonRelease(callData: unknown): void;
+
+  /**
+   * Handles the start of a wheel event.
+   * @param callData event data
+   */
+  handleStartMouseWheel(callData: unknown): void;
+
+  /**
+   * Handles a wheel event.
+   * @param callData event data
+   */
+  handleMouseWheel(callData: unknown): void;
+
+  /**
+   * Handles the end of a wheel event.
+   * @param callData event data
+   */
+  handleEndMouseWheel(callData: unknown): void;
+
+  /**
+   * Handles a mouse move.
+   * @param callData event data
+   */
+  handleMouseMove(callData: unknown): void;
+
+  /**
+   * Handles a 3D button event.
+   * @param callData event data
+   */
+  handleButton3D(ed: unknown): void;
+
+  /**
+   * Handles a 3D move event.
+   * @param ed event data
+   */
+  handleMove3D(ed: unknown): void;
+
+  /**
+   * Handles a keypress.
+   * @param callData event data
+   */
+  handleKeyPress(callData: unknown): void;
+
+  /**
+   * Handles a keydown event.
+   * @param callData event data
+   */
+  handleKeyDown(callData: unknown): void;
+
+  /**
+   * Handles a keyup event.
+   * @param callData event data
+   */
+  handleKeyUp(callData: unknown): void;
+
+  /**
+   * Handles the start of a pinch gesture.
+   * @param callData event data
+   */
+  handleStartPinch(callData: unknown): void;
+
+  /**
+   * Handles the end of a pinch gesture.
+   * @param callData event data
+   */
+  handleEndPinch(callData: unknown): void;
+
+  /**
+   * Handles the start of a rotate gesture.
+   * @param callData event data
+   */
+  handleStartRotate(callData: unknown): void;
+
+  /**
+   * Handles the end of a rotate gesture.
+   * @param callData event data
+   */
+  handleEndRotate(callData: unknown): void;
+
+  /**
+   * Handles the start of a pan gesture.
+   * @param callData event data
+   */
+  handleStartPan(callData: unknown): void;
+
+  /**
+   * Handles the end of a pan gesture.
+   * @param callData event data
+   */
+  handleEndPan(callData: unknown): void;
+
+  /**
+   * Handles a pinch gesture.
+   * @param callData event data
+   */
+  handlePinch(callData: unknown): void;
+
+  /**
+   * Handles a rotate gesture.
+   * @param callData event data
+   */
+  handleRotate(callData: unknown): void;
+
+  /**
+   * Handles a pan gesture.
+   * @param callData event data
+   */
+  handlePan(callData: unknown): void;
+
+  /**
+   * Handles a button down event.
+   * @param button which button
+   * @param callData event data
+   */
+  onButtonDown(button: number, callData: unknown): void;
+
+  /**
+   * Handles a button up event.
+   * @param button which button
+   */
+  onButtonUp(button: number): void;
+
+  /**
+   * Sets the rotation factor.
+   * @param factor rotation factor
+   */
+  setRotationFactor(factor: number): boolean;
+
+  /**
+   * Gets the rotation factor.
+   */
+  getRotationFactor(): number;
+
+  getMouseManipulators(): vtkCompositeMouseManipulator[];
+  getMouseManipulators(): vtkCompositeMouseManipulator[];
+  getMouseManipulators(): vtkCompositeMouseManipulator[];
+  getMouseManipulators(): vtkCompositeMouseManipulator[];
+
+  /**
+   * Sets the center of rotation
+   * @param {Number} x
+   * @param {Number} y
+   * @param {Number} z
+   */
+  setCenterOfRotation(x: number, y: number, z: number): boolean;
+  setCenterOfRotation(xyz: Vector3): boolean;
+
+  /**
+   * Gets the center of rotation.
+   * @returns {Vector3}
+   */
+  getCenterOfRotation(): Vector3;
+}
+
+export interface IInteractorStyleManipulatorInitialValues {
+  centerOfRotation?: Vector3;
+  rotationFactor?: number;
+}
+
+export function newInstance(
+  initialValues?: IInteractorStyleManipulatorInitialValues
+): vtkInteractorStyleManipulator;
+
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IInteractorStyleManipulatorInitialValues
+): void;
+
+export const vtkInteractorStyleManipulator: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
+
+export default vtkInteractorStyleManipulator;

package/Interaction/Style/InteractorStyleTrackballCamera.d.ts

@@ -0,0 +1,170 @@
+import vtkInteractorStyle from './../../Rendering/Core/InteractorStyle';
+import vtkRenderer from './../../Rendering/Core/Renderer';
+
+export interface vtkInteractorStyleTrackballCamera extends vtkInteractorStyle {
+  /**
+   * Handles a mouse move.
+   * @param callData event data
+   */
+  handleMouseMove(callData: unknown): void;
+
+  /**
+   * Handles a 3D button event.
+   * @param callData event data
+   */
+  handleButton3D(ed: unknown): void;
+
+  /**
+   * Handles a 3D move event.
+   * @param ed event data
+   */
+  handleMove3D(ed: unknown): void;
+
+  /**
+   * Update camera pose
+   * @param ed event data
+   */
+  updateCameraPose(ed: unknown): void;
+
+  /**
+   * Handles a left button press event.
+   * @param callData event data
+   */
+  handleLeftButtonPress(callData: unknown): void;
+
+  /**
+   * Handles a left button release event.
+   * @param callData event data
+   */
+  handleLeftButtonRelease(callData: unknown): void;
+
+  /**
+   * Handles the start of a wheel event.
+   * @param callData event data
+   */
+  handleStartMouseWheel(callData: unknown): void;
+
+  /**
+   * Handles the end of a wheel event.
+   * @param callData event data
+   */
+  handleEndMouseWheel(callData: unknown): void;
+
+  /**
+   * Handles the start of a pinch gesture.
+   * @param callData event data
+   */
+  handleStartPinch(callData: unknown): void;
+
+  /**
+   * Handles the end of a pinch gesture.
+   * @param callData event data
+   */
+  handleEndPinch(callData: unknown): void;
+
+  /**
+   * Handles the start of a rotate gesture.
+   * @param callData event data
+   */
+  handleStartRotate(callData: unknown): void;
+
+  /**
+   * Handles the end of a rotate gesture.
+   * @param callData event data
+   */
+  handleEndRotate(callData: unknown): void;
+
+  /**
+   * Handles the start of a pan gesture.
+   * @param callData event data
+   */
+  handleStartPan(callData: unknown): void;
+
+  /**
+   * Handles the end of a pan gesture.
+   * @param callData event data
+   */
+  handleEndPan(callData: unknown): void;
+
+  /**
+   * Handles a pinch gesture.
+   * @param callData event data
+   */
+  handlePinch(callData: unknown): void;
+
+  /**
+   * Handles a pan gesture.
+   * @param callData event data
+   */
+  handlePan(callData: unknown): void;
+
+  /**
+   * Handles a rotate gesture.
+   * @param callData event data
+   */
+  handleRotate(callData: unknown): void;
+
+  /**
+   * Handles rotate with a mouse.
+   * @param renderer the renderer
+   * @param position the display position
+   */
+  handleMouseRotate(renderer: vtkRenderer, position: { x: number, y: number }): void;
+
+  /**
+   * Handles spin with a mouse.
+   * @param renderer the renderer
+   * @param position the display position
+   */
+  handleMouseSpin(renderer: vtkRenderer, position: { x: number, y: number }): void;
+
+  /**
+   * Handles pan with a mouse.
+   * @param renderer the renderer
+   * @param position the display position
+   */
+  handleMousePan(renderer: vtkRenderer, position: { x: number, y: number }): void;
+
+  /**
+   * Handles dolly with a mouse.
+   * @param renderer the renderer
+   * @param position the display position
+   */
+  handleMouseDolly(renderer: vtkRenderer, position: { x: number, y: number }): void;
+
+  /**
+   * Handles a wheel event.
+   * @param callData event data
+   */
+  handleMouseWheel(callData: unknown): void;
+
+  /**
+   * Dolly by factor.
+   * @param renderer the renderer
+   * @param factor factor
+   */
+  dollyByFactor(renderer: vtkRenderer, factor: number): void;
+}
+
+export interface IInteractorStyleTrackballCameraInitialValues {
+  motionFactor: number;
+  zoomFactor: number;
+}
+
+export function newInstance(
+  initialValues?: IInteractorStyleTrackballCameraInitialValues
+): vtkInteractorStyleTrackballCamera;
+
+
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IInteractorStyleTrackballCameraInitialValues
+): void;
+
+export const vtkInteractorStyleTrackballCamera: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+}
+
+export default vtkInteractorStyleTrackballCamera;

package/Interaction/Widgets/ImageCroppingRegionsWidget.js

@@ -1,7 +1,7 @@
 import _toConsumableArray from '@babel/runtime/helpers/toConsumableArray';
 import _defineProperty from '@babel/runtime/helpers/defineProperty';
 import macro from '../../macros.js';
-import { l as normalize, d as dot, g as subtract, B as projectVector, k as add } from '../../Common/Core/Math/index.js';
+import { g as normalize, d as dot, j as subtract, B as projectVector, l as add } from '../../Common/Core/Math/index.js';
 import vtkPlane from '../../Common/DataModel/Plane.js';
 import vtkAbstractWidget from './AbstractWidget.js';
 import vtkImageCroppingRegionsRepresentation from './ImageCroppingRegionsRepresentation.js';

package/Interaction/Widgets/LabelRepresentation.js

@@ -2,7 +2,7 @@ import _defineProperty from '@babel/runtime/helpers/defineProperty';
 import macro from '../../macros.js';
 import vtkActor from '../../Rendering/Core/Actor.js';
 import vtkInteractorObserver from '../../Rendering/Core/InteractorObserver.js';
-import { g as subtract, k as add } from '../../Common/Core/Math/index.js';
+import { j as subtract, l as add } from '../../Common/Core/Math/index.js';
 import vtkPixelSpaceCallbackMapper from '../../Rendering/Core/PixelSpaceCallbackMapper.js';
 import vtkPointSource from '../../Filters/Sources/PointSource.js';
 import vtkHandleRepresentation from './HandleRepresentation.js';

package/Interaction/Widgets/OrientationMarkerWidget/Constants.d.ts

@@ -0,0 +1,11 @@
+export declare enum Corners {
+	TOP_LEFT = 'TOP_LEFT',
+	TOP_RIGHT = 'TOP_RIGHT',
+	BOTTOM_LEFT = 'BOTTOM_LEFT',
+	BOTTOM_RIGHT = 'BOTTOM_RIGHT',
+}
+
+declare const _default: {
+	Corners: typeof Corners;
+};
+export default _default;

package/Interaction/Widgets/ResliceCursor/ResliceCursor.js

@@ -1,7 +1,7 @@
 import _toConsumableArray from '@babel/runtime/helpers/toConsumableArray';
 import _defineProperty from '@babel/runtime/helpers/defineProperty';
 import macro from '../../../macros.js';
-import { j as cross, l as normalize, A as clampValue } from '../../../Common/Core/Math/index.js';
+import { k as cross, g as normalize, A as clampValue } from '../../../Common/Core/Math/index.js';
 import vtkPolyData from '../../../Common/DataModel/PolyData.js';
 import vtkPlane from '../../../Common/DataModel/Plane.js';
 import vtkCellArray from '../../../Common/Core/CellArray.js';

package/Interaction/Widgets/ResliceCursor/ResliceCursorLineRepresentation.js

@@ -2,7 +2,7 @@ import _toConsumableArray from '@babel/runtime/helpers/toConsumableArray';
 import macro from '../../../macros.js';
 import vtkInteractorObserver from '../../../Rendering/Core/InteractorObserver.js';
 import vtkLine from '../../../Common/DataModel/Line.js';
-import { f as distance2BetweenPoints, l as normalize, d as dot, j as cross, u as uninitializeBounds } from '../../../Common/Core/Math/index.js';
+import { f as distance2BetweenPoints, g as normalize, d as dot, k as cross, u as uninitializeBounds } from '../../../Common/Core/Math/index.js';
 import vtkMatrixBuilder from '../../../Common/Core/MatrixBuilder.js';
 import vtkPlane from '../../../Common/DataModel/Plane.js';
 import vtkResliceCursorActor from './ResliceCursorActor.js';

package/Interaction/Widgets/ResliceCursor/ResliceCursorRepresentation.js

@@ -4,7 +4,7 @@ import { mat4, vec4 } from 'gl-matrix';
 import vtkImageMapper from '../../../Rendering/Core/ImageMapper.js';
 import vtkImageReslice from '../../../Imaging/Core/ImageReslice.js';
 import vtkImageSlice from '../../../Rendering/Core/ImageSlice.js';
-import { k as add, g as subtract, l as normalize } from '../../../Common/Core/Math/index.js';
+import { l as add, j as subtract, g as normalize } from '../../../Common/Core/Math/index.js';
 import vtkPlaneSource from '../../../Filters/Sources/PlaneSource.js';
 import vtkWidgetRepresentation from '../WidgetRepresentation.js';
 import { transformPlane, boundPlane } from '../../../Widgets/Widgets3D/ResliceCursorWidget/helpers.js';

package/Proxy/Core/AbstractRepresentationProxy.d.ts

@@ -0,0 +1,24 @@
+import { vtkObject } from './../../interfaces';
+import { VtkProxy } from './../../macros';
+import vtkSourceProxy from './SourceProxy';
+import vtkAbstractMapper from './../../Rendering/Core/AbstractMapper';
+import vtkActor from './../../Rendering/Core/Actor';
+import vtkVolume from './../../Rendering/Core/Volume';
+
+export interface vtkAbstractRepresentationProxy extends VtkProxy {
+  setInput<T>(source: vtkSourceProxy<T>): void;
+  getInputDataSet(): vtkObject | null;
+  setColorBy(
+    arrayName: string | null,
+    arrayLocation: string,
+    componentIndex?: number
+  );
+  setRescaleOnColorBy(rescale: boolean): boolean;
+  getRescaleOnColorBy(): boolean;
+  getInput(): VtkProxy;
+  getMapper(): vtkAbstractMapper;
+  getActors(): vtkActor[];
+  getVolumes(): vtkVolume[];
+}
+
+export default vtkAbstractRepresentationProxy;

package/Proxy/Core/LookupTableProxy.d.ts

@@ -0,0 +1,45 @@
+import { VtkProxy } from './../../macros';
+import vtkColorTransferFunction from './../../Rendering/Core/ColorTransferFunction';
+
+// [x, r/h, g/s, b/v, m=0.5, s=0.0]
+export type RGBHSVPoint = [number, number, number, number, number?, number?];
+
+export enum Mode {
+  Preset = 0,
+  RGBPoints = 1,
+  HSVPoints = 2,
+  Nodes = 3,
+}
+
+export interface vtkLookupTableProxy extends VtkProxy {
+  setPresetName(name: string): void;
+  getPresetName(): string;
+  setRGBPoints(points: RGBHSVPoint[]): void;
+  getRGBPoints(): RGBHSVPoint[];
+  setHSVPoints(points: RGBHSVPoint[]): void;
+  getHSVPoints(): RGBHSVPoint[];
+  // Node: { x, y, midpoint, sharpness }
+  setNodes(nodes: number[][]): void;
+  getNodes(nodes): number[][];
+  setMode(mode: number): void;
+  getMode(): number;
+  applyMode(): void;
+  setDataRange(min: number, max: number): void;
+  getDataRange(): [number, number];
+  getLookupTable(): vtkColorTransferFunction;
+}
+
+export interface ILookupTableProxyInitialValues {
+  lookupTable?: vtkColorTransferFunction;
+}
+
+export function newInstance(
+  initialValues?: ILookupTableProxyInitialValues
+): vtkLookupTableProxy;
+
+export declare const vtkLookupTableProxy: {
+  newInstance: typeof newInstance;
+  Mode: Mode;
+};
+
+export default vtkLookupTableProxy;