@kitware/vtk.js 30.6.0 → 30.6.1

package/Rendering/SceneGraph/ViewNodeFactory.d.ts

@@ -1,17 +1,16 @@
 import { vtkObject } from './../../interfaces';
 
 /**
- * 
+ *
  */
 export interface IViewNodeFactoryInitialValues {}
 
 export interface vtkViewNodeFactory extends vtkObject {
-
-	/**
-	 * Creates and returns a vtkViewNode for the provided renderable.
-	 * @param dataObject 
-	 */
-	createNode(dataObject: any): void;
+  /**
+   * Creates and returns a vtkViewNode for the provided renderable.
+   * @param dataObject
+   */
+  createNode(dataObject: any): void;
 }
 
 /**
@@ -21,24 +20,30 @@ export interface vtkViewNodeFactory extends vtkObject {
  * @param model object on which data structure will be bounds (protected)
  * @param {IViewNodeFactoryInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IViewNodeFactoryInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IViewNodeFactoryInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkViewNodeFactory.
  * @param {IViewNodeFactoryInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: IViewNodeFactoryInitialValues): vtkViewNodeFactory;
+export function newInstance(
+  initialValues?: IViewNodeFactoryInitialValues
+): vtkViewNodeFactory;
 
 /**
  * factory that chooses vtkViewNodes to create
- * 
+ *
  * Class tells VTK which specific vtkViewNode subclass to make when it is asked
  * to make a vtkViewNode for a particular renderable. modules for different
  * rendering backends are expected to use this to customize the set of instances
  * for their own purposes
  */
 export declare const vtkViewNodeFactory: {
-	newInstance: typeof newInstance,
-	extend: typeof extend,
+  newInstance: typeof newInstance;
+  extend: typeof extend;
 };
 export default vtkViewNodeFactory;

package/Rendering/WebXR/RenderWindowHelper/Constants.d.ts

@@ -1,11 +1,11 @@
 export declare enum XrSessionTypes {
-	HmdVR = 0,
-	MobileAR = 1,
-  	LookingGlassVR = 2,
-	HmdAR = 3
+  HmdVR = 0,
+  MobileAR = 1,
+  LookingGlassVR = 2,
+  HmdAR = 3,
 }
 
 declare const _default: {
-	XrSessionTypes: typeof XrSessionTypes;
+  XrSessionTypes: typeof XrSessionTypes;
 };
 export default _default;

package/Rendering/WebXR/RenderWindowHelper.d.ts

@@ -6,61 +6,60 @@ import vtkOpenGLRenderWindow from './../OpenGL/RenderWindow';
  *
  */
 export interface IWebXRRenderWindowHelperInitialValues {
-    initialized: boolean,
-    initCanvasSize?: [number, number],
-    initBackground?: [number, number, number, number],
-    renderWindow?: Nullable<vtkOpenGLRenderWindow>,
-    xrSession?: Nullable<XRSession>,
-    xrSessionType: number,
-    xrReferenceSpace?: any,
+  initialized: boolean;
+  initCanvasSize?: [number, number];
+  initBackground?: [number, number, number, number];
+  renderWindow?: Nullable<vtkOpenGLRenderWindow>;
+  xrSession?: Nullable<XRSession>;
+  xrSessionType: number;
+  xrReferenceSpace?: any;
 }
 
 export interface vtkWebXRRenderWindowHelper extends vtkObject {
+  /**
+   * Initialize the instance.
+   */
+  initialize(): void;
 
-	/**
-     * Initialize the instance.
-	 */
-	initialize(): void;
+  /**
+   * Request an XR session on the user device with WebXR,
+   * typically in response to a user request such as a button press.
+   */
+  startXR(xrSessionType: Number): void;
 
-	/**
-	 * Request an XR session on the user device with WebXR,
-     * typically in response to a user request such as a button press.
-	 */
-	startXR(xrSessionType: Number): void;
+  /**
+   * When an XR session is available, set up the XRWebGLLayer
+   * and request the first animation frame for the device
+   */
+  enterXR(): void;
 
-    /**
-     * When an XR session is available, set up the XRWebGLLayer
-     * and request the first animation frame for the device
-     */
-    enterXR(): void;
+  /**
+   * Adjust world-to-physical parameters for different viewing modalities
+   *
+   * @param {Number} inputRescaleFactor
+   * @param {Number} inputTranslateZ
+   */
+  resetXRScene(inputRescaleFactor: number, inputTranslateZ: number): void;
 
-    /**
-     * Adjust world-to-physical parameters for different viewing modalities
-     *
-     * @param {Number} inputRescaleFactor
-     * @param {Number} inputTranslateZ
-     */
-    resetXRScene(inputRescaleFactor: number, inputTranslateZ: number): void;
+  /**
+   * Request to stop the current XR session
+   */
+  stopXR(): void;
 
-	/**
-	 * Request to stop the current XR session
-	 */
-	stopXR(): void;
+  /**
+   * Get the underlying render window to drive XR rendering.
+   */
+  getRenderWindow(): Nullable<vtkOpenGLRenderWindow>;
 
-    /**
-     * Get the underlying render window to drive XR rendering.
-     */
-    getRenderWindow(): Nullable<vtkOpenGLRenderWindow>;
+  /**
+   * Set the underlying render window to drive XR rendering.
+   */
+  setRenderWindow(renderWindow: Nullable<vtkOpenGLRenderWindow>);
 
-    /**
-     * Set the underlying render window to drive XR rendering.
-     */
-    setRenderWindow(renderWindow:Nullable<vtkOpenGLRenderWindow>);
-
-    /**
-     * Get the active WebXR session.
-     */
-    getXrSession(): Nullable<XRSession>;
+  /**
+   * Get the active WebXR session.
+   */
+  getXrSession(): Nullable<XRSession>;
 }
 
 /**
@@ -70,13 +69,19 @@ export interface vtkWebXRRenderWindowHelper extends vtkObject {
  * @param model object on which data structure will be bounds (protected)
  * @param {IWebXRRenderWindowHelperInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IWebXRRenderWindowHelperInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IWebXRRenderWindowHelperInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkWebXRRenderWindowHelper.
  * @param {IWebXRRenderWindowHelperInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: IWebXRRenderWindowHelperInitialValues): vtkWebXRRenderWindowHelper;
+export function newInstance(
+  initialValues?: IWebXRRenderWindowHelperInitialValues
+): vtkWebXRRenderWindowHelper;
 
 /**
  * WebXR rendering helper
@@ -84,7 +89,7 @@ export function newInstance(initialValues?: IWebXRRenderWindowHelperInitialValue
  * vtkWebXRRenderWindowHelper is designed to wrap a vtkRenderWindow for XR rendering.
  */
 export declare const vtkWebXRRenderWindowHelper: {
-	newInstance: typeof newInstance,
-	extend: typeof extend,
+  newInstance: typeof newInstance;
+  extend: typeof extend;
 };
 export default vtkWebXRRenderWindowHelper;

package/Widgets/Core/AbstractWidget.d.ts

@@ -22,12 +22,12 @@ export interface vtkAbstractWidget extends vtkProp, vtkInteractorObserver {
   /**
    * Activate a handle, identified by both a state and a representation.
    * Will also invoke appropriate events.
-   * 
+   *
    * @param locator An object describing the handle to activate.
    */
-  activateHandle(locator: { 
-    selectedState: vtkWidgetState; 
-    representation: vtkWidgetRepresentation; 
+  activateHandle(locator: {
+    selectedState: vtkWidgetState;
+    representation: vtkWidgetRepresentation;
   }): void;
 
   /**
@@ -37,7 +37,7 @@ export interface vtkAbstractWidget extends vtkProp, vtkInteractorObserver {
 
   /**
    * Returns true if the widget instance holds the given actor, false otherwise.
-   * 
+   *
    * @param {vtkProp} actor
    */
   hasActor(actor: vtkProp): boolean;
@@ -61,7 +61,7 @@ export interface vtkAbstractWidget extends vtkProp, vtkInteractorObserver {
 
   /**
    * Place a widget at the given bounds.
-   * 
+   *
    * @param {Bounds} bounds
    */
   placeWidget(bounds: Bounds): void;
@@ -73,22 +73,22 @@ export interface vtkAbstractWidget extends vtkProp, vtkInteractorObserver {
 
   /**
    * Set the place factor.
-   * 
+   *
    * @param {Number} factor The place factor.
    */
   setPlaceFactor(factor: number): void;
 
   /**
    * Get the `vtkWidgetRepresentation` instance associated with the given `vtkActor` instance.
-   * 
-   * @param {vtkProp} actor 
+   *
+   * @param {vtkProp} actor
    */
   getRepresentationFromActor(actor: vtkProp): vtkWidgetRepresentation;
 
   /**
    * Update all the widget representations for render.
-   * 
-   * @param {RenderingTypes} renderingType Default value if `RenderingTypes.FRONT_BUFFER` 
+   *
+   * @param {RenderingTypes} renderingType Default value if `RenderingTypes.FRONT_BUFFER`
    */
   updateRepresentationForRender(renderingType: RenderingTypes): void;
 
@@ -97,11 +97,10 @@ export interface vtkAbstractWidget extends vtkProp, vtkInteractorObserver {
    */
   getViewWidgets(): vtkAbstractWidget[];
 
-
   /**
    * Set the context visibility.
-   * 
-   * @param {Boolean} visible 
+   *
+   * @param {Boolean} visible
    */
   setContextVisibility(visible: boolean): void;
 
@@ -112,8 +111,8 @@ export interface vtkAbstractWidget extends vtkProp, vtkInteractorObserver {
 
   /**
    * Defines if the handles should be visible or not.
-   * 
-   * @param {Boolean} visible 
+   *
+   * @param {Boolean} visible
    */
   setHandleVisibility(visible: boolean): void;
 
@@ -124,7 +123,7 @@ export interface vtkAbstractWidget extends vtkProp, vtkInteractorObserver {
 
   /**
    * Set the widget manager associated with the widget instance.
-   * 
+   *
    * @param {vtkWidgetManager} wm The widget manager instance
    */
   setWidgetManager(wm: vtkWidgetManager): void;
@@ -146,15 +145,18 @@ export interface vtkAbstractWidget extends vtkProp, vtkInteractorObserver {
 
   /**
    * Register a callback to be invoked when the `ActivateHandle` event occurs.
-   * 
+   *
    * @param {EventHandler} cb The callback to register
    * @param {Number} [priority] Priority of this subscription
    */
-  onActivateHandle(cb: EventHandler, priority?: number): Readonly<vtkSubscription>;
+  onActivateHandle(
+    cb: EventHandler,
+    priority?: number
+  ): Readonly<vtkSubscription>;
 
   /**
    * Invoke the `ActivateHandle` event with the given payload.
-   * 
+   *
    * @param args The event payload
    */
   invokeActivateHandle(...args: unknown[]): void;
@@ -167,11 +169,15 @@ export interface vtkAbstractWidget extends vtkProp, vtkInteractorObserver {
  * @param model object on which data structure will be bounds (protected)
  * @param initialValues (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues? : object): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: object
+): void;
 
 /**
  * Method used to create a new instance of vtkAbstractWidget
- * 
+ *
  * @param initialValues For pre-setting some of its content
  */
 export function newInstance(initialValues?: object): vtkAbstractWidget;
@@ -180,8 +186,8 @@ export function newInstance(initialValues?: object): vtkAbstractWidget;
  * vtkAbstractWidget is an abstract class to construct a widget.
  */
 export declare const vtkAbstractWidget: {
-	newInstance: typeof newInstance,
-	extend: typeof extend,
+  newInstance: typeof newInstance;
+  extend: typeof extend;
 };
 
 export default vtkAbstractWidget;

package/Widgets/Core/AbstractWidgetFactory.d.ts

@@ -12,12 +12,14 @@ export interface IGetWidgetForViewParams {
   initialValues?: object;
 }
 
-export interface vtkAbstractWidgetFactory<WidgetInstance extends vtkAbstractWidget> extends vtkObject {
+export interface vtkAbstractWidgetFactory<
+  WidgetInstance extends vtkAbstractWidget
+> extends vtkObject {
   /**
-   * Will return the widget associated with the view with Id id `locator.viewId`. 
+   * Will return the widget associated with the view with Id id `locator.viewId`.
    * If there is no widget associated with the view, a new widget will be constructed, provided
    * that the renderer, viewType, and optionally initialValues are also provided.
-   * 
+   *
    * @param {IGetWidgetForViewParams} locator
    */
   getWidgetForView(locator: IGetWidgetForViewParams): Nullable<WidgetInstance>;
@@ -34,43 +36,43 @@ export interface vtkAbstractWidgetFactory<WidgetInstance extends vtkAbstractWidg
 
   /**
    * Set the visiblity on each underlying view widget.
-   * 
+   *
    * @param {Boolean} visible
    */
-  setVisibility(visible: boolean): void 
+  setVisibility(visible: boolean): void;
 
   /**
    * Set the pickable flag for each underlying view widget.
-   * 
-   * @param {Boolean} pickable 
+   *
+   * @param {Boolean} pickable
    */
-  setPickable(pickable: boolean): void
+  setPickable(pickable: boolean): void;
 
   /**
    * Set the dragable flag for each underlying view widget.
-   * 
-   * @param {Boolean} dragable 
+   *
+   * @param {Boolean} dragable
    */
-  setDragable(dragable: boolean): void
+  setDragable(dragable: boolean): void;
 
   /**
    * Set the context visibility for each associated view widget.
-   * 
-   * @param {Boolean} visible 
+   *
+   * @param {Boolean} visible
    */
-  setContextVisibility(visible: boolean): void
+  setContextVisibility(visible: boolean): void;
 
   /**
    * Set the handles visibility for each underlying view widget.
-   * 
-   * @param {Boolean} visible 
+   *
+   * @param {Boolean} visible
    */
-  setHandleVisiblity(visible: boolean): void
+  setHandleVisiblity(visible: boolean): void;
 
   /**
    * Place a new widget at the given bounds.
-   * 
-   * @param {Bounds} bounds 
+   *
+   * @param {Bounds} bounds
    */
   placeWidget(bounds: Bounds): void;
 
@@ -81,8 +83,8 @@ export interface vtkAbstractWidgetFactory<WidgetInstance extends vtkAbstractWidg
 
   /**
    * Set the place factor.
-   * 
-   * @param {Number} factor 
+   *
+   * @param {Number} factor
    */
   setPlaceFactor(factor: number): void;
 
@@ -93,15 +95,18 @@ export interface vtkAbstractWidgetFactory<WidgetInstance extends vtkAbstractWidg
 
   /**
    * Register a callback to be called when the WidgetChange event arise.
-   * 
+   *
    * @param {EventHandler} cb The callback to be invoked.
    * @param {Number} [priority] The priority of this subscription
    */
-  onWidgetChangeEvent(cb: EventHandler, priority?: number): Readonly<vtkSubscription>;
+  onWidgetChangeEvent(
+    cb: EventHandler,
+    priority?: number
+  ): Readonly<vtkSubscription>;
 
   /**
    * Invoke the WidgetChange event
-   * 
+   *
    * @param args The event payload
    */
   invokeWidgetChangeEvent(...args: unknown[]): void;
@@ -112,7 +117,7 @@ export interface vtkAbstractWidgetFactory<WidgetInstance extends vtkAbstractWidg
  * This is because typescript is completely "structural" and doesn't have any way to declare "nominal" types
  * See: https://github.com/microsoft/TypeScript/issues/202
  * For example, in this code, widgetInstance is a vtkResliceCursorWidgetCPRInstance:
- * 
+ *
  * import vtkResliceCursorWidget from '@kitware/vtk.js/Widgets/Widgets3D/ResliceCursorWidget';
  * import widgetBehavior from '@kitware/vtk.js/Widgets/Widgets3D/ResliceCursorWidget/cprBehavior';
  *
@@ -123,9 +128,14 @@ export interface vtkAbstractWidgetFactory<WidgetInstance extends vtkAbstractWidg
  * const widgetInstance = widgetManager.addWidget(widget);
  */
 declare const ExtendSymbol: unique symbol;
-export type ExtendWidgetBehavior<WidgetInstance> = ((publicAPI: object, model: object) => void) & { [ExtendSymbol]: WidgetInstance };
-
-export interface IAbstractWidgetFactoryInitialValues<WidgetInstance extends vtkAbstractWidget = vtkAbstractWidget> {
+export type ExtendWidgetBehavior<WidgetInstance> = ((
+  publicAPI: object,
+  model: object
+) => void) & { [ExtendSymbol]: WidgetInstance };
+
+export interface IAbstractWidgetFactoryInitialValues<
+  WidgetInstance extends vtkAbstractWidget = vtkAbstractWidget
+> {
   behavior?: ExtendWidgetBehavior<WidgetInstance>;
 }
 
@@ -136,18 +146,28 @@ export interface IAbstractWidgetFactoryInitialValues<WidgetInstance extends vtkA
  * @param model object on which data structure will be bounds (protected)
  * @param initialValues (default: {})
  */
-export function extend<WidgetInstance extends vtkAbstractWidget = vtkAbstractWidget>(publicAPI: object, model: object, initialValues?: IAbstractWidgetFactoryInitialValues<WidgetInstance>): void;
+export function extend<
+  WidgetInstance extends vtkAbstractWidget = vtkAbstractWidget
+>(
+  publicAPI: object,
+  model: object,
+  initialValues?: IAbstractWidgetFactoryInitialValues<WidgetInstance>
+): void;
 
 /**
  * Method used to create a new instance of vtkAbstractWidgetFactory
- * 
+ *
  * @param initialValues for pre-setting some of its content
  */
-export function newInstance<WidgetInstance extends vtkAbstractWidget = vtkAbstractWidget>(initialValues?: IAbstractWidgetFactoryInitialValues<WidgetInstance>): vtkAbstractWidgetFactory<WidgetInstance>;
+export function newInstance<
+  WidgetInstance extends vtkAbstractWidget = vtkAbstractWidget
+>(
+  initialValues?: IAbstractWidgetFactoryInitialValues<WidgetInstance>
+): vtkAbstractWidgetFactory<WidgetInstance>;
 
 export declare const vtkAbstractWidgetFactory: {
-	newInstance: typeof newInstance,
-	extend: typeof extend,
+  newInstance: typeof newInstance;
+  extend: typeof extend;
 };
 
 export default vtkAbstractWidgetFactory;

package/Widgets/Core/WidgetManager/Constants.d.ts

@@ -5,23 +5,23 @@ export declare enum ViewTypes {
   VOLUME = 3,
   YZ_PLANE = 4,
   XZ_PLANE = 5,
-  XY_PLANE = 6
+  XY_PLANE = 6,
 }
 
 export declare enum RenderingTypes {
   PICKING_BUFFER = 0,
-  FRONT_BUFFER = 1
+  FRONT_BUFFER = 1,
 }
 
 export declare enum CaptureOn {
   MOUSE_MOVE = 0,
-  MOUSE_RELEASE = 1
+  MOUSE_RELEASE = 1,
 }
 
 declare const _default: {
   ViewTypes: typeof ViewTypes;
   RenderingTypes: typeof RenderingTypes;
   CaptureOn: typeof CaptureOn;
-}
+};
 
 export default _default;

package/Widgets/Core/WidgetManager.d.ts

@@ -32,10 +32,12 @@ export interface IRenderingComponents {
 
 /**
  * Extract the rendering components from the given renderer.
- * 
+ *
  * @param {vtkRenderer} renderer The vtkRenderer instance.
  */
-export function extractRenderingComponents(renderer: vtkRenderer): IRenderingComponents;
+export function extractRenderingComponents(
+  renderer: vtkRenderer
+): IRenderingComponents;
 
 /**
  * This method returns the world distance that corresponds to the height of a
@@ -47,10 +49,10 @@ export function getPixelWorldHeightAtCoord(coord: []): Number;
 
 export interface vtkWidgetManager extends vtkObject {
   /**
-   * The the captureOn value. 
+   * The the captureOn value.
    * `CaptureOn.MOUSE_MOVE`: captures small region when moving mouse
    * `CaptureOn.MOUSE_RELEASE`: captures entire region when mouse button is released
-   * 
+   *
    * @param {CaptureOn} captureOn
    */
   setCaptureOn(captureOn: CaptureOn): boolean;
@@ -62,7 +64,7 @@ export interface vtkWidgetManager extends vtkObject {
 
   /**
    * The the view type.
-   * 
+   *
    * @param {ViewTypes} type
    */
   setViewType(type: ViewTypes): boolean;
@@ -116,15 +118,15 @@ export interface vtkWidgetManager extends vtkObject {
 
   /**
    * Set the renderer.
-   * 
+   *
    * @param {vtkRenderer} renderer
    */
   setRenderer(renderer: vtkRenderer): void;
 
   /**
-   * Register a widget on the widget manager instance. 
-   * Please note that one should link the widget manager to a view before calling this method. 
-   * 
+   * Register a widget on the widget manager instance.
+   * Please note that one should link the widget manager to a view before calling this method.
+   *
    * @param {vtkAbstractWidgetFactory} widget The abstract widget factory.
    * @param {ViewTypes} [viewType]
    * @param {Object} [initialValues]
@@ -133,7 +135,9 @@ export interface vtkWidgetManager extends vtkObject {
     widget: WidgetFactory,
     viewType?: ViewTypes,
     initialValues?: object
-  ): WidgetFactory extends vtkAbstractWidgetFactory<infer WidgetInstance> ? WidgetInstance : never;
+  ): WidgetFactory extends vtkAbstractWidgetFactory<infer WidgetInstance>
+    ? WidgetInstance
+    : never;
 
   /**
    * Unregister all widgets from the widget manager.
@@ -142,14 +146,14 @@ export interface vtkWidgetManager extends vtkObject {
 
   /**
    * Remove a widget from the widget manager.
-   * 
+   *
    * @param {vtkAbstractWidget | vtkAbstractWidgetFactory} widget The widget to remove
    */
   removeWidget(widget: vtkAbstractWidget | vtkAbstractWidgetFactory<any>): void;
 
   /**
    * Given x and y parameter, get selected data.
-   * 
+   *
    * @param {Number} x
    * @param {Number} y
    */
@@ -162,7 +166,7 @@ export interface vtkWidgetManager extends vtkObject {
 
   /**
    * Given the focus to the given widget instance.
-   * 
+   *
    * @param {vtkAbstractWidget | vtkAbstractWidgetFactory} widget The widget instance which should get the focus.
    */
   grabFocus(widget: vtkAbstractWidget | vtkAbstractWidgetFactory<any>): void;
@@ -211,10 +215,12 @@ export function extend(
 
 /**
  * Method used to create a new instance of vtkCellArray
- * 
+ *
  * @param initialValues for pre-setting some of its content
  */
-export function newInstance(initialValues?: IWidgetManagerInitialValues): vtkWidgetManager;
+export function newInstance(
+  initialValues?: IWidgetManagerInitialValues
+): vtkWidgetManager;
 
 export declare const vtkWidgetManager: {
   newInstance: typeof newInstance;