Interface IWebXRTeleportationOptions
Hierarchy
- IWebXRTeleportationOptions
Index
Properties
Optional blocked
Color of the teleportation ray when it is blocked by a mesh in the pickBlockerMeshes array Defaults to red.
Optional custom
if provided, this scene will be used to render meshes.
Optional default
Values to configure the default target mesh
Type declaration
Optional disable
Animation?: boolean Disable the mesh's animation sequence
Optional disable
Lighting?: boolean Disable lighting on the material or the ring and arrow
Optional teleportation
Border Color?: string Border color for the teleportation area
Optional teleportation
Circle Material?: Material Override the default material of the Landing Zone
Optional teleportation
Fill Color?: string Fill color of the teleportation area
Optional torus
Arrow Material?: Material Override the default material of the torus and arrow
Optional floor
A list of meshes to use as floor meshes. Meshes can be added and removed after initializing the feature using the addFloorMesh and removeFloorMesh functions If empty, rotation will still work
Optional force
Should teleport work only on a specific hand?
Optional pick
Meshes that the teleportation ray cannot go through
Optional rendering
use this rendering group id for the meshes (optional)
Optional snap
Should teleportation move only to snap points
Optional snap
An array of points to which the teleportation will snap to. If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
Optional snap
How close should the teleportation ray be in order to snap to position. Default to 0.8 units (meters)
Optional teleportation
Provide your own teleportation mesh instead of babylon's wonderful doughnut. If you want to support rotation, make sure your mesh has a direction indicator.
When left untouched, the default mesh will be initialized.
Optional time
If main component is used (no thumbstick), how long should the "long press" take before teleport
Optional use
Disable using the thumbstick and use the main component (usually trigger) on long press. This will be automatically true if the controller doesn't have a thumbstick or touchpad.
Optional use
Should meshes created here be added to a utility layer or the main scene
xr
Babylon XR Input class for controller
Methods
Optional generate
If provided, this function will be used to generate the ray mesh instead of the lines mesh being used per default
Parameters
points: Vector3[]
pickingInfo: PickingInfo
Returns AbstractMesh
The options container for the teleportation module