Private _availablePrivate _checkingPrivate _supportedPrivate managerList of active XrHitTestSource.
True if Hit Test is available. This information is available only when the session has started.
True if AR Hit Test is supported.
Private _onPrivate Hit test source.
True if hit test source is created from transient input source.
Input Source with which hit test source is associated with.
Callback called once hit test source is created.
Private _onPrivate _onFire an event, all additional arguments are passed on to the event listener.
Name of event to fire.
Optional arg1: anyFirst argument that is passed to the event handler.
Optional arg2: anySecond argument that is passed to the event handler.
Optional arg3: anyThird argument that is passed to the event handler.
Optional arg4: anyFourth argument that is passed to the event handler.
Optional arg5: anyFifth argument that is passed to the event handler.
Optional arg6: anySixth argument that is passed to the event handler.
Optional arg7: anySeventh argument that is passed to the event handler.
Optional arg8: anyEighth argument that is passed to the event handler.
Self for chaining.
obj.fire('test', 'This is the message');
Test if there are any handlers bound to an event name.
The name of the event to test.
True if the object has handlers bound to the specified event name.
obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false
Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.
Optional name: stringName of the event to unbind.
Optional callback: HandleEventCallbackFunction to be unbound.
Optional scope: objectScope that was used as the this when the event is fired.
Self for chaining.
const handler = function () {
};
obj.on('test', handler);
obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this
Attach an event handler to an event.
Name of the event to bind the callback to.
Function that is called when event is fired. Note the callback is limited to 8 arguments.
Optional scope: object = ...Object to use as 'this' when the event is fired, defaults to current this.
Can be used for removing event in the future.
obj.on('test', function (a, b) {
console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
const evt = obj.on('test', function (a, b) {
console.log(a + b);
});
// some time later
evt.off();
Attach an event handler to an event. This handler will be removed after being fired once.
Name of the event to bind the callback to.
Function that is called when event is fired. Note the callback is limited to 8 arguments.
Optional scope: object = ...Object to use as 'this' when the event is fired, defaults to current this.
obj.once('test', function (a, b) {
console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled
Attempts to start hit test with provided reference space.
Optional options: { Optional object for passing arguments.
Optional callback function called once hit test source is created or failed.
Optional list of underlying entity types against which hit tests will be performed. Defaults to [ XRTRACKABLE_PLANE ]. Can be any combination of the following:
Optional ray by which hit test ray can be offset.
if hit test source meant to match input source instead of reference space, then name of profile of the XrInputSource should be provided.
Reference space type. Defaults to XRSPACE_VIEWER. Can be one of the following:
// start hit testing from viewer position facing forwards
app.xr.hitTest.start({
spaceType: pc.XRSPACE_VIEWER,
callback: function (err, hitTestSource) {
if (err) return;
hitTestSource.on('result', function (position, rotation) {
// position and rotation of hit test result
});
}
});
// start hit testing using an arbitrary ray
const ray = new pc.Ray(new pc.Vec3(0, 0, 0), new pc.Vec3(0, -1, 0));
app.xr.hitTest.start({
spaceType: pc.XRSPACE_LOCAL,
offsetRay: ray,
callback: function (err, hitTestSource) {
// hit test source that will sample real world geometry straight down
// from the position where AR session started
}
});
// start hit testing for touch screen taps
app.xr.hitTest.start({
profile: 'generic-touchscreen',
callback: function (err, hitTestSource) {
if (err) return;
hitTestSource.on('result', function (position, rotation, inputSource) {
// position and rotation of hit test result
// that will be created from touch on mobile devices
});
}
});
Static EVENT_Fired when new XrHitTestSource is added to the list. The handler is passed the XrHitTestSource object that has been added.
app.xr.hitTest.on('add', (hitTestSource) => {
// new hit test source is added
});
Static EVENT_Fired when hit test becomes available.
app.xr.hitTest.on('available', () => {
console.log('Hit Testing is available');
});
Static EVENT_Fired when failed create hit test source. The handler is passed the Error object.
app.xr.hitTest.on('error', (err) => {
console.error(err.message);
});
Static EVENT_Fired when XrHitTestSource is removed to the list. The handler is passed the XrHitTestSource object that has been removed.
app.xr.hitTest.on('remove', (hitTestSource) => {
// hit test source is removed
});
Static EVENT_Fired when hit test source receives new results. It provides transform information that tries to match real world picked geometry. The handler is passed the XrHitTestSource that produced the hit result, the Vec3 position, the Quat rotation and the XrInputSource (if it is a transient hit test source).
app.xr.hitTest.on('result', (hitTestSource, position, rotation, inputSource) => {
target.setPosition(position);
target.setRotation(rotation);
});
Static EVENT_Fired when hit test becomes unavailable.
app.xr.hitTest.on('unavailable', () => {
console.log('Hit Testing is unavailable');
});
The Hit Test interface allows initiating hit testing against real-world geometry from various sources: the view, input sources, or an arbitrary ray in space. Results reflect the underlying AR system's understanding of the real world.