Interface VehicleNavigationControllerParams

Configures VehicleNavigationController.

interface VehicleNavigationControllerParams {
    acceleration?: number;
    active?: boolean;
    aircraftControlSurfaces?: boolean;
    bodyRadius?: number;
    brakeDeceleration?: number;
    cameraHeight?: number;
    coastDeceleration?: number;
    collision?: boolean;
    controlSurfaceResponse?: number;
    controlSurfaceReturnResponse?: number;
    cursorTurnDeadZone?: number;
    cursorTurnResponse?: number;
    driveSurfaceFilter?: (objectId: string) => boolean;
    fallAcceleration?: number;
    flightAcceleration?: number;
    flightAirDrag?: number;
    flightBrakeDeceleration?: number;
    flightGravity?: number;
    flightLandingFallSpeed?: number;
    flightMinGlideSpeed?: number;
    flightPitchRateDegreesPerSecond?: number;
    flightSoftLandingRange?: number;
    flightSteeringResponse?: number;
    flightTakeoffHeight?: number;
    flightTakeoffSpeed?: number;
    gravity?: boolean;
    keyboardEnabledOnlyOnMouseover?: boolean;
    keyboardPitchInFlight?: boolean;
    keySteerInitialScale?: number;
    keySteerRampSeconds?: number;
    leanDegrees?: number;
    leanSmoothing?: number;
    maxFall?: number;
    maxFallSpeed?: number;
    maxFlightPitchDegrees?: number;
    maxForwardSpeed?: number;
    maxMouseDragInputPerFrame?: number;
    maxPitchDegrees?: number;
    maxReverseSpeed?: number;
    maxSlopeDegrees?: number;
    maxSlopePitchDegrees?: number;
    mouseDragPitchSensitivity?: number;
    mouseDragResponse?: number;
    mouseDragYawSensitivity?: number;
    obstacleFilter?: (objectId: string) => boolean;
    raycaster?: SceneRaycaster;
    relativeMouseSensitivity?: number;
    slopePitchFactor?: number;
    slopePitchSmoothing?: number;
    stepHeight?: number;
    suspendModelNavigationController?: viewing.navigation.model.ModelNavigationController;
    turnRateDegreesPerSecond?: number;
}

Properties

acceleration? active? aircraftControlSurfaces? bodyRadius? brakeDeceleration? cameraHeight? coastDeceleration? collision? controlSurfaceResponse? controlSurfaceReturnResponse? cursorTurnDeadZone? cursorTurnResponse? driveSurfaceFilter? fallAcceleration? flightAcceleration? flightAirDrag? flightBrakeDeceleration? flightGravity? flightLandingFallSpeed? flightMinGlideSpeed? flightPitchRateDegreesPerSecond? flightSoftLandingRange? flightSteeringResponse? flightTakeoffHeight? flightTakeoffSpeed? gravity? keyboardEnabledOnlyOnMouseover? keyboardPitchInFlight? keySteerInitialScale? keySteerRampSeconds? leanDegrees? leanSmoothing? maxFall? maxFallSpeed? maxFlightPitchDegrees? maxForwardSpeed? maxMouseDragInputPerFrame? maxPitchDegrees? maxReverseSpeed? maxSlopeDegrees? maxSlopePitchDegrees? mouseDragPitchSensitivity? mouseDragResponse? mouseDragYawSensitivity? obstacleFilter? raycaster? relativeMouseSensitivity? slopePitchFactor? slopePitchSmoothing? stepHeight? suspendModelNavigationController? turnRateDegreesPerSecond?

Properties

Optionalacceleration

acceleration?: number

Forward acceleration, in world-space units per second squared.

Default is 9.

Optionalactive

active?: boolean

Whether the controller starts active.

Default is true.

OptionalaircraftControlSurfaces

aircraftControlSurfaces?: boolean

Treat arrow-key flight input as rudder/elevator control-surface deflection instead of immediate yaw/pitch rate commands.

Default is false.

OptionalbodyRadius

bodyRadius?: number

Approximate vehicle/body radius used for ground and flight obstacle tests.

Default is 0.45.

OptionalbrakeDeceleration

brakeDeceleration?: number

Braking deceleration when pressing reverse while moving forward.

Default is 18.

OptionalcameraHeight

cameraHeight?: number

Camera height above the driven surface, in world-space units.

Default is 1.45.

OptionalcoastDeceleration

coastDeceleration?: number

Passive deceleration when no throttle or brake key is pressed.

Default is 5.

Optionalcollision

collision?: boolean

Enables horizontal obstacle tests.

Default is true.

OptionalcontrolSurfaceResponse

controlSurfaceResponse?: number

Response factor for rudder/elevator deflection while arrow keys are held.

Default is 5.5.

OptionalcontrolSurfaceReturnResponse

controlSurfaceReturnResponse?: number

Response factor for rudder/elevator return to neutral after release.

Default is 3.5.

OptionalcursorTurnDeadZone

cursorTurnDeadZone?: number

Deprecated compatibility option. Hover cursor steering is no longer used; vehicle steering is driven by keyboard ramping and captured mouse drag.

Deprecated

This option is ignored.

OptionalcursorTurnResponse

cursorTurnResponse?: number

Deprecated compatibility option. Hover cursor steering is no longer used; vehicle steering is driven by keyboard ramping and captured mouse drag.

Deprecated

This option is ignored.

OptionaldriveSurfaceFilter

driveSurfaceFilter?: (objectId: string) => boolean

Optional object filter for drive-surface raycasts.

OptionalfallAcceleration

fallAcceleration?: number

Downward acceleration while falling, in world-space units per second squared.

Default is 9.8.

OptionalflightAcceleration

flightAcceleration?: number

Forward thrust acceleration while flying.

Default is 13.

OptionalflightAirDrag

flightAirDrag?: number

Passive air drag while flying, as a response factor per second.

Default is 0.45.

OptionalflightBrakeDeceleration

flightBrakeDeceleration?: number

Deceleration while holding reverse/brake in flight.

Default is 12.

OptionalflightGravity

flightGravity?: number

Downward acceleration while gliding, in world-space units per second squared.

Default is 3.2.

OptionalflightLandingFallSpeed

flightLandingFallSpeed?: number

Initial downward speed when leaving flight mode.

Default is 16.

OptionalflightMinGlideSpeed

flightMinGlideSpeed?: number

Minimum forward airspeed preserved while gliding.

Default is 5.

OptionalflightPitchRateDegreesPerSecond

flightPitchRateDegreesPerSecond?: number

Keyboard pitch rate while flying, in degrees per second.

Default is 58.

OptionalflightSoftLandingRange

flightSoftLandingRange?: number

Distance above a drive surface at which flight softly snaps into landing.

Default is 0.75.

OptionalflightSteeringResponse

flightSteeringResponse?: number

Response factor for steering gliding momentum toward the current heading.

Default is 2.8.

OptionalflightTakeoffHeight

flightTakeoffHeight?: number

Height gained automatically after entering flight mode.

Default is 4.

OptionalflightTakeoffSpeed

flightTakeoffSpeed?: number

Vertical lift speed after entering flight mode, in world-space units per second.

Default is 7.

Optionalgravity

gravity?: boolean

Enables drive-surface following and falling.

Default is true.

OptionalkeyboardEnabledOnlyOnMouseover

keyboardEnabledOnlyOnMouseover?: boolean

Only handle keyboard input while the pointer is over the View element.

Default is true.

OptionalkeyboardPitchInFlight

keyboardPitchInFlight?: boolean

Whether keyboard pitch keys affect camera pitch while flying.

Set this to false for ground vehicles that temporarily use flight mode for jumps, where ArrowUp should keep meaning forward motion instead of pitching the camera up during the jump. Mouse-drag pitch remains enabled.

Default is true.

OptionalkeySteerInitialScale

keySteerInitialScale?: number

Initial fraction of the steering rate applied when a turn key is first pressed. The rate ramps toward full steering while the key is held.

Default is 0.28.

OptionalkeySteerRampSeconds

keySteerRampSeconds?: number

Time, in seconds, for held turn keys to ramp from the initial steering scale to the full steering rate.

Default is 1.45.

OptionalleanDegrees

leanDegrees?: number

Maximum camera roll into a turn, in degrees.

Ground roll is scaled by speed, so slow steering stays upright and faster carving banks more visibly.

Default is 18.

OptionalleanSmoothing

leanSmoothing?: number

Camera-roll smoothing factor, in response units per second.

Ground roll response is also scaled by speed, so banking snaps in more at speed than while creeping.

Default is 8.

OptionalmaxFall

maxFall?: number

Maximum unsupported drop that remains snapped to the drive surface. Larger unsupported drops become an actual fall.

Default is 1.2.

OptionalmaxFallSpeed

maxFallSpeed?: number

Maximum downward falling speed, in world-space units per second.

Default is 35.

OptionalmaxFlightPitchDegrees

maxFlightPitchDegrees?: number

Maximum cursor-controlled up/down look pitch while flying, in degrees.

Default is 65.

OptionalmaxForwardSpeed

maxForwardSpeed?: number

Maximum forward speed, in world-space units per second.

Default is 22.

OptionalmaxMouseDragInputPerFrame

maxMouseDragInputPerFrame?: number

Maximum captured mouse-drag yaw or pitch control deflection.

Default is 0.45.

OptionalmaxPitchDegrees

maxPitchDegrees?: number

Maximum cursor-controlled up/down look pitch, in degrees.

Default is 18.

OptionalmaxReverseSpeed

maxReverseSpeed?: number

Maximum reverse speed, in world-space units per second.

Default is 5.

OptionalmaxSlopeDegrees

maxSlopeDegrees?: number

Maximum driveable surface slope, in degrees.

Default is 55.

OptionalmaxSlopePitchDegrees

maxSlopePitchDegrees?: number

Maximum camera pitch contributed by drive-surface incline/decline, in degrees.

Default is 10.

OptionalmouseDragPitchSensitivity

mouseDragPitchSensitivity?: number

Mouse-drag pitch sensitivity while pointer capture is active.

Default is 0.0021.

OptionalmouseDragResponse

mouseDragResponse?: number

Response factor that smooths captured mouse-drag steering.

Default is 5.2.

OptionalmouseDragYawSensitivity

mouseDragYawSensitivity?: number

Mouse-drag yaw sensitivity while pointer capture is active.

Default is 0.0034.

OptionalobstacleFilter

obstacleFilter?: (objectId: string) => boolean

Optional object filter for horizontal obstacle tests.

Optionalraycaster

raycaster?: SceneRaycaster

Optional raycaster used for drive-surface following and obstacle tests.

When omitted, the controller creates a SceneRaycaster for the View's Scene.

OptionalrelativeMouseSensitivity

relativeMouseSensitivity?: number

Deprecated compatibility alias for mouse-drag yaw and pitch sensitivity. Used only when mouseDragYawSensitivity or mouseDragPitchSensitivity are omitted.

Default is 0.0024.

OptionalslopePitchFactor

slopePitchFactor?: number

Fraction of the current drive-surface incline/decline pitch applied to the camera while ground driving.

Values below 1 keep the rider partly upright instead of exactly matching the surface.

Default is 0.42.

OptionalslopePitchSmoothing

slopePitchSmoothing?: number

Response factor used when easing camera pitch toward the current drive-surface incline/decline.

Default is 5.5.

OptionalstepHeight

stepHeight?: number

Maximum height the controller can snap up/down while following a drive surface.

Default is 0.45.

OptionalsuspendModelNavigationController

suspendModelNavigationController?: viewing.navigation.model.ModelNavigationController

Optional standard ModelNavigationController to suspend while vehicle navigation is active.

Use this when enabling vehicle navigation inside Viewer/Studio applications that already have the default camera controller installed.

OptionalturnRateDegreesPerSecond

turnRateDegreesPerSecond?: number

Base steering yaw rate, in degrees per second.

Ground steering is scaled by speed: low speeds turn above this base rate for tight carving, while high speeds turn below it for stability. Flight steering keeps speed-proportional aircraft-like behavior.

Default is 95.

Settings

Member Visibility

On This Page

Properties
accelerationactiveaircraftControlSurfacesbodyRadiusbrakeDecelerationcameraHeightcoastDecelerationcollisioncontrolSurfaceResponsecontrolSurfaceReturnResponsecursorTurnDeadZonecursorTurnResponsedriveSurfaceFilterfallAccelerationflightAccelerationflightAirDragflightBrakeDecelerationflightGravityflightLandingFallSpeedflightMinGlideSpeedflightPitchRateDegreesPerSecondflightSoftLandingRangeflightSteeringResponseflightTakeoffHeightflightTakeoffSpeedgravitykeyboardEnabledOnlyOnMouseoverkeyboardPitchInFlightkeySteerInitialScalekeySteerRampSecondsleanDegreesleanSmoothingmaxFallmaxFallSpeedmaxFlightPitchDegreesmaxForwardSpeedmaxMouseDragInputPerFramemaxPitchDegreesmaxReverseSpeedmaxSlopeDegreesmaxSlopePitchDegreesmouseDragPitchSensitivitymouseDragResponsemouseDragYawSensitivityobstacleFilterraycasterrelativeMouseSensitivityslopePitchFactorslopePitchSmoothingstepHeightsuspendModelNavigationControllerturnRateDegreesPerSecond