@kitware/vtk.js 21.1.5 → 21.2.0

package/Common/Transform/LandmarkTransform.d.ts

@@ -89,7 +89,7 @@ export function newInstance(initialValues?: ILandmarkTransformInitialValues): vt
  * 
  * @example
  * '''js
- * import vtkLandmarkTransform from 'vtk.js/Sources/Common/Transform/LandmarkTransform';
+ * import vtkLandmarkTransform from '@kitware/vtk.js/Common/Transform/LandmarkTransform';
  * 
  * const transform = LandmarkTransform.New();
  * transform.setMode(Mode.RIGID_BODY);

package/Filters/Sources/Arrow2DSource.d.ts

@@ -1,4 +1,5 @@
 import { vtkAlgorithm, vtkObject } from '@kitware/vtk.js/interfaces';
+import { Vector3 } from '@kitware/vtk.js/types';
 
 export enum ShapeType {
 	TRIANGLE,
@@ -15,10 +16,10 @@ export interface IArrow2DSourceInitialValues {
 	height?: number;
 	width?: number;
 	thickness?: number;
-	center?: number[];
+	center?: Vector3;
 	pointType?: string;
-	origin?: number[];
-	direction?: number[];
+	origin?: Vector3;
+	direction?: Vector3;
 }
 
 type vtkArrow2DSourceBase = vtkObject & Omit<vtkAlgorithm,
@@ -41,23 +42,23 @@ export interface vtkArrow2DSource extends vtkArrow2DSourceBase {
 	 * Get the center of the cone.
 	 * @default [0, 0, 0]
 	 */
-	getCenter(): number[];
+	getCenter(): Vector3;
 
 	/**
 	 * Get the center of the cone.
 	 */
-	getCenterByReference(): number[];
+	getCenterByReference(): Vector3;
 
 	/**
 	 * Get the orientation vector of the cone.
 	 * @default [1.0, 0.0, 0.0]
 	 */
-	getDirection(): number[];
+	getDirection(): Vector3;
 
 	/**
 	 * Get the orientation vector of the cone.
 	 */
-	getDirectionByReference(): number[];
+	getDirectionByReference(): Vector3;
 
 	/**
 	 * Get the height of the cone.
@@ -107,10 +108,10 @@ export interface vtkArrow2DSource extends vtkArrow2DSourceBase {
 	 * It is located at the middle of the axis of the cone.
 	 * !!! warning
 	 *     This is not the center of the base of the cone!
-	 * @param {Number[]} center The center of the cone coordinates.
+	 * @param {Vector3} center The center of the cone coordinates.
 	 * @default [0, 0, 0]
 	 */
-	setCenterFrom(center: number[]): boolean;
+	setCenterFrom(center: Vector3): boolean;
 
 	/**
 	 * Set the direction for the arrow.
@@ -122,15 +123,15 @@ export interface vtkArrow2DSource extends vtkArrow2DSourceBase {
 
 	/**
 	 * Set the direction for the arrow 2D.
-	 * @param {Number[]} direction The direction coordinates.
+	 * @param {Vector3} direction The direction coordinates.
 	 */
-	setDirection(direction: number[]): boolean;
+	setDirection(direction: Vector3): boolean;
 
 	/**
 	 * Set the direction for the arrow 2D.
-	 * @param {Number[]} direction The direction coordinates.
+	 * @param {Vector3} direction The direction coordinates.
 	 */
-	setDirectionFrom(direction: number[]): boolean;
+	setDirectionFrom(direction: Vector3): boolean;
 
 	/**
 	 * Set the height of the cone.

package/Filters/Sources/ArrowSource.d.ts

@@ -1,4 +1,5 @@
 import { vtkAlgorithm, vtkObject } from '@kitware/vtk.js/interfaces';
+import { Vector3 } from '@kitware/vtk.js/types';
 
 export enum ShapeType {
 	TRIANGLE,
@@ -17,7 +18,7 @@ export interface IArrowSourceInitialValues {
 	shaftResolution?: number;
 	shaftRadius?: number;
 	invert?: boolean;
-	direction?: number[];
+	direction?: Vector3;
 	pointType?: string;
 }
 
@@ -35,12 +36,12 @@ export interface vtkArrowSource extends vtkArrowSourceBase {
 	 * Get the orientation vector of the cone.
 	 * @default [1.0, 0.0, 0.0]
 	 */
-	getDirection(): number[];
+	getDirection(): Vector3;
 
 	/**
 	 * Get the orientation vector of the cone.
 	 */
-	getDirectionByReference(): number[];
+	getDirectionByReference(): Vector3;
 
 	/**
 	 *
@@ -95,15 +96,15 @@ export interface vtkArrowSource extends vtkArrowSourceBase {
 
 	/**
 	 * Set the direction for the arrow.
-	 * @param {Number[]} direction The direction coordinates.
+	 * @param {Vector3} direction The direction coordinates.
 	 */
-	setDirection(direction: number[]): boolean;
+	setDirection(direction: Vector3): boolean;
 
 	/**
 	 * Set the direction for the arrow.
-	 * @param {Number[]} direction The direction coordinates.
+	 * @param {Vector3} direction The direction coordinates.
 	 */
-	setDirectionFrom(direction: number[]): boolean;
+	setDirectionFrom(direction: Vector3): boolean;
 
 	/**
 	 * Inverts the arrow direction.
@@ -168,7 +169,7 @@ export function newInstance(initialValues?: IArrowSourceInitialValues): vtkArrow
  * 
  * @example
  * ```js
- * import vtkArrowSource from 'vtk.js/Sources/Filters/Sources/ArrowSource';
+ * import vtkArrowSource from '@kitware/vtk.js/Filters/Sources/ArrowSource';
  * 
  * const arrow = vtkArrowSource.newInstance({
  *   tipResolution: 6,

package/Filters/Sources/CircleSource.d.ts

@@ -1,4 +1,5 @@
 import { vtkAlgorithm, vtkObject } from '@kitware/vtk.js/interfaces';
+import { Vector3 } from '@kitware/vtk.js/types';
 
 /**
  *
@@ -6,7 +7,7 @@ import { vtkAlgorithm, vtkObject } from '@kitware/vtk.js/interfaces';
 export interface ICircleSourceInitialValues {
 	radius?: number;
 	resolution?: number;
-	center?: number[];
+	center?: Vector3;
 	pointType?: string;
 	lines?: boolean;
 	face?: boolean;
@@ -26,23 +27,23 @@ export interface vtkCircleSource extends vtkCircleSourceBase {
 	 * Get the center of the cone.
 	 * @default [0, 0, 0]
 	 */
-	getCenter(): number[];
+	getCenter(): Vector3;
 
 	/**
 	 * Get the center of the cone.
 	 */
-	getCenterByReference(): number[];
+	getCenterByReference(): Vector3;
 
 	/**
 	 * Get the orientation vector of the cone.
 	 * @default [1.0, 0.0, 0.0]
 	 */
-	getDirection(): number[];
+	getDirection(): Vector3;
 
 	/**
 	 * Get the orientation vector of the cone.
 	 */
-	getDirectionByReference(): number[];
+	getDirectionByReference(): Vector3;
 
 	/**
 	 *
@@ -85,15 +86,15 @@ export interface vtkCircleSource extends vtkCircleSourceBase {
 
 	/**
 	 * Set the direction for the circle.
-	 * @param {Number[]} direction The direction coordinates.
+	 * @param {Vector3} direction The direction coordinates.
 	 */
-	setDirection(direction: number[]): boolean;
+	setDirection(direction: Vector3): boolean;
 
 	/**
 	 * Set the direction for the circle.
-	 * @param {Number[]} direction The direction coordinates.
+	 * @param {Vector3} direction The direction coordinates.
 	 */
-	setDirectionFrom(direction: number[]): boolean;
+	setDirectionFrom(direction: Vector3): boolean;
 
 	/**
 	 * Set the center of the circle.
@@ -106,10 +107,10 @@ export interface vtkCircleSource extends vtkCircleSourceBase {
 
 	/**
 	 * Set the center of the circle.
-	 * @param {Number[]} center 
+	 * @param {Vector3} center 
 	 * @default [0, 0, 0]
 	 */
-	setCenterFrom(center: number[]): boolean;
+	setCenterFrom(center: Vector3): boolean;
 
 	/**
 	 *
@@ -125,13 +126,13 @@ export interface vtkCircleSource extends vtkCircleSourceBase {
 
 	/**
 	 * Set the radius of the circle.
-	 * @param {Number} radius 
+	 * @param {Number} radius The radius of the circle.
 	 */
 	setRadius(radius: number): boolean;
 
 	/**
 	 * Set the resolution of the circle.
-	 * @param resolution 
+	 * @param {Number} resolution The resolution of the circle.
 	 */
 	setResolution(resolution: number): boolean;
 }
@@ -157,7 +158,7 @@ export function newInstance(initialValues?: ICircleSourceInitialValues): vtkCirc
  * 
  * @example
  * ```js
- * import vtkCircleSource from 'vtk.js/Sources/Filters/Sources/CircleSource';
+ * import vtkCircleSource from '@kitware/vtk.js/Filters/Sources/CircleSource';
  * 
  * const circle = vtkCircleSource.newInstance({ radius: 1, resolution: 80 });
  * const polydata = circle.getOutputData();

package/Filters/Sources/ConeSource.d.ts

@@ -1,4 +1,5 @@
 import { vtkAlgorithm, vtkObject } from '@kitware/vtk.js/interfaces';
+import { Vector3 } from '@kitware/vtk.js/types';
 
 /**
  *
@@ -7,8 +8,8 @@ export interface IConeSourceInitialValues {
 	height?: number;
 	radius?: number;
 	resolution?: number;
-	center?: number[] ;
-	direction?: number[];
+	center?: Vector3 ;
+	direction?: Vector3;
 	capping?: boolean;
 	pointType?: string;
 }
@@ -33,23 +34,23 @@ export interface vtkConeSource extends vtkConeSourceBase {
 	 * Get the center of the cone.
 	 * @default [0, 0, 0]
 	 */
-	getCenter(): number[];
+	getCenter(): Vector3;
 
 	/**
 	 * Get the center of the cone.
 	 */
-	getCenterByReference(): number[];
+	getCenterByReference(): Vector3;
 
 	/**
 	 * Get the orientation vector of the cone.
 	 * @default [1.0, 0.0, 0.0]
 	 */
-	getDirection(): number[];
+	getDirection(): Vector3;
 
 	/**
 	 * Get the orientation vector of the cone.
 	 */
-	getDirectionByReference(): number[];
+	getDirectionByReference(): Vector3;
 
 	/**
 	 * Get the height of the cone.
@@ -99,20 +100,20 @@ export interface vtkConeSource extends vtkConeSourceBase {
 	 * It is located at the middle of the axis of the cone.
 	 * !!! warning
 	 *     This is not the center of the base of the cone!
-	 * @param {Number[]} center 
+	 * @param {Vector3} center 
 	 * @default [0, 0, 0]
 	 */
-	setCenter(center: number[]): boolean;
+	setCenter(center: Vector3): boolean;
 
 	/**
 	 * Set the center of the cone.
 	 * It is located at the middle of the axis of the cone.
 	 * !!! warning
 	 *     This is not the center of the base of the cone!
-	 * @param {Number[]} center 
+	 * @param {Vector3} center 
 	 * @default [0, 0, 0]
 	 */
-	setCenterFrom(center: number[]): boolean;
+	setCenterFrom(center: Vector3): boolean;
 
 	/**
 	 * Set the direction for the cone.
@@ -125,23 +126,23 @@ export interface vtkConeSource extends vtkConeSourceBase {
 
 	/**
 	 * Set the direction for the cone.
-	 * @param {Number[]} direction The direction coordinates.
+	 * @param {Vector3} direction The direction coordinates.
 	 */
-	setDirection(direction: number[]): boolean;
+	setDirection(direction: Vector3): boolean;
 
 	/**
 	 * Set the direction for the cone.
-	 * @param {Number[]} direction 
+	 * @param {Vector3} direction 
 	 * @default [1, 0, 0]
 	 */
-	setDirection(direction: number[]): boolean;
+	setDirection(direction: Vector3): boolean;
 
 	/**
 	 * Set the direction for the cone.
-	 * @param {Number[]} direction 
+	 * @param {Vector3} direction 
 	 * @default [1, 0, 0]
 	 */
-	setDirectionFrom(direction: number[]): boolean;
+	setDirectionFrom(direction: Vector3): boolean;
 
 	/**
 	 * Set the height of the cone.
@@ -188,7 +189,7 @@ export function newInstance(initialValues ? : IConeSourceInitialValues): vtkCone
  * 
  * @example
  * ```js
- * import vtkConeSource from 'vtk.js/Sources/Filters/Sources/ConeSource';
+ * import vtkConeSource from '@kitware/vtk.js/Filters/Sources/ConeSource';
  * 
  * const cone = vtkConeSource.newInstance({ height: 2, radius: 1, resolution: 80 });
  * const polydata = cone.getOutputData();

package/Filters/Sources/CubeSource.d.ts

@@ -1,5 +1,5 @@
 import { vtkAlgorithm, vtkObject } from '@kitware/vtk.js/interfaces';
-import { Bounds, Point } from '@kitware/vtk.js/types';
+import { Bounds, Vector3 } from '@kitware/vtk.js/types';
 
 /**
  *
@@ -8,8 +8,8 @@ export interface ICircleSourceInitialValues {
 	xLength?: number;
 	yLength?: number;
 	zLength?: number;
-	center?: Point;
-	rotations?: number[];
+	center?: Vector3;
+	rotations?: Vector3;
 	pointType?: string;
 	generate3DTextureCoordinates?: boolean;
 }
@@ -28,12 +28,12 @@ export interface vtkCubeSource extends vtkCubeSourceBase {
 	 * Get the center of the cube.
 	 * @default [0.0, 0.0, 0.0]
 	 */
-	getCenter(): Point;
+	getCenter(): Vector3;
 
 	/**
 	 * Get the center of the cube.
 	 */
-	getCenterByReference(): Point;
+	getCenterByReference(): Vector3;
 
 	/**
 	 *
@@ -45,13 +45,13 @@ export interface vtkCubeSource extends vtkCubeSourceBase {
 	 *
 	 * @default [0.0, 0.0, 0.0]
 	 */
-	getRotations(): number[];
+	getRotations(): Vector3;
 
 	/**
 	 *
-	 * @default false
+	 * @default [0.0, 0.0, 0.0]
 	 */
-	getRotationsByReference(): boolean;
+	getRotationsByReference(): Vector3;
 
 	/**
 	 * Get the length of the cube in the x-direction.
@@ -80,12 +80,12 @@ export interface vtkCubeSource extends vtkCubeSourceBase {
 
 	/**
 	 * Convenience methods allows creation of cube by specifying bounding box.
-	 * @param xMin
-	 * @param xMax
-	 * @param yMin
-	 * @param yMax
-	 * @param zMin
-	 * @param zMax
+	 * @param {Number} xMin 
+	 * @param {Number} xMax 
+	 * @param {Number} yMin 
+	 * @param {Number} yMax 
+	 * @param {Number} zMin 
+	 * @param {Number} zMax 
 	 */
 	setBounds(xMin: number, xMax: number, yMin: number, yMax: number, zMin: number, zMax: number): boolean;
 
@@ -109,7 +109,7 @@ export interface vtkCubeSource extends vtkCubeSourceBase {
 	 * @param center
 	 * @default [0, 0, 0]
 	 */
-	setCenterFrom(center: Point): boolean;
+	setCenterFrom(center: Vector3): boolean;
 
 	/**
 	 *
@@ -127,9 +127,9 @@ export interface vtkCubeSource extends vtkCubeSourceBase {
 
 	/**
 	 *
-	 * @param rotations
+	 * @param {Vector3} rotations
 	 */
-	setRotationsFrom(rotations: number[]): boolean;
+	setRotationsFrom(rotations: Vector3): boolean;
 
 	/**
 	 * Set the length of the cube in the x-direction.
@@ -171,10 +171,10 @@ export function newInstance(initialValues?: ICircleSourceInitialValues): vtkCube
  * 
  * @example
  * ```js
- * import vtkCubeSource from 'vtk.js/Sources/Filters/Sources/CubeSource';
+ * import vtkCubeSource from '@kitware/vtk.js/Filters/Sources/CubeSource';
  * 
  * const cubeSource = vtkCubeSource.newInstance({ xLength: 5, yLength: 5, zLength: 5 });
- * const cubePolydata = cubeSource.getOutputData();
+ * const polydata = cubeSource.getOutputData();
  * ```
  */
 export declare const vtkCubeSource: {

package/Filters/Sources/Cursor3D.d.ts

@@ -1,14 +1,14 @@
 import { vtkAlgorithm, vtkObject } from '@kitware/vtk.js/interfaces';
-
 import vtkPolyData from '@kitware/vtk.js/Common/DataModel/PolyData';
+import { Bounds, Vector3 } from '@kitware/vtk.js/types';
 
 
 /**
  *
  */
 export interface ICursor3DInitialValues {
-	modelBounds?: number[];
-	focalPoint?: number[];
+	modelBounds?: Bounds;
+	focalPoint?: Vector3;
 	outline?: boolean;
 	axes?: boolean;
 	xShadows?: boolean;
@@ -46,12 +46,12 @@ export interface vtkCursor3D extends vtkCursor3DBase {
 	/**
 	 * Get the position of cursor focus.
 	 */
-	getFocalPoint(): number[];
+	getFocalPoint(): Vector3;
 
 	/**
 	 *
 	 */
-	getFocalPointByReference(): number[];
+	getFocalPointByReference(): Vector3;
 
 	/**
 	 *
@@ -63,13 +63,13 @@ export interface vtkCursor3D extends vtkCursor3DBase {
 	 * Set the boundary of the 3D cursor.
 	 * @default [-1.0, 1.0, -1.0, 1.0, -1.0, 1.0]
 	 */
-	getModelBounds(): number[];
+	getModelBounds(): Bounds;
 
 	/**
 	 *
 	 *  @default [-1.0, 1.0, -1.0, 1.0, -1.0, 1.0]
 	 */
-	getModelBoundsByReference(): number[];
+	getModelBoundsByReference(): Bounds;
 
 	/**
 	 *
@@ -127,22 +127,25 @@ export interface vtkCursor3D extends vtkCursor3DBase {
 
 	/**
 	 * Set the position of cursor focus.
-	 * If translation mode is on, then the entire cursor (including bounding box, cursor, and shadows) is
-	 * translated. Otherwise, the focal point will either be clamped to the bounding box, or wrapped, if Wrap is on.
-	 * (Note: this behavior requires that the bounding box is set prior to the focal point.)
-	 * @param {Number[]} points 
+	 * If translation mode is on, then the entire cursor (including bounding
+	 * box, cursor, and shadows) is translated. Otherwise, the focal point will
+	 * either be clamped to the bounding box, or wrapped, if Wrap is on. (Note:
+	 * this behavior requires that the bounding box is set prior to the focal
+	 * point.)
+	 * @param {Vector3} points 
 	 */
-	setFocalPoint(points: number[]): boolean;
+	setFocalPoint(points: Vector3): boolean;
 
 	/**
 	 * Set the boundary of the 3D cursor.
-	 * @param {Number[]} bounds The bounds of the 3D cursor.
+	 * @param {Bounds} bounds The bounds of the 3D cursor.
 	 */
-	setModelBounds(bounds: number[]): boolean;
+	setModelBounds(bounds: Bounds): boolean;
 
 	/**
 	 * Enable/disable the translation mode.
-	 * If on, changes in cursor position cause the entire widget to translate along with the cursor.
+	 * If on, changes in cursor position cause the entire widget to translate
+	 * along with the cursor.
 	 * @param {Boolean} translationMode 
 	 */
 	setTranslationMode(translationMode: boolean): boolean;
@@ -201,7 +204,7 @@ export function newInstance(initialValues?: ICursor3DInitialValues): vtkCursor3D
  * 
  * @example
  * ```js
- * import vtkCursor3D from 'vtk.js/Sources/Filters/Sources/vtkCursor3D';
+ * import vtkCursor3D from '@kitware/vtk.js/Filters/Sources/vtkCursor3D';
  * 
  * const cursor = vtkCursor3D.newInstance({focalPoint: [0, 0, 0], modelBounds: [-100, 100, -100, 100, -100, 100]});
  * const polyData = cursor.getOutputData();

package/Filters/Sources/CylinderSource.d.ts

@@ -1,4 +1,5 @@
 import { vtkAlgorithm, vtkObject } from '@kitware/vtk.js/interfaces';
+import { Vector3 } from '@kitware/vtk.js/types';
 
 /**
  *
@@ -9,8 +10,8 @@ export interface ICylinderSourceInitialValues {
 	otherRadius?: number;
 	radius?: number;
 	resolution?: number;
-	center?: number[];
-	direction?: number[];
+	center?: Vector3;
+	direction?: Vector3;
 	capping?: boolean;
 	pointType?: string;
 }
@@ -35,23 +36,23 @@ export interface vtkCylinderSource extends vtkCylinderSourceBase {
 	 * Get the center of the cylinder.
 	 * @default [0, 0, 0]
 	 */
-	getCenter(): number[];
+	getCenter(): Vector3;
 
 	/**
 	 * Get the center of the cylinder.
 	 */
-	getCenterByReference(): number[];
+	getCenterByReference(): Vector3;
 
 	/**
 	 * Get the orientation vector of the cylinder.
 	 * @default [1.0, 0.0, 0.0]
 	 */
-	getDirection(): number[];
+	getDirection(): Vector3;
 
 	/**
 	 * Get the orientation vector of the cylinder.
 	 */
-	getDirectionByReference(): number[];
+	getDirectionByReference(): Vector3;
 
 	/**
 	 * Get the height of the cylinder.
@@ -111,10 +112,10 @@ export interface vtkCylinderSource extends vtkCylinderSourceBase {
 
 	/**
 	 * Set the center of the cylinder.
-	 * @param {Number[]} center The center point's coordinates.
+	 * @param {Vector3} center The center point's coordinates.
 	 * @default [0, 0, 0]
 	 */
-	setCenterFrom(center: number[]): boolean;
+	setCenterFrom(center: Vector3): boolean;
 
 	/**
 	 * Set the direction for the cylinder.
@@ -126,15 +127,15 @@ export interface vtkCylinderSource extends vtkCylinderSourceBase {
 
 	/**
 	 * Set the direction for the cylinder.
-	 * @param {Number[]} direction The direction coordinates.
+	 * @param {Vector3} direction The direction coordinates.
 	 */
-	setDirection(direction: number[]): boolean;
+	setDirection(direction: Vector3): boolean;
 
 	/**
 	 * Set the direction for the cylinder.
-	 * @param {Number[]} direction The direction coordinates.
+	 * @param {Vector3} direction The direction coordinates.
 	 */
-	setDirectionFrom(direction: number[]): boolean;
+	setDirectionFrom(direction: Vector3): boolean;
 
 	/**
 	 * Set the height of the cylinder.
@@ -146,7 +147,7 @@ export interface vtkCylinderSource extends vtkCylinderSourceBase {
 	 * Set the initial angle along direction.
 	 * @param {Number} initAngle The initial angle in radian.
 	 */
-	setInitAngle(radianAngle: number): boolean;
+	setInitAngle(initAngle: number): boolean;
 
 	/**
 	 * Set the base Z radius of the cylinder.
@@ -194,7 +195,7 @@ export function newInstance(initialValues?: ICylinderSourceInitialValues): vtkCy
  * 
  * @example
  * ```js
- * import vtkCylinderSource from 'vtk.js/Sources/Filters/Sources/CylinderSource';
+ * import vtkCylinderSource from '@kitware/vtk.js/Filters/Sources/CylinderSource';
  * 
  * const cylinder = vtkCylinderSource.newInstance({ height: 2, radius: 1, resolution: 80 });
  * const polydata = cylinder.getOutputData();

package/Filters/Sources/LineSource.d.ts

@@ -119,7 +119,7 @@ export function newInstance(initialValues?: ILineSourceInitialValues): vtkLineSo
  * 
  * @example
  * ```js
- * import vtkLineSource from 'vtk.js/Sources/Filters/Sources/LineSource';
+ * import vtkLineSource from '@kitware/vtk.js/Filters/Sources/LineSource';
  * 
  * const line = vtkLineSource.newInstance({ resolution: 10 });
  * const polydata = line.getOutputData();