XRFrame: fillJointRadii() method

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The fillJointRadii() method of the XRFrame interface populates a Float32Array with radii for a list of hand joint spaces and returns true if successful for all spaces.

Syntax

fillJointRadii(jointSpaces, radii)

Parameters

jointSpaces

An array of XRJointSpace objects for which to obtain the radii.

radii

A Float32Array that is populated with the radii of the jointSpaces.

Return value

A boolean indicating if all of the spaces have a valid pose.

Exceptions

TypeError

Thrown if the length of jointSpaces is larger than the number of elements in radii.

Examples

Obtaining radii for all joints of a hand

To efficiently get all radii for all 25 joints of each XRHand, you can use the fillJointRadii() method.

let radii1 = new Float32Array(25);
let radii2 = new Float32Array(25);

function onXRFrame(xrFrame, renderer) {
  let hand1 = xrFrame.session.inputSources[0].hand;
  xrFrame.fillJointRadii(hand1.values(), radii1);
  let hand2 = xrFrame.session.inputSources[1].hand;
  xrFrame.fillJointRadii(hand2.values(), radii2);
}

Specifications

Specification
WebXR Hand Input Module - Level 1
# dom-xrframe-filljointradii

Browser compatibility

BCD tables only load in the browser

See also