Overview
NavigationInfo describes the user’s viewing model, user navigation-interaction modalities, and also dimensional characteristics of the user’s (typically invisible) avatar.
The NavigationInfo node belongs to the Navigation component and its default container field is children. It is available since X3D version 3.0 or later.
Hierarchy
1
2
3
4
+ X3DNode
+ X3DChildNode
+ X3DBindableNode
+ NavigationInfo
Fields
SFNode [in, out] metadata NULL [X3DMetadataObject]
Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
SFBool [in] set_bind
Setting set_bind true makes this node active setting set_bind false makes this node inactive. Thus setting set_bind true/false will pop/push (enable/disable) this node.
MFString [in, out] type [ “EXAMINE”, “ANY” ] [“EXAMINE”,”WALK”,”FLY”,”PLANE_create3000.github.io”,”LOOKAT”,”EXPLORE”,”ANY”,”NONE”]
Enter one or more quoted SFString values: “EXAMINE” “WALK” “FLY” “PLANE_create3000.github.io” “LOOKAT” “EXPLORE” “ANY” “NONE”.
The PLANE viewer is primarily designed to use with OrthoViewpoint and 2D scenes. You can zoom, which will change the viewport size (center of zoom is mouse pointer), and you can move the scene along the viewport plane.
Hints
- For inspection of simple objects, usability often improves with type=”EXAMINE” “ANY”.
- Types WALK and FLY force strict camera-to-object collision detection.
- See Collision node for further details on camera-to-object collision detection.
- MFString arrays can have multiple values, so separate each individual string by quote marks “https://www.web3d.org” “https://www.web3d.org/about” “etc.” ]
MFFloat [in, out] avatarSize [ 0.25, 1.6, 0.75 ] [0,∞)
avatarSize triplet values are: (a) collision distance between user and geometry (near culling plane of the view frustrum) (b) viewer height above terrain (c) tallest height viewer can WALK over.
Hint
- Keep (visibilityLimit / avatarSize.CollisionDistance) < 10,000 to avoid aliasing artifacts (i.e. polygon “tearing”). Interchange profile hint: this field may be ignored, applying the default value regardless.
SFFloat [in, out] speed 1 [0,∞)
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.
SFBool [in, out] headlight TRUE
Enable/disable directional light that always points in the direction the user is looking.
SFFloat [in, out] visibilityLimit
Geometry beyond the visibilityLimit may not be rendered (far culling plane of the view frustrum). visibilityLimit=0.0 indicates an infinite visibility limit.
Hints
- Keep visibilityLimit >= zero. Keep (visibilityLimit / avatarSize.CollisionDistance) < 10,000 to avoid aliasing artifacts (i.e. polygon “tearing”). Interchange profile hint: this field may be ignored, applying the default value regardless.
MFString [in, out] transitionType “LINEAR” [“TELEPORT”|”LINEAR”|”ANIMATE”]
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.
SFTime [in, out] transitionTime 1 [0,∞)
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.
SFBool [out] transitionComplete
Event signaling viewpoint transition complete. Interchange profile hint: this field may be ignored, applying the default value regardless.
SFBool [out] isBound
Event true sent when node becomes active, event false sent when unbound by another node.
SFTime [out] bindTime
Event sent when node becomes active/inactive.
Description
Hints
- For inspection of simple objects, usability often improves with type=”EXAMINE” “ANY”
- NavigationInfo, Background, TextureBackground, Fog, OrthoViewpoint and Viewpoint are bindable nodes, meaning that no more than one of each node type can be active at a given time.
- NavigationInfo types ‘“WALK” “FLY”’ support camera-to-object collision detection.
Warning
- Results are undefined if a bindable node (Viewpoint, OrthoViewpoint, NavigationInfo, Fog, Background, TextureBackground) is a contained child of LOD or Switch.