The XRHitTestSource
interface of the WebXR Device API handles hit test subscriptions. You can get an XRHitTestSource
object by using the XRSession.requestHitTestSource()
method.
This object doesn't itself contain hit test results, but it is used to compute hit tests for each XRFrame
by calling XRFrame.getHitTestResults()
, which returns XRHitTestResult
objects.
Call XRSession.requestHitTestSource()
to get a hit test source.
const xrSession = navigator.xr.requestSession("immersive-ar", {
requiredFeatures: ["local", "hit-test"]
});
let hitTestSource = null;
xrSession.requestHitTestSource({
space : viewerSpace,
offsetRay : new XRRay({y: 0.5})
}).then((viewerHitTestSource) => {
hitTestSource = viewerHitTestSource;
});
function onXRFrame(time, xrFrame) {
let hitTestResults = xrFrame.getHitTestResults(hitTestSource);
}
To unsubscribe from a hit test source, call XRHitTestSource.cancel()
. Since the object will no longer be usable, you can clean up and set the XRHitTestSource
object to null
.
hitTestSource.cancel();
hitTestSource = null;