Interface GeoElevationGrid

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

public interface GeoElevationGrid
extends X3DGeometryNode
GeoElevationGrid 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] GeoElevationGrid is a geometry node defining a rectangular height field, with default values for a 1m by 1m square at height 0. Vertices corresponding to GeoElevationGrid height values define quadrilaterals, which are placed above or below a curved geospatial surface using geographic coordinates.
  • 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: GeoElevationGrid can contain GeoOrigin, Color|ColorRGBA, Normal and TextureCoordinate nodes.
  • Hint: insert a Shape node before adding geometry or Appearance.
  • Hint: X3D for Advanced Modeling (X3D4AM) slideset http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
  • Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>
  • Warning: avoid having GeoLocation or GeoTransform as a parent or ancestor node of GeoElevationGrid, since multiple geospatial transformations then occur with unpredictable results.

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

    Modifier and Type Method Description
    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.
    double getCreaseAngle()
    Provide double value unit axis, angle (in radians) within allowed range of [0,infinity) from initializeOnly SFDouble field named creaseAngle.
    double[] getGeoGridOrigin()
    Provide array of 3-tuple double results from initializeOnly SFVec3d field named geoGridOrigin.
    GeoOrigin getGeoOrigin()
    Provide GeoOrigin instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.
    java.lang.String[] getGeoSystem()
    Provide array of String results from initializeOnly MFString field named geoSystem.
    double[] getHeight()
    Provide array of double results from initializeOnly MFDouble 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.
    double getXSpacing()
    Provide double value within allowed range of (0,infinity) from initializeOnly SFDouble field named xSpacing.
    float getYScale()
    Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named yScale.
    int getZDimension()
    Provide int value within allowed range of [0,infinity) from initializeOnly SFInt32 field named zDimension.
    double getZSpacing()
    Provide double value within allowed range of (0,infinity) from initializeOnly SFDouble field named zSpacing.
    GeoElevationGrid setCcw​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named ccw.
    GeoElevationGrid setColor​(X3DColorNode newValue)
    Accessor method to assign X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.
    GeoElevationGrid setColorPerVertex​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named colorPerVertex.
    GeoElevationGrid setCreaseAngle​(double newValue)
    Accessor method to assign double value unit axis, angle (in radians) to initializeOnly SFDouble field named creaseAngle.
    GeoElevationGrid setGeoGridOrigin​(double[] newValue)
    Accessor method to assign 3-tuple double array to initializeOnly SFVec3d field named geoGridOrigin.
    GeoElevationGrid setGeoOrigin​(GeoOrigin newValue)
    Accessor method to assign GeoOrigin instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.
    GeoElevationGrid setGeoSystem​(java.lang.String[] newValue)
    Accessor method to assign String array to initializeOnly MFString field named geoSystem.
    GeoElevationGrid setHeight​(double[] newValue)
    Accessor method to assign double array to initializeOnly MFDouble field named height.
    GeoElevationGrid setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    GeoElevationGrid setNormal​(X3DNormalNode newValue)
    Accessor method to assign X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal.
    GeoElevationGrid setNormalPerVertex​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named normalPerVertex.
    GeoElevationGrid setSolid​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named solid.
    GeoElevationGrid setTexCoord​(X3DTextureCoordinateNode newValue)
    Accessor method to assign X3DTextureCoordinateNode instance (using a properly typed node) to inputOutput SFNode field texCoord.
    GeoElevationGrid setXDimension​(int newValue)
    Accessor method to assign int value to initializeOnly SFInt32 field named xDimension.
    GeoElevationGrid setXSpacing​(double newValue)
    Accessor method to assign double value to initializeOnly SFDouble field named xSpacing.
    GeoElevationGrid setYScale​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named yScale.
    GeoElevationGrid setZDimension​(int newValue)
    Accessor method to assign int value to initializeOnly SFInt32 field named zDimension.
    GeoElevationGrid setZSpacing​(double newValue)
    Accessor method to assign double value to initializeOnly SFDouble field named zSpacing.
  • Method Details

    • 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

      GeoElevationGrid 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:
      GeoElevationGrid - 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

      GeoElevationGrid 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:
      GeoElevationGrid - 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

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

      double getCreaseAngle()
      Provide double value unit axis, angle (in radians) within allowed range of [0,infinity) from initializeOnly SFDouble 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.
      • Hint: creaseAngle=0 means render all edges sharply, creaseAngle=3.14159 means render all edges smoothly.
      • Warning: note type double, unlike ElevationGrid creaseAngle.
      • Hint: https://en.wikipedia.org/wiki/Radian
      Returns:
      value of creaseAngle field
    • setCreaseAngle

      GeoElevationGrid setCreaseAngle​(double newValue)
      Accessor method to assign double value unit axis, angle (in radians) to initializeOnly SFDouble 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.
      • Hint: creaseAngle=0 means render all edges sharply, creaseAngle=3.14159 means render all edges smoothly.
      • Warning: note type double, unlike ElevationGrid creaseAngle.
      • Hint: https://en.wikipedia.org/wiki/Radian
      Parameters:
      newValue - is new value for the creaseAngle field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getGeoGridOrigin

      double[] getGeoGridOrigin()
      Provide array of 3-tuple double results from initializeOnly SFVec3d field named geoGridOrigin.

      Tooltip: Geographic coordinate for southwest (lower-left) corner of height dataset. *
      Returns:
      value of geoGridOrigin field
    • setGeoGridOrigin

      GeoElevationGrid setGeoGridOrigin​(double[] newValue)
      Accessor method to assign 3-tuple double array to initializeOnly SFVec3d field named geoGridOrigin.

      Tooltip: Geographic coordinate for southwest (lower-left) corner of height dataset. *
      Parameters:
      newValue - is new value for the geoGridOrigin field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getGeoOrigin

      GeoOrigin getGeoOrigin()
      Provide GeoOrigin instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.
      Returns:
      value of geoOrigin field
    • setGeoOrigin

      GeoElevationGrid setGeoOrigin​(GeoOrigin newValue)
      Accessor method to assign GeoOrigin instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.
      Parameters:
      newValue - is new value for the geoOrigin field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getGeoSystem

      java.lang.String[] getGeoSystem()
      Provide array of String results from initializeOnly MFString field named geoSystem.

      Tooltip: Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted string parameters as appropriate for the type.
      Returns:
      value of geoSystem field
    • setGeoSystem

      GeoElevationGrid setGeoSystem​(java.lang.String[] newValue)
      Accessor method to assign String array to initializeOnly MFString field named geoSystem.

      Tooltip: Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted string parameters as appropriate for the type.
      Parameters:
      newValue - is new value for the geoSystem field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getHeight

      double[] getHeight()
      Provide array of double results from initializeOnly MFDouble field named height.

      Tooltip: Contains xDimension rows * zDimension columns floating-point values for elevation above ellipsoid.
      • Hint: height array values are in row-major order from west to east, south to north.
      • Hint: geoGridOrigin is in southwest (lower-left) corner of height dataset.
      • 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

      GeoElevationGrid setHeight​(double[] newValue)
      Accessor method to assign double array to initializeOnly MFDouble field named height.

      Tooltip: Contains xDimension rows * zDimension columns floating-point values for elevation above ellipsoid.
      • Hint: height array values are in row-major order from west to east, south to north.
      • Hint: geoGridOrigin is in southwest (lower-left) corner of height dataset.
      • 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:
      GeoElevationGrid - 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

      GeoElevationGrid 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:
      GeoElevationGrid - 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

      GeoElevationGrid 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:
      GeoElevationGrid - 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

      GeoElevationGrid 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:
      GeoElevationGrid - 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

      GeoElevationGrid 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:
      GeoElevationGrid - 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

      GeoElevationGrid 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:
      GeoElevationGrid - 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 east-west X direction.
      • Hint: total horizontal x-axis distance equals (xDimension-1) * xSpacing.
      • Warning: xDimension < 2 means that GeoElevationGrid contains no quadrilaterals.
      Returns:
      value of xDimension field
    • setXDimension

      GeoElevationGrid 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 east-west X direction.
      • Hint: total horizontal x-axis distance equals (xDimension-1) * xSpacing.
      • Warning: xDimension < 2 means that GeoElevationGrid contains no quadrilaterals.
      Parameters:
      newValue - is new value for the xDimension field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getXSpacing

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

      Tooltip: (0,+infinity) Distance between grid-array vertices along east-west X direction.
      • Hint: when geoSystem is GDC, xSpacing is number of degrees of longitude.
      • Hint: when geoSystem is UTM, xSpacing is number of eastings (meters).
      Returns:
      value of xSpacing field
    • setXSpacing

      GeoElevationGrid setXSpacing​(double newValue)
      Accessor method to assign double value to initializeOnly SFDouble field named xSpacing.

      Tooltip: (0,+infinity) Distance between grid-array vertices along east-west X direction.
      • Hint: when geoSystem is GDC, xSpacing is number of degrees of longitude.
      • Hint: when geoSystem is UTM, xSpacing is number of eastings (meters).
      Parameters:
      newValue - is new value for the xSpacing field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getYScale

      float getYScale()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named yScale.

      Tooltip: [0,+infinity) Vertical exaggeration of displayed data produced from the height array. *
      Returns:
      value of yScale field
    • setYScale

      GeoElevationGrid setYScale​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named yScale.

      Tooltip: [0,+infinity) Vertical exaggeration of displayed data produced from the height array. *
      Parameters:
      newValue - is new value for the yScale field.
      Returns:
      GeoElevationGrid - 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 north-south Z direction.
      • Hint: total lateral z-axis distance equals (zDimension-1) * zSpacing.
      • Warning: zDimension < 2 means that GeoElevationGrid contains no quadrilaterals.
      Returns:
      value of zDimension field
    • setZDimension

      GeoElevationGrid 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 north-south Z direction.
      • Hint: total lateral z-axis distance equals (zDimension-1) * zSpacing.
      • Warning: zDimension < 2 means that GeoElevationGrid contains no quadrilaterals.
      Parameters:
      newValue - is new value for the zDimension field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getZSpacing

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

      Tooltip: (0,+infinity) Distance between grid-array vertices along north-south Z direction.
      • Hint: when geoSystem is GDC, zSpacing is number of degrees of latitude.
      • Hint: when geoSystem is UTM, zSpacing is number of northings (meters).
      Returns:
      value of zSpacing field
    • setZSpacing

      GeoElevationGrid setZSpacing​(double newValue)
      Accessor method to assign double value to initializeOnly SFDouble field named zSpacing.

      Tooltip: (0,+infinity) Distance between grid-array vertices along north-south Z direction.
      • Hint: when geoSystem is GDC, zSpacing is number of degrees of latitude.
      • Hint: when geoSystem is UTM, zSpacing is number of northings (meters).
      Parameters:
      newValue - is new value for the zSpacing field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).