javafx.scene.shape

Class Cylinder

java.lang.Object

Node

javafx.scene.shape.Shape3D

javafx.scene.shape.Cylinder

public class Cylinder
extends Shape3D

The Cylinder class defines a 3 dimensional cylinder with the specified size. A Cylinder is a 3D geometry primitive created with a given radius and height. It is centered at the origin.

Since:

JavaFX 8.0

Property Summary

Type	Property and Description
DoubleProperty	height Defines the height or the Y dimension of the Cylinder.
DoubleProperty	radius Defines the radius in the Z plane of the Cylinder.

Properties inherited from class javafx.scene.shape.Shape3D

cullFaceProperty, drawModeProperty, materialProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	Cylinder.CylinderKey

Nested classes/interfaces inherited from class javafx.scene.shape.Shape3D

Shape3D.Key

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static int	DEFAULT_DIVISIONS
(package private) static double	DEFAULT_HEIGHT
(package private) static double	DEFAULT_RADIUS
private int	divisions
private DoubleProperty	height Defines the height or the Y dimension of the Cylinder.
private TriangleMesh	mesh
private DoubleProperty	radius Defines the radius in the Z plane of the Cylinder.

Fields inherited from class javafx.scene.shape.Shape3D

key, manager

Constructor Summary

Constructors

Constructor and Description
Cylinder() Creates a new instance of Cylinder of radius of 1.0 and height of 2.0.
Cylinder(double radius, double height) Creates a new instance of Cylinder of a given radius and height.
Cylinder(double radius, double height, int divisions) Creates a new instance of Cylinder of a given radius, height, and divisions.

Method Summary

Modifier and Type	Method and Description
(package private) static TriangleMesh	createMesh(int div, float h, float r)
private boolean	doComputeContains(double localX, double localY)
private BaseBounds	doComputeGeomBounds(BaseBounds bounds, BaseTransform tx)
private boolean	doComputeIntersects(PickRay pickRay, PickResultChooser pickResult)
private NGNode	doCreatePeer()
private void	doUpdatePeer()
int	getDivisions() Retrieves the divisions attribute use to generate this cylinder.
double	getHeight() Gets the value of the property height.
double	getRadius() Gets the value of the property radius.
DoubleProperty	heightProperty() Defines the height or the Y dimension of the Cylinder.
DoubleProperty	radiusProperty() Defines the radius in the Z plane of the Cylinder.
void	setHeight(double value) Sets the value of the property height.
void	setRadius(double value) Sets the value of the property radius.

Methods inherited from class javafx.scene.shape.Shape3D

cullFaceProperty, drawModeProperty, getCullFace, getDrawMode, getMaterial, materialProperty, setCullFace, setDrawMode, setMaterial

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Detail

height

public final DoubleProperty heightProperty

Defines the height or the Y dimension of the Cylinder.

See Also:

getHeight(), setHeight(double)

radius

public final DoubleProperty radiusProperty

Defines the radius in the Z plane of the Cylinder.

See Also:

getRadius(), setRadius(double)

Field Detail

DEFAULT_DIVISIONS

static final int DEFAULT_DIVISIONS

See Also:

Constant Field Values

DEFAULT_RADIUS

static final double DEFAULT_RADIUS

See Also:

Constant Field Values

DEFAULT_HEIGHT

static final double DEFAULT_HEIGHT

See Also:

Constant Field Values

divisions

private int divisions

mesh

private TriangleMesh mesh

height

private DoubleProperty height

Defines the height or the Y dimension of the Cylinder.

radius

private DoubleProperty radius

Defines the radius in the Z plane of the Cylinder.

Constructor Detail

Cylinder

public Cylinder()

Creates a new instance of Cylinder of radius of 1.0 and height of 2.0. Resolution defaults to 15 divisions along X and Z axis.

Cylinder

public Cylinder(double radius,
                double height)

Creates a new instance of Cylinder of a given radius and height. Resolution defaults to 15 divisions along X and Z axis.

Parameters:

radius - Radius

height - Height

Cylinder

public Cylinder(double radius,
                double height,
                int divisions)

Creates a new instance of Cylinder of a given radius, height, and divisions. Resolution defaults to 15 divisions along X and Z axis. Note that divisions should be at least 3. Any value less than that will be clamped to 3.

Parameters:

radius - Radius

height - Height

divisions - Divisions

Method Detail

setHeight

public final void setHeight(double value)

Sets the value of the property height.

getHeight

public final double getHeight()

Gets the value of the property height.

heightProperty

public final DoubleProperty heightProperty()

Defines the height or the Y dimension of the Cylinder.

See Also:

getHeight(), setHeight(double)

setRadius

public final void setRadius(double value)

Sets the value of the property radius.

getRadius

public final double getRadius()

Gets the value of the property radius.

radiusProperty

public final DoubleProperty radiusProperty()

Defines the radius in the Z plane of the Cylinder.

See Also:

getRadius(), setRadius(double)

getDivisions

public int getDivisions()

Retrieves the divisions attribute use to generate this cylinder.

Returns:

the divisions attribute.

doUpdatePeer

private void doUpdatePeer()

doCreatePeer

private NGNode doCreatePeer()

doComputeGeomBounds

private BaseBounds doComputeGeomBounds(BaseBounds bounds,
                                       BaseTransform tx)

doComputeContains

private boolean doComputeContains(double localX,
                                  double localY)

doComputeIntersects

private boolean doComputeIntersects(PickRay pickRay,
                                    PickResultChooser pickResult)

createMesh

static TriangleMesh createMesh(int div,
                               float h,
                               float r)