Class GeoLODObject

java.lang.Object
All Implemented Interfaces:
X3DChildNode, X3DNode, GeoLOD, X3DBoundedObject

public class GeoLODObject
extends X3DConcreteNode
implements GeoLOD
GeoLOD provides quadtree level-of-detail loading/unloading for multi-resolution terrains.

X3D node tooltip: [X3DChildNode,X3DBoundedObject] 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 http://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:
X3D Abstract Specification: GeoLOD, X3D Tooltips: GeoLOD, X3D Scene Authoring Hints
  • Field Details

    • NAME

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

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

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

      public static final float[] BBOXCENTER_DEFAULT_VALUE
      SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
    • BBOXSIZE_DEFAULT_VALUE

      public static final float[] BBOXSIZE_DEFAULT_VALUE
      SFVec3f 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_VALUE
      SFVec3d field named center has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax).
    • CHILD1URL_DEFAULT_VALUE

      public static final java.util.ArrayList<java.lang.String> CHILD1URL_DEFAULT_VALUE
      MFString field named child1Url has default value equal to an empty list.
    • CHILD2URL_DEFAULT_VALUE

      public static final java.util.ArrayList<java.lang.String> CHILD2URL_DEFAULT_VALUE
      MFString field named child2Url has default value equal to an empty list.
    • CHILD3URL_DEFAULT_VALUE

      public static final java.util.ArrayList<java.lang.String> CHILD3URL_DEFAULT_VALUE
      MFString field named child3Url has default value equal to an empty list.
    • CHILD4URL_DEFAULT_VALUE

      public static final java.util.ArrayList<java.lang.String> CHILD4URL_DEFAULT_VALUE
      MFString field named child4Url has default value equal to an empty list.
    • GEOORIGIN_DEFAULT_VALUE

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

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

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

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

      public static final float RANGE_DEFAULT_VALUE
      SFFloat field named range has default value 10f (Java syntax) or 10 (XML syntax).
      See Also:
      Constant Field Values
    • ROOTURL_DEFAULT_VALUE

      public static final java.util.ArrayList<java.lang.String> ROOTURL_DEFAULT_VALUE
      MFString field named rootUrl has default value equal to an empty list.
    • containerField_DEFAULT_VALUE

      public static final java.lang.String containerField_DEFAULT_VALUE
      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.
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
    • fromField_CHILDREN

      public static final java.lang.String fromField_CHILDREN
      fromField ROUTE name for MFNode field named children.
      See Also:
      Constant Field Values
    • fromField_IS

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

      public static final java.lang.String fromField_LEVEL_CHANGED
      fromField ROUTE name for SFInt32 field named level_changed.
      See Also:
      Constant Field Values
    • fromField_METADATA

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

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

    • GeoLODObject

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

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

      public final java.lang.String getComponent()
      Defines X3D component for the GeoLOD element: Geospatial
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element
    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 1
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element
    • getFieldType

      public java.lang.String getFieldType​(java.lang.String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
    • getAccessType

      public java.lang.String getAccessType​(java.lang.String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
    • 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 class X3DConcreteNode
      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 class X3DConcreteNode
    • 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.
      Specified by:
      getBboxCenter in interface GeoLOD
      Specified by:
      getBboxCenter in interface X3DBoundedObject
      Returns:
      value of bboxCenter field
    • setBboxCenter

      public GeoLODObject setBboxCenter​(float[] newValue)
      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.
      Specified by:
      setBboxCenter in interface GeoLOD
      Specified by:
      setBboxCenter in interface X3DBoundedObject
      Parameters:
      newValue - is new value for the bboxCenter field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public GeoLODObject setBboxCenter​(SFVec3fObject newValue)
      Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
      Parameters:
      newValue - is new value for the bboxCenter field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public GeoLODObject setBboxCenter​(float x, float y, float z)
      Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public GeoLODObject setBboxCenter​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public GeoLODObject setBboxCenter​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      GeoLODObject - 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: 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.
      Specified by:
      getBboxSize in interface GeoLOD
      Specified by:
      getBboxSize in interface X3DBoundedObject
      Returns:
      value of bboxSize field
    • setBboxSize

      public GeoLODObject setBboxSize​(float[] newValue)
      Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.

      Tooltip: 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.
      Specified by:
      setBboxSize in interface GeoLOD
      Specified by:
      setBboxSize in interface X3DBoundedObject
      Parameters:
      newValue - is new value for the bboxSize field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

      public GeoLODObject setBboxSize​(SFVec3fObject newValue)
      Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
      Parameters:
      newValue - is new value for the bboxSize field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

      public GeoLODObject setBboxSize​(float x, float y, float z)
      Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

      public GeoLODObject setBboxSize​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

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

      public double[] getCenter()
      Provide array of 3-tuple double results from initializeOnly SFVec3d field named center.

      Tooltip: Viewer range from geographic-coordinates center triggers quadtree loading/unloading. *
      Specified by:
      getCenter in interface GeoLOD
      Returns:
      value of center field
    • setCenter

      public GeoLODObject setCenter​(double[] newValue)
      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. *
      Specified by:
      setCenter in interface GeoLOD
      Parameters:
      newValue - is new value for the center field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenter

      public GeoLODObject setCenter​(SFVec3dObject newValue)
      Assign typed object value to SFVec3d center field, similar to setCenter(double[]).
      Parameters:
      newValue - is new value for the center field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenter

      public GeoLODObject setCenter​(double x, double y, double z)
      Assign values to SFVec3d center field, similar to setCenter(double[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getChild1Url

      public java.lang.String[] 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 interface GeoLOD
      Returns:
      value of child1Url field
    • getChild1UrlList

      public java.util.ArrayList<java.lang.String> getChild1UrlList()
      Utility method to get ArrayList value of MFString child1Url field, similar to getChild1Url().
      Returns:
      value of child1Url field
    • setChild1Url

      public GeoLODObject setChild1Url​(java.lang.String[] newValue)
      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 interface GeoLOD
      Parameters:
      newValue - is new value for the child1Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setChild1Url

      public GeoLODObject setChild1Url​(MFStringObject newValue)
      Assign typed object value to MFString child1Url field, similar to setChild1Url(String[]).
      Parameters:
      newValue - is new value for the child1Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setChild1Url

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

      public GeoLODObject setChild1Url​(java.lang.String newValue)
      Assign singleton String value to MFString child1Url field, similar to setChild1Url(String[]).
      Parameters:
      newValue - is new value for the child1Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setChild1Url

      public GeoLODObject setChild1Url​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString child1Url field, similar to setChild1Url(String[]).
      Parameters:
      newValue - is new value for the child1Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearChild1Url

      public GeoLODObject clearChild1Url()
      Utility method to clear MFString value of child1Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addChild1Url

      public GeoLODObject addChild1Url​(java.lang.String newValue)
      Add singleton String value to MFString child1Url field.
      Parameters:
      newValue - is new value to add to the child1Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • addChild1Url

      public GeoLODObject addChild1Url​(SFStringObject newValue)
      Add singleton SFStringObject value to MFString child1Url field.
      Parameters:
      newValue - is new value to add to the child1Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • getChild2Url

      public java.lang.String[] 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 interface GeoLOD
      Returns:
      value of child2Url field
    • getChild2UrlList

      public java.util.ArrayList<java.lang.String> getChild2UrlList()
      Utility method to get ArrayList value of MFString child2Url field, similar to getChild2Url().
      Returns:
      value of child2Url field
    • setChild2Url

      public GeoLODObject setChild2Url​(java.lang.String[] newValue)
      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 interface GeoLOD
      Parameters:
      newValue - is new value for the child2Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setChild2Url

      public GeoLODObject setChild2Url​(MFStringObject newValue)
      Assign typed object value to MFString child2Url field, similar to setChild2Url(String[]).
      Parameters:
      newValue - is new value for the child2Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setChild2Url

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

      public GeoLODObject setChild2Url​(java.lang.String newValue)
      Assign singleton String value to MFString child2Url field, similar to setChild2Url(String[]).
      Parameters:
      newValue - is new value for the child2Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setChild2Url

      public GeoLODObject setChild2Url​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString child2Url field, similar to setChild2Url(String[]).
      Parameters:
      newValue - is new value for the child2Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearChild2Url

      public GeoLODObject clearChild2Url()
      Utility method to clear MFString value of child2Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addChild2Url

      public GeoLODObject addChild2Url​(java.lang.String newValue)
      Add singleton String value to MFString child2Url field.
      Parameters:
      newValue - is new value to add to the child2Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • addChild2Url

      public GeoLODObject addChild2Url​(SFStringObject newValue)
      Add singleton SFStringObject value to MFString child2Url field.
      Parameters:
      newValue - is new value to add to the child2Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • getChild3Url

      public java.lang.String[] 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 interface GeoLOD
      Returns:
      value of child3Url field
    • getChild3UrlList

      public java.util.ArrayList<java.lang.String> getChild3UrlList()
      Utility method to get ArrayList value of MFString child3Url field, similar to getChild3Url().
      Returns:
      value of child3Url field
    • setChild3Url

      public GeoLODObject setChild3Url​(java.lang.String[] newValue)
      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 interface GeoLOD
      Parameters:
      newValue - is new value for the child3Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setChild3Url

      public GeoLODObject setChild3Url​(MFStringObject newValue)
      Assign typed object value to MFString child3Url field, similar to setChild3Url(String[]).
      Parameters:
      newValue - is new value for the child3Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setChild3Url

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

      public GeoLODObject setChild3Url​(java.lang.String newValue)
      Assign singleton String value to MFString child3Url field, similar to setChild3Url(String[]).
      Parameters:
      newValue - is new value for the child3Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setChild3Url

      public GeoLODObject setChild3Url​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString child3Url field, similar to setChild3Url(String[]).
      Parameters:
      newValue - is new value for the child3Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearChild3Url

      public GeoLODObject clearChild3Url()
      Utility method to clear MFString value of child3Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addChild3Url

      public GeoLODObject addChild3Url​(java.lang.String newValue)
      Add singleton String value to MFString child3Url field.
      Parameters:
      newValue - is new value to add to the child3Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • addChild3Url

      public GeoLODObject addChild3Url​(SFStringObject newValue)
      Add singleton SFStringObject value to MFString child3Url field.
      Parameters:
      newValue - is new value to add to the child3Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • getChild4Url

      public java.lang.String[] 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 interface GeoLOD
      Returns:
      value of child4Url field
    • getChild4UrlList

      public java.util.ArrayList<java.lang.String> getChild4UrlList()
      Utility method to get ArrayList value of MFString child4Url field, similar to getChild4Url().
      Returns:
      value of child4Url field
    • setChild4Url

      public GeoLODObject setChild4Url​(java.lang.String[] newValue)
      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 interface GeoLOD
      Parameters:
      newValue - is new value for the child4Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setChild4Url

      public GeoLODObject setChild4Url​(MFStringObject newValue)
      Assign typed object value to MFString child4Url field, similar to setChild4Url(String[]).
      Parameters:
      newValue - is new value for the child4Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setChild4Url

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

      public GeoLODObject setChild4Url​(java.lang.String newValue)
      Assign singleton String value to MFString child4Url field, similar to setChild4Url(String[]).
      Parameters:
      newValue - is new value for the child4Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setChild4Url

      public GeoLODObject setChild4Url​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString child4Url field, similar to setChild4Url(String[]).
      Parameters:
      newValue - is new value for the child4Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearChild4Url

      public GeoLODObject clearChild4Url()
      Utility method to clear MFString value of child4Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addChild4Url

      public GeoLODObject addChild4Url​(java.lang.String newValue)
      Add singleton String value to MFString child4Url field.
      Parameters:
      newValue - is new value to add to the child4Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • addChild4Url

      public GeoLODObject addChild4Url​(SFStringObject newValue)
      Add singleton SFStringObject value to MFString child4Url field.
      Parameters:
      newValue - is new value to add to the child4Url field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • getChildren

      public X3DNode[] getChildren()
      Provide array of X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) 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 interface GeoLOD
      Returns:
      value of children field
      See Also:
      X3DChildNode
    • getChildrenList

      public java.util.ArrayList<X3DNode> getChildrenList()
      Utility method to get ArrayList value of MFNode children field, similar to getChildren().
      Returns:
      value of children field
    • addComments

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

      public GeoLODObject addComments​(java.lang.String[] newComments)
      Add comments as String[] array to children field
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public GeoLODObject addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to children field
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getGeoOrigin

      public GeoOrigin getGeoOrigin()
      Provide GeoOriginObject instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.
      Specified by:
      getGeoOrigin in interface GeoLOD
      Returns:
      value of geoOrigin field
      See Also:
      getGeoOriginProtoInstance()
    • setGeoOrigin

      public GeoLODObject setGeoOrigin​(GeoOrigin newValue)
      Accessor method to assign GeoOriginObject instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.
      Specified by:
      setGeoOrigin in interface GeoLOD
      Parameters:
      newValue - is new value for the geoOrigin field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setGeoOrigin(ProtoInstanceObject)
    • clearGeoOrigin

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

      public GeoLODObject setGeoOrigin​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field geoOrigin.
      Parameters:
      newValue - is new value for the geoOrigin field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setGeoOrigin(GeoOrigin)
    • hasGeoOrigin

      public boolean hasGeoOrigin()
      Indicate whether an object is available for initializeOnly SFNode field geoOrigin.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getGeoOrigin(), getGeoOriginProtoInstance()
    • getGeoSystem

      public java.lang.String[] getGeoSystem()
      Provide array of String results from initializeOnly MFString field named geoSystem.

      Tooltip: Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted string parameters as appropriate for the type.
      Specified by:
      getGeoSystem in interface GeoLOD
      Returns:
      value of geoSystem field
    • getGeoSystemList

      public java.util.ArrayList<java.lang.String> getGeoSystemList()
      Utility method to get ArrayList value of MFString geoSystem field, similar to getGeoSystem().
      Returns:
      value of geoSystem field
    • setGeoSystem

      public GeoLODObject setGeoSystem​(java.lang.String[] newValue)
      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.
      Specified by:
      setGeoSystem in interface GeoLOD
      Parameters:
      newValue - is new value for the geoSystem field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGeoSystem

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

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

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

      public GeoLODObject setGeoSystem​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString geoSystem field, similar to setGeoSystem(String[]).
      Parameters:
      newValue - is new value for the geoSystem field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearGeoSystem

      public GeoLODObject clearGeoSystem()
      Utility method to clear MFString value of geoSystem field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addGeoSystem

      public GeoLODObject addGeoSystem​(java.lang.String newValue)
      Add singleton String value to MFString geoSystem field.
      Parameters:
      newValue - is new value to add to the geoSystem field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • addGeoSystem

      public GeoLODObject addGeoSystem​(SFStringObject newValue)
      Add singleton SFStringObject value to MFString geoSystem field.
      Parameters:
      newValue - is new value to add to the geoSystem field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • getIS

      public ISObject getIS()
      Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • setIS

      public GeoLODObject setIS​(ISObject newValue)
      Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      GeoLODObject - 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

      public GeoLODObject clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      GeoLODObject - 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()
    • 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.
      Specified by:
      getLevel in interface GeoLOD
      Returns:
      value of level_changed field
    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface GeoLOD
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public GeoLODObject setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface GeoLOD
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

      public GeoLODObject clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMetadata

      public GeoLODObject setMetadata​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      GeoLODObject - 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
    • 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.
      Specified by:
      getRange in interface GeoLOD
      Returns:
      value of range field
    • setRange

      public GeoLODObject setRange​(float newValue)
      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.
      Specified by:
      setRange in interface GeoLOD
      Parameters:
      newValue - is new value for the range field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRange

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

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

      public X3DNode[] getRootNode()
      Provide array of X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) 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 interface GeoLOD
      Returns:
      value of rootNode field
      See Also:
      X3DChildNode
    • getRootNodeList

      public java.util.ArrayList<X3DNode> getRootNodeList()
      Utility method to get ArrayList value of MFNode rootNode field, similar to getRootNode().
      Returns:
      value of rootNode field
    • setRootNode

      public GeoLODObject setRootNode​(X3DNode[] newValue)
      Accessor method to assign X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) 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 interface GeoLOD
      Parameters:
      newValue - is new value for the rootNode field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRootNode

      public GeoLODObject setRootNode​(java.util.ArrayList<X3DChildNode> newValue)
      Assign ArrayList value of MFNode rootNode field, similar to setRootNode(X3DNode[]).
      Parameters:
      newValue - is new value for the rootNode field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addRootNode

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

      public GeoLODObject addRootNode​(ProtoInstanceObject newValue)
      Add single ProtoInstanceObject (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:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addRootNode

      public void addRootNode​(X3DNode[] newValue)
      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 interface GeoLOD
      Parameters:
      newValue - is new value array to be appended the rootNode field.
    • setRootNode

      public void setRootNode​(X3DNode newValue)
      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 interface GeoLOD
      Parameters:
      newValue - is new node for the rootNode field (restricted to X3DChildNode)
    • clearRootNode

      public GeoLODObject clearRootNode()
      Utility method to clear MFNode value of rootNode field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • 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:
      getRootNode()
    • getRootUrl

      public java.lang.String[] 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 interface GeoLOD
      Returns:
      value of rootUrl field
    • getRootUrlList

      public java.util.ArrayList<java.lang.String> getRootUrlList()
      Utility method to get ArrayList value of MFString rootUrl field, similar to getRootUrl().
      Returns:
      value of rootUrl field
    • setRootUrl

      public GeoLODObject setRootUrl​(java.lang.String[] newValue)
      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 interface GeoLOD
      Parameters:
      newValue - is new value for the rootUrl field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRootUrl

      public GeoLODObject setRootUrl​(MFStringObject newValue)
      Assign typed object value to MFString rootUrl field, similar to setRootUrl(String[]).
      Parameters:
      newValue - is new value for the rootUrl field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRootUrl

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

      public GeoLODObject setRootUrl​(java.lang.String newValue)
      Assign singleton String value to MFString rootUrl field, similar to setRootUrl(String[]).
      Parameters:
      newValue - is new value for the rootUrl field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRootUrl

      public GeoLODObject setRootUrl​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString rootUrl field, similar to setRootUrl(String[]).
      Parameters:
      newValue - is new value for the rootUrl field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearRootUrl

      public GeoLODObject clearRootUrl()
      Utility method to clear MFString value of rootUrl field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addRootUrl

      public GeoLODObject addRootUrl​(java.lang.String newValue)
      Add singleton String value to MFString rootUrl field.
      Parameters:
      newValue - is new value to add to the rootUrl field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • addRootUrl

      public GeoLODObject addRootUrl​(SFStringObject newValue)
      Add singleton SFStringObject value to MFString rootUrl field.
      Parameters:
      newValue - is new value to add to the rootUrl field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • 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.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

      public final GeoLODObject setDEF​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

      public GeoLODObject setDEF​(SFStringObject newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getUSE

      public java.lang.String getUSE()
      Provide String value from inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setUSE

      public final GeoLODObject setUSE​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.


      Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

      Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Specified by:
      setUSE in class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public GeoLODObject setUSE​(SFStringObject newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCssClass

      public java.lang.String getCssClass()
      Provide String value from inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final GeoLODObject setCssClass​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

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

      public GeoLODObject setUSE​(GeoLODObject DEFnode)
      Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

      Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Parameters:
      DEFnode - must have a DEF value defined
      Returns:
      GeoLODObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • 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 class X3DConcreteElement
      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 class X3DConcreteElement
      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 class X3DConcreteElement
      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

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • hasElementByNameValue

      public boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:
      findElementByNameValue(String, String)
    • findNodeByDEF

      public 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.

      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 class X3DConcreteElement
      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 class X3DConcreteElement
      Returns:
      validation results (if any)