Package org.web3d.x3d.sai.Geometry2D

Interface Polyline2D

All Superinterfaces:
X3DGeometryNode, X3DNode
All Known Implementing Classes:
Polyline2DObject
public interface Polyline2D
extends X3DGeometryNode
Polyline2D is a geometry node that defines a connected set of vertices in a contiguous set of line segments in X-Y plane.

X3D node tooltip: [X3DGeometryNode] Polyline2D is a geometry node that defines a connected set of vertices in a contiguous set of line segments in X-Y plane.
  • Hint: Material emissiveColor in corresponding Appearance is used for rendering lines.
  • Warning: lines are not lit, are not texture-mapped, and do not participate in collision detection.
  • Warning: use a different Material emissiveColor than the Background color, otherwise geometry is invisible.
  • Hint: adding LineProperties to the corresponding Appearance node can modify the rendering style of these lines.
  • Hint: insert a Shape node before adding geometry or Appearance. Examples: X3D Example Archives, X3D for Web Authors, Chapter 10 Geometry 2D https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter10Geometry2D

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: Polyline2D, X3D Tooltips: Polyline2D, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    float[] getLineSegments()
    Provide array of 2-tuple float results from initializeOnly MFVec2f field named lineSegments.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    Polyline2D setLineSegments​(float[] newValue)
    Accessor method to assign 2-tuple float array to initializeOnly MFVec2f field named lineSegments.
    Polyline2D setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

  • Method Details

    • getLineSegments

      float[] getLineSegments()
      Provide array of 2-tuple float results from initializeOnly MFVec2f field named lineSegments.

      Tooltip: Coordinates of vertices connected into contiguous Polyline2D.
      • 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 lineSegments field

    • setLineSegments

      Polyline2D setLineSegments​(float[] newValue)
      Accessor method to assign 2-tuple float array to initializeOnly MFVec2f field named lineSegments.

      Tooltip: Coordinates of vertices connected into contiguous Polyline2D.
      • 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 lineSegments field.
      Returns:
      Polyline2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • 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

      Polyline2D 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:
      Polyline2D - 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