Bitbybit Docs
    Preparing search index...

    Class WebXRDefaultExperienceOptions (Inputs.BabylonWebXR)

    Feeds babylon.webXr.base.createDefaultXRExperienceAsync with the engine's options for a WebXR session: which features to start, the floor meshes for teleporting, and per-feature settings.

    Index

    Constructors

    constructor

    Properties

    disableDefaultUI? disablePointerSelection? disableTeleportation? disableNearInteraction? disableHandTracking? floorMeshes? ignoreNativeCameraTransformation? inputOptions? pointerSelectionOptions? nearInteractionOptions? handSupportOptions? teleportationOptions? outputCanvasOptions? uiOptions? useStablePlugins? renderingGroupId? optionalFeatures?

    Constructors

    Properties

    disableDefaultUI?: boolean

    Enable or disable default UI to enter XR

    true

    disablePointerSelection?: boolean

    Should pointer selection not initialize. Note that disabling pointer selection also disables teleportation. Defaults to false.

    true

    disableTeleportation?: boolean

    Should teleportation not initialize. Defaults to false.

    true

    disableNearInteraction?: boolean

    Should nearInteraction not initialize. Defaults to false.

    true

    disableHandTracking?: boolean

    Should hand tracking be disabled. Defaults to false.

    true

    floorMeshes?: AbstractMesh[]

    Floor meshes that will be used for teleport

    true

    ignoreNativeCameraTransformation?: boolean

    When true, the first frame does not reset the position from the previous camera; mainly for AR

    true

    inputOptions?: any

    Optional configuration for the XR input object

    true

    pointerSelectionOptions?: any

    optional configuration for pointer selection

    true

    nearInteractionOptions?: any

    optional configuration for near interaction

    true

    handSupportOptions?: any

    optional configuration for hand tracking

    true

    teleportationOptions?: any

    optional configuration for teleportation

    true

    outputCanvasOptions?: any

    optional configuration for the output canvas

    true

    uiOptions?: any

    optional UI options. This can be used among other to change session mode and reference space type

    true

    useStablePlugins?: boolean

    When loading teleportation and pointer select, use stable versions instead of latest.

    true

    renderingGroupId?: number

    An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes

    true

    optionalFeatures?: boolean | string[]

    A list of optional features to init the session with If set to true, all features we support will be added

    true

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties