Class GeoElevationGridObject

  • All Implemented Interfaces:
    X3DNode, GeoElevationGrid, X3DGeometryNode

    public class GeoElevationGridObject
    extends X3DConcreteNode
    implements GeoElevationGrid
    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 Detail

      • NAME

        public static final java.lang.String NAME
        String constant NAME provides name of this element: GeoElevationGrid.
        See Also:
        Constant Field Values
      • COMPONENT

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the GeoElevationGrid element: Geospatial
        See Also:
        Constant Field Values
      • LEVEL

        public static final int LEVEL
        Integer constant LEVEL provides default X3D Geospatial component level for this element: 1
        See Also:
        Constant Field Values
      • CCW_DEFAULT_VALUE

        public static final boolean CCW_DEFAULT_VALUE
        SFBool field named ccw has default value true (Java syntax) or true (XML syntax).
        See Also:
        Constant Field Values
      • COLOR_DEFAULT_VALUE

        public static final X3DColorNode COLOR_DEFAULT_VALUE
        SFNode field named color has default value null (Java syntax) or NULL (XML syntax).
      • COLORPERVERTEX_DEFAULT_VALUE

        public static final boolean COLORPERVERTEX_DEFAULT_VALUE
        SFBool field named colorPerVertex has default value true (Java syntax) or true (XML syntax).
        See Also:
        Constant Field Values
      • CREASEANGLE_DEFAULT_VALUE

        public static final double CREASEANGLE_DEFAULT_VALUE
        SFDouble field named creaseAngle has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • GEOGRIDORIGIN_DEFAULT_VALUE

        public static final double[] GEOGRIDORIGIN_DEFAULT_VALUE
        SFVec3d field named geoGridOrigin has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax).
      • GEOORIGIN_DEFAULT_VALUE

        public static final GeoOriginObject GEOORIGIN_DEFAULT_VALUE
        SFNode field named geoOrigin has default value null (Java syntax) or NULL (XML syntax).
      • GEOSYSTEM_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.String> GEOSYSTEM_DEFAULT_VALUE
        MFString field named geoSystem has default quoted value new String[] {"GD","WE"} (Java syntax) or quoted value "GD" "WE" (XML syntax).
      • HEIGHT_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.Double> HEIGHT_DEFAULT_VALUE
        MFDouble field named height has default value {0.0,0.0,0.0,0.0} (Java syntax) or 0 0 0 0 (XML syntax).
      • IS_DEFAULT_VALUE

        public static final ISObject IS_DEFAULT_VALUE
        SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
      • METADATA_DEFAULT_VALUE

        public static final X3DMetadataObject METADATA_DEFAULT_VALUE
        SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
      • NORMAL_DEFAULT_VALUE

        public static final X3DNormalNode NORMAL_DEFAULT_VALUE
        SFNode field named normal has default value null (Java syntax) or NULL (XML syntax).
      • NORMALPERVERTEX_DEFAULT_VALUE

        public static final boolean NORMALPERVERTEX_DEFAULT_VALUE
        SFBool field named normalPerVertex has default value true (Java syntax) or true (XML syntax).
        See Also:
        Constant Field Values
      • SOLID_DEFAULT_VALUE

        public static final boolean SOLID_DEFAULT_VALUE
        SFBool field named solid has default value true (Java syntax) or true (XML syntax).
        See Also:
        Constant Field Values
      • TEXCOORD_DEFAULT_VALUE

        public static final X3DTextureCoordinateNode TEXCOORD_DEFAULT_VALUE
        SFNode field named texCoord has default value null (Java syntax) or NULL (XML syntax).
      • XDIMENSION_DEFAULT_VALUE

        public static final int XDIMENSION_DEFAULT_VALUE
        SFInt32 field named xDimension has default value 2 (Java syntax) or 2 (XML syntax).
        See Also:
        Constant Field Values
      • XSPACING_DEFAULT_VALUE

        public static final double XSPACING_DEFAULT_VALUE
        SFDouble field named xSpacing has default value 1.0 (Java syntax) or 1.0 (XML syntax).
        See Also:
        Constant Field Values
      • YSCALE_DEFAULT_VALUE

        public static final float YSCALE_DEFAULT_VALUE
        SFFloat field named yScale has default value 1f (Java syntax) or 1 (XML syntax).
        See Also:
        Constant Field Values
      • ZDIMENSION_DEFAULT_VALUE

        public static final int ZDIMENSION_DEFAULT_VALUE
        SFInt32 field named zDimension has default value 2 (Java syntax) or 2 (XML syntax).
        See Also:
        Constant Field Values
      • ZSPACING_DEFAULT_VALUE

        public static final double ZSPACING_DEFAULT_VALUE
        SFDouble field named zSpacing has default value 1.0 (Java syntax) or 1.0 (XML syntax).
        See Also:
        Constant Field Values
      • fromField_COLOR

        public static final java.lang.String fromField_COLOR
        fromField ROUTE name for SFNode field named color.
        See Also:
        Constant Field Values
      • toField_COLOR

        public static final java.lang.String toField_COLOR
        toField ROUTE name for SFNode field named color.
        See Also:
        Constant Field Values
      • fromField_IS

        public static final java.lang.String fromField_IS
        fromField ROUTE name for SFNode field named IS.
        See Also:
        Constant Field Values
      • fromField_METADATA

        public static final java.lang.String fromField_METADATA
        fromField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • toField_METADATA

        public static final java.lang.String toField_METADATA
        toField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • fromField_NORMAL

        public static final java.lang.String fromField_NORMAL
        fromField ROUTE name for SFNode field named normal.
        See Also:
        Constant Field Values
      • toField_NORMAL

        public static final java.lang.String toField_NORMAL
        toField ROUTE name for SFNode field named normal.
        See Also:
        Constant Field Values
      • toField_SET_HEIGHT

        public static final java.lang.String toField_SET_HEIGHT
        toField ROUTE name for MFFloat field named set_height.
        See Also:
        Constant Field Values
      • fromField_TEXCOORD

        public static final java.lang.String fromField_TEXCOORD
        fromField ROUTE name for SFNode field named texCoord.
        See Also:
        Constant Field Values
      • toField_TEXCOORD

        public static final java.lang.String toField_TEXCOORD
        toField ROUTE name for SFNode field named texCoord.
        See Also:
        Constant Field Values
      • fromField_YSCALE

        public static final java.lang.String fromField_YSCALE
        fromField ROUTE name for SFFloat field named yScale.
        See Also:
        Constant Field Values
      • toField_YSCALE

        public static final java.lang.String toField_YSCALE
        toField ROUTE name for SFFloat field named yScale.
        See Also:
        Constant Field Values
    • Constructor Detail

      • GeoElevationGridObject

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

        public GeoElevationGridObject​(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 Detail

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

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

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

        public GeoElevationGridObject setCcw​(SFBoolObject newValue)
        Assign typed object value to SFBool ccw field, similar to setCcw(boolean).
        Parameters:
        newValue - is new value for the ccw field.
        Returns:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getColor

        public X3DColorNode getColor()
        Provide 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. *
      • clearColor

        public GeoElevationGridObject clearColor()
        Utility method to clear SFNode value of color field.
        Returns:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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()
      • setColorPerVertex

        public GeoElevationGridObject setColorPerVertex​(SFBoolObject newValue)
        Assign typed object value to SFBool colorPerVertex field, similar to setColorPerVertex(boolean).
        Parameters:
        newValue - is new value for the colorPerVertex field.
        Returns:
        GeoElevationGridObject - 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 GeoElevationGridObject 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:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setCreaseAngle

        public GeoElevationGridObject setCreaseAngle​(SFDoubleObject newValue)
        Assign typed object value to SFDouble creaseAngle field, similar to setCreaseAngle(double).
        Parameters:
        newValue - is new value for the creaseAngle field.
        Returns:
        GeoElevationGridObject - 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 GeoElevationGridObject 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:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setGeoGridOrigin

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

        public GeoOrigin getGeoOrigin()
        Provide GeoOriginObject 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:
        getGeoOriginProtoInstance()
      • clearGeoOrigin

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

        public GeoElevationGridObject setGeoOrigin​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field geoOrigin.
        Parameters:
        newValue - is new value for the geoOrigin field.
        Returns:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setGeoOrigin(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()
      • 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
      • setGeoSystem

        public GeoElevationGridObject setGeoSystem​(SFStringObject newValue)
        Assign single SFString object value to MFString geoSystem field, similar to setGeoSystem(String[]).
        Parameters:
        newValue - is new value for the geoSystem field.
        Returns:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setGeoSystem

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

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

        public GeoElevationGridObject clearGeoSystem()
        Utility method to clear MFString value of geoSystem field.
        Returns:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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
      • setHeight

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

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

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

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

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

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

        public GeoElevationGridObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        GeoElevationGridObject - 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()
      • clearMetadata

        public GeoElevationGridObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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 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.
      • clearNormal

        public GeoElevationGridObject clearNormal()
        Utility method to clear SFNode value of normal field.
        Returns:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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 GeoElevationGridObject 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:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setNormalPerVertex

        public GeoElevationGridObject setNormalPerVertex​(SFBoolObject newValue)
        Assign typed object value to SFBool normalPerVertex field, similar to setNormalPerVertex(boolean).
        Parameters:
        newValue - is new value for the normalPerVertex field.
        Returns:
        GeoElevationGridObject - 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).
        • 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 GeoElevationGridObject setSolid​(boolean newValue)
        Accessor method to assign boolean value to initializeOnly SFBool field named solid.

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

        public GeoElevationGridObject setSolid​(SFBoolObject newValue)
        Assign typed object value to SFBool solid field, similar to setSolid(boolean).
        Parameters:
        newValue - is new value for the solid field.
        Returns:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getTexCoord

        public X3DTextureCoordinateNode getTexCoord()
        Provide 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. *
      • clearTexCoord

        public GeoElevationGridObject clearTexCoord()
        Utility method to clear SFNode value of texCoord field.
        Returns:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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 GeoElevationGridObject 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:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setXDimension

        public GeoElevationGridObject setXDimension​(SFInt32Object newValue)
        Assign typed object value to SFInt32 xDimension field, similar to setXDimension(int).
        Parameters:
        newValue - is new value for the xDimension field.
        Returns:
        GeoElevationGridObject - 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 GeoElevationGridObject 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:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setXSpacing

        public GeoElevationGridObject setXSpacing​(SFDoubleObject newValue)
        Assign typed object value to SFDouble xSpacing field, similar to setXSpacing(double).
        Parameters:
        newValue - is new value for the xSpacing field.
        Returns:
        GeoElevationGridObject - 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 GeoElevationGridObject 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:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setYScale

        public GeoElevationGridObject setYScale​(SFFloatObject newValue)
        Assign typed object value to SFFloat yScale field, similar to setYScale(float).
        Parameters:
        newValue - is new value for the yScale field.
        Returns:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setYScale

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

        public GeoElevationGridObject setZDimension​(SFInt32Object newValue)
        Assign typed object value to SFInt32 zDimension field, similar to setZDimension(int).
        Parameters:
        newValue - is new value for the zDimension field.
        Returns:
        GeoElevationGridObject - 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 GeoElevationGridObject 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:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setZSpacing

        public GeoElevationGridObject setZSpacing​(SFDoubleObject newValue)
        Assign typed object value to SFDouble zSpacing field, similar to setZSpacing(double).
        Parameters:
        newValue - is new value for the zSpacing field.
        Returns:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDEF

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

        public GeoElevationGridObject setDEF​(SFStringObject newValue)
        Assign typed object value to SFString DEF field, similar to setDEF(String).
        Parameters:
        newValue - is new value for the DEF field.
        Returns:
        GeoElevationGridObject - 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 GeoElevationGridObject 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:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setUSE

        public GeoElevationGridObject setUSE​(SFStringObject newValue)
        Assign typed object value to SFString USE field, similar to setUSE(String).
        Parameters:
        newValue - is new value for the USE field.
        Returns:
        GeoElevationGridObject - 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 GeoElevationGridObject 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:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        W3C Cascading Style Sheets
      • setUSE

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

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

        public GeoElevationGridObject 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:
        GeoElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
      • 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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
      • 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)
      • 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)