@kitware/vtk.js/Common/DataModel/Sphere.d.ts

Visualization Toolkit for the Web

import { Vector3 } from './../../types';
import vtkImplicitFunction from './ImplicitFunction';

export interface ISphereInitialValues {
  radius?: number | Vector3;
  center?: Vector3;
}

export interface vtkSphere extends vtkImplicitFunction {
  /**
   * Given the point xyz (three floating value) evaluate the sphere
   * equation.
   * @param {Vector3} xyz The point coordinate.
   */
  evaluateFunction(xyz: Vector3): number;

  /**
   * Given the point xyz (three floating values) evaluate the equation for the
   * sphere gradient.
   * @param {Vector3} xyz The point coordinate.
   */
  evaluateGradient(xyz: Vector3): number[];

  /**
   * Get the center of the sphere.
   */
  getCenter(): Vector3;

  /**
   * Get the center of the sphere.
   */
  getCenterByReference(): Vector3;

  /**
   * Get the radius of the sphere.
   */
  getRadius(): number | Vector3;

  /**
   * Set the center of the sphere.
   * @param {Vector3} center The center coordinate.
   */
  setCenter(center: Vector3): boolean;

  /**
   * Set the center of the sphere.
   * @param {Number} x The x coordinate.
   * @param {Number} y The y coordinate.
   * @param {Number} z The z coordinate.
   */
  setCenter(x: number, y: number, z: number): boolean;

  /**
   * Set the center of the sphere.
   * @param {Vector3} center The center coordinate.
   */
  setCenterFrom(center: Vector3): boolean;

  /**
   * Set the radius of the sphere. Radius must be > 0.
   * It can also be an array of 3 positive values for ellipsoids
   * @param {Number|Vector3} radius The radius of the sphere.
   */
  setRadius(radius: number | Vector3): boolean;
}

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

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

/**
 * @param {Number} radius
 * @param {Vector3} center
 * @param {Vector3} x
 */
declare function evaluate(radius: number, center: Vector3, x: Vector3): number;

/**
 * Approximate bounding sphere for a point set represented as a flat xyz array.
 * Returns `[cx, cy, cz, r]`.
 *
 * @param {Array<number>|TypedArray} pts flat xyz point coordinates
 * @param {number} [numPts] number of points to process
 * @param {number[]} [hints] two point ids expected to be far apart
 */
declare function computeBoundingSphere(
  pts: Array<number> | ArrayLike<number>,
  numPts?: number,
  hints?: number[]
): [number, number, number, number];

/**
 * Approximate bounding sphere for an array of spheres `[x, y, z, r]`.
 * Returns `[cx, cy, cz, r]`.
 *
 * @param {Array<Vector4>} spheres list of spheres
 * @param {number} [numSpheres] number of spheres to process
 * @param {number[]} [hints] two sphere ids expected to be far apart
 */
declare function computeBoundingSphereFromSpheres(
  spheres: Array<[number, number, number, number]>,
  numSpheres?: number,
  hints?: number[]
): [number, number, number, number];

/**
 * vtkSphere provides methods for creating a 1D cubic spline object from given
 * parameters, and allows for the calculation of the spline value and derivative
 * at any given point inside the spline intervals.
 */
export declare const vtkSphere: {
  newInstance: typeof newInstance;
  extend: typeof extend;
  evaluate: typeof evaluate;
  computeBoundingSphere: typeof computeBoundingSphere;
  computeBoundingSphereFromSpheres: typeof computeBoundingSphereFromSpheres;
};
export default vtkSphere;