@kitware/vtk.js 30.5.3 → 30.6.1

package/Rendering/Core/AbstractImageMapper.d.ts

@@ -1,119 +1,127 @@
-import vtkAbstractMapper3D, { IAbstractMapper3DInitialValues } from './AbstractMapper3D';
+import vtkAbstractMapper3D, {
+  IAbstractMapper3DInitialValues,
+} from './AbstractMapper3D';
 import vtkImageData from './../../Common/DataModel/ImageData';
 import { Bounds, Extent, Nullable, RGBAColor } from './../../types';
 
-
-export interface IAbstractImageMapperInitialValues extends IAbstractMapper3DInitialValues {
-	customDisplayExtent?: number[];
-	useCustomExtents?: boolean;
-	slice?: number;
+export interface IAbstractImageMapperInitialValues
+  extends IAbstractMapper3DInitialValues {
+  customDisplayExtent?: number[];
+  useCustomExtents?: boolean;
+  slice?: number;
 }
 
 export interface vtkAbstractImageMapper extends vtkAbstractMapper3D {
-
-	/**
-	 *
-	 */
-	getIsOpaque(): boolean;
-
-	/**
-  	 * Return currently active image for the mapper. Overridden by deriving classes.
-	 */
-	getCurrentImage(): Nullable<vtkImageData>;
-
-	/**
-	 * Get the slice index.
-	 */
-	getSlice(): number;
-
-	/**
-	 *
-	 * @param {Number} slice The slice index.
-	 */
-	setSlice(slice: number): boolean;
-
-	/**
-	 * Get bounds for a specified slice.
-	 * To be implemented by derived classes.
-	 * @param {Number} slice The slice index. If undefined, the current slice is considered.
-	 * @param {Number} thickness The slice thickness. If undefined, 0 is considered.
-	 */
-	getBoundsForSlice(slice?: number, thickness?: number): Bounds;
-
-	/**
-	 * Return the currently set background color.
-	 */
-	getBackgroundColor(): RGBAColor;
-
-	/**
-	 * Return the currently set background color.
-	 */
-	getBackgroundColorByReference(): RGBAColor;
-
-	/**
-	 * @param r red component of background color
-	 * @param g green component of background color
-	 * @param b blue component of background color
-	 * @param a opacity component of background color
-	 */
-	setBackgroundColor(r: number, g: number, b: number, a: number): boolean;
-
-	/**
-	 *
-	 * @param color specify background color as an array of 4 values.
-	 */
-	setBackgroundColor(color: RGBAColor): boolean;
-
-	/**
-	 *
-	 * @param {RGBAColor} color specify the background color to use
-	 * in RGBA format as an array of 4 values. Values are copied.
-	 */
-	setBackgroundColorFrom(color: RGBAColor): boolean;
-
-	/**
-	 *
-	 */
-	getUseCustomExtents(): boolean;
-
-	/**
-	 *
-	 * @param {Boolean} useCustomExtents
-	 */
-	setUseCustomExtents(useCustomExtents: boolean): boolean;
-
-	/**
-	 *
-	 */
-	getCustomDisplayExtent(): Extent;
-
-	/**
-	 *
-	 */
-	getCustomDisplayExtentByReference(): Extent;
-
-	/**
-	 *
-	 * @param {Number} x1 The x coordinate of the first point.
-	 * @param {Number} x2 The x coordinate of the second point.
-	 * @param {Number} y1 The y coordinate of the first point.
-	 * @param {Number} y2 The y coordinate of the second point.
-	 * @param {Number} z1 The z coordinate of the first point.
-	 * @param {Number} z2 The z coordinate of the second point.
-	 */
-	setCustomDisplayExtent(x1: number, x2: number, y1: number, y2: number, z1: number, z2: number): boolean;
-
-	/**
-	 *
-	 * @param extents specify extents as an array of 6 values [minx, maxx, ...]
-	 */
-	setCustomDisplayExtent(customDisplayExtent: Extent): boolean;
-
-	/**
-	 *
-	 * @param customDisplayExtent
-	 */
-	setCustomDisplayExtentFrom(customDisplayExtent: number[]): boolean;
+  /**
+   *
+   */
+  getIsOpaque(): boolean;
+
+  /**
+   * Return currently active image for the mapper. Overridden by deriving classes.
+   */
+  getCurrentImage(): Nullable<vtkImageData>;
+
+  /**
+   * Get the slice index.
+   */
+  getSlice(): number;
+
+  /**
+   *
+   * @param {Number} slice The slice index.
+   */
+  setSlice(slice: number): boolean;
+
+  /**
+   * Get bounds for a specified slice.
+   * To be implemented by derived classes.
+   * @param {Number} slice The slice index. If undefined, the current slice is considered.
+   * @param {Number} thickness The slice thickness. If undefined, 0 is considered.
+   */
+  getBoundsForSlice(slice?: number, thickness?: number): Bounds;
+
+  /**
+   * Return the currently set background color.
+   */
+  getBackgroundColor(): RGBAColor;
+
+  /**
+   * Return the currently set background color.
+   */
+  getBackgroundColorByReference(): RGBAColor;
+
+  /**
+   * @param r red component of background color
+   * @param g green component of background color
+   * @param b blue component of background color
+   * @param a opacity component of background color
+   */
+  setBackgroundColor(r: number, g: number, b: number, a: number): boolean;
+
+  /**
+   *
+   * @param color specify background color as an array of 4 values.
+   */
+  setBackgroundColor(color: RGBAColor): boolean;
+
+  /**
+   *
+   * @param {RGBAColor} color specify the background color to use
+   * in RGBA format as an array of 4 values. Values are copied.
+   */
+  setBackgroundColorFrom(color: RGBAColor): boolean;
+
+  /**
+   *
+   */
+  getUseCustomExtents(): boolean;
+
+  /**
+   *
+   * @param {Boolean} useCustomExtents
+   */
+  setUseCustomExtents(useCustomExtents: boolean): boolean;
+
+  /**
+   *
+   */
+  getCustomDisplayExtent(): Extent;
+
+  /**
+   *
+   */
+  getCustomDisplayExtentByReference(): Extent;
+
+  /**
+   *
+   * @param {Number} x1 The x coordinate of the first point.
+   * @param {Number} x2 The x coordinate of the second point.
+   * @param {Number} y1 The y coordinate of the first point.
+   * @param {Number} y2 The y coordinate of the second point.
+   * @param {Number} z1 The z coordinate of the first point.
+   * @param {Number} z2 The z coordinate of the second point.
+   */
+  setCustomDisplayExtent(
+    x1: number,
+    x2: number,
+    y1: number,
+    y2: number,
+    z1: number,
+    z2: number
+  ): boolean;
+
+  /**
+   *
+   * @param extents specify extents as an array of 6 values [minx, maxx, ...]
+   */
+  setCustomDisplayExtent(customDisplayExtent: Extent): boolean;
+
+  /**
+   *
+   * @param customDisplayExtent
+   */
+  setCustomDisplayExtentFrom(customDisplayExtent: number[]): boolean;
 }
 
 /**
@@ -123,7 +131,11 @@ export interface vtkAbstractImageMapper extends vtkAbstractMapper3D {
  * @param model object on which data structure will be bounds (protected)
  * @param {IAbstractImageMapperInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IAbstractImageMapperInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IAbstractImageMapperInitialValues
+): void;
 
 /**
  * vtkImageMapper provides 2D image display support for vtk.
@@ -132,6 +144,6 @@ export function extend(publicAPI: object, model: object, initialValues?: IAbstra
  * This class resolves coincident topology with the same methods as vtkMapper.
  */
 export declare const vtkAbstractImageMapper: {
-	extend: typeof extend;
-}
+  extend: typeof extend;
+};
 export default vtkAbstractImageMapper;

package/Rendering/Core/AbstractMapper.d.ts

@@ -1,70 +1,72 @@
 import { vtkAlgorithm, vtkObject } from './../../interfaces';
 import vtkPlane from './../../Common/DataModel/Plane';
-import { mat4 } from "gl-matrix";
+import { mat4 } from 'gl-matrix';
 
 /**
- * 
+ *
  */
 export interface IAbstractMapperInitialValues {
-	clippingPlanes?: vtkPlane[];
+  clippingPlanes?: vtkPlane[];
 }
 
-type vtkAbstractMapperBase = vtkObject & Omit<vtkAlgorithm,
-	| 'getOutputData'
-	| 'getOutputPort'> ;
+type vtkAbstractMapperBase = vtkObject &
+  Omit<vtkAlgorithm, 'getOutputData' | 'getOutputPort'>;
 
 export interface vtkAbstractMapper extends vtkAbstractMapperBase {
+  /**
+   * Added plane needs to be a vtkPlane object.
+   * @param {vtkPlane} plane
+   */
+  addClippingPlane(plane: vtkPlane): boolean;
 
-	/**
-	 * Added plane needs to be a vtkPlane object.
-	 * @param {vtkPlane} plane
-	 */
-	addClippingPlane(plane: vtkPlane): boolean;
-
-	/**
-	 * Get number of clipping planes.
-	 * @return {Number} The number of clipping planes.
-	 */
-	getNumberOfClippingPlanes(): number;
+  /**
+   * Get number of clipping planes.
+   * @return {Number} The number of clipping planes.
+   */
+  getNumberOfClippingPlanes(): number;
 
-	/**
-	 * Get all clipping planes.
-	 * @return {vtkPlane[]} An array of the clipping planes objects
-	 */
-	getClippingPlanes(): vtkPlane[];
+  /**
+   * Get all clipping planes.
+   * @return {vtkPlane[]} An array of the clipping planes objects
+   */
+  getClippingPlanes(): vtkPlane[];
 
-	/**
-	 * Remove all clipping planes.
-	 * @return true if there were planes, false otherwise.
-	 */
-	removeAllClippingPlanes(): boolean;
+  /**
+   * Remove all clipping planes.
+   * @return true if there were planes, false otherwise.
+   */
+  removeAllClippingPlanes(): boolean;
 
-	 /**
-	  * Remove clipping plane.
-	  * @param {vtkPlane} plane
-	  * @return true if plane existed and therefore is removed, false otherwise.
-	  */
-	removeClippingPlane(plane: vtkPlane): boolean;
+  /**
+   * Remove clipping plane.
+   * @param {vtkPlane} plane
+   * @return true if plane existed and therefore is removed, false otherwise.
+   */
+  removeClippingPlane(plane: vtkPlane): boolean;
 
-	/**
-	 * Set clipping planes.
-	 * @param {vtkPlane[]} planes
-	 */
-	setClippingPlanes(planes: vtkPlane[]): void;
+  /**
+   * Set clipping planes.
+   * @param {vtkPlane[]} planes
+   */
+  setClippingPlanes(planes: vtkPlane[]): void;
 
-	/**
-	 * Get the ith clipping plane as a homogeneous plane equation.
-	 * Use getNumberOfClippingPlanes() to get the number of planes.
-	 * @param {mat4} propMatrix
-	 * @param {Number} i
-	 * @param {Number[]} hnormal
-	 */
-	getClippingPlaneInDataCoords(propMatrix : mat4, i : number, hnormal : number[]): void;
+  /**
+   * Get the ith clipping plane as a homogeneous plane equation.
+   * Use getNumberOfClippingPlanes() to get the number of planes.
+   * @param {mat4} propMatrix
+   * @param {Number} i
+   * @param {Number[]} hnormal
+   */
+  getClippingPlaneInDataCoords(
+    propMatrix: mat4,
+    i: number,
+    hnormal: number[]
+  ): void;
 
-	/**
-	 * 
-	 */
-	update(): void;
+  /**
+   *
+   */
+  update(): void;
 }
 
 /**
@@ -74,7 +76,11 @@ export interface vtkAbstractMapper extends vtkAbstractMapperBase {
  * @param model object on which data structure will be bounds (protected)
  * @param {IAbstractMapperInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IAbstractMapperInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IAbstractMapperInitialValues
+): void;
 
 /**
  * vtkAbstractMapper is an abstract class to specify interface between data and
@@ -83,6 +89,6 @@ export function extend(publicAPI: object, model: object, initialValues?: IAbstra
  * data.
  */
 export declare const vtkAbstractMapper: {
-	extend: typeof extend,
+  extend: typeof extend;
 };
 export default vtkAbstractMapper;

package/Rendering/Core/AbstractMapper3D.d.ts

@@ -1,33 +1,36 @@
 import { Bounds, Vector3 } from './../../types';
-import vtkAbstractMapper, { IAbstractMapperInitialValues } from './AbstractMapper';
+import vtkAbstractMapper, {
+  IAbstractMapperInitialValues,
+} from './AbstractMapper';
 
 /**
- * 
+ *
  */
-export interface IAbstractMapper3DInitialValues extends IAbstractMapperInitialValues {
-	bounds?: Bounds;
-	center?: Vector3;
+export interface IAbstractMapper3DInitialValues
+  extends IAbstractMapperInitialValues {
+  bounds?: Bounds;
+  center?: Vector3;
 }
 
 export interface vtkAbstractMapper3D extends vtkAbstractMapper {
-	/**
-     * Get the bounds for this mapper as [xmin, xmax, ymin, ymax,zmin, zmax].
-	 * @default 0
-	 * @return {Bounds} The bounds for the mapper.
-	 */
-	getBounds(): Bounds;
+  /**
+   * Get the bounds for this mapper as [xmin, xmax, ymin, ymax,zmin, zmax].
+   * @default 0
+   * @return {Bounds} The bounds for the mapper.
+   */
+  getBounds(): Bounds;
+
+  /**
+   * Get the center of this mapper’s data.
+   * @return {Vector3} The center of the mapper's data.
+   */
+  getCenter(): Vector3;
 
-	/**
-	 * Get the center of this mapper’s data.
-	 * @return {Vector3} The center of the mapper's data.
-	 */
-	getCenter(): Vector3;
-	
-	/**
-	 * Get the diagonal length of this mappers bounding box.
-	 * @return {Number} The diagonal length of mapper bounding box.
-	 */
-	getLength(): number;
+  /**
+   * Get the diagonal length of this mappers bounding box.
+   * @return {Number} The diagonal length of mapper bounding box.
+   */
+  getLength(): number;
 }
 
 /**
@@ -37,19 +40,23 @@ export interface vtkAbstractMapper3D extends vtkAbstractMapper {
  * @param model object on which data structure will be bounds (protected)
  * @param {IAbstractMapper3DInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IAbstractMapper3DInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IAbstractMapper3DInitialValues
+): void;
 
 /**
  * vtkAbstractMapper3D is an abstract class to specify interface between 3D
  * data and graphics primitives or software rendering techniques. Subclasses
  * of vtkAbstractMapper3D can be used for rendering geometry or rendering
  * volumetric data.
- * 
+ *
  * This class also defines an API to support hardware clipping planes (at most
  * six planes can be defined). It also provides geometric data about the input
  * data it maps, such as the bounding box and center.
  */
 export declare const vtkAbstractMapper3D: {
-    extend: typeof extend,
+  extend: typeof extend;
 };
 export default vtkAbstractMapper3D;