Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • WebXRDefaultExperienceOptions

Index

Constructors

constructor

Properties

Optional disableDefaultUI

disableDefaultUI: boolean

Enable or disable default UI to enter XR

optional

true

Optional disableHandTracking

disableHandTracking: boolean

Should hand tracking be disabled. Defaults to false.

optional

true

Optional disableNearInteraction

disableNearInteraction: boolean

Should nearInteraction not initialize. Defaults to false.

optional

true

Optional disablePointerSelection

disablePointerSelection: boolean

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

optional

true

Optional disableTeleportation

disableTeleportation: boolean

Should teleportation not initialize. Defaults to false.

optional

true

Optional floorMeshes

floorMeshes: AbstractMesh[]

Floor meshes that will be used for teleport

optional

true

Optional handSupportOptions

handSupportOptions: Partial<IWebXRHandTrackingOptions>

optional configuration for hand tracking

optional

true

Optional ignoreNativeCameraTransformation

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

optional

true

Optional inputOptions

inputOptions: Partial<IWebXRInputOptions>

Optional configuration for the XR input object

optional

true

Optional nearInteractionOptions

nearInteractionOptions: Partial<IWebXRNearInteractionOptions>

optional configuration for near interaction

optional

true

Optional optionalFeatures

optionalFeatures: boolean | string[]

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

optional

true

Optional outputCanvasOptions

outputCanvasOptions: WebXRManagedOutputCanvasOptions

optional configuration for the output canvas

optional

true

Optional pointerSelectionOptions

pointerSelectionOptions: Partial<IWebXRControllerPointerSelectionOptions>

optional configuration for pointer selection

optional

true

Optional renderingGroupId

renderingGroupId: number

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

optional

true

Optional teleportationOptions

teleportationOptions: Partial<IWebXRTeleportationOptions>

optional configuration for teleportation

optional

true

Optional uiOptions

uiOptions: Partial<WebXREnterExitUIOptions>

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

optional

true

Optional useStablePlugins

useStablePlugins: boolean

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

optional

true

Generated using TypeDoc