@kitware/vtk.js 30.6.0 → 30.6.2

package/Common/Transform/LandmarkTransform.d.ts

@@ -3,68 +3,66 @@ import { vtkObject } from './../../interfaces';
 import vtkPoints from './../Core/Points';
 
 export enum Mode {
-	RIGID_BODY,
-	SIMILARITY,
-	AFFINE,
+  RIGID_BODY,
+  SIMILARITY,
+  AFFINE,
 }
 
-export interface ILandmarkTransformInitialValues { 
-	mode?: Mode;
+export interface ILandmarkTransformInitialValues {
+  mode?: Mode;
 }
 
-
 export interface vtkLandmarkTransform extends vtkObject {
-
-	/**
-	 * Mat4 matrix, result of the landmark transform.
-	 * If vtkLandmarkTransformed failed, default is identity.
-	 */
-	getMatrix(): mat4;
-
-	/**
-	 * Get the number of degrees of freedom to constrain the solution to.
-	 */
-	getMode(): Mode;
-
-	/**
-	 * Get list of 3D points which defines the source points.
-	 */
-	getSourceLandmark(): vtkPoints;
-
-	/**
-	 * Get list of 3D points which defines the target points.
-	 */
-	getTargetLandmark(): vtkPoints;
-
-	/**
-	 * Set the number of degrees of freedom to constrain the solution to:
-	 * 
-	 * - `Mode.RIGID_BODY` : Rotation and translation onlu
-	 * - `Mode.SIMILARITY` : rotation, translation and isotropic scaling
-	 * - `Mode.AFFINE` : collinearity is preserved. Ratios of distances along a line are preserved.
-	 * 
-	 * @param {Mode} mode The value of mode.
-	 * @default SIMILARITY
-	 */
-	setMode(mode: Mode): boolean;
-
-	/**
-	 * Set list of 3D points which defines the source points.
-	 * @param {vtkPoints} sourceLandmark 
-	 */
-	setSourceLandmark(sourceLandmark: vtkPoints): boolean;
-
-	/**
-	 * Set list of 3D points which defines the target points.
-	 * @param {vtkPoints} targetLandmark 
-	 */
-	setTargetLandmark(targetLandmark: vtkPoints): boolean;
-
-	/**
-	 * Launch the computation of the matrix according to target and source
-	 * points.
-	 */
-	update(): void;
+  /**
+   * Mat4 matrix, result of the landmark transform.
+   * If vtkLandmarkTransformed failed, default is identity.
+   */
+  getMatrix(): mat4;
+
+  /**
+   * Get the number of degrees of freedom to constrain the solution to.
+   */
+  getMode(): Mode;
+
+  /**
+   * Get list of 3D points which defines the source points.
+   */
+  getSourceLandmark(): vtkPoints;
+
+  /**
+   * Get list of 3D points which defines the target points.
+   */
+  getTargetLandmark(): vtkPoints;
+
+  /**
+   * Set the number of degrees of freedom to constrain the solution to:
+   *
+   * - `Mode.RIGID_BODY` : Rotation and translation onlu
+   * - `Mode.SIMILARITY` : rotation, translation and isotropic scaling
+   * - `Mode.AFFINE` : collinearity is preserved. Ratios of distances along a line are preserved.
+   *
+   * @param {Mode} mode The value of mode.
+   * @default SIMILARITY
+   */
+  setMode(mode: Mode): boolean;
+
+  /**
+   * Set list of 3D points which defines the source points.
+   * @param {vtkPoints} sourceLandmark
+   */
+  setSourceLandmark(sourceLandmark: vtkPoints): boolean;
+
+  /**
+   * Set list of 3D points which defines the target points.
+   * @param {vtkPoints} targetLandmark
+   */
+  setTargetLandmark(targetLandmark: vtkPoints): boolean;
+
+  /**
+   * Launch the computation of the matrix according to target and source
+   * points.
+   */
+  update(): void;
 }
 
 /**
@@ -74,23 +72,28 @@ export interface vtkLandmarkTransform extends vtkObject {
  * @param model object on which data structure will be bounds (protected)
  * @param {ILandmarkTransformInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: ILandmarkTransformInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: ILandmarkTransformInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkLandmarkTransform.
  * @param {ILandmarkTransformInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: ILandmarkTransformInitialValues): vtkLandmarkTransform;
-
+export function newInstance(
+  initialValues?: ILandmarkTransformInitialValues
+): vtkLandmarkTransform;
 
 /**
  * vtkLandmarkTransform is a cell which representant a triangle. It contains static
  * method to make some computations directly link to triangle.
- * 
+ *
  * @example
  * '''js
  * import vtkLandmarkTransform from '@kitware/vtk.js/Common/Transform/LandmarkTransform';
- * 
+ *
  * const transform = LandmarkTransform.New();
  * transform.setMode(Mode.RIGID_BODY);
  * transform.setSourceLandmark(...); // vtkPoints
@@ -100,7 +103,7 @@ export function newInstance(initialValues?: ILandmarkTransformInitialValues): vt
  * '''
  */
 export declare const vtkLandmarkTransform: {
-	newInstance: typeof newInstance,
-	extend: typeof extend;
+  newInstance: typeof newInstance;
+  extend: typeof extend;
 };
 export default vtkLandmarkTransform;

package/Common/Transform/Transform.d.ts

@@ -2,131 +2,148 @@ import { mat4, vec3 } from 'gl-matrix';
 import { vtkObject } from './../../interfaces';
 import { TypedArray } from './../../types';
 
-export interface ITransformInitialValues { 
-	preMultiplyFlag?: boolean;
-	matrix?: number[];
+export interface ITransformInitialValues {
+  preMultiplyFlag?: boolean;
+  matrix?: number[];
 }
 
 type TSlicableArray = number[] | TypedArray;
 
-
 export interface vtkTransform extends vtkObject {
-
-	/**
-	 * Mat4 matrix, used by vtkTransform to transform points, vertices, matrices...
-	 * Default is identity.
-	 */
-	getMatrix(): mat4;
-
-	/**
-	 * @see getMatrix
-	 * @param {mat4} matrix
-	 */
-	setMatrix(matrix: mat4): boolean;
-
-	/**
-	 * @see getMatrix
-	 * Matrix is stored using gl-matrix conventions: column major
-	 * @param e00
-	 * @param e01
-	 * @param e02
-	 * @param e03
-	 * @param e10
-	 * @param e11
-	 * @param e12
-	 * @param e13
-	 * @param e20
-	 * @param e21
-	 * @param e22
-	 * @param e23
-	 * @param e30
-	 * @param e31
-	 * @param e32
-	 * @param e33
-	 */
-	setMatrix(e00: number, e01: number, e02: number, e03: number, e10: number, e11: number, e12: number, e13: number, e20: number, e21: number, e22: number, e23: number, e30: number, e31: number, e32: number, e33: number): boolean;
-
-	/**
-	 * The value of preMultiplyFlag indicates how matrix multiplications should occur.
-	 * 
-	 * When in premultiply mode:
-	 * All subsequent operations will occur before those already represented in the current transformation.
-	 * In homogeneous matrix notation, M = M*A where M is the current transformation matrix and A is the applied matrix.
-	 *
-	 * When in postmultiply mode:
-	 * All subsequent operations will occur after those already represented in the current transformation.
-	 * In homogeneous matrix notation, M = A*M where M is the current transformation matrix and A is the applied matrix.
-	 *
-	 * This flag is also used in @see transformMatrix and @see transformMatrices to indicate how transform is applied to matrices:
-	 * Premultiply: O_i = M * A_i
-	 * Postmultiply: O_i = A_i * M
-	 * where M is the current transformation matrix, A_i are the matrices in argument, O_i are the output matrices.
-	 *
-	 * The default is PreMultiply.
-	 */
-	getPreMultiplyFlag(): boolean;
-
-	/**
-	 * @see getPreMultiplyFlag
-	 * @param preMultiplyFlag
-	 */
-	setPreMultiplyFlag(preMultiplyFlag: boolean): boolean;
-
-	/**
-	 * Set preMultiplyFlag to true
-	 * @see getPreMultiplyFlag
-	 */
-	preMultiply(): void;
-
-	/**
-	 * Set preMultiplyFlag to false
-	 * @see getPreMultiplyFlag
-	 */
-	postMultiply(): void;
-
-	/**
-	 * Transform a single point using the internal transform matrix
-	 * The resulting point is: Pout = M * Pin where M is the internal matrix, Pin and Pout the in and out points
-	 * @param point The point to transform, is not modified (except if point === out)
-	 * @param out The receiving output point, is modified, can be the same as point
-	 * @returns The out parameter
-	 */
-	transformPoint(point: vec3, out: vec3): vec3;
-
-	/**
-	 * Transform multiple points using the internal transform matrix
-	 * See @see transformPoint for more info
-	 * Modify the out array only
-	 * @param points An array (typed or not) containing n*3 elements or of shape (n, 3)
-	 * @param out An array (typed or not) containing n*3 elements or of shape (n, 3)
-	 */
-	transformPoints(points: TSlicableArray, out: TSlicableArray): TSlicableArray;
-
-
-	/**
-	 * Transform a single matrix using the internal transform matrix
-	 * The resulting matrix is:
-	 * Mout = M * Min when in premultiply mode
-	 * Mout = Min * M when in postmultiply mode
-	 * @param matrix The matrix to transform, is not modified (except if matrix === out)
-	 * @param out The receiving output matrix, is modified, can be the same as matrix
-	 * @returns The out parameter
-	 */
-	transformMatrix(matrix: mat4, out: mat4): mat4;
-
-	/**
-	 * Transform multiple matrices using the internal transform matrix
-	 * See @see transformMatrix for more info
-	 * Modify the out array only
-	 * @param matrices An array (typed or not) containing n*16 elements or of shape (n, 16)
-	 * @param out An array (typed or not) containing n*16 elements or of shape (n, 16)
-	 */
-	transformMatrices(matrices: TSlicableArray, out: TSlicableArray): TSlicableArray;
-
-	/**
-	 * @returns A new transform with an inversed internal matrix. Also copy the premultiply flag @see getPreMultiplyFlag.
-	 */
-	getInverse(): vtkTransform;
+  /**
+   * Mat4 matrix, used by vtkTransform to transform points, vertices, matrices...
+   * Default is identity.
+   */
+  getMatrix(): mat4;
+
+  /**
+   * @see getMatrix
+   * @param {mat4} matrix
+   */
+  setMatrix(matrix: mat4): boolean;
+
+  /**
+   * @see getMatrix
+   * Matrix is stored using gl-matrix conventions: column major
+   * @param e00
+   * @param e01
+   * @param e02
+   * @param e03
+   * @param e10
+   * @param e11
+   * @param e12
+   * @param e13
+   * @param e20
+   * @param e21
+   * @param e22
+   * @param e23
+   * @param e30
+   * @param e31
+   * @param e32
+   * @param e33
+   */
+  setMatrix(
+    e00: number,
+    e01: number,
+    e02: number,
+    e03: number,
+    e10: number,
+    e11: number,
+    e12: number,
+    e13: number,
+    e20: number,
+    e21: number,
+    e22: number,
+    e23: number,
+    e30: number,
+    e31: number,
+    e32: number,
+    e33: number
+  ): boolean;
+
+  /**
+   * The value of preMultiplyFlag indicates how matrix multiplications should occur.
+   *
+   * When in premultiply mode:
+   * All subsequent operations will occur before those already represented in the current transformation.
+   * In homogeneous matrix notation, M = M*A where M is the current transformation matrix and A is the applied matrix.
+   *
+   * When in postmultiply mode:
+   * All subsequent operations will occur after those already represented in the current transformation.
+   * In homogeneous matrix notation, M = A*M where M is the current transformation matrix and A is the applied matrix.
+   *
+   * This flag is also used in @see transformMatrix and @see transformMatrices to indicate how transform is applied to matrices:
+   * Premultiply: O_i = M * A_i
+   * Postmultiply: O_i = A_i * M
+   * where M is the current transformation matrix, A_i are the matrices in argument, O_i are the output matrices.
+   *
+   * The default is PreMultiply.
+   */
+  getPreMultiplyFlag(): boolean;
+
+  /**
+   * @see getPreMultiplyFlag
+   * @param preMultiplyFlag
+   */
+  setPreMultiplyFlag(preMultiplyFlag: boolean): boolean;
+
+  /**
+   * Set preMultiplyFlag to true
+   * @see getPreMultiplyFlag
+   */
+  preMultiply(): void;
+
+  /**
+   * Set preMultiplyFlag to false
+   * @see getPreMultiplyFlag
+   */
+  postMultiply(): void;
+
+  /**
+   * Transform a single point using the internal transform matrix
+   * The resulting point is: Pout = M * Pin where M is the internal matrix, Pin and Pout the in and out points
+   * @param point The point to transform, is not modified (except if point === out)
+   * @param out The receiving output point, is modified, can be the same as point
+   * @returns The out parameter
+   */
+  transformPoint(point: vec3, out: vec3): vec3;
+
+  /**
+   * Transform multiple points using the internal transform matrix
+   * See @see transformPoint for more info
+   * Modify the out array only
+   * @param points An array (typed or not) containing n*3 elements or of shape (n, 3)
+   * @param out An array (typed or not) containing n*3 elements or of shape (n, 3)
+   */
+  transformPoints(points: TSlicableArray, out: TSlicableArray): TSlicableArray;
+
+  /**
+   * Transform a single matrix using the internal transform matrix
+   * The resulting matrix is:
+   * Mout = M * Min when in premultiply mode
+   * Mout = Min * M when in postmultiply mode
+   * @param matrix The matrix to transform, is not modified (except if matrix === out)
+   * @param out The receiving output matrix, is modified, can be the same as matrix
+   * @returns The out parameter
+   */
+  transformMatrix(matrix: mat4, out: mat4): mat4;
+
+  /**
+   * Transform multiple matrices using the internal transform matrix
+   * See @see transformMatrix for more info
+   * Modify the out array only
+   * @param matrices An array (typed or not) containing n*16 elements or of shape (n, 16)
+   * @param out An array (typed or not) containing n*16 elements or of shape (n, 16)
+   */
+  transformMatrices(
+    matrices: TSlicableArray,
+    out: TSlicableArray
+  ): TSlicableArray;
+
+  /**
+   * @returns A new transform with an inversed internal matrix. Also copy the premultiply flag @see getPreMultiplyFlag.
+   */
+  getInverse(): vtkTransform;
 }
 
 /**
@@ -136,14 +153,19 @@ export interface vtkTransform extends vtkObject {
  * @param model object on which data structure will be bounds (protected)
  * @param {ITransformInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: ITransformInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: ITransformInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkTransform.
  * @param {ITransformInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: ITransformInitialValues): vtkTransform;
-
+export function newInstance(
+  initialValues?: ITransformInitialValues
+): vtkTransform;
 
 /**
  * vtkTransform describes linear transformations via a 4x4 matrix.
@@ -158,7 +180,7 @@ export function newInstance(initialValues?: ITransformInitialValues): vtkTransfo
  * ```js
  * import vtkTransform from '@kitware/vtk.js/Common/Transform/Transform';
  * import vtkMatrixBuilder from '@kitware/vtk.js/Common/Core/MatrixBuilder';
- * 
+ *
  * const transform = vtkTransform.newInstance();
  * const matrix = vtkMatrixBuilder
  *   .buildFromDegree()
@@ -171,7 +193,7 @@ export function newInstance(initialValues?: ITransformInitialValues): vtkTransfo
  * ```
  */
 export declare const vtkTransform: {
-	newInstance: typeof newInstance,
-	extend: typeof extend;
+  newInstance: typeof newInstance;
+  extend: typeof extend;
 };
 export default vtkTransform;

package/Filters/General/AppendPolyData.d.ts

@@ -1,50 +1,51 @@
 import { vtkAlgorithm, vtkObject } from './../../interfaces';
 
 export enum DesiredOutputPrecision {
-	/**
-	 * Output precision should match the input precision
-	 */
-	DEFAULT,
+  /**
+   * Output precision should match the input precision
+   */
+  DEFAULT,
 
-	/**
-	 * Output single-precision floating-point (i.e. float32)
-	 */
-	SINGLE,
+  /**
+   * Output single-precision floating-point (i.e. float32)
+   */
+  SINGLE,
 
-	/**
-	 * Output double-precision floating point (i.e. float64)
-	 */
-	DOUBLE
+  /**
+   * Output double-precision floating point (i.e. float64)
+   */
+  DOUBLE,
 }
 
 /**
  *
  */
 export interface IAppendPolyDataInitialValues {
-	outputPointsPrecision?: DesiredOutputPrecision;
+  outputPointsPrecision?: DesiredOutputPrecision;
 }
 
 type vtkAppendPolyDataBase = vtkObject & vtkAlgorithm;
 
 export interface vtkAppendPolyData extends vtkAppendPolyDataBase {
+  /**
+   * Get the desired precision for the output types.
+   */
+  getOutputPointsPrecision(): DesiredOutputPrecision;
 
-	/**
-	 * Get the desired precision for the output types.
-	 */
-	getOutputPointsPrecision(): DesiredOutputPrecision;
+  /**
+   * Set the desired precision for the output types.
+   * @param outputPointsPrecision
+   */
+  setOutputPointsPrecision(
+    outputPointsPrecision: DesiredOutputPrecision
+  ): boolean;
 
-	/**
-	 * Set the desired precision for the output types.
-	 * @param outputPointsPrecision
-	 */
-	setOutputPointsPrecision(outputPointsPrecision: DesiredOutputPrecision): boolean;
-
-	/**
-	 *
-	 * @param inData
-	 * @param outData
-	 */
-	requestData(inData: any, outData: any): void;
+  /**
+   *
+   * @param inData
+   * @param outData
+   */
+  requestData(inData: any, outData: any): void;
 }
 
 /**
@@ -54,14 +55,19 @@ export interface vtkAppendPolyData extends vtkAppendPolyDataBase {
  * @param model object on which data structure will be bounds (protected)
  * @param {IAppendPolyDataInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IAppendPolyDataInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IAppendPolyDataInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkAppendPolyData
  * @param {IAppendPolyDataInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: IAppendPolyDataInitialValues): vtkAppendPolyData;
-
+export function newInstance(
+  initialValues?: IAppendPolyDataInitialValues
+): vtkAppendPolyData;
 
 /**
  * vtkAppendPolyData - append one or more polygonal datasets together
@@ -72,13 +78,13 @@ export function newInstance(initialValues?: IAppendPolyDataInitialValues): vtkAp
  * only if all datasets have the point and/or cell attributes available.  (For
  * example, if one dataset has point scalars but another does not, point scalars
  * will not be appended.)
- * 
+ *
  * @example
  * Provide the first input to the filter via the standard
  * `setInput(Data/Connection)` methods. Any additional inputs can be provided via
  * the `addInput(Data/Connection)` methods. When only a single input is provided,
  * it is passed through as is to the output.
- * 
+ *
  * ```js
  * const cone = vtkConeSource.newInstance();
  * const cylinder = vtkCylinderSource.newInstance();
@@ -91,7 +97,7 @@ export function newInstance(initialValues?: IAppendPolyDataInitialValues): vtkAp
  * ```
  */
 export declare const vtkAppendPolyData: {
-	newInstance: typeof newInstance;
-	extend: typeof extend;
-}
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
 export default vtkAppendPolyData;