Class WebXRHand
Hierarchy
- WebXRHand
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
Construct a new hand object
Parameters
-
xrController: WebXRInputSource
the controller to which the hand correlates
-
trackedMeshes: AbstractMesh[]
the meshes to be used to track the hand joints
-
Optional _handMesh: AbstractMesh | undefined
an optional hand mesh. if not provided, ours will be used
-
Optional _rigMapping: string[] | undefined
an optional rig mapping for the hand mesh. if not provided, ours will be used
-
Optional disableDefaultHandMesh: boolean
should the default mesh creation be disabled
Returns WebXRHand
-
Properties
hand Parts DefinitionSearch playground for handPartsDefinition
Hand-parts definition (key is HandPart)
Type declaration
-
[key: string]: number[]
on Hand Mesh Ready ObservableSearch playground for onHandMeshReadyObservable
Observers will be triggered when the mesh for this hand was initialized.
Readonly tracked MeshesSearch playground for trackedMeshes
the meshes to be used to track the hand joints
Readonly xr ControllerSearch playground for xrController
the controller to which the hand correlates
Accessors
hand Mesh
-
Get the hand mesh. It is possible that the hand mesh is not yet ready!
Returns AbstractMesh | undefined
Methods
disposeSearch playground for dispose
-
Dispose this Hand object
Returns void
get Hand Part MeshesSearch playground for getHandPartMeshes
-
Get meshes of part of the hand
Parameters
-
part: HandPart
the part of hand to get
Returns AbstractMesh[]
An array of meshes that correlate to the hand part requested
-
update FromXRFrameSearch playground for updateFromXRFrame
-
Update this hand from the latest xr frame
Parameters
-
xrFrame: XRFrame
xrFrame to update from
-
referenceSpace: XRReferenceSpace
The current viewer reference space
-
Optional scaleFactor: number
optional scale factor for the meshes
Returns void
-
Representing a single hand (with its corresponding native XRHand object)