bitbybit.dev v1.0.0-rc.1
    Preparing search index...

    Class WebXRDefaultExperienceOptions

    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

    If set to true, the first frame will not be used to reset position The first frame is mainly used when copying transformation from the old camera Mainly used in AR

    true

    inputOptions?: IWebXRInputOptions

    Optional configuration for the XR input object

    true

    pointerSelectionOptions?: IWebXRControllerPointerSelectionOptions

    optional configuration for pointer selection

    true

    nearInteractionOptions?: IWebXRNearInteractionOptions

    optional configuration for near interaction

    true

    handSupportOptions?: IWebXRHandTrackingOptions

    optional configuration for hand tracking

    true

    teleportationOptions?: IWebXRTeleportationOptions

    optional configuration for teleportation

    true

    outputCanvasOptions?: WebXRManagedOutputCanvasOptions

    optional configuration for the output canvas

    true

    uiOptions?: WebXREnterExitUIOptions

    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