Interface QuadSet

All Superinterfaces:
X3DComposedGeometryNode, X3DGeometryNode, X3DNode
All Known Implementing Classes:
QuadSet
public interface QuadSet extends X3DComposedGeometryNode
QuadSet is a geometry node that defines quadrilaterals.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. QuadSet node tooltip: (X3D version 3.1 or later) [X3DComposedGeometryNode] QuadSet is a geometry node that defines planar quadrilaterals. QuadSet contains a Coordinate|CoordinateDouble node, and can also contain Color|ColorRGBA, Normal and TextureCoordinate nodes.
  • Hint: Quadrilateral https://en.wikipedia.org/wiki/Quadrilateral
  • Hint: color, normal and texCoord values are applied in the same order as coord values.
  • 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: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/ComputerAidedDesignInterchangeProfile.pdf
  • Warning: requires X3D profile='Full' or else include <component name='CADGeometry' level='1'/>
  • Warning: rendering characteristics are undefined if polygons are not planar.
  • Warning: avoid self-intersecting polygon line segments, otherwise defined geometry is irregular and rendering results are undefined.

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

  • 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 org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field attrib.
    boolean
    getCcw()
    Provide boolean value from initializeOnly SFBool field named ccw.
    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.
    boolean
    getColorPerVertex()
    Provide boolean value from initializeOnly SFBool field named colorPerVertex.
    X3DCoordinateNode
    getCoord()
    Provide org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.
    FogCoordinate
    getFogCoord()
    Provide org.web3d.x3d.sai.EnvironmentalEffects.FogCoordinate instance (using a properly typed node) from inputOutput SFNode field fogCoord.
    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.
    boolean
    getNormalPerVertex()
    Provide boolean value from initializeOnly SFBool field named normalPerVertex.
    boolean
    getSolid()
    Provide boolean value from initializeOnly SFBool field named solid.
    X3DNode
    getTexCoord()
    Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DSingleTextureCoordinateNode|MultiTextureCoordinate, from inputOutput SFNode field texCoord.
    void
    setAttrib(X3DNode newValue)
    Set single child attrib node, replacing prior array of existing nodes (if any).
    QuadSet
    setAttrib(X3DNode[] newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field attrib.
    QuadSet
    setCcw(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named ccw.
    QuadSet
    setColor(X3DColorNode newValue)
    Accessor method to assign org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.
    QuadSet
    setColorPerVertex(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named colorPerVertex.
    QuadSet
    setCoord(X3DCoordinateNode newValue)
    Accessor method to assign org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.
    QuadSet
    setFogCoord(FogCoordinate newValue)
    Accessor method to assign org.web3d.x3d.sai.EnvironmentalEffects.FogCoordinate instance (using a properly typed node) to inputOutput SFNode field fogCoord.
    QuadSet
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    QuadSet
    setNormal(X3DNormalNode newValue)
    Accessor method to assign org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal.
    QuadSet
    setNormalPerVertex(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named normalPerVertex.
    QuadSet
    setSolid(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named solid.
    QuadSet
    setTexCoord(X3DNode newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field texCoord.

  • Method Details

    • getAttrib

      X3DNode[] getAttrib()
      Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field attrib.

      Tooltip: [X3DVertexAttributeNode] Single contained FloatVertexAttribute node that can specify 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:

    • setAttrib

      QuadSet setAttrib(X3DNode[] newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field attrib.

      Tooltip: [X3DVertexAttributeNode] Single contained FloatVertexAttribute node that can specify 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:
      QuadSet - 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 defines clockwise/counterclockwise ordering of vertex coordinates, which in turn defines front/back orientation of polygon normals according to Right-Hand Rule (RHR).
      • Hint: a good debugging technique for problematic polygons is to try changing the value of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector direction.
      • Warning: consistent and correct ordering of left-handed or right-handed point sequences is important throughout the coord array of point values.
      • Hint: clockwise https://en.wikipedia.org/wiki/Clockwise
      Specified by:
      getCcw in interface X3DComposedGeometryNode
      Returns:
      value of ccw field

    • setCcw

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

      Tooltip: ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in turn defines front/back orientation of polygon normals according to Right-Hand Rule (RHR).
      • Hint: a good debugging technique for problematic polygons is to try changing the value of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector direction.
      • Warning: consistent and correct ordering of left-handed or right-handed point sequences is important throughout the coord array of point values.
      • Hint: clockwise https://en.wikipedia.org/wiki/Clockwise
      Specified by:
      setCcw in interface X3DComposedGeometryNode
      Parameters:
      newValue - is new value for the ccw field.
      Returns:
      QuadSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getColor

      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.

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

    • setColor

      QuadSet setColor(X3DColorNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.

      Tooltip: [X3DColorNode] Single contained Color or ColorRGBA node that can specify 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:
      QuadSet - 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

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

    • getCoord

      X3DCoordinateNode getCoord()
      Provide org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.

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

    • setCoord

      QuadSet setCoord(X3DCoordinateNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.

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

    • getFogCoord

      FogCoordinate getFogCoord()
      Provide org.web3d.x3d.sai.EnvironmentalEffects.FogCoordinate instance (using a properly typed node) from inputOutput SFNode field fogCoord.

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

    • setFogCoord

      QuadSet setFogCoord(FogCoordinate newValue)
      Accessor method to assign org.web3d.x3d.sai.EnvironmentalEffects.FogCoordinate instance (using a properly typed node) to inputOutput SFNode field fogCoord.

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

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      getMetadata in interface X3DComposedGeometryNode
      Specified by:
      getMetadata in interface X3DGeometryNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      QuadSet setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      setMetadata in interface X3DComposedGeometryNode
      Specified by:
      setMetadata in interface X3DGeometryNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      QuadSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getNormal

      X3DNormalNode getNormal()
      Provide org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field normal.

      Tooltip: [X3DNormalNode] Single contained Normal node that can specify 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. Normal vectors are rapidly computed at run time by GPUs and thus are rarely needed in model files if no special effects are expected.
      Specified by:
      getNormal in interface X3DComposedGeometryNode
      Returns:
      value of normal field

    • setNormal

      QuadSet setNormal(X3DNormalNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal.

      Tooltip: [X3DNormalNode] Single contained Normal node that can specify 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. Normal vectors are rapidly computed at run time by GPUs and thus are rarely needed in model files if no special effects are expected.
      Specified by:
      setNormal in interface X3DComposedGeometryNode
      Parameters:
      newValue - is new value for the normal field.
      Returns:
      QuadSet - 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

      QuadSet 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:
      QuadSet - 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).
      • Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
      • Warning: default value true can completely hide geometry if viewed from wrong side!
      • Hint: if in doubt, use solid='false' for maximum visibility.
      • Hint: accessType relaxed to inputOutput in order to support animation and visualization.
      Specified by:
      getSolid in interface X3DComposedGeometryNode
      Returns:
      value of solid field

    • setSolid

      QuadSet 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).
      • Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
      • Warning: default value true can completely hide geometry if viewed from wrong side!
      • Hint: if in doubt, use solid='false' for maximum visibility.
      • Hint: accessType relaxed to inputOutput in order to support animation and visualization.
      Specified by:
      setSolid in interface X3DComposedGeometryNode
      Parameters:
      newValue - is new value for the solid field.
      Returns:
      QuadSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getTexCoord

      X3DNode getTexCoord()
      Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DSingleTextureCoordinateNode|MultiTextureCoordinate, from inputOutput SFNode field texCoord.

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

    • setTexCoord

      QuadSet setTexCoord(X3DNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field texCoord.

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