Interface WalkNavigationControllerParams

Configures WalkNavigationController.

interface WalkNavigationControllerParams {
    active?: boolean;
    bodyRadius?: number;
    collision?: boolean;
    eyeHeight?: number;
    fallAcceleration?: number;
    gravity?: boolean;
    keyboardEnabledOnlyOnMouseover?: boolean;
    keyboardLookDegreesPerSecond?: number;
    maxFall?: number;
    maxFallSpeed?: number;
    maxPitchDegrees?: number;
    maxSlopeDegrees?: number;
    mouseLookDegreesPerPixel?: number;
    obstacleFilter?: (objectId: string) => boolean;
    raycaster?: SceneRaycaster;
    runSpeed?: number;
    stepHeight?: number;
    suspendViewController?: ViewController;
    walkSpeed?: number;
    walkSurfaceFilter?: (objectId: string) => boolean;
}

Properties

active? bodyRadius? collision? eyeHeight? fallAcceleration? gravity? keyboardEnabledOnlyOnMouseover? keyboardLookDegreesPerSecond? maxFall? maxFallSpeed? maxPitchDegrees? maxSlopeDegrees? mouseLookDegreesPerPixel? obstacleFilter? raycaster? runSpeed? stepHeight? suspendViewController? walkSpeed? walkSurfaceFilter?

Properties

Optionalactive

active?: boolean

Whether the controller starts active.

Default is true.

OptionalbodyRadius

bodyRadius?: number

Approximate body radius used for horizontal obstacle tests.

Default is 0.28.

Optionalcollision

collision?: boolean

Enables horizontal obstacle tests.

Default is true.

OptionaleyeHeight

eyeHeight?: number

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

Default is 1.7.

OptionalfallAcceleration

fallAcceleration?: number

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

Default is 9.8.

Optionalgravity

gravity?: boolean

Enables floor following.

Default is true.

OptionalkeyboardEnabledOnlyOnMouseover

keyboardEnabledOnlyOnMouseover?: boolean

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

Default is true.

OptionalkeyboardLookDegreesPerSecond

keyboardLookDegreesPerSecond?: number

Arrow-key look speed, in degrees per second.

Default is 90.

OptionalmaxFall

maxFall?: number

Maximum drop that the controller will snap down to while floor following. Larger unsupported drops become an actual fall.

Default is 1.5.

OptionalmaxFallSpeed

maxFallSpeed?: number

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

Default is 30.

OptionalmaxPitchDegrees

maxPitchDegrees?: number

Maximum up/down look angle from the horizontal plane, in degrees.

Default is 85.

OptionalmaxSlopeDegrees

maxSlopeDegrees?: number

Maximum walkable surface slope, in degrees.

Default is 50.

OptionalmouseLookDegreesPerPixel

mouseLookDegreesPerPixel?: number

Mouse-look sensitivity, in degrees per pointer pixel.

Default is 0.12.

OptionalobstacleFilter

obstacleFilter?: (objectId: string) => boolean

Optional object filter for horizontal obstacle tests.

Optionalraycaster

raycaster?: SceneRaycaster

Optional raycaster used for floor following and obstacle tests.

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

OptionalrunSpeed

runSpeed?: number

Walking speed while holding Shift, in world-space units per second.

Default is 8.5.

OptionalstepHeight

stepHeight?: number

Maximum height that the controller can step up onto.

Default is 0.35.

OptionalsuspendViewController

suspendViewController?: ViewController

Optional standard ViewController to suspend while walk navigation is active.

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

OptionalwalkSpeed

walkSpeed?: number

Normal walking speed, in world-space units per second.

Default is 4.

OptionalwalkSurfaceFilter

walkSurfaceFilter?: (objectId: string) => boolean

Optional object filter for floor-following raycasts.

Settings

Member Visibility

On This Page

Properties