WebXRHitTest

The currently-working hit-test module. Hit test (or Ray-casting) is used to interact with the real world. For further information read here - https://github.com/immersive-web/hit-test

Tested on chrome (mobile) 80.

Hierarchy

Implements

Index

Constructors

constructor

Find examples in Playground

Properties

autoCloneTransformation

Find examples in Playground
autoCloneTransformation: boolean

When set to true, each hit test will have its own position/rotation objects When set to false, position and rotation objects will be reused for each hit test. It is expected that the developers will clone them or copy them as they see fit.

disableAutoAttach

Find examples in Playground
disableAutoAttach: boolean

Should auto-attach be disabled?

lastNativeXRHitResults

Find examples in Playground
lastNativeXRHitResults: XRHitResult[]

Populated with the last native XR Hit Results

onHitTestResultObservable

Find examples in Playground
onHitTestResultObservable: Observable<IWebXRHitResult[]>

Triggered when new babylon (transformed) hit test results are available

options

Find examples in Playground

options to use when constructing this feature

paused

Find examples in Playground
paused: boolean

Use this to temporarily pause hit test checks.

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

attach

Find examples in Playground
  • attach(): boolean
  • attach this feature Will usually be called by the features manager

    Returns boolean

    true if successful.

detach

Find examples in Playground
  • detach(): boolean

dispose

Find examples in Playground
  • dispose(): void

Generated using TypeDoc