Package org.web3d.x3d.jsail.Rendering

Class LineSet

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Rendering.LineSet
All Implemented Interfaces:
X3DNode, LineSet, X3DGeometryNode
public class LineSet
extends X3DConcreteNode
implements LineSet
LineSet is a geometry node that can contain a Coordinate|CoordinateDouble node and optionally a Color|ColorRGBA node.

X3D node tooltip: [X3DGeometryNode] LineSet 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: 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 LineSet (LS).

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

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static X3DColorNode COLOR_DEFAULT_VALUE
    SFNode field named color has default value null (Java syntax) or NULL (XML syntax).
    static java.lang.String COMPONENT
    String constant COMPONENT defines X3D component for the LineSet element: Rendering
    static java.lang.String containerField_DEFAULT_VALUE
    containerField describes typical field relationship of a node to its parent.
    static X3DCoordinateNode COORD_DEFAULT_VALUE
    SFNode field named coord has default value null (Java syntax) or NULL (XML syntax).
    static FogCoordinate FOGCOORD_DEFAULT_VALUE
    SFNode field named fogCoord has default value null (Java syntax) or NULL (XML syntax).
    static java.lang.String fromField_ATTRIB
    fromField ROUTE name for MFNode field named attrib.
    static java.lang.String fromField_COLOR
    fromField ROUTE name for SFNode field named color.
    static java.lang.String fromField_COORD
    fromField ROUTE name for SFNode field named coord.
    static java.lang.String fromField_FOGCOORD
    fromField ROUTE name for SFNode field named fogCoord.
    static java.lang.String fromField_IS
    fromField ROUTE name for SFNode field named IS.
    static java.lang.String fromField_METADATA
    fromField ROUTE name for SFNode field named metadata.
    static java.lang.String fromField_NORMAL
    fromField ROUTE name for SFNode field named normal.
    static java.lang.String fromField_VERTEXCOUNT
    fromField ROUTE name for MFInt32 field named vertexCount.
    static IS IS_DEFAULT_VALUE
    SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
    static int LEVEL
    Integer constant LEVEL provides default X3D Rendering component level for this element: 1
    static X3DMetadataObject METADATA_DEFAULT_VALUE
    SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
    static java.lang.String NAME
    String constant NAME provides name of this element: LineSet.
    static X3DNormalNode NORMAL_DEFAULT_VALUE
    SFNode field named normal has default value null (Java syntax) or NULL (XML syntax).
    static java.lang.String toField_ATTRIB
    toField ROUTE name for MFNode field named attrib.
    static java.lang.String toField_COLOR
    toField ROUTE name for SFNode field named color.
    static java.lang.String toField_COORD
    toField ROUTE name for SFNode field named coord.
    static java.lang.String toField_FOGCOORD
    toField ROUTE name for SFNode field named fogCoord.
    static java.lang.String toField_METADATA
    toField ROUTE name for SFNode field named metadata.
    static java.lang.String toField_NORMAL
    toField ROUTE name for SFNode field named normal.
    static java.lang.String toField_VERTEXCOUNT
    toField ROUTE name for MFInt32 field named vertexCount.
    static java.util.ArrayList<java.lang.Integer> VERTEXCOUNT_DEFAULT_VALUE
    MFInt32 field named vertexCount has default value equal to an empty list.

    Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

    CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

    Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

    validationResult

  • Constructor Summary

    Constructors 
    Constructor Description
    LineSet()
    Constructor for LineSet to initialize member variables with default values.
    LineSet​(java.lang.String DEFlabel)
    Utility constructor that assigns DEF label after initializing member variables with default values.

  • Method Summary

    Modifier and Type Method Description
    LineSet addAttrib​(ProtoInstance newValue)
    Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for attrib field.
    LineSet addAttrib​(X3DNode newValue)
    Add single child node to existing array of attrib nodes (if any).
    void addAttrib​(X3DNode[] newValue)
    Add array of child attrib nodes to array of existing nodes (if any).
    LineSet addComments​(java.lang.String newComment)
    Add comment as String to contained commentsList.
    LineSet addComments​(java.lang.String[] newComments)
    Add comments as String[] array to contained commentsList.
    LineSet addComments​(CommentsBlock newCommentsBlock)
    Add CommentsBlock to contained commentsList.
    LineSet addVertexCount​(int newValue)
    Add singleton int value to MFInt32 vertexCount field.
    LineSet addVertexCount​(SFInt32 newValue)
    Add singleton SFInt32 value to MFInt32 vertexCount field.
    LineSet clearAttrib()
    Utility method to clear MFNode value of attrib field.
    LineSet clearColor()
    Utility method to clear SFNode value of color field.
    LineSet clearCoord()
    Utility method to clear SFNode value of coord field.
    LineSet clearFogCoord()
    Utility method to clear SFNode value of fogCoord field.
    LineSet clearIS()
    Utility method to clear SFNode value of IS field.
    LineSet clearMetadata()
    Utility method to clear SFNode value of metadata field.
    LineSet clearNormal()
    Utility method to clear SFNode value of normal field.
    LineSet clearVertexCount()
    Utility method to clear MFInt32 value of vertexCount field.
    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.
    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.
    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.
    java.lang.String getAccessType​(java.lang.String fieldName)
    Indicate accessType corresponding to given fieldName.
    X3DNode[] getAttrib()
    Provide array of org.web3d.x3d.sai.Shaders.X3DVertexAttributeNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field attrib.
    java.util.ArrayList<X3DNode> getAttribList()
    Utility method to get ArrayList value of MFNode attrib field, similar to getAttrib().
    X3DColorNode getColor()
    Provide org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.
    java.lang.String getComponent()
    Defines X3D component for the LineSet element: Rendering
    int getComponentLevel()
    Provides default X3D component level for this element: 1
    java.lang.String getContainerFieldDefault()
    containerField describes typical field relationship of a node to its parent.
    X3DCoordinateNode getCoord()
    Provide org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.
    java.lang.String getCssClass()
    Provide String value from inputOutput SFString field named class.
    java.lang.String getDEF()
    Provide String value from inputOutput SFString field named DEF.
    java.lang.String getElementName()
    Provides name of this element: LineSet
    java.lang.String getFieldType​(java.lang.String fieldName)
    Indicate type corresponding to given fieldName.
    FogCoordinate getFogCoord()
    Provide org.web3d.x3d.sai.EnvironmentalEffects.FogCoordinate instance (using a properly typed node) from inputOutput SFNode field fogCoord.
    IS getIS()
    Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
    X3DMetadataObject getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    X3DNormalNode getNormal()
    Provide org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field normal.
    java.lang.String getUSE()
    Provide String value from inputOutput SFString field named USE.
    int[] getVertexCount()
    Provide array of Integer results within allowed range of [2,infinity) from inputOutput MFInt32 field named vertexCount.
    java.util.ArrayList<java.lang.Integer> getVertexCountList()
    Utility method to get ArrayList value of MFInt32 vertexCount field, similar to getVertexCount().
    java.lang.String getVertexCountString()
    Utility method to get String value of MFInt32 vertexCount field, similar to getVertexCount().
    boolean hasAttrib()
    Indicate whether an object is available for inputOutput MFNode field attrib.
    boolean hasColor()
    Indicate whether an object is available for inputOutput SFNode field color.
    boolean hasCoord()
    Indicate whether an object is available for inputOutput SFNode field coord.
    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.
    boolean hasFogCoord()
    Indicate whether an object is available for inputOutput SFNode field fogCoord.
    boolean hasIS()
    Indicate whether an object is available for inputOutput SFNode field IS.
    boolean hasMetadata()
    Indicate whether an object is available for inputOutput SFNode field metadata.
    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.
    boolean hasNormal()
    Indicate whether an object is available for inputOutput SFNode field normal.
    void initialize()
    Initialize all member variables to default values.
    LineSet setAttrib​(java.util.ArrayList<X3DVertexAttributeNode> newValue)
    Assign ArrayList value of MFNode attrib field, similar to setAttrib(org.web3d.x3d.sai.Core.X3DNode[]).
    void setAttrib​(X3DNode newValue)
    Set single child attrib node, replacing prior array of existing nodes (if any).
    LineSet setAttrib​(X3DNode[] newValue)
    Accessor method to assign org.web3d.x3d.sai.Shaders.X3DVertexAttributeNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field attrib.
    LineSet setColor​(ProtoInstance newValue)
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field color.
    LineSet setColor​(X3DColorNode newValue)
    Accessor method to assign org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.
    LineSet setCoord​(ProtoInstance newValue)
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field coord.
    LineSet setCoord​(X3DCoordinateNode newValue)
    Accessor method to assign org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.
    LineSet setCssClass​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named class.
    LineSet setCssClass​(SFString newValue)
    Assign typed object value to SFString cssClass field, similar to setCssClass(String).
    LineSet setDEF​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named DEF.
    LineSet setDEF​(SFString newValue)
    Assign typed object value to SFString DEF field, similar to setDEF(String).
    LineSet setFogCoord​(ProtoInstance newValue)
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fogCoord.
    LineSet setFogCoord​(FogCoordinate newValue)
    Accessor method to assign org.web3d.x3d.sai.EnvironmentalEffects.FogCoordinate instance (using a properly typed node) to inputOutput SFNode field fogCoord.
    LineSet setIS​(IS newValue)
    Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
    LineSet setMetadata​(ProtoInstance newValue)
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
    LineSet setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    LineSet setNormal​(ProtoInstance newValue)
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field normal.
    LineSet setNormal​(X3DNormalNode newValue)
    Accessor method to assign org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal.
    LineSet setUSE​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named USE.
    LineSet setUSE​(SFString newValue)
    Assign typed object value to SFString USE field, similar to setUSE(String).
    LineSet setUSE​(LineSet DEFnode)
    Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
    LineSet setVertexCount​(int[] newValue)
    Accessor method to assign Integer array to inputOutput MFInt32 field named vertexCount.
    LineSet setVertexCount​(java.util.ArrayList<java.lang.Integer> newValue)
    Assign ArrayList value of MFInt32 vertexCount field, similar to setVertexCount(int[]).
    LineSet setVertexCount​(MFInt32 newValue)
    Assign typed object value to MFInt32 vertexCount field, similar to setVertexCount(int[]).
    java.lang.String toStringClassicVRML​(int indentLevel)
    Recursive method to provide ClassicVRML string serialization.
    java.lang.String toStringVRML97​(int indentLevel)
    Recursive method to provide VRML97 string serialization.
    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.
    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.

    Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

    getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

    Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

    addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • LineSet

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

    • LineSet

      public LineSet​(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: LineSet
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element

    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the LineSet 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 org.web3d.x3d.sai.Shaders.X3DVertexAttributeNode results (using an array consisting of properly typed nodes or ProtoInstances) 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 LineSet
      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 LineSet setAttrib​(X3DNode[] newValue)
      Accessor method to assign org.web3d.x3d.sai.Shaders.X3DVertexAttributeNode array (using an array consisting of properly typed nodes or ProtoInstances) 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 LineSet
      Parameters:
      newValue - is new value for the attrib field.
      Returns:
      LineSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setAttrib

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

    • addAttrib

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

    • addAttrib

      public LineSet addAttrib​(ProtoInstance newValue)
      Add single ProtoInstance (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:
      LineSet - 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 LineSet
      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 LineSet
      Parameters:
      newValue - is new node for the attrib field (restricted to X3DVertexAttributeNode)

    • clearAttrib

      public LineSet clearAttrib()
      Utility method to clear MFNode value of attrib field.
      Returns:
      LineSet - 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 org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.
      Specified by:
      getColor in interface LineSet
      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 LineSet setColor​(X3DColorNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.
      Specified by:
      setColor in interface LineSet
      Parameters:
      newValue - is new value for the color field.
      Returns:
      LineSet - 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 LineSet clearColor()
      Utility method to clear SFNode value of color field.
      Returns:
      LineSet - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setColor

      public LineSet setColor​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field color.
      Parameters:
      newValue - is new value for the color field.
      Returns:
      LineSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setColor( org.web3d.x3d.sai.Rendering.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()

    • getCoord

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

    • setCoord

      public LineSet setCoord​(X3DCoordinateNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.
      Specified by:
      setCoord in interface LineSet
      Parameters:
      newValue - is new value for the coord field.
      Returns:
      LineSet - 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 LineSet clearCoord()
      Utility method to clear SFNode value of coord field.
      Returns:
      LineSet - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setCoord

      public LineSet setCoord​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field coord.
      Parameters:
      newValue - is new value for the coord field.
      Returns:
      LineSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setCoord( org.web3d.x3d.sai.Rendering.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()

    • getFogCoord

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

    • setFogCoord

      public LineSet setFogCoord​(FogCoordinate newValue)
      Accessor method to assign org.web3d.x3d.sai.EnvironmentalEffects.FogCoordinate instance (using a properly typed node) to inputOutput SFNode field fogCoord.
      Specified by:
      setFogCoord in interface LineSet
      Parameters:
      newValue - is new value for the fogCoord field.
      Returns:
      LineSet - 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 LineSet clearFogCoord()
      Utility method to clear SFNode value of fogCoord field.
      Returns:
      LineSet - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setFogCoord

      public LineSet setFogCoord​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fogCoord.
      Parameters:
      newValue - is new value for the fogCoord field.
      Returns:
      LineSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setFogCoord( org.web3d.x3d.sai.EnvironmentalEffects.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 IS getIS()
      Provide IS 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 LineSet setIS​(IS newValue)
      Accessor method to assign IS 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:
      LineSet - 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 LineSet clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      LineSet - 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 org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface LineSet
      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/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      public LineSet setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface LineSet
      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:
      LineSet - 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/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes

    • clearMetadata

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

    • setMetadata

      public LineSet setMetadata​(ProtoInstance 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:
      LineSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata( org.web3d.x3d.sai.Core.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

    • getNormal

      public X3DNormalNode getNormal()
      Provide org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field normal.
      Specified by:
      getNormal in interface LineSet
      Returns:
      value of normal field
      See Also:
      getNormalProtoInstance()

    • setNormal

      public LineSet setNormal​(X3DNormalNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal.
      Specified by:
      setNormal in interface LineSet
      Parameters:
      newValue - is new value for the normal field.
      Returns:
      LineSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setNormal(ProtoInstance)

    • clearNormal

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

    • setNormal

      public LineSet setNormal​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field normal.
      Parameters:
      newValue - is new value for the normal field.
      Returns:
      LineSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setNormal( org.web3d.x3d.sai.Rendering.X3DNormalNode)

    • hasNormal

      public boolean hasNormal()
      Indicate whether an object is available for inputOutput SFNode field normal.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getNormal(), getNormalProtoInstance()

    • getVertexCount

      public int[] getVertexCount()
      Provide array of Integer results within allowed range of [2,infinity) from inputOutput MFInt32 field named vertexCount.

      Tooltip: [2,+infinity) vertexCount describes how many vertices are used in each individual polyline segment from the Coordinate point values. Coordinate point values are assigned as a block of points to each line by taking vertexCount[n] vertices at a time. *
      Specified by:
      getVertexCount in interface LineSet
      Returns:
      value of vertexCount field

    • getVertexCountList

      public java.util.ArrayList<java.lang.Integer> getVertexCountList()
      Utility method to get ArrayList value of MFInt32 vertexCount field, similar to getVertexCount().
      Returns:
      value of vertexCount field

    • getVertexCountString

      public java.lang.String getVertexCountString()
      Utility method to get String value of MFInt32 vertexCount field, similar to getVertexCount().
      Returns:
      value of vertexCount field

    • setVertexCount

      public LineSet setVertexCount​(int[] newValue)
      Accessor method to assign Integer array to inputOutput MFInt32 field named vertexCount.

      Tooltip: [2,+infinity) vertexCount describes how many vertices are used in each individual polyline segment from the Coordinate point values. Coordinate point values are assigned as a block of points to each line by taking vertexCount[n] vertices at a time. *
      Specified by:
      setVertexCount in interface LineSet
      Parameters:
      newValue - is new value for the vertexCount field.
      Returns:
      LineSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setVertexCount

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

    • setVertexCount

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

    • clearVertexCount

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

    • addVertexCount

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

    • addVertexCount

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

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

    • setDEF

      public LineSet setDEF​(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      LineSet - 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 LineSet 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:
      LineSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

      public LineSet setUSE​(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      LineSet - 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 Cascading Style Sheets (CSS) and XML stylesheets.
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets

    • setCssClass

      public final LineSet 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 Cascading Style Sheets (CSS) and XML stylesheets.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      LineSet - 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 LineSet setCssClass​(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      LineSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

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

    • addComments

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

    • addComments

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

    • addComments

      public LineSet addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      LineSet - 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:
      X3D.FILE_EXTENSION_X3D, X3D.FILE_EXTENSION_XML, X3D.toStringXML(), X3D.toFileXML(String), X3D.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:
      X3D.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:
      X3D.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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()

    • 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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()

    • 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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()

    • 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)