@kitware/vtk.js 30.6.0 → 30.6.2

package/Filters/Sources/Arrow2DSource.d.ts

@@ -2,155 +2,157 @@ import { vtkAlgorithm, vtkObject } from './../../interfaces';
 import { Vector3 } from './../../types';
 
 export enum ShapeType {
-	TRIANGLE,
-	STAR,
-	ARROW_4,
-	ARROW_6
+  TRIANGLE,
+  STAR,
+  ARROW_4,
+  ARROW_6,
 }
 
 /**
  *
  */
 export interface IArrow2DSourceInitialValues {
-	base?: number;
-	height?: number;
-	width?: number;
-	thickness?: number;
-	center?: Vector3;
-	pointType?: string;
-	origin?: Vector3;
-	direction?: Vector3;
+  base?: number;
+  height?: number;
+  width?: number;
+  thickness?: number;
+  center?: Vector3;
+  pointType?: string;
+  origin?: Vector3;
+  direction?: Vector3;
 }
 
-type vtkArrow2DSourceBase = vtkObject & Omit<vtkAlgorithm,
-	| 'getInputData'
-	| 'setInputData'
-	| 'setInputConnection'
-	| 'getInputConnection'
-	| 'addInputConnection'
-	| 'addInputData'>;
+type vtkArrow2DSourceBase = vtkObject &
+  Omit<
+    vtkAlgorithm,
+    | 'getInputData'
+    | 'setInputData'
+    | 'setInputConnection'
+    | 'getInputConnection'
+    | 'addInputConnection'
+    | 'addInputData'
+  >;
 
 export interface vtkArrow2DSource extends vtkArrow2DSourceBase {
-
-	/**
-	 * Get the cap the base of the cone with a polygon.
-	 * @default 0
-	 */
-	getBase(): number;
-
-	/**
-	 * Get the center of the cone.
-	 * @default [0, 0, 0]
-	 */
-	getCenter(): Vector3;
-
-	/**
-	 * Get the center of the cone.
-	 */
-	getCenterByReference(): Vector3;
-
-	/**
-	 * Get the orientation vector of the cone.
-	 * @default [1.0, 0.0, 0.0]
-	 */
-	getDirection(): Vector3;
-
-	/**
-	 * Get the orientation vector of the cone.
-	 */
-	getDirectionByReference(): Vector3;
-
-	/**
-	 * Get the height of the cone.
-	 * @default 1.0
-	 */
-	getHeight(): number;
-
-	/**
-	 * Get the base thickness of the cone.
-	 * @default 0.5
-	 */
-	getThickness(): number;
-
-	/**
-	 * Get the number of facets used to represent the cone.
-	 * @default 6
-	 */
-	getWidth(): number;
-
-	/**
-	 * Expose methods
-	 * @param inData 
-	 * @param outData 
-	 */
-	requestData(inData: any, outData: any): void;
-
-	/**
-	 * Turn on/off whether to cap the base of the cone with a polygon.
-	 * @param {Number} base The value of the 
-	 */
-	setBase(base: number): 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} x The x coordinate.
-	 * @param {Number} y The y coordinate.
-	 * @param {Number} z The z coordinate.
-	 * @default [0, 0, 0]
-	 */
-	setCenter(x: number, y: number, z: number): 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 {Vector3} center The center of the cone coordinates.
-	 * @default [0, 0, 0]
-	 */
-	setCenterFrom(center: Vector3): boolean;
-
-	/**
-	 * Set the direction for the arrow.
-	 * @param {Number} x The x coordinate.
-	 * @param {Number} y The y coordinate.
-	 * @param {Number} z The z coordinate.
-	 */
-	setDirection(x: number, y: number, z: number): boolean;
-
-	/**
-	 * Set the direction for the arrow 2D.
-	 * @param {Vector3} direction The direction coordinates.
-	 */
-	setDirection(direction: Vector3): boolean;
-
-	/**
-	 * Set the direction for the arrow 2D.
-	 * @param {Vector3} direction The direction coordinates.
-	 */
-	setDirectionFrom(direction: Vector3): boolean;
-
-	/**
-	 * Set the height of the cone.
-	 * This is the height along the cone in its specified direction.
-	 * @param {Number} height The height value.
-	 */
-	setHeight(height: number): boolean;
-
-	/**
-	 * Set the base thickness of the cone.
-	 * @param {Number} thickness The thickness value.
-	 */
-	setThickness(thickness: number): boolean;
-
-	/**
-	 * Set the number of facets used to represent the cone.
-	 * @param {Number} width The width value.
-	 */
-	setWidth(width: number): boolean;
+  /**
+   * Get the cap the base of the cone with a polygon.
+   * @default 0
+   */
+  getBase(): number;
+
+  /**
+   * Get the center of the cone.
+   * @default [0, 0, 0]
+   */
+  getCenter(): Vector3;
+
+  /**
+   * Get the center of the cone.
+   */
+  getCenterByReference(): Vector3;
+
+  /**
+   * Get the orientation vector of the cone.
+   * @default [1.0, 0.0, 0.0]
+   */
+  getDirection(): Vector3;
+
+  /**
+   * Get the orientation vector of the cone.
+   */
+  getDirectionByReference(): Vector3;
+
+  /**
+   * Get the height of the cone.
+   * @default 1.0
+   */
+  getHeight(): number;
+
+  /**
+   * Get the base thickness of the cone.
+   * @default 0.5
+   */
+  getThickness(): number;
+
+  /**
+   * Get the number of facets used to represent the cone.
+   * @default 6
+   */
+  getWidth(): number;
+
+  /**
+   * Expose methods
+   * @param inData
+   * @param outData
+   */
+  requestData(inData: any, outData: any): void;
+
+  /**
+   * Turn on/off whether to cap the base of the cone with a polygon.
+   * @param {Number} base The value of the
+   */
+  setBase(base: number): 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} x The x coordinate.
+   * @param {Number} y The y coordinate.
+   * @param {Number} z The z coordinate.
+   * @default [0, 0, 0]
+   */
+  setCenter(x: number, y: number, z: number): 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 {Vector3} center The center of the cone coordinates.
+   * @default [0, 0, 0]
+   */
+  setCenterFrom(center: Vector3): boolean;
+
+  /**
+   * Set the direction for the arrow.
+   * @param {Number} x The x coordinate.
+   * @param {Number} y The y coordinate.
+   * @param {Number} z The z coordinate.
+   */
+  setDirection(x: number, y: number, z: number): boolean;
+
+  /**
+   * Set the direction for the arrow 2D.
+   * @param {Vector3} direction The direction coordinates.
+   */
+  setDirection(direction: Vector3): boolean;
+
+  /**
+   * Set the direction for the arrow 2D.
+   * @param {Vector3} direction The direction coordinates.
+   */
+  setDirectionFrom(direction: Vector3): boolean;
+
+  /**
+   * Set the height of the cone.
+   * This is the height along the cone in its specified direction.
+   * @param {Number} height The height value.
+   */
+  setHeight(height: number): boolean;
+
+  /**
+   * Set the base thickness of the cone.
+   * @param {Number} thickness The thickness value.
+   */
+  setThickness(thickness: number): boolean;
+
+  /**
+   * Set the number of facets used to represent the cone.
+   * @param {Number} width The width value.
+   */
+  setWidth(width: number): boolean;
 }
 
 /**
@@ -160,13 +162,19 @@ export interface vtkArrow2DSource extends vtkArrow2DSourceBase {
  * @param model object on which data structure will be bounds (protected)
  * @param {IArrow2DSourceInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IArrow2DSourceInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IArrow2DSourceInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkArrow2DSource.
  * @param {IArrow2DSourceInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: IArrow2DSourceInitialValues): vtkArrow2DSource;
+export function newInstance(
+  initialValues?: IArrow2DSourceInitialValues
+): vtkArrow2DSource;
 
 /**
  * vtkArrow2DSource creates a cone centered at a specified point and pointing in a specified direction.
@@ -177,7 +185,7 @@ export function newInstance(initialValues?: IArrow2DSourceInitialValues): vtkArr
  * and to specify the height and thickness of the cone.
  */
 export declare const vtkArrow2DSource: {
-	newInstance: typeof newInstance,
-	extend: typeof extend,
+  newInstance: typeof newInstance;
+  extend: typeof extend;
 };
 export default vtkArrow2DSource;

package/Filters/Sources/ArrowSource.d.ts

@@ -2,162 +2,170 @@ import { vtkAlgorithm, vtkObject } from './../../interfaces';
 import { Vector3 } from './../../types';
 
 export enum ShapeType {
-	TRIANGLE,
-	STAR,
-	ARROW_4,
-	ARROW_6
+  TRIANGLE,
+  STAR,
+  ARROW_4,
+  ARROW_6,
 }
 
 /**
  *
  */
 export interface IArrowSourceInitialValues {
-	tipResolution?: number;
-	tipRadius?: number;
-	tipLength?: number;
-	shaftResolution?: number;
-	shaftRadius?: number;
-	invert?: boolean;
-	direction?: Vector3;
-	pointType?: string;
+  tipResolution?: number;
+  tipRadius?: number;
+  tipLength?: number;
+  shaftResolution?: number;
+  shaftRadius?: number;
+  invert?: boolean;
+  direction?: Vector3;
+  pointType?: string;
 }
 
-type vtkArrowSourceBase = vtkObject & Omit<vtkAlgorithm,
-	| 'getInputData'
-	| 'setInputData'
-	| 'setInputConnection'
-	| 'getInputConnection'
-	| 'addInputConnection'
-	| 'addInputData'>;
+type vtkArrowSourceBase = vtkObject &
+  Omit<
+    vtkAlgorithm,
+    | 'getInputData'
+    | 'setInputData'
+    | 'setInputConnection'
+    | 'getInputConnection'
+    | 'addInputConnection'
+    | 'addInputData'
+  >;
 
 export interface vtkArrowSource extends vtkArrowSourceBase {
-
-	/**
-	 * Get the orientation vector of the cone.
-	 * @default [1.0, 0.0, 0.0]
-	 */
-	getDirection(): Vector3;
-
-	/**
-	 * Get the orientation vector of the cone.
-	 */
-	getDirectionByReference(): Vector3;
-
-	/**
-	 *
-	 * @default false
-	 */
-	getInvert(): boolean;
-
-	/**
-	 * Get the resolution of the shaft.
-	 * @default 0.03
-	 */
-	getShaftRadius(): number;
-
-	/**
-	 * Get the resolution of the shaft.
-	 * @default 6
-	 */
-	getShaftResolution(): number;
-
-	/**
-	 * Get the length of the tip.
-	 * @default 0.35
-	 */
-	getTipLength(): number;
-
-	/**
-	 * Get the radius of the tip.
-	 * @default 0.1
-	 */
-	getTipRadius(): number;
-
-	/**
-	 * Get the resolution of the tip.
-	 * @default 6
-	 */
-	getTipResolution(): number;
-
-	/**
-	 * Expose methods
-	 * @param inData 
-	 * @param outData 
-	 */
-	requestData(inData: any, outData: any): void;
-
-	/**
-	 * Set the direction for the arrow.
-	 * @param {Number} x The x coordinate.
-	 * @param {Number} y The y coordinate.
-	 * @param {Number} z The z coordinate.
-	 */
-	setDirection(x: number, y: number, z: number): boolean;
-
-	/**
-	 * Set the direction for the arrow.
-	 * @param {Vector3} direction The direction coordinates.
-	 */
-	setDirection(direction: Vector3): boolean;
-
-	/**
-	 * Set the direction for the arrow.
-	 * @param {Vector3} direction The direction coordinates.
-	 */
-	setDirectionFrom(direction: Vector3): boolean;
-
-	/**
-	 * Inverts the arrow direction.
-	 * When set to true, base is at [1, 0, 0] while the tip is at [0, 0, 0].
-	 * @param {Booolean} invert  
-	 */
-	setInvert(invert: boolean): boolean;
-
-	/**
-	 * Set the radius of the shaft.
-	 * @param {Number} shaftRadius  
-	 */
-	setShaftRadius(shaftRadius: number): boolean;
-
-	/**
-	 * Set the resolution of the shaft.
-	 * @param {Number} shaftResolution 
-	 */
-	setShaftResolution(shaftResolution: number): boolean;
-
-	/**
-	 * Set the length of the tip.
-	 * @param {Number} tipLength 
-	 */
-	setTipLength(tipLength: number): boolean;
-
-	/**
-	 * Set the radius of the tip.
-	 * @param {Number} tipRadius 
-	 */
-	setTipRadius(tipRadius: number): boolean;
-
-	/**
-	 * Set the resolution of the tip.
-	 * @param {Number} tipResolution 
-	 */
-	setTipResolution(tipResolution: number): boolean;
+  /**
+   * Get the orientation vector of the cone.
+   * @default [1.0, 0.0, 0.0]
+   */
+  getDirection(): Vector3;
+
+  /**
+   * Get the orientation vector of the cone.
+   */
+  getDirectionByReference(): Vector3;
+
+  /**
+   *
+   * @default false
+   */
+  getInvert(): boolean;
+
+  /**
+   * Get the resolution of the shaft.
+   * @default 0.03
+   */
+  getShaftRadius(): number;
+
+  /**
+   * Get the resolution of the shaft.
+   * @default 6
+   */
+  getShaftResolution(): number;
+
+  /**
+   * Get the length of the tip.
+   * @default 0.35
+   */
+  getTipLength(): number;
+
+  /**
+   * Get the radius of the tip.
+   * @default 0.1
+   */
+  getTipRadius(): number;
+
+  /**
+   * Get the resolution of the tip.
+   * @default 6
+   */
+  getTipResolution(): number;
+
+  /**
+   * Expose methods
+   * @param inData
+   * @param outData
+   */
+  requestData(inData: any, outData: any): void;
+
+  /**
+   * Set the direction for the arrow.
+   * @param {Number} x The x coordinate.
+   * @param {Number} y The y coordinate.
+   * @param {Number} z The z coordinate.
+   */
+  setDirection(x: number, y: number, z: number): boolean;
+
+  /**
+   * Set the direction for the arrow.
+   * @param {Vector3} direction The direction coordinates.
+   */
+  setDirection(direction: Vector3): boolean;
+
+  /**
+   * Set the direction for the arrow.
+   * @param {Vector3} direction The direction coordinates.
+   */
+  setDirectionFrom(direction: Vector3): boolean;
+
+  /**
+   * Inverts the arrow direction.
+   * When set to true, base is at [1, 0, 0] while the tip is at [0, 0, 0].
+   * @param {Booolean} invert
+   */
+  setInvert(invert: boolean): boolean;
+
+  /**
+   * Set the radius of the shaft.
+   * @param {Number} shaftRadius
+   */
+  setShaftRadius(shaftRadius: number): boolean;
+
+  /**
+   * Set the resolution of the shaft.
+   * @param {Number} shaftResolution
+   */
+  setShaftResolution(shaftResolution: number): boolean;
+
+  /**
+   * Set the length of the tip.
+   * @param {Number} tipLength
+   */
+  setTipLength(tipLength: number): boolean;
+
+  /**
+   * Set the radius of the tip.
+   * @param {Number} tipRadius
+   */
+  setTipRadius(tipRadius: number): boolean;
+
+  /**
+   * Set the resolution of the tip.
+   * @param {Number} tipResolution
+   */
+  setTipResolution(tipResolution: number): boolean;
 }
 
 /**
  * Method used to decorate a given object (publicAPI+model) with vtkArrowSource characteristics.
  *
- * @param publicAPI object on which methods will be bounds (public) 
- * @param model object on which data structure will be bounds (protected) 
- * @param {IArrowSourceInitialValues} [initialValues] (default: {}) 
+ * @param publicAPI object on which methods will be bounds (public)
+ * @param model object on which data structure will be bounds (protected)
+ * @param {IArrowSourceInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IArrowSourceInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IArrowSourceInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkArrowSource.
- * @param {IArrowSourceInitialValues} [initialValues] for pre-setting some of its content 
+ * @param {IArrowSourceInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: IArrowSourceInitialValues): vtkArrowSource;
+export function newInstance(
+  initialValues?: IArrowSourceInitialValues
+): vtkArrowSource;
 
 /**
  * vtkArrowSource was intended to be used as the source for a glyph.
@@ -166,11 +174,11 @@ export function newInstance(initialValues?: IArrowSourceInitialValues): vtkArrow
  * The resolution of the cone and shaft can be set and default to 6.
  * The radius of the cone and shaft can be set and default to 0.03 and 0.1.
  * The length of the tip can also be set, and defaults to 0.35.
- * 
+ *
  * @example
  * ```js
  * import vtkArrowSource from '@kitware/vtk.js/Filters/Sources/ArrowSource';
- * 
+ *
  * const arrow = vtkArrowSource.newInstance({
  *   tipResolution: 6,
  *   tipRadius: 0.1,
@@ -183,7 +191,7 @@ export function newInstance(initialValues?: IArrowSourceInitialValues): vtkArrow
  * ```
  */
 export declare const vtkArrowSource: {
-	newInstance: typeof newInstance,
-	extend: typeof extend,
+  newInstance: typeof newInstance;
+  extend: typeof extend;
 };
 export default vtkArrowSource;