Input fields
- Last UpdatedOct 21, 2025
- 3 minute read
The input fields in the Navigation module.
|
Name |
Type |
Description |
|---|---|---|
|
axis_0 |
svec3 |
When movableNode refers to an Avatar, this field is internally used to calculate pan, fly, walk, slide and climb movements. While, when movableNode refers to a Camera, this field is internally used to calculate shift movement. |
|
axis_1 |
svec3 |
When movableNode refers to an Avatar, this field is internally used to calculate self and target rotations. While, when movableNode refers to a Camera, this field is internally used to calculate pan movement and self and target rotations. |
|
enabled |
sbool |
Enables or disables the navigation module. It is initialized using the corresponding configuration value. |
|
focusTarget |
svec4 |
Target position for the focus movement. |
|
focusOnTarget |
sevent |
Invoke it to start a focus movement. |
|
isCrouch |
sbool |
If set to true, it is used to inform the module a crouch movement needs to be performed. It only works when movableNode is an Avatar with mode set to player. |
|
isPan |
sbool |
If set to true, it is used to inform the module a pan movement needs to be performed. |
|
isSelection |
sbool |
If set to true, it is used to prevent crouching or climbing, when movableNode is an Avatar with mode set to player. |
|
isSelfRotate |
sbool |
If set to true, it is used to inform the module self rotation needs to be performed. |
|
isSprint |
sbool |
Increases the movement speed, such as sprintSpeed is used for walk, shift, and pan instead of speed. |
|
isTartgetRotate |
sbool |
If set to true, it is used to inform the module target rotation needs to be performed. |
|
isZoomIn |
sbool |
If set to true, it is used to inform the module a zoom in movement needs to be performed. It works when movableNode refers to a Camera or an Avatar with mode set to controller. |
|
isZoomOut |
sbool |
If set to true, it is used to inform the module a zoom out movement needs to be performed. It works when movableNode refers to a Camera or an Avatar with mode set to controller. |
|
isZoomTrigger |
sbool |
If set to true, it is used to inform the module a zoom movement needs to be performed. It only works when movableNode refers to an Avatar with mode set to player. |
|
movableNode |
string |
The name of the Camera or Avatar node to be used for navigation. It can either corresponds to the MovableNode output of the MovableNode module or be the name of any Camera or Avatar node the user desires to use. Please note that only cameras of type matrix are supported. |
|
mouseWheelDelta |
sfloat |
Represents the mouse wheel scrolling delta. When movableNode refers to an Avatar with mode set to player, this input is used in the zoom movement calculation. Positive values of the mouseWheelDelta input allow zooming in, while negative values are used for zooming out. |
|
overrideRotationTarget |
sbool |
When set to true, rotation target and rotationTargetPosition output are overridden with the given overrideRotationTargetPosition input value, otherwise they are internally calculated. |
|
overrideRotationTargetPosition |
svec3 |
Position used to override the rotation target when overrideRotationTarget is set to true. |
|
rotationSpeed |
sfloat |
Calculates the speed to rotate. It is initialized using the corresponding configuration value. |
|
speed |
sfloat |
Calculates the speed to walk, fly, shift, and pan. It is initialized using the corresponding configuration value. |
|
sprintSpeed |
sfloat |
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. It is initialized using the corresponding configuration value. |
|
useTargetDistance |
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. It is initialized using the corresponding configuration value. |
|
|
teleport |
sevent |
Starts a teleport movement. |
|
teleportFinalPosition |
svec3 |
Position of the movableNode after the teleport finishes. |
|
teleportFinalRotation |
svec2 |
Rotation of the movableNode after the teleport finishes. The values are in radians. |
|
timeToTeleport |
sfloat |
Time to wait before teleport starts. |
|
switchCameraMode |
sevent |
Can be used only when the movableNode input referes to an Avatar. If mode is player, it switches cameraMode following the order fps-behind-over. If mode is controller, it switches the associated AvatarControllerViewer mode following the order walk-fly-cad-orbit-target-cvp3dvs. |
|
zoomSpeed |
sfloat |
Calculates the speed to zoom. It is initialized using the corresponding configuration value. |