CylinderObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.X3DConcreteElement
- - org.web3d.x3d.jsail.X3DConcreteNode
  - - org.web3d.x3d.jsail.Geometry3D.CylinderObject

All Implemented Interfaces:

X3DNode, Cylinder, X3DGeometryNode
```
public class CylinderObject
extends X3DConcreteNode
implements Cylinder
```
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 org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:

X3D Abstract Specification: Cylinder, X3D Tooltips: Cylinder, X3D Scene Authoring Hints

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`BOTTOM_DEFAULT_VALUE` SFBool field named bottom has default value true (Java syntax) or true (XML syntax).
`static java.lang.String`	`COMPONENT` String constant COMPONENT defines X3D component for the Cylinder element: Geometry3D
`static java.lang.String`	`containerField_DEFAULT_VALUE` containerField describes typical field relationship of a node to its parent.
`static java.lang.String`	`fromField_METADATA` fromField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`fromField_TOP` fromField ROUTE name for SFBool field named top.
`static float`	`HEIGHT_DEFAULT_VALUE` SFFloat field named height has default value 2f (Java syntax) or 2 (XML syntax).
`static int`	`LEVEL` Integer constant LEVEL provides default X3D Geometry3D component level for this element: 1
`static java.lang.String`	`NAME` String constant NAME provides name of this element: Cylinder.
`static float`	`RADIUS_DEFAULT_VALUE` SFFloat field named radius has default value 1f (Java syntax) or 1 (XML syntax).
`static boolean`	`SIDE_DEFAULT_VALUE` SFBool field named side has default value true (Java syntax) or true (XML syntax).
`static boolean`	`SOLID_DEFAULT_VALUE` SFBool field named solid has default value true (Java syntax) or true (XML syntax).
`static java.lang.String`	`toField_METADATA` toField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`toField_TOP` toField ROUTE name for SFBool field named top.
`static boolean`	`TOP_DEFAULT_VALUE` SFBool field named top has default value true (Java syntax) or true (XML syntax).

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
validationResult

Constructor Summary

Constructors
Constructor and Description
`CylinderObject()` Constructor for CylinderObject to initialize member variables with default values.
`CylinderObject(java.lang.String DEFlabel)` Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CylinderObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to contained commentsList.
`CylinderObject`	`addComments(java.lang.String newComment)` Add comment as String to contained commentsList.
`CylinderObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to contained commentsList.
`CylinderObject`	`clearMetadata()` Utility method to clear SFNode value of metadata field.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteNode`	`findNodeByDEF(java.lang.String DEFvalue)` Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
`java.lang.String`	`getAccessType(java.lang.String fieldName)` Indicate accessType corresponding to given fieldName.
`boolean`	`getBottom()` Provide boolean value from initializeOnly SFBool field named bottom.
`java.lang.String`	`getComponent()` Defines X3D component for the Cylinder element: Geometry3D
`int`	`getComponentLevel()` Provides default X3D component level for this element: 1
`java.lang.String`	`getContainerFieldDefault()` containerField describes typical field relationship of a node to its parent.
`java.lang.String`	`getElementName()` Provides name of this element: Cylinder
`java.lang.String`	`getFieldType(java.lang.String fieldName)` Indicate type corresponding to given fieldName.
`float`	`getHeight()` Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named height.
`ISObject`	`getIS()` Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`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.
`boolean`	`hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
`boolean`	`hasMetadata()` Indicate whether an object is available for inputOutput SFNode field metadata.
`boolean`	`hasNodeByDEF(java.lang.String DEFvalue)` Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
`void`	`initialize()` Initialize all member variables to default values.
`CylinderObject`	`setBottom(boolean newValue)` Assign boolean value to initializeOnly SFBool field named bottom.
`CylinderObject`	`setBottom(SFBoolObject newValue)` Assign typed object value to SFBool bottom field, similar to `setBottom(boolean)`.
`CylinderObject`	`setCssClass(SFStringObject newValue)` Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`CylinderObject`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`CylinderObject`	`setDEF(SFStringObject newValue)` Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`CylinderObject`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`CylinderObject`	`setHeight(float newValue)` Assign float value within allowed range of (0,infinity) to initializeOnly SFFloat field named height.
`CylinderObject`	`setHeight(SFFloatObject newValue)` Assign typed object value to SFFloat height field, similar to `setHeight(float)`.
`CylinderObject`	`setIS(ISObject newValue)` Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`CylinderObject`	`setMetadata(ProtoInstanceObject newValue)` Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
`CylinderObject`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`CylinderObject`	`setRadius(float newValue)` Assign float value within allowed range of (0,infinity) to initializeOnly SFFloat field named radius.
`CylinderObject`	`setRadius(SFFloatObject newValue)` Assign typed object value to SFFloat radius field, similar to `setRadius(float)`.
`CylinderObject`	`setSide(boolean newValue)` Assign boolean value to initializeOnly SFBool field named side.
`CylinderObject`	`setSide(SFBoolObject newValue)` Assign typed object value to SFBool side field, similar to `setSide(boolean)`.
`CylinderObject`	`setSolid(boolean newValue)` Assign boolean value to initializeOnly SFBool field named solid.
`CylinderObject`	`setSolid(SFBoolObject newValue)` Assign typed object value to SFBool solid field, similar to `setSolid(boolean)`.
`CylinderObject`	`setTop(boolean newValue)` Assign boolean value to inputOutput SFBool field named top.
`CylinderObject`	`setTop(SFBoolObject newValue)` Assign typed object value to SFBool top field, similar to `setTop(boolean)`.
`CylinderObject`	`setUSE(CylinderObject DEFnode)` Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`CylinderObject`	`setUSE(SFStringObject newValue)` Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`CylinderObject`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`java.lang.String`	`toStringClassicVRML(int indentLevel)` Recursive method to provide ClassicVRML string serialization.
`java.lang.String`	`toStringVRML97(int indentLevel)` Recursive method to provide VRML97 string serialization.
`java.lang.String`	`toStringX3D(int indentLevel)` Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
`java.lang.String`	`validate()` Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: Cylinder.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT defines X3D component for the Cylinder element: Geometry3D
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final int LEVEL
```
    Integer constant LEVEL provides default X3D Geometry3D component level for this element: 1
    
    See Also:
    
    Constant Field Values
  - BOTTOM_DEFAULT_VALUE
```
public static final boolean BOTTOM_DEFAULT_VALUE
```
    SFBool field named bottom has default value true (Java syntax) or true (XML syntax).
    
    See Also:
    
    Constant Field Values
  - HEIGHT_DEFAULT_VALUE
```
public static final float HEIGHT_DEFAULT_VALUE
```
    SFFloat field named height has default value 2f (Java syntax) or 2 (XML syntax).
    
    See Also:
    
    Constant Field Values
  - RADIUS_DEFAULT_VALUE
```
public static final float RADIUS_DEFAULT_VALUE
```
    SFFloat field named radius has default value 1f (Java syntax) or 1 (XML syntax).
    
    See Also:
    
    Constant Field Values
  - SIDE_DEFAULT_VALUE
```
public static final boolean SIDE_DEFAULT_VALUE
```
    SFBool field named side has default value true (Java syntax) or true (XML syntax).
    
    See Also:
    
    Constant Field Values
  - SOLID_DEFAULT_VALUE
```
public static final boolean SOLID_DEFAULT_VALUE
```
    SFBool field named solid has default value true (Java syntax) or true (XML syntax).
    
    See Also:
    
    Constant Field Values
  - TOP_DEFAULT_VALUE
```
public static final boolean TOP_DEFAULT_VALUE
```
    SFBool field named top has default value true (Java syntax) or true (XML syntax).
    
    See Also:
    
    Constant Field Values
  - containerField_DEFAULT_VALUE
```
public static final java.lang.String containerField_DEFAULT_VALUE
```
    containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
  - fromField_METADATA
```
public static final java.lang.String fromField_METADATA
```
    fromField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - toField_METADATA
```
public static final java.lang.String toField_METADATA
```
    toField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - fromField_TOP
```
public static final java.lang.String fromField_TOP
```
    fromField ROUTE name for SFBool field named top.
    
    See Also:
    
    Constant Field Values
  - toField_TOP
```
public static final java.lang.String toField_TOP
```
    toField ROUTE name for SFBool field named top.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CylinderObject
```
public CylinderObject()
```
    Constructor for CylinderObject to initialize member variables with default values.
  - CylinderObject
```
public CylinderObject(java.lang.String DEFlabel)
```
    Utility constructor that assigns DEF label after initializing member variables with default values.
    
    Parameters:
    
    DEFlabel - unique DEF name for this X3D node
- Method Detail
  - getElementName
```
public final java.lang.String getElementName()
```
    Provides name of this element: Cylinder
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Defines X3D component for the Cylinder element: Geometry3D
    
    Specified by:
    
    getComponent in class X3DConcreteElement
    
    Returns:
    
    X3D component for this element
  - getComponentLevel
```
public final int getComponentLevel()
```
    Provides default X3D component level for this element: 1
    
    Specified by:
    
    getComponentLevel in class X3DConcreteElement
    
    Returns:
    
    default X3D component level for this element
  - getFieldType
```
public java.lang.String getFieldType(java.lang.String fieldName)
```
    Indicate type corresponding to given fieldName.
    
    Specified by:
    
    getFieldType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
  - getAccessType
```
public java.lang.String getAccessType(java.lang.String fieldName)
```
    Indicate accessType corresponding to given fieldName.
    
    Specified by:
    
    getAccessType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
  - getContainerFieldDefault
```
public final java.lang.String getContainerFieldDefault()
```
    containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
    
    Specified by:
    
    getContainerFieldDefault in class X3DConcreteNode
    
    Returns:
    
    default containerField value
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
  - initialize
```
public final void initialize()
```
    Initialize all member variables to default values.
    
    Overrides:
    
    initialize in class X3DConcreteNode
  - getBottom
```
public 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.
    Specified by:
    
    getBottom in interface Cylinder
    
    Returns:
    
    value of bottom field
  - setBottom
```
public CylinderObject 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.
    
    Specified by:
    
    setBottom in interface Cylinder
    
    Parameters:
    
    newValue - is new value for the bottom field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setBottom
```
public CylinderObject setBottom(SFBoolObject newValue)
```
    Assign typed object value to SFBool bottom field, similar to setBottom(boolean).
    
    Parameters:
    
    newValue - is new value for the bottom field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getHeight
```
public 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.
    Specified by:
    
    getHeight in interface Cylinder
    
    Returns:
    
    value of height field
  - setHeight
```
public CylinderObject 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.
    
    Specified by:
    
    setHeight in interface Cylinder
    
    Parameters:
    
    newValue - is new value for the height field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setHeight
```
public CylinderObject setHeight(SFFloatObject newValue)
```
    Assign typed object value to SFFloat height field, similar to setHeight(float).
    
    Parameters:
    
    newValue - is new value for the height field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMetadata
```
public X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface Cylinder
    
    Specified by:
    
    getMetadata in interface X3DGeometryNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
public CylinderObject setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface Cylinder
    
    Specified by:
    
    setMetadata in interface X3DGeometryNode
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
  - clearMetadata
```
public CylinderObject clearMetadata()
```
    Utility method to clear SFNode value of metadata field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setMetadata
```
public CylinderObject setMetadata(ProtoInstanceObject newValue)
```
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(X3DMetadataObject)
  - hasMetadata
```
public boolean hasMetadata()
```
    Indicate whether an object is available for inputOutput SFNode field metadata.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - getRadius
```
public 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.
    Specified by:
    
    getRadius in interface Cylinder
    
    Returns:
    
    value of radius field
  - setRadius
```
public CylinderObject 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.
    
    Specified by:
    
    setRadius in interface Cylinder
    
    Parameters:
    
    newValue - is new value for the radius field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setRadius
```
public CylinderObject setRadius(SFFloatObject newValue)
```
    Assign typed object value to SFFloat radius field, similar to setRadius(float).
    
    Parameters:
    
    newValue - is new value for the radius field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getSide
```
public 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.
    Specified by:
    
    getSide in interface Cylinder
    
    Returns:
    
    value of side field
  - setSide
```
public CylinderObject 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.
    
    Specified by:
    
    setSide in interface Cylinder
    
    Parameters:
    
    newValue - is new value for the side field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setSide
```
public CylinderObject setSide(SFBoolObject newValue)
```
    Assign typed object value to SFBool side field, similar to setSide(boolean).
    
    Parameters:
    
    newValue - is new value for the side field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getSolid
```
public 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.
    Specified by:
    
    getSolid in interface Cylinder
    
    Returns:
    
    value of solid field
  - setSolid
```
public CylinderObject 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.
    
    Specified by:
    
    setSolid in interface Cylinder
    
    Parameters:
    
    newValue - is new value for the solid field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setSolid
```
public CylinderObject setSolid(SFBoolObject newValue)
```
    Assign typed object value to SFBool solid field, similar to setSolid(boolean).
    
    Parameters:
    
    newValue - is new value for the solid field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getTop
```
public 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.
    Specified by:
    
    getTop in interface Cylinder
    
    Returns:
    
    value of top field
  - setTop
```
public CylinderObject 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.
    
    Specified by:
    
    setTop in interface Cylinder
    
    Parameters:
    
    newValue - is new value for the top field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setTop
```
public CylinderObject setTop(SFBoolObject newValue)
```
    Assign typed object value to SFBool top field, similar to setTop(boolean).
    
    Parameters:
    
    newValue - is new value for the top field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public final CylinderObject 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 X3DNode
    
    Specified by:
    
    setDEF in interface Cylinder
    
    Specified by:
    
    setDEF in interface X3DGeometryNode
    
    Specified by:
    
    setDEF in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public CylinderObject setDEF(SFStringObject newValue)
```
    Assign typed object value to SFString DEF field, similar to setDEF(String).
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public final CylinderObject 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 X3DNode
    
    Specified by:
    
    setUSE in interface Cylinder
    
    Specified by:
    
    setUSE in interface X3DGeometryNode
    
    Specified by:
    
    setUSE in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public CylinderObject setUSE(SFStringObject newValue)
```
    Assign typed object value to SFString USE field, similar to setUSE(String).
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
public final CylinderObject 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 X3DNode
    
    Specified by:
    
    setCssClass in interface Cylinder
    
    Specified by:
    
    setCssClass in interface X3DGeometryNode
    
    Specified by:
    
    setCssClass in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    W3C Cascading Style Sheets
  - setCssClass
```
public CylinderObject setCssClass(SFStringObject newValue)
```
    Assign typed object value to SFString cssClass field, similar to setCssClass(String).
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setIS
```
public CylinderObject setIS(ISObject newValue)
```
    Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    setIS in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the description field.
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - getIS
```
public ISObject getIS()
```
    Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    getIS in class X3DConcreteNode
    
    Returns:
    
    current ISObject, if any.
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - setUSE
```
public CylinderObject setUSE(CylinderObject DEFnode)
```
    Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
    
    Warning: note that 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.
    
    Parameters:
    
    DEFnode - must have a DEF value defined
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addComments
```
public CylinderObject addComments(java.lang.String newComment)
```
    Add comment as String to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public CylinderObject addComments(java.lang.String[] newComments)
```
    Add comments as String[] array to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComments - array of comments
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public CylinderObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    CylinderObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - toStringX3D
```
public java.lang.String toStringX3D(int indentLevel)
```
    Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
    
    Specified by:
    
    toStringX3D in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    X3D string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form
  - toStringClassicVRML
```
public java.lang.String toStringClassicVRML(int indentLevel)
```
    Recursive method to provide ClassicVRML string serialization.
    
    Specified by:
    
    toStringClassicVRML in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    ClassicVRML string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
  - toStringVRML97
```
public java.lang.String toStringVRML97(int indentLevel)
```
    Recursive method to provide VRML97 string serialization.
    
    Specified by:
    
    toStringVRML97 in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    VRML97 string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.String elementName)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasElementByNameValue
```
public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.String elementName)
```
    Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findElementByNameValue(String, String)
  - findNodeByDEF
```
public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same DEF, this method does not handle that case.
    
    Specified by:
    
    findNodeByDEF in class X3DConcreteElement
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found node, null otherwise
    
    See Also:
    
    findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasNodeByDEF
```
public boolean hasNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findNodeByDEF(String)
  - validate
```
public java.lang.String validate()
```
    Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
    
    Specified by:
    
    validate in class X3DConcreteElement
    
    Returns:
    
    validation results (if any)

Class CylinderObject

Field Summary

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Constructor Summary

Method Summary

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Methods inherited from class java.lang.Object

Field Detail

NAME

COMPONENT

LEVEL

BOTTOM_DEFAULT_VALUE

HEIGHT_DEFAULT_VALUE

RADIUS_DEFAULT_VALUE

SIDE_DEFAULT_VALUE

SOLID_DEFAULT_VALUE

TOP_DEFAULT_VALUE

containerField_DEFAULT_VALUE

fromField_METADATA

toField_METADATA

fromField_TOP

toField_TOP

Constructor Detail

CylinderObject

CylinderObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

getContainerFieldDefault

initialize

getBottom

setBottom

setBottom

getHeight

setHeight

setHeight

getMetadata

setMetadata

clearMetadata

setMetadata

hasMetadata

getRadius

setRadius

setRadius

getSide

setSide

setSide

getSolid

setSolid

setSolid

getTop

setTop

setTop

setDEF

setDEF

setUSE

setUSE

setCssClass

setCssClass

setIS

getIS

setUSE

addComments

addComments

addComments

toStringX3D

toStringClassicVRML

toStringVRML97

findElementByNameValue

findElementByNameValue

hasElementByNameValue

findNodeByDEF

hasNodeByDEF

validate