vtkBox 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.
Methods
addBounds
Add the bounds for the box.
Argument
Type
Required
Description
bounds
Bounds
Yes
addBox
Argument
Type
Required
Description
other
Yes
evaluateFunction
Argument
Type
Required
Description
x
Number
Yes
The x coordinate.
y
Number
Yes
The y coordinate.
z
Number
Yes
The z coordinate.
evaluateFunction
Argument
Type
Required
Description
x
Vector3
Yes
The point coordinate.
extend
Method used to decorate a given object (publicAPI+model) with vtkBox characteristics.
Argument
Type
Required
Description
publicAPI
Yes
object on which methods will be bounds (public)
model
Yes
object on which data structure will be bounds (protected)
/** * Add the bounds for the box. * @param {Bounds} bounds */ addBounds(bounds: Bounds): void;
/** * * @param other */ addBox(other: any): void;
/** * * @param {Vector3} x The point coordinate. */ evaluateFunction(x: Vector3): number;
/** * * @param {Number} x The x coordinate. * @param {Number} y The y coordinate. * @param {Number} z The z coordinate. */ evaluateFunction(x: number, y: number, z: number ): number;
/** * Get the bounds for the box. */ getBounds(): Bounds;
/** * Set the bounds for the box. * @param {Bounds} bounds The bounds for the box. */ setBounds(bounds: Bounds): void; }
/** * Method used to decorate a given object (publicAPI+model) with vtkBox characteristics. * * @param publicAPI object on which methods will be bounds (public) * @param model object on which data structure will be bounds (protected) * @param {IBoxInitialValues} [initialValues] (default: {}) */ exportfunctionextend(publicAPI: object, model: object, initialValues?: IBoxInitialValues): void;
/** * Method used to create a new instance of vtkBox. * @param {IBoxInitialValues} [initialValues] for pre-setting some of its content */ exportfunctionnewInstance(initialValues?: IBoxInitialValues): vtkBox;
/** * vtkBox 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 constvtkBox: { newInstance: typeof newInstance, extend: typeof extend }; exportdefault vtkBox;