@kitware/vtk.js 30.5.3 → 30.6.1

package/Filters/Sources/PlaneSource.d.ts

@@ -3,208 +3,210 @@ import { vtkAlgorithm, vtkObject } from './../../interfaces';
 import { Vector3 } from './../../types';
 
 /**
- * 
+ *
  */
 export interface IPlaneSourceInitialValues {
-	xResolution?: number;
-	yResolution?: number;
-	origin?: Vector3;
-	point1?: Vector3;
-	point2?: Vector3;
-	pointType?: string;
+  xResolution?: number;
+  yResolution?: number;
+  origin?: Vector3;
+  point1?: Vector3;
+  point2?: Vector3;
+  pointType?: string;
 }
 
-type vtkPlaneSourceBase = vtkObject & Omit<vtkAlgorithm,
-	| 'getInputData'
-	| 'setInputData'
-	| 'setInputConnection'
-	| 'getInputConnection'
-	| 'addInputConnection'
-	| 'addInputData'>;
+type vtkPlaneSourceBase = vtkObject &
+  Omit<
+    vtkAlgorithm,
+    | 'getInputData'
+    | 'setInputData'
+    | 'setInputConnection'
+    | 'getInputConnection'
+    | 'addInputConnection'
+    | 'addInputData'
+  >;
 
 export interface vtkPlaneSource extends vtkPlaneSourceBase {
-
-	/**
-	 * Get the center of the plane.
-	 * @default [0, 0, 0]
-	 */
-	getCenter(): Vector3;
-
-	/**
-	 * Get the center of the plane.
-	 */
-	getCenterByReference(): Vector3;
-
-	/**
-	 * Get the normal of the plane.
-	 * @default [0, 0, 1]
-	 */
-	getNormal(): Vector3;
-
-	/**
-	 * Get the normal of the plane.
-	 */
-	getNormalByReference(): Vector3;
-
-	/**
-	 * Get the origin of the plane, lower-left corner.
-	 * @default [0, 0, 0]
-	 */
-	getOrigin(): Vector3;
-
-	/**
-	 * Get the origin of the plane, lower-left corner.
-	 */
-	getOriginByReference(): Vector3;
-
-	/**
-	 * Get the x axes of the plane.
-	 * @default [1, 0, 0]
-	 */
-	getPoint1(): Vector3;
-
-	/**
-	 * Get the x axes of the plane.
-	 */
-	getPoint1ByReference(): Vector3;
-
-	/**
-	 * Get the y axes of the plane.
-	 * @default [0, 1, 0]
-	 */
-	getPoint2(): Vector3;
-
-	/**
-	 * Get the y axes of the plane.
-	 */
-	getPoint2ByReference(): Vector3;
-
-	/**
-	 * Get the x resolution of the plane.
-	 * @default 10
-	 */
-	getXResolution(): number;
-
-	/**
-	 * Get the y resolution of the plane.
-	 * @default 10
-	 */
-	getYResolution(): number;
-
-	/**
-	 * 
-	 * @param inData 
-	 * @param outData 
-	 */
-	requestData(inData: any, outData: any): void;
-
-	/**
-	 * Rotate plane around a given axis
-	 * @param angle theta Angle (radian) to rotate about
-	 * @param rotationAxis Axis to rotate around
-	 */
-	rotate(angle: number, rotationAxis: vec3): void;
-
-	/**
-	 * Set the center of the plane.
-	 * @param {Number} x The x coordinate.
-	 * @param {Number} y The y coordinate.
-	 * @param {Number} z The z coordinate.
-	 */
-	setCenter(x: number, y: number, z: number): void;
-
-	/**
-	 * Set the center of the plane.
-	 * @param {Vector3} center The coordinate of the center point.
-	 */
-	setCenter(center: Vector3): void;
-
-	/**
-	 * Set the normal of the plane.
-	 * @param {Vector3} normal The normal coordinate.
-	 */
-	setNormal(normal: Vector3): boolean;
-
-	/**
-	 * Set the normal of the plane.
-	 * @param {Number} x The x coordinate.
-	 * @param {Number} y The y coordinate.
-	 * @param {Number} z The z coordinate.
-	 */
-	setNormal(x: number, y: number, z: number): boolean;
-
-	/**
-	 * Set the normal of the plane.
-	 * @param {Vector3} normal The normal coordinate.
-	 */
-	setNormalFrom(normal: Vector3): boolean;
-
-	/**
-	 * Set the origin of the plane.
-	 * @param {Vector3} origin The coordinate of the origin point.
-	 */
-	setOrigin(origin: Vector3): boolean;
-
-	/**
-	 * Set the origin of the plane.
-	 * @param {Number} x The x coordinate of the origin point.
-	 * @param {Number} y The y coordinate of the origin point.
-	 * @param {Number} z The z coordinate of the origin point.
-	 */
-	setOrigin(x: number, y: number, z: number): boolean;
-
-	/**
-	 * Set the origin of the plane.
-	 * @param {Vector3} origin The coordinate of the origin point.
-	 */
-	setOriginFrom(origin: Vector3): boolean;
-
-	/**
-	 * Specify a point defining the first axis of the plane.
-	 * @param {Number} x The x coordinate.
-	 * @param {Number} y The y coordinate.
-	 * @param {Number} z The z coordinate.
-	 */
-	setPoint1(x: number, y: number, z: number): boolean;
-
-	/**
-	 * Specify a point defining the first axis of the plane.
-	 * @param {Vector3} point1 
-	 */
-	setPoint1(point1: Vector3): boolean;
-
-	/**
-	 * Specify a point defining the second axis of the plane.
-	 * @param {Number} x The x coordinate.
-	 * @param {Number} y The y coordinate.
-	 * @param {Number} z The z coordinate.
-	 */
-	setPoint2(x: number, y: number, z: number): boolean;
-
-	/**
-	 * Specify a point defining the second axis of the plane.
-	 * @param {Vector3} point2 
-	 */
-	setPoint2(point2: Vector3): boolean;
-
-	/**
-	 * Set the number of facets used to represent the cone.
-	 * @param {Number} xResolution 
-	 */
-	setXResolution(xResolution: number): boolean;
-
-	/**
-	 * Set the number of facets used to represent the cone.
-	 * @param {Number} yResolution 
-	 */
-	setYResolution(yResolution: number): boolean;
-
-	/**
-	 * 
-	 * @param {vec3} v1 
-	 * @param {vec3} v2 
-	 */
-	updatePlane(v1: vec3, v2: vec3): boolean;
+  /**
+   * Get the center of the plane.
+   * @default [0, 0, 0]
+   */
+  getCenter(): Vector3;
+
+  /**
+   * Get the center of the plane.
+   */
+  getCenterByReference(): Vector3;
+
+  /**
+   * Get the normal of the plane.
+   * @default [0, 0, 1]
+   */
+  getNormal(): Vector3;
+
+  /**
+   * Get the normal of the plane.
+   */
+  getNormalByReference(): Vector3;
+
+  /**
+   * Get the origin of the plane, lower-left corner.
+   * @default [0, 0, 0]
+   */
+  getOrigin(): Vector3;
+
+  /**
+   * Get the origin of the plane, lower-left corner.
+   */
+  getOriginByReference(): Vector3;
+
+  /**
+   * Get the x axes of the plane.
+   * @default [1, 0, 0]
+   */
+  getPoint1(): Vector3;
+
+  /**
+   * Get the x axes of the plane.
+   */
+  getPoint1ByReference(): Vector3;
+
+  /**
+   * Get the y axes of the plane.
+   * @default [0, 1, 0]
+   */
+  getPoint2(): Vector3;
+
+  /**
+   * Get the y axes of the plane.
+   */
+  getPoint2ByReference(): Vector3;
+
+  /**
+   * Get the x resolution of the plane.
+   * @default 10
+   */
+  getXResolution(): number;
+
+  /**
+   * Get the y resolution of the plane.
+   * @default 10
+   */
+  getYResolution(): number;
+
+  /**
+   *
+   * @param inData
+   * @param outData
+   */
+  requestData(inData: any, outData: any): void;
+
+  /**
+   * Rotate plane around a given axis
+   * @param angle theta Angle (radian) to rotate about
+   * @param rotationAxis Axis to rotate around
+   */
+  rotate(angle: number, rotationAxis: vec3): void;
+
+  /**
+   * Set the center of the plane.
+   * @param {Number} x The x coordinate.
+   * @param {Number} y The y coordinate.
+   * @param {Number} z The z coordinate.
+   */
+  setCenter(x: number, y: number, z: number): void;
+
+  /**
+   * Set the center of the plane.
+   * @param {Vector3} center The coordinate of the center point.
+   */
+  setCenter(center: Vector3): void;
+
+  /**
+   * Set the normal of the plane.
+   * @param {Vector3} normal The normal coordinate.
+   */
+  setNormal(normal: Vector3): boolean;
+
+  /**
+   * Set the normal of the plane.
+   * @param {Number} x The x coordinate.
+   * @param {Number} y The y coordinate.
+   * @param {Number} z The z coordinate.
+   */
+  setNormal(x: number, y: number, z: number): boolean;
+
+  /**
+   * Set the normal of the plane.
+   * @param {Vector3} normal The normal coordinate.
+   */
+  setNormalFrom(normal: Vector3): boolean;
+
+  /**
+   * Set the origin of the plane.
+   * @param {Vector3} origin The coordinate of the origin point.
+   */
+  setOrigin(origin: Vector3): boolean;
+
+  /**
+   * Set the origin of the plane.
+   * @param {Number} x The x coordinate of the origin point.
+   * @param {Number} y The y coordinate of the origin point.
+   * @param {Number} z The z coordinate of the origin point.
+   */
+  setOrigin(x: number, y: number, z: number): boolean;
+
+  /**
+   * Set the origin of the plane.
+   * @param {Vector3} origin The coordinate of the origin point.
+   */
+  setOriginFrom(origin: Vector3): boolean;
+
+  /**
+   * Specify a point defining the first axis of the plane.
+   * @param {Number} x The x coordinate.
+   * @param {Number} y The y coordinate.
+   * @param {Number} z The z coordinate.
+   */
+  setPoint1(x: number, y: number, z: number): boolean;
+
+  /**
+   * Specify a point defining the first axis of the plane.
+   * @param {Vector3} point1
+   */
+  setPoint1(point1: Vector3): boolean;
+
+  /**
+   * Specify a point defining the second axis of the plane.
+   * @param {Number} x The x coordinate.
+   * @param {Number} y The y coordinate.
+   * @param {Number} z The z coordinate.
+   */
+  setPoint2(x: number, y: number, z: number): boolean;
+
+  /**
+   * Specify a point defining the second axis of the plane.
+   * @param {Vector3} point2
+   */
+  setPoint2(point2: Vector3): boolean;
+
+  /**
+   * Set the number of facets used to represent the cone.
+   * @param {Number} xResolution
+   */
+  setXResolution(xResolution: number): boolean;
+
+  /**
+   * Set the number of facets used to represent the cone.
+   * @param {Number} yResolution
+   */
+  setYResolution(yResolution: number): boolean;
+
+  /**
+   *
+   * @param {vec3} v1
+   * @param {vec3} v2
+   */
+  updatePlane(v1: vec3, v2: vec3): boolean;
 }
 
 /**
@@ -214,13 +216,19 @@ export interface vtkPlaneSource extends vtkPlaneSourceBase {
  * @param model object on which data structure will be bounds (protected)
  * @param {IPlaneSourceInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IPlaneSourceInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IPlaneSourceInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkPlaneSource.
  * @param {IPlaneSourceInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: IPlaneSourceInitialValues): vtkPlaneSource;
+export function newInstance(
+  initialValues?: IPlaneSourceInitialValues
+): vtkPlaneSource;
 
 /**
  * vtkPlaneSource creates an m x n array of quadrilaterals arranged as a regular
@@ -229,20 +237,20 @@ export function newInstance(initialValues?: IPlaneSourceInitialValues): vtkPlane
  * These axes do not have to be orthogonal - so you can create a parallelogram.
  * (The axes must not be parallel.) The resolution of the plane (i.e., number of
  * subdivisions) is controlled by the ivars XResolution and YResolution.
- * 
+ *
  * By default, the plane is centered at the origin and perpendicular to the z-axis,
  * with width and height of length 1 and resolutions set to 1.
- * 
+ *
  * @example
  * ```js
  * import vtkPlaneSource from '@kitware/vtk.js/Filters/Sources/PlaneSource';
- * 
+ *
  * const plane = vtkPlaneSource.newInstance({ xResolution: 10, yResolution: 10 });
  * const polydata = plane.getOutputData();
  * ```
  */
 export declare const vtkPlaneSource: {
-	newInstance: typeof newInstance,
-	extend: typeof extend,
+  newInstance: typeof newInstance;
+  extend: typeof extend;
 };
 export default vtkPlaneSource;

package/Filters/Sources/PointSource.d.ts

@@ -2,88 +2,90 @@ import { vtkAlgorithm, vtkObject } from './../../interfaces';
 import { Vector3 } from './../../types';
 
 /**
- * 
+ *
  */
 export interface IPointSourceInitialValues {
-	numberOfPoints?: number;
-	center?: Vector3;
-	radius?: number;
-	pointType?: string;
+  numberOfPoints?: number;
+  center?: Vector3;
+  radius?: number;
+  pointType?: string;
 }
 
-type vtkPointSourceBase = vtkObject & Omit<vtkAlgorithm,
-	| 'getInputData'
-	| 'setInputData'
-	| 'setInputConnection'
-	| 'getInputConnection'
-	| 'addInputConnection'
-	| 'addInputData'>;
+type vtkPointSourceBase = vtkObject &
+  Omit<
+    vtkAlgorithm,
+    | 'getInputData'
+    | 'setInputData'
+    | 'setInputConnection'
+    | 'getInputConnection'
+    | 'addInputConnection'
+    | 'addInputData'
+  >;
 
 export interface vtkPointSource extends vtkPointSourceBase {
-
-	/**
-	 * Get the center of the plane.
-	 * @default [0, 0, 0]
-	 */
-	getCenter(): Vector3;
-
-	/**
-	 * Get the center of the plane.
-	 */
-	getCenterByReference(): Vector3;
-
-	/**
-	 * Get the number of points to generate.
-	 * @default 10
-	 */
-	getNumberOfPoints(): number;
-
-	/**
-	 * Get the radius of the point cloud.
-	 * @default 0.5
-	 */
-	getRadius(): number;
-
-	/**
-	 * 
-	 * @param inData 
-	 * @param outData 
-	 */
-	requestData(inData: any, outData: any): void;
-
-	/**
-	 * Set the center of the point cloud.
-	 * @param {Number} x The x coordinate.
-	 * @param {Number} y The y coordinate.
-	 * @param {Number} z The z coordinate.
-	 */
-	setCenter(x: number, y: number, z: number): boolean;
-
-	/**
-	 * Set the center of the point cloud.
-	 * @param {Vector3} center The center point's coordinates.
-	 */
-	setCenter(center: Vector3): boolean;
-
-	/**
-	 * Set the center of the point cloud.
-	 * @param {Vector3} center The center point's coordinates.
-	 */
-	setCenterFrom(center: Vector3): boolean;
-
-	/**
-	 * Set the number of points to generate.
-	 * @param {Number} numberOfPoints The number of points to generate.
-	 */
-	setNumberOfPoints(numberOfPoints: number): boolean;
-
-	/**
-	 * Set the radius of the point cloud. If you are generating a Gaussian
-	 * distribution, then this is the standard deviation for each of x, y, and
-	 * z.
-	 * @param {Number} radius The radius value.
-	 */
-	setRadius(radius: number): boolean;
+  /**
+   * Get the center of the plane.
+   * @default [0, 0, 0]
+   */
+  getCenter(): Vector3;
+
+  /**
+   * Get the center of the plane.
+   */
+  getCenterByReference(): Vector3;
+
+  /**
+   * Get the number of points to generate.
+   * @default 10
+   */
+  getNumberOfPoints(): number;
+
+  /**
+   * Get the radius of the point cloud.
+   * @default 0.5
+   */
+  getRadius(): number;
+
+  /**
+   *
+   * @param inData
+   * @param outData
+   */
+  requestData(inData: any, outData: any): void;
+
+  /**
+   * Set the center of the point cloud.
+   * @param {Number} x The x coordinate.
+   * @param {Number} y The y coordinate.
+   * @param {Number} z The z coordinate.
+   */
+  setCenter(x: number, y: number, z: number): boolean;
+
+  /**
+   * Set the center of the point cloud.
+   * @param {Vector3} center The center point's coordinates.
+   */
+  setCenter(center: Vector3): boolean;
+
+  /**
+   * Set the center of the point cloud.
+   * @param {Vector3} center The center point's coordinates.
+   */
+  setCenterFrom(center: Vector3): boolean;
+
+  /**
+   * Set the number of points to generate.
+   * @param {Number} numberOfPoints The number of points to generate.
+   */
+  setNumberOfPoints(numberOfPoints: number): boolean;
+
+  /**
+   * Set the radius of the point cloud. If you are generating a Gaussian
+   * distribution, then this is the standard deviation for each of x, y, and
+   * z.
+   * @param {Number} radius The radius value.
+   */
+  setRadius(radius: number): boolean;
 }
 
 /**
@@ -93,13 +95,19 @@ export interface vtkPointSource extends vtkPointSourceBase {
  * @param model object on which data structure will be bounds (protected)
  * @param {IPointSourceInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IPointSourceInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IPointSourceInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkPointSource.
  * @param {IPointSourceInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: IPointSourceInitialValues): vtkPointSource;
+export function newInstance(
+  initialValues?: IPointSourceInitialValues
+): vtkPointSource;
 
 /**
  * vtkPointSource is a source object that creates a user-specified number of
@@ -108,17 +116,17 @@ export function newInstance(initialValues?: IPointSourceInitialValues): vtkPoint
  * generate random points only on the surface of the sphere. The output PolyData
  * has the specified number of points and 1 cell - a vtkPolyVertex containing
  * all of the points.
- * 
+ *
  * @example
  * ```js
  * import vtkPointSource from '@kitware/vtk.js/Filters/Sources/PointSource';
- * 
+ *
  * const point = vtkPointSource.newInstance({ numberOfPoints: 10 });
  * const polydata = point.getOutputData();
  * ```
  */
 export declare const vtkPointSource: {
-	newInstance: typeof newInstance,
-	extend: typeof extend,
+  newInstance: typeof newInstance;
+  extend: typeof extend;
 };
 export default vtkPointSource;