Sphere

Source (.js)Source (.d.ts)

Introduction

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.

Methods

evaluateFunction

Given the point xyz (three floating value) evaluate the sphere equation.

Argument	Type	Required	Description
xyz	Vector3	Yes	The point coordinate.

evaluateGradient

Given the point xyz (three floating values) evaluate the equation for the sphere gradient.

Argument	Type	Required	Description
xyz	Vector3	Yes	The point coordinate.

extend

Method used to decorate a given object (publicAPI+model) with vtkSphere 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)
initialValues	ISphereInitialValues	No	(default: {})

getCenter

Get the center of the sphere.

getCenterByReference

Get the center of the sphere.

getRadius

Get the radius of the sphere.

newInstance

Method used to create a new instance of vtkSphere.

Argument	Type	Required	Description
initialValues	ISphereInitialValues	No	for pre-setting some of its content

setCenter

Set the center of the sphere.

Argument	Type	Required	Description
x	Number	Yes	The x coordinate.
y	Number	Yes	The y coordinate.
z	Number	Yes	The z coordinate.

setCenter

Set the center of the sphere.

Argument	Type	Required	Description
center	Vector3	Yes	The center coordinate.

setCenterFrom

Set the center of the sphere.

Argument	Type	Required	Description
center	Vector3	Yes	The center coordinate.

setRadius

Set the radius of the sphere. Radius must be > 0. It can also be an array of 3 positive values for ellipsoids

Argument	Type	Required	Description
radius	Number or Vector3	Yes	The radius of the sphere.