|
| 1 | +import { vtkObject } from "../../../interfaces" ; |
| 2 | +import { Bounds, Point } from "../../../types"; |
| 3 | + |
| 4 | + |
| 5 | +export interface IBoxInitialValues { |
| 6 | + bbox?: Bounds; |
| 7 | +} |
| 8 | + |
| 9 | +export interface vtkBox extends vtkObject { |
| 10 | + |
| 11 | + /** |
| 12 | + * Add the bounds for the box. |
| 13 | + * @param {Bounds} bounds |
| 14 | + */ |
| 15 | + addBounds(bounds: Bounds): void; |
| 16 | + |
| 17 | + /** |
| 18 | + * |
| 19 | + * @param other |
| 20 | + */ |
| 21 | + addBox(other: any): void; |
| 22 | + |
| 23 | + /** |
| 24 | + * |
| 25 | + * @param {Point} x The point coordinate. |
| 26 | + */ |
| 27 | + evaluateFunction(x: Point): number; |
| 28 | + |
| 29 | + /** |
| 30 | + * |
| 31 | + * @param {Number} x The x coordinate. |
| 32 | + * @param {Number} y The y coordinate. |
| 33 | + * @param {Number} z The z coordinate. |
| 34 | + */ |
| 35 | + evaluateFunction(x: number, y: number, z: number ): number; |
| 36 | + |
| 37 | + /** |
| 38 | + * Get the bounds for the box. |
| 39 | + */ |
| 40 | + getBounds(): Bounds; |
| 41 | + |
| 42 | + /** |
| 43 | + * Set the bounds for the box. |
| 44 | + * @param {Bounds} bounds The bounds for the box. |
| 45 | + */ |
| 46 | + setBounds(bounds: Bounds): void; |
| 47 | +} |
| 48 | + |
| 49 | +/** |
| 50 | + * Method used to decorate a given object (publicAPI+model) with vtkBox characteristics. |
| 51 | + * |
| 52 | + * @param publicAPI object on which methods will be bounds (public) |
| 53 | + * @param model object on which data structure will be bounds (protected) |
| 54 | + * @param {IBoxInitialValues} [initialValues] (default: {}) |
| 55 | + */ |
| 56 | +export function extend(publicAPI: object, model: object, initialValues?: IBoxInitialValues): void; |
| 57 | + |
| 58 | +/** |
| 59 | + * Method used to create a new instance of vtkBox. |
| 60 | + * @param {IBoxInitialValues} [initialValues] for pre-setting some of its content |
| 61 | + */ |
| 62 | +export function newInstance(initialValues?: IBoxInitialValues): vtkBox; |
| 63 | + |
| 64 | +/** |
| 65 | + * vtkBox provides methods for creating a 1D cubic spline object from given |
| 66 | + * parameters, and allows for the calculation of the spline value and derivative |
| 67 | + * at any given point inside the spline intervals. |
| 68 | + */ |
| 69 | +export declare const vtkBox: { |
| 70 | + newInstance: typeof newInstance, |
| 71 | + extend: typeof extend |
| 72 | +}; |
| 73 | +export default vtkBox; |
0 commit comments