@kitware/vtk.js 30.6.0 → 30.6.2

package/Common/Core/MatrixBuilder.d.ts

@@ -2,137 +2,142 @@ import { mat3, mat4 } from 'gl-matrix';
 import { TypedArray, Vector3 } from './../../types';
 
 declare interface Transform {
-
-	/**
-	 * 
-	 * @param {Boolean} [useDegree] 
-	 */
-	new (useDegree?: boolean);
-
-	/**
-	 * Multiplies the current matrix with a transformation matrix created by
-	 * normalizing both direction vectors and rotating around the axis of the
-	 * crossProduct by the angle from the dotProduct of the two directions.
-	 * @param {Number[]} originDirection 
-	 * @param {Number[]} targetDirection 
-	 */
-	rotateFromDirections(originDirection: number[], targetDirection: number[]): Transform
-
-	/**
-	 * Normalizes the axis of rotation then rotates the current matrix `angle`
-	 * degrees/radians around the provided axis.
-	 * @param {Number} angle 
-	 * @param {Vector3} axis 
-	 */
-	rotate(angle: number, axis: Vector3): Transform
-
-	/**
-	 * Rotates `angle` degrees/radians around the X axis.
-	 * @param {Number} angle 
-	 */
-	rotateX(angle: number): Transform
-
-	/**
-	 * Rotates `angle` degrees/radians around the Y axis.
-	 * @param {Number} angle 
-	 */
-	rotateY(angle: number): Transform
-
-	/**
-	 * Rotates `angle` degrees/radians around the Z axis.
-	 * @param {Number} angle 
-	 */
-	rotateZ(angle: number): Transform
-
-	/**
-	 * Translates the matrix by x, y, z.
-	 * @param {Number} x The x coordinate.
-	 * @param {Number} y The y coordinate.
-	 * @param {Number} z The z coordinate.
-	 */
-	translate(x: number, y: number, z: number): Transform
-
-	/**
-	 * Scales the matrix by sx, sy, sz.
-	 * @param {Number} sx 
-	 * @param {Number} sy 
-	 * @param {Number} sz 
-	 */
-	scale(sx: number, sy: number, sz: number): Transform
-
-	/**
-	 *
-	 * @param {mat4} mat4x4 
-	 */
-	multiply(mat4x4: mat4): Transform
-
-	/**
-	 * Multiply the current matrix with the provided 3x3 matrix.
-	 * @param {mat3} mat3x3 column-first matrix
-	 */
-	 multiply3x3(mat3x3: mat3): Transform
-	
-	/**
-	 * Resets the MatrixBuilder to the Identity matrix.
-	 */
-	identity(): Transform
-
-	/**
-	 * Inverts the MatrixBuilder matrix.
-	 */
-	invert(): Transform
-
-	/**
-	 * Multiplies the array by the MatrixBuilder's internal matrix, in sets of
-	 * 3. Updates the array in place. If specified, `offset` starts at a given
-	 * position in the array, and `nbIterations` will determine the number of
-	 * iterations (sets of 3) to loop through. Assumes the `typedArray` is an
-	 * array of multiples of 3, unless specifically handling with offset and
-	 * iterations. Returns the instance for chaining.
-	 * @param {Number[]|TypedArray} typedArray The Array value.
-	 * @param {Number} [offset] 
-	 * @param {Number} [nbIterations] 
-	 */
-	apply(typedArray: number[]|TypedArray, offset?: number, nbIterations?: number): Transform
-
-	/**
-	 * Returns the internal `mat4` matrix.
-	 */
-	getMatrix(): mat4;
-
-	/**
-	 * Copies the given `mat4` into the builder. Useful if you already have a
-	 * transformation matrix and want to transform it further. Returns the
-	 * instance for chaining.
-	 * @param {mat4} mat4x4 
-	 */
-	setMatrix(mat4x4: mat4): Transform
+  /**
+   *
+   * @param {Boolean} [useDegree]
+   */
+  new (useDegree?: boolean);
+
+  /**
+   * Multiplies the current matrix with a transformation matrix created by
+   * normalizing both direction vectors and rotating around the axis of the
+   * crossProduct by the angle from the dotProduct of the two directions.
+   * @param {Number[]} originDirection
+   * @param {Number[]} targetDirection
+   */
+  rotateFromDirections(
+    originDirection: number[],
+    targetDirection: number[]
+  ): Transform;
+
+  /**
+   * Normalizes the axis of rotation then rotates the current matrix `angle`
+   * degrees/radians around the provided axis.
+   * @param {Number} angle
+   * @param {Vector3} axis
+   */
+  rotate(angle: number, axis: Vector3): Transform;
+
+  /**
+   * Rotates `angle` degrees/radians around the X axis.
+   * @param {Number} angle
+   */
+  rotateX(angle: number): Transform;
+
+  /**
+   * Rotates `angle` degrees/radians around the Y axis.
+   * @param {Number} angle
+   */
+  rotateY(angle: number): Transform;
+
+  /**
+   * Rotates `angle` degrees/radians around the Z axis.
+   * @param {Number} angle
+   */
+  rotateZ(angle: number): Transform;
+
+  /**
+   * Translates the matrix by x, y, z.
+   * @param {Number} x The x coordinate.
+   * @param {Number} y The y coordinate.
+   * @param {Number} z The z coordinate.
+   */
+  translate(x: number, y: number, z: number): Transform;
+
+  /**
+   * Scales the matrix by sx, sy, sz.
+   * @param {Number} sx
+   * @param {Number} sy
+   * @param {Number} sz
+   */
+  scale(sx: number, sy: number, sz: number): Transform;
+
+  /**
+   *
+   * @param {mat4} mat4x4
+   */
+  multiply(mat4x4: mat4): Transform;
+
+  /**
+   * Multiply the current matrix with the provided 3x3 matrix.
+   * @param {mat3} mat3x3 column-first matrix
+   */
+  multiply3x3(mat3x3: mat3): Transform;
+
+  /**
+   * Resets the MatrixBuilder to the Identity matrix.
+   */
+  identity(): Transform;
+
+  /**
+   * Inverts the MatrixBuilder matrix.
+   */
+  invert(): Transform;
+
+  /**
+   * Multiplies the array by the MatrixBuilder's internal matrix, in sets of
+   * 3. Updates the array in place. If specified, `offset` starts at a given
+   * position in the array, and `nbIterations` will determine the number of
+   * iterations (sets of 3) to loop through. Assumes the `typedArray` is an
+   * array of multiples of 3, unless specifically handling with offset and
+   * iterations. Returns the instance for chaining.
+   * @param {Number[]|TypedArray} typedArray The Array value.
+   * @param {Number} [offset]
+   * @param {Number} [nbIterations]
+   */
+  apply(
+    typedArray: number[] | TypedArray,
+    offset?: number,
+    nbIterations?: number
+  ): Transform;
+
+  /**
+   * Returns the internal `mat4` matrix.
+   */
+  getMatrix(): mat4;
+
+  /**
+   * Copies the given `mat4` into the builder. Useful if you already have a
+   * transformation matrix and want to transform it further. Returns the
+   * instance for chaining.
+   * @param {mat4} mat4x4
+   */
+  setMatrix(mat4x4: mat4): Transform;
 }
 
 /**
- * 
+ *
  * @return {Transform}
  */
 declare function buildFromDegree(): Transform;
 
 /**
- * 
+ *
  * @return {Transform}
  */
 declare function buildFromRadian(): Transform;
 
-
 /**
  * The `vtkMatrixBuilder` class provides a system to create a mat4
  * transformation matrix. All functions return the MatrixBuilder Object
  * instance, allowing transformations to be chained.
- * 
+ *
  * @example
  * ```js
  * let point = [2,5,12];
  * vtkMatrixBuilder.buildFromDegree().translate(1,0,2).rotateZ(45).apply(point);
  * ```
- * 
+ *
  * The vtkMatrixBuilder class has two functions, `vtkMatrixBuilder.buildFromDegree()` and
  * `vtkMatrixbuilder.buildFromRadian()`, predefining the angle format used for
  * transformations and returning a MatrixBuilder instance. The matrix is
@@ -140,8 +145,8 @@ declare function buildFromRadian(): Transform;
  *
  */
 export declare const vtkMatrixBuilder: {
-  buildFromDegree: typeof buildFromDegree,
-  buildFromRadian: typeof buildFromRadian,
+  buildFromDegree: typeof buildFromDegree;
+  buildFromRadian: typeof buildFromRadian;
 };
 
 export default vtkMatrixBuilder;

package/Common/Core/Points.d.ts

@@ -1,106 +1,114 @@
-import vtkDataArray from './DataArray';
-import { Bounds, TypedArray } from './../../types';
-
-/**
- *
- */
-export interface IPointsInitialValues {
-	empty?: boolean;
-	numberOfComponents?: number;
-	bounds?: Bounds;
-}
-
-export interface vtkPoints extends vtkDataArray {
-
-	/**
-	 * Trigger the computation of bounds
-	 */
-	computeBounds(): Bounds;
-
-	/**
-	 * Get the bounds for this mapper as [xmin, xmax, ymin, ymax,zmin, zmax].
-	 * @return {Bounds} The bounds for the mapper.
-	 */
-	getBounds(): Bounds;
-
-	/**
-	 * Get the coordinate of a point.
-	 * @param {Number} idx The index of point.
-	 * @param {Number[]|TypedArray} [tupleToFill] (default [])
-	 * @returns {Number[]|TypedArray}
-	 */
-	getPoint(idx: number, tupleToFill?: number[]|TypedArray): number[]|TypedArray;
-
-	/**
-	 * Convenient method to search a point in the array.
-	 * This is a naïve search. Consider using a "locator" instead.
-	 * @param {Array<Number>|TypedArray} pointToSearch
-	 * @param {Number} precision (1e-6 by default)
-	 * @returns {Number} the index of the point if found, -1 otherwise.
-	 */
-	findPoint(pointToSearch: Array<number>|TypedArray, precision?: number): number;
-
-	/**
-	 * Get the number of points for this object can hold.
-	 */
-	getNumberOfPoints(): number;
-
-	/**
-	 * Set the number of points for this object to hold.
-	 * 
-	 * ```js
-	 * points.getData()[0] = x;
-	 * points.getData()[1] = y;
-	 * points.getData()[2] = z;
-	 * ```
-	 * 
-	 * @param {Number} nbPoints 
-	 * @param {Number} [dimension] 
-	 */
-	setNumberOfPoints(nbPoints: number, dimension?: number): void;
-
-	/**
-	 * Set the (x,y,z) coordinates of a point based on its index.
-	 * @param {Number} idx The index of point.
-	 * @param {Number} x The x coordinate.
-	 * @param {Number} y The y coordinate.
-	 * @param {Number} z The z coordinate.
-	 */
-	setPoint(idx: number, x: number, y: number, z: number): void;
-
-	/**
-	 * Insert the (x,y,z) coordinates of a point at the next available slot.
-	 * @param {Number} x The x coordinate.
-	 * @param {Number} y The y coordinate.
-	 * @param {Number} z The z coordinate.
-	 * @returns {Number} Index of the inserted point.
-	 */
-	insertNextPoint(x: number, y: number, z: number): number;
-}
-
-/**
- * Method used to decorate a given object (publicAPI+model) with vtkPoints characteristics.
- *
- * @param publicAPI object on which methods will be bounds (public)
- * @param model object on which data structure will be bounds (protected)
- * @param {IPointsInitialValues} [initialValues] (default: {})
- */
-export function extend(publicAPI: object, model: object, initialValues?: IPointsInitialValues): void;
-
-/**
- * Method used to create a new instance of vtkPoints
- * @param {IPointsInitialValues} [initialValues] for pre-setting some of its content
- */
-export function newInstance(initialValues?: IPointsInitialValues): vtkPoints;
-
-
-/**
- * vtkPoints represents 3D points. The data model for vtkPoints is an array 
- * of vx-vy-vz triplets accessible by (point or cell) id.
- */
-
-export declare const vtkPoints: {
-	newInstance: typeof newInstance;
-	extend: typeof extend;
-}
-export default vtkPoints;
+import vtkDataArray from './DataArray';
+import { Bounds, TypedArray } from './../../types';
+
+/**
+ *
+ */
+export interface IPointsInitialValues {
+  empty?: boolean;
+  numberOfComponents?: number;
+  bounds?: Bounds;
+}
+
+export interface vtkPoints extends vtkDataArray {
+  /**
+   * Trigger the computation of bounds
+   */
+  computeBounds(): Bounds;
+
+  /**
+   * Get the bounds for this mapper as [xmin, xmax, ymin, ymax,zmin, zmax].
+   * @return {Bounds} The bounds for the mapper.
+   */
+  getBounds(): Bounds;
+
+  /**
+   * Get the coordinate of a point.
+   * @param {Number} idx The index of point.
+   * @param {Number[]|TypedArray} [tupleToFill] (default [])
+   * @returns {Number[]|TypedArray}
+   */
+  getPoint(
+    idx: number,
+    tupleToFill?: number[] | TypedArray
+  ): number[] | TypedArray;
+
+  /**
+   * Convenient method to search a point in the array.
+   * This is a naïve search. Consider using a "locator" instead.
+   * @param {Array<Number>|TypedArray} pointToSearch
+   * @param {Number} precision (1e-6 by default)
+   * @returns {Number} the index of the point if found, -1 otherwise.
+   */
+  findPoint(
+    pointToSearch: Array<number> | TypedArray,
+    precision?: number
+  ): number;
+
+  /**
+   * Get the number of points for this object can hold.
+   */
+  getNumberOfPoints(): number;
+
+  /**
+   * Set the number of points for this object to hold.
+   *
+   * ```js
+   * points.getData()[0] = x;
+   * points.getData()[1] = y;
+   * points.getData()[2] = z;
+   * ```
+   *
+   * @param {Number} nbPoints
+   * @param {Number} [dimension]
+   */
+  setNumberOfPoints(nbPoints: number, dimension?: number): void;
+
+  /**
+   * Set the (x,y,z) coordinates of a point based on its index.
+   * @param {Number} idx The index of point.
+   * @param {Number} x The x coordinate.
+   * @param {Number} y The y coordinate.
+   * @param {Number} z The z coordinate.
+   */
+  setPoint(idx: number, x: number, y: number, z: number): void;
+
+  /**
+   * Insert the (x,y,z) coordinates of a point at the next available slot.
+   * @param {Number} x The x coordinate.
+   * @param {Number} y The y coordinate.
+   * @param {Number} z The z coordinate.
+   * @returns {Number} Index of the inserted point.
+   */
+  insertNextPoint(x: number, y: number, z: number): number;
+}
+
+/**
+ * Method used to decorate a given object (publicAPI+model) with vtkPoints characteristics.
+ *
+ * @param publicAPI object on which methods will be bounds (public)
+ * @param model object on which data structure will be bounds (protected)
+ * @param {IPointsInitialValues} [initialValues] (default: {})
+ */
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IPointsInitialValues
+): void;
+
+/**
+ * Method used to create a new instance of vtkPoints
+ * @param {IPointsInitialValues} [initialValues] for pre-setting some of its content
+ */
+export function newInstance(initialValues?: IPointsInitialValues): vtkPoints;
+
+/**
+ * vtkPoints represents 3D points. The data model for vtkPoints is an array
+ * of vx-vy-vz triplets accessible by (point or cell) id.
+ */
+
+export declare const vtkPoints: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
+export default vtkPoints;

package/Common/Core/PriorityQueue.d.ts

@@ -1,36 +1,35 @@
-import { vtkObject } from './../../interfaces' ;
+import { vtkObject } from './../../interfaces';
 
 /**
  *
  */
 export interface IPriorityQueueInitialValues {
-	elements?: Array<any>;
+  elements?: Array<any>;
 }
 
 export interface vtkPriorityQueue extends vtkObject {
+  /**
+   * Push an element to the queue while defining a priority.
+   * @param {Number} priority The priority of the element.
+   * @param element
+   */
+  push(priority: number, element: any): void;
 
-	/**
-	 * Push an element to the queue while defining a priority.
-	 * @param {Number} priority The priority of the element.
-	 * @param element 
-	 */
-	push(priority: number, element: any): void;
-
-	/**
-	 * 
-	 */
-	pop(): any | null;
-
-	/**
-	 * Delete an element from the queue by its ID.
-	 * @param {Number} id The id of the element.
-	 */
-	deleteById(id: number): void;
-
-	/**
-	 * Get the length of the queue.
-	 */
-	length(): number;
+  /**
+   *
+   */
+  pop(): any | null;
+
+  /**
+   * Delete an element from the queue by its ID.
+   * @param {Number} id The id of the element.
+   */
+  deleteById(id: number): void;
+
+  /**
+   * Get the length of the queue.
+   */
+  length(): number;
 }
 
 /**
@@ -40,14 +39,19 @@ export interface vtkPriorityQueue extends vtkObject {
  * @param model object on which data structure will be bounds (protected)
  * @param {IPriorityQueueInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IPriorityQueueInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IPriorityQueueInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkPriorityQueue
  * @param {IPriorityQueueInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: IPriorityQueueInitialValues): vtkPriorityQueue;
-
+export function newInstance(
+  initialValues?: IPriorityQueueInitialValues
+): vtkPriorityQueue;
 
 /**
  * vtkPriorityQueue is a general object for creating and manipulating lists of
@@ -56,7 +60,7 @@ export function newInstance(initialValues?: IPriorityQueueInitialValues): vtkPri
  * smallest values.
  */
 export declare const vtkPriorityQueue: {
-	newInstance: typeof newInstance;
-	extend: typeof extend;
-}
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
 export default vtkPriorityQueue;