Cylinder

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

Introduction

vtkCylinder computes the implicit function and/or gradient for a cylinder. vtkCylinder is a concrete implementation of vtkImplicitFunction.

Methods

evaluate

Evaluate of the cylinder equation without setting the data members center and radius.

Argument	Type	Required	Description
radius	Number	Yes
center	Number	Yes
axis	Array[Number]	Yes
x	Array[Number]	Yes

evaluateFunction

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

Argument	Type	Required	Description
xyz	Vector3	Yes	The point coordinate.

evaluateGradient

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

Argument	Type	Required	Description
xyz	Vector3	Yes	The point coordinate.

extend

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

getAngle

Get the angle of the cone.

getAxis

Get the axis of the cylinder.

getAxisByReference

Get the axis of the cylinder.

getCenter

Get the center of the cylinder.

getCenterByReference

Get the center of the cylinder.

getRadius

Get the radius of the cylinder.

newInstance

Method used to create a new instance of vtkCylinder.

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

setAngle

Set the value representing the angle of the cone.

Argument	Type	Required	Description
angle	Number	Yes	The angle of the cone.

setAxis

Set the axis of the cylinder.

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

setAxis

Set the axis of the cylinder.

Argument	Type	Required	Description
axis	Array[Number]	Yes	The axis coordinate.

setAxisFrom

Set the axis of the cylinder.

Argument	Type	Required	Description
axis	Array[Number]	Yes	The axis coordinate.

setCenter

Set the center of the cylinder.

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 cylinder.

Argument	Type	Required	Description
center	Array[Number]	Yes	The center coordinate.

setCenterFrom

Set the center of the cylinder.

Argument	Type	Required	Description
center	Array[Number]	Yes	The center coordinate.

setRadius

Set the radius of the cylinder.

Argument	Type	Required	Description
radius	Number	Yes	The radius of the cylinder.