Package org.web3d.x3d.jsail.Geometry3D
Class ElevationGridObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Geometry3D.ElevationGridObject
- All Implemented Interfaces:
X3DNode
,ElevationGrid
,X3DGeometryNode
public class ElevationGridObject extends X3DConcreteNode implements ElevationGrid
ElevationGrid 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] 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.
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] 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.
-
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 ElevationGrid element: Geometry3Dstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static float
CREASEANGLE_DEFAULT_VALUE
SFFloat field named creaseAngle has default value 0f (Java syntax) or 0 (XML syntax).static FogCoordinateObject
FOGCOORD_DEFAULT_VALUE
SFNode field named fogCoord has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
fromField_ATTRIB
fromField ROUTE name for MFNode field named attrib.static java.lang.String
fromField_COLOR
fromField ROUTE name for SFNode field named color.static java.lang.String
fromField_FOGCOORD
fromField ROUTE name for SFNode field named fogCoord.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.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).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 Geometry3D component level for this element: 3static 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: ElevationGrid.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_ATTRIB
toField ROUTE name for MFNode field named attrib.static java.lang.String
toField_COLOR
toField ROUTE name for SFNode field named color.static java.lang.String
toField_FOGCOORD
toField ROUTE name for SFNode field named fogCoord.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 int
XDIMENSION_DEFAULT_VALUE
SFInt32 field named xDimension has default value 2 (Java syntax) or 2 (XML syntax).static float
XSPACING_DEFAULT_VALUE
SFFloat field named xSpacing has default value 1.0f (Java syntax) or 1.0 (XML syntax).static int
ZDIMENSION_DEFAULT_VALUE
SFInt32 field named zDimension has default value 2 (Java syntax) or 2 (XML syntax).static float
ZSPACING_DEFAULT_VALUE
SFFloat field named zSpacing has default value 1.0f (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 ElevationGridObject()
Constructor for ElevationGridObject to initialize member variables with default values.ElevationGridObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description ElevationGridObject
addAttrib(ProtoInstanceObject newValue)
Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for attrib field.ElevationGridObject
addAttrib(X3DNode newValue)
Add single child node to existing array of attrib nodes (if any).void
addAttrib(X3DNode[] newValue)
Add array of child attrib nodes to array of existing nodes (if any).ElevationGridObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.ElevationGridObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.ElevationGridObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.ElevationGridObject
addHeight(float newValue)
Add singleton float value to MFFloat height field.ElevationGridObject
addHeight(SFFloatObject newValue)
Add singleton SFFloatObject value to MFFloat height field.ElevationGridObject
clearAttrib()
Utility method to clear MFNode value of attrib field.ElevationGridObject
clearColor()
Utility method to clear SFNode value of color field.ElevationGridObject
clearFogCoord()
Utility method to clear SFNode value of fogCoord field.ElevationGridObject
clearHeight()
Utility method to clear MFFloat value of height field.ElevationGridObject
clearIS()
Utility method to clear SFNode value of IS field.ElevationGridObject
clearMetadata()
Utility method to clear SFNode value of metadata field.ElevationGridObject
clearNormal()
Utility method to clear SFNode value of normal field.ElevationGridObject
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.X3DNode[]
getAttrib()
Provide array of X3DVertexAttributeNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field attrib.java.util.ArrayList<X3DNode>
getAttribList()
Utility method to get ArrayList value of MFNode attrib field, similar togetAttrib()
.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 ElevationGrid element: Geometry3Dint
getComponentLevel()
Provides default X3D component level for this element: 3java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.float
getCreaseAngle()
Provide float value unit axis, angle (in radians) within allowed range of [0,infinity) from initializeOnly SFFloat 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: ElevationGridjava.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.FogCoordinate
getFogCoord()
Provide FogCoordinateObject instance (using a properly typed node) from inputOutput SFNode field fogCoord.float[]
getHeight()
Provide array of Float results from initializeOnly MFFloat field named height.java.util.ArrayList<java.lang.Float>
getHeightList()
Utility method to get ArrayList value of MFFloat height field, similar togetHeight()
.java.lang.String
getHeightString()
Utility method to get String value of MFFloat 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.float
getXSpacing()
Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named xSpacing.int
getZDimension()
Provide int value within allowed range of [0,infinity) from initializeOnly SFInt32 field named zDimension.float
getZSpacing()
Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named zSpacing.boolean
hasAttrib()
Indicate whether an object is available for inputOutput MFNode field attrib.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
hasFogCoord()
Indicate whether an object is available for inputOutput SFNode field fogCoord.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.ElevationGridObject
setAttrib(java.util.ArrayList<X3DVertexAttributeNode> newValue)
Assign ArrayList value of MFNode attrib field, similar tosetAttrib(X3DNode[])
.void
setAttrib(X3DNode newValue)
Set single child attrib node, replacing prior array of existing nodes (if any).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.ElevationGridObject
setCcw(boolean newValue)
Accessor method to assign boolean value to initializeOnly SFBool field named ccw.ElevationGridObject
setCcw(SFBoolObject newValue)
Assign typed object value to SFBool ccw field, similar tosetCcw(boolean)
.ElevationGridObject
setColor(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field color.ElevationGridObject
setColor(X3DColorNode newValue)
Accessor method to assign X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.ElevationGridObject
setColorPerVertex(boolean newValue)
Accessor method to assign boolean value to initializeOnly SFBool field named colorPerVertex.ElevationGridObject
setColorPerVertex(SFBoolObject newValue)
Assign typed object value to SFBool colorPerVertex field, similar tosetColorPerVertex(boolean)
.ElevationGridObject
setCreaseAngle(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetCreaseAngle(float)
.ElevationGridObject
setCreaseAngle(float newValue)
Accessor method to assign float value unit axis, angle (in radians) to initializeOnly SFFloat field named creaseAngle.ElevationGridObject
setCreaseAngle(SFFloatObject newValue)
Assign typed object value to SFFloat creaseAngle field, similar tosetCreaseAngle(float)
.ElevationGridObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.ElevationGridObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.ElevationGridObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.ElevationGridObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.ElevationGridObject
setFogCoord(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fogCoord.ElevationGridObject
setFogCoord(FogCoordinate newValue)
Accessor method to assign FogCoordinateObject instance (using a properly typed node) to inputOutput SFNode field fogCoord.ElevationGridObject
setHeight(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetHeight(float[])
.ElevationGridObject
setHeight(float[] newValue)
Accessor method to assign Float array to initializeOnly MFFloat field named height.ElevationGridObject
setHeight(int[] newValue)
Assign floating-point array value of MFFloat height field, similar tosetHeight(float[])
.ElevationGridObject
setHeight(java.util.ArrayList<java.lang.Float> newValue)
Assign ArrayList value of MFFloat height field, similar tosetHeight(float[])
.ElevationGridObject
setHeight(MFFloatObject newValue)
Assign typed object value to MFFloat height field, similar tosetHeight(float[])
.ElevationGridObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.ElevationGridObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.ElevationGridObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.ElevationGridObject
setNormal(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field normal.ElevationGridObject
setNormal(X3DNormalNode newValue)
Accessor method to assign X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal.ElevationGridObject
setNormalPerVertex(boolean newValue)
Accessor method to assign boolean value to initializeOnly SFBool field named normalPerVertex.ElevationGridObject
setNormalPerVertex(SFBoolObject newValue)
Assign typed object value to SFBool normalPerVertex field, similar tosetNormalPerVertex(boolean)
.ElevationGridObject
setSolid(boolean newValue)
Accessor method to assign boolean value to initializeOnly SFBool field named solid.ElevationGridObject
setSolid(SFBoolObject newValue)
Assign typed object value to SFBool solid field, similar tosetSolid(boolean)
.ElevationGridObject
setTexCoord(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field texCoord.ElevationGridObject
setTexCoord(X3DTextureCoordinateNode newValue)
Accessor method to assign X3DTextureCoordinateNode instance (using a properly typed node) to inputOutput SFNode field texCoord.ElevationGridObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.ElevationGridObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.ElevationGridObject
setUSE(ElevationGridObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.ElevationGridObject
setXDimension(int newValue)
Accessor method to assign int value to initializeOnly SFInt32 field named xDimension.ElevationGridObject
setXDimension(SFInt32Object newValue)
Assign typed object value to SFInt32 xDimension field, similar tosetXDimension(int)
.ElevationGridObject
setXSpacing(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetXSpacing(float)
.ElevationGridObject
setXSpacing(float newValue)
Accessor method to assign float value to initializeOnly SFFloat field named xSpacing.ElevationGridObject
setXSpacing(SFFloatObject newValue)
Assign typed object value to SFFloat xSpacing field, similar tosetXSpacing(float)
.ElevationGridObject
setZDimension(int newValue)
Accessor method to assign int value to initializeOnly SFInt32 field named zDimension.ElevationGridObject
setZDimension(SFInt32Object newValue)
Assign typed object value to SFInt32 zDimension field, similar tosetZDimension(int)
.ElevationGridObject
setZSpacing(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetZSpacing(float)
.ElevationGridObject
setZSpacing(float newValue)
Accessor method to assign float value to initializeOnly SFFloat field named zSpacing.ElevationGridObject
setZSpacing(SFFloatObject newValue)
Assign typed object value to SFFloat zSpacing field, similar tosetZSpacing(float)
.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: ElevationGrid.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the ElevationGrid element: Geometry3D- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger 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_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 float CREASEANGLE_DEFAULT_VALUESFFloat field named creaseAngle has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
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_VALUEMFFloat field named height has default value {0f,0f,0f,0f} (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 float XSPACING_DEFAULT_VALUESFFloat 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_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 float ZSPACING_DEFAULT_VALUESFFloat field named zSpacing has default value 1.0f (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_ATTRIB
public static final java.lang.String fromField_ATTRIBfromField ROUTE name for MFNode field named attrib.- See Also:
- Constant Field Values
-
toField_ATTRIB
public static final java.lang.String toField_ATTRIBtoField ROUTE name for MFNode field named attrib.- See Also:
- Constant Field Values
-
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_FOGCOORD
public static final java.lang.String fromField_FOGCOORDfromField ROUTE name for SFNode field named fogCoord.- See Also:
- Constant Field Values
-
toField_FOGCOORD
public static final java.lang.String toField_FOGCOORDtoField ROUTE name for SFNode field named fogCoord.- 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
-
-
Constructor Details
-
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 Details
-
getElementName
public final java.lang.String getElementName()Provides name of this element: ElevationGrid- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the ElevationGrid element: Geometry3D- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 3- 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
-
getAttrib
Provide array of X3DVertexAttributeNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field attrib.
Tooltip: [X3DVertexAttributeNode] Single contained FloatVertexAttribute node that specifies list of per-vertex attribute information for programmable shaders.- Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shaders.html#Pervertexattributes
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVertexAttributeNode.- Specified by:
getAttrib
in interfaceElevationGrid
- Returns:
- value of attrib field
- See Also:
X3DVertexAttributeNode
-
getAttribList
Utility method to get ArrayList value of MFNode attrib field, similar togetAttrib()
.- Returns:
- value of attrib field
-
setAttrib
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.- Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shaders.html#Pervertexattributes
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVertexAttributeNode.- Specified by:
setAttrib
in interfaceElevationGrid
- 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).
-
setAttrib
Assign ArrayList value of MFNode attrib field, similar tosetAttrib(X3DNode[])
.- 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
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
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
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 interfaceElevationGrid
- Parameters:
newValue
- is new value array to be appended the attrib field.
-
setAttrib
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 interfaceElevationGrid
- Parameters:
newValue
- is new node for the attrib field (restricted to X3DVertexAttributeNode)
-
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 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 interfaceElevationGrid
- 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 interfaceElevationGrid
- 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
Assign typed object value to SFBool ccw field, similar tosetCcw(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
Provide X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.- Specified by:
getColor
in interfaceElevationGrid
- 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 interfaceElevationGrid
- 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:
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:
ElevationGridObject
- 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:
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()
-
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 interfaceElevationGrid
- 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 interfaceElevationGrid
- 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).
-
setColorPerVertex
Assign typed object value to SFBool colorPerVertex field, similar tosetColorPerVertex(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.- Hint: creaseAngle=0 means render all edges sharply, creaseAngle=3.14159 means render all edges smoothly.
- Hint: https://en.wikipedia.org/wiki/Radian
- Specified by:
getCreaseAngle
in interfaceElevationGrid
- Returns:
- value of creaseAngle field
-
setCreaseAngle
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.- Hint: creaseAngle=0 means render all edges sharply, creaseAngle=3.14159 means render all edges smoothly.
- Hint: https://en.wikipedia.org/wiki/Radian
- Specified by:
setCreaseAngle
in interfaceElevationGrid
- 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
Assign typed object value to SFFloat creaseAngle field, similar tosetCreaseAngle(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
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetCreaseAngle(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
Provide FogCoordinateObject instance (using a properly typed node) from inputOutput SFNode field fogCoord.- Specified by:
getFogCoord
in interfaceElevationGrid
- Returns:
- value of fogCoord field
- See Also:
Tooltip: [FogCoordinate] Single contained FogCoordinate node that specifies depth parameters for fog in corresponding geometry. *
-
setFogCoord
Accessor method to assign FogCoordinateObject instance (using a properly typed node) to inputOutput SFNode field fogCoord.- Specified by:
setFogCoord
in interfaceElevationGrid
- 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:
Tooltip: [FogCoordinate] Single contained FogCoordinate node that specifies depth parameters for fog in corresponding geometry. *
-
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
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 interfaceElevationGrid
- 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 togetHeight()
.- Returns:
- value of height field
-
getHeightString
public java.lang.String getHeightString()Utility method to get String value of MFFloat height field, similar togetHeight()
.- Returns:
- value of height field
-
setHeight
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 interfaceElevationGrid
- 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
Assign typed object value to MFFloat height field, similar tosetHeight(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
Assign ArrayList value of MFFloat height field, similar tosetHeight(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
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
Assign floating-point array value of MFFloat height field, similar tosetHeight(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
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
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
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetHeight(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).
-
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:
ElevationGridObject
- 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:
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()
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceElevationGrid
- 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 interfaceElevationGrid
- 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:
ElevationGridObject
- 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:
ElevationGridObject
- 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:
ElevationGridObject
- 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 interfaceElevationGrid
- 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 interfaceElevationGrid
- 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:
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:
ElevationGridObject
- 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:
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 interfaceElevationGrid
- 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 interfaceElevationGrid
- 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
Assign typed object value to SFBool normalPerVertex field, similar tosetNormalPerVertex(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).- 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 interfaceElevationGrid
- 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 interfaceElevationGrid
- 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
Assign typed object value to SFBool solid field, similar tosetSolid(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
Provide X3DTextureCoordinateNode instance (using a properly typed node) from inputOutput SFNode field texCoord.- Specified by:
getTexCoord
in interfaceElevationGrid
- 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 interfaceElevationGrid
- Parameters:
newValue
- is new value for the texCoord field.- Returns:
ElevationGridObject
- 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:
ElevationGridObject
- 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:
ElevationGridObject
- 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 X direction.- Hint: total horizontal x-axis distance equals (xDimension-1) * xSpacing.
- Warning: xDimension < 2 means that ElevationGrid contains no quadrilaterals.
- Specified by:
getXDimension
in interfaceElevationGrid
- 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 X direction.- Hint: total horizontal x-axis distance equals (xDimension-1) * xSpacing.
- Warning: xDimension < 2 means that ElevationGrid contains no quadrilaterals.
- Specified by:
setXDimension
in interfaceElevationGrid
- 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
Assign typed object value to SFInt32 xDimension field, similar tosetXDimension(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 interfaceElevationGrid
- Returns:
- value of xSpacing field
-
setXSpacing
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 interfaceElevationGrid
- 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
Assign typed object value to SFFloat xSpacing field, similar tosetXSpacing(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
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetXSpacing(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 < 2 means that ElevationGrid contains no quadrilaterals.
- Specified by:
getZDimension
in interfaceElevationGrid
- 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 Z direction.- Hint: total horizontal z-axis distance equals (zDimension-1) * zSpacing.
- Warning: zDimension < 2 means that ElevationGrid contains no quadrilaterals.
- Specified by:
setZDimension
in interfaceElevationGrid
- 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
Assign typed object value to SFInt32 zDimension field, similar tosetZDimension(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 interfaceElevationGrid
- Returns:
- value of zSpacing field
-
setZSpacing
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 interfaceElevationGrid
- 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
Assign typed object value to SFFloat zSpacing field, similar tosetZSpacing(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
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetZSpacing(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).
-
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:
ElevationGridObject
- 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:
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 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:
ElevationGridObject
- 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:
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 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:
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
Assign typed object value to SFString cssClass field, similar tosetCssClass(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
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:
ElevationGridObject
- 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:
ElevationGridObject
- 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:
ElevationGridObject
- 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:
ElevationGridObject
- 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)
-