Package org.web3d.x3d.sai.Rendering

Interface IndexedLineSet

All Superinterfaces:
X3DGeometryNode, X3DNode
All Known Implementing Classes:
IndexedLineSetObject
public interface IndexedLineSet
extends X3DGeometryNode
IndexedLineSet defines polyline segments using index lists corresponding to vertex coordinates.

X3D node tooltip: [X3DGeometryNode] IndexedLineSet defines polyline segments using index lists corresponding to vertex coordinates. IndexedLineSet is a geometry node that can contain a Coordinate|CoordinateDouble node and optionally a Color|ColorRGBA node.
  • Hint: Polygonal chain https://en.wikipedia.org/wiki/Polygonal_chain
  • Hint: either values in a contained Color node, or else Material emissiveColor in corresponding Appearance node, are used for rendering lines and points.
  • Warning: lines are not lit, are not texture-mapped, and do not participate in collision detection.
  • Warning: use a different color (or 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: if rendering Coordinate points originally defined for an IndexedFaceSet, index values may need to repeat each initial vertex to close each polygon outline.
  • Hint: step-wise variation or linear interpolation of color values can be used as a good scientific visualization technique to map arbitrary function values to a color map.
  • Hint: insert a Shape node before adding geometry or Appearance.
  • Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance node (with correct containerField value) for contained node content.
  • Hint: consider including Fog (with Fog color matching Background color) to provide further depth cueing for IndexedLineSet (ILS).

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

  • Method Summary

    Modifier and Type Method Description
    void addAttrib​(X3DNode[] newValue)
    Add array of child attrib nodes to array of existing nodes (if any).
    X3DNode[] getAttrib()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field attrib.
    X3DColorNode getColor()
    Provide X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.
    int[] getColorIndex()
    Provide array of int results using RGB values [0..1] from initializeOnly MFInt32 field named colorIndex.
    boolean getColorPerVertex()
    Provide boolean value from initializeOnly SFBool field named colorPerVertex.
    X3DCoordinateNode getCoord()
    Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.
    int[] getCoordIndex()
    Provide array of int results within allowed range of [-1,infinity) from initializeOnly MFInt32 field named coordIndex.
    FogCoordinate getFogCoord()
    Provide FogCoordinate instance (using a properly typed node) from inputOutput SFNode field fogCoord.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    void setAttrib​(X3DNode newValue)
    Set single child attrib node, replacing prior array of existing nodes (if any).
    IndexedLineSet setAttrib​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field attrib.
    IndexedLineSet setColor​(X3DColorNode newValue)
    Accessor method to assign X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.
    IndexedLineSet setColorIndex​(int[] newValue)
    Accessor method to assign int array to initializeOnly MFInt32 field named colorIndex.
    IndexedLineSet setColorPerVertex​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named colorPerVertex.
    IndexedLineSet setCoord​(X3DCoordinateNode newValue)
    Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.
    IndexedLineSet setCoordIndex​(int[] newValue)
    Accessor method to assign int array to initializeOnly MFInt32 field named coordIndex.
    IndexedLineSet setFogCoord​(FogCoordinate newValue)
    Accessor method to assign FogCoordinate instance (using a properly typed node) to inputOutput SFNode field fogCoord.
    IndexedLineSet setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

  • Method Details

    • getAttrib

      X3DNode[] getAttrib()
      Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field attrib.

      Tooltip: [X3DVertexAttributeNode] Single contained FloatVertexAttribute node that specifies list of per-vertex attribute information for programmable shaders.

      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVertexAttributeNode.
      Returns:
      value of attrib field
      See Also:
      X3DVertexAttributeNode

    • setAttrib

      IndexedLineSet setAttrib​(X3DNode[] newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field attrib.

      Tooltip: [X3DVertexAttributeNode] Single contained FloatVertexAttribute node that specifies list of per-vertex attribute information for programmable shaders.

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVertexAttributeNode.
      Parameters:
      newValue - is new value for the attrib field.
      Returns:
      IndexedLineSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addAttrib

      void addAttrib​(X3DNode[] newValue)
      Add array of child attrib nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVertexAttributeNode.
      Parameters:
      newValue - is new value array to be appended the attrib field.

    • setAttrib

      void setAttrib​(X3DNode newValue)
      Set single child attrib node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the attrib field

    • getColor

      X3DColorNode getColor()
      Provide X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.

      Tooltip: [X3DColorNode] Single contained Color or ColorRGBA node that specifies color values applied to corresponding vertices according to colorIndex and colorPerVertex fields. *
      Returns:
      value of color field

    • setColor

      IndexedLineSet setColor​(X3DColorNode newValue)
      Accessor method to assign X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.

      Tooltip: [X3DColorNode] Single contained Color or ColorRGBA node that specifies color values applied to corresponding vertices according to colorIndex and colorPerVertex fields. *
      Parameters:
      newValue - is new value for the color field.
      Returns:
      IndexedLineSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getColorIndex

      int[] getColorIndex()
      Provide array of int results using RGB values [0..1] from initializeOnly MFInt32 field named colorIndex.

      Tooltip: [-1,+infinity) colorIndex values define the order in which Color|ColorRGBA values are applied to polygons (or vertices).
      • Hint: if colorIndex array is not provided, then Color|ColorRGBA values are indexed according to the coordIndex field.
      • Hint: If colorPerVertex='false' then one index is provided for each polygon defined by the coordIndex array. No sentinel -1 values are included.
      • Hint: If colorPerVertex='true' then a matching set of indices is provided, each separated by sentinel -1, that exactly corresponds to individual values in the coordIndex array polygon definitions.
      • Hint: if rendering Coordinate points originally defined for an IndexedFaceSet, index values may need to repeat initial each initial vertex to close the polygons.
      • Warning: if child Color|ColorRGBA node is not provided, then geometry is rendered using corresponding Appearance and material/texture values.
      Returns:
      value of colorIndex field

    • setColorIndex

      IndexedLineSet setColorIndex​(int[] newValue)
      Accessor method to assign int array to initializeOnly MFInt32 field named colorIndex.

      Tooltip: [-1,+infinity) colorIndex values define the order in which Color|ColorRGBA values are applied to polygons (or vertices).
      • Hint: if colorIndex array is not provided, then Color|ColorRGBA values are indexed according to the coordIndex field.
      • Hint: If colorPerVertex='false' then one index is provided for each polygon defined by the coordIndex array. No sentinel -1 values are included.
      • Hint: If colorPerVertex='true' then a matching set of indices is provided, each separated by sentinel -1, that exactly corresponds to individual values in the coordIndex array polygon definitions.
      • Hint: if rendering Coordinate points originally defined for an IndexedFaceSet, index values may need to repeat initial each initial vertex to close the polygons.
      • Warning: if child Color|ColorRGBA node is not provided, then geometry is rendered using corresponding Appearance and material/texture values.
      Parameters:
      newValue - is new value for the colorIndex field.
      Returns:
      IndexedLineSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getColorPerVertex

      boolean getColorPerVertex()
      Provide boolean value from initializeOnly SFBool field named colorPerVertex.

      Tooltip: Whether Color node color values are applied to each point vertex (true) or per polyline (false).
      Returns:
      value of colorPerVertex field

    • setColorPerVertex

      IndexedLineSet setColorPerVertex​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named colorPerVertex.

      Tooltip: Whether Color node color values are applied to each point vertex (true) or per polyline (false).
      Parameters:
      newValue - is new value for the colorPerVertex field.
      Returns:
      IndexedLineSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCoord

      X3DCoordinateNode getCoord()
      Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.

      Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that specifies a list of vertex values. *
      Returns:
      value of coord field

    • setCoord

      IndexedLineSet setCoord​(X3DCoordinateNode newValue)
      Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.

      Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that specifies a list of vertex values. *
      Parameters:
      newValue - is new value for the coord field.
      Returns:
      IndexedLineSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCoordIndex

      int[] getCoordIndex()
      Provide array of int results within allowed range of [-1,infinity) from initializeOnly MFInt32 field named coordIndex.

      Tooltip: [-1,+infinity) coordIndex indices provide the order in which coordinates are applied to construct each polygon face. Order starts at index 0, commas are optional between sets, use -1 to separate indices for each polyline.
      • Hint: if rendering Coordinate points originally defined for an IndexedFaceSet, index values may need to repeat initial each initial vertex to close the polygons.
      • Hint: sentinel value -1 is used to separate indices for each successive polyline.
      • Warning: coordIndex is required in order to connect contained coordinate point values.
      Returns:
      value of coordIndex field

    • setCoordIndex

      IndexedLineSet setCoordIndex​(int[] newValue)
      Accessor method to assign int array to initializeOnly MFInt32 field named coordIndex.

      Tooltip: [-1,+infinity) coordIndex indices provide the order in which coordinates are applied to construct each polygon face. Order starts at index 0, commas are optional between sets, use -1 to separate indices for each polyline.
      • Hint: if rendering Coordinate points originally defined for an IndexedFaceSet, index values may need to repeat initial each initial vertex to close the polygons.
      • Hint: sentinel value -1 is used to separate indices for each successive polyline.
      • Warning: coordIndex is required in order to connect contained coordinate point values.
      Parameters:
      newValue - is new value for the coordIndex field.
      Returns:
      IndexedLineSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getFogCoord

      FogCoordinate getFogCoord()
      Provide FogCoordinate instance (using a properly typed node) from inputOutput SFNode field fogCoord.

      Tooltip: [FogCoordinate] Single contained FogCoordinate node that specifies depth parameters for fog in corresponding geometry. *
      Returns:
      value of fogCoord field

    • setFogCoord

      IndexedLineSet setFogCoord​(FogCoordinate newValue)
      Accessor method to assign FogCoordinate instance (using a properly typed node) to inputOutput SFNode field fogCoord.

      Tooltip: [FogCoordinate] Single contained FogCoordinate node that specifies depth parameters for fog in corresponding geometry. *
      Parameters:
      newValue - is new value for the fogCoord field.
      Returns:
      IndexedLineSet - 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

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