XRPose extension type

XRPose is a WebXR API interface representing a position and orientation in the 3D space, relative to the XRSpace within which it resides. The XRSpace—which is either an XRReferenceSpace or an XRBoundedReferenceSpace—defines the coordinate system used for the pose and, in the case of an XRViewerPose, its underlying views.

To obtain the XRPose for the XRSpace used as the local coordinate system of an object, call XRFrame.getPose, specifying that local XRSpace and the space to which you wish to convert:

thePose = xrFrame.getPose(localSpace, baseSpace);

The pose for a viewer (or camera) is represented by the XRViewerPose subclass of XRPose. This is obtained using XRFrame.getViewerPose instead of getPose(), 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 article Movement, orientation, and motion for further details and an example with thorough explanations of what's going on.

API documentation sourced from MDN Web Docs.

on
Implemented types
Available extensions

Properties

angularVelocity → DOMPointReadOnly?
The angularVelocity read-only property of the XRPose interface is a DOMPointReadOnly describing the angular velocity in radians per second relative to the base XRSpace.
no setter
emulatedPosition → bool
The emulatedPosition read-only attribute of the XRPose interface is a Boolean value indicating whether or not both the XRRigidTransform.position component of the pose's XRPose.transform is directly taken from the XR device, or it's simulated or computed based on other sources.
no setter
hashCode → int
The hash code for this object.
no setterinherited
linearVelocity → DOMPointReadOnly?
The linearVelocity read-only property of the XRPose interface is a DOMPointReadOnly describing the linear velocity in meters per second relative to the base XRSpace.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transform → XRRigidTransform
The transform read-only attribute of the XRPose interface is a XRRigidTransform object providing the position and orientation of the pose relative to the base XRSpace as specified when the pose was obtained by calling XRFrame.getPose.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited