Class GeoViewpoint

java.lang.Object
All Implemented Interfaces:
X3DBindableNode, X3DChildNode, X3DNode, GeoViewpoint, X3DViewpointNode

public class GeoViewpoint
extends X3DConcreteNode
implements GeoViewpoint
GeoViewpoint specifies viewpoints using geographic coordinates.

X3D node tooltip: [X3DViewpointNode] GeoViewpoint specifies viewpoints using geographic coordinates. GeoViewpoint can contain a GeoOrigin node. Since GeoViewpoint must navigate smoothly inside a curved geographic coordinate system, it includes both Viewpoint and NavigationInfo attributes.
  • Hint: alternatively can use GeoLocation or GeoTransform as parent of a Viewpoint node to orient geospatial views.
  • Hint: include <component name='Geospatial' level='1'/>
  • Hint: when a GeoViewpoint node is bound, it also overrides the currently bound NavigationInfo node in the scene and controls user navigation for smoother geospatial interaction.
  • Hint: Background, Fog, GeoViewpoint, NavigationInfo, OrthoViewpoint, TextureBackground and Viewpoint are bindable nodes, meaning that no more than one of each node type can be active at a given time.
  • Hint: GeoViewpoint OrthoViewpoint and Viewpoint share the same binding stack, so no more than one of these nodes can be bound and active at a given time.
  • Warning: do not include GeoViewpoint OrthoViewpoint or Viewpoint as a child of LOD or Switch, instead use ViewpointGroup as parent to constrain location proximity where the viewpoint is available to user.
  • Warning: GeoViewpoint navType and headlight fields were removed as part of X3D version 3.3, authors can instead use a NavigationInfo node for those fields in prior X3D versions 3.0, 3.1 or 3.2. Upgrading such legacy scenes to version 3.3 or greater is preferred and recommended.
  • Hint: Regardless of viewpoint jump value at bind time, the relative viewing transformation between user's view and defined position/orientation is stored for later use when un-jumping (returning to the viewpoint when subsequent viewpoint is unbound).
  • Hint: customizable design pattern for dedicated Viewpoint/NavigationInfo pair: <Viewpoint DEF='SpecialView'/> <NavigationInfo DEF='SpecialNav'/> <ROUTE fromNode='SpecialView' fromField='isBound' toNode='SpecialNav' toField='set_bind'/>
  • Warning: avoid having GeoLocation or GeoTransform as a parent or ancestor node of GeoViewpoint, since multiple geospatial transformations then occur with unpredictable results.
  • Hint: X3D Scene Authoring Hints, Viewpoints https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Viewpoints

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: GeoViewpoint, X3D Tooltips: GeoViewpoint, X3D Scene Authoring Hints: Viewpoints
  • Field Details

  • Constructor Details

    • GeoViewpoint

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

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

      public final java.lang.String getComponent()
      Defines X3D component for the GeoViewpoint 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
    • getBindTime

      public double getBindTime()
      Provide double value in seconds from outputOnly SFTime field named bindTime.

      Tooltip: Event sent reporting timestamp when node becomes active/inactive.
      • 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:
      getBindTime in interface GeoViewpoint
      Specified by:
      getBindTime in interface X3DBindableNode
      Specified by:
      getBindTime in interface X3DViewpointNode
      Returns:
      value of bindTime field
    • getCenterOfRotation

      public double[] getCenterOfRotation()
      Provide array of 3-tuple double results unit axis, angle (in radians) from inputOutput SFVec3d field named centerOfRotation.

      Tooltip: centerOfRotation specifies center point about which to rotate user's eyepoint when in EXAMINE or LOOKAT mode. *
      Specified by:
      getCenterOfRotation in interface GeoViewpoint
      Returns:
      value of centerOfRotation field
    • setCenterOfRotation

      public GeoViewpoint setCenterOfRotation​(double[] newValue)
      Accessor method to assign 3-tuple double array unit axis, angle (in radians) to inputOutput SFVec3d field named centerOfRotation.

      Tooltip: centerOfRotation specifies center point about which to rotate user's eyepoint when in EXAMINE or LOOKAT mode. *
      Specified by:
      setCenterOfRotation in interface GeoViewpoint
      Parameters:
      newValue - is new value for the centerOfRotation field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenterOfRotation

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

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

      public java.lang.String getDescription()
      Provide String value from inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of this node.
      • Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Specified by:
      getDescription in interface GeoViewpoint
      Specified by:
      getDescription in interface X3DViewpointNode
      Returns:
      value of description field
    • setDescription

      public GeoViewpoint setDescription​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of this node.
      • Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Specified by:
      setDescription in interface GeoViewpoint
      Specified by:
      setDescription in interface X3DViewpointNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDescription

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

      public float getFarDistance()
      Provide float value from inputOutput SFFloat field named farDistance.

      Tooltip: or (0,+infinity) farDistance defines maximum clipping plane distance allowed for object display.
      Specified by:
      getFarDistance in interface GeoViewpoint
      Specified by:
      getFarDistance in interface X3DViewpointNode
      Returns:
      value of farDistance field
    • setFarDistance

      public GeoViewpoint setFarDistance​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named farDistance.

      Tooltip: or (0,+infinity) farDistance defines maximum clipping plane distance allowed for object display.
      Specified by:
      setFarDistance in interface GeoViewpoint
      Specified by:
      setFarDistance in interface X3DViewpointNode
      Parameters:
      newValue - is new value for the farDistance field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setFarDistance

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

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

      public float getFieldOfView()
      Provide float value within allowed range of (0,3.1416) from inputOutput SFFloat field named fieldOfView.

      Tooltip: Preferred minimum viewing angle from this viewpoint in radians, providing minimum height or minimum width (whichever is smaller). Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens. *
      Specified by:
      getFieldOfView in interface GeoViewpoint
      Returns:
      value of fieldOfView field
    • setFieldOfView

      public GeoViewpoint setFieldOfView​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named fieldOfView.

      Tooltip: Preferred minimum viewing angle from this viewpoint in radians, providing minimum height or minimum width (whichever is smaller). Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens. *
      Specified by:
      setFieldOfView in interface GeoViewpoint
      Parameters:
      newValue - is new value for the fieldOfView field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setFieldOfView

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

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

      public GeoOrigin 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 interface GeoViewpoint
      Returns:
      value of geoOrigin field
      See Also:
      Tooltip: [GeoOrigin] Single contained GeoOrigin node that specifies a local coordinate frame for extended precision. Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/geospatial.html#high-precisioncoords Warning: XML validation requires placement as first child node following contained metadata nodes (if any).
    • setGeoOrigin

      public GeoViewpoint setGeoOrigin​(GeoOrigin newValue)
      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 interface GeoViewpoint
      Parameters:
      newValue - is new value for the geoOrigin field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [GeoOrigin] Single contained GeoOrigin node that specifies a local coordinate frame for extended precision. Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/geospatial.html#high-precisioncoords Warning: XML validation requires placement as first child node following contained metadata nodes (if any).
    • clearGeoOrigin

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

      public GeoViewpoint setGeoOrigin​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field geoOrigin.
      Parameters:
      newValue - is new value for the geoOrigin field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setGeoOrigin( org.web3d.x3d.sai.Geospatial.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 GeoViewpoint
      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
    • getGeoSystemString

      public java.lang.String getGeoSystemString()
      Utility method to get String value of MFString geoSystem field, similar to getGeoSystem().
      Returns:
      value of geoSystem field
    • setGeoSystem

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

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

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

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

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

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

      public GeoViewpoint 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:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFString.cleanupEnumerationValues(String)
    • addGeoSystem

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

      public IS getIS()
      Provide IS 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 GeoViewpoint setIS​(IS newValue)
      Accessor method to assign IS 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:
      GeoViewpoint - 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 GeoViewpoint clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      GeoViewpoint - 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()
    • getIsBound

      public boolean getIsBound()
      Provide boolean value from outputOnly SFBool field named isBound.

      Tooltip: Output event true gets sent when node becomes bound and activated, otherwise output event false gets sent when node becomes unbound and deactivated.
      • 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:
      getIsBound in interface GeoViewpoint
      Specified by:
      getIsBound in interface X3DBindableNode
      Specified by:
      getIsBound in interface X3DViewpointNode
      Returns:
      value of isBound field
    • getJump

      public boolean getJump()
      Provide boolean value from inputOutput SFBool field named jump.

      Tooltip: Whether to transition instantly by jumping, or else smoothly animate to this Viewpoint. *
      Specified by:
      getJump in interface GeoViewpoint
      Specified by:
      getJump in interface X3DViewpointNode
      Returns:
      value of jump field
    • setJump

      public GeoViewpoint setJump​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named jump.

      Tooltip: Whether to transition instantly by jumping, or else smoothly animate to this Viewpoint. *
      Specified by:
      setJump in interface GeoViewpoint
      Specified by:
      setJump in interface X3DViewpointNode
      Parameters:
      newValue - is new value for the jump field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setJump

      public GeoViewpoint setJump​(SFBool newValue)
      Assign typed object value to SFBool jump field, similar to setJump(boolean).
      Parameters:
      newValue - is new value for the jump field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface GeoViewpoint
      Specified by:
      getMetadata in interface X3DBindableNode
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DViewpointNode
      Returns:
      value of metadata field
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public GeoViewpoint setMetadata​(X3DMetadataObject newValue)
      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 interface GeoViewpoint
      Specified by:
      setMetadata in interface X3DBindableNode
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DViewpointNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

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

      public GeoViewpoint setMetadata​(ProtoInstance 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:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata( org.web3d.x3d.sai.Core.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
    • getNavigationInfo

      public NavigationInfo getNavigationInfo()
      Provide org.web3d.x3d.sai.Navigation.NavigationInfo instance (using a properly typed node) from inputOutput SFNode field navigationInfo.
      Specified by:
      getNavigationInfo in interface GeoViewpoint
      Specified by:
      getNavigationInfo in interface X3DViewpointNode
      Returns:
      value of navigationInfo field
      See Also:
      getNavigationInfoProtoInstance()
    • setNavigationInfo

      public GeoViewpoint setNavigationInfo​(NavigationInfo newValue)
      Accessor method to assign org.web3d.x3d.sai.Navigation.NavigationInfo instance (using a properly typed node) to inputOutput SFNode field navigationInfo.
      Specified by:
      setNavigationInfo in interface GeoViewpoint
      Specified by:
      setNavigationInfo in interface X3DViewpointNode
      Parameters:
      newValue - is new value for the navigationInfo field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setNavigationInfo(ProtoInstance)
    • clearNavigationInfo

      public GeoViewpoint clearNavigationInfo()
      Utility method to clear SFNode value of navigationInfo field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setNavigationInfo

      public GeoViewpoint setNavigationInfo​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field navigationInfo.
      Parameters:
      newValue - is new value for the navigationInfo field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setNavigationInfo( org.web3d.x3d.sai.Navigation.NavigationInfo)
    • hasNavigationInfo

      public boolean hasNavigationInfo()
      Indicate whether an object is available for inputOutput SFNode field navigationInfo.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getNavigationInfo(), getNavigationInfoProtoInstance()
    • getNearDistance

      public float getNearDistance()
      Provide float value from inputOutput SFFloat field named nearDistance.

      Tooltip: or (0,+infinity) nearDistance defines minimum clipping plane distance necessary for object display.
      Specified by:
      getNearDistance in interface GeoViewpoint
      Specified by:
      getNearDistance in interface X3DViewpointNode
      Returns:
      value of nearDistance field
    • setNearDistance

      public GeoViewpoint setNearDistance​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named nearDistance.

      Tooltip: or (0,+infinity) nearDistance defines minimum clipping plane distance necessary for object display.
      Specified by:
      setNearDistance in interface GeoViewpoint
      Specified by:
      setNearDistance in interface X3DViewpointNode
      Parameters:
      newValue - is new value for the nearDistance field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setNearDistance

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

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

      public float[] getOrientation()
      Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.

      Tooltip: Rotation of Viewpoint, relative to default -Z axis direction in local coordinate system.
      • Warning: for VR/AR/MAR users wearing a head-mounted display (HMD), animating this field may induce motion sickness.
      • Hint: this is orientation _change_ from default direction (0 0 -1) +Y axis is the up vector for the local area (the normal to the tangent plane on the ellipsoid), -Z points towards the north pole, and +X is east 1 0 0 -1.570796 always looks down.
      Specified by:
      getOrientation in interface GeoViewpoint
      Specified by:
      getOrientation in interface X3DViewpointNode
      Returns:
      value of orientation field
    • setOrientation

      public GeoViewpoint setOrientation​(float[] newValue)
      Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.

      Tooltip: Rotation of Viewpoint, relative to default -Z axis direction in local coordinate system.
      • Warning: for VR/AR/MAR users wearing a head-mounted display (HMD), animating this field may induce motion sickness.
      • Hint: this is orientation _change_ from default direction (0 0 -1) +Y axis is the up vector for the local area (the normal to the tangent plane on the ellipsoid), -Z points towards the north pole, and +X is east 1 0 0 -1.570796 always looks down.
      Specified by:
      setOrientation in interface GeoViewpoint
      Specified by:
      setOrientation in interface X3DViewpointNode
      Parameters:
      newValue - is new value for the orientation field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setOrientation

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

      public GeoViewpoint setOrientation​(float x, float y, float z, float angleRadians)
      Assign values to SFRotation orientation field, similar to setOrientation(float[]).
      Parameters:
      x - first component of axis
      y - second component of axis
      z - third component of axis
      angleRadians - fourth component of rotation around axis
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setOrientation

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

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

      public double[] getPosition()
      Provide array of 3-tuple double results from inputOutput SFVec3d field named position.

      Tooltip: position relative to local georeferenced coordinate system, in proper format. *
      Specified by:
      getPosition in interface GeoViewpoint
      Returns:
      value of position field
    • setPosition

      public GeoViewpoint setPosition​(double[] newValue)
      Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named position.

      Tooltip: position relative to local georeferenced coordinate system, in proper format. *
      Specified by:
      setPosition in interface GeoViewpoint
      Parameters:
      newValue - is new value for the position field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPosition

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

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

      public boolean getRetainUserOffsets()
      Provide boolean value from inputOutput SFBool field named retainUserOffsets.

      Tooltip: Retain (true) or reset to zero (false) any prior user navigation offsets from defined viewpoint position, orientation. *
      Specified by:
      getRetainUserOffsets in interface GeoViewpoint
      Specified by:
      getRetainUserOffsets in interface X3DViewpointNode
      Returns:
      value of retainUserOffsets field
    • setRetainUserOffsets

      public GeoViewpoint setRetainUserOffsets​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named retainUserOffsets.

      Tooltip: Retain (true) or reset to zero (false) any prior user navigation offsets from defined viewpoint position, orientation. *
      Specified by:
      setRetainUserOffsets in interface GeoViewpoint
      Specified by:
      setRetainUserOffsets in interface X3DViewpointNode
      Parameters:
      newValue - is new value for the retainUserOffsets field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRetainUserOffsets

      public GeoViewpoint setRetainUserOffsets​(SFBool newValue)
      Assign typed object value to SFBool retainUserOffsets field, similar to setRetainUserOffsets(boolean).
      Parameters:
      newValue - is new value for the retainUserOffsets field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSpeedFactor

      public float getSpeedFactor()
      Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named speedFactor.

      Tooltip: [0,+infinity) speedFactor is a multiplier to modify the original elevation-based speed that is set automatically by the browser.
      • Hint: speedFactor is a relative value and not an absolute speed as defined by NavigationInfo.
      Specified by:
      getSpeedFactor in interface GeoViewpoint
      Returns:
      value of speedFactor field
    • setSpeedFactor

      public GeoViewpoint setSpeedFactor​(float newValue)
      Accessor method to assign float value to initializeOnly SFFloat field named speedFactor.

      Tooltip: [0,+infinity) speedFactor is a multiplier to modify the original elevation-based speed that is set automatically by the browser.
      • Hint: speedFactor is a relative value and not an absolute speed as defined by NavigationInfo.
      Specified by:
      setSpeedFactor in interface GeoViewpoint
      Parameters:
      newValue - is new value for the speedFactor field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSpeedFactor

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

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

      public boolean getViewAll()
      Provide boolean value from inputOutput SFBool field named viewAll.
      Specified by:
      getViewAll in interface GeoViewpoint
      Specified by:
      getViewAll in interface X3DViewpointNode
      Returns:
      value of viewAll field
    • setViewAll

      public GeoViewpoint setViewAll​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named viewAll.
      Specified by:
      setViewAll in interface GeoViewpoint
      Specified by:
      setViewAll in interface X3DViewpointNode
      Parameters:
      newValue - is new value for the viewAll field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setViewAll

      public GeoViewpoint setViewAll​(SFBool newValue)
      Assign typed object value to SFBool viewAll field, similar to setViewAll(boolean).
      Parameters:
      newValue - is new value for the viewAll field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDEF

      public java.lang.String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

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

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

      public GeoViewpoint setUSE​(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      GeoViewpoint - 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 Cascading Style Sheets (CSS) and XML stylesheets.
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final GeoViewpoint 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 Cascading Style Sheets (CSS) and XML stylesheets.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      GeoViewpoint - 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 GeoViewpoint setCssClass​(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

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

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

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

      public GeoViewpoint addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • toStringX3D

      public java.lang.String toStringX3D​(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
      X3D.FILE_EXTENSION_X3D, X3D.FILE_EXTENSION_XML, X3D.toStringXML(), X3D.toFileXML(String), X3D.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:
      X3D.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:
      X3D.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 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 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.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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 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 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.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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 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 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.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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)