Merge pull request #2173 from daker/ts-defs-update

docs(ts): Update Typescript definitions

Author: floryst

Sources/Common/DataModel/PiecewiseFunction/api.md

@@ -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);

Sources/Common/Transform/LandmarkTransform/api.md

@@ -1,4 +1,5 @@
 import { vtkAlgorithm, vtkObject } from "../../../interfaces";
+import { Vector3 } from "../../../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.

Sources/Common/Transform/LandmarkTransform/index.d.ts

@@ -1,4 +1,5 @@
 import { vtkAlgorithm, vtkObject } from "../../../interfaces";
+import { Vector3 } from "../../../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,

Sources/Filters/Sources/Arrow2DSource/index.d.ts

@@ -1,12 +1,13 @@
 import { vtkAlgorithm, vtkObject } from "../../../interfaces";
+import { Vector3 } from "../../../types";
 
 /**
  *
  */
 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();