IWebXRHitTestFeature<T>

An interface for all Hit test features

Type parameters

Hierarchy

Implemented by

Index

Properties

attached

Find examples in Playground
attached: boolean

Is this feature attached

Optional dependsOn

Find examples in Playground
dependsOn: string[]

A list of (Babylon WebXR) features this feature depends on

disableAutoAttach

Find examples in Playground
disableAutoAttach: boolean

Should auto-attach be disabled?

isDisposed

Find examples in Playground
isDisposed: boolean

Was this feature disposed;

onHitTestResultObservable

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

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

Optional xrNativeFeatureName

Find examples in Playground
xrNativeFeatureName: string

The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)

Methods

attach

Find examples in Playground
  • attach(force?: boolean): boolean
  • Attach the feature to the session Will usually be called by the features manager

    Parameters

    • Optional force: boolean

      should attachment be forced (even when already attached)

    Returns boolean

    true if successful.

detach

Find examples in Playground
  • detach(): boolean
  • Detach the feature from the session Will usually be called by the features manager

    Returns boolean

    true if successful.

dispose

Find examples in Playground
  • dispose(): void

isCompatible

Find examples in Playground
  • isCompatible(): boolean
  • This function will be executed during before enabling the feature and can be used to not-allow enabling it. Note that at this point the session has NOT started, so this is purely checking if the browser supports it

    Returns boolean

    whether or not the feature is compatible in this environment

Generated using TypeDoc