Package org.web3d.x3d.jsail.Geospatial
Class GeoElevationGridObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Geospatial.GeoElevationGridObject
- All Implemented Interfaces:
X3DNode
,GeoElevationGrid
,X3DGeometryNode
public class GeoElevationGridObject extends X3DConcreteNode implements GeoElevationGrid
GeoElevationGrid is a geometry node defining a rectangular height field, with default values for a 1m by 1m square at height 0.
X3D node tooltip: [X3DGeometryNode] GeoElevationGrid is a geometry node defining a rectangular height field, with default values for a 1m by 1m square at height 0. Vertices corresponding to GeoElevationGrid height values define quadrilaterals, which are placed above or below a curved geospatial surface using geographic coordinates.
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.
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.
-
Field Summary
Fields Modifier and Type Field Description static boolean
CCW_DEFAULT_VALUE
SFBool field named ccw has default value true (Java syntax) or true (XML syntax).static X3DColorNode
COLOR_DEFAULT_VALUE
SFNode field named color has default value null (Java syntax) or NULL (XML syntax).static boolean
COLORPERVERTEX_DEFAULT_VALUE
SFBool field named colorPerVertex has default value true (Java syntax) or true (XML syntax).static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the GeoElevationGrid element: Geospatialstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static double
CREASEANGLE_DEFAULT_VALUE
SFDouble field named creaseAngle has default value 0 (Java syntax) or 0 (XML syntax).static java.lang.String
fromField_COLOR
fromField ROUTE name for SFNode field named color.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_NORMAL
fromField ROUTE name for SFNode field named normal.static java.lang.String
fromField_TEXCOORD
fromField ROUTE name for SFNode field named texCoord.static java.lang.String
fromField_YSCALE
fromField ROUTE name for SFFloat field named yScale.static double[]
GEOGRIDORIGIN_DEFAULT_VALUE
SFVec3d field named geoGridOrigin has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax).static GeoOriginObject
GEOORIGIN_DEFAULT_VALUE
SFNode field named geoOrigin has default value null (Java syntax) or NULL (XML syntax).static 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).static 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).static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D Geospatial component level for this element: 1static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: GeoElevationGrid.static X3DNormalNode
NORMAL_DEFAULT_VALUE
SFNode field named normal has default value null (Java syntax) or NULL (XML syntax).static boolean
NORMALPERVERTEX_DEFAULT_VALUE
SFBool field named normalPerVertex has default value true (Java syntax) or true (XML syntax).static boolean
SOLID_DEFAULT_VALUE
SFBool field named solid has default value true (Java syntax) or true (XML syntax).static X3DTextureCoordinateNode
TEXCOORD_DEFAULT_VALUE
SFNode field named texCoord has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
toField_COLOR
toField ROUTE name for SFNode field named color.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_NORMAL
toField ROUTE name for SFNode field named normal.static java.lang.String
toField_SET_HEIGHT
toField ROUTE name for MFFloat field named set_height.static java.lang.String
toField_TEXCOORD
toField ROUTE name for SFNode field named texCoord.static java.lang.String
toField_YSCALE
toField ROUTE name for SFFloat field named yScale.static int
XDIMENSION_DEFAULT_VALUE
SFInt32 field named xDimension has default value 2 (Java syntax) or 2 (XML syntax).static double
XSPACING_DEFAULT_VALUE
SFDouble field named xSpacing has default value 1.0 (Java syntax) or 1.0 (XML syntax).static float
YSCALE_DEFAULT_VALUE
SFFloat field named yScale has default value 1f (Java syntax) or 1 (XML syntax).static int
ZDIMENSION_DEFAULT_VALUE
SFInt32 field named zDimension has default value 2 (Java syntax) or 2 (XML syntax).static double
ZSPACING_DEFAULT_VALUE
SFDouble field named zSpacing has default value 1.0 (Java syntax) or 1.0 (XML syntax).Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description GeoElevationGridObject()
Constructor for GeoElevationGridObject to initialize member variables with default values.GeoElevationGridObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description GeoElevationGridObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.GeoElevationGridObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.GeoElevationGridObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.GeoElevationGridObject
addGeoSystem(java.lang.String newValue)
Add singleton String value to MFString geoSystem field.GeoElevationGridObject
addGeoSystem(SFStringObject newValue)
Add singleton SFStringObject value to MFString geoSystem field.GeoElevationGridObject
addHeight(double newValue)
Add singleton double value to MFDouble height field.GeoElevationGridObject
addHeight(SFDoubleObject newValue)
Add singleton SFDoubleObject value to MFDouble height field.GeoElevationGridObject
clearColor()
Utility method to clear SFNode value of color field.GeoElevationGridObject
clearGeoOrigin()
Utility method to clear SFNode value of geoOrigin field.GeoElevationGridObject
clearGeoSystem()
Utility method to clear MFString value of geoSystem field.GeoElevationGridObject
clearHeight()
Utility method to clear MFDouble value of height field.GeoElevationGridObject
clearIS()
Utility method to clear SFNode value of IS field.GeoElevationGridObject
clearMetadata()
Utility method to clear SFNode value of metadata field.GeoElevationGridObject
clearNormal()
Utility method to clear SFNode value of normal field.GeoElevationGridObject
clearTexCoord()
Utility method to clear SFNode value of texCoord field.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.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.X3DConcreteNode
findNodeByDEF(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.java.lang.String
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.boolean
getCcw()
Provide boolean value from initializeOnly SFBool field named ccw.X3DColorNode
getColor()
Provide X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.boolean
getColorPerVertex()
Provide boolean value from initializeOnly SFBool field named colorPerVertex.java.lang.String
getComponent()
Defines X3D component for the GeoElevationGrid element: Geospatialint
getComponentLevel()
Provides default X3D component level for this element: 1java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.double
getCreaseAngle()
Provide double value unit axis, angle (in radians) within allowed range of [0,infinity) from initializeOnly SFDouble field named creaseAngle.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.java.lang.String
getElementName()
Provides name of this element: GeoElevationGridjava.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.double[]
getGeoGridOrigin()
Provide array of 3-tuple double results from initializeOnly SFVec3d field named geoGridOrigin.GeoOrigin
getGeoOrigin()
Provide GeoOriginObject instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.java.lang.String[]
getGeoSystem()
Provide array of String results from initializeOnly MFString field named geoSystem.java.util.ArrayList<java.lang.String>
getGeoSystemList()
Utility method to get ArrayList value of MFString geoSystem field, similar togetGeoSystem()
.java.lang.String
getGeoSystemString()
Utility method to get String value of MFString geoSystem field, similar togetGeoSystem()
.double[]
getHeight()
Provide array of Double results from initializeOnly MFDouble field named height.java.util.ArrayList<java.lang.Double>
getHeightList()
Utility method to get ArrayList value of MFDouble height field, similar togetHeight()
.java.lang.String
getHeightString()
Utility method to get String value of MFDouble height field, similar togetHeight()
.ISObject
getIS()
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.X3DNormalNode
getNormal()
Provide X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field normal.boolean
getNormalPerVertex()
Provide boolean value from initializeOnly SFBool field named normalPerVertex.boolean
getSolid()
Provide boolean value from initializeOnly SFBool field named solid.X3DTextureCoordinateNode
getTexCoord()
Provide X3DTextureCoordinateNode instance (using a properly typed node) from inputOutput SFNode field texCoord.java.lang.String
getUSE()
Provide String value from inputOutput SFString field named USE.int
getXDimension()
Provide int value within allowed range of [0,infinity) from initializeOnly SFInt32 field named xDimension.double
getXSpacing()
Provide double value within allowed range of (0,infinity) from initializeOnly SFDouble field named xSpacing.float
getYScale()
Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named yScale.int
getZDimension()
Provide int value within allowed range of [0,infinity) from initializeOnly SFInt32 field named zDimension.double
getZSpacing()
Provide double value within allowed range of (0,infinity) from initializeOnly SFDouble field named zSpacing.boolean
hasColor()
Indicate whether an object is available for inputOutput SFNode field color.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.boolean
hasGeoOrigin()
Indicate whether an object is available for initializeOnly SFNode field geoOrigin.boolean
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.boolean
hasMetadata()
Indicate whether an object is available for inputOutput SFNode field metadata.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.boolean
hasNormal()
Indicate whether an object is available for inputOutput SFNode field normal.boolean
hasTexCoord()
Indicate whether an object is available for inputOutput SFNode field texCoord.void
initialize()
Initialize all member variables to default values.GeoElevationGridObject
setCcw(boolean newValue)
Accessor method to assign boolean value to initializeOnly SFBool field named ccw.GeoElevationGridObject
setCcw(SFBoolObject newValue)
Assign typed object value to SFBool ccw field, similar tosetCcw(boolean)
.GeoElevationGridObject
setColor(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field color.GeoElevationGridObject
setColor(X3DColorNode newValue)
Accessor method to assign X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.GeoElevationGridObject
setColorPerVertex(boolean newValue)
Accessor method to assign boolean value to initializeOnly SFBool field named colorPerVertex.GeoElevationGridObject
setColorPerVertex(SFBoolObject newValue)
Assign typed object value to SFBool colorPerVertex field, similar tosetColorPerVertex(boolean)
.GeoElevationGridObject
setCreaseAngle(double newValue)
Accessor method to assign double value unit axis, angle (in radians) to initializeOnly SFDouble field named creaseAngle.GeoElevationGridObject
setCreaseAngle(SFDoubleObject newValue)
Assign typed object value to SFDouble creaseAngle field, similar tosetCreaseAngle(double)
.GeoElevationGridObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.GeoElevationGridObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.GeoElevationGridObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.GeoElevationGridObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.GeoElevationGridObject
setGeoGridOrigin(double[] newValue)
Accessor method to assign 3-tuple double array to initializeOnly SFVec3d field named geoGridOrigin.GeoElevationGridObject
setGeoGridOrigin(double x, double y, double z)
Assign values to SFVec3d geoGridOrigin field, similar tosetGeoGridOrigin(double[])
.GeoElevationGridObject
setGeoGridOrigin(SFVec3dObject newValue)
Assign typed object value to SFVec3d geoGridOrigin field, similar tosetGeoGridOrigin(double[])
.GeoElevationGridObject
setGeoOrigin(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field geoOrigin.GeoElevationGridObject
setGeoOrigin(GeoOrigin newValue)
Accessor method to assign GeoOriginObject instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.GeoElevationGridObject
setGeoSystem(java.lang.String newValue)
Assign singleton String value to MFString geoSystem field, similar tosetGeoSystem(String[])
.GeoElevationGridObject
setGeoSystem(java.lang.String[] newValue)
Accessor method to assign String array to initializeOnly MFString field named geoSystem.GeoElevationGridObject
setGeoSystem(java.util.ArrayList<java.lang.String> newValue)
Assign ArrayList value of MFString geoSystem field, similar tosetGeoSystem(String[])
.GeoElevationGridObject
setGeoSystem(MFStringObject newValue)
Assign typed object value to MFString geoSystem field, similar tosetGeoSystem(String[])
.GeoElevationGridObject
setGeoSystem(SFStringObject newValue)
Assign single SFString object value to MFString geoSystem field, similar tosetGeoSystem(String[])
.GeoElevationGridObject
setHeight(double[] newValue)
Accessor method to assign Double array to initializeOnly MFDouble field named height.GeoElevationGridObject
setHeight(int[] newValue)
Assign floating-point array value of MFDouble height field, similar tosetHeight(double[])
.GeoElevationGridObject
setHeight(java.util.ArrayList<java.lang.Double> newValue)
Assign ArrayList value of MFDouble height field, similar tosetHeight(double[])
.GeoElevationGridObject
setHeight(MFDoubleObject newValue)
Assign typed object value to MFDouble height field, similar tosetHeight(double[])
.GeoElevationGridObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.GeoElevationGridObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.GeoElevationGridObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.GeoElevationGridObject
setNormal(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field normal.GeoElevationGridObject
setNormal(X3DNormalNode newValue)
Accessor method to assign X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal.GeoElevationGridObject
setNormalPerVertex(boolean newValue)
Accessor method to assign boolean value to initializeOnly SFBool field named normalPerVertex.GeoElevationGridObject
setNormalPerVertex(SFBoolObject newValue)
Assign typed object value to SFBool normalPerVertex field, similar tosetNormalPerVertex(boolean)
.GeoElevationGridObject
setSolid(boolean newValue)
Accessor method to assign boolean value to initializeOnly SFBool field named solid.GeoElevationGridObject
setSolid(SFBoolObject newValue)
Assign typed object value to SFBool solid field, similar tosetSolid(boolean)
.GeoElevationGridObject
setTexCoord(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field texCoord.GeoElevationGridObject
setTexCoord(X3DTextureCoordinateNode newValue)
Accessor method to assign X3DTextureCoordinateNode instance (using a properly typed node) to inputOutput SFNode field texCoord.GeoElevationGridObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.GeoElevationGridObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.GeoElevationGridObject
setUSE(GeoElevationGridObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.GeoElevationGridObject
setXDimension(int newValue)
Accessor method to assign int value to initializeOnly SFInt32 field named xDimension.GeoElevationGridObject
setXDimension(SFInt32Object newValue)
Assign typed object value to SFInt32 xDimension field, similar tosetXDimension(int)
.GeoElevationGridObject
setXSpacing(double newValue)
Accessor method to assign double value to initializeOnly SFDouble field named xSpacing.GeoElevationGridObject
setXSpacing(SFDoubleObject newValue)
Assign typed object value to SFDouble xSpacing field, similar tosetXSpacing(double)
.GeoElevationGridObject
setYScale(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetYScale(float)
.GeoElevationGridObject
setYScale(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named yScale.GeoElevationGridObject
setYScale(SFFloatObject newValue)
Assign typed object value to SFFloat yScale field, similar tosetYScale(float)
.GeoElevationGridObject
setZDimension(int newValue)
Accessor method to assign int value to initializeOnly SFInt32 field named zDimension.GeoElevationGridObject
setZDimension(SFInt32Object newValue)
Assign typed object value to SFInt32 zDimension field, similar tosetZDimension(int)
.GeoElevationGridObject
setZSpacing(double newValue)
Accessor method to assign double value to initializeOnly SFDouble field named zSpacing.GeoElevationGridObject
setZSpacing(SFDoubleObject newValue)
Assign typed object value to SFDouble zSpacing field, similar tosetZSpacing(double)
.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.java.lang.String
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.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.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: GeoElevationGrid.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the GeoElevationGrid element: Geospatial- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger 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_VALUESFBool field named ccw has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
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_VALUESFBool 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_VALUESFDouble 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_VALUESFVec3d field named geoGridOrigin has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax). -
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_VALUEMFString 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_VALUEMFDouble 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
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
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_VALUESFBool 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_VALUESFBool field named solid has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
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_VALUESFInt32 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_VALUESFDouble 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_VALUESFFloat 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_VALUESFInt32 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_VALUESFDouble field named zSpacing has default value 1.0 (Java syntax) or 1.0 (XML syntax).- See Also:
- Constant Field Values
-
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes. -
fromField_COLOR
public static final java.lang.String fromField_COLORfromField ROUTE name for SFNode field named color.- See Also:
- Constant Field Values
-
toField_COLOR
public static final java.lang.String toField_COLORtoField ROUTE name for SFNode field named color.- See Also:
- Constant Field Values
-
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
fromField_NORMAL
public static final java.lang.String fromField_NORMALfromField ROUTE name for SFNode field named normal.- See Also:
- Constant Field Values
-
toField_NORMAL
public static final java.lang.String toField_NORMALtoField ROUTE name for SFNode field named normal.- See Also:
- Constant Field Values
-
toField_SET_HEIGHT
public static final java.lang.String toField_SET_HEIGHTtoField ROUTE name for MFFloat field named set_height.- See Also:
- Constant Field Values
-
fromField_TEXCOORD
public static final java.lang.String fromField_TEXCOORDfromField ROUTE name for SFNode field named texCoord.- See Also:
- Constant Field Values
-
toField_TEXCOORD
public static final java.lang.String toField_TEXCOORDtoField ROUTE name for SFNode field named texCoord.- See Also:
- Constant Field Values
-
fromField_YSCALE
public static final java.lang.String fromField_YSCALEfromField ROUTE name for SFFloat field named yScale.- See Also:
- Constant Field Values
-
toField_YSCALE
public static final java.lang.String toField_YSCALEtoField ROUTE name for SFFloat field named yScale.- See Also:
- Constant Field Values
-
-
Constructor Details
-
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 Details
-
getElementName
public final java.lang.String getElementName()Provides name of this element: GeoElevationGrid- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the GeoElevationGrid element: Geospatial- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevel
in classX3DConcreteElement
- 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 classX3DConcreteElement
- 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 classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
-
getContainerFieldDefault
public final java.lang.String getContainerFieldDefault()containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
- X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getCcw
public boolean getCcw()Provide boolean value from initializeOnly SFBool field named ccw.
Tooltip: ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in turn defines front/back orientation of polygon normals according to Right-Hand Rule (RHR).- Hint: a good debugging technique for problematic polygons is to try changing the value of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector direction.
- Warning: consistent and correct ordering of left-handed or right-handed point sequences is important throughout the coord array of point values.
- Hint: clockwise https://en.wikipedia.org/wiki/Clockwise
- Specified by:
getCcw
in interfaceGeoElevationGrid
- Returns:
- value of ccw field
-
setCcw
Accessor method to assign boolean value to initializeOnly SFBool field named ccw.
Tooltip: ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in turn defines front/back orientation of polygon normals according to Right-Hand Rule (RHR).- Hint: a good debugging technique for problematic polygons is to try changing the value of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector direction.
- Warning: consistent and correct ordering of left-handed or right-handed point sequences is important throughout the coord array of point values.
- Hint: clockwise https://en.wikipedia.org/wiki/Clockwise
- Specified by:
setCcw
in interfaceGeoElevationGrid
- 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
Assign typed object value to SFBool ccw field, similar tosetCcw(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
Provide X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.- Specified by:
getColor
in interfaceGeoElevationGrid
- Returns:
- value of color field
- See Also:
Tooltip: [X3DColorNode] Single contained Color or ColorRGBA node that specifies color values applied to corresponding vertices according to colorPerVertex field. *
-
setColor
Accessor method to assign X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.- Specified by:
setColor
in interfaceGeoElevationGrid
- Parameters:
newValue
- is new value for the color field.- Returns:
GeoElevationGridObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DColorNode] Single contained Color or ColorRGBA node that specifies color values applied to corresponding vertices according to colorPerVertex field. *
-
clearColor
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).
-
setColor
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field color.- Parameters:
newValue
- is new value for the color field.- Returns:
GeoElevationGridObject
- 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()
-
getColorPerVertex
public boolean getColorPerVertex()Provide boolean value from initializeOnly SFBool field named colorPerVertex.
Tooltip: Whether Color node color values are applied to each point vertex (true) or per quadrilateral (false).- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Specified by:
getColorPerVertex
in interfaceGeoElevationGrid
- Returns:
- value of colorPerVertex field
-
setColorPerVertex
Accessor method to assign boolean value to initializeOnly SFBool field named colorPerVertex.
Tooltip: Whether Color node color values are applied to each point vertex (true) or per quadrilateral (false).- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Specified by:
setColorPerVertex
in interfaceGeoElevationGrid
- 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).
-
setColorPerVertex
Assign typed object value to SFBool colorPerVertex field, similar tosetColorPerVertex(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 interfaceGeoElevationGrid
- Returns:
- value of creaseAngle field
-
setCreaseAngle
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 interfaceGeoElevationGrid
- 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
Assign typed object value to SFDouble creaseAngle field, similar tosetCreaseAngle(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 interfaceGeoElevationGrid
- Returns:
- value of geoGridOrigin field
-
setGeoGridOrigin
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 interfaceGeoElevationGrid
- 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
Assign typed object value to SFVec3d geoGridOrigin field, similar tosetGeoGridOrigin(double[])
.- 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
Assign values to SFVec3d geoGridOrigin field, similar tosetGeoGridOrigin(double[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
GeoElevationGridObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getGeoOrigin
Provide GeoOriginObject instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.- Specified by:
getGeoOrigin
in interfaceGeoElevationGrid
- Returns:
- value of geoOrigin field
- See Also:
Tooltip: [GeoOrigin] Single contained GeoOrigin node that specifies a local coordinate frame for extended precision. Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#high-precisioncoords Warning: XML validation requires placement as first child node following contained metadata nodes (if any).
-
setGeoOrigin
Accessor method to assign GeoOriginObject instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.- Specified by:
setGeoOrigin
in interfaceGeoElevationGrid
- 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:
Tooltip: [GeoOrigin] Single contained GeoOrigin node that specifies a local coordinate frame for extended precision. Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#high-precisioncoords Warning: XML validation requires placement as first child node following contained metadata nodes (if any).
-
clearGeoOrigin
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
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()
-
getGeoSystem
public java.lang.String[] getGeoSystem()Provide array of String results from initializeOnly MFString field named geoSystem.
Tooltip: Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted string parameters as appropriate for the type.- Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#Spatialreferenceframes
- Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#Specifyinggeospatialcoords
- Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
- Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC).
- Specified by:
getGeoSystem
in interfaceGeoElevationGrid
- Returns:
- value of geoSystem field
-
getGeoSystemList
public java.util.ArrayList<java.lang.String> getGeoSystemList()Utility method to get ArrayList value of MFString geoSystem field, similar togetGeoSystem()
.- Returns:
- value of geoSystem field
-
getGeoSystemString
public java.lang.String getGeoSystemString()Utility method to get String value of MFString geoSystem field, similar togetGeoSystem()
.- Returns:
- value of geoSystem field
-
setGeoSystem
Accessor method to assign String array to initializeOnly MFString field named geoSystem.
Tooltip: Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted string parameters as appropriate for the type.- Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#Spatialreferenceframes
- Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#Specifyinggeospatialcoords
- Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
- Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC).
- Specified by:
setGeoSystem
in interfaceGeoElevationGrid
- 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
Assign typed object value to MFString geoSystem field, similar tosetGeoSystem(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
Assign single SFString object value to MFString geoSystem field, similar tosetGeoSystem(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
Assign singleton String value to MFString geoSystem field, similar tosetGeoSystem(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
Assign ArrayList value of MFString geoSystem field, similar tosetGeoSystem(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
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).
-
addGeoSystem
Add singleton String value to MFString geoSystem field.- Parameters:
newValue
- is new value to add to the geoSystem field.- Returns:
GeoElevationGridObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
addGeoSystem
Add singleton SFStringObject value to MFString geoSystem field.- Parameters:
newValue
- is new value to add to the geoSystem field.- Returns:
GeoElevationGridObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
getHeight
public double[] getHeight()Provide array of Double results from initializeOnly MFDouble field named height.
Tooltip: Contains xDimension rows * zDimension columns floating-point values for elevation above ellipsoid.- Hint: height array values are in row-major order from west to east, south to north.
- Hint: geoGridOrigin is in southwest (lower-left) corner of height dataset.
- Warning: height array values are not retained or available at run time since a browser is permitted to condense geometry.
- Specified by:
getHeight
in interfaceGeoElevationGrid
- 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 togetHeight()
.- Returns:
- value of height field
-
getHeightString
public java.lang.String getHeightString()Utility method to get String value of MFDouble height field, similar togetHeight()
.- Returns:
- value of height field
-
setHeight
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 interfaceGeoElevationGrid
- 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
Assign typed object value to MFDouble height field, similar tosetHeight(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).
-
setHeight
Assign ArrayList value of MFDouble height field, similar tosetHeight(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
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
Assign floating-point array value of MFDouble height field, similar tosetHeight(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
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
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).
-
getIS
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
GeoElevationGridObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
clearIS
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()
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceGeoElevationGrid
- Specified by:
getMetadata
in interfaceX3DGeometryNode
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceGeoElevationGrid
- Specified by:
setMetadata
in interfaceX3DGeometryNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
GeoElevationGridObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
clearMetadata
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).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
GeoElevationGridObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setMetadata(X3DMetadataObject)
-
hasMetadata
public boolean hasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getMetadata()
,getMetadataProtoInstance()
, X3D Scene Authoring Hints: Metadata Nodes
-
getNormal
Provide X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field normal.- Specified by:
getNormal
in interfaceGeoElevationGrid
- Returns:
- value of normal field
- See Also:
Tooltip: [X3DNormalNode] Single contained Normal node that specifies perpendicular vectors for corresponding vertices to support rendering computations, applied according to the normalPerVertex field. Hint: useful for special effects. Normal vector computation by 3D graphics hardware is quite fast so adding normals to a scene is typically unnecessary. Warning: normal vectors increase file size, typically doubling geometry definitions.
-
setNormal
Accessor method to assign X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal.- Specified by:
setNormal
in interfaceGeoElevationGrid
- Parameters:
newValue
- is new value for the normal field.- Returns:
GeoElevationGridObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DNormalNode] Single contained Normal node that specifies perpendicular vectors for corresponding vertices to support rendering computations, applied according to the normalPerVertex field. Hint: useful for special effects. Normal vector computation by 3D graphics hardware is quite fast so adding normals to a scene is typically unnecessary. Warning: normal vectors increase file size, typically doubling geometry definitions.
-
clearNormal
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).
-
setNormal
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field normal.- Parameters:
newValue
- is new value for the normal field.- Returns:
GeoElevationGridObject
- 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 interfaceGeoElevationGrid
- Returns:
- value of normalPerVertex field
-
setNormalPerVertex
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 interfaceGeoElevationGrid
- 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
Assign typed object value to SFBool normalPerVertex field, similar tosetNormalPerVertex(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).- Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
- Warning: default value true can completely hide geometry if viewed from wrong side!
- Hint: if in doubt, use solid='false' for maximum visibility.
- Specified by:
getSolid
in interfaceGeoElevationGrid
- Returns:
- value of solid field
-
setSolid
Accessor method to assign boolean value to initializeOnly SFBool field named solid.
Tooltip: Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off).- Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
- Warning: default value true can completely hide geometry if viewed from wrong side!
- Hint: if in doubt, use solid='false' for maximum visibility.
- Specified by:
setSolid
in interfaceGeoElevationGrid
- 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
Assign typed object value to SFBool solid field, similar tosetSolid(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
Provide X3DTextureCoordinateNode instance (using a properly typed node) from inputOutput SFNode field texCoord.- Specified by:
getTexCoord
in interfaceGeoElevationGrid
- Returns:
- value of texCoord field
- See Also:
Tooltip: [X3DTextureCoordinateNode] Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate node that specifies coordinates for texture mapping onto corresponding geometry. *
-
setTexCoord
Accessor method to assign X3DTextureCoordinateNode instance (using a properly typed node) to inputOutput SFNode field texCoord.- Specified by:
setTexCoord
in interfaceGeoElevationGrid
- Parameters:
newValue
- is new value for the texCoord field.- Returns:
GeoElevationGridObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DTextureCoordinateNode] Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate node that specifies coordinates for texture mapping onto corresponding geometry. *
-
clearTexCoord
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).
-
setTexCoord
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field texCoord.- Parameters:
newValue
- is new value for the texCoord field.- Returns:
GeoElevationGridObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setTexCoord(X3DTextureCoordinateNode)
-
hasTexCoord
public boolean hasTexCoord()Indicate whether an object is available for inputOutput SFNode field texCoord.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getTexCoord()
,getTexCoordProtoInstance()
-
getXDimension
public int getXDimension()Provide int value within allowed range of [0,infinity) from initializeOnly SFInt32 field named xDimension.
Tooltip: (0,+infinity) Number of elements in the height array along east-west X direction.- Hint: total horizontal x-axis distance equals (xDimension-1) * xSpacing.
- Warning: xDimension < 2 means that GeoElevationGrid contains no quadrilaterals.
- Specified by:
getXDimension
in interfaceGeoElevationGrid
- Returns:
- value of xDimension field
-
setXDimension
Accessor method to assign int value to initializeOnly SFInt32 field named xDimension.
Tooltip: (0,+infinity) Number of elements in the height array along east-west X direction.- Hint: total horizontal x-axis distance equals (xDimension-1) * xSpacing.
- Warning: xDimension < 2 means that GeoElevationGrid contains no quadrilaterals.
- Specified by:
setXDimension
in interfaceGeoElevationGrid
- 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
Assign typed object value to SFInt32 xDimension field, similar tosetXDimension(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 interfaceGeoElevationGrid
- Returns:
- value of xSpacing field
-
setXSpacing
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 interfaceGeoElevationGrid
- 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
Assign typed object value to SFDouble xSpacing field, similar tosetXSpacing(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 interfaceGeoElevationGrid
- Returns:
- value of yScale field
-
setYScale
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 interfaceGeoElevationGrid
- 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
Assign typed object value to SFFloat yScale field, similar tosetYScale(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
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetYScale(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 < 2 means that GeoElevationGrid contains no quadrilaterals.
- Specified by:
getZDimension
in interfaceGeoElevationGrid
- Returns:
- value of zDimension field
-
setZDimension
Accessor method to assign int value to initializeOnly SFInt32 field named zDimension.
Tooltip: (0,+infinity) Number of elements in the height array along north-south Z direction.- Hint: total lateral z-axis distance equals (zDimension-1) * zSpacing.
- Warning: zDimension < 2 means that GeoElevationGrid contains no quadrilaterals.
- Specified by:
setZDimension
in interfaceGeoElevationGrid
- 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
Assign typed object value to SFInt32 zDimension field, similar tosetZDimension(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 interfaceGeoElevationGrid
- Returns:
- value of zSpacing field
-
setZSpacing
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 interfaceGeoElevationGrid
- 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
Assign typed object value to SFDouble zSpacing field, similar tosetZSpacing(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).
-
getDEF
public java.lang.String getDEF()Provide String value from inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Overrides:
getDEF
in classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
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.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- 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
Assign typed object value to SFString DEF field, similar tosetDEF(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 classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
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: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
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 classX3DConcreteNode
- 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
Assign typed object value to SFString USE field, similar tosetUSE(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 classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
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 classX3DConcreteNode
- 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
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- 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).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
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
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
GeoElevationGridObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
GeoElevationGridObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
GeoElevationGridObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
public java.lang.String toStringX3D(int indentLevel)Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
X3DObject.FILE_EXTENSION_X3D
,X3DObject.FILE_EXTENSION_XML
,X3DObject.toStringXML()
,X3DObject.toFileXML(String)
,X3DObject.toFileX3D(String)
, X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
public java.lang.String toStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
X3DObject.FILE_EXTENSION_CLASSICVRML
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
-
toStringVRML97
public java.lang.String toStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
X3DObject.FILE_EXTENSION_VRML97
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
-
findElementByNameValue
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 classX3DConcreteElement
- 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 classX3DConcreteElement
- 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)
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
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 DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
findElementByNameValue(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
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 classX3DConcreteElement
- Returns:
- validation results (if any)
-