Package org.web3d.x3d.jsail.Geospatial
Class GeoLOD
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Geospatial.GeoLOD
- All Implemented Interfaces:
X3DChildNode
,X3DNode
,GeoLOD
,X3DBoundedObject
Note that MFNode rootNode field can contain multiple nodes and has accessType inputOutput. Meanwhile MFNode children field is outputOnly, unlike other X3DGroupingNode exemplars.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
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.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail
classes.
GeoLOD node tooltip: [X3DChildNode,X3DBoundedObject,X3DVisibleObject] GeoLOD provides quadtree level-of-detail loading/unloading for multi-resolution terrains. GeoLOD can contain children and GeoOrigin nodes.
- Hint: children nodes expose the scene graph for the currently loaded set of nodes.
- Hint: rootNode specifies the geometry of the root tile.
- Warning: do not use rootUrl and rootNode simultaneously, since each specifies the root tile.
- Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
- Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>
- Warning: nested LOD (and/or GeoLOD) nodes with overlapping range intervals can lead to unexpected or undefined behavior.
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final float[]
SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static final boolean
SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).static final float[]
SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).static final double[]
SFVec3d field named center has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax).MFString field named child1Url has default value equal to an empty list.MFString field named child2Url has default value equal to an empty list.MFString field named child3Url has default value equal to an empty list.MFString field named child4Url has default value equal to an empty list.static final String
String constant COMPONENT defines X3D component for the GeoLOD element: Geospatialstatic final String
containerField describes typical field relationship of a node to its parent.static final String
fromField ROUTE name for SFBool field named bboxDisplay.static final String
fromField ROUTE name for MFNode field named children.static final String
fromField ROUTE name for SFNode field named IS.static final String
fromField ROUTE name for SFInt32 field named level_changed.static final String
fromField ROUTE name for SFNode field named metadata.static final String
fromField ROUTE name for SFBool field named visible.static final GeoOrigin
SFNode field named geoOrigin has default value null (Java syntax) or NULL (XML syntax).MFString field named geoSystem has default quoted value new String[] {"GD","WE"} (Java syntax) or quoted value "GD" "WE" (XML syntax).static final IS
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static final int
Integer constant LEVEL provides default X3D Geospatial component level for this element: 1static final X3DMetadataObject
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static final String
String constant NAME provides name of this element: GeoLOD.static final float
SFFloat field named range has default value 10f (Java syntax) or 10 (XML syntax).MFString field named rootUrl has default value equal to an empty list.static final String
toField ROUTE name for SFBool field named bboxDisplay.static final String
toField ROUTE name for SFNode field named metadata.static final String
toField ROUTE name for SFBool field named visible.static final boolean
SFBool field named visible has default value true (Java syntax) or true (XML syntax).Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddChild1Url
(String newValue) Add singleton String value to MFString child1Url field.addChild1Url
(SFString newValue) Add singleton SFString value to MFString child1Url field.addChild2Url
(String newValue) Add singleton String value to MFString child2Url field.addChild2Url
(SFString newValue) Add singleton SFString value to MFString child2Url field.addChild3Url
(String newValue) Add singleton String value to MFString child3Url field.addChild3Url
(SFString newValue) Add singleton SFString value to MFString child3Url field.addChild4Url
(String newValue) Add singleton String value to MFString child4Url field.addChild4Url
(SFString newValue) Add singleton SFString value to MFString child4Url field.addComments
(String newComment) Add comment as CommentsBlock to children fieldaddComments
(String[] newComments) Add comments as String[] array to children fieldaddComments
(CommentsBlock newCommentsBlock) Add CommentsBlock to children fieldaddGeoSystem
(String newValue) Add singleton String value to MFString geoSystem field.addGeoSystem
(SFString newValue) Add singleton SFString value to MFString geoSystem field.addRootNode
(ProtoInstance newValue) Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for rootNode field.addRootNode
(X3DNode newValue) Add single child node to existing array of rootNode nodes (if any).void
addRootNode
(X3DNode[] newValue) Add array of child rootNode nodes to array of existing nodes (if any).addRootUrl
(String newValue) Add singleton String value to MFString rootUrl field.addRootUrl
(SFString newValue) Add singleton SFString value to MFString rootUrl field.Utility method to clear MFString value of child1Url field.Utility method to clear MFString value of child2Url field.Utility method to clear MFString value of child3Url field.Utility method to clear MFString value of child4Url field.Utility method to clear SFNode value of geoOrigin field.Utility method to clear MFString value of geoSystem field.clearIS()
Utility method to clear SFNode value of IS field.Utility method to clear SFNode value of metadata field.Utility method to clear MFNode value of rootNode field.Utility method to clear MFString value of rootUrl field.findElementByNameValue
(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.findElementByNameValue
(String nameValue, 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.findNodeByDEF
(String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.getAccessType
(String fieldName) Indicate accessType corresponding to given fieldName.float[]
Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.boolean
Provide boolean value from inputOutput SFBool field named bboxDisplay.float[]
Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.double[]
Provide array of 3-tuple double results from initializeOnly SFVec3d field named center.String[]
Provide array of String results from initializeOnly MFString field named child1Url.Utility method to get ArrayList value of MFString child1Url field, similar togetChild1Url()
.Utility method to get String value of MFString child1Url field, similar togetChild1Url()
.String[]
Provide array of String results from initializeOnly MFString field named child2Url.Utility method to get ArrayList value of MFString child2Url field, similar togetChild2Url()
.Utility method to get String value of MFString child2Url field, similar togetChild2Url()
.String[]
Provide array of String results from initializeOnly MFString field named child3Url.Utility method to get ArrayList value of MFString child3Url field, similar togetChild3Url()
.Utility method to get String value of MFString child3Url field, similar togetChild3Url()
.String[]
Provide array of String results from initializeOnly MFString field named child4Url.Utility method to get ArrayList value of MFString child4Url field, similar togetChild4Url()
.Utility method to get String value of MFString child4Url field, similar togetChild4Url()
.X3DNode[]
Provide array of org.web3d.x3d.sai.Core.X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstances) from outputOnly MFNode field children.Utility method to get ArrayList value of MFNode children field, similar togetChildren()
.final String
Defines X3D component for the GeoLOD element: Geospatialfinal int
Provides default X3D component level for this element: 1final String
containerField describes typical field relationship of a node to its parent.Provide String value from inputOutput SFString field named class.Provide String value from inputOutput SFString field named style.getDEF()
Provide String value from inputOutput SFString field named DEF.final String
Provides name of this element: GeoLODgetFieldType
(String fieldName) Indicate type corresponding to given fieldName.Provide org.web3d.x3d.sai.Geospatial.GeoOrigin instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.String[]
Provide array of String results from initializeOnly MFString field named geoSystem.Utility method to get ArrayList value of MFString geoSystem field, similar togetGeoSystem()
.Utility method to get String value of MFString geoSystem field, similar togetGeoSystem()
.Provide String value from inputOutput SFString field named id.getIS()
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.int
getLevel()
Provide int value within allowed range of [0,1] from outputOnly SFInt32 field named level_changed.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.float
getRange()
Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named range.X3DNode[]
Provide array of org.web3d.x3d.sai.Core.X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstances) from initializeOnly MFNode field rootNode.Utility method to get ArrayList value of MFNode rootNode field, similar togetRootNode()
.String[]
Provide array of String results from initializeOnly MFString field named rootUrl.Utility method to get ArrayList value of MFString rootUrl field, similar togetRootUrl()
.Utility method to get String value of MFString rootUrl field, similar togetRootUrl()
.getUSE()
Provide String value from inputOutput SFString field named USE.boolean
Provide boolean value from inputOutput SFBool field named visible.boolean
hasElementByNameValue
(String nameValue, 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
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
Indicate whether an object is available for inputOutput SFNode field metadata.boolean
hasNodeByDEF
(String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.boolean
Indicate whether an object is available for initializeOnly MFNode field rootNode.final void
Initialize all member variables to default values.setBboxCenter
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.setBboxCenter
(double x, double y, double z) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.setBboxCenter
(float[] newValue) Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.setBboxCenter
(float x, float y, float z) Assign values to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.setBboxCenter
(SFVec3f newValue) Assign typed object value to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.setBboxDisplay
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.setBboxDisplay
(SFBool newValue) Assign typed object value to SFBool bboxDisplay field, similar tosetBboxDisplay(boolean)
.setBboxSize
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxSize(float[])
.setBboxSize
(double x, double y, double z) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxSize(float[])
.setBboxSize
(float[] newValue) Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.setBboxSize
(float x, float y, float z) Assign values to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.setBboxSize
(SFVec3f newValue) Assign typed object value to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.setCenter
(double[] newValue) Accessor method to assign 3-tuple double array to initializeOnly SFVec3d field named center.setCenter
(double x, double y, double z) Assign values to SFVec3d center field, similar tosetCenter(double[])
.Assign typed object value to SFVec3d center field, similar tosetCenter(double[])
.setChild1Url
(String newValue) Assign singleton String value to MFString child1Url field, similar tosetChild1Url(String[])
.setChild1Url
(String[] newValue) Accessor method to assign String array to initializeOnly MFString field named child1Url.setChild1Url
(ArrayList<String> newValue) Assign ArrayList value of MFString child1Url field, similar tosetChild1Url(String[])
.setChild1Url
(MFString newValue) Assign typed object value to MFString child1Url field, similar tosetChild1Url(String[])
.setChild1Url
(SFString newValue) Assign single SFString object value to MFString child1Url field, similar tosetChild1Url(String[])
.setChild2Url
(String newValue) Assign singleton String value to MFString child2Url field, similar tosetChild2Url(String[])
.setChild2Url
(String[] newValue) Accessor method to assign String array to initializeOnly MFString field named child2Url.setChild2Url
(ArrayList<String> newValue) Assign ArrayList value of MFString child2Url field, similar tosetChild2Url(String[])
.setChild2Url
(MFString newValue) Assign typed object value to MFString child2Url field, similar tosetChild2Url(String[])
.setChild2Url
(SFString newValue) Assign single SFString object value to MFString child2Url field, similar tosetChild2Url(String[])
.setChild3Url
(String newValue) Assign singleton String value to MFString child3Url field, similar tosetChild3Url(String[])
.setChild3Url
(String[] newValue) Accessor method to assign String array to initializeOnly MFString field named child3Url.setChild3Url
(ArrayList<String> newValue) Assign ArrayList value of MFString child3Url field, similar tosetChild3Url(String[])
.setChild3Url
(MFString newValue) Assign typed object value to MFString child3Url field, similar tosetChild3Url(String[])
.setChild3Url
(SFString newValue) Assign single SFString object value to MFString child3Url field, similar tosetChild3Url(String[])
.setChild4Url
(String newValue) Assign singleton String value to MFString child4Url field, similar tosetChild4Url(String[])
.setChild4Url
(String[] newValue) Accessor method to assign String array to initializeOnly MFString field named child4Url.setChild4Url
(ArrayList<String> newValue) Assign ArrayList value of MFString child4Url field, similar tosetChild4Url(String[])
.setChild4Url
(MFString newValue) Assign typed object value to MFString child4Url field, similar tosetChild4Url(String[])
.setChild4Url
(SFString newValue) Assign single SFString object value to MFString child4Url field, similar tosetChild4Url(String[])
.final GeoLOD
setCssClass
(String newValue) Accessor method to assign String value to inputOutput SFString field named class.setCssClass
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.final GeoLOD
setCssStyle
(String newValue) Accessor method to assign String value to inputOutput SFString field named style.setCssStyle
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.final GeoLOD
Accessor method to assign String value to inputOutput SFString field named DEF.Assign typed object value to SFString DEF field, similar tosetDEF(String)
.setGeoOrigin
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field geoOrigin.setGeoOrigin
(GeoOrigin newValue) Accessor method to assign org.web3d.x3d.sai.Geospatial.GeoOrigin instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.setGeoSystem
(String newValue) Assign singleton String value to MFString geoSystem field, similar tosetGeoSystem(String[])
.setGeoSystem
(String[] newValue) Accessor method to assign String array to initializeOnly MFString field named geoSystem.setGeoSystem
(ArrayList<String> newValue) Assign ArrayList value of MFString geoSystem field, similar tosetGeoSystem(String[])
.setGeoSystem
(MFString newValue) Assign typed object value to MFString geoSystem field, similar tosetGeoSystem(String[])
.setGeoSystem
(SFString newValue) Assign single SFString object value to MFString geoSystem field, similar tosetGeoSystem(String[])
.final GeoLOD
Accessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.setMetadata
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setRange
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetRange(float)
.setRange
(float newValue) Accessor method to assign float value to initializeOnly SFFloat field named range.Assign typed object value to SFFloat range field, similar tosetRange(float)
.setRootNode
(ArrayList<X3DChildNode> newValue) Assign ArrayList value of MFNode rootNode field, similar tosetRootNode(org.web3d.x3d.sai.Core.X3DNode[])
.void
setRootNode
(X3DNode newValue) Set single child rootNode node, replacing prior array of existing nodes (if any).setRootNode
(X3DNode[] newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstances) to initializeOnly MFNode field rootNode.setRootUrl
(String newValue) Assign singleton String value to MFString rootUrl field, similar tosetRootUrl(String[])
.setRootUrl
(String[] newValue) Accessor method to assign String array to initializeOnly MFString field named rootUrl.setRootUrl
(ArrayList<String> newValue) Assign ArrayList value of MFString rootUrl field, similar tosetRootUrl(String[])
.setRootUrl
(MFString newValue) Assign typed object value to MFString rootUrl field, similar tosetRootUrl(String[])
.setRootUrl
(SFString newValue) Assign single SFString object value to MFString rootUrl field, similar tosetRootUrl(String[])
.final GeoLOD
Accessor method to assign String value to inputOutput SFString field named USE.Assign typed object value to SFString USE field, similar tosetUSE(String)
.Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.setVisible
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named visible.setVisible
(SFBool newValue) Assign typed object value to SFBool visible field, similar tosetVisible(boolean)
.toStringClassicVRML
(int indentLevel) Recursive method to provide ClassicVRML string serialization.toStringVRML97
(int indentLevel) Recursive method to provide VRML97 string serialization.toStringX3D
(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.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
getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
String constant NAME provides name of this element: GeoLOD.- See Also:
-
COMPONENT
String constant COMPONENT defines X3D component for the GeoLOD element: Geospatial- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Geospatial component level for this element: 1- See Also:
-
BBOXCENTER_DEFAULT_VALUE
public static final float[] BBOXCENTER_DEFAULT_VALUESFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
BBOXDISPLAY_DEFAULT_VALUE
public static final boolean BBOXDISPLAY_DEFAULT_VALUESFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).- See Also:
-
BBOXSIZE_DEFAULT_VALUE
public static final float[] BBOXSIZE_DEFAULT_VALUESFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax). -
CENTER_DEFAULT_VALUE
public static final double[] CENTER_DEFAULT_VALUESFVec3d field named center has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax). -
CHILD1URL_DEFAULT_VALUE
-
CHILD2URL_DEFAULT_VALUE
-
CHILD3URL_DEFAULT_VALUE
-
CHILD4URL_DEFAULT_VALUE
-
GEOORIGIN_DEFAULT_VALUE
SFNode field named geoOrigin has default value null (Java syntax) or NULL (XML syntax). -
GEOSYSTEM_DEFAULT_VALUE
-
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). -
RANGE_DEFAULT_VALUE
public static final float RANGE_DEFAULT_VALUESFFloat field named range has default value 10f (Java syntax) or 10 (XML syntax).- See Also:
-
ROOTURL_DEFAULT_VALUE
-
VISIBLE_DEFAULT_VALUE
public static final boolean VISIBLE_DEFAULT_VALUESFBool field named visible has default value true (Java syntax) or true (XML syntax).- See Also:
-
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "children";
containerField_ALLOWED_VALUES = {"children" }; type xs:NMTOKEN- See Also:
-
fromField_BBOXDISPLAY
fromField ROUTE name for SFBool field named bboxDisplay.- See Also:
-
toField_BBOXDISPLAY
toField ROUTE name for SFBool field named bboxDisplay.- See Also:
-
fromField_CHILDREN
fromField ROUTE name for MFNode field named children.- See Also:
-
fromField_IS
-
fromField_LEVEL_CHANGED
fromField ROUTE name for SFInt32 field named level_changed.- See Also:
-
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.- See Also:
-
toField_METADATA
toField ROUTE name for SFNode field named metadata.- See Also:
-
fromField_VISIBLE
fromField ROUTE name for SFBool field named visible.- See Also:
-
toField_VISIBLE
toField ROUTE name for SFBool field named visible.- See Also:
-
-
Constructor Details
-
GeoLOD
public GeoLOD()Constructor for GeoLOD to initialize member variables with default values. -
GeoLOD
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
Provides name of this element: GeoLOD- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
Defines X3D component for the GeoLOD 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
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:
-
getAccessType
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:
-
getContainerFieldDefault
containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getBboxCenter
public float[] getBboxCenter()Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.- Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
- Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
- Specified by:
getBboxCenter
in interfaceGeoLOD
- Specified by:
getBboxCenter
in interfaceX3DBoundedObject
- Returns:
- value of bboxCenter field
-
setBboxCenter
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.- Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
- Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
- Specified by:
setBboxCenter
in interfaceGeoLOD
- Specified by:
setBboxCenter
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the bboxCenter field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Assign typed object value to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.- Parameters:
newValue
- is new value for the bboxCenter field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Assign values to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.- Parameters:
newArray
- is new value for field- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBboxDisplay
public boolean getBboxDisplay()Provide boolean value from inputOutput SFBool field named bboxDisplay.
Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.- Hint: the bounding box is displayed regardless of whether contained content is visible.
- Specified by:
getBboxDisplay
in interfaceGeoLOD
- Specified by:
getBboxDisplay
in interfaceX3DBoundedObject
- Returns:
- value of bboxDisplay field
-
setBboxDisplay
Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.- Hint: the bounding box is displayed regardless of whether contained content is visible.
- Specified by:
setBboxDisplay
in interfaceGeoLOD
- Specified by:
setBboxDisplay
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the bboxDisplay field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxDisplay
Assign typed object value to SFBool bboxDisplay field, similar tosetBboxDisplay(boolean)
.- Parameters:
newValue
- is new value for the bboxDisplay field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBboxSize
public float[] getBboxSize()Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
Tooltip: or [0,+infinity) Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.- Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
- Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
- Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
- Specified by:
getBboxSize
in interfaceGeoLOD
- Specified by:
getBboxSize
in interfaceX3DBoundedObject
- Returns:
- value of bboxSize field
-
setBboxSize
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
Tooltip: or [0,+infinity) Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.- Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
- Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
- Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
- Specified by:
setBboxSize
in interfaceGeoLOD
- Specified by:
setBboxSize
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the bboxSize field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Assign typed object value to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.- Parameters:
newValue
- is new value for the bboxSize field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Assign values to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxSize(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxSize(float[])
.- Parameters:
newArray
- is new value for field- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCenter
-
setCenter
Accessor method to assign 3-tuple double array to initializeOnly SFVec3d field named center.
Tooltip: Viewer range from geographic-coordinates center triggers quadtree loading/unloading. * -
setCenter
Assign typed object value to SFVec3d center field, similar tosetCenter(double[])
.- Parameters:
newValue
- is new value for the center field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCenter
Assign values to SFVec3d center field, similar tosetCenter(double[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getChild1Url
Provide array of String results from initializeOnly MFString field named child1Url.
Tooltip: quadtree geometry loaded when viewer is within range. *- Specified by:
getChild1Url
in interfaceGeoLOD
- Returns:
- value of child1Url field
-
getChild1UrlList
Utility method to get ArrayList value of MFString child1Url field, similar togetChild1Url()
.- Returns:
- value of child1Url field
-
getChild1UrlString
Utility method to get String value of MFString child1Url field, similar togetChild1Url()
.- Returns:
- value of child1Url field
-
setChild1Url
Accessor method to assign String array to initializeOnly MFString field named child1Url.
Tooltip: quadtree geometry loaded when viewer is within range. *- Specified by:
setChild1Url
in interfaceGeoLOD
- Parameters:
newValue
- is new value for the child1Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setChild1Url
Assign typed object value to MFString child1Url field, similar tosetChild1Url(String[])
.- Parameters:
newValue
- is new value for the child1Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setChild1Url
Assign single SFString object value to MFString child1Url field, similar tosetChild1Url(String[])
.- Parameters:
newValue
- is new value for the child1Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setChild1Url
Assign singleton String value to MFString child1Url field, similar tosetChild1Url(String[])
.- Parameters:
newValue
- is new value for the child1Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setChild1Url
Assign ArrayList value of MFString child1Url field, similar tosetChild1Url(String[])
.- Parameters:
newValue
- is new value for the child1Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearChild1Url
-
addChild1Url
Add singleton String value to MFString child1Url field.- Parameters:
newValue
- is new value to add to the child1Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addChild1Url
Add singleton SFString value to MFString child1Url field.- Parameters:
newValue
- is new value to add to the child1Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getChild2Url
Provide array of String results from initializeOnly MFString field named child2Url.
Tooltip: quadtree geometry loaded when viewer is within range. *- Specified by:
getChild2Url
in interfaceGeoLOD
- Returns:
- value of child2Url field
-
getChild2UrlList
Utility method to get ArrayList value of MFString child2Url field, similar togetChild2Url()
.- Returns:
- value of child2Url field
-
getChild2UrlString
Utility method to get String value of MFString child2Url field, similar togetChild2Url()
.- Returns:
- value of child2Url field
-
setChild2Url
Accessor method to assign String array to initializeOnly MFString field named child2Url.
Tooltip: quadtree geometry loaded when viewer is within range. *- Specified by:
setChild2Url
in interfaceGeoLOD
- Parameters:
newValue
- is new value for the child2Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setChild2Url
Assign typed object value to MFString child2Url field, similar tosetChild2Url(String[])
.- Parameters:
newValue
- is new value for the child2Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setChild2Url
Assign single SFString object value to MFString child2Url field, similar tosetChild2Url(String[])
.- Parameters:
newValue
- is new value for the child2Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setChild2Url
Assign singleton String value to MFString child2Url field, similar tosetChild2Url(String[])
.- Parameters:
newValue
- is new value for the child2Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setChild2Url
Assign ArrayList value of MFString child2Url field, similar tosetChild2Url(String[])
.- Parameters:
newValue
- is new value for the child2Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearChild2Url
-
addChild2Url
Add singleton String value to MFString child2Url field.- Parameters:
newValue
- is new value to add to the child2Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addChild2Url
Add singleton SFString value to MFString child2Url field.- Parameters:
newValue
- is new value to add to the child2Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getChild3Url
Provide array of String results from initializeOnly MFString field named child3Url.
Tooltip: quadtree geometry loaded when viewer is within range. *- Specified by:
getChild3Url
in interfaceGeoLOD
- Returns:
- value of child3Url field
-
getChild3UrlList
Utility method to get ArrayList value of MFString child3Url field, similar togetChild3Url()
.- Returns:
- value of child3Url field
-
getChild3UrlString
Utility method to get String value of MFString child3Url field, similar togetChild3Url()
.- Returns:
- value of child3Url field
-
setChild3Url
Accessor method to assign String array to initializeOnly MFString field named child3Url.
Tooltip: quadtree geometry loaded when viewer is within range. *- Specified by:
setChild3Url
in interfaceGeoLOD
- Parameters:
newValue
- is new value for the child3Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setChild3Url
Assign typed object value to MFString child3Url field, similar tosetChild3Url(String[])
.- Parameters:
newValue
- is new value for the child3Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setChild3Url
Assign single SFString object value to MFString child3Url field, similar tosetChild3Url(String[])
.- Parameters:
newValue
- is new value for the child3Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setChild3Url
Assign singleton String value to MFString child3Url field, similar tosetChild3Url(String[])
.- Parameters:
newValue
- is new value for the child3Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setChild3Url
Assign ArrayList value of MFString child3Url field, similar tosetChild3Url(String[])
.- Parameters:
newValue
- is new value for the child3Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearChild3Url
-
addChild3Url
Add singleton String value to MFString child3Url field.- Parameters:
newValue
- is new value to add to the child3Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addChild3Url
Add singleton SFString value to MFString child3Url field.- Parameters:
newValue
- is new value to add to the child3Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getChild4Url
Provide array of String results from initializeOnly MFString field named child4Url.
Tooltip: quadtree geometry loaded when viewer is within range. *- Specified by:
getChild4Url
in interfaceGeoLOD
- Returns:
- value of child4Url field
-
getChild4UrlList
Utility method to get ArrayList value of MFString child4Url field, similar togetChild4Url()
.- Returns:
- value of child4Url field
-
getChild4UrlString
Utility method to get String value of MFString child4Url field, similar togetChild4Url()
.- Returns:
- value of child4Url field
-
setChild4Url
Accessor method to assign String array to initializeOnly MFString field named child4Url.
Tooltip: quadtree geometry loaded when viewer is within range. *- Specified by:
setChild4Url
in interfaceGeoLOD
- Parameters:
newValue
- is new value for the child4Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setChild4Url
Assign typed object value to MFString child4Url field, similar tosetChild4Url(String[])
.- Parameters:
newValue
- is new value for the child4Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setChild4Url
Assign single SFString object value to MFString child4Url field, similar tosetChild4Url(String[])
.- Parameters:
newValue
- is new value for the child4Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setChild4Url
Assign singleton String value to MFString child4Url field, similar tosetChild4Url(String[])
.- Parameters:
newValue
- is new value for the child4Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setChild4Url
Assign ArrayList value of MFString child4Url field, similar tosetChild4Url(String[])
.- Parameters:
newValue
- is new value for the child4Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearChild4Url
-
addChild4Url
Add singleton String value to MFString child4Url field.- Parameters:
newValue
- is new value to add to the child4Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addChild4Url
Add singleton SFString value to MFString child4Url field.- Parameters:
newValue
- is new value to add to the child4Url field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getChildren
Provide array of org.web3d.x3d.sai.Core.X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstances) from outputOnly MFNode field children.
Tooltip: [X3DChildNode] The outputOnly children field exposes a portion of the scene graph for the currently loaded set of nodes. The value returned as an event is an MFNode containing the currently selected tile. This will either be the node specified by the rootNode field or the nodes specified by the child1Url, child2Url, child3Url, and child4Url fields. The GeoLOD node shall generate a new children output event each time the scene graph is changed (EXAMPLE whenever nodes are loaded or unloaded).- Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.- Specified by:
getChildren
in interfaceGeoLOD
- Returns:
- value of children field
- See Also:
-
getChildrenList
Utility method to get ArrayList value of MFNode children field, similar togetChildren()
.- Returns:
- value of children field
-
addComments
Add comment as CommentsBlock to children field- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to children field- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to children field- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getGeoOrigin
Provide org.web3d.x3d.sai.Geospatial.GeoOrigin instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.- Specified by:
getGeoOrigin
in interfaceGeoLOD
- Returns:
- value of geoOrigin field
- See Also:
-
setGeoOrigin
Accessor method to assign org.web3d.x3d.sai.Geospatial.GeoOrigin instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.- Specified by:
setGeoOrigin
in interfaceGeoLOD
- Parameters:
newValue
- is new value for the geoOrigin field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearGeoOrigin
-
setGeoOrigin
Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field geoOrigin.- Parameters:
newValue
- is new value for the geoOrigin field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/geospatial.html#Spatialreferenceframes
- Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/geospatial.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 interfaceGeoLOD
- Returns:
- value of geoSystem field
-
getGeoSystemList
Utility method to get ArrayList value of MFString geoSystem field, similar togetGeoSystem()
.- Returns:
- value of geoSystem field
-
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/geospatial.html#Spatialreferenceframes
- Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/geospatial.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 interfaceGeoLOD
- Parameters:
newValue
- is new value for the geoSystem field.- Returns:
GeoLOD
- 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:
GeoLOD
- 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:
GeoLOD
- 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:
GeoLOD
- 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:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearGeoSystem
-
addGeoSystem
Add singleton String value to MFString geoSystem field.- Parameters:
newValue
- is new value to add to the geoSystem field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addGeoSystem
Add singleton SFString value to MFString geoSystem field.- Parameters:
newValue
- is new value to add to the geoSystem field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getIS
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
-
setIS
Accessor method to assign IS 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:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearIS
-
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:
-
getLevel
public int getLevel()Provide int value within allowed range of [0,1] from outputOnly SFInt32 field named level_changed.
Tooltip: Output event that reports when the new children outputOnly event is generated, with value 0 or 1, where 0 indicates the rootNode field and 1 indicates the nodes specified by the child1Url, child2Url, child3Url, and child4Url fields.- Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
-
getMetadata
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceGeoLOD
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceGeoLOD
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearMetadata
-
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:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
getRange
public float getRange()Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named range.
Tooltip: (0,+infinity) Viewer range from geographic-coordinates center triggers quadtree loading/unloading.- Hint: not setting range values indicates that level switching can be optimized automatically based on performance.
-
setRange
Accessor method to assign float value to initializeOnly SFFloat field named range.
Tooltip: (0,+infinity) Viewer range from geographic-coordinates center triggers quadtree loading/unloading.- Hint: not setting range values indicates that level switching can be optimized automatically based on performance.
-
setRange
Assign typed object value to SFFloat range field, similar tosetRange(float)
.- Parameters:
newValue
- is new value for the range field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRange
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetRange(float)
.- Parameters:
newValue
- is new value for field- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getRootNode
Provide array of org.web3d.x3d.sai.Core.X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstances) from initializeOnly MFNode field rootNode.
Tooltip: Geometry for the root tile.- Warning: either rootNode or rootUrl can specify root tile, but specifying both is an error.
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.- Specified by:
getRootNode
in interfaceGeoLOD
- Returns:
- value of rootNode field
- See Also:
-
getRootNodeList
Utility method to get ArrayList value of MFNode rootNode field, similar togetRootNode()
.- Returns:
- value of rootNode field
-
setRootNode
Accessor method to assign org.web3d.x3d.sai.Core.X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstances) to initializeOnly MFNode field rootNode.
Tooltip: Geometry for the root tile.- Warning: either rootNode or rootUrl can specify root tile, but specifying both is an error.
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.- Specified by:
setRootNode
in interfaceGeoLOD
- Parameters:
newValue
- is new value for the rootNode field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRootNode
Assign ArrayList value of MFNode rootNode field, similar tosetRootNode(org.web3d.x3d.sai.Core.X3DNode[])
.- Parameters:
newValue
- is new value for the rootNode field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addRootNode
Add single child node to existing array of rootNode nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode and ProtoInstance.- Parameters:
newValue
- is new value to be appended the rootNode field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addRootNode
Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for rootNode 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:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addRootNode
Add array of child rootNode nodes to array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.- Specified by:
addRootNode
in interfaceGeoLOD
- Parameters:
newValue
- is new value array to be appended the rootNode field.
-
setRootNode
Set single child rootNode node, replacing prior array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DChildNode.- Specified by:
setRootNode
in interfaceGeoLOD
- Parameters:
newValue
- is new node for the rootNode field (restricted to X3DChildNode)
-
clearRootNode
-
hasRootNode
public boolean hasRootNode()Indicate whether an object is available for initializeOnly MFNode field rootNode.- Returns:
- whether a properly typed node or ProtoInstance array or CommentsBlock is available.
- See Also:
-
getRootUrl
Provide array of String results from initializeOnly MFString field named rootUrl.
Tooltip: url for scene providing geometry for the root tile.- Warning: either rootNode or rootUrl can specify root tile, but specifying both is an error.
- Specified by:
getRootUrl
in interfaceGeoLOD
- Returns:
- value of rootUrl field
-
getRootUrlList
Utility method to get ArrayList value of MFString rootUrl field, similar togetRootUrl()
.- Returns:
- value of rootUrl field
-
getRootUrlString
Utility method to get String value of MFString rootUrl field, similar togetRootUrl()
.- Returns:
- value of rootUrl field
-
setRootUrl
Accessor method to assign String array to initializeOnly MFString field named rootUrl.
Tooltip: url for scene providing geometry for the root tile.- Warning: either rootNode or rootUrl can specify root tile, but specifying both is an error.
- Specified by:
setRootUrl
in interfaceGeoLOD
- Parameters:
newValue
- is new value for the rootUrl field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRootUrl
Assign typed object value to MFString rootUrl field, similar tosetRootUrl(String[])
.- Parameters:
newValue
- is new value for the rootUrl field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRootUrl
Assign single SFString object value to MFString rootUrl field, similar tosetRootUrl(String[])
.- Parameters:
newValue
- is new value for the rootUrl field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRootUrl
Assign singleton String value to MFString rootUrl field, similar tosetRootUrl(String[])
.- Parameters:
newValue
- is new value for the rootUrl field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRootUrl
Assign ArrayList value of MFString rootUrl field, similar tosetRootUrl(String[])
.- Parameters:
newValue
- is new value for the rootUrl field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearRootUrl
-
addRootUrl
Add singleton String value to MFString rootUrl field.- Parameters:
newValue
- is new value to add to the rootUrl field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addRootUrl
Add singleton SFString value to MFString rootUrl field.- Parameters:
newValue
- is new value to add to the rootUrl field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getVisible
public boolean getVisible()Provide boolean value from inputOutput SFBool field named visible.
Tooltip: Whether or not renderable content within this node is visually displayed.- Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
- Hint: content must be visible to be collidable and to be pickable.
- Specified by:
getVisible
in interfaceGeoLOD
- Specified by:
getVisible
in interfaceX3DBoundedObject
- Returns:
- value of visible field
-
setVisible
Accessor method to assign boolean value to inputOutput SFBool field named visible.
Tooltip: Whether or not renderable content within this node is visually displayed.- Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
- Hint: content must be visible to be collidable and to be pickable.
- Specified by:
setVisible
in interfaceGeoLOD
- Specified by:
setVisible
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the visible field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setVisible
Assign typed object value to SFBool visible field, similar tosetVisible(boolean)
.- Parameters:
newValue
- is new value for the visible field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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:
-
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:
GeoLOD
- 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:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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:
-
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:
GeoLOD
- 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:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
Provide String value from inputOutput SFString field named class.- Overrides:
getCssClass
in classX3DConcreteElement
- Returns:
- value of class field
- See Also:
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHtmlID
Provide String value from inputOutput SFString field named id.- Overrides:
getHtmlID
in classX3DConcreteElement
- Returns:
- value of id field
- See Also:
-
setHtmlID
Accessor method to assign String value to inputOutput SFString field named id.- Specified by:
setHtmlID
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the id field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setHtmlID
Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.- Parameters:
newValue
- is new value for the id field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssStyle
Provide String value from inputOutput SFString field named style.- Overrides:
getCssStyle
in classX3DConcreteElement
- Returns:
- value of style field
- See Also:
-
setCssStyle
Accessor method to assign String value to inputOutput SFString field named style.- Specified by:
setCssStyle
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the style field.- Returns:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssStyle
Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.- Parameters:
newValue
- is new value for the style field.- Returns:
GeoLOD
- 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:
GeoLOD
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
toStringX3D
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:
-
toStringClassicVRML
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:
-
toStringVRML97
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:
-
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 findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in 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:
-
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 findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in 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:
-
hasElementByNameValue
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:
-
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 findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in 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:
-
hasNodeByDEF
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:
-
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. TODO document specific validation methods.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-