| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Locate point at device position. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Locate point at projection of device position on closest screen. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| crosshairSize | number | uiSize*2.0 | Size of the crosshairs indicating the tool's screen position, in physical coordinate units. If set to zero, no crosshairs will be drawn. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Locate point at device position; scale translations and rotations of device while active. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| linearScale | number | 0.25 | Scale factor between translations of the tool's device and the locator while active. |
| angularScale | number | 0.25 | Scale factor between rotations of the tool's device and the locator while active. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Drag from device position. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Drag from device position; scale translations and rotations of device while active. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| linearScale | number | 0.25 | Scale factor between translations of the tool's device and the dragger while active. |
| angularScale | number | 0.25 | Scale factor between rotations of the tool's device and the dragger while active. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 2 | 1: Rotate around display center. Optionally: Interact with 3D GUI widgets. 2: If 1 not pressed: Pan along surface. Otherwise: Scale around display center. |
| Required Valuators | 1 | Scale around display center. |
| 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. |
| throwThreshold | number | uiSize*2.0 | Distance in physical coordinate units by which the mouse has to move while button 2 is released in panning mode to trigger throwing animation. |
| 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. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 5 | 1: Toggle tool activation state. 2: Strafe left. 3: Strafe right. 4: Walk backwards. 5: Walk forward. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| rotateFactor | number | 12.0" | Distance in physical coordinate units by which the mouse has to be moved to rotate the model by one radians. |
| moveSpeed | number | 120.0"/s | Movement speed in physical coordinate units per second. |
| 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. |
| showHud | boolean | true | Flag whether to draw the heads-up display indicating the current aziumth. |
| levelOnExit | boolean | false | Flag whether to reset the tool's elevation to zero upon deactivation. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | 1: Tool activation state. |
| Required Valuators | 6 | 1: Translate along local X axis (right/left). 2: Translate along local Y axis (forward/backwards). 3: Translate along local Z axis (up/down). 4: Rotate around surface Z axis (yaw). 5: Rotate around surface X axis (pitch). 6: Rotate around surface Y axis (roll). |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| activationToggle | boolean | true | Flag whether the activation button acts as a toggle. |
| translateFactors | list of three numbers | (displaySize, displaySize, displaySize) | Maximum translation speeds along X, Y, and Z axes, respectively, in physical coordinate units/s. |
| rotateFactors | list of three numbers | (180.0°/s, 180.0°/s, 180.0°/s) | Maximum rotation speeds in yaw, pitch, and roll, respectively, in degree/s. |
| canRoll | boolean | true | Flag whether the navigation tool allows rolling away from level orientation. |
| bankTurns | boolean | false | Flag whether the navigation tool links roll angle to the current yaw angular velocity. |
| bankFactor | number | 60.0 | Maximum banking angle during banking turns. |
| levelSpeed | positive number | 5.0 | Relative speed at which the navigation tool attains a given roll angle. |
| canFly | boolean | true | Flag whether the navigation tool allows flying above the surface. |
| 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. |
| fixAzimuth | boolean | false | Flag whether the current azimuth angle stays constant when the surface's local coordinate frame rotates. |
| drawHud | boolean | true | Flag whether to draw the six-axis navigation tool's heads-up display, indicating azimuth, elevation, and roll angles. |
| hudColor | color | (0.0, 1.0, 0.0) | Color to draw the HUD. |
| hudDist | number | Distance from main viewer's head position to displayCenter | Distance from the viewer's eye to the HUD plane in physical coordinate units. |
| hudRadius | number | displaySize | Radius of the HUD physical coordinate units. |
| hudFontSize | number | uiSize*1.5 | Font size for the HUD in physical coordinate units. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 3 | 1: Tool activation state. 2: Forward thrust. 3: Reverse thrust. |
| Required Valuators | 6 | 1: Cyclic pitch control. 2: Cyclic roll control. 3: Rudder yaw control. 4: Collective control. 5: Viewing yaw. 6: Viewing pitch. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| activationToggle | boolean | true | Flag whether the activation button acts as a toggle. |
| 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. |
| drawHud | boolean | true | Flag whether to draw the helicopter tool's heads-up display, indicating azimuth, elevation, and roll angles and relative flight path. |
| hudColor | color | (0.0, 1.0, 0.0) | Color to draw the HUD. |
| hudDist | number | Distance from main viewer's head position to displayCenter | Distance from the viewer's eye to the HUD plane in physical coordinate units. |
| hudRadius | number | displaySize | Radius of the HUD physical coordinate units. |
| hudFontSize | number | uiSize*1.5 | Font size for the HUD in physical coordinate units. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Toggle tool's activation state. |
| Optional Valuators | 1 | Fire a "jetpack" thruster along the ray direction of the device associated with the valuator. |
| 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. |
| jetpackAcceleration | number | fallAcceleration*1.5 | Maximum acceleration of virtual jetpack 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. |
| hudFontSize | number | uiSize*2.0 | Size of heads-up display's font in physical coordinate units. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 3 | 1: Rotate around screen center. Optional: Interact with 3D GUI widgets. 2: If 1 not pressed: Pan in screen plane. Otherwise: Scale around display center, or dolly in or out of screen plane. 3: Switch between scaling and dollying. |
| Required Valuators | 1 | Scale around display center, or dolly in or out of screen plane. |
| 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 | 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. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Rotate around screen center, or pan in screen plane, or scale around the display center, or dolly in or out of the screen plane. |
| 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. |
| Input | Number | Function Description |
|---|---|---|
| Required Valuators | 7 | 1: Translate along vector 0 2: Translate along vector 1 3: Translate along vector 2 4: Rotate around axis 0 5: Rotate around axis 1 6: Rotate around axis 2 7: Zoom |
| 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. |
| 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. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Grab space at device position. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Scale around initial device position. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| scaleDirection | vector | (0.0, 1.0, 0.0) | Direction of scaling line in device's local coordinate system. |
| scaleFactor | number | -8.0" | Distance in physical coordinate units by which the device has to slide along the scaling line to scale by a factor of e. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Grab virtual trackball and rotate. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| rotateFactor | number | 1.0 | Number of degrees by which the model rotates if the virtual trackball is rotated by one degree. |
| Input | Number | Function Description |
|---|---|---|
| Required Valuators | 1 | 1: Scale around device's initial position. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| valuatorThreshold | number | 0.25 | Minimum absolute valuator value at which the tool becomes active. |
| scalingFactor | number | 0.25/s | Maximum change in scale per second, if valuator is held at maximum absolute value. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 2 | 1: Grab space. 2: If 1 already pressed: Scale around device position. Otherwise: Forwarded button. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| scaleFactor | number | -8.0" | Distance in physical coordinate units by which the device has to slide along the scaling line to scale by a factor of e. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 2 | 1: If device is away from second device: Grab space. Otherwise: Scale around second device position. 2: Forwarded button. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| scaleDeviceDistance | number | 4.0" | Maximum distance between the two devices at which tool goes into scaling mode when activated. |
| deviceScaleDirection | vector | (0.0, 1.0, 0.0) | Direction of scaling line in second device's local coordinate system. |
| scaleFactor | number | 8.0" | Distance in physical coordinate units by which the device has to slide along the scaling line to scale by a factor of e. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 2 | 1 or 2: By itself: Grab space. Otherwise: Scale around other device's position. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Grab space. |
| Optional Buttons | >=0 | Grab space. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| translationFactor | number | 1.0 | Number of units by which the model translates if the centroid of the currently active devices moves by one unit. |
| minRotationScalingDistance | number | 1.0" | Minimum separation distance between two active devices to allow rotation and scaling. |
| rotationFactor | number | 1.0 | Number of degrees by which the model translates if the currently active devices rotate around their centroid by one degree. |
| scalingFactor | number | 1.0 | Ratio between the factor by which the model is scaled to the factor by which the configuration of currently active devices is scaled. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Fly in device-relative direction. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| flyDirection | vector | (0.0, 1.0, 0.0) | Unit vector defining the flying direction in device's local coordinate system. |
| flyFactor | number | displaySize*0.5/s | Flying speed in physical coordinate units per second. |
| Input | Number | Function Description |
|---|---|---|
| Required Valuators | 1 | Fly in device-relative direction. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| valuatorThreshold | number | 0.25 | Minimum absolute valuator value at which the tool becomes active. |
| flyDirection | vector | (0.0, 1.0, 0.0) | Unit vector defining the flying direction in device's local coordinate system. |
| flyFactor | number | displaySize*0.5/s | Flying speed in physical coordinate units per second, if valuator is at maximum absolute value. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Fly in device-relative direction. |
| Required Valuators | 2 | 1: Rotate around first axis. 2: Rotate around second axis. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| valuatorThreshold | number | 0.25 | Minimum absolute valuator value at which the tool becomes active. |
| flyDirection | vector | (0.0, 1.0, 0.0) | Unit vector defining the flying direction in device's local coordinate system. |
| flyFactor | number | displaySize*0.5/s | Flying speed in physical coordinate units per second. |
| rotationAxis0 | vector | (0.0, 0.0, 1.0) | Unit vector defining rotation axis for first valuator in device's local coordinate system. |
| rotationAxis1 | vector | (1.0, 0.0, 0.0) | Unit vector defining rotation axis for second valuator in device's local coordinate system. |
| rotationCenter | point | (0.0, 0.0, 0.0) | Center of rotation for both axes in device's local coordinate system. |
| rotationFactor | number | 90.0°/s | Rotation speed in degrees per second, if the respective valuator is at maximum absolute value. |
| Input | Number | Function Description |
|---|---|---|
| Required Valuators | 2 | 1: Fly in device-relative direction. 2: Rotate around axis. |
| 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. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Toggle tool's activation state. |
| 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. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Move device's position to display center, and its pointing direction to the forward direction. If pressed again during animation, jump immediately to final position and orientation. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| linearSnapThreshold | number | displaySize*0.25 | Maximum translation distance in physical coordinate units for which the tool will skip animation and jump directly to the final position. |
| angularSnapThreshold | number | 15.0° | Maximum rotation angle in degrees for which the tool will skip animation and jump directly to the final orientation. |
| maxLinearVelocity | number | displaySize*5.0/s | Maximum linear velocity in physical coordinate units per second during animation. |
| maxAngularVelocity | number | 90.0°/s | Maximum angular velocity in degrees per second during animation. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Jump to the position of the input device, using a fancy forward flip. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| gravity | number | 9.81m/s2 | Gravity acceleration in physical coordinate units per second squared. |
| jumpTime | number | 1.0s | Time to complete the jump to the input device's position in seconds. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Toggle tool's activation state. When the tool is deactivated during animation, it will resume animation at the interrupted point when re-activated. |
| 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. |
| Input | Number | Function Description |
|---|---|---|
| Optional Buttons | >=0 | Forwarded to virtual input device. |
| Optional Valuators | >=0 | Forwarded to virtual input device. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| rayOffset | number | uiSize*2.0 | Distance in physical coordinate units by which to move back the start position of intersection rays. |
| crosshairSize | number | 0.0" | Size of crosshairs in physical coordinate units to indicate the position of the virtual input device in the screen plane. If left at 0.0", no crosshairs will be drawn. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Set the simulated valuator to value +1.0. |
| Optional Buttons | >=0 | Set the simulated valuator to value -1.0. |
| Input | Number | Function Description |
|---|---|---|
| Required Valuators | 1 | Simulate two buttons; one pressed when valuator is positive, one pressed when valuator is negative. |
| Optional Valuators | >=0 | Simulate two buttons; one pressed when valuator is positive, one pressed when valuator is negative. |
| Input | Number | Function Description |
|---|---|---|
| Optional Buttons | >=0 | Forwarded to virtual input device. |
| Optional Valuators | >=0 | Forwarded to virtual input device. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Reset the virtual input device to its home position. |
| Optional Buttons | >=0 | Forwarded to virtual input device. |
| Required Valuators | 6 | 1: Translate along vector 0 2: Translate along vector 1 3: Translate along vector 2 4: Rotate around axis 0 5: Rotate around axis 1 6: Rotate around axis 2 |
| Optional Valuators | >=0 | Forwarded to virtual input device. |
| 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. |
| Input | Number | Function Description |
|---|---|---|
| Optional Buttons | >=0 | Forwarded to virtual input device. |
| Optional Valuators | >=0 | Forwarded to virtual input device. |
| Input | Number | Function Description |
|---|---|---|
| Optional Buttons | >=0 | Forwarded to virtual input device. |
| Optional Valuators | >=0 | Forwarded to virtual input device. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| offset | tracker state | translate (0.0, displaySize*0.5, 0.0) | Offset transformation from source input device to transformed input device, in source device's local coordinate system. |
| Input | Number | Function Description |
|---|---|---|
| Optional Buttons | >=0 | Forwarded to virtual input device. |
| Optional Valuators | >=0 | Forwarded to virtual input device. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| linearScale | number | 0.25 | Scale factor between translations of the tool's source device and the transformed device while active. |
| angularScale | number | 0.25 | Scale factor between rotations of the tool's tool's source device and the transformed device while active. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Disengage source input device from transformed input device. |
| Optional Buttons | >=0 | Forwarded to virtual input device. |
| Optional Valuators | >=0 | Forwarded to virtual input device. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| clutchButtonToggleFlag | boolean | false | Flag whether the clutch button acts as a toggle. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Shift between button/valuator planes. |
| Optional Buttons | >=0 | Forwarded to virtual input device. |
| Optional Valuators | >=0 | Forwarded to virtual input device. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| toggle | boolean | false | Flag whether the shift button acts as a toggle. |
| forwardShiftButton | boolean | false | Flag whether the shift button itself is forwarded to both button planes, reflecting the status of the currently active plane. |
| resetFeatures | boolean | false | Flag whether buttons and valuators reset to their default values when the tool shifts away from their plane. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Cycle revolver chamber. |
| Optional Buttons | >=0 | Forwarded to virtual input device. |
| Optional Valuators | >=0 | Forwarded to virtual input device. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| numChambers | integer | 6 | Number of chambers on the revolver. Each chamber contains copies of all optional forwarded buttons and valuators. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| useEyeRay | boolean | false | Flag whether all classes derived from UserInterfaceTool use a ray from the main viewer's head position to the device position as interaction ray instead of the device's own ray direction. |
| rayOffset | number | uiSize*2.0 | Distance in physical coordinate units by which to move back the start position of interaction rays when not using eye rays. |
| drawRay | boolean | true if useEyeRay is false; true otherwise | Flag whether all classes derived from UserInterfaceTool draw the interaction ray when active. |
| rayWidth | number | 3.0 | Cosmetic line width to draw the interaction ray in pixels. |
| rayColor | color | (1.0, 0.0, 0.0) | Color with which to draw the interaction ray. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Pop up and interact with menu. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| initialMenuOffset | number | 6.0" | Distance in physical coordinate units along device's interaction ray from device's position to menu pop-up position. |
| interactWithWidgets | boolean | false | Flag whether the tool's button interacts with 3D GUI widgets if pressed over a displayed widget. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Pop up and interact with menu. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| interactWithWidgets | boolean | false | Flag whether the tool's button interacts with 3D GUI widgets if pressed over a displayed widget. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Forwarded button. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Grab virtual input device. |
| Optional Buttons | >=0 | Forwarded to grabbed virtual input device. |
| Optional Valuators | >=0 | Forwarded to grabbed virtual input device. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| rotateFactor | number | 3.0" | Distance in physical coordinate units by which a virtual input device's edge has to be dragged to rotate by one radians. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 8 | 1: Switch control to the next virtual input device. 2: Switch between translation and rotation modes. 3: Translate along -X or rotate around -Z. 4: Translate along +X or rotate around +Z. 5: Translate along -Y or rotate around -Y. 6: Translate along +Y or rotate around +Y. 7: Translate along -Z or rotate around -X. 8: Translate along +Z or rotate around +X. |
| Optional Buttons | >=0 | Forwarded to currently controlled virtual input device. |
| Optional Valuators | >=0 | Forwarded to currently controlled virtual input device. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| translateFactor | number | 4.0"/s | Speed in physical coordinate units by which the controlled virtual input device moves if a translate button is pressed. |
| rotateFactor | number | 60.0°/s | Angular speed by which the controlled virtual input device rotates if a rotate button is pressed. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Grab virtual input device based on ray selection. |
| Optional Buttons | >=0 | Forwarded to grabbed virtual input device. |
| Required Valuators | 6 | 1: Translate along vector 0 2: Translate along vector 1 3: Translate along vector 2 4: Rotate around axis 0 5: Rotate around axis 1 6: Rotate around axis 2 |
| Optional Valuators | >=0 | Forwarded to grabbed virtual input device. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| selectButtonToggle | boolean | true | Flag whether the grab button acts as a toggle. |
| 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. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Grab virtual input device. |
| Optional Buttons | >=0 | Forwarded to grabbed virtual input device. |
| Optional Valuators | >=0 | Forwarded to grabbed virtual input device. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| selectButtonToggle | boolean | false | Flag whether the grab button acts as a toggle. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Grab virtual input device or select plane points. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| markerSize | number | uiSize | Size of the markers indicating the tool's currently selected plane points, in physical coordinate units. If set to zero, no markers will be drawn. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Interact with GUI widgets. |
| Input | Number | Function Description |
|---|---|---|
| Required Valuators | 1 | Scroll in GUI widgets. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Select in daisy wheel. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Pop up and interact with QuikWrite panel. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| squareSize | number | uiFontTextHeight*10.0 | Overall side length of QuikWrite panel. |
| initialSquareDist | number | 3.0" | Initial distance in physical coordinate units along device's selection ray when popping up the QuikWrite panel. |
| backgroundColor | color | backgroundColor | Background color for the QuikWrite panel. |
| foregroundColor | color | Complement of backgroundColor | Foreground and text color for the QuikWrite panel. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | 1 | Activate laser pointer. |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|---|---|---|
| rayLength | number | displaySize*5.0 | Length of the laser pointer ray in physical coordinate units. |
| rayLineWidth | number | 3.0 | Cosmetic line width in pixels with which to draw the laser pointer ray. |
| rayColor | color | (1.0, 0.0, 0.0) | Color with which to draw the laser pointer ray. |
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | ||
| Optional Buttons | ||
| Required Valuators | ||
| Optional Valuators |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | ||
| Optional Buttons | ||
| Required Valuators | ||
| Optional Valuators |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | ||
| Optional Buttons | ||
| Required Valuators | ||
| Optional Valuators |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | ||
| Optional Buttons | ||
| Required Valuators | ||
| Optional Valuators |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | ||
| Optional Buttons | ||
| Required Valuators | ||
| Optional Valuators |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | ||
| Optional Buttons | ||
| Required Valuators | ||
| Optional Valuators |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | ||
| Optional Buttons | ||
| Required Valuators | ||
| Optional Valuators |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | ||
| Optional Buttons | ||
| Required Valuators | ||
| Optional Valuators |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|
| Input | Number | Function Description |
|---|---|---|
| Required Buttons | ||
| Optional Buttons | ||
| Required Valuators | ||
| Optional Valuators |
| Setting Tag | Setting Value Type | Default Value | Setting Description |
|---|
| Input | Number | Function Description |
|---|---|---|
| Optional Buttons | >=0 | Ignored buttons. |
| Optional Valuators | >=0 | Ignored valuators. |