Setting Tag | Setting Value Type | Default Value | Setting Description |
rotateFactor | number | 3.0" |
Distance in physical coordinate units by which the mouse has to be moved in rotation mode to rotate the model by one radians. |
screenScalingDirection | vector | (0.0, -1.0, 0.0) |
Direction in screen coordinates along which the mouse has to slide to scale in scaling mode. |
scaleFactor | number | 3.0" |
Distance in physical coordinate units by which the mouse has to slide along the scaling direction in scaling mode to scale by a factor of e. |
wheelScaleFactor | number | 0.5 |
Scale factor to apply for each tick of the mouse wheel. |
probeSize | number | uiSize |
Radius in physical coordinate units of the probe sphere used to lock the display center to the surface. |
maxClimb | number | displaySize |
Maximum distance in physical coordinate units by which the probe sphere can climb when the display center is snapped to the surface. |
fixAzimuth | boolean | false |
Flag whether the current azimuth angle stays constant when the surface's local coordinate frame rotates. |
showCompass | boolean | true |
Flag whether to draw the compass rose showing the 0° azimuth direction ("north"). |
compassSize | number | uiSize*5.0 |
Radius of the displayed compass rose in physical coordinate units. |
compassThickness | number | uiSize*0.5 |
Thickness of the displayed compass rose's azimuth band in physical coordinate units. |
showScreenCenter | boolean | true |
Flag whether to show crosshairs indicating the screen plane and the screen center while the tool is active. |
interactWithWidgets | boolean | true |
Flag whether the tool's first button interacts with 3D GUI widgets if pressed over a displayed widget. |
Setting Tag | Setting Value Type | Default Value | Setting Description |
rotateFactors | list of three numbers | (-60.0°/s, -60.0°/s, 45.0°/s) |
Maximum rotation speeds in roll, pitch, and yaw, respectively, in degree/s. |
g | number | 9.81m/s2 |
Gravity acceleration in physical coordinate units per second squared. |
collectiveMin | number | 0.0m/s2 |
Minimum collective acceleration. |
collectiveMax | number | g*1.5 |
Maximum collective acceleration. |
thrust | number | g*1.0 |
Forward thrust acceleration. |
brake | number | g*0.5 |
Reverse thrust acceleration. |
dragCoefficients | vector | (0.3, 0.1, 0.3) |
Drag coefficient tensor in helicopter's local coordinate system. |
viewAngleFactors | list of two numbers | (35.0°, -25.0°) |
Yaw and pitch viewing angles in degrees when the respective valuators are at their maximum values. |
probeSize | number | 1.5m |
Radius in physical coordinate units of the probe sphere used to lock the viewer's feet to the surface. |
maxClimb | number | 1.5m |
Maximum distance in physical coordinate units by which the probe sphere can climb when the viewer's feet are snapped to the surface. |
Setting Tag | Setting Value Type | Default Value | Setting Description |
centerOnActivation | boolean | false |
Flag whether the tool's center point is set to the viewer's foot position when the tool is activated. |
centerPoint | point | displayCenter |
Center point of the movement circle in physical coordinate system. Is projected to environment's floor plane before activation. |
moveSpeed | number | displaySize/s |
Maximum walking speed in physical coordinate units per second if the viewer stepped outside the outer movement circle. |
innerRadius | number | displaySize*0.5 |
Radius of the inner movement circle. Movement speed is set to zero when the viewer is inside. |
outerRadius | number | displaySize*0.75 |
Radius of the outer movement circle. Movement speed varies linearly between zero and the maximum walking speed as the viewer moves from the inner circle to the outer circle. |
centerViewDirection | vector | forwardDirection |
Direction of the center line of the rotation cone. Is projected to environment's floor plane before activation. |
rotateSpeed | number | 120.0°/s |
Maximum rotation speed in degrees per second if the viewer looks outside the outer rotation angle. |
innerAngle | number | 30.0° |
Inner rotation angle. Rotation speed is set to zero while the view direction is inside. |
outerAngle | number | 120.0° |
Outer rotation angle. Rotation speed varies linearly between zero and maximum rotation speed as the viewer looks from the inner rotation angle to the outer rotation angle. |
fallAcceleration | number | 9.81m/s2 |
Acceleration when falling towards the surface in physical coordinate units per second squared. |
probeSize | number | 12.0" |
Radius in physical coordinate units of the probe sphere used to lock the viewer's feet to the surface. |
maxClimb | number | 24.0" |
Maximum distance in physical coordinate units by which the probe sphere can climb when the viewer's feet are snapped to the surface. |
fixAzimuth | boolean | false |
Flag whether the current azimuth angle stays constant when the surface's local coordinate frame rotates. |
drawMovementCircles | boolean | true |
Flag whether to draw the movement circles and the rotation cone while the tool is active. |
movementCircleColor | color | (0.0, 1.0, 0.0) |
Line color with which to draw the movement circles and rotation cone. |
drawHud | boolean | true |
Flag whether to draw the heads-up display indicating the current azimuth angle. |
Setting Tag | Setting Value Type | Default Value | Setting Description |
rotatePlaneOffset | number | 3.0" |
The mouse navigation tool uses an offset plane formula to calculate the rotation axis based on the mouse position and mouse motion in screen coordinates. If the plane offset is zero, any mouse movement will rotate around the screen's z axis (roll); a large plane offset will favor rotation around the screen's x and y axes (yaw and pitch, respectively). |
rotateFactor | number | 3.0" |
Distance in physical coordinate units by which the mouse pointer has to move on screen to rotate the view by one radians. |
invertDolly | boolean | false |
Flag whether to invert the scaling/dolly switch. If false, pressing buttons 1 and 2 together or rolling the mouse wheel will scale around the display center, while additionally pressing button 3 will dolly in or out of the screen plane. If true, the roles of scaling and dollying are reversed. |
screenDollyingDirection | vector | (0.0, -1.0, 0.0) |
Direction in screen coordinates along which the mouse has to slide to dolly in or out of the screen plane. |
screenScalingDirection | vector | (0.0, -1.0, 0.0) |
Direction in screen coordinates along which the mouse has to slide to scale. |
dollyFactor | number | 1.0 |
Distance in physical coordinate units by which the mouse has to slide along the dollying direction to dolly in or out by one physical coordinate unit. |
scaleFactor | number | 3.0" |
Distance in physical coordinate units by which the mouse has to slide along the scaling direction to scale by a factor of e. |
wheelDollyFactor | number | -12.0" |
Dollying distance in physical coordinate units to apply for each tick of the mouse wheel. |
wheelScaleFactor | number | 0.5 |
Scale factor to apply for each tick of the mouse wheel. |
spinThreshold | number | uiSize*2.0 |
Distance in physical coordinate units by which the mouse has to move while button 1 is released in rotation mode to trigger spinning animation. |
showScreenCenter | boolean | true |
Flag whether to show crosshairs indicating the screen plane and the screen center while the tool is active. |
interactWithWidgets | boolean | true |
Flag whether the tool's first button interacts with 3D GUI widgets if pressed over a displayed widget. |
Setting Tag | Setting Value Type | Default Value | Setting Description |
rotatePlaneOffset | number | 3.0" |
The mouse navigation tool uses an offset plane formula to calculate the rotation axis based on the mouse position and mouse motion in screen coordinates. If the plane offset is zero, any mouse movement will rotate around the screen's z axis (roll); a large plane offset will favor rotation around the screen's x and y axes (yaw and pitch, respectively). |
rotateFactor | number | 3.0" |
Distance in physical coordinate units by which the mouse pointer has to move on screen to rotate the view by one radians. |
screenDollyingDirection | vector | (0.0, -1.0, 0.0) |
Direction in screen coordinates along which the mouse has to slide to dolly in or out of the screen plane. |
screenScalingDirection | vector | (0.0, -1.0, 0.0) |
Direction in screen coordinates along which the mouse has to slide to scale. |
dollyFactor | number | 1.0 |
Distance in physical coordinate units by which the mouse has to slide along the dollying direction to dolly in or out by one physical coordinate unit. |
scaleFactor | number | 3.0" |
Distance in physical coordinate units by which the mouse has to slide along the scaling direction to scale by a factor of e. |
spinThreshold | number | uiSize*2.0 |
Distance in physical coordinate units by which the mouse has to move while button 1 is released in rotation mode to trigger spinning animation. |
interactWithWidgets | boolean | true |
Flag whether the tool's first button interacts with 3D GUI widgets if pressed over a displayed widget. |
Setting Tag | Setting Value Type | Default Value | Setting Description |
translateFactor | number | displaySize/3.0 |
Linear velocity factor in physical coordinate units per second by which the three translation vectors will be multiplied. |
translationVectors | list of vectors | ((1.0, 0.0, 0.0), (0.0, 1.0, 0.0), (0.0, 0.0, 1.0)) |
List of exactly three unitless translation vectors in physical space. Each vector will be multiplied by the translateFactor to calculate the final physical-space translation vectors. |
rotateFactor | number | 180.0°/s |
Angular velocity factor in degrees per second by which the three scaled rotation axes will be multiplied. |
scaledRotationAxes | list of vectors | ((1.0, 0.0, 0.0), (0.0, 1.0, 0.0), (0.0, 0.0, 1.0)) |
List of exactly three unitless scaled rotation axes in physical space. Each axis will be multiplied by the rotateFactor to calculate the final physical-space scaled rotation axes. |
zoomFactor | number | 1.0 |
Unitless zoom factor in 1/s. This is the natural logarithm of the zoom factor achieved when the zoom axis is held at its maximal value for one second. |
navigationCenter | point | displayCenter |
Center point for rotation and zooming navigation. |
followDisplayCenter | boolean | true |
Flag whether the navigation center shall follow Vrui's display center (in which case the configured navigation center is ignored). |
invertNavigation | boolean | false |
Switches between camera-in-hand navigation mode (if false) and world-in-hand navigation mode (if true). |
showNavigationCenter | boolean | true |
Flag whether to show crosshairs indicating the center of navigation while the tool is active. |
Setting Tag | Setting Value Type | Default Value | Setting Description |
valuatorThreshold | number | 0.25 |
Minimum absolute valuator value at which the tool becomes active. |
valuatorExponent | number | 1.0 |
Exponent applied to absolute valuator value to enable non-linear behavior. |
superAccelerationFactor | number | 1.1/s |
While the first valuator is held at its maximal absolute value, the flying speed increases by this factor every second. |
flyDirectionDeviceCoordinates | boolean | true |
Flag whether the fly direction is defined in the device's local coordinate system (true) or in physical coordinates (false). |
flyDirection | vector | (0.0, 1.0, 0.0) |
Unit vector defining the flying direction for the first valuator in device's local coordinate system, or in physical coordinate system. |
flyFactor | number | displaySize*2.0/s |
Maximum flying speed in physical coordinate units per second if first valuator is held a maximum absolute value, and without superacceleration. |
rotationAxisDeviceCoordinates | boolean | true |
Flag whether the rotation axis is defined in the device's local coordinate system (true) or in physical coordinates (false). |
rotationAxis | vector | (0.0, 0.0, 1.0) |
Unit vector defining rotation axis for the second valuator in device's local coordinate system, or in physical coordinate system. |
rotationCenterDeviceCoordinates | boolean | true |
Flag whether the center of rotation is defined in the device's local coordinate system (true) or in physical coordinates (false). |
rotationCenter | point | (0.0, 0.0, 0.0) |
Center of rotation for second valuator in device's local coordinate system, or in physical coordinate system. |
rotationFactor | number | 90.0°/s |
Rotation speed in degrees per second, if the respective valuator is at maximum absolute value. |
Setting Tag | Setting Value Type | Default Value | Setting Description |
centerOnActivation | boolean | false |
Flag whether the tool's center point is set to the viewer's foot position when the tool is activated. |
centerPoint | point | displayCenter |
Center point of the movement circle in physical coordinate system. Is projected to environment's floor plane before activation. |
moveSpeed | number | displaySize/s |
Maximum walking speed in physical coordinate units per second if the viewer stepped outside the outer movement circle. |
innerRadius | number | displaySize*0.5 |
Radius of the inner movement circle. Movement speed is set to zero when the viewer is inside. |
outerRadius | number | displaySize*0.75 |
Radius of the outer movement circle. Movement speed varies linearly between zero and the maximum walking speed as the viewer moves from the inner circle to the outer circle. |
centerViewDirection | vector | forwardDirection |
Direction of the center line of the rotation cone. Is projected to environment's floor plane before activation. |
rotateSpeed | number | 120.0°/s |
Maximum rotation speed in degrees per second if the viewer looks outside the outer rotation angle. |
innerAngle | number | 30.0° |
Inner rotation angle. Rotation speed is set to zero while the view direction is inside. |
outerAngle | number | 120.0° |
Outer rotation angle. Rotation speed varies linearly between zero and maximum rotation speed as the viewer looks from the inner rotation angle to the outer rotation angle. |
drawMovementCircles | boolean | true |
Flag whether to draw the movement circles and the rotation cone while the tool is active. |
movementCircleColor | color | (0.0, 1.0, 0.0) |
Line color with which to draw the movement circles and rotation cone. |
Setting Tag | Setting Value Type | Default Value | Setting Description |
viewpointFileName | string | "" |
Name of the viewpoint or curve file to load when a tool of this class is created. If the file name is left empty, a newly-instantiated tool will open a file selection dialog to load a file interactively.
If the specified or selected file name has extension ".views", the tool will read a sequence of animation keyframes, and calculate an interpolating cubic animation spline on-the-fly. If the specified or selected file name has extension ".curve", the tool will read a sequence of cubic Hermite spline sections and play them back exactly as specified. |
showKeyframes | boolean | true |
Flag whether to show a representation of the next keyframe during animation. Keyframes are drawn as two lines: a green line indicating the keyframe's "forward" direction, and a red line indicating its "up" direction. The intersection point of the two lines is the keyframe's display center, and the lengths of the lines indicate the keyframe's display size. |
pauseFileName | string | "ViewpointFileNavigation.pauses" |
If a file of this name exists when a tool of this class is created, the newly-instantiated tool will read a list of time stamps (in seconds) from it. The tool will automatically pause playback when reaching any of the time stamps, and can be re-activated by pressing the activation button. |
autostart | boolean | false |
Flag whether the tool will start animating immediately after construction. |
Setting Tag | Setting Value Type | Default Value | Setting Description |
homePosition | point | displayCenter |
Home position for the tool's virtual input device. Newly-instantiated tools position their virtual devices at the home position, and pressing the home button will return the virtual input device to the home position. |
translateFactor | number | displaySize/3.0 |
Linear velocity factor in physical coordinate units per second by which the three translation vectors will be multiplied. |
translationVectors | list of vectors | ((1.0, 0.0, 0.0), (0.0, 1.0, 0.0), (0.0, 0.0, 1.0)) |
List of exactly three unitless translation vectors in physical space. Each vector will be multiplied by the translateFactor to calculate the final physical-space translation vectors. |
rotateFactor | number | 180.0°/s |
Angular velocity factor in degrees per second by which the three scaled rotation axes will be multiplied. |
scaledRotationAxes | list of vectors | ((1.0, 0.0, 0.0), (0.0, 1.0, 0.0), (0.0, 0.0, 1.0)) |
List of exactly three unitless scaled rotation axes in physical space. Each axis will be multiplied by the rotateFactor to calculate the final physical-space scaled rotation axes. |
deviceGlyphType | glyph type | Cone |
Type of glyph used to draw a 3D representation of the virtual input device in the Vrui display environment. |
deviceGlyphMaterial | material | {AmbientDiffuse=(0.5, 0.5, 0.5); Specular=(1.0, 1.0, 1.0); Shininess=25.0;} |
Material properties to render the virtual input device's glyph. |