Package org.web3d.x3d.sai.Geometry3D

Interface Box

All Superinterfaces:
X3DGeometryNode, X3DNode
All Known Implementing Classes:
BoxObject
public interface Box
extends X3DGeometryNode
Box is a geometry node specifying a rectangular cuboid.

X3D node tooltip: [X3DGeometryNode] Box is a geometry node specifying a rectangular cuboid.
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: Box, X3D Tooltips: Box, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    float[] getSize()
    Provide array of 3-tuple float results from initializeOnly SFVec3f field named size.
    boolean getSolid()
    Provide boolean value from initializeOnly SFBool field named solid.
    Box setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    Box setSize​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named size.
    Box setSolid​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named solid.

  • Method Details

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide 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

      Box setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign 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:
      Box - 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

    • getSize

      float[] getSize()
      Provide array of 3-tuple float results from initializeOnly SFVec3f field named size.

      Tooltip: (0,+infinity) size x y z 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 size field

    • setSize

      Box setSize​(float[] newValue)
      Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named size.

      Tooltip: (0,+infinity) size x y z 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 size field.
      Returns:
      Box - 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

      Box 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).
      • 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:
      Box - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).