@thewtex/vtk.js-esm/Common/Core/Points.d.ts

Visualization Toolkit for the Web

import vtkDataArray from '@kitware/vtk.js/Common/Core/DataArray';
import { Bounds } from '@kitware/vtk.js/types';

/**
 *
 */
interface IPointsInitialValues {
	empty?: boolean;
	numberOfComponents?: number;
	bounds?: number[];
}

export interface vtkPoints extends vtkDataArray {

	/**
	 * Trigger the computation of bounds
	 */
	computeBounds(): number[];

	/**
	 * Get the bounds for this mapper as [xmin, xmax, ymin, ymax,zmin, zmax].
	 * @return {Bounds} The bounds for the mapper.
	 */
	getBounds(): Bounds;

	/**
	 * Get the coordinate of a point.
	 * @param {Number} idx The index of point.
	 * @param {Number[]} [tupleToFill]
	 * @default []
	 */
	getPoint(idx: number, tupleToFill?: number[]): number[];

	/**
	 * Get the number of points for this object can hold.
	 */
	getNumberOfPoints(): number;

	/**
	 * Set the number of points for this object to hold.
	 * 
	 * ```js
	 * points.getData()[0] = x;
	 * points.getData()[1] = y;
	 * points.getData()[2] = z;
	 * ```
	 * 
	 * @param {Number} nbPoints
	 * @param {Number} [dimension]
	 */
	setNumberOfPoints(nbPoints: number, dimension?: number): void;

	/**
	 * Set the (x,y,z) coordinate of a point based on its index.
	 * @param {Number} idx The index of point.
	 * @param {Number} x The x coordinate.
	 * @param {Number} y The y coordinate.
	 * @param {Number} z The z coordinate.
	 */
	setPoint(idx: number, x: number, y: number, z: number): void;

	/**
	 * Insert point into object.
	 * @param {Number} idx The index of point.
	 * @param {Number[]} coord The point's coordinates.
	 */
	setPoint(idx: number, coord: number[]): void;
}

/**
 * Method used to decorate a given object (publicAPI+model) with vtkPoints characteristics.
 *
 * @param publicAPI object on which methods will be bounds (public)
 * @param model object on which data structure will be bounds (protected)
 * @param {IPointsInitialValues} [initialValues] (default: {})
 */
export function extend(publicAPI: object, model: object, initialValues?: IPointsInitialValues): void;

/**
 * Method used to create a new instance of vtkPoints
 * @param {IPointsInitialValues} [initialValues] for pre-setting some of its content
 */
export function newInstance(initialValues?: IPointsInitialValues): vtkPoints;


/**
 * vtkPoints represents 3D points. The data model for vtkPoints is an array 
 * of vx-vy-vz triplets accessible by (point or cell) id.
 */

export declare const vtkPoints: {
	newInstance: typeof newInstance;
	extend: typeof extend;
}
export default vtkPoints;