official documentation

  1. x3dom.org
  2. documentation
  3. Developer API

Class: Cylinder

X3D: 3.3
Component: Geometry3D
Status:
experimental

Quick Links

➨ Fields
➨ Properties

.nodeTypes. Cylinder

The Cylinder node specifies a capped cylinder centred at (0,0,0) in the local coordinate system and with a central axis oriented along the local Y-axis. By default, the cylinder is sized at "-1" to "+1" in all three dimensions.

HTML Encoding and Default Values⤴

<Cylinder bottom='true' ccw='true' height='2.0' lit='true' metadata='X3DMetadataObject' radius='1.0' side='true' solid='true' subdivision='32' top='true' useGeoCache='true' ></Cylinder>

Inheritance⤴


Constructor⤴

Cylinder(ctx)⤴

Constructor for Cylinder

Parameters:
Name Type Argument Default Description
ctx Object <optional>
 null context object, containing initial settings like namespace

Fields⤴

These are the X3D / X3DOM fields of this node. Values should usually be received / set as strings via DOM functions (i.e., using setAttribute("myFieldName", "myFieldValue") and getAttribute("myFieldName")).
Name Type Default Value Range Inheritance Standard Description
bottom SFBool true The bottom field specifies whether the bottom cap of the cylinder is created.
ccw SFBool true X3DGeometryNode The ccw field defines the ordering of the vertex coordinates of the geometry with respect to user-given or automatically generated normal vectors used in the lighting model equations.
height SFFloat 2.0 [0, inf] The height field specifies the height of the cylinder along the central axis.
lit SFBool true X3DGeometryNode Specifies whether this geometry should be rendered with or without lighting.
metadata SFNode X3DMetadataObject X3DNode Field to add metadata information
radius SFFloat 1.0 [0, inf] The radius field specifies the radius of the cylinder.
side SFBool true The side field specifies whether sides of the cylinder are created.
solid SFBool true X3DGeometryNode Specifies whether backface-culling is used. If solid is TRUE only front-faces are drawn.
subdivision SFFloat 32 [2, inf] Specifies the number of faces that are generated to approximate the sides of the cylinder.
top SFBool true The top field specifies whether the top cap of the cylinder is created.
useGeoCache SFBool true X3DGeometryNode Most geo primitives use geo cache and others might later on, but one should be able to disable cache per geometry node. Defaults to global useGeoCache setting parameter.