Class NavigationInfoObject

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Navigation.NavigationInfoObject
All Implemented Interfaces:
X3DBindableNode, X3DChildNode, X3DNode, NavigationInfo

public class NavigationInfoObject
extends X3DConcreteNode
implements NavigationInfo
NavigationInfo describes the user's viewing model, user navigation-interaction modalities, and also dimensional characteristics of the user's (typically invisible) avatar.

X3D node tooltip: [X3DBindableNode] NavigationInfo describes the user's viewing model, user navigation-interaction modalities, and also dimensional characteristics of the user's (typically invisible) avatar.
  • Hint: for inspection of simple objects, usability often improves with type="EXAMINE" "ANY"
  • 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: NavigationInfo types '"WALK" "FLY"' support camera-to-object collision detection.
  • Warning: results are undefined if a bindable node (Background, Fog, NavigationInfo, OrthoViewpoint, TextureBackground, Viewpoint) is a contained descendant node of either LOD or Switch.
  • 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'/>
  • Hint: X3D Scene Authoring Hints, Viewpoints http://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: NavigationInfo, X3D Tooltips: NavigationInfo, X3D Scene Authoring Hints: Viewpoints
  • Field Details

  • Constructor Details

    • NavigationInfoObject

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

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

      public final java.lang.String getComponent()
      Defines X3D component for the NavigationInfo element: Navigation
      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
    • getAvatarSize

      public float[] getAvatarSize()
      Provide array of Float results within allowed range of [0,infinity) from inputOutput MFFloat field named avatarSize.

      Tooltip: avatarSize triplet values define three separate parameters: (a) collisionDistance between user and geometry, i.e. near clipping plane of view frustrum, default 0.25m, (b) viewer height above terrain, default 1.6m, and (c) tallest height viewer can WALK over, default 0.75m.
      • Hint: X3D specification recommends that browsers set near clipping plane to one-half of avatarSize.CollisionDistance value.
      • Warning: important design thumbrule is to keep (visibilityLimit / avatarSize.CollisionDistance) < 10,000 to avoid aliasing artifacts (i.e. polygon "tearing").
      • Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics) Interchange profile hint: this field may be ignored, applying the default value regardless.
      • Hint: transformation hierarchy of currently bound Viewpoint node scales avatarSize, but translations and rotations have no effect.
      Specified by:
      getAvatarSize in interface NavigationInfo
      Returns:
      value of avatarSize field
    • getAvatarSizeList

      public java.util.ArrayList<java.lang.Float> getAvatarSizeList()
      Utility method to get ArrayList value of MFFloat avatarSize field, similar to getAvatarSize().
      Returns:
      value of avatarSize field
    • setAvatarSize

      public NavigationInfoObject setAvatarSize​(float[] newValue)
      Accessor method to assign Float array to inputOutput MFFloat field named avatarSize.

      Tooltip: avatarSize triplet values define three separate parameters: (a) collisionDistance between user and geometry, i.e. near clipping plane of view frustrum, default 0.25m, (b) viewer height above terrain, default 1.6m, and (c) tallest height viewer can WALK over, default 0.75m.
      • Hint: X3D specification recommends that browsers set near clipping plane to one-half of avatarSize.CollisionDistance value.
      • Warning: important design thumbrule is to keep (visibilityLimit / avatarSize.CollisionDistance) &lt; 10,000 to avoid aliasing artifacts (i.e. polygon "tearing").
      • Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics) Interchange profile hint: this field may be ignored, applying the default value regardless.
      • Hint: transformation hierarchy of currently bound Viewpoint node scales avatarSize, but translations and rotations have no effect.
      Specified by:
      setAvatarSize in interface NavigationInfo
      Parameters:
      newValue - is new value for the avatarSize field.
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAvatarSize

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

      public NavigationInfoObject setAvatarSize​(java.util.ArrayList<java.lang.Float> newValue)
      Assign ArrayList value of MFFloat avatarSize field, similar to setAvatarSize(float[]).
      Parameters:
      newValue - is new value for the avatarSize field.
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearAvatarSize

      public NavigationInfoObject clearAvatarSize()
      Utility method to clear MFFloat value of avatarSize field.
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setAvatarSize

      public NavigationInfoObject setAvatarSize​(int[] newValue)
      Assign floating-point array value of MFFloat avatarSize field, similar to setAvatarSize(float[]).
      Parameters:
      newValue - is new value for the avatarSize field.
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addAvatarSize

      public NavigationInfoObject addAvatarSize​(float newValue)
      Add singleton float value to MFFloat avatarSize field.
      Parameters:
      newValue - is new value to add to the avatarSize field.
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addAvatarSize

      public NavigationInfoObject addAvatarSize​(SFFloatObject newValue)
      Add singleton SFFloatObject value to MFFloat avatarSize field.
      Parameters:
      newValue - is new value to add to the avatarSize field.
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAvatarSize

      public NavigationInfoObject setAvatarSize​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setAvatarSize(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • 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 NavigationInfo
      Specified by:
      getBindTime in interface X3DBindableNode
      Returns:
      value of bindTime field
    • getHeadlight

      public boolean getHeadlight()
      Provide boolean value from inputOutput SFBool field named headlight.

      Tooltip: Enable/disable directional light that always points in the direction the user is looking. *
      Specified by:
      getHeadlight in interface NavigationInfo
      Returns:
      value of headlight field
    • setHeadlight

      public NavigationInfoObject setHeadlight​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named headlight.

      Tooltip: Enable/disable directional light that always points in the direction the user is looking. *
      Specified by:
      setHeadlight in interface NavigationInfo
      Parameters:
      newValue - is new value for the headlight field.
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setHeadlight

      public NavigationInfoObject setHeadlight​(SFBoolObject newValue)
      Assign typed object value to SFBool headlight field, similar to setHeadlight(boolean).
      Parameters:
      newValue - is new value for the headlight field.
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • 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 NavigationInfoObject 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:
      NavigationInfoObject - 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 NavigationInfoObject clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      NavigationInfoObject - 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.
      • Hint: paired node operations can be established by connecting set_bind and isBound fields of corresponding bindable nodes.
      • 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 NavigationInfo
      Specified by:
      getIsBound in interface X3DBindableNode
      Returns:
      value of isBound field
    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface NavigationInfo
      Specified by:
      getMetadata in interface X3DBindableNode
      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 NavigationInfoObject setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface NavigationInfo
      Specified by:
      setMetadata in interface X3DBindableNode
      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:
      NavigationInfoObject - 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 NavigationInfoObject clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMetadata

      public NavigationInfoObject 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:
      NavigationInfoObject - 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
    • getSpeed

      public float getSpeed()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named speed.

      Tooltip: [0,+infinity) Default rate at which viewer travels through scene, meters/second.
      • Warning: default 1 m/s usually seems slow for ordinary navigation. Interchange profile hint: this field may be ignored, applying the default value regardless.
      Specified by:
      getSpeed in interface NavigationInfo
      Returns:
      value of speed field
    • setSpeed

      public NavigationInfoObject setSpeed​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named speed.

      Tooltip: [0,+infinity) Default rate at which viewer travels through scene, meters/second.
      • Warning: default 1 m/s usually seems slow for ordinary navigation. Interchange profile hint: this field may be ignored, applying the default value regardless.
      Specified by:
      setSpeed in interface NavigationInfo
      Parameters:
      newValue - is new value for the speed field.
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSpeed

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

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

      public boolean getTransitionComplete()
      Provide boolean value from outputOnly SFBool field named transitionComplete.

      Tooltip: Event signaling viewpoint transition complete. Interchange profile hint: this field may be ignored.
      • 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:
      getTransitionComplete in interface NavigationInfo
      Returns:
      value of transitionComplete field
    • getTransitionTime

      public double getTransitionTime()
      Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named transitionTime.

      Tooltip: transitionTime defines the expected duration of viewpoint transition in seconds.
      • Hint: If transitionType is "ANIMATE", transitionTime provides browser-dependent animation parameters. Interchange profile hint: this field may be ignored, applying the default value regardless.
      Specified by:
      getTransitionTime in interface NavigationInfo
      Returns:
      value of transitionTime field
    • setTransitionTime

      public NavigationInfoObject setTransitionTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named transitionTime.

      Tooltip: transitionTime defines the expected duration of viewpoint transition in seconds.
      • Hint: If transitionType is "ANIMATE", transitionTime provides browser-dependent animation parameters. Interchange profile hint: this field may be ignored, applying the default value regardless.
      Specified by:
      setTransitionTime in interface NavigationInfo
      Parameters:
      newValue - is new value for the transitionTime field.
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTransitionTime

      public NavigationInfoObject setTransitionTime​(SFTimeObject newValue)
      Assign typed object value to SFTime transitionTime field, similar to setTransitionTime(double).
      Parameters:
      newValue - is new value for the transitionTime field.
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getTransitionType

      public java.lang.String[] getTransitionType()
      Provide array of String enumeration results with quoted value(s) ["TELEPORT","LINEAR","ANIMATE",...] from inputOutput MFString field named transitionType.

      Tooltip: Camera transition between viewpoints. Enter one or more quoted SFString values: "ANIMATE" "TELEPORT" "LINEAR".
      • Hint: "ANIMATE" behavior is browser-specific, "TELEPORT" is immediate, and "LINEAR" may proceed directly through intervening objects.


      Available enumeration values for string comparison: TELEPORT, LINEAR, ANIMATE.
      Specified by:
      getTransitionType in interface NavigationInfo
      Returns:
      value of transitionType field
    • getTransitionTypeList

      public java.util.ArrayList<java.lang.String> getTransitionTypeList()
      Utility method to get ArrayList value of MFString transitionType field, similar to getTransitionType().
      Returns:
      value of transitionType field
    • setTransitionType

      public NavigationInfoObject setTransitionType​(java.lang.String[] newValue)
      Accessor method to assign String enumeration array (""TELEPORT"" | ""LINEAR"" | ""ANIMATE"") to inputOutput MFString field named transitionType.

      Hint: authors have option to choose from an extendible list of predefined enumeration values (TELEPORT, LINEAR, ANIMATE).

      Tooltip: Camera transition between viewpoints. Enter one or more quoted SFString values: "ANIMATE" "TELEPORT" "LINEAR".
      • Hint: "ANIMATE" behavior is browser-specific, "TELEPORT" is immediate, and "LINEAR" may proceed directly through intervening objects.
      Specified by:
      setTransitionType in interface NavigationInfo
      Parameters:
      newValue - is new value for the transitionType field.
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTransitionType

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

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

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

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

      public NavigationInfoObject clearTransitionType()
      Utility method to clear MFString value of transitionType field.
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addTransitionType

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

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

      public java.lang.String[] getType()
      Provide array of String enumeration results with quoted value(s) ["ANY","WALK","EXAMINE","FLY","LOOKAT","NONE","EXPLORE",...] from inputOutput MFString field named type.

      Tooltip: Enter one or more quoted SFString values: "EXAMINE" "WALK" "FLY" "LOOKAT" "EXPLORE" "ANY" "NONE".
      • Hint: for inspection of simple objects, usability often improves with type="EXAMINE" "ANY".
      • Hint: types WALK and FLY force strict camera-to-object collision detection.
      • Hint: see Collision node for further details on camera-to-object collision detection.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc." ] Interchange profile hint: this field may be ignored, applying the default value regardless.


      Available enumeration values for string comparison: ANY, WALK, EXAMINE, FLY, LOOKAT, NONE, EXPLORE.
      Specified by:
      getType in interface NavigationInfo
      Returns:
      value of type field
    • getTypeList

      public java.util.ArrayList<java.lang.String> getTypeList()
      Utility method to get ArrayList value of MFString type field, similar to getType().
      Returns:
      value of type field
    • setType

      public NavigationInfoObject setType​(java.lang.String[] newValue)
      Accessor method to assign String enumeration array (""ANY"" | ""WALK"" | ""EXAMINE"" | ""FLY"" | ""LOOKAT"" | ""NONE"" | ""EXPLORE"") to inputOutput MFString field named type.

      Hint: authors have option to choose from an extendible list of predefined enumeration values (ANY, WALK, EXAMINE, FLY, LOOKAT, NONE, EXPLORE).

      Tooltip: Enter one or more quoted SFString values: "EXAMINE" "WALK" "FLY" "LOOKAT" "EXPLORE" "ANY" "NONE".
      • Hint: for inspection of simple objects, usability often improves with type="EXAMINE" "ANY".
      • Hint: types WALK and FLY force strict camera-to-object collision detection.
      • Hint: see Collision node for further details on camera-to-object collision detection.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc." ] Interchange profile hint: this field may be ignored, applying the default value regardless.
      Specified by:
      setType in interface NavigationInfo
      Parameters:
      newValue - is new value for the type field.
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setType

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

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

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

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

      public NavigationInfoObject clearType()
      Utility method to clear MFString value of type field.
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addType

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

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

      public float getVisibilityLimit()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named visibilityLimit.

      Tooltip: Geometry beyond the visibilityLimit may not be rendered (far clipping plane of the view frustrum).
      • Hint: visibilityLimit=0.0 indicates an infinite visibility limit (no far clipping plane).
      • Hint: set visibilityLimit to appropriate positive value in meters to define far culling plane of view frustum.
      • Hint: X3D specification recommends that browsers set near clipping plane to one-half of avatarSize.CollisionDistance value.
      • Warning: important design thumbrule is to keep (visibilityLimit / avatarSize.CollisionDistance) &lt; 10,000 to avoid aliasing artifacts (i.e. polygon "tearing").
      • Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics) Interchange profile hint: this field may be ignored, applying the default value regardless.
      Specified by:
      getVisibilityLimit in interface NavigationInfo
      Returns:
      value of visibilityLimit field
    • setVisibilityLimit

      public NavigationInfoObject setVisibilityLimit​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named visibilityLimit.

      Tooltip: Geometry beyond the visibilityLimit may not be rendered (far clipping plane of the view frustrum).
      • Hint: visibilityLimit=0.0 indicates an infinite visibility limit (no far clipping plane).
      • Hint: set visibilityLimit to appropriate positive value in meters to define far culling plane of view frustum.
      • Hint: X3D specification recommends that browsers set near clipping plane to one-half of avatarSize.CollisionDistance value.
      • Warning: important design thumbrule is to keep (visibilityLimit / avatarSize.CollisionDistance) &lt; 10,000 to avoid aliasing artifacts (i.e. polygon "tearing").
      • Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics) Interchange profile hint: this field may be ignored, applying the default value regardless.
      Specified by:
      setVisibilityLimit in interface NavigationInfo
      Parameters:
      newValue - is new value for the visibilityLimit field.
      Returns:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setVisibilityLimit

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

      public NavigationInfoObject setVisibilityLimit​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setVisibilityLimit(float).
      Parameters:
      newValue - is new value for field
      Returns:
      NavigationInfoObject - 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 NavigationInfoObject 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:
      NavigationInfoObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

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

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

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

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

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

      public NavigationInfoObject addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      NavigationInfoObject - 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:
      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)