Interface IndexedQuadSet

All Superinterfaces:
X3DComposedGeometryNode, X3DGeometryNode, X3DNode
All Known Implementing Classes:
IndexedQuadSetObject

public interface IndexedQuadSet
extends X3DComposedGeometryNode
IndexedQuadSet is a geometry node that defines quadrilaterals.

X3D node tooltip: (X3D version 3.1 or later) [X3DComposedGeometryNode] IndexedQuadSet is a geometry node that defines planar quadrilaterals. IndexedQuadSet contains a Coordinate|CoordinateDouble node, and can also contain Color|ColorRGBA, Normal and TextureCoordinate nodes.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification: TODO, X3D Abstract Specification: IndexedQuadSet, X3D Tooltips: IndexedQuadSet, X3D Scene Authoring Hints: Meshes
  • Method Summary

    Modifier and Type Method Description
    void addAttrib​(X3DNode[] newValue)
    Add array of child attrib nodes to array of existing nodes (if any).
    X3DNode[] getAttrib()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field attrib.
    boolean getCcw()
    Provide boolean value from initializeOnly SFBool field named ccw.
    X3DColorNode getColor()
    Provide X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.
    boolean getColorPerVertex()
    Provide boolean value from initializeOnly SFBool field named colorPerVertex.
    X3DCoordinateNode getCoord()
    Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.
    FogCoordinate getFogCoord()
    Provide FogCoordinate instance (using a properly typed node) from inputOutput SFNode field fogCoord.
    int[] getIndex()
    Provide array of int results within allowed range of [0,infinity) from initializeOnly MFInt32 field named index.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    X3DNormalNode getNormal()
    Provide X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field normal.
    boolean getNormalPerVertex()
    Provide boolean value from initializeOnly SFBool field named normalPerVertex.
    boolean getSolid()
    Provide boolean value from initializeOnly SFBool field named solid.
    X3DTextureCoordinateNode getTexCoord()
    Provide X3DTextureCoordinateNode instance (using a properly typed node) from inputOutput SFNode field texCoord.
    void setAttrib​(X3DNode newValue)
    Set single child attrib node, replacing prior array of existing nodes (if any).
    IndexedQuadSet setAttrib​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field attrib.
    IndexedQuadSet setCcw​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named ccw.
    IndexedQuadSet setColor​(X3DColorNode newValue)
    Accessor method to assign X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.
    IndexedQuadSet setColorPerVertex​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named colorPerVertex.
    IndexedQuadSet setCoord​(X3DCoordinateNode newValue)
    Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.
    IndexedQuadSet setFogCoord​(FogCoordinate newValue)
    Accessor method to assign FogCoordinate instance (using a properly typed node) to inputOutput SFNode field fogCoord.
    IndexedQuadSet setIndex​(int[] newValue)
    Accessor method to assign int array to initializeOnly MFInt32 field named index.
    IndexedQuadSet setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    IndexedQuadSet setNormal​(X3DNormalNode newValue)
    Accessor method to assign X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal.
    IndexedQuadSet setNormalPerVertex​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named normalPerVertex.
    IndexedQuadSet setSolid​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named solid.
    IndexedQuadSet setTexCoord​(X3DTextureCoordinateNode newValue)
    Accessor method to assign X3DTextureCoordinateNode instance (using a properly typed node) to inputOutput SFNode field texCoord.
  • Method Details

    • getAttrib

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

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

      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVertexAttributeNode.
      Specified by:
      getAttrib in interface X3DComposedGeometryNode
      Returns:
      value of attrib field
      See Also:
      X3DVertexAttributeNode
    • setAttrib

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

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

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

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

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVertexAttributeNode.
      Specified by:
      addAttrib in interface X3DComposedGeometryNode
      Parameters:
      newValue - is new value array to be appended the attrib field.
    • setAttrib

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

      boolean getCcw()
      Provide boolean value from initializeOnly SFBool field named ccw.

      Tooltip: ccw = counterclockwise: ordering of vertex coordinates orientation, according to Right-Hand Rule (RHR).
      • Hint: ccw false can reverse solid (backface culling) and normal-vector orientation. Note that consistency of left-handed or right-handed point sequences is important throughout.
      Specified by:
      getCcw in interface X3DComposedGeometryNode
      Returns:
      value of ccw field
    • setCcw

      IndexedQuadSet setCcw​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named ccw.

      Tooltip: ccw = counterclockwise: ordering of vertex coordinates orientation, according to Right-Hand Rule (RHR).
      • Hint: ccw false can reverse solid (backface culling) and normal-vector orientation. Note that consistency of left-handed or right-handed point sequences is important throughout.
      Specified by:
      setCcw in interface X3DComposedGeometryNode
      Parameters:
      newValue - is new value for the ccw field.
      Returns:
      IndexedQuadSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getColor

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

      Tooltip: [X3DColorNode] Single contained Color or ColorRGBA node that specifies color values applied to corresponding vertices according to colorIndex and colorPerVertex fields. *
      Specified by:
      getColor in interface X3DComposedGeometryNode
      Returns:
      value of color field
    • setColor

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

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

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

      Tooltip: Whether Color|ColorRGBA values are applied to each point vertex (true) or to each polygon face (false).
      Specified by:
      getColorPerVertex in interface X3DComposedGeometryNode
      Returns:
      value of colorPerVertex field
    • setColorPerVertex

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

      Tooltip: Whether Color|ColorRGBA values are applied to each point vertex (true) or to each polygon face (false).
      Specified by:
      setColorPerVertex in interface X3DComposedGeometryNode
      Parameters:
      newValue - is new value for the colorPerVertex field.
      Returns:
      IndexedQuadSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCoord

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

      Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that specifies a list of vertex values. *
      Specified by:
      getCoord in interface X3DComposedGeometryNode
      Returns:
      value of coord field
    • setCoord

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

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

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

      Tooltip: [FogCoordinate] Single contained FogCoordinate node that specifies depth parameters for fog in corresponding geometry. *
      Specified by:
      getFogCoord in interface X3DComposedGeometryNode
      Returns:
      value of fogCoord field
    • setFogCoord

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

      Tooltip: [FogCoordinate] Single contained FogCoordinate node that specifies depth parameters for fog in corresponding geometry. *
      Specified by:
      setFogCoord in interface X3DComposedGeometryNode
      Parameters:
      newValue - is new value for the fogCoord field.
      Returns:
      IndexedQuadSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getIndex

      int[] getIndex()
      Provide array of int results within allowed range of [0,infinity) from initializeOnly MFInt32 field named index.

      Tooltip: [0,+infinity) index values provide order in which coordinates are applied. Order starts at index 0, commas are optional between sets. Four unique indices are defined for each quadrilateral.
      • Warning: -1 sentinel values are not allowed.
      Returns:
      value of index field
    • setIndex

      IndexedQuadSet setIndex​(int[] newValue)
      Accessor method to assign int array to initializeOnly MFInt32 field named index.

      Tooltip: [0,+infinity) index values provide order in which coordinates are applied. Order starts at index 0, commas are optional between sets. Four unique indices are defined for each quadrilateral.
      • Warning: -1 sentinel values are not allowed.
      Parameters:
      newValue - is new value for the index field.
      Returns:
      IndexedQuadSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMetadata

      X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface X3DComposedGeometryNode
      Specified by:
      getMetadata in interface X3DGeometryNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      IndexedQuadSet setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface X3DComposedGeometryNode
      Specified by:
      setMetadata in interface X3DGeometryNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      IndexedQuadSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • getNormal

      X3DNormalNode getNormal()
      Provide X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field normal.

      Tooltip: [X3DNormalNode] Single contained Normal node that specifies perpendicular vectors for corresponding vertices to support rendering computations, applied according to the normalPerVertex field.
      • Hint: useful for special effects. Normal vector computation by 3D graphics hardware is quite fast so adding normals to a scene is typically unnecessary.
      • Warning: normal vectors increase file size, typically doubling geometry definitions.
      Specified by:
      getNormal in interface X3DComposedGeometryNode
      Returns:
      value of normal field
    • setNormal

      IndexedQuadSet setNormal​(X3DNormalNode newValue)
      Accessor method to assign X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal.

      Tooltip: [X3DNormalNode] Single contained Normal node that specifies perpendicular vectors for corresponding vertices to support rendering computations, applied according to the normalPerVertex field.
      • Hint: useful for special effects. Normal vector computation by 3D graphics hardware is quite fast so adding normals to a scene is typically unnecessary.
      • Warning: normal vectors increase file size, typically doubling geometry definitions.
      Specified by:
      setNormal in interface X3DComposedGeometryNode
      Parameters:
      newValue - is new value for the normal field.
      Returns:
      IndexedQuadSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getNormalPerVertex

      boolean getNormalPerVertex()
      Provide boolean value from initializeOnly SFBool field named normalPerVertex.

      Tooltip: Whether Normal node vector values are applied to each point vertex (true) or to each polygon face (false).
      • Hint: if no child Normal node is provided, the X3D browser shall automatically generate normals, using creaseAngle to determine smoothed shading across shared vertices.
      Specified by:
      getNormalPerVertex in interface X3DComposedGeometryNode
      Returns:
      value of normalPerVertex field
    • setNormalPerVertex

      IndexedQuadSet setNormalPerVertex​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named normalPerVertex.

      Tooltip: Whether Normal node vector values are applied to each point vertex (true) or to each polygon face (false).
      • Hint: if no child Normal node is provided, the X3D browser shall automatically generate normals, using creaseAngle to determine smoothed shading across shared vertices.
      Specified by:
      setNormalPerVertex in interface X3DComposedGeometryNode
      Parameters:
      newValue - is new value for the normalPerVertex field.
      Returns:
      IndexedQuadSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSolid

      boolean getSolid()
      Provide boolean value from initializeOnly SFBool field named solid.

      Tooltip: Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off).
      • Warning: default value true can completely hide geometry if viewed from wrong side!
      • Hint: if in doubt, use solid='false' for maximum visibility.
      Specified by:
      getSolid in interface X3DComposedGeometryNode
      Returns:
      value of solid field
    • setSolid

      IndexedQuadSet setSolid​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named solid.

      Tooltip: Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off).
      • Warning: default value true can completely hide geometry if viewed from wrong side!
      • Hint: if in doubt, use solid='false' for maximum visibility.
      Specified by:
      setSolid in interface X3DComposedGeometryNode
      Parameters:
      newValue - is new value for the solid field.
      Returns:
      IndexedQuadSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getTexCoord

      Provide X3DTextureCoordinateNode instance (using a properly typed node) from inputOutput SFNode field texCoord.

      Tooltip: [X3DTextureCoordinateNode] Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate node that specifies coordinates for texture mapping onto corresponding geometry. *
      Specified by:
      getTexCoord in interface X3DComposedGeometryNode
      Returns:
      value of texCoord field
    • setTexCoord

      IndexedQuadSet setTexCoord​(X3DTextureCoordinateNode newValue)
      Accessor method to assign X3DTextureCoordinateNode instance (using a properly typed node) to inputOutput SFNode field texCoord.

      Tooltip: [X3DTextureCoordinateNode] Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate node that specifies coordinates for texture mapping onto corresponding geometry. *
      Specified by:
      setTexCoord in interface X3DComposedGeometryNode
      Parameters:
      newValue - is new value for the texCoord field.
      Returns:
      IndexedQuadSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).