Cylinder (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DGeometryNode, X3DNode

All Known Implementing Classes:

CylinderObject
```
public interface Cylinder
extends X3DGeometryNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: [X3DGeometryNode] Cylinder is a geometry node.
- Hint: Cylinder
  https://en.wikipedia.org/wiki/Cylinder
- Hint: insert a Shape node before adding geometry or Appearance.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

SAI Java Specification: TODO, X3D Abstract Specification: Cylinder, X3D Tooltips: Cylinder, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`getBottom()` Provide boolean value from initializeOnly SFBool field named bottom.
`float`	`getHeight()` Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named height.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`float`	`getRadius()` Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named radius.
`boolean`	`getSide()` Provide boolean value from initializeOnly SFBool field named side.
`boolean`	`getSolid()` Provide boolean value from initializeOnly SFBool field named solid.
`boolean`	`getTop()` Provide boolean value from inputOutput SFBool field named top.
`Cylinder`	`setBottom(boolean newValue)` Assign boolean value to initializeOnly SFBool field named bottom.
`Cylinder`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`Cylinder`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`Cylinder`	`setHeight(float newValue)` Assign float value within allowed range of (0,infinity) to initializeOnly SFFloat field named height.
`Cylinder`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`Cylinder`	`setRadius(float newValue)` Assign float value within allowed range of (0,infinity) to initializeOnly SFFloat field named radius.
`Cylinder`	`setSide(boolean newValue)` Assign boolean value to initializeOnly SFBool field named side.
`Cylinder`	`setSolid(boolean newValue)` Assign boolean value to initializeOnly SFBool field named solid.
`Cylinder`	`setTop(boolean newValue)` Assign boolean value to inputOutput SFBool field named top.
`Cylinder`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getBottom
```
boolean getBottom()
```
    Provide boolean value from initializeOnly SFBool field named bottom.
    
    Tooltip: Whether to draw bottom (inside faces are never drawn).
    - Warning: cannot be changed after initial creation.
    Returns:
    
    value of bottom field
  - setBottom
```
Cylinder setBottom(boolean newValue)
```
    Assign boolean value to initializeOnly SFBool field named bottom.
    
    Tooltip: Whether to draw bottom (inside faces are never drawn). Warning: cannot be changed after initial creation.
    
    Parameters:
    
    newValue - is new value for the bottom field.
    
    Returns:
    
    Cylinder - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getHeight
```
float getHeight()
```
    Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named height.
    
    Tooltip: (0,+infinity) Size in meters.
    - Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor Transform scale instead.
    Returns:
    
    value of height field
  - setHeight
```
Cylinder setHeight(float newValue)
```
    Assign float value within allowed range of (0,infinity) to initializeOnly SFFloat field named height.
    
    Tooltip: (0,+infinity) Size in meters. Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor Transform scale instead.
    
    Parameters:
    
    newValue - is new value for the height field.
    
    Returns:
    
    Cylinder - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DGeometryNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
Cylinder setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DGeometryNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    Cylinder - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - getRadius
```
float getRadius()
```
    Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named radius.
    
    Tooltip: (0,+infinity) Size in meters.
    - Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor Transform scale instead.
    Returns:
    
    value of radius field
  - setRadius
```
Cylinder setRadius(float newValue)
```
    Assign float value within allowed range of (0,infinity) to initializeOnly SFFloat field named radius.
    
    Tooltip: (0,+infinity) Size in meters. Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor Transform scale instead.
    
    Parameters:
    
    newValue - is new value for the radius field.
    
    Returns:
    
    Cylinder - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getSide
```
boolean getSide()
```
    Provide boolean value from initializeOnly SFBool field named side.
    
    Tooltip: Whether to draw sides (inside faces are never drawn).
    - Warning: cannot be changed after initial creation.
    Returns:
    
    value of side field
  - setSide
```
Cylinder setSide(boolean newValue)
```
    Assign boolean value to initializeOnly SFBool field named side.
    
    Tooltip: Whether to draw sides (inside faces are never drawn). Warning: cannot be changed after initial creation.
    
    Parameters:
    
    newValue - is new value for the side field.
    
    Returns:
    
    Cylinder - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getSolid
```
boolean getSolid()
```
    Provide boolean value from initializeOnly SFBool field named solid.
    
    Tooltip: Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off).
    - Warning: default value true can completely hide geometry if viewed from wrong side!
    - Hint: if in doubt, use solid='false' for maximum visibility.
    - Warning: solid false not supported in VRML97.
    Returns:
    
    value of solid field
  - setSolid
```
Cylinder setSolid(boolean newValue)
```
    Assign boolean value to initializeOnly SFBool field named solid.
    
    Tooltip: Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off). Warning: default value true can completely hide geometry if viewed from wrong side! Hint: if in doubt, use solid='false' for maximum visibility. Warning: solid false not supported in VRML97.
    
    Parameters:
    
    newValue - is new value for the solid field.
    
    Returns:
    
    Cylinder - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getTop
```
boolean getTop()
```
    Provide boolean value from inputOutput SFBool field named top.
    
    Tooltip: Whether to draw top (inside faces are never drawn).
    - Warning: cannot be changed after initial creation.
    Returns:
    
    value of top field
  - setTop
```
Cylinder setTop(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named top.
    
    Tooltip: Whether to draw top (inside faces are never drawn). Warning: cannot be changed after initial creation.
    
    Parameters:
    
    newValue - is new value for the top field.
    
    Returns:
    
    Cylinder - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
Cylinder setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DGeometryNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    Cylinder - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
Cylinder setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DGeometryNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    Cylinder - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
Cylinder setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DGeometryNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    Cylinder - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface Cylinder

Method Summary

Method Detail

getBottom

setBottom

getHeight

setHeight

getMetadata

setMetadata

getRadius

setRadius

getSide

setSide

getSolid

setSolid

getTop

setTop

setDEF

setUSE

setCssClass