Package org.web3d.x3d.sai.Geometry3D

Interface Cylinder

All Superinterfaces:
X3DGeometryNode, X3DNode
All Known Implementing Classes:
Cylinder
public interface Cylinder
extends X3DGeometryNode
Cylinder is a geometry node.

X3D node tooltip: [X3DGeometryNode] Cylinder is a geometry node.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification, X3D Abstract Specification: Cylinder, X3D Tooltips: Cylinder, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    boolean getBottom()
    Provide boolean value from inputOutput SFBool field named bottom.
    float getHeight()
    Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named height.
    X3DMetadataObject getMetadata()
    Provide org.web3d.x3d.sai.Core.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 inputOutput 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)
    Accessor method to assign boolean value to inputOutput SFBool field named bottom.
    Cylinder setHeight​(float newValue)
    Accessor method to assign float value to initializeOnly SFFloat field named height.
    Cylinder setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    Cylinder setRadius​(float newValue)
    Accessor method to assign float value to initializeOnly SFFloat field named radius.
    Cylinder setSide​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named side.
    Cylinder setSolid​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named solid.
    Cylinder setTop​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named top.

  • Method Details

    • getBottom

      boolean getBottom()
      Provide boolean value from inputOutput SFBool field named bottom.

      Tooltip: Whether to draw bottom (inside faces are never drawn). *
      Returns:
      value of bottom field

    • setBottom

      Cylinder setBottom​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named bottom.

      Tooltip: Whether to draw bottom (inside faces are never drawn). *
      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, avoiding the need for potentially expensive tessellation at run time.
      • Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
      Returns:
      value of height field

    • setHeight

      Cylinder setHeight​(float newValue)
      Accessor method to assign float value 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, avoiding the need for potentially expensive tessellation at run time.
      • Hint: for size animation, modify the scale of a parent/ancestor Transform node 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 org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      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)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      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, avoiding the need for potentially expensive tessellation at run time.
      • Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
      Returns:
      value of radius field

    • setRadius

      Cylinder setRadius​(float newValue)
      Accessor method to assign float value 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, avoiding the need for potentially expensive tessellation at run time.
      • Hint: for size animation, modify the scale of a parent/ancestor Transform node 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 inputOutput SFBool field named side.

      Tooltip: Whether to draw sides (inside faces are never drawn). *
      Returns:
      value of side field

    • setSide

      Cylinder setSide​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named side.

      Tooltip: Whether to draw sides (inside faces are never drawn). *
      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).
      • Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
      • 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)
      Accessor method to 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).
      • Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
      • 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). *
      Returns:
      value of top field

    • setTop

      Cylinder setTop​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named top.

      Tooltip: Whether to draw top (inside faces are never drawn). *
      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).