WebXRMotionControllerTeleportation

This is a teleportation feature to be used with webxr-enabled motion controllers. When enabled and attached, the feature will allow a user to move aroundand rotate in the scene using the input of the attached controllers.

Hierarchy

Implements

Index

Constructors

constructor

Find examples in Playground

Properties

backwardsTeleportationDistance

Find examples in Playground
backwardsTeleportationDistance: number

Distance to travel when moving backwards

parabolicCheckRadius

Find examples in Playground
parabolicCheckRadius: number

The distance from the user to the inspection point in the direction of the controller A higher number will allow the user to move further defaults to 5 (meters, in xr units)

parabolicRayEnabled

Find examples in Playground
parabolicRayEnabled: boolean

Should the module support parabolic ray on top of direct ray If enabled, the user will be able to point "at the sky" and move according to predefined radius distance Very helpful when moving between floors / different heights

rotationAngle

Find examples in Playground
rotationAngle: number

How much rotation should be applied when rotating right and left

rotationEnabled

Find examples in Playground
rotationEnabled: boolean

Is rotation enabled when moving forward? Disabling this feature will prevent the user from deciding the direction when teleporting

Static Name

Find examples in Playground
Name: string

The module's name

Static Version

Find examples in Playground
Version: number

The (Babylon) version of this module. This is an integer representing the implementation version. This number does not correspond to the webxr specs version

Accessors

attached

Find examples in Playground
  • get attached(): boolean

Methods

addFloorMesh

Find examples in Playground
  • Add a new mesh to the floor meshes array

    Parameters

    Returns void

attach

Find examples in Playground
  • attach(): boolean

detach

Find examples in Playground
  • detach(): boolean

dispose

Find examples in Playground
  • dispose(): void

removeFloorMesh

Find examples in Playground
  • Remove a mesh from the floor meshes array

    Parameters

    Returns void

removeFloorMeshByName

Find examples in Playground
  • removeFloorMeshByName(name: string): void
  • Remove a mesh from the floor meshes array using its name

    Parameters

    • name: string

      the mesh name to remove

    Returns void

setSelectionFeature

Find examples in Playground
  • This function sets a selection feature that will be disabled when the forward ray is shown and will be reattached when hidden. This is used to remove the selection rays when moving.

    Parameters

    • selectionFeature: IWebXRFeature

      the feature to disable when forward movement is enabled

    Returns void

Generated using TypeDoc