APIdia Launch Partner
Top Description Inners Fields Constructors Methods
javafx.scene.shape

public non-sealed Class Cylinder

extends Shape3D
Class Inheritance
Imports
com.sun.javafx.geom.BaseBounds, .PickRay, .Vec3d, com.sun.javafx.geom.transform.BaseTransform, com.sun.javafx.scene.DirtyBits, .NodeHelper, com.sun.javafx.scene.input.PickResultChooser, com.sun.javafx.scene.shape.CylinderHelper, .MeshHelper, com.sun.javafx.sg.prism.NGCylinder, .NGNode, javafx.beans.property.DoubleProperty, .SimpleDoubleProperty, javafx.geometry.Point2D, .Point3D, javafx.scene.Node, javafx.scene.input.PickResult, javafx.scene.transform.Rotate

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

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
pack-priv static final int
pack-priv static final double
pack-priv static final double
private int
private DoubleProperty
height

Defines the height or the Y dimension of the Cylinder.

private TriangleMesh
private DoubleProperty
radius

Defines the radius in the Z plane of the Cylinder.

Inherited from javafx.scene.shape.Shape3D:
keymanager

Constructor Summary

AccessConstructor and Description
public
Cylinder()

Creates a new instance of Cylinder of radius of 1.0 and height of 2.0.

public
Cylinder(double
Radius
radius
,
double
Height
height
)

Creates a new instance of Cylinder of a given radius and height.

public
Cylinder(double
Radius
radius
,
double
Height
height
,
int
Divisions
divisions
)

Creates a new instance of Cylinder of a given radius, height, and divisions.

Method Summary

Modifier and TypeMethod and Description
pack-priv static TriangleMesh
createMesh(int div, float h, float r)

private boolean
private BaseBounds
private boolean
private NGNode
private void
public int

Returns:

the divisions attribute.
getDivisions
()

Retrieves the divisions attribute use to generate this cylinder.

public final double
public final double
public final DoubleProperty
public final DoubleProperty
public final void
setHeight(double value)

public final void
setRadius(double value)

Inherited from javafx.scene.shape.Shape3D:
cullFacePropertydrawModePropertygetCullFacegetDrawModegetMaterialmaterialPropertysetCullFacesetDrawModesetMaterial

Field Detail

DEFAULT_DIVISIONSback to summary
pack-priv static final int DEFAULT_DIVISIONS
DEFAULT_HEIGHTback to summary
pack-priv static final double DEFAULT_HEIGHT
DEFAULT_RADIUSback to summary
pack-priv static final double DEFAULT_RADIUS
divisionsback to summary
private int divisions
heightback to summary
private DoubleProperty height

Defines the height or the Y dimension of the Cylinder.

Default Value
2.0
meshback to summary
private TriangleMesh mesh
radiusback to summary
private DoubleProperty radius

Defines the radius in the Z plane of the Cylinder.

Default Value
1.0

Constructor Detail

Cylinderback to summary
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.

Cylinderback to summary
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:double

Radius

height:double

Height

Cylinderback to summary
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:double

Radius

height:double

Height

divisions:int

Divisions

Method Detail

createMeshback to summary
pack-priv static TriangleMesh createMesh(int div, float h, float r)
doComputeContainsback to summary
private boolean doComputeContains(double localX, double localY)

Hides javafx.scene.shape.Shape3D.doComputeContains.

doComputeGeomBoundsback to summary
private BaseBounds doComputeGeomBounds(BaseBounds bounds, BaseTransform tx)

Hides javafx.scene.shape.Shape3D.doComputeGeomBounds.

doComputeIntersectsback to summary
private boolean doComputeIntersects(PickRay pickRay, PickResultChooser pickResult)

Hides javafx.scene.Node.doComputeIntersects.

doCreatePeerback to summary
private NGNode doCreatePeer()
doUpdatePeerback to summary
private void doUpdatePeer()

Hides javafx.scene.shape.Shape3D.doUpdatePeer.

getDivisionsback to summary
public int getDivisions()

Retrieves the divisions attribute use to generate this cylinder.

Returns:int

the divisions attribute.

getHeightback to summary
public final double getHeight()
getRadiusback to summary
public final double getRadius()
heightPropertyback to summary
public final DoubleProperty heightProperty()
radiusPropertyback to summary
public final DoubleProperty radiusProperty()
setHeightback to summary
public final void setHeight(double value)
setRadiusback to summary
public final void setRadius(double value)
javafx.scene.shape back to summary

private Class Cylinder.CylinderKey

extends Key
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv final int
pack-priv final double
pack-priv final double

Constructor Summary

AccessConstructor and Description
private
CylinderKey(double radius, double height, int divisions)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object obj)

Implements abstract javafx.scene.shape.Shape3D.Key.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Implements abstract javafx.scene.shape.Shape3D.Key.hashCode.

Returns a hash code value for this object.

Field Detail

divisionsback to summary
pack-priv final int divisions
heightback to summary
pack-priv final double height
radiusback to summary
pack-priv final double radius

Constructor Detail

CylinderKeyback to summary
private CylinderKey(double radius, double height, int divisions)

Method Detail

equalsback to summary
public boolean equals(Object obj)

Implements abstract javafx.scene.shape.Shape3D.Key.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Implements abstract javafx.scene.shape.Shape3D.Key.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override