Class ElevationGridObject

  • All Implemented Interfaces:
    X3DNode, ElevationGrid, X3DGeometryNode

    public class ElevationGridObject
    extends X3DConcreteNode
    implements ElevationGrid
    X3D node tooltip: [X3DGeometryNode] ElevationGrid is a geometry node defining a rectangular height field, with default values for a 1m by 1m square at height 0. Vertices corresponding to ElevationGrid height values define quadrilaterals, which are placed above or below a flat surface.
    • Hint: the height array defines (xDimension-1)*(zDimension-1) quadrilaterals.
    • Warning: generated quadrilaterals can be nonplanar. Tessellation splits quadrilaterals into triangles along seam starting at initial vertex of the quadrilateral and proceeding to opposite vertex.
    • Hint: positive direction for normal of each triangle is on same side of the quadrilateral. Triangles are defined either counterclockwise or clockwise depending on value of ccw field.
    • Hint: ElevationGrid can contain Color|ColorRGBA, Normal and TextureCoordinate nodes.
    • Hint: insert a Shape node before adding geometry or Appearance.
    • Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance node (with correct containerField value) for contained node content.

    Package hint: This 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: ElevationGrid, X3D Tooltips: ElevationGrid, X3D Scene Authoring Hints
    • Field Detail

      • NAME

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

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

        public static final int LEVEL
        Integer constant LEVEL provides default X3D Geometry3D component level for this element: 3
        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 float CREASEANGLE_DEFAULT_VALUE
        SFFloat field named creaseAngle has default value 0f (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • FOGCOORD_DEFAULT_VALUE

        public static final FogCoordinateObject FOGCOORD_DEFAULT_VALUE
        SFNode field named fogCoord has default value null (Java syntax) or NULL (XML syntax).
      • HEIGHT_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.Float> HEIGHT_DEFAULT_VALUE
        MFFloat field named height has default value {0f,0f,0f,0f} (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 float XSPACING_DEFAULT_VALUE
        SFFloat field named xSpacing has default value 1.0f (Java syntax) or 1.0 (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 float ZSPACING_DEFAULT_VALUE
        SFFloat field named zSpacing has default value 1.0f (Java syntax) or 1.0 (XML syntax).
        See Also:
        Constant Field Values
      • fromField_ATTRIB

        public static final java.lang.String fromField_ATTRIB
        fromField ROUTE name for MFNode field named attrib.
        See Also:
        Constant Field Values
      • toField_ATTRIB

        public static final java.lang.String toField_ATTRIB
        toField ROUTE name for MFNode field named attrib.
        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_FOGCOORD

        public static final java.lang.String fromField_FOGCOORD
        fromField ROUTE name for SFNode field named fogCoord.
        See Also:
        Constant Field Values
      • toField_FOGCOORD

        public static final java.lang.String toField_FOGCOORD
        toField ROUTE name for SFNode field named fogCoord.
        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
    • Constructor Detail

      • ElevationGridObject

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

        public ElevationGridObject​(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: ElevationGrid
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.String getComponent()
        Defines X3D component for the ElevationGrid element: Geometry3D
        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: 3
        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
      • getAttribList

        public java.util.ArrayList<X3DNode> getAttribList()
        Utility method to get ArrayList value of MFNode attrib field, similar to getAttrib().
        Returns:
        value of attrib field
      • setAttrib

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

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

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

        public ElevationGridObject addAttrib​(X3DNode newValue)
        Add single child node to existing array of attrib nodes (if any).

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

        public ElevationGridObject addAttrib​(ProtoInstanceObject newValue)
        Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for attrib field.

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.
        Parameters:
        newValue - is new value to be appended the parts field.
        Returns:
        ElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addAttrib

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

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

        public void setAttrib​(X3DNode newValue)
        Set single child attrib node, replacing prior array of existing nodes (if any).

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DVertexAttributeNode.
        Specified by:
        setAttrib in interface ElevationGrid
        Parameters:
        newValue - is new node for the attrib field (restricted to X3DVertexAttributeNode)
      • clearAttrib

        public ElevationGridObject clearAttrib()
        Utility method to clear MFNode value of attrib field.
        Returns:
        ElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasAttrib

        public boolean hasAttrib()
        Indicate whether an object is available for inputOutput MFNode field attrib.
        Returns:
        whether a properly typed node or ProtoInstance array or CommentsBlock is available.
        See Also:
        getAttrib()
      • 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 ElevationGrid
        Returns:
        value of ccw field
      • setCcw

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

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

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

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

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

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

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

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

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

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

        public FogCoordinate getFogCoord()
        Provide FogCoordinateObject instance (using a properly typed node) from inputOutput SFNode field fogCoord.
        Specified by:
        getFogCoord in interface ElevationGrid
        Returns:
        value of fogCoord field
        See Also:
        Tooltip: [FogCoordinate] Single contained FogCoordinate node that specifies depth parameters for fog in corresponding geometry. *
      • clearFogCoord

        public ElevationGridObject clearFogCoord()
        Utility method to clear SFNode value of fogCoord field.
        Returns:
        ElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setFogCoord

        public ElevationGridObject setFogCoord​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fogCoord.
        Parameters:
        newValue - is new value for the fogCoord field.
        Returns:
        ElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setFogCoord(FogCoordinate)
      • hasFogCoord

        public boolean hasFogCoord()
        Indicate whether an object is available for inputOutput SFNode field fogCoord.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getFogCoord(), getFogCoordProtoInstance()
      • getHeight

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

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

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

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

        Tooltip: Grid array of height vertices with upward direction along +Y axis, with xDimension rows and zDimension columns.
        • Hint: height array values are given in row-major order from left to right along X axis, then back to front along Z axis.
        • Warning: height array values are not retained or available at run time since a browser is permitted to condense geometry.
        Specified by:
        setHeight in interface ElevationGrid
        Parameters:
        newValue - is new value for the height field.
        Returns:
        ElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setHeight

        public ElevationGridObject setHeight​(MFFloatObject newValue)
        Assign typed object value to MFFloat height field, similar to setHeight(float[]).
        Parameters:
        newValue - is new value for the height field.
        Returns:
        ElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setHeight

        public ElevationGridObject setHeight​(java.util.ArrayList<java.lang.Float> newValue)
        Assign ArrayList value of MFFloat height field, similar to setHeight(float[]).
        Parameters:
        newValue - is new value for the height field.
        Returns:
        ElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearHeight

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

        public ElevationGridObject setHeight​(int[] newValue)
        Assign floating-point array value of MFFloat height field, similar to setHeight(float[]).
        Parameters:
        newValue - is new value for the height field.
        Returns:
        ElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addHeight

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

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

        public ElevationGridObject setHeight​(double[] newArray)
        Utility method: double-precision set-array accessor for X3D floating-point type, similar to setHeight(float[]).
        Parameters:
        newArray - is new value for field
        Returns:
        ElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearIS

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

        public ElevationGridObject setNormal​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field normal.
        Parameters:
        newValue - is new value for the normal field.
        Returns:
        ElevationGridObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setNormal(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 ElevationGrid
        Returns:
        value of normalPerVertex field
      • setNormalPerVertex

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

        public ElevationGridObject 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:
        ElevationGridObject - 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 ElevationGrid
        Returns:
        value of solid field
      • setSolid

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

        public ElevationGridObject 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:
        ElevationGridObject - 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 ElevationGrid
        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 ElevationGridObject clearTexCoord()
        Utility method to clear SFNode value of texCoord field.
        Returns:
        ElevationGridObject - 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 X direction.
        • Hint: total horizontal x-axis distance equals (xDimension-1) * xSpacing.
        • Warning: xDimension &lt; 2 means that ElevationGrid contains no quadrilaterals.
        Specified by:
        getXDimension in interface ElevationGrid
        Returns:
        value of xDimension field
      • setXDimension

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

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

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

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

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

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

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

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

        public ElevationGridObject setXSpacing​(double newValue)
        Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setXSpacing(float).
        Parameters:
        newValue - is new value for field
        Returns:
        ElevationGridObject - 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 Z direction.
        • Hint: total horizontal z-axis distance equals (zDimension-1) * zSpacing.
        • Warning: zDimension &lt; 2 means that ElevationGrid contains no quadrilaterals.
        Specified by:
        getZDimension in interface ElevationGrid
        Returns:
        value of zDimension field
      • setZDimension

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        public ElevationGridObject 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:
        ElevationGridObject - 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)