Class WebXRHand

constructor

• new WebXRHand(
      xrController: WebXRInputSource,
      _jointMeshes: AbstractMesh[],
      _handMesh: Nullable<AbstractMesh>,
      rigMapping: Nullable<XRHandMeshRigMapping>,
      _leftHandedMeshes?: boolean,
      _jointsInvisible?: boolean,
      _jointScaleFactor?: number,
  ): WebXRHand

  Construct a new hand object

  Parameters

  • xrController: WebXRInputSource

    The controller to which the hand correlates.

  • _jointMeshes: AbstractMesh[]

    The meshes to be used to track the hand joints.

  • _handMesh: Nullable<AbstractMesh>

    An optional hand mesh.

  • rigMapping: Nullable<XRHandMeshRigMapping>

    An optional rig mapping for the hand mesh. If not provided (but a hand mesh is provided), it will be assumed that the hand mesh's bones are named directly after the WebXR bone names.

  • _leftHandedMeshes: boolean = false

    Are the hand meshes left-handed-system meshes

  • _jointsInvisible: boolean = false

    Are the tracked joint meshes visible

  • _jointScaleFactor: number = 1

    Scale factor for all joint meshes

  Returns WebXRHand

onHandMeshSetObservable

ReadonlyrigMapping

ReadonlyxrController

handMesh

• get handMesh(): Nullable<AbstractMesh>

  Get the hand mesh.

  Returns Nullable<AbstractMesh>

dispose

• dispose(disposeMeshes?: boolean): void

  Dispose this Hand object

  Parameters

  • disposeMeshes: boolean = false

    Should the meshes be disposed as well

  Returns void

getHandPartMeshes

• getHandPartMeshes(part: HandPart): AbstractMesh[]

  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.

getJointMesh

• getJointMesh(jointName: WebXRHandJoint): AbstractMesh

  Retrieves a mesh linked to a named joint in the hand.

  Parameters

  • jointName: WebXRHandJoint

    The name of the joint.

  Returns AbstractMesh

  An AbstractMesh whose position corresponds with the joint position.

setHandMesh

• setHandMesh(
      handMesh: AbstractMesh,
      rigMapping: Nullable<XRHandMeshRigMapping>,
      _xrSessionManager?: WebXRSessionManager,
  ): void

  Sets the current hand mesh to render for the WebXRHand.

  Parameters

  • handMesh: AbstractMesh

    The rigged hand mesh that will be tracked to the user's hand.

  • rigMapping: Nullable<XRHandMeshRigMapping>

    The mapping from XRHandJoint to bone names to use with the mesh.

  • Optional_xrSessionManager: WebXRSessionManager

    The XRSessionManager used to initialize the hand mesh.

  Returns void

updateFromXRFrame

• updateFromXRFrame(
      xrFrame: XRFrame,
      referenceSpace: XRReferenceSpace,
      xrCamera: WebXRCamera,
  ): void

  Update this hand from the latest xr frame.

  Parameters

  • xrFrame: XRFrame

    The latest frame received from WebXR.

  • referenceSpace: XRReferenceSpace

    The current viewer reference space.

  • xrCamera: WebXRCamera

    the xr camera, used for parenting

  Returns void