Interface Rectangle2D

All Superinterfaces:
X3DGeometryNode, X3DNode
All Known Implementing Classes:
Rectangle2DObject

public interface Rectangle2D
extends X3DGeometryNode
Rectangle2D is a geometry node that defines a 2D rectangle in X-Y plane.

X3D node tooltip: [X3DGeometryNode] Rectangle2D is a geometry node that defines a 2D rectangle in X-Y plane.
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: Rectangle2D, X3D Tooltips: Rectangle2D, 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 2-tuple float results within allowed range of (0,infinity) from initializeOnly SFVec2f field named size.
    boolean getSolid()
    Provide boolean value from initializeOnly SFBool field named solid.
    Rectangle2D setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    Rectangle2D setSize​(float[] newValue)
    Accessor method to assign 2-tuple float array to initializeOnly SFVec2f field named size.
    Rectangle2D 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.
      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

      Rectangle2D setMetadata​(X3DMetadataObject newValue)
      Accessor method to 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:
      Rectangle2D - 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 2-tuple float results within allowed range of (0,infinity) from initializeOnly SFVec2f field named size.

      Tooltip: 2D dimensions of Rectangle2D.
      • 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

      Rectangle2D setSize​(float[] newValue)
      Accessor method to assign 2-tuple float array to initializeOnly SFVec2f field named size.

      Tooltip: 2D dimensions of Rectangle2D.
      • 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:
      Rectangle2D - 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

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