WebXR Device API
The XRRay interface of the WebXR Device API is a geometric ray described by an origin point and a direction vector.
XRRay objects can be passed to XRSession.requestHitTestSource() or XRSession.requestHitTestSourceForTransientInput() to perform hit testing.
Constructor
- XRRay.XRRay
- : Creates a new
XRRayobject.
- : Creates a new
Instance properties
- XRRay.direction
- : A DOMPointReadOnly representing the ray's 3-dimensional directional vector.
- XRRay.matrix
- : A transform that can be used to position objects along the
XRRay. This is a 4 by 4 matrix given as a 16 element Float32Array in column major order.
- : A transform that can be used to position objects along the
- XRRay.origin
- : A DOMPointReadOnly representing the 3-dimensional point in space that the ray originates from, in meters.
Instance methods
None.
Examples
Using XRRay to request a hit test source
The XRSession.requestHitTestSource() method takes an XRRay object for its offsetRay option. In this example, the hit test source is positioned slightly above the viewer as the application has some UI elements at the bottom while wanting to maintain the perception of a centered cursor.
const xrSession = navigator.xr.requestSession("immersive-ar", {
requiredFeatures: ["local", "hit-test"],
});
let hitTestSource = null;
xrSession
.requestHitTestSource({
space: viewerSpace, // obtained from xrSession.requestReferenceSpace("viewer");
offsetRay: new XRRay({ y: 0.5 }),
})
.then((viewerHitTestSource) => {
hitTestSource = viewerHitTestSource;
});
Specifications
Browser compatibility
See also
- XRSession.requestHitTestSource()
- XRHitTestResult
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
