@kitware/vtk.js 30.5.3 → 30.6.1

package/Rendering/Core/Viewport.d.ts

@@ -1,227 +1,228 @@
-
 import { vtkObject } from './../../interfaces';
 import { RGBColor, Size } from './../../types';
 import vtkActor2D from './Actor2D';
 import vtkProp from './Prop';
 
 export interface IViewportInitialValues {
-    background?: RGBColor;
-    background2?: RGBColor;
-    gradientBackground?: boolean;
-    viewport?: number[];
-    aspect?: number[];
-    pixelAspect?: number[];
-    props?: vtkProp[];
-    actors2D?: vtkActor2D[];
+  background?: RGBColor;
+  background2?: RGBColor;
+  gradientBackground?: boolean;
+  viewport?: number[];
+  aspect?: number[];
+  pixelAspect?: number[];
+  props?: vtkProp[];
+  actors2D?: vtkActor2D[];
 }
 
 export interface vtkViewport extends vtkObject {
-
-    /**
-     * Adds a 2D actor to the scene.
-     * @param prop
-     */
-    addActor2D(prop: vtkActor2D): void;
-
-    /**
-     * Add a prop to the list of props.
-     * @param prop 
-     */
-    addViewProp(prop: vtkProp): void;
-
-    /**
-     * Convert display coordinates to view coordinates.
-     */
-    displayToView(): any;
-
-    /**
-     * 
-     */
-    getActors2D(): vtkActor2D[];
-
-    /**
-     * 
-     */
-    getBackground2(): number[];
-
-    /**
-    * 
-    */
-    getBackground2ByReference(): number[];
-
-    /**
-     * 
-     */
-    getBackground(): number[];
-
-    /**
-     * 
-     */
-    getBackgroundByReference(): number[];
-
-    /**
-     * 
-     */
-    getSize(): Size;
-
-    /**
-     * 
-     */
-    getViewport(): vtkViewport;
-
-    /**
-     * 
-     */
-    getViewportByReference(): vtkViewport;
-
-    /**
-     * 
-     */
-    getViewPropsWithNestedProps(): any;
-
-    /**
-     * 
-     */
-    getViewProps(): vtkProp[];
-
-    /**
-     * 
-     * @param prop 
-     */
-    hasViewProp(prop: vtkProp): boolean;
-
-    /**
-     * 
-	 * @param {Number} x The x coordinate.
-	 * @param {Number} y The y coordinate.
-	 * @param {Number} z The z coordinate.
-     */
-    normalizedDisplayToProjection(x: number, y: number, z: number): number[];
-
-    /**
-     * 
-	 * @param {Number} x The x coordinate.
-	 * @param {Number} y The y coordinate.
-	 * @param {Number} z The z coordinate.
-     */
-    normalizedDisplayToNormalizedViewport(x: number, y: number, z: number): any;
-
-    /**
-     * 
-	 * @param {Number} x The x coordinate.
-	 * @param {Number} y The y coordinate.
-	 * @param {Number} z The z coordinate.
-     */
-    normalizedViewportToProjection(x: number, y: number, z: any): number[];
-
-    /**
-     * 
-	 * @param {Number} x The x coordinate.
-	 * @param {Number} y The y coordinate.
-	 * @param {Number} z The z coordinate.
-     */
-    projectionToNormalizedDisplay(x: number, y: number, z: number): number[];
-
-    /**
-     * 
-	 * @param {Number} x The x coordinate.
-	 * @param {Number} y The y coordinate.
-	 * @param {Number} z The z coordinate.
-     */
-    normalizedViewportToNormalizedDisplay(x: number, y: number, z: number): number[];
-
-    /**
-     * Set the viewport background.
-     * @param {Number} r Defines the red component (between 0 and 1).
-     * @param {Number} g Defines the green component (between 0 and 1).
-     * @param {Number} b Defines the blue component (between 0 and 1).
-     */
-    setBackground(r: number, g: number, b: number): boolean;
-
-    /**
-     * Set the viewport background.
-     * @param {Number[]} background The RGB color array. 
-     */
-    setBackground(background: number[]): boolean;
-
-    /**
-     * 
-     * @param {Number} r Defines the red component (between 0 and 1).
-     * @param {Number} g Defines the green component (between 0 and 1).
-     * @param {Number} b Defines the blue component (between 0 and 1).
-     */
-    setBackground2(r: number, g: number, b: number): boolean;
-
-    /**
-     * 
-     * @param {Number[]} background 
-     */
-    setBackground2(background: number[]): boolean;
-
-    /**
-     * 
-     * @param {Number[]} background 
-     */
-    setBackground2From(background: number[]): boolean;
-
-    /**
-     * 
-     * @param {Number[]} background 
-     */
-    setBackgroundFrom(background: number[]): boolean;
-
-    /**
-     * Specify the viewport for the Viewport to draw in the rendering window.
-     * Each coordinate is 0 <= coordinate <= 1.0.
-     * @param {Number} xmin The xmin coordinate.
-     * @param {Number} ymin The ymin coordinate.
-     * @param {Number} xmax The xmax coordinate.
-     * @param {Number} ymax The ymax coordinate.
-     */
-    setViewport(xmin: number, ymin: number, xmax: number, ymax: number): boolean;
-
-    /**
-     * Specify the viewport for the Viewport to draw in the rendering window.
-     * Coordinates are expressed as [xmin, ymin, xmax, ymax], where each coordinate is 0 <= coordinate <= 1.0.
-     * @param {Number[]} viewport 
-     */
-    setViewportFrom(viewport: number[]): boolean;
-
-    /**
-     * 
-     * @param prop 
-     */
-    removeViewProp(prop: vtkProp): void;
-
-    /**
-     * 
-     */
-    removeAllViewProps(): void;
-
-    /**
-     * 
-     * @param prop 
-     */
-    removeActor2D(prop: vtkProp): void;
-
-    /**
-     * 
-     */
-    viewToDisplay(): any;
-
-    /**
-     * 
-	 * @param {Number} x The x coordinate.
-	 * @param {Number} y The y coordinate.
-	 * @param {Number} z The z coordinate.
-     */
-    projectionToNormalizedViewport(x: number, y: number, z: number): number[];
-
-
-    /**
-     * Not Implemented yet
-     */
-    PickPropFrom(): any;
+  /**
+   * Adds a 2D actor to the scene.
+   * @param prop
+   */
+  addActor2D(prop: vtkActor2D): void;
+
+  /**
+   * Add a prop to the list of props.
+   * @param prop
+   */
+  addViewProp(prop: vtkProp): void;
+
+  /**
+   * Convert display coordinates to view coordinates.
+   */
+  displayToView(): any;
+
+  /**
+   *
+   */
+  getActors2D(): vtkActor2D[];
+
+  /**
+   *
+   */
+  getBackground2(): number[];
+
+  /**
+   *
+   */
+  getBackground2ByReference(): number[];
+
+  /**
+   *
+   */
+  getBackground(): number[];
+
+  /**
+   *
+   */
+  getBackgroundByReference(): number[];
+
+  /**
+   *
+   */
+  getSize(): Size;
+
+  /**
+   *
+   */
+  getViewport(): vtkViewport;
+
+  /**
+   *
+   */
+  getViewportByReference(): vtkViewport;
+
+  /**
+   *
+   */
+  getViewPropsWithNestedProps(): any;
+
+  /**
+   *
+   */
+  getViewProps(): vtkProp[];
+
+  /**
+   *
+   * @param prop
+   */
+  hasViewProp(prop: vtkProp): boolean;
+
+  /**
+   *
+   * @param {Number} x The x coordinate.
+   * @param {Number} y The y coordinate.
+   * @param {Number} z The z coordinate.
+   */
+  normalizedDisplayToProjection(x: number, y: number, z: number): number[];
+
+  /**
+   *
+   * @param {Number} x The x coordinate.
+   * @param {Number} y The y coordinate.
+   * @param {Number} z The z coordinate.
+   */
+  normalizedDisplayToNormalizedViewport(x: number, y: number, z: number): any;
+
+  /**
+   *
+   * @param {Number} x The x coordinate.
+   * @param {Number} y The y coordinate.
+   * @param {Number} z The z coordinate.
+   */
+  normalizedViewportToProjection(x: number, y: number, z: any): number[];
+
+  /**
+   *
+   * @param {Number} x The x coordinate.
+   * @param {Number} y The y coordinate.
+   * @param {Number} z The z coordinate.
+   */
+  projectionToNormalizedDisplay(x: number, y: number, z: number): number[];
+
+  /**
+   *
+   * @param {Number} x The x coordinate.
+   * @param {Number} y The y coordinate.
+   * @param {Number} z The z coordinate.
+   */
+  normalizedViewportToNormalizedDisplay(
+    x: number,
+    y: number,
+    z: number
+  ): number[];
+
+  /**
+   * Set the viewport background.
+   * @param {Number} r Defines the red component (between 0 and 1).
+   * @param {Number} g Defines the green component (between 0 and 1).
+   * @param {Number} b Defines the blue component (between 0 and 1).
+   */
+  setBackground(r: number, g: number, b: number): boolean;
+
+  /**
+   * Set the viewport background.
+   * @param {Number[]} background The RGB color array.
+   */
+  setBackground(background: number[]): boolean;
+
+  /**
+   *
+   * @param {Number} r Defines the red component (between 0 and 1).
+   * @param {Number} g Defines the green component (between 0 and 1).
+   * @param {Number} b Defines the blue component (between 0 and 1).
+   */
+  setBackground2(r: number, g: number, b: number): boolean;
+
+  /**
+   *
+   * @param {Number[]} background
+   */
+  setBackground2(background: number[]): boolean;
+
+  /**
+   *
+   * @param {Number[]} background
+   */
+  setBackground2From(background: number[]): boolean;
+
+  /**
+   *
+   * @param {Number[]} background
+   */
+  setBackgroundFrom(background: number[]): boolean;
+
+  /**
+   * Specify the viewport for the Viewport to draw in the rendering window.
+   * Each coordinate is 0 <= coordinate <= 1.0.
+   * @param {Number} xmin The xmin coordinate.
+   * @param {Number} ymin The ymin coordinate.
+   * @param {Number} xmax The xmax coordinate.
+   * @param {Number} ymax The ymax coordinate.
+   */
+  setViewport(xmin: number, ymin: number, xmax: number, ymax: number): boolean;
+
+  /**
+   * Specify the viewport for the Viewport to draw in the rendering window.
+   * Coordinates are expressed as [xmin, ymin, xmax, ymax], where each coordinate is 0 <= coordinate <= 1.0.
+   * @param {Number[]} viewport
+   */
+  setViewportFrom(viewport: number[]): boolean;
+
+  /**
+   *
+   * @param prop
+   */
+  removeViewProp(prop: vtkProp): void;
+
+  /**
+   *
+   */
+  removeAllViewProps(): void;
+
+  /**
+   *
+   * @param prop
+   */
+  removeActor2D(prop: vtkProp): void;
+
+  /**
+   *
+   */
+  viewToDisplay(): any;
+
+  /**
+   *
+   * @param {Number} x The x coordinate.
+   * @param {Number} y The y coordinate.
+   * @param {Number} z The z coordinate.
+   */
+  projectionToNormalizedViewport(x: number, y: number, z: number): number[];
+
+  /**
+   * Not Implemented yet
+   */
+  PickPropFrom(): any;
 }
 
 /**
@@ -231,19 +232,25 @@ export interface vtkViewport extends vtkObject {
  * @param model object on which data structure will be bounds (protected)
  * @param {IViewportInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IViewportInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IViewportInitialValues
+): void;
 
 /**
- * Method use to create a new instance of vtkViewport 
+ * Method use to create a new instance of vtkViewport
  */
-export function newInstance(initialValues?: IViewportInitialValues): vtkViewport;
+export function newInstance(
+  initialValues?: IViewportInitialValues
+): vtkViewport;
 
-/** 
+/**
  * vtkViewport represents part or all of a RenderWindow. It holds a
  * collection of props that will be rendered into the area it represents.
  * This class also contains methods to convert between coordinate systems
  * commonly used in rendering.
- * 
+ *
  * @see [vtkActor](./Rendering_Core_Actor.html)
  * @see [vtkCoordinate](./Rendering_Core_Coordinate.html)
  * @see [vtkProp](./Rendering_Core_Prop.html)
@@ -252,7 +259,7 @@ export function newInstance(initialValues?: IViewportInitialValues): vtkViewport
  * @see [vtkVolume](./Rendering_Core_Volume.html)
  */
 export declare const vtkViewport: {
-    newInstance: typeof newInstance,
-    extend: typeof extend,
+  newInstance: typeof newInstance;
+  extend: typeof extend;
 };
 export default vtkViewport;

package/Rendering/Core/Volume.d.ts

@@ -1,84 +1,85 @@
 import { Bounds, Nullable } from './../../types';
 import vtkProp3D, { IProp3DInitialValues } from './Prop3D';
 import vtkVolumeMapper from './VolumeMapper';
-import vtkVolumeProperty, { IVolumePropertyInitialValues } from './VolumeProperty';
+import vtkVolumeProperty, {
+  IVolumePropertyInitialValues,
+} from './VolumeProperty';
 
 /**
- * 
+ *
  */
 export interface IVolumeInitialValues extends IProp3DInitialValues {
-	mapper?: vtkVolumeMapper;
-	property?: vtkVolumeProperty;
-	bounds?: Bounds;
+  mapper?: vtkVolumeMapper;
+  property?: vtkVolumeProperty;
+  bounds?: Bounds;
 }
 
 /**
- * 
+ *
  */
 export interface vtkVolume extends vtkProp3D {
-
-	/**
-	 * Get the volume mapper
-	 */
-	getMapper(): Nullable<vtkVolumeMapper>;
-
-	/**
-	 * For some exporters and other other operations we must be able to collect
-	 * all the actors or volumes.
-	 */
-	getVolumes(): vtkVolume[];
-
-	/**
-	 * Get the volume property
-	 */
-	getProperty(): vtkVolumeProperty;
-
-	/**
-	 * Get the bounds for this mapper as [xmin, xmax, ymin, ymax,zmin, zmax].
-	 * @return {Bounds} The bounds for the mapper.
-	 */
-	getBounds(): Bounds;
-
-	/**
-	 * Get the bounds as [xmin, xmax, ymin, ymax, zmin, zmax].
-	 */
-	getBoundsByReference(): Bounds;
-
-	/**
-	 * Get the `Modified Time` which is a monotonic increasing integer
-	 * global for all vtkObjects.
-	 *
-	 * This allow to solve a question such as:
-	 *  - Is that object created/modified after another one?
-	 *  - Do I need to re-execute this filter, or not? ...
-	 *
-	 * @return {Number} the global modified time.
-	 */
-	getMTime(): number;
-
-	/**
-	 * Get the mtime of anything that would cause the rendered image to appear
-	 * differently
-	 */
-	getRedrawMTime(): number;
-
-	/**
-	 * Create a new property suitable for use with this type of Actor.
-	 * @param {IVolumePropertyInitialValues} [initialValues] (default: {})
-	 */
-	makeProperty(initialValues?: IVolumePropertyInitialValues): vtkVolumeProperty;
-
-	/**
-	 * Set the volume mapper
-	 * @param {vtkVolumeMapper} mapper 
-	 */
-	setMapper(mapper: vtkVolumeMapper): boolean;
-
-	/**
-	 * Set the volume property
-	 * @param {vtkVolumeProperty} property 
-	 */
-	setProperty(property: vtkVolumeProperty): boolean;
+  /**
+   * Get the volume mapper
+   */
+  getMapper(): Nullable<vtkVolumeMapper>;
+
+  /**
+   * For some exporters and other other operations we must be able to collect
+   * all the actors or volumes.
+   */
+  getVolumes(): vtkVolume[];
+
+  /**
+   * Get the volume property
+   */
+  getProperty(): vtkVolumeProperty;
+
+  /**
+   * Get the bounds for this mapper as [xmin, xmax, ymin, ymax,zmin, zmax].
+   * @return {Bounds} The bounds for the mapper.
+   */
+  getBounds(): Bounds;
+
+  /**
+   * Get the bounds as [xmin, xmax, ymin, ymax, zmin, zmax].
+   */
+  getBoundsByReference(): Bounds;
+
+  /**
+   * Get the `Modified Time` which is a monotonic increasing integer
+   * global for all vtkObjects.
+   *
+   * This allow to solve a question such as:
+   *  - Is that object created/modified after another one?
+   *  - Do I need to re-execute this filter, or not? ...
+   *
+   * @return {Number} the global modified time.
+   */
+  getMTime(): number;
+
+  /**
+   * Get the mtime of anything that would cause the rendered image to appear
+   * differently
+   */
+  getRedrawMTime(): number;
+
+  /**
+   * Create a new property suitable for use with this type of Actor.
+   * @param {IVolumePropertyInitialValues} [initialValues] (default: {})
+   */
+  makeProperty(initialValues?: IVolumePropertyInitialValues): vtkVolumeProperty;
+
+  /**
+   * Set the volume mapper
+   * @param {vtkVolumeMapper} mapper
+   */
+  setMapper(mapper: vtkVolumeMapper): boolean;
+
+  /**
+   * Set the volume property
+   * @param {vtkVolumeProperty} property
+   */
+  setProperty(property: vtkVolumeProperty): boolean;
 }
 
 /**
@@ -88,10 +89,14 @@ export interface vtkVolume extends vtkProp3D {
  * @param model object on which data structure will be bounds (protected)
  * @param {IVolumeInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IVolumeInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IVolumeInitialValues
+): void;
 
 /**
- * Method use to create a new instance of vtkVolume 
+ * Method use to create a new instance of vtkVolume
  */
 export function newInstance(initialValues?: IVolumeInitialValues): vtkVolume;
 
@@ -172,7 +177,7 @@ export function newInstance(initialValues?: IVolumeInitialValues): vtkVolume;
  * @see [vtkVolumeProperty](./Rendering_Core_VolumeProperty.html) 
  */
 export declare const vtkVolume: {
-	newInstance: typeof newInstance,
-	extend: typeof extend,
+  newInstance: typeof newInstance;
+  extend: typeof extend;
 };
 export default vtkVolume;