Interface IWebXRHandTrackingOptions
Hierarchy
- IWebXRHandTrackingOptions
Index
Properties
Properties
Optional joint MeshesSearch playground for jointMeshes
Configuration object for the joint meshes
Type declaration
-
Optional disable
Default Hand Mesh?: boolean Should the default hand mesh be disabled. In this case, the spheres will be visible (unless set invisible).
-
Optional enable
Physics?: boolean Should each instance have its own physics impostor
-
Optional hand
Meshes?: { left: AbstractMesh; right: AbstractMesh } a rigged hand-mesh that will be updated according to the XRHand data provided. This will override the default hand mesh
-
left: AbstractMesh
-
right: AbstractMesh
-
-
Optional invisible?: boolean
Should the meshes created be invisible (defaults to false)
-
Optional keep
Original Visible?: boolean Should the source mesh stay visible. Defaults to false
-
Optional on
Hand Joint Mesh Generated?: (meshInstance: InstancedMesh, jointId: number, controllerId: string) => Mesh | undefined This function will be called after a mesh was created for a specific joint. Using this function you can either manipulate the instance or return a new mesh. When returning a new mesh the instance created before will be disposed
-
-
Parameters
-
meshInstance: InstancedMesh
-
jointId: number
-
controllerId: string
Returns Mesh | undefined
-
-
-
-
Optional physics
Props?: { friction?: number; impostorType?: number; restitution?: number } If enabled, override default physics properties
-
Optional friction?: number
-
Optional impostor
Type?: number -
Optional restitution?: number
-
-
Optional rig
Mapping?: { left: string[]; right: string[] } If a hand mesh was provided, this array will define what axis will update which node. This will override the default hand mesh
-
left: string[]
-
right: string[]
-
-
Optional scale
Factor?: number Scale factor for all instances (defaults to 2)
-
Optional source
Mesh?: Mesh A source mesh to be used to create instances. Defaults to a sphere. This mesh will be the source for all other (25) meshes. It should have the general size of a single unit, as the instances will be scaled according to the provided radius
xr InputSearch playground for xrInput
The xrInput that will be used as source for new hands
Configuration interface for the hand tracking feature