Class NavigationInfoObject

  • All Implemented Interfaces:
    X3DBindableNode, X3DChildNode, X3DNode, NavigationInfo

    public class NavigationInfoObject
    extends X3DConcreteNode
    implements NavigationInfo
    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 Detail

      • TRANSITIONTYPE_TELEPORT

        public static final java.lang.String TRANSITIONTYPE_TELEPORT
        MFString field named transitionType with X3DUOM baseType navigationTransitionTypeValues is an array that can include this quoted enumeration value (and alternate values) "TELEPORT" (Java syntax) or '"TELEPORT"' (XML syntax).
        See Also:
        navigationTransitionTypeValues, Constant Field Values
      • TRANSITIONTYPE_LINEAR

        public static final java.lang.String TRANSITIONTYPE_LINEAR
        MFString field named transitionType with X3DUOM baseType navigationTransitionTypeValues is an array that can include this quoted enumeration value (and alternate values) "LINEAR" (Java syntax) or '"LINEAR"' (XML syntax).
        See Also:
        navigationTransitionTypeValues, Constant Field Values
      • TRANSITIONTYPE_ANIMATE

        public static final java.lang.String TRANSITIONTYPE_ANIMATE
        MFString field named transitionType with X3DUOM baseType navigationTransitionTypeValues is an array that can include this quoted enumeration value (and alternate values) "ANIMATE" (Java syntax) or '"ANIMATE"' (XML syntax).
        See Also:
        navigationTransitionTypeValues, Constant Field Values
      • TYPE_ANY

        public static final java.lang.String TYPE_ANY
        MFString field named type with X3DUOM baseType navigationTypeValues is an array that can include this quoted enumeration value (and alternate values) "ANY" (Java syntax) or '"ANY"' (XML syntax).
        See Also:
        navigationTypeValues, Constant Field Values
      • TYPE_WALK

        public static final java.lang.String TYPE_WALK
        MFString field named type with X3DUOM baseType navigationTypeValues is an array that can include this quoted enumeration value (and alternate values) "WALK" (Java syntax) or '"WALK"' (XML syntax).
        See Also:
        navigationTypeValues, Constant Field Values
      • TYPE_EXAMINE

        public static final java.lang.String TYPE_EXAMINE
        MFString field named type with X3DUOM baseType navigationTypeValues is an array that can include this quoted enumeration value (and alternate values) "EXAMINE" (Java syntax) or '"EXAMINE"' (XML syntax).
        See Also:
        navigationTypeValues, Constant Field Values
      • TYPE_FLY

        public static final java.lang.String TYPE_FLY
        MFString field named type with X3DUOM baseType navigationTypeValues is an array that can include this quoted enumeration value (and alternate values) "FLY" (Java syntax) or '"FLY"' (XML syntax).
        See Also:
        navigationTypeValues, Constant Field Values
      • TYPE_LOOKAT

        public static final java.lang.String TYPE_LOOKAT
        MFString field named type with X3DUOM baseType navigationTypeValues is an array that can include this quoted enumeration value (and alternate values) "LOOKAT" (Java syntax) or '"LOOKAT"' (XML syntax).
        See Also:
        navigationTypeValues, Constant Field Values
      • TYPE_NONE

        public static final java.lang.String TYPE_NONE
        MFString field named type with X3DUOM baseType navigationTypeValues is an array that can include this quoted enumeration value (and alternate values) "NONE" (Java syntax) or '"NONE"' (XML syntax).
        See Also:
        navigationTypeValues, Constant Field Values
      • TYPE_EXPLORE

        public static final java.lang.String TYPE_EXPLORE
        MFString field named type with X3DUOM baseType navigationTypeValues is an array that can include this quoted enumeration value (and alternate values) "EXPLORE" (Java syntax) or '"EXPLORE"' (XML syntax).
        See Also:
        navigationTypeValues, Constant Field Values
      • NAME

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

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

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

        public static final java.util.ArrayList<java.lang.Float> AVATARSIZE_DEFAULT_VALUE
        MFFloat field named avatarSize has default value {0.25f,1.6f,0.75f} (Java syntax) or 0.25 1.6 0.75 (XML syntax).
      • HEADLIGHT_DEFAULT_VALUE

        public static final boolean HEADLIGHT_DEFAULT_VALUE
        SFBool field named headlight has default value true (Java syntax) or true (XML syntax).
        See Also:
        Constant Field Values
      • IS_DEFAULT_VALUE

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

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

        public static final float SPEED_DEFAULT_VALUE
        SFFloat field named speed has default value 1f (Java syntax) or 1 (XML syntax).
        See Also:
        Constant Field Values
      • TRANSITIONTIME_DEFAULT_VALUE

        public static final double TRANSITIONTIME_DEFAULT_VALUE
        SFTime field named transitionTime has default value 1.0 (Java syntax) or 1.0 (XML syntax).
        See Also:
        Constant Field Values
      • TRANSITIONTYPE_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.String> TRANSITIONTYPE_DEFAULT_VALUE
        MFString field named transitionType has default quoted value new String[] {"LINEAR"} (Java syntax) or quoted value "LINEAR" (XML syntax).
      • TYPE_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.String> TYPE_DEFAULT_VALUE
        MFString field named type has default quoted value new String[] {"EXAMINE","ANY"} (Java syntax) or quoted value "EXAMINE" "ANY" (XML syntax).
      • VISIBILITYLIMIT_DEFAULT_VALUE

        public static final float VISIBILITYLIMIT_DEFAULT_VALUE
        SFFloat field named visibilityLimit has default value 0f (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • fromField_AVATARSIZE

        public static final java.lang.String fromField_AVATARSIZE
        fromField ROUTE name for MFFloat field named avatarSize.
        See Also:
        Constant Field Values
      • toField_AVATARSIZE

        public static final java.lang.String toField_AVATARSIZE
        toField ROUTE name for MFFloat field named avatarSize.
        See Also:
        Constant Field Values
      • fromField_BINDTIME

        public static final java.lang.String fromField_BINDTIME
        fromField ROUTE name for SFTime field named bindTime.
        See Also:
        Constant Field Values
      • fromField_HEADLIGHT

        public static final java.lang.String fromField_HEADLIGHT
        fromField ROUTE name for SFBool field named headlight.
        See Also:
        Constant Field Values
      • toField_HEADLIGHT

        public static final java.lang.String toField_HEADLIGHT
        toField ROUTE name for SFBool field named headlight.
        See Also:
        Constant Field Values
      • fromField_IS

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

        public static final java.lang.String fromField_ISBOUND
        fromField ROUTE name for SFBool field named isBound.
        See Also:
        Constant Field Values
      • fromField_METADATA

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

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

        public static final java.lang.String toField_SET_BIND
        toField ROUTE name for SFBool field named set_bind.
        See Also:
        Constant Field Values
      • fromField_SPEED

        public static final java.lang.String fromField_SPEED
        fromField ROUTE name for SFFloat field named speed.
        See Also:
        Constant Field Values
      • toField_SPEED

        public static final java.lang.String toField_SPEED
        toField ROUTE name for SFFloat field named speed.
        See Also:
        Constant Field Values
      • fromField_TRANSITIONCOMPLETE

        public static final java.lang.String fromField_TRANSITIONCOMPLETE
        fromField ROUTE name for SFBool field named transitionComplete.
        See Also:
        Constant Field Values
      • fromField_TRANSITIONTIME

        public static final java.lang.String fromField_TRANSITIONTIME
        fromField ROUTE name for SFTime field named transitionTime.
        See Also:
        Constant Field Values
      • toField_TRANSITIONTIME

        public static final java.lang.String toField_TRANSITIONTIME
        toField ROUTE name for SFTime field named transitionTime.
        See Also:
        Constant Field Values
      • fromField_TRANSITIONTYPE

        public static final java.lang.String fromField_TRANSITIONTYPE
        fromField ROUTE name for MFString field named transitionType.
        See Also:
        Constant Field Values
      • toField_TRANSITIONTYPE

        public static final java.lang.String toField_TRANSITIONTYPE
        toField ROUTE name for MFString field named transitionType.
        See Also:
        Constant Field Values
      • fromField_TYPE

        public static final java.lang.String fromField_TYPE
        fromField ROUTE name for MFString field named type.
        See Also:
        Constant Field Values
      • toField_TYPE

        public static final java.lang.String toField_TYPE
        toField ROUTE name for MFString field named type.
        See Also:
        Constant Field Values
      • fromField_VISIBILITYLIMIT

        public static final java.lang.String fromField_VISIBILITYLIMIT
        fromField ROUTE name for SFFloat field named visibilityLimit.
        See Also:
        Constant Field Values
      • toField_VISIBILITYLIMIT

        public static final java.lang.String toField_VISIBILITYLIMIT
        toField ROUTE name for SFFloat field named visibilityLimit.
        See Also:
        Constant Field Values
    • Constructor Detail

      • 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 Detail

      • 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
      • 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) &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:
        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).
      • 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
      • 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).
      • 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​(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)
      • 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​(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).
      • 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).
      • 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).
      • 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)
      • 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)