Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebXRHand

Representing a single hand (with its corresponding native XRHand object)

Hierarchy

  • WebXRHand

Implements

Index

Constructors

constructor

  • Construct a new hand object

    Parameters

    • xrController: WebXRInputSource

      the controller to which the hand correlates

    • trackedMeshes: Map<string, 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

    • Optional _nearInteractionMesh: Nullable<AbstractMesh> | undefined

      as optional mesh used for near interaction collision checking

    • Optional _leftHandedMeshes: boolean | undefined

      are the hand meshes left-handed-system meshes

    Returns WebXRHand

Properties

handPartsDefinitionSearch playground for handPartsDefinition

handPartsDefinition: {}

Hand-parts definition (key is HandPart)

Type declaration

  • [key: string]: string[]

onHandMeshReadyObservableSearch playground for onHandMeshReadyObservable

onHandMeshReadyObservable: Observable<WebXRHand>

Observers will be triggered when the mesh for this hand was initialized.

Readonly trackedMeshesSearch playground for trackedMeshes

trackedMeshes: Map<string, AbstractMesh>

the meshes to be used to track the hand joints

Readonly xrControllerSearch playground for xrController

xrController: WebXRInputSource

the controller to which the hand correlates

Accessors

handMesh

  • Get the hand mesh. It is possible that the hand mesh is not yet ready!

    Returns AbstractMesh | undefined

Methods

disposeSearch playground for dispose

  • dispose(): void
  • Dispose this Hand object

    Returns void

getHandPartMeshesSearch 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

updateFromXRFrameSearch 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

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method