Class GeoElevationGrid

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Geospatial.GeoElevationGrid
All Implemented Interfaces:
X3DNode, GeoElevationGrid, X3DGeometryNode

public class GeoElevationGrid
extends X3DConcreteNode
implements GeoElevationGrid
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 org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:
X3D Abstract Specification: GeoElevationGrid, X3D Tooltips: GeoElevationGrid, X3D Scene Authoring Hints
  • Field Details

  • Constructor Details

    • GeoElevationGrid

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

      public GeoElevationGrid​(java.lang.String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node
  • Method Details

    • getElementName

      public final java.lang.String getElementName()
      Provides name of this element: GeoElevationGrid
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the GeoElevationGrid element: Geospatial
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element
    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 1
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element
    • getFieldType

      public java.lang.String getFieldType​(java.lang.String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
    • getAccessType

      public java.lang.String getAccessType​(java.lang.String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
    • getContainerFieldDefault

      public final java.lang.String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode
    • getCcw

      public 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 GeoElevationGrid
      Returns:
      value of ccw field
    • setCcw

      public GeoElevationGrid 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 GeoElevationGrid
      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).
    • setCcw

      public GeoElevationGrid setCcw​(SFBool newValue)
      Assign typed object value to SFBool ccw field, similar to setCcw(boolean).
      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

      public X3DColorNode getColor()
      Provide org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.
      Specified by:
      getColor in interface GeoElevationGrid
      Returns:
      value of color field
      See Also:
      Tooltip: [X3DColorNode] Single contained Color or ColorRGBA node that specifies color values applied to corresponding vertices according to colorPerVertex field. *
    • setColor

      public GeoElevationGrid setColor​(X3DColorNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.
      Specified by:
      setColor in interface GeoElevationGrid
      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).
      See Also:
      Tooltip: [X3DColorNode] Single contained Color or ColorRGBA node that specifies color values applied to corresponding vertices according to colorPerVertex field. *
    • clearColor

      public GeoElevationGrid clearColor()
      Utility method to clear SFNode value of color field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setColor

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

      public boolean hasColor()
      Indicate whether an object is available for inputOutput SFNode field color.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getColor(), getColorProtoInstance()
    • getColorPerVertex

      public 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).
      Specified by:
      getColorPerVertex in interface GeoElevationGrid
      Returns:
      value of colorPerVertex field
    • setColorPerVertex

      public 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).
      Specified by:
      setColorPerVertex in interface GeoElevationGrid
      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).
    • setColorPerVertex

      public GeoElevationGrid setColorPerVertex​(SFBool newValue)
      Assign typed object value to SFBool colorPerVertex field, similar to setColorPerVertex(boolean).
      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

      public 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
      Specified by:
      getCreaseAngle in interface GeoElevationGrid
      Returns:
      value of creaseAngle field
    • setCreaseAngle

      public 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
      Specified by:
      setCreaseAngle in interface GeoElevationGrid
      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).
    • setCreaseAngle

      public GeoElevationGrid setCreaseAngle​(SFDouble newValue)
      Assign typed object value to SFDouble creaseAngle field, similar to setCreaseAngle(double).
      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

      public 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. *
      Specified by:
      getGeoGridOrigin in interface GeoElevationGrid
      Returns:
      value of geoGridOrigin field
    • setGeoGridOrigin

      public 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. *
      Specified by:
      setGeoGridOrigin in interface GeoElevationGrid
      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).
    • setGeoGridOrigin

      public GeoElevationGrid setGeoGridOrigin​(SFVec3d newValue)
      Assign typed object value to SFVec3d geoGridOrigin field, similar to setGeoGridOrigin(double[]).
      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).
    • setGeoGridOrigin

      public GeoElevationGrid setGeoGridOrigin​(double x, double y, double z)
      Assign values to SFVec3d geoGridOrigin field, similar to setGeoGridOrigin(double[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getGeoOrigin

      public GeoOrigin getGeoOrigin()
      Provide org.web3d.x3d.sai.Geospatial.GeoOrigin instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.
      Specified by:
      getGeoOrigin in interface GeoElevationGrid
      Returns:
      value of geoOrigin field
      See Also:
      Tooltip: [GeoOrigin] Single contained GeoOrigin node that specifies a local coordinate frame for extended precision. Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#high-precisioncoords Warning: XML validation requires placement as first child node following contained metadata nodes (if any).
    • setGeoOrigin

      public GeoElevationGrid setGeoOrigin​(GeoOrigin newValue)
      Accessor method to assign org.web3d.x3d.sai.Geospatial.GeoOrigin instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.
      Specified by:
      setGeoOrigin in interface GeoElevationGrid
      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).
      See Also:
      Tooltip: [GeoOrigin] Single contained GeoOrigin node that specifies a local coordinate frame for extended precision. Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#high-precisioncoords Warning: XML validation requires placement as first child node following contained metadata nodes (if any).
    • clearGeoOrigin

      public GeoElevationGrid clearGeoOrigin()
      Utility method to clear SFNode value of geoOrigin field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setGeoOrigin

      public GeoElevationGrid setGeoOrigin​(ProtoInstance newValue)
      Assign ProtoInstance (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).
      See Also:
      setGeoOrigin( org.web3d.x3d.sai.Geospatial.GeoOrigin)
    • hasGeoOrigin

      public boolean hasGeoOrigin()
      Indicate whether an object is available for initializeOnly SFNode field geoOrigin.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getGeoOrigin(), getGeoOriginProtoInstance()
    • getGeoSystem

      public 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.
      Specified by:
      getGeoSystem in interface GeoElevationGrid
      Returns:
      value of geoSystem field
    • getGeoSystemList

      public java.util.ArrayList<java.lang.String> getGeoSystemList()
      Utility method to get ArrayList value of MFString geoSystem field, similar to getGeoSystem().
      Returns:
      value of geoSystem field
    • getGeoSystemString

      public java.lang.String getGeoSystemString()
      Utility method to get String value of MFString geoSystem field, similar to getGeoSystem().
      Returns:
      value of geoSystem field
    • setGeoSystem

      public 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.
      Specified by:
      setGeoSystem in interface GeoElevationGrid
      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).
    • setGeoSystem

      public GeoElevationGrid setGeoSystem​(MFString newValue)
      Assign typed object value to MFString geoSystem field, similar to setGeoSystem(String[]).
      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).
    • setGeoSystem

      public GeoElevationGrid setGeoSystem​(SFString newValue)
      Assign single SFString object value to MFString geoSystem field, similar to setGeoSystem(String[]).
      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).
    • setGeoSystem

      public GeoElevationGrid setGeoSystem​(java.lang.String newValue)
      Assign singleton String value to MFString geoSystem field, similar to setGeoSystem(String[]).
      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).
    • setGeoSystem

      public GeoElevationGrid setGeoSystem​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString geoSystem field, similar to setGeoSystem(String[]).
      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).
    • clearGeoSystem

      public GeoElevationGrid clearGeoSystem()
      Utility method to clear MFString value of geoSystem field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addGeoSystem

      public GeoElevationGrid addGeoSystem​(java.lang.String newValue)
      Add singleton String value to MFString geoSystem field.
      Parameters:
      newValue - is new value to add to the geoSystem field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFString.cleanupEnumerationValues(String)
    • addGeoSystem

      public GeoElevationGrid addGeoSystem​(SFString newValue)
      Add singleton SFString value to MFString geoSystem field.
      Parameters:
      newValue - is new value to add to the geoSystem field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFString.cleanupEnumerationValues(String)
    • getHeight

      public 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.
      Specified by:
      getHeight in interface GeoElevationGrid
      Returns:
      value of height field
    • getHeightList

      public java.util.ArrayList<java.lang.Double> getHeightList()
      Utility method to get ArrayList value of MFDouble height field, similar to getHeight().
      Returns:
      value of height field
    • getHeightString

      public java.lang.String getHeightString()
      Utility method to get String value of MFDouble height field, similar to getHeight().
      Returns:
      value of height field
    • setHeight

      public 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.
      Specified by:
      setHeight in interface GeoElevationGrid
      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).
    • setHeight

      public GeoElevationGrid setHeight​(MFDouble newValue)
      Assign typed object value to MFDouble height field, similar to setHeight(double[]).
      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).
    • setHeight

      public GeoElevationGrid setHeight​(java.util.ArrayList<java.lang.Double> newValue)
      Assign ArrayList value of MFDouble height field, similar to setHeight(double[]).
      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).
    • clearHeight

      public GeoElevationGrid clearHeight()
      Utility method to clear MFDouble value of height field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setHeight

      public GeoElevationGrid setHeight​(int[] newValue)
      Assign floating-point array value of MFDouble height field, similar to setHeight(double[]).
      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).
    • addHeight

      public GeoElevationGrid addHeight​(double newValue)
      Add singleton double value to MFDouble height field.
      Parameters:
      newValue - is new value to add to the height field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addHeight

      public GeoElevationGrid addHeight​(SFDouble newValue)
      Add singleton SFDouble value to MFDouble height field.
      Parameters:
      newValue - is new value to add to the height field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getIS

      public IS getIS()
      Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • setIS

      public GeoElevationGrid setIS​(IS newValue)
      Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • clearIS

      public GeoElevationGrid clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:
      getIS()
    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface GeoElevationGrid
      Specified by:
      getMetadata in interface X3DGeometryNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public GeoElevationGrid setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface GeoElevationGrid
      Specified by:
      setMetadata in interface X3DGeometryNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

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

      public GeoElevationGrid setMetadata​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata( org.web3d.x3d.sai.Core.X3DMetadataObject)
    • hasMetadata

      public boolean hasMetadata()
      Indicate whether an object is available for inputOutput SFNode field metadata.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • getNormal

      public X3DNormalNode getNormal()
      Provide org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field normal.
      Specified by:
      getNormal in interface GeoElevationGrid
      Returns:
      value of normal field
      See Also:
      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.
    • setNormal

      public GeoElevationGrid setNormal​(X3DNormalNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal.
      Specified by:
      setNormal in interface GeoElevationGrid
      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).
      See Also:
      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.
    • clearNormal

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

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

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

      public 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.
      Specified by:
      getNormalPerVertex in interface GeoElevationGrid
      Returns:
      value of normalPerVertex field
    • setNormalPerVertex

      public 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.
      Specified by:
      setNormalPerVertex in interface GeoElevationGrid
      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).
    • setNormalPerVertex

      public GeoElevationGrid setNormalPerVertex​(SFBool newValue)
      Assign typed object value to SFBool normalPerVertex field, similar to setNormalPerVertex(boolean).
      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

      public 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.
      Specified by:
      getSolid in interface GeoElevationGrid
      Returns:
      value of solid field
    • setSolid

      public 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).
      • 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.
      Specified by:
      setSolid in interface GeoElevationGrid
      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).
    • setSolid

      public GeoElevationGrid setSolid​(SFBool newValue)
      Assign typed object value to SFBool solid field, similar to setSolid(boolean).
      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

      public X3DTextureCoordinateNode getTexCoord()
      Provide org.web3d.x3d.sai.Texturing.X3DTextureCoordinateNode instance (using a properly typed node) from inputOutput SFNode field texCoord.
      Specified by:
      getTexCoord in interface GeoElevationGrid
      Returns:
      value of texCoord field
      See Also:
      Tooltip: [X3DTextureCoordinateNode] Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate node that specifies coordinates for texture mapping onto corresponding geometry. *
    • setTexCoord

      public GeoElevationGrid setTexCoord​(X3DTextureCoordinateNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTextureCoordinateNode instance (using a properly typed node) to inputOutput SFNode field texCoord.
      Specified by:
      setTexCoord in interface GeoElevationGrid
      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).
      See Also:
      Tooltip: [X3DTextureCoordinateNode] Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate node that specifies coordinates for texture mapping onto corresponding geometry. *
    • clearTexCoord

      public GeoElevationGrid clearTexCoord()
      Utility method to clear SFNode value of texCoord field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setTexCoord

      public GeoElevationGrid setTexCoord​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field texCoord.
      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).
      See Also:
      setTexCoord( org.web3d.x3d.sai.Texturing.X3DTextureCoordinateNode)
    • hasTexCoord

      public boolean hasTexCoord()
      Indicate whether an object is available for inputOutput SFNode field texCoord.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getTexCoord(), getTexCoordProtoInstance()
    • getXDimension

      public 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 &lt; 2 means that GeoElevationGrid contains no quadrilaterals.
      Specified by:
      getXDimension in interface GeoElevationGrid
      Returns:
      value of xDimension field
    • setXDimension

      public 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 &lt; 2 means that GeoElevationGrid contains no quadrilaterals.
      Specified by:
      setXDimension in interface GeoElevationGrid
      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).
    • setXDimension

      public GeoElevationGrid setXDimension​(SFInt32 newValue)
      Assign typed object value to SFInt32 xDimension field, similar to setXDimension(int).
      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

      public 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).
      Specified by:
      getXSpacing in interface GeoElevationGrid
      Returns:
      value of xSpacing field
    • setXSpacing

      public 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).
      Specified by:
      setXSpacing in interface GeoElevationGrid
      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).
    • setXSpacing

      public GeoElevationGrid setXSpacing​(SFDouble newValue)
      Assign typed object value to SFDouble xSpacing field, similar to setXSpacing(double).
      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

      public 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. *
      Specified by:
      getYScale in interface GeoElevationGrid
      Returns:
      value of yScale field
    • setYScale

      public 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. *
      Specified by:
      setYScale in interface GeoElevationGrid
      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).
    • setYScale

      public GeoElevationGrid setYScale​(SFFloat newValue)
      Assign typed object value to SFFloat yScale field, similar to setYScale(float).
      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).
    • setYScale

      public GeoElevationGrid setYScale​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setYScale(float).
      Parameters:
      newValue - is new value for field
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getZDimension

      public 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 &lt; 2 means that GeoElevationGrid contains no quadrilaterals.
      Specified by:
      getZDimension in interface GeoElevationGrid
      Returns:
      value of zDimension field
    • setZDimension

      public 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 &lt; 2 means that GeoElevationGrid contains no quadrilaterals.
      Specified by:
      setZDimension in interface GeoElevationGrid
      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).
    • setZDimension

      public GeoElevationGrid setZDimension​(SFInt32 newValue)
      Assign typed object value to SFInt32 zDimension field, similar to setZDimension(int).
      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

      public 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).
      Specified by:
      getZSpacing in interface GeoElevationGrid
      Returns:
      value of zSpacing field
    • setZSpacing

      public 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).
      Specified by:
      setZSpacing in interface GeoElevationGrid
      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).
    • setZSpacing

      public GeoElevationGrid setZSpacing​(SFDouble newValue)
      Assign typed object value to SFDouble zSpacing field, similar to setZSpacing(double).
      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).
    • getDEF

      public java.lang.String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

      public final GeoElevationGrid setDEF​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

      public GeoElevationGrid setDEF​(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getUSE

      public java.lang.String getUSE()
      Provide String value from inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setUSE

      public final GeoElevationGrid setUSE​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.


      Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

      Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Specified by:
      setUSE in class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public GeoElevationGrid setUSE​(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCssClass

      public java.lang.String getCssClass()
      Provide String value from inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final GeoElevationGrid setCssClass​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public GeoElevationGrid setCssClass​(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public GeoElevationGrid setUSE​(GeoElevationGrid DEFnode)
      Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

      Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Parameters:
      DEFnode - must have a DEF value defined
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

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

      public GeoElevationGrid addComments​(java.lang.String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public GeoElevationGrid addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      GeoElevationGrid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • toStringX3D

      public java.lang.String toStringX3D​(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
      X3D.FILE_EXTENSION_X3D, X3D.FILE_EXTENSION_XML, X3D.toStringXML(), X3D.toFileXML(String), X3D.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
    • toStringClassicVRML

      public java.lang.String toStringClassicVRML​(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
      X3D.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
    • toStringVRML97

      public java.lang.String toStringVRML97​(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
      X3D.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • hasElementByNameValue

      public boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:
      findElementByNameValue(String, String)
    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • hasNodeByDEF

      public boolean hasNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      whether node is found
      See Also:
      findNodeByDEF(String)
    • validate

      public java.lang.String validate()
      Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)