@xeokit/sdk-plugins - v0.1.5
    Preparing search index...

    Interface WalkModePluginConfig

    Configuration for WalkModePlugin.

    interface WalkModePluginConfig {
        bodyHeight?: number;
        bodyRadius?: number;
        doorPassMargin?: number;
        doorReach?: number;
        doorScanInterval?: number;
        doorTypes?: string[];
        eyeHeight?: number;
        flyFastSpeed?: number;
        flySpeed?: number;
        gravity?: number;
        hiddenTypes?: string[];
        id?: string;
        jetpackAcceleration?: number;
        jetpackMaxSpeed?: number;
        keys?: Partial<WalkModeKeys>;
        lookSensitivity?: number;
        maxFrameSeconds?: number;
        maxLookDelta?: number;
        maxPitch?: number;
        modes?: Partial<WalkModeModes>;
        objectType?: (entityId: string) => string | undefined;
        runSpeed?: number;
        stepHeight?: number;
        walkSpeed?: number;
    }

    Hierarchy

    Index
    bodyHeight? bodyRadius? doorPassMargin? doorReach? doorScanInterval? doorTypes? eyeHeight? flyFastSpeed? flySpeed? gravity? hiddenTypes? id? jetpackAcceleration? jetpackMaxSpeed? keys? lookSensitivity? maxFrameSeconds? maxLookDelta? maxPitch? modes? objectType? runSpeed? stepHeight? walkSpeed?
    bodyHeight?: number

    Height of the walker; walls are detected at half of it. Default 1.8.

    bodyRadius?: number

    Distance kept from walls. Default 0.3.

    doorPassMargin?: number

    Distance behind a door at which one lands after going through it. Default 0.6.

    doorReach?: number

    Farthest distance at which a door can be targeted. Default 2.5.

    doorScanInterval?: number

    How often the crosshair target is re-checked while the view changes. Default 0.15.

    doorTypes?: string[]

    Object types that are doors, case-insensitive. Default ["IfcDoor", "Doors"] (IFC, Revit).

    eyeHeight?: number

    Camera height above the floor. Default 1.7.

    flyFastSpeed?: number

    Flight speed while holding the "run" key. Default 14.

    flySpeed?: number

    Default 5.

    gravity?: number

    Downward acceleration in m/s². Default 9.81.

    hiddenTypes?: string[]

    Object types hidden while walking, since they would block movement, case-insensitive. Default ["IfcSpace", "IfcOpeningElement", "IfcAnnotation", "Rooms"] (IFC, Revit).

    id?: string

    Optional ID for this plugin, unique among the plugins of the Viewer. Default "WalkMode".

    jetpackAcceleration?: number

    Upward acceleration of the jetpack in m/s². Default 18.

    jetpackMaxSpeed?: number

    Highest rising speed of the jetpack. Default 4.

    keys?: Partial<WalkModeKeys>

    Key bindings, merged over the defaults per action. An empty array unbinds an action.

    lookSensitivity?: number

    Rotation per pixel of mouse movement. Default 0.0025.

    maxFrameSeconds?: number

    Longer frames are simulated as this long, so that a stall can't move the walker through walls. Default 0.1.

    maxLookDelta?: number

    Mouse movement per event above this many pixels is clamped, filtering pointer lock spikes. Default 100.

    maxPitch?: number

    How far up / down one can look. Default π/2 - 0.05.

    modes?: Partial<WalkModeModes>

    Modes to switch off, all enabled by default. Keys of a disabled mode are left to the page.

    objectType?: (entityId: string) => string | undefined

    Returns the type of an object (e.g. "IfcDoor") when it can't be found in viewer.metaScene, e.g. for models with custom metadata. Doors and spaces are recognized by type.

    runSpeed?: number

    Speed while holding the "run" key. Default 4.5.

    stepHeight?: number

    Highest step that is walked up. Default 0.6.

    walkSpeed?: number

    Default 1.6.

    Settings
    Member Visibility

    On This Page
    Properties