WebXR Device API
The requestHitTestSource() method of the
XRSession interface returns a Promise that resolves with an XRHitTestSource object that can be passed to XRFrame.getHitTestResults().
Syntax
requestHitTestSource(options)
Parameters
options- : An object containing configuration options, specifically:
space- : The XRSpace that will be tracked by the hit test source.
entityTypes- : An Array specifying the types of entities to be used for hit test source creation. If no entity type is specified, the array defaults to a single element with the
planetype. Possible types:point: Compute hit test results based on characteristic points detected.plane: Compute hit test results based on real-world planes detected.mesh: Compute hit test results based on meshes detected.
- : An Array specifying the types of entities to be used for hit test source creation. If no entity type is specified, the array defaults to a single element with the
offsetRay- : The XRRay object that will be used to perform hit test. If no
XRRayobject has been provided, a newXRRayobject is constructed without any parameters.
- : The XRRay object that will be used to perform hit test. If no
- : An object containing configuration options, specifically:
Return value
A Promise that resolves with an XRHitTestSource object.
Exceptions
Rather than throwing true exceptions, requestHitTestSource() rejects the
returned promise with a DOMException, specifically, one of the following:
NotSupportedErrorDOMException- : Thrown if
hit-testis not an enabled feature in XRSystem.requestSession().
- : Thrown if
InvalidStateErrorDOMException- : Thrown if the session has already ended.
NotAllowedErrorDOMException- : Thrown if there is an unreasonable number of requests. Some user agents might limit usage for privacy reasons.
Examples
Requesting a hit test source
To request a hit test source, start an XRSession with the hit-test session feature enabled. Next, configure the hit test source and store it for later use in the frame loop and call XRFrame.getHitTestResults() to obtain the result.
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;
});
// frame loop
function onXRFrame(time, xrFrame) {
let hitTestResults = xrFrame.getHitTestResults(hitTestSource);
// do things with the hit test results
}
Specifications
Browser compatibility
See also
- XRSession.requestHitTestSourceForTransientInput()
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
