Package org.web3d.x3d.sai.Geometry2D

Interface Circle2D

All Superinterfaces:
X3DGeometryNode, X3DNode
All Known Implementing Classes:
Circle2DObject
public interface Circle2D
extends X3DGeometryNode
Circle2D is a geometry node that defines a linear X-Y circle with center (0,0) in X-Y plane.

X3D node tooltip: [X3DGeometryNode] Circle2D is a geometry node that defines a linear X-Y circle with center (0,0) 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: Circle2D, X3D Tooltips: Circle2D, 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 getRadius()
    Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named radius.
    Circle2D setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    Circle2D setRadius​(float newValue)
    Accessor method to assign float value to initializeOnly SFFloat field named radius.

  • 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

      Circle2D 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:
      Circle2D - 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) circle radius.
      • 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

      Circle2D setRadius​(float newValue)
      Accessor method to assign float value to initializeOnly SFFloat field named radius.

      Tooltip: (0,+infinity) circle radius.
      • 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:
      Circle2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).