API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebXRHandTracking

WebXR Hand Joint tracking feature, available for selected browsers and devices

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

disableAutoAttachSearch playground for disableAutoAttach

disableAutoAttach: boolean

Should auto-attach be disabled?

isDisposedSearch playground for isDisposed

isDisposed: boolean

Is this feature disposed?

onHandAddedObservableSearch playground for onHandAddedObservable

onHandAddedObservable: Observable<WebXRHand>

This observable will notify registered observers when a new hand object was added and initialized

onHandRemovedObservableSearch playground for onHandRemovedObservable

onHandRemovedObservable: Observable<WebXRHand>

This observable will notify its observers right before the hand object is disposed

Readonly optionsSearch playground for options

options: IWebXRHandTrackingOptions

Options to use when constructing this feature.

xrNativeFeatureNameSearch playground for xrNativeFeatureName

xrNativeFeatureName: string

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

Static DEFAULT_HAND_MODEL_BASE_URLSearch playground for DEFAULT_HAND_MODEL_BASE_URL

DEFAULT_HAND_MODEL_BASE_URL: string

The base URL for the default hand model.

Static DEFAULT_HAND_MODEL_LEFT_FILENAMESearch playground for DEFAULT_HAND_MODEL_LEFT_FILENAME

DEFAULT_HAND_MODEL_LEFT_FILENAME: string

The filename to use for the default left hand model.

Static DEFAULT_HAND_MODEL_RIGHT_FILENAMESearch playground for DEFAULT_HAND_MODEL_RIGHT_FILENAME

DEFAULT_HAND_MODEL_RIGHT_FILENAME: string

The filename to use for the default right hand model.

Static DEFAULT_HAND_MODEL_SHADER_URLSearch playground for DEFAULT_HAND_MODEL_SHADER_URL

DEFAULT_HAND_MODEL_SHADER_URL: string

The URL pointing to the default hand model NodeMaterial shader.

Static Readonly NameSearch playground for Name

Name: "xr-hand-tracking" = "xr-hand-tracking"

The module's name

Static Readonly VersionSearch playground for Version

Version: 1 = 1

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

  • get attached(): boolean

Methods

attachSearch playground for attach

  • attach(): boolean

  • Attach this feature. Will usually be called by the features manager.

    Returns boolean

    true if successful.

detachSearch playground for detach

  • detach(): boolean

  • Detach this feature. Will usually be called by the features manager.

    Returns boolean

    true if successful.

disposeSearch playground for dispose

  • dispose(): void

getHandByControllerIdSearch playground for getHandByControllerId

  • Get the hand object according to the controller id

    Parameters

    • controllerId: string

      the controller id to which we want to get the hand

    Returns Nullable<WebXRHand>

    null if not found or the WebXRHand object if found

getHandByHandednessSearch playground for getHandByHandedness

  • Get a hand object according to the requested handedness

    Parameters

    Returns Nullable<WebXRHand>

    null if not found or the WebXRHand object if found

isCompatibleSearch playground for isCompatible

  • isCompatible(): boolean

  • Check if the needed objects are defined. This does not mean that the feature is enabled, but that the objects needed are well defined.

    Returns boolean

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method