@kitware/vtk.js 30.5.3 → 30.6.1

package/IO/Geometry/PLYWriter.d.ts

@@ -1,153 +1,154 @@
-import { mat4 } from "gl-matrix";
+import { mat4 } from 'gl-matrix';
 import vtkPolyData from './../../Common/DataModel/PolyData';
 import { vtkAlgorithm, vtkObject } from './../../interfaces';
 
 export enum FormatTypes {
-	ASCII,
-	BINARY
+  ASCII,
+  BINARY,
 }
 
 export enum TextureCoordinatesName {
-	UV,
-	TEXTURE_UV
+  UV,
+  TEXTURE_UV,
 }
 
 /**
- * 
+ *
  */
 export interface IPLYWriterInitialValues {
-	format?: FormatTypes,
-	dataByteOrder?: number,
-	comments?: string[],
-	textureFileName?: string,
-	textureCoordinatesName?: TextureCoordinatesName,
-	transform?: mat4,
-	withNormals?: boolean,
-	withUVs?: boolean,
-	withColors?: boolean,
-	withIndice?: boolean
+  format?: FormatTypes;
+  dataByteOrder?: number;
+  comments?: string[];
+  textureFileName?: string;
+  textureCoordinatesName?: TextureCoordinatesName;
+  transform?: mat4;
+  withNormals?: boolean;
+  withUVs?: boolean;
+  withColors?: boolean;
+  withIndice?: boolean;
 }
 
 type vtkPLYWriterBase = vtkObject & vtkAlgorithm;
 
 export interface vtkPLYWriter extends vtkPLYWriterBase {
-
-	/**
-	 * Get byte order value.
-	 */
-	getDataByteOrder(): number;
-
-	/**
-	 * Get file format value.
-	 */
-	getFormat(): FormatTypes;
-
-	/**
-	 * Get header comments.
-	 */
-	getHeaderComments(): string[];
-
-	/**
-	 * Get textures mapping coordinates format.
-	 */
-	getTextureCoordinatesName(): TextureCoordinatesName;
-
-	/**
-	 * Get texture filename.
-	 */
-	getTextureFileName(): string;
-
-	/**
-	 * Get transformation matrix.
-	 */
-	getTransform(): mat4;
-
-	/**
-	 * Get whether colors values are included.
-	 */
-	getWithColors(): boolean;
-
-	/**
-	 * Get whether indices are included.
-	 */
-	getWithIndices(): boolean;
-
-	/**
-	 * Get whether normals are included.
-	 */
-	getWithNormals(): boolean;
-
-	/**
-	 * Get textures mapping coordinates.
-	 */
-	getWithUVs(): boolean;
-
-	/**
-	 *
-	 * @param inData 
-	 * @param outData 
-	 */
-	requestData(inData: any, outData: any): void;
-
-	/**
-	 * Set byte order.
-	 * @param {Number} byteOrder Byte order.
-	 */
-	setDataByteOrder(byteOrder: number): boolean;
-
-	/**
-	 * Set file format.
-	 * @param {FormatTypes} format File format.
-	 */
-	setFormat(format: FormatTypes): boolean;
-
-	/**
-	 * Set header comments.
-	 * @param {String[]} headerComments Header comments.
-	 */
-	setHeaderComments(headerComments: string[]): boolean;
-
-	/**
-	 * Set textures coordinates format.
-	 * @param {TextureCoordinatesName} textureCoordinatesName Textures mapping coordinates format.
-	 */
-	setTextureCoordinatesName(textureCoordinatesName: TextureCoordinatesName): boolean;
-
-	/**
-	 * Set texture filename.
-	 * @param {String} textureFileName Texture filename.
-	 */
-	setTextureFileName(textureFileName: string): boolean;
-
-	/**
-	 * Set tranformation matrix.
-	 * @param {mat4} transform Tranformation matrix.
-	 */
-	setTransform(transform: mat4): boolean;
-
-	/**
-	 * Set colors values.
-	 * @param {Boolean} withColors Include colors.
-	 */
-	setWithColors(withColors: boolean): boolean;
-
-	/**
-	 * Set indices values.
-	 * @param {Boolean} withIndices Include indices.
-	 */
-	setWithIndices(withIndices: boolean): boolean;
-
-	/**
-	 * Set normals values.
-	 * @param {Boolean} withNormals Include normals.
-	 */
-	setWithNormals(withNormals: boolean): boolean;
-
-	/**
-	 * Set UVs values.
-	 * @param {Boolean} withUVs Include textures mapping coordinates.
-	 */
-	setWithUVs(withUVs: boolean): boolean;
+  /**
+   * Get byte order value.
+   */
+  getDataByteOrder(): number;
+
+  /**
+   * Get file format value.
+   */
+  getFormat(): FormatTypes;
+
+  /**
+   * Get header comments.
+   */
+  getHeaderComments(): string[];
+
+  /**
+   * Get textures mapping coordinates format.
+   */
+  getTextureCoordinatesName(): TextureCoordinatesName;
+
+  /**
+   * Get texture filename.
+   */
+  getTextureFileName(): string;
+
+  /**
+   * Get transformation matrix.
+   */
+  getTransform(): mat4;
+
+  /**
+   * Get whether colors values are included.
+   */
+  getWithColors(): boolean;
+
+  /**
+   * Get whether indices are included.
+   */
+  getWithIndices(): boolean;
+
+  /**
+   * Get whether normals are included.
+   */
+  getWithNormals(): boolean;
+
+  /**
+   * Get textures mapping coordinates.
+   */
+  getWithUVs(): boolean;
+
+  /**
+   *
+   * @param inData
+   * @param outData
+   */
+  requestData(inData: any, outData: any): void;
+
+  /**
+   * Set byte order.
+   * @param {Number} byteOrder Byte order.
+   */
+  setDataByteOrder(byteOrder: number): boolean;
+
+  /**
+   * Set file format.
+   * @param {FormatTypes} format File format.
+   */
+  setFormat(format: FormatTypes): boolean;
+
+  /**
+   * Set header comments.
+   * @param {String[]} headerComments Header comments.
+   */
+  setHeaderComments(headerComments: string[]): boolean;
+
+  /**
+   * Set textures coordinates format.
+   * @param {TextureCoordinatesName} textureCoordinatesName Textures mapping coordinates format.
+   */
+  setTextureCoordinatesName(
+    textureCoordinatesName: TextureCoordinatesName
+  ): boolean;
+
+  /**
+   * Set texture filename.
+   * @param {String} textureFileName Texture filename.
+   */
+  setTextureFileName(textureFileName: string): boolean;
+
+  /**
+   * Set tranformation matrix.
+   * @param {mat4} transform Tranformation matrix.
+   */
+  setTransform(transform: mat4): boolean;
+
+  /**
+   * Set colors values.
+   * @param {Boolean} withColors Include colors.
+   */
+  setWithColors(withColors: boolean): boolean;
+
+  /**
+   * Set indices values.
+   * @param {Boolean} withIndices Include indices.
+   */
+  setWithIndices(withIndices: boolean): boolean;
+
+  /**
+   * Set normals values.
+   * @param {Boolean} withNormals Include normals.
+   */
+  setWithNormals(withNormals: boolean): boolean;
+
+  /**
+   * Set UVs values.
+   * @param {Boolean} withUVs Include textures mapping coordinates.
+   */
+  setWithUVs(withUVs: boolean): boolean;
 }
 
 /**
@@ -157,20 +158,25 @@ export interface vtkPLYWriter extends vtkPLYWriterBase {
  * @param model object on which data structure will be bounds (protected)
  * @param {IPLYWriterInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IPLYWriterInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IPLYWriterInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkPLYWriter
  * @param {IPLYWriterInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: IPLYWriterInitialValues): vtkPLYWriter;
-
+export function newInstance(
+  initialValues?: IPLYWriterInitialValues
+): vtkPLYWriter;
 
 /**
- * 
- * @param {vktPolyData} polyData 
- * @param {FormatTypes} [format] 
- * @param {Number} [dataByteOrder] 
+ *
+ * @param {vktPolyData} polyData
+ * @param {FormatTypes} [format]
+ * @param {Number} [dataByteOrder]
  * @param {String[]} [comments] Header comments.
  * @param {String} [textureFileName] Texture file n coordinates name.
  * @param {TextureCoordinatesName} [textureCoordinatesName] Textures mapping coordinates format.
@@ -180,10 +186,19 @@ export function newInstance(initialValues?: IPLYWriterInitialValues): vtkPLYWrit
  * @param {Boolean} [withColors] Include colors.
  * @param {Boolean} [withIndice] Include indice.
  */
-export function writePLY(polyData: vtkPolyData, format?: FormatTypes, 
-	dataByteOrder?: number, comments?: string[], textureFileName?: string, 
-	textureCoordinatesName?: TextureCoordinatesName, transform?: mat4, withNormals?: boolean, 
-	withUVs?: boolean, withColors?: boolean, withIndice?: boolean): vtkPolyData;
+export function writePLY(
+  polyData: vtkPolyData,
+  format?: FormatTypes,
+  dataByteOrder?: number,
+  comments?: string[],
+  textureFileName?: string,
+  textureCoordinatesName?: TextureCoordinatesName,
+  transform?: mat4,
+  withNormals?: boolean,
+  withUVs?: boolean,
+  withColors?: boolean,
+  withIndice?: boolean
+): vtkPolyData;
 
 /**
  * vtkPLYWriter writes polygonal data in Stanford University PLY format (see
@@ -196,8 +211,8 @@ export function writePLY(polyData: vtkPolyData, format?: FormatTypes,
  * specify a vtkLookupTable to map the scalars to RGB.
  */
 export declare const vtkPLYWriter: {
-	newInstance: typeof newInstance;
-	extend: typeof extend;
-	writePLY: typeof writePLY;
-}
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+  writePLY: typeof writePLY;
+};
 export default vtkPLYWriter;

package/IO/Geometry/STLReader.d.ts

@@ -4,86 +4,96 @@ import HttpDataAccessHelper from './../Core/DataAccessHelper/HttpDataAccessHelpe
 import JSZipDataAccessHelper from './../Core/DataAccessHelper/JSZipDataAccessHelper';
 import LiteHttpDataAccessHelper from './../Core/DataAccessHelper/LiteHttpDataAccessHelper';
 
-
 interface ISTLReaderOptions {
-	binary?: boolean;
-	compression?: string;
-	progressCallback?: any;
+  binary?: boolean;
+  compression?: string;
+  progressCallback?: any;
 }
 
 /**
- * 
+ *
  */
 export interface ISTLReaderInitialValues {}
 
-type vtkSTLReaderBase = vtkObject & Omit<vtkAlgorithm,
-	| 'getInputData'
-	| 'setInputData'
-	| 'setInputConnection'
-	| 'getInputConnection'
-	| 'addInputConnection'
-	| 'addInputData'>;
+type vtkSTLReaderBase = vtkObject &
+  Omit<
+    vtkAlgorithm,
+    | 'getInputData'
+    | 'setInputData'
+    | 'setInputConnection'
+    | 'getInputConnection'
+    | 'addInputConnection'
+    | 'addInputData'
+  >;
 
 export interface vtkSTLReader extends vtkSTLReaderBase {
-
-	/**
-	 * 
-	 */
-	getBaseURL(): string;
-
-	/**
-	 * 
-	 */
-	getDataAccessHelper(): HtmlDataAccessHelper | HttpDataAccessHelper | JSZipDataAccessHelper | LiteHttpDataAccessHelper;
-
-	/**
-	 * Get the url of the object to load.
-	 */
-	getUrl(): string;
-
-	/**
-	 * Load the object data.
-	 * @param {ISTLReaderOptions} [options] 
-	 */
-	loadData(options?: ISTLReaderOptions): Promise<any>;
-
-	/**
-	 * Parse data.
-	 * @param {String | ArrayBuffer} content The content to parse.
-	 */
-	parse(content: string | ArrayBuffer): void;
-
-	/**
-	 * Parse data as ArrayBuffer.
-	 * @param {ArrayBuffer} content The content to parse. 
-	 */
-	parseAsArrayBuffer(content: ArrayBuffer): void;
-
-	/**
-	 * Parse data as text.
-	 * @param {String} content The content to parse. 
-	 */
-	parseAsText(content: string): void;
-	/**
-	 *
-	 * @param inData 
-	 * @param outData 
-	 */
-	requestData(inData: any, outData: any): void;
-
-	/**
-	 * 
-	 * @param dataAccessHelper 
-	 */
-	setDataAccessHelper(dataAccessHelper: HtmlDataAccessHelper | HttpDataAccessHelper | JSZipDataAccessHelper | LiteHttpDataAccessHelper): boolean;
-
-
-	/**
-	 * Set the url of the object to load.
-	 * @param {String} url the url of the object to load.
-	 * @param {ISTLReaderOptions} [option] The STL reader options.
-	 */
-	setUrl(url: string, option?: ISTLReaderOptions): Promise<string | any>;
+  /**
+   *
+   */
+  getBaseURL(): string;
+
+  /**
+   *
+   */
+  getDataAccessHelper():
+    | HtmlDataAccessHelper
+    | HttpDataAccessHelper
+    | JSZipDataAccessHelper
+    | LiteHttpDataAccessHelper;
+
+  /**
+   * Get the url of the object to load.
+   */
+  getUrl(): string;
+
+  /**
+   * Load the object data.
+   * @param {ISTLReaderOptions} [options]
+   */
+  loadData(options?: ISTLReaderOptions): Promise<any>;
+
+  /**
+   * Parse data.
+   * @param {String | ArrayBuffer} content The content to parse.
+   */
+  parse(content: string | ArrayBuffer): void;
+
+  /**
+   * Parse data as ArrayBuffer.
+   * @param {ArrayBuffer} content The content to parse.
+   */
+  parseAsArrayBuffer(content: ArrayBuffer): void;
+
+  /**
+   * Parse data as text.
+   * @param {String} content The content to parse.
+   */
+  parseAsText(content: string): void;
+  /**
+   *
+   * @param inData
+   * @param outData
+   */
+  requestData(inData: any, outData: any): void;
+
+  /**
+   *
+   * @param dataAccessHelper
+   */
+  setDataAccessHelper(
+    dataAccessHelper:
+      | HtmlDataAccessHelper
+      | HttpDataAccessHelper
+      | JSZipDataAccessHelper
+      | LiteHttpDataAccessHelper
+  ): boolean;
+
+  /**
+   * Set the url of the object to load.
+   * @param {String} url the url of the object to load.
+   * @param {ISTLReaderOptions} [option] The STL reader options.
+   */
+  setUrl(url: string, option?: ISTLReaderOptions): Promise<string | any>;
 }
 
 /**
@@ -93,14 +103,19 @@ export interface vtkSTLReader extends vtkSTLReaderBase {
  * @param model object on which data structure will be bounds (protected)
  * @param {ISTLReaderInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: ISTLReaderInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: ISTLReaderInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkSTLReader
  * @param {ISTLReaderInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: ISTLReaderInitialValues): vtkSTLReader;
-
+export function newInstance(
+  initialValues?: ISTLReaderInitialValues
+): vtkSTLReader;
 
 /**
  * vtkSTLReader is a source object that reads ASCII or binary stereo lithography
@@ -109,7 +124,7 @@ export function newInstance(initialValues?: ISTLReaderInitialValues): vtkSTLRead
  * definitions.
  */
 export declare const vtkSTLReader: {
-	newInstance: typeof newInstance;
-	extend: typeof extend;
-}
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
 export default vtkSTLReader;