@kitware/vtk.js 26.3.2 → 26.4.1

package/Interaction/Manipulators/CompositeMouseManipulator.d.ts

@@ -0,0 +1,149 @@
+import vtkRenderer from './../../Rendering/Core/Renderer';
+import vtkRenderWindowInteractor from './../../Rendering/Core/RenderWindowInteractor';
+
+export interface vtkCompositeMouseManipulator {
+  /**
+   * Starts an interaction event.
+   */
+  startInteraction(): void;
+
+  /**
+   * Ends an interaction event.
+   */
+  endInteraction(): void;
+
+  /**
+   * Handles a button down event.
+   * @param interactor the interactor
+   * @param renderer the renderer
+   * @param position the display position
+   */
+  onButtonDown(
+    interactor: vtkRenderWindowInteractor,
+    renderer: vtkRenderer,
+    position: { x: number; y: number }
+  ): void;
+
+  /**
+   * Handles a button up event.
+   * @param interactor the interactor
+   */
+  onButtonUp(interactor: vtkRenderWindowInteractor): void;
+
+  /**
+   * Handles a mouse move event.
+   * @param interactor the interactor
+   * @param renderer the renderer
+   * @param position the display position
+   */
+  onMouseMove(
+    interactor: vtkRenderWindowInteractor,
+    renderer: vtkRenderer,
+    position: { x: number; y: number }
+  ): void;
+
+  /**
+   * Handles a start scroll event.
+   * @param interactor the interactor
+   * @param renderer the renderer
+   * @param delta the scroll delta
+   */
+  onStartScroll(
+    interactor: vtkRenderWindowInteractor,
+    renderer: vtkRenderer,
+    delta: number
+  ): void;
+
+  /**
+   * Handles a scroll event.
+   * @param interactor the interactor
+   */
+  onEndScroll(interactor: vtkRenderWindowInteractor): void;
+
+  /**
+   * Is drag enabled.
+   */
+  isDragEnabled(): boolean;
+
+  /**
+   * Sets if drag is enabled.
+   * @param enabled
+   */
+  setDragEnabled(enabled: boolean): boolean;
+
+  /**
+   * Is scroll enabled.
+   */
+  isScrollEnabled(): boolean;
+
+  /**
+   * Sets if scroll is enabled.
+   * @param enabled
+   */
+  setScrollEnabled(enabled: boolean): boolean;
+
+  /**
+   * Sets the associated button.
+   * @param btn
+   */
+  setButton(btn: number): boolean;
+
+  /**
+   * Gets the associated button.
+   */
+  getButton(): number;
+
+  /**
+   * Sets if the shift key is required.
+   * @param shift
+   */
+  setShift(shift: boolean): boolean;
+
+  /**
+   * Gets flag if shift key is required.
+   */
+  getShift(): boolean;
+
+  /**
+   * Sets if the control key is required.
+   * @param ctrl
+   */
+  setControl(ctrl: boolean): boolean;
+
+  /**
+   * Gets flag if control key is required.
+   */
+  getControl(): boolean;
+
+  /**
+   * Sets if the alt key is required.
+   * @param alt
+   */
+  setAlt(alt: boolean): boolean;
+
+  /**
+   * Gets flag if alt key is required.
+   */
+  getAlt(): boolean;
+}
+
+export interface ICompositeMouseManipulatorInitialValues {
+  button?: number;
+  shift?: boolean;
+  control?: boolean;
+  alt?: boolean;
+  dragEnabled?: boolean;
+  scrollEnabled?: boolean;
+}
+
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: ICompositeMouseManipulatorInitialValues
+): void;
+
+export const vtkCompositeMouseManipulator: {
+  extend: typeof extend;
+};
+
+export default vtkCompositeMouseManipulator;

package/Interaction/Manipulators/CompositeVRManipulator.d.ts

@@ -0,0 +1,44 @@
+import { States } from './../../Rendering/Core/InteractorStyle/Constants';
+import vtkRenderer from './../../Rendering/Core/Renderer';
+import vtkRenderWindowInteractor from './../../Rendering/Core/RenderWindowInteractor';
+import {
+  Device,
+  Input,
+} from './../../Rendering/Core/RenderWindowInteractor/Constants';
+
+export interface vtkCompositeVRManipulator {
+  onButton3D(
+    interactor: vtkRenderWindowInteractor,
+    renderer: vtkRenderer,
+    state: States,
+    device: Device,
+    input: Input,
+    pressed: boolean
+  ): void;
+
+  onMove3D(
+    interactor: vtkRenderWindowInteractor,
+    renderer: vtkRenderer,
+    state: States,
+    device: Device,
+    input: Input,
+    pressed: boolean
+  ): void;
+}
+
+export interface ICompositeVRManipulatorInitialValues {
+  device?: Device;
+  input?: Input;
+}
+
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: ICompositeVRManipulatorInitialValues
+): void;
+
+export const vtkCompositeVRManipulator: {
+  extend: typeof extend;
+};
+
+export default vtkCompositeVRManipulator;

package/Interaction/Manipulators/GestureCameraManipulator.d.ts

@@ -0,0 +1,34 @@
+import vtkCompositeCameraManipulator, {
+  ICompositeCameraManipulatorInitialValues,
+} from './CompositeCameraManipulator';
+import vtkCompositeGestureManipulator, {
+  ICompositeGestureManipulatorInitialValues,
+} from './CompositeGestureManipulator';
+import { vtkObject } from './../../interfaces';
+export interface vtkGestureCameraManipulator
+  extends vtkObject,
+    vtkCompositeCameraManipulator,
+    vtkCompositeGestureManipulator {}
+
+export interface IGestureCameraManipulatorInitialValues
+  extends ICompositeCameraManipulatorInitialValues,
+    ICompositeGestureManipulatorInitialValues {
+  flipDirection?: boolean;
+}
+
+export function newInstance(
+  initialValues?: IGestureCameraManipulatorInitialValues
+): vtkGestureCameraManipulator;
+
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IGestureCameraManipulatorInitialValues
+): void;
+
+export const vtkGestureCameraManipulator: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
+
+export default vtkGestureCameraManipulator;

package/Interaction/Manipulators/MouseBoxSelectorManipulator.d.ts

@@ -0,0 +1,88 @@
+import vtkCompositeMouseManipulator, {
+  ICompositeMouseManipulatorInitialValues,
+} from './CompositeMouseManipulator';
+import { EventHandler, vtkObject, vtkSubscription } from './../../interfaces';
+import { Nullable } from './../../types';
+
+export interface vtkMouseBoxSelectorManipulator
+  extends vtkObject,
+    vtkCompositeMouseManipulator {
+  /**
+   * Invokes a box select change event.
+   */
+  invokeBoxSelectChange(data: unknown): void;
+
+  /**
+   * Registers a callback when a box select change event occurs.
+   * @param cb EventHandler
+   */
+  onBoxSelectChange(cb: EventHandler): vtkSubscription;
+
+  /**
+   * Invokes a box select input event.
+   */
+  invokeBoxSelectInput(data: unknown): void;
+
+  /**
+   * Registers a callback when a box select input event occurs.
+   * @param cb EventHandler
+   */
+  onBoxSelectInput(cb: EventHandler): vtkSubscription;
+
+  /**
+   * Sets whether to render the selection.
+   * @param render
+   */
+  setRenderSelection(render: boolean): boolean;
+
+  /**
+   * Get whether to render the selection.
+   */
+  getRenderSelection(): boolean;
+
+  /**
+   * Sets the selection box style.
+   * @param style
+   */
+  setSelectionStyle(style: Record<string, string>): boolean;
+
+  /**
+   * Gets the selection box style.
+   */
+  getSelectionStyle(): Record<string, string>;
+
+  /**
+   * Sets the box container.
+   * @param container
+   */
+  setContainer(container: Element): boolean;
+
+  /**
+   * Gets the box container.
+   */
+  getContainer(): Nullable<Element>;
+}
+
+export interface IMouseBoxSelectorManipulatorInitialValues
+  extends ICompositeMouseManipulatorInitialValues {
+  renderSelection?: boolean;
+  selectionStyle?: Record<string, string>;
+  container?: Element;
+}
+
+export function newInstance(
+  initialValues?: IMouseBoxSelectorManipulatorInitialValues
+): vtkMouseBoxSelectorManipulator;
+
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IMouseBoxSelectorManipulatorInitialValues
+): void;
+
+export const vtkMouseBoxSelectorManipulator: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
+
+export default vtkMouseBoxSelectorManipulator;

package/Interaction/Manipulators/MouseCameraTrackballMultiRotateManipulator.d.ts

@@ -0,0 +1,32 @@
+import vtkCompositeCameraManipulator, {
+  ICompositeCameraManipulatorInitialValues,
+} from './CompositeCameraManipulator';
+import vtkCompositeMouseManipulator, {
+  ICompositeMouseManipulatorInitialValues,
+} from './CompositeMouseManipulator';
+import { vtkObject } from './../../interfaces';
+export interface vtkMouseCameraTrackballMultiRotateManipulator
+  extends vtkObject,
+    vtkCompositeCameraManipulator,
+    vtkCompositeMouseManipulator {}
+
+export interface IMouseCameraTrackballMultiRotateManipulatorInitialValues
+  extends ICompositeCameraManipulatorInitialValues,
+    ICompositeMouseManipulatorInitialValues {}
+
+export function newInstance(
+  initialValues?: IMouseCameraTrackballMultiRotateManipulatorInitialValues
+): vtkMouseCameraTrackballMultiRotateManipulator;
+
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IMouseCameraTrackballMultiRotateManipulatorInitialValues
+): void;
+
+export const vtkMouseCameraTrackballMultiRotateManipulator: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
+
+export default vtkMouseCameraTrackballMultiRotateManipulator;

package/Interaction/Manipulators/MouseCameraTrackballPanManipulator.d.ts

@@ -0,0 +1,33 @@
+import vtkCompositeCameraManipulator, {
+  ICompositeCameraManipulatorInitialValues,
+} from './CompositeCameraManipulator';
+import vtkCompositeMouseManipulator, {
+  ICompositeMouseManipulatorInitialValues,
+} from './CompositeMouseManipulator';
+import { vtkObject } from './../../interfaces';
+
+export interface vtkMouseCameraTrackballPanManipulator
+  extends vtkObject,
+    vtkCompositeCameraManipulator,
+    vtkCompositeMouseManipulator {}
+
+export interface IMouseCameraTrackballPanManipulatorInitialValues
+  extends ICompositeCameraManipulatorInitialValues,
+    ICompositeMouseManipulatorInitialValues {}
+
+export function newInstance(
+  initialValues?: IMouseCameraTrackballPanManipulatorInitialValues
+): vtkMouseCameraTrackballPanManipulator;
+
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IMouseCameraTrackballPanManipulatorInitialValues
+): void;
+
+export const vtkMouseCameraTrackballPanManipulator: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
+
+export default vtkMouseCameraTrackballPanManipulator;

package/Interaction/Manipulators/MouseCameraTrackballRollManipulator.d.ts

@@ -0,0 +1,33 @@
+import vtkCompositeCameraManipulator, {
+  ICompositeCameraManipulatorInitialValues,
+} from './CompositeCameraManipulator';
+import vtkCompositeMouseManipulator, {
+  ICompositeMouseManipulatorInitialValues,
+} from './CompositeMouseManipulator';
+import { vtkObject } from './../../interfaces';
+
+export interface vtkMouseCameraTrackballRollManipulator
+  extends vtkObject,
+    vtkCompositeCameraManipulator,
+    vtkCompositeMouseManipulator {}
+
+export interface IMouseCameraTrackballRollManipulatorInitialValues
+  extends ICompositeCameraManipulatorInitialValues,
+    ICompositeMouseManipulatorInitialValues {}
+
+export function newInstance(
+  initialValues?: IMouseCameraTrackballRollManipulatorInitialValues
+): vtkMouseCameraTrackballRollManipulator;
+
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IMouseCameraTrackballRollManipulatorInitialValues
+): void;
+
+export const vtkMouseCameraTrackballRollManipulator: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
+
+export default vtkMouseCameraTrackballRollManipulator;

package/Interaction/Manipulators/MouseCameraTrackballRotateManipulator.d.ts

@@ -0,0 +1,67 @@
+import vtkCompositeCameraManipulator, {
+  ICompositeCameraManipulatorInitialValues,
+} from './CompositeCameraManipulator';
+import vtkCompositeMouseManipulator, {
+  ICompositeMouseManipulatorInitialValues,
+} from './CompositeMouseManipulator';
+import { vtkObject } from './../../interfaces';
+import { Vector3 } from './../../types';
+
+export interface vtkMouseCameraTrackballRotateManipulator
+  extends vtkObject,
+    vtkCompositeCameraManipulator,
+    vtkCompositeMouseManipulator {
+  /**
+   * Sets whether to use a given world-up vector.
+   * @param use boolean
+   */
+  setUseWorldUpVec(use: boolean): boolean;
+
+  /**
+   * Sets the world-up vector.
+   * @param vec the world-up vector
+   */
+  setWorldUpVec(vec: Vector3): boolean;
+  setWorldUpVec(x: number, y: number, z: number): boolean;
+
+  /**
+   * Gets the world-up vector.
+   */
+  getWorldUpVec(): Vector3;
+
+  /**
+   * Gets whether to use the focal point as the center of rotation.
+   */
+  getUseFocalPointAsCenterOfRotation(): boolean;
+
+  /**
+   * Sets using the focal point as the center of rotation.
+   * @param useFocalPoint
+   */
+  setUseFocalPointAsCenterOfRotation(useFocalPoint: boolean): boolean;
+}
+
+export interface IMouseCameraTrackballRotateManipulatorInitialValues
+  extends ICompositeCameraManipulatorInitialValues,
+    ICompositeMouseManipulatorInitialValues {
+  useWorldUpVec?: boolean;
+  worldUpVec?: Vector3;
+  useFocalPointAsCenterOfRotation?: boolean;
+}
+
+export function newInstance(
+  initialValues?: IMouseCameraTrackballRotateManipulatorInitialValues
+): vtkMouseCameraTrackballRotateManipulator;
+
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IMouseCameraTrackballRotateManipulatorInitialValues
+): void;
+
+export const vtkMouseCameraTrackballRotateManipulator: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
+
+export default vtkMouseCameraTrackballRotateManipulator;

package/Interaction/Manipulators/MouseCameraTrackballZoomManipulator.d.ts

@@ -0,0 +1,45 @@
+import vtkCompositeCameraManipulator, {
+  ICompositeCameraManipulatorInitialValues,
+} from './CompositeCameraManipulator';
+import vtkCompositeMouseManipulator, {
+  ICompositeMouseManipulatorInitialValues,
+} from './CompositeMouseManipulator';
+import { vtkObject } from './../../interfaces';
+export interface vtkMouseCameraTrackballZoomManipulator
+  extends vtkObject,
+    vtkCompositeCameraManipulator,
+    vtkCompositeMouseManipulator {
+  /**
+   * Sets whether to flip the zoom direction.
+   * @param flip
+   */
+  setFlipDirection(flip: boolean): boolean;
+
+  /**
+   * Gets the flip direction.
+   */
+  getFlipDirection(): boolean;
+}
+
+export interface IMouseCameraTrackballZoomManipulatorInitialValues
+  extends ICompositeCameraManipulatorInitialValues,
+    ICompositeMouseManipulatorInitialValues {
+  flipDirection?: boolean;
+}
+
+export function newInstance(
+  initialValues?: IMouseCameraTrackballZoomManipulatorInitialValues
+): vtkMouseCameraTrackballZoomManipulator;
+
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IMouseCameraTrackballZoomManipulatorInitialValues
+): void;
+
+export const vtkMouseCameraTrackballZoomManipulator: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
+
+export default vtkMouseCameraTrackballZoomManipulator;

package/Interaction/Manipulators/MouseCameraTrackballZoomToMouseManipulator.d.ts

@@ -0,0 +1,26 @@
+import vtkMouseCameraTrackballZoomManipulator, {
+  IMouseCameraTrackballZoomManipulatorInitialValues,
+} from './MouseCameraTrackballZoomManipulator';
+
+export type vtkMouseCameraTrackballZoomToMouseManipulator =
+  vtkMouseCameraTrackballZoomManipulator;
+
+export type IMouseCameraTrackballZoomToMouseManipulatorInitialValues =
+  IMouseCameraTrackballZoomManipulatorInitialValues;
+
+export function newInstance(
+  initialValues?: IMouseCameraTrackballZoomToMouseManipulatorInitialValues
+): vtkMouseCameraTrackballZoomToMouseManipulator;
+
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IMouseCameraTrackballZoomToMouseManipulatorInitialValues
+): void;
+
+export const vtkMouseCameraTrackballZoomToMouseManipulator: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
+
+export default vtkMouseCameraTrackballZoomToMouseManipulator;

package/Interaction/Manipulators/MouseRangeManipulator.d.ts

@@ -0,0 +1,53 @@
+import vtkCompositeMouseManipulator, {
+  ICompositeMouseManipulatorInitialValues,
+} from './CompositeMouseManipulator';
+
+export interface IMouseRangeManipulatorInitialValues
+  extends ICompositeMouseManipulatorInitialValues {}
+
+export interface vtkMouseRangeManipulator extends vtkCompositeMouseManipulator {
+  setHorizontalListener(
+    min: number,
+    max: number,
+    step: number,
+    getValue: () => number,
+    setValue: (v: number) => void,
+    scale?: number
+  );
+  setVerticalListener(
+    min: number,
+    max: number,
+    step: number,
+    getValue: () => number,
+    setValue: (v: number) => void,
+    scale?: number
+  );
+  setScrollListener(
+    min: number,
+    max: number,
+    step: number,
+    getValue: () => number,
+    setValue: (v: number) => void,
+    scale?: number
+  );
+  removeHorizontalListener();
+  removeVerticalListener();
+  removeScrollListener();
+  removeAllListeners();
+}
+
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IMouseRangeManipulatorInitialValues
+): void;
+export function newInstance(
+  initialValues?: IMouseRangeManipulatorInitialValues
+): vtkMouseRangeManipulator;
+
+export declare const vtkMouseRangeManipulator: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
+
+export default vtkMouseRangeManipulator;