official documentation

  1. x3dom.org
  2. documentation
  3. Developer API

Class: NavigationInfo

X3D: 3.3
Component: Navigation
Status:
experimental

Quick Links

➨ Fields
➨ Properties

.nodeTypes. NavigationInfo

NavigationInfo describes the viewing model and physical characteristics of the viewer's avatar. Hint: for inspection of simple objects, usability often improves with type='EXAMINE' 'ANY' Hint: NavigationInfo types ''WALK' 'FLY'' support camera-to-object collision detection. Background, Fog, NavigationInfo, TextureBackground and Viewpoint are bindable nodes.

HTML Encoding and Default Values⤴

<NavigationInfo avatarSize='[ 0.25, 1.6, 0.75 ]' bind='false' description='""' explorationMode=''all'' headlight='true' isActive='false' metadata='X3DMetadataObject' reverseScroll='false' speed='1.0' transitionTime='1.0' transitionType='["LINEAR"]' type='["EXAMINE","ANY"]' typeParams='[-0.4,60,0.05,2.8]' visibilityLimit='0.0' walkDamping='2.0' ></NavigationInfo>

Inheritance⤴


Constructor⤴

Constructor for NavigationInfo

Parameters:
Name Type Argument Default Description
ctx Object <optional>
 null context object, containing initial settings like namespace

Fields⤴

These are the X3D / X3DOM fields of this node. Values should usually be received / set as strings via DOM functions (i.e., using setAttribute("myFieldName", "myFieldValue") and getAttribute("myFieldName")).
Name Type Default Value Range Inheritance Standard Description
avatarSize MFFloat 75 ] 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 (avatarSize.CollisionDistance / visibilityLimit) less then; 10,000 to avoid aliasing artifacts (i.e. polygon 'tearing'). Interchange profile hint: this field may be ignored.
bind SFBool false X3DBindableNode Pushes/pops the node on/from the top of the bindable stack
description SFString "" X3DBindableNode Description of the bindable node
explorationMode SFString 'all' [all, pan, zoom, rotate, -pan, -zoom, -rotate, none] allows restricting examine and turntable navigation, overrides mouse buttons (useful for special viewers)
headlight SFBool true Enable/disable directional light that always points in the direction the user is looking.
isActive SFBool false X3DBindableNode
metadata SFNode X3DMetadataObject X3DNode Field to add metadata information
reverseScroll SFBool false Enable/disable reversed mousewheel scrolling to zoom.
speed SFFloat 1.0 [0, inf] 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.
transitionTime SFTime 1.0 [0, inf] The transitionTime field specifies the duration of any viewpoint transition
transitionType MFString ["LINEAR"] [LINEAR, TELEPORT, ANIMATE, ...] Specifies the transition mode.
type MFString ["EXAMINE","ANY"] {"ANY","WALK","EXAMINE","FLY","LOOKAT","NONE","EXPLORE",...} defines the navigation type
typeParams MFFloat 8] Specifies the view angle and height for helicopter mode and min/max rotation angle for turntable in ]0, PI[, starting from +y (0) down to -y (PI)
visibilityLimit SFFloat 0.0 [0, inf] Geometry beyond the visibilityLimit may not be rendered (far culling plane of the view frustrum). visibilityLimit=0.0 indicates an infinite visibility limit. Hint: keep visibilityLimit greater than zero. Hint: keep (avatarSize.CollisionDistance / visibilityLimit) less than 10,000 to avoid aliasing artifacts (i.e. polygon 'tearing'). Interchange profile hint: this field may be ignored.
walkDamping SFFloat 2.0 Factor for damping the walk animation Interchange profile hint: this field may be ignored.