Class WebXRHand

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

Hierarchy

WebXRHand

Implements

IDisposable

Index

Constructors

constructor

Properties

Accessors

handMesh

Methods

Constructors

constructor

new WebXRHand(xrController: WebXRInputSource, trackedMeshes: AbstractMesh[], _handMesh?: AbstractMesh | undefined, _rigMapping?: string[] | undefined, disableDefaultHandMesh?: boolean): WebXRHand

- Defined in .temp/docdirectory/doc.d.ts:79763
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

handPartsDefinitionSearch playground for handPartsDefinition

handPartsDefinition: {}

Hand-parts definition (key is HandPart)

Type declaration

[key: string]: number[]

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: 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 handMesh(): AbstractMesh | undefined

- Defined in .temp/docdirectory/doc.d.ts:79780
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

Implementation of IDisposable.dispose
- Defined in .temp/docdirectory/doc.d.ts:79797
Dispose this Hand object

Returns void

getHandPartMeshesSearch playground for getHandPartMeshes

getHandPartMeshes(part: HandPart): AbstractMesh[]

- Defined in .temp/docdirectory/doc.d.ts:79793
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

updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void

- Defined in .temp/docdirectory/doc.d.ts:79787
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