Package org.web3d.x3d.jsail.Rendering

Class IndexedLineSetObject

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Rendering.IndexedLineSetObject
All Implemented Interfaces:
X3DNode, IndexedLineSet, X3DGeometryNode
public class IndexedLineSetObject
extends X3DConcreteNode
implements IndexedLineSet
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 org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:
X3D Abstract Specification: IndexedLineSet, X3D Tooltips: IndexedLineSet, X3D Scene Authoring Hints

  • Field Details

  • Constructor Details

    • IndexedLineSetObject

      public IndexedLineSetObject()
      Constructor for IndexedLineSetObject to initialize member variables with default values.

    • IndexedLineSetObject

      public IndexedLineSetObject​(java.lang.String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node

  • Method Details

    • getElementName

      public final java.lang.String getElementName()
      Provides name of this element: IndexedLineSet
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element

    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the IndexedLineSet element: Rendering
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element

    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 1
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element

    • getFieldType

      public java.lang.String getFieldType​(java.lang.String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

    • getAccessType

      public java.lang.String getAccessType​(java.lang.String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

    • getContainerFieldDefault

      public final java.lang.String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)

    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode

    • getAttrib

      public X3DNode[] getAttrib()
      Provide array of X3DVertexAttributeNode 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.
      Specified by:
      getAttrib in interface IndexedLineSet
      Returns:
      value of attrib field
      See Also:
      X3DVertexAttributeNode

    • getAttribList

      public java.util.ArrayList<X3DNode> getAttribList()
      Utility method to get ArrayList value of MFNode attrib field, similar to getAttrib().
      Returns:
      value of attrib field

    • setAttrib

      public IndexedLineSetObject setAttrib​(X3DNode[] newValue)
      Accessor method to assign X3DVertexAttributeNode 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.
      Specified by:
      setAttrib in interface IndexedLineSet
      Parameters:
      newValue - is new value for the attrib field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setAttrib

      public IndexedLineSetObject setAttrib​(java.util.ArrayList<X3DVertexAttributeNode> newValue)
      Assign ArrayList value of MFNode attrib field, similar to setAttrib(X3DNode[]).
      Parameters:
      newValue - is new value for the attrib field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addAttrib

      public IndexedLineSetObject addAttrib​(X3DNode newValue)
      Add single child node to existing array of attrib nodes (if any).

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

    • addAttrib

      public IndexedLineSetObject addAttrib​(ProtoInstanceObject newValue)
      Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for attrib field.

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.
      Parameters:
      newValue - is new value to be appended the parts field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addAttrib

      public 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.
      Specified by:
      addAttrib in interface IndexedLineSet
      Parameters:
      newValue - is new value array to be appended the attrib field.

    • setAttrib

      public void setAttrib​(X3DNode newValue)
      Set single child attrib node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DVertexAttributeNode.
      Specified by:
      setAttrib in interface IndexedLineSet
      Parameters:
      newValue - is new node for the attrib field (restricted to X3DVertexAttributeNode)

    • clearAttrib

      public IndexedLineSetObject clearAttrib()
      Utility method to clear MFNode value of attrib field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasAttrib

      public boolean hasAttrib()
      Indicate whether an object is available for inputOutput MFNode field attrib.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:
      getAttrib()

    • getColor

      public X3DColorNode getColor()
      Provide X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.
      Specified by:
      getColor in interface IndexedLineSet
      Returns:
      value of color field
      See Also:
      Tooltip: [X3DColorNode] Single contained Color or ColorRGBA node that specifies color values applied to corresponding vertices according to colorIndex and colorPerVertex fields. *

    • setColor

      public IndexedLineSetObject setColor​(X3DColorNode newValue)
      Accessor method to assign X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.
      Specified by:
      setColor in interface IndexedLineSet
      Parameters:
      newValue - is new value for the color field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DColorNode] Single contained Color or ColorRGBA node that specifies color values applied to corresponding vertices according to colorIndex and colorPerVertex fields. *

    • clearColor

      public IndexedLineSetObject clearColor()
      Utility method to clear SFNode value of color field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setColor

      public IndexedLineSetObject setColor​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field color.
      Parameters:
      newValue - is new value for the color field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setColor(X3DColorNode)

    • hasColor

      public boolean hasColor()
      Indicate whether an object is available for inputOutput SFNode field color.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getColor(), getColorProtoInstance()

    • getColorIndex

      public int[] getColorIndex()
      Provide array of Integer 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.
      Specified by:
      getColorIndex in interface IndexedLineSet
      Returns:
      value of colorIndex field

    • getColorIndexList

      public java.util.ArrayList<java.lang.Integer> getColorIndexList()
      Utility method to get ArrayList value of MFInt32 colorIndex field, similar to getColorIndex().
      Returns:
      value of colorIndex field

    • getColorIndexString

      public java.lang.String getColorIndexString()
      Utility method to get String value of MFInt32 colorIndex field, similar to getColorIndex().
      Returns:
      value of colorIndex field

    • setColorIndex

      public IndexedLineSetObject setColorIndex​(int[] newValue)
      Accessor method to assign Integer 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.
      Specified by:
      setColorIndex in interface IndexedLineSet
      Parameters:
      newValue - is new value for the colorIndex field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setColorIndex

      public IndexedLineSetObject setColorIndex​(MFInt32Object newValue)
      Assign typed object value to MFInt32 colorIndex field, similar to setColorIndex(int[]).
      Parameters:
      newValue - is new value for the colorIndex field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setColorIndex

      public IndexedLineSetObject setColorIndex​(java.util.ArrayList<java.lang.Integer> newValue)
      Assign ArrayList value of MFInt32 colorIndex field, similar to setColorIndex(int[]).
      Parameters:
      newValue - is new value for the colorIndex field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • clearColorIndex

      public IndexedLineSetObject clearColorIndex()
      Utility method to clear MFInt32 value of colorIndex field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addColorIndex

      public IndexedLineSetObject addColorIndex​(int newValue)
      Add singleton int value to MFInt32 colorIndex field.
      Parameters:
      newValue - is new value to add to the colorIndex field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addColorIndex

      public IndexedLineSetObject addColorIndex​(SFInt32Object newValue)
      Add singleton SFInt32Object value to MFInt32 colorIndex field.
      Parameters:
      newValue - is new value to add to the colorIndex field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getColorPerVertex

      public 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).
      Specified by:
      getColorPerVertex in interface IndexedLineSet
      Returns:
      value of colorPerVertex field

    • setColorPerVertex

      public IndexedLineSetObject 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).
      Specified by:
      setColorPerVertex in interface IndexedLineSet
      Parameters:
      newValue - is new value for the colorPerVertex field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setColorPerVertex

      public IndexedLineSetObject setColorPerVertex​(SFBoolObject newValue)
      Assign typed object value to SFBool colorPerVertex field, similar to setColorPerVertex(boolean).
      Parameters:
      newValue - is new value for the colorPerVertex field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCoord

      public X3DCoordinateNode getCoord()
      Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.
      Specified by:
      getCoord in interface IndexedLineSet
      Returns:
      value of coord field
      See Also:
      Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that specifies a list of vertex values. *

    • setCoord

      public IndexedLineSetObject setCoord​(X3DCoordinateNode newValue)
      Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.
      Specified by:
      setCoord in interface IndexedLineSet
      Parameters:
      newValue - is new value for the coord field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that specifies a list of vertex values. *

    • clearCoord

      public IndexedLineSetObject clearCoord()
      Utility method to clear SFNode value of coord field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setCoord

      public IndexedLineSetObject setCoord​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field coord.
      Parameters:
      newValue - is new value for the coord field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setCoord(X3DCoordinateNode)

    • hasCoord

      public boolean hasCoord()
      Indicate whether an object is available for inputOutput SFNode field coord.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getCoord(), getCoordProtoInstance()

    • getCoordIndex

      public int[] getCoordIndex()
      Provide array of Integer 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.
      Specified by:
      getCoordIndex in interface IndexedLineSet
      Returns:
      value of coordIndex field

    • getCoordIndexList

      public java.util.ArrayList<java.lang.Integer> getCoordIndexList()
      Utility method to get ArrayList value of MFInt32 coordIndex field, similar to getCoordIndex().
      Returns:
      value of coordIndex field

    • getCoordIndexString

      public java.lang.String getCoordIndexString()
      Utility method to get String value of MFInt32 coordIndex field, similar to getCoordIndex().
      Returns:
      value of coordIndex field

    • setCoordIndex

      public IndexedLineSetObject setCoordIndex​(int[] newValue)
      Accessor method to assign Integer 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.
      Specified by:
      setCoordIndex in interface IndexedLineSet
      Parameters:
      newValue - is new value for the coordIndex field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCoordIndex

      public IndexedLineSetObject setCoordIndex​(MFInt32Object newValue)
      Assign typed object value to MFInt32 coordIndex field, similar to setCoordIndex(int[]).
      Parameters:
      newValue - is new value for the coordIndex field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCoordIndex

      public IndexedLineSetObject setCoordIndex​(java.util.ArrayList<java.lang.Integer> newValue)
      Assign ArrayList value of MFInt32 coordIndex field, similar to setCoordIndex(int[]).
      Parameters:
      newValue - is new value for the coordIndex field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • clearCoordIndex

      public IndexedLineSetObject clearCoordIndex()
      Utility method to clear MFInt32 value of coordIndex field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addCoordIndex

      public IndexedLineSetObject addCoordIndex​(int newValue)
      Add singleton int value to MFInt32 coordIndex field.
      Parameters:
      newValue - is new value to add to the coordIndex field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addCoordIndex

      public IndexedLineSetObject addCoordIndex​(SFInt32Object newValue)
      Add singleton SFInt32Object value to MFInt32 coordIndex field.
      Parameters:
      newValue - is new value to add to the coordIndex field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getFogCoord

      public FogCoordinate getFogCoord()
      Provide FogCoordinateObject instance (using a properly typed node) from inputOutput SFNode field fogCoord.
      Specified by:
      getFogCoord in interface IndexedLineSet
      Returns:
      value of fogCoord field
      See Also:
      Tooltip: [FogCoordinate] Single contained FogCoordinate node that specifies depth parameters for fog in corresponding geometry. *

    • setFogCoord

      public IndexedLineSetObject setFogCoord​(FogCoordinate newValue)
      Accessor method to assign FogCoordinateObject instance (using a properly typed node) to inputOutput SFNode field fogCoord.
      Specified by:
      setFogCoord in interface IndexedLineSet
      Parameters:
      newValue - is new value for the fogCoord field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [FogCoordinate] Single contained FogCoordinate node that specifies depth parameters for fog in corresponding geometry. *

    • clearFogCoord

      public IndexedLineSetObject clearFogCoord()
      Utility method to clear SFNode value of fogCoord field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setFogCoord

      public IndexedLineSetObject setFogCoord​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fogCoord.
      Parameters:
      newValue - is new value for the fogCoord field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setFogCoord(FogCoordinate)

    • hasFogCoord

      public boolean hasFogCoord()
      Indicate whether an object is available for inputOutput SFNode field fogCoord.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getFogCoord(), getFogCoordProtoInstance()

    • getIS

      public ISObject getIS()
      Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect

    • setIS

      public IndexedLineSetObject setIS​(ISObject newValue)
      Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect

    • clearIS

      public IndexedLineSetObject clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:
      getIS()

    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface IndexedLineSet
      Specified by:
      getMetadata in interface X3DGeometryNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      public IndexedLineSetObject setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface IndexedLineSet
      Specified by:
      setMetadata in interface X3DGeometryNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes

    • clearMetadata

      public IndexedLineSetObject clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setMetadata

      public IndexedLineSetObject setMetadata​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(X3DMetadataObject)

    • hasMetadata

      public boolean hasMetadata()
      Indicate whether an object is available for inputOutput SFNode field metadata.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes

    • getDEF

      public java.lang.String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions

    • setDEF

      public final IndexedLineSetObject setDEF​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDEF

      public IndexedLineSetObject setDEF​(SFStringObject newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getUSE

      public java.lang.String getUSE()
      Provide String value from inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions

    • setUSE

      public final IndexedLineSetObject setUSE​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.


      Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

      Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Specified by:
      setUSE in class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

      public IndexedLineSetObject setUSE​(SFStringObject newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCssClass

      public java.lang.String getCssClass()
      Provide String value from inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets

    • setCssClass

      public final IndexedLineSetObject setCssClass​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      W3C Cascading Style Sheets

    • setCssClass

      public IndexedLineSetObject setCssClass​(SFStringObject newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

      public IndexedLineSetObject setUSE​(IndexedLineSetObject DEFnode)
      Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

      Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Parameters:
      DEFnode - must have a DEF value defined
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addComments

      public IndexedLineSetObject addComments​(java.lang.String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addComments

      public IndexedLineSetObject addComments​(java.lang.String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addComments

      public IndexedLineSetObject addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      IndexedLineSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • toStringX3D

      public java.lang.String toStringX3D​(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
      X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool

    • toStringClassicVRML

      public java.lang.String toStringClassicVRML​(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
      X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar

    • toStringVRML97

      public java.lang.String toStringVRML97​(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
      X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

    • hasElementByNameValue

      public boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:
      findElementByNameValue(String, String)

    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

    • hasNodeByDEF

      public boolean hasNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      whether node is found
      See Also:
      findNodeByDEF(String)

    • validate

      public java.lang.String validate()
      Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)

    • getCoordCount

      public int getCoordCount()
      Utility method to get number of coordinate 3-tuple values in contained Coordinate/CoordinateDouble or ProtoInstance node
      Returns:
      number of coordinate 3-tuple values
      See Also:
      CoordinateObject, CoordinateDoubleObject, ProtoInstanceObject

    • getColorCount

      public int getColorCount()
      Utility method to get number of 3-tuple Color RGB values (or 4-tuple ColorRGBA values) in contained Color/ColorRGBA or ProtoInstance node
      Returns:
      number of color values
      See Also:
      ColorObject, ColorRGBAObject, ProtoInstanceObject