Class WebXRHandTracking
Hierarchy (View Summary)
- WebXRAbstractFeature
- WebXRHandTracking
Constructors
constructor
-
new WebXRHandTracking(
_xrSessionManager: WebXRSessionManager,
options: IWebXRHandTrackingOptions,
): WebXRHandTrackingCreates 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
- _xrSessionManager: WebXRSessionManager
Properties
Optionaldepends On
The dependencies of this feature, if any
disable Auto Attach
Should auto-attach be disabled?
is Disposed
Is this feature disposed?
on Feature Attach Observable
Observers registered here will be executed when the feature is attached
on Feature Detach Observable
Observers registered here will be executed when the feature is detached
on Hand Added Observable
This observable will notify registered observers when a new hand object was added and initialized
on Hand Removed Observable
This observable will notify its observers right before the hand object is disposed
Readonlyoptions
Options to use when constructing this feature.
StaticDEFAULT_ HAND_ MODEL_ BASE_ URL
The base URL for the default hand model.
StaticDEFAULT_ HAND_ MODEL_ LEFT_ FILENAME
The filename to use for the default left hand model.
StaticDEFAULT_ HAND_ MODEL_ RIGHT_ FILENAME
The filename to use for the default right hand model.
StaticDEFAULT_ HAND_ MODEL_ SHADER_ URL
The URL pointing to the default hand model NodeMaterial shader.
Static ReadonlyName
The module's name
Static ReadonlyVersion
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
Is this feature attached
Returns boolean
xr Native Feature Name
-
get xrNativeFeatureName(): string
The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
Returns string
-
set xrNativeFeatureName(name: string): void
The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
Parameters
- name: string
Returns void
Methods
attach
-
Attach this feature. Will usually be called by the features manager.
Returns boolean
true if successful.
detach
-
Detach this feature. Will usually be called by the features manager.
Returns boolean
true if successful.
dispose
-
Dispose this feature and all of the resources attached.
Returns void
get Hand By Controller Id
get Hand By Handedness
is Compatible
-
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
true if the needed objects for this feature are defined
WebXR Hand Joint tracking feature, available for selected browsers and devices