XRPose

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Secure context: This feature is available only insecure contexts (HTTPS), in some or allsupporting browsers.

XRPose is aWebXR API interface representing a position and orientation in the 3D space, relative to theXRSpace within which it resides. TheXRSpace—which is either anXRReferenceSpace or anXRBoundedReferenceSpace—defines the coordinate system used for the pose and, in the case of anXRViewerPose, its underlying views.

To obtain theXRPose for theXRSpace used as the local coordinate system of an object, callXRFrame.getPose(), specifying that localXRSpace and the space to which you wish to convert:

thePose = xrFrame.getPose(localSpace, baseSpace);

The pose for a viewer (or camera) is represented by theXRViewerPose subclass ofXRPose. This is obtained usingXRFrame.getViewerPose() instead ofgetPose(), specifying a reference space which has been adjusted to position and orient the node to provide the desired viewing position and angle:

viewerPose = xrFrame.getViewerPose(adjReferenceSpace);

Here,adjReferenceSpace is a reference space which has been updated using the base frame of reference for the frame and any adjustments needed to position the viewer based on movement or rotation which is being supplied from a source other than the XR device, such as keyboard or mouse inputs.

See the articleMovement, orientation, and motion for further details and an example with thorough explanations of what's going on.

Instance properties

XRPose.angularVelocityRead only: ADOMPointReadOnly describing the angular velocity in radians per second relative to the baseXRSpace.
XRPose.emulatedPositionRead only: A Boolean value which isfalse if the position and orientation given bytransform is obtained directly from a full six degree of freedom (6DoF) XR device (that is, a device which tracks not only the pitch, yaw, and roll of the head but also the forward, backward, and side-to-side motion of the viewer). If any component of thetransform is computed or created artificially (such as by using mouse or keyboard controls to move through space), this value is insteadtrue, indicating that thetransform is in part emulated in software.
XRPose.linearVelocityRead only: ADOMPointReadOnly describing the linear velocity in meters per second relative to the baseXRSpace.
XRPose.transformRead only: AXRRigidTransform which provides the position and orientation of the pose relative to the baseXRSpace.