Configuration fields
- Last UpdatedOct 02, 2025
- 2 minute read
The configuration fields in the Navigation module.
|
Name |
Type |
Default value |
Description |
|---|---|---|---|
|
automaticClippingPlanesRecalculation |
sbool |
true |
When set to true, dynamically recalculates the near and far camera planes based on the target distance. In particular, near plane is calculated as the target distance divided by 100 and far plane is double the distance. However, near plane can not be smaller than minimumNearPlane configurationvalue and far plane can not be smaller than minimumFarPlane configuration value. |
|
avatarMoveUsingTrackerDirection |
sbool |
true |
When set to true and a VR device is used, the forward direction for movements is overridden with the headset tracker orientation. |
|
enabled |
sbool |
true |
Enables or disables the navigation module. |
|
focusDistanceMultiplier |
sfloat |
2.5 |
Used to modulate the speed of the focus movement, based on the distance of the movableNode from the focus target. |
|
minimumNearPlane |
sfloat |
0.01 |
Defines the minimum acceptable value for the near plane of the camera FOV, when FOV is dynamically recalculated. |
|
minimumFarPlane |
sfloat |
10000 |
Defines the minimum acceptable value for the near plane of the camera FOV, when FOV is dynamically recalculated. |
|
mouseWheelToAccelerate |
sbool |
true |
When set to true, allows to modulate the fly or shift velocity scrolling the mouse wheel, i.e. scrolling in to accelerate and scrolling out to decelerate. A multiplier is applied to the standard speed, based on the velocityMultiplierRange configuration. It is applied only when the movableNode input refers to a Camera or an Avatar with mode field set to controller. |
|
rotationSpeed |
sfloat |
0.1 |
Calculates the speed to rotate. |
|
speed |
sfloat |
5 |
Calculates the speed to walk, fly, shift, and pan. |
|
sprintSpeed |
sfloat |
15 |
When movableNode refers to a Camera, it is used to calculate the shift speed during sprint. When movableNode refers to an Avatar, it is used to calculate the run or fly run speed. |
|
timeToFocus |
sfloat |
0.5 |
Defines the time required to take a focus movement and make the movement smooth. |
|
useTargetDistance |
sbool |
true |
If set to true, when movableNode refers to a Camera or an Avatar with mode set to controller, zoom and pan speeds are modulated based on the distance from the camera target. |
|
velocityMultiplierRange |
svec2 |
0.1 5 |
Defines the minimum and maximum values to which the speed multiplier can be assigned. Speed multiplier is modulated by scrolling the mouse wheel during movements, when mouseWheelToAccelerate is set to true. Limits are included. |
|
zoomDistanceRange |
svec2 |
0 -1 |
Defines the range for zoom in and zoom out movements. Zoom in is always constrained by the camera target position. -1 corresponds to setting the limit to Infinity. |
|
zoomSpeed |
sfloat |
1 |
Used to calculate the speed to zoom. |