Class WebXRHandTracking
Hierarchy
- WebXRAbstractFeature
- WebXRHandTracking
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new instance of the XR hand tracking feature.
Parameters
_xrSessionManager: WebXRSessionManager
An instance of WebXRSessionManager.
options: IWebXRHandTrackingOptions
Options to use when constructing this feature.
Returns WebXRHandTracking
Properties
disable Auto AttachSearch playground for disableAutoAttach
Should auto-attach be disabled?
is DisposedSearch playground for isDisposed
Is this feature disposed?
on Hand Added ObservableSearch playground for onHandAddedObservable
This observable will notify registered observers when a new hand object was added and initialized
on Hand Removed ObservableSearch playground for onHandRemovedObservable
This observable will notify its observers right before the hand object is disposed
Readonly optionsSearch playground for options
Options to use when constructing this feature.
xr Native Feature NameSearch playground for xrNativeFeatureName
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
The base URL for the default hand model.
Static DEFAULT_ HAND_ MODEL_ LEFT_ FILENAMESearch playground for DEFAULT_HAND_MODEL_LEFT_FILENAME
The filename to use for the default left hand model.
Static DEFAULT_ HAND_ MODEL_ RIGHT_ FILENAMESearch playground for DEFAULT_HAND_MODEL_RIGHT_FILENAME
The filename to use for the default right hand model.
Static DEFAULT_ HAND_ MODEL_ SHADER_ URLSearch playground for DEFAULT_HAND_MODEL_SHADER_URL
The URL pointing to the default hand model NodeMaterial shader.
Static Readonly NameSearch playground for Name
The module's name
Static Readonly VersionSearch playground for Version
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
Is this feature attached
Returns boolean
Methods
attachSearch playground for attach
Attach this feature. Will usually be called by the features manager.
Returns boolean
true if successful.
detachSearch playground for detach
Detach this feature. Will usually be called by the features manager.
Returns boolean
true if successful.
disposeSearch playground for dispose
Dispose this feature and all of the resources attached.
Returns void
get Hand By Controller IdSearch playground for getHandByControllerId
get Hand By HandednessSearch playground for getHandByHandedness
Get a hand object according to the requested handedness
Parameters
handedness: XRHandedness
the handedness to request
Returns Nullable<WebXRHand>
null if not found or the WebXRHand object if found
is CompatibleSearch playground for isCompatible
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
WebXR Hand Joint tracking feature, available for selected browsers and devices