Interface ElevationGrid

All Superinterfaces:
X3DGeometryNode, X3DNode
All Known Implementing Classes:
ElevationGridObject

public interface ElevationGrid
extends X3DGeometryNode
ElevationGrid is a geometry node defining a rectangular height field, with default values for a 1m by 1m square at height 0.

X3D node tooltip: [X3DGeometryNode] ElevationGrid is a geometry node defining a rectangular height field, with default values for a 1m by 1m square at height 0. Vertices corresponding to ElevationGrid height values define quadrilaterals, which are placed above or below a flat surface.
  • Hint: the height array defines (xDimension-1)*(zDimension-1) quadrilaterals.
  • Warning: generated quadrilaterals can be nonplanar. Tessellation splits quadrilaterals into triangles along seam starting at initial vertex of the quadrilateral and proceeding to opposite vertex.
  • Hint: positive direction for normal of each triangle is on same side of the quadrilateral. Triangles are defined either counterclockwise or clockwise depending on value of ccw field.
  • Hint: ElevationGrid can contain Color|ColorRGBA, Normal and TextureCoordinate nodes.
  • 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.

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: ElevationGrid, X3D Tooltips: ElevationGrid, X3D Scene Authoring Hints
  • Method Summary

    Modifier and Type Method Description
    void addAttrib​(X3DNode[] newValue)
    Add array of child attrib nodes to array of existing nodes (if any).
    X3DNode[] getAttrib()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field attrib.
    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.
    float getCreaseAngle()
    Provide float value unit axis, angle (in radians) within allowed range of [0,infinity) from initializeOnly SFFloat field named creaseAngle.
    FogCoordinate getFogCoord()
    Provide FogCoordinate instance (using a properly typed node) from inputOutput SFNode field fogCoord.
    float[] getHeight()
    Provide array of float results from initializeOnly MFFloat field named height.
    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.
    int getXDimension()
    Provide int value within allowed range of [0,infinity) from initializeOnly SFInt32 field named xDimension.
    float getXSpacing()
    Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named xSpacing.
    int getZDimension()
    Provide int value within allowed range of [0,infinity) from initializeOnly SFInt32 field named zDimension.
    float getZSpacing()
    Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named zSpacing.
    void setAttrib​(X3DNode newValue)
    Set single child attrib node, replacing prior array of existing nodes (if any).
    ElevationGrid setAttrib​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field attrib.
    ElevationGrid setCcw​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named ccw.
    ElevationGrid setColor​(X3DColorNode newValue)
    Accessor method to assign X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.
    ElevationGrid setColorPerVertex​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named colorPerVertex.
    ElevationGrid setCreaseAngle​(float newValue)
    Accessor method to assign float value unit axis, angle (in radians) to initializeOnly SFFloat field named creaseAngle.
    ElevationGrid setFogCoord​(FogCoordinate newValue)
    Accessor method to assign FogCoordinate instance (using a properly typed node) to inputOutput SFNode field fogCoord.
    ElevationGrid setHeight​(float[] newValue)
    Accessor method to assign float array to initializeOnly MFFloat field named height.
    ElevationGrid setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    ElevationGrid setNormal​(X3DNormalNode newValue)
    Accessor method to assign X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal.
    ElevationGrid setNormalPerVertex​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named normalPerVertex.
    ElevationGrid setSolid​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named solid.
    ElevationGrid setTexCoord​(X3DTextureCoordinateNode newValue)
    Accessor method to assign X3DTextureCoordinateNode instance (using a properly typed node) to inputOutput SFNode field texCoord.
    ElevationGrid setXDimension​(int newValue)
    Accessor method to assign int value to initializeOnly SFInt32 field named xDimension.
    ElevationGrid setXSpacing​(float newValue)
    Accessor method to assign float value to initializeOnly SFFloat field named xSpacing.
    ElevationGrid setZDimension​(int newValue)
    Accessor method to assign int value to initializeOnly SFInt32 field named zDimension.
    ElevationGrid setZSpacing​(float newValue)
    Accessor method to assign float value to initializeOnly SFFloat field named zSpacing.
  • Method Details

    • getAttrib

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

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

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

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

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

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

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

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

      void setAttrib​(X3DNode newValue)
      Set single child attrib node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the attrib field
    • 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.
      Returns:
      value of ccw field
    • setCcw

      ElevationGrid 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.
      Parameters:
      newValue - is new value for the ccw field.
      Returns:
      ElevationGrid - 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 colorPerVertex field. *
      Returns:
      value of color field
    • setColor

      ElevationGrid 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 colorPerVertex field. *
      Parameters:
      newValue - is new value for the color field.
      Returns:
      ElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getColorPerVertex

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

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

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

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

      float getCreaseAngle()
      Provide float value unit axis, angle (in radians) within allowed range of [0,infinity) from initializeOnly SFFloat field named creaseAngle.

      Tooltip: [0,+infinity) creaseAngle defines angle (in radians) for determining whether adjacent polygons are drawn with sharp edges or smooth shading. If angle between normals of two adjacent polygons is less than creaseAngle, smooth shading is rendered across the shared line segment.
      Returns:
      value of creaseAngle field
    • setCreaseAngle

      ElevationGrid setCreaseAngle​(float newValue)
      Accessor method to assign float value unit axis, angle (in radians) to initializeOnly SFFloat field named creaseAngle.

      Tooltip: [0,+infinity) creaseAngle defines angle (in radians) for determining whether adjacent polygons are drawn with sharp edges or smooth shading. If angle between normals of two adjacent polygons is less than creaseAngle, smooth shading is rendered across the shared line segment.
      Parameters:
      newValue - is new value for the creaseAngle field.
      Returns:
      ElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getFogCoord

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

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

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

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

      float[] getHeight()
      Provide array of float results from initializeOnly MFFloat field named height.

      Tooltip: Grid array of height vertices with upward direction along +Y axis, with xDimension rows and zDimension columns.
      • Hint: height array values are given in row-major order from left to right along X axis, then back to front along Z axis.
      • Warning: height array values are not retained or available at run time since a browser is permitted to condense geometry.
      Returns:
      value of height field
    • setHeight

      ElevationGrid setHeight​(float[] newValue)
      Accessor method to assign float array to initializeOnly MFFloat field named height.

      Tooltip: Grid array of height vertices with upward direction along +Y axis, with xDimension rows and zDimension columns.
      • Hint: height array values are given in row-major order from left to right along X axis, then back to front along Z axis.
      • Warning: height array values are not retained or available at run time since a browser is permitted to condense geometry.
      Parameters:
      newValue - is new value for the height field.
      Returns:
      ElevationGrid - 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 X3DGeometryNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      ElevationGrid setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface X3DGeometryNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ElevationGrid - 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.
      Returns:
      value of normal field
    • setNormal

      ElevationGrid 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.
      Parameters:
      newValue - is new value for the normal field.
      Returns:
      ElevationGrid - 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 per quadrilateral (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.
      Returns:
      value of normalPerVertex field
    • setNormalPerVertex

      ElevationGrid 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 per quadrilateral (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.
      Parameters:
      newValue - is new value for the normalPerVertex field.
      Returns:
      ElevationGrid - 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.
      Returns:
      value of solid field
    • setSolid

      ElevationGrid 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.
      Parameters:
      newValue - is new value for the solid field.
      Returns:
      ElevationGrid - 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. *
      Returns:
      value of texCoord field
    • setTexCoord

      ElevationGrid 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. *
      Parameters:
      newValue - is new value for the texCoord field.
      Returns:
      ElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getXDimension

      int getXDimension()
      Provide int value within allowed range of [0,infinity) from initializeOnly SFInt32 field named xDimension.

      Tooltip: (0,+infinity) Number of elements in the height array along X direction.
      • Hint: total horizontal x-axis distance equals (xDimension-1) * xSpacing.
      • Warning: xDimension < 2 means that ElevationGrid contains no quadrilaterals.
      Returns:
      value of xDimension field
    • setXDimension

      ElevationGrid setXDimension​(int newValue)
      Accessor method to assign int value to initializeOnly SFInt32 field named xDimension.

      Tooltip: (0,+infinity) Number of elements in the height array along X direction.
      • Hint: total horizontal x-axis distance equals (xDimension-1) * xSpacing.
      • Warning: xDimension < 2 means that ElevationGrid contains no quadrilaterals.
      Parameters:
      newValue - is new value for the xDimension field.
      Returns:
      ElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getXSpacing

      float getXSpacing()
      Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named xSpacing.

      Tooltip: (0,+infinity) Meters distance between grid-array vertices along X direction.
      • Hint: total horizontal x-axis distance equals (xDimension-1) * xSpacing.
      Returns:
      value of xSpacing field
    • setXSpacing

      ElevationGrid setXSpacing​(float newValue)
      Accessor method to assign float value to initializeOnly SFFloat field named xSpacing.

      Tooltip: (0,+infinity) Meters distance between grid-array vertices along X direction.
      • Hint: total horizontal x-axis distance equals (xDimension-1) * xSpacing.
      Parameters:
      newValue - is new value for the xSpacing field.
      Returns:
      ElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getZDimension

      int getZDimension()
      Provide int value within allowed range of [0,infinity) from initializeOnly SFInt32 field named zDimension.

      Tooltip: (0,+infinity) Number of elements in the height array along Z direction.
      • Hint: total horizontal z-axis distance equals (zDimension-1) * zSpacing.
      • Warning: zDimension < 2 means that ElevationGrid contains no quadrilaterals.
      Returns:
      value of zDimension field
    • setZDimension

      ElevationGrid setZDimension​(int newValue)
      Accessor method to assign int value to initializeOnly SFInt32 field named zDimension.

      Tooltip: (0,+infinity) Number of elements in the height array along Z direction.
      • Hint: total horizontal z-axis distance equals (zDimension-1) * zSpacing.
      • Warning: zDimension < 2 means that ElevationGrid contains no quadrilaterals.
      Parameters:
      newValue - is new value for the zDimension field.
      Returns:
      ElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getZSpacing

      float getZSpacing()
      Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named zSpacing.

      Tooltip: (0,+infinity) Meters distance between grid-array vertices along Z direction.
      • Hint: total lateral z-axis distance equals (zDimension-1) * zSpacing.
      Returns:
      value of zSpacing field
    • setZSpacing

      ElevationGrid setZSpacing​(float newValue)
      Accessor method to assign float value to initializeOnly SFFloat field named zSpacing.

      Tooltip: (0,+infinity) Meters distance between grid-array vertices along Z direction.
      • Hint: total lateral z-axis distance equals (zDimension-1) * zSpacing.
      Parameters:
      newValue - is new value for the zSpacing field.
      Returns:
      ElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).