API Reference

Class List

pc.XrHitTestSource

Extends: pc.EventHandler

Represents XR hit test source, which provides access to hit results of real world geometry from AR session.

hitTestSource.on('result', function (position, rotation) {
    target.setPosition(position);
});

Summary

Methods

remove

Stop and remove hit test source.

Events

remove

Fired when {pc.XrHitTestSource} is removed.

result

Fired when hit test source receives new results.

Inherited

Methods

fire

Fire an event, all additional arguments are passed on to the event listener.

hasEvent

Test if there are any handlers bound to an event name.

off

Detach an event handler from an event.

on

Attach an event handler to an event.

once

Attach an event handler to an event.

Details

Constructor

XrHitTestSource(manager, xrHitTestSource, transient)

Represents XR hit test source, which provides access to hit results of real world geometry from AR session.

hitTestSource.on('result', function (position, rotation) {
    target.setPosition(position);
});

Parameters

managerpc.XrManager

WebXR Manager.

xrHitTestSourceobject

XRHitTestSource object that is created by WebXR API.

transientboolean

True if XRHitTestSource created for input source profile.

Methods

remove()

Stop and remove hit test source.

Events

remove

Fired when {pc.XrHitTestSource} is removed.

hitTestSource.once('remove', function () {
    // hit test source has been removed
});

result

Fired when hit test source receives new results. It provides transform information that tries to match real world picked geometry.

hitTestSource.on('result', function (position, rotation, inputSource) {
    target.setPosition(position);
    target.setRotation(rotation);
});

Parameters

positionpc.Vec3

Position of hit test

rotationpc.Quat

Rotation of hit test

inputSourcepc.XrInputSource, null

If is transient hit test source, then it will provide related input source

Inherited

Methods

fire(name, [arg1], [arg2], [arg3], [arg4], [arg5], [arg6], [arg7], [arg8])

Fire an event, all additional arguments are passed on to the event listener.

obj.fire('test', 'This is the message');

Parameters

nameobject

Name of event to fire.

arg1*

First argument that is passed to the event handler.

arg2*

Second argument that is passed to the event handler.

arg3*

Third argument that is passed to the event handler.

arg4*

Fourth argument that is passed to the event handler.

arg5*

Fifth argument that is passed to the event handler.

arg6*

Sixth argument that is passed to the event handler.

arg7*

Seventh argument that is passed to the event handler.

arg8*

Eighth argument that is passed to the event handler.

Returns

pc.EventHandler

Self for chaining.

hasEvent(name)

Test if there are any handlers bound to an event name.

obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false

Parameters

namestring

The name of the event to test.

Returns

boolean

True if the object has handlers bound to the specified event name.

off([name], [callback], [scope])

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.

var 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 hander functions, called 'test' with scope this

Parameters

namestring

Name of the event to unbind.

callbackpc.callbacks.HandleEvent

Function to be unbound.

scopeobject

Scope that was used as the this when the event is fired.

Returns

pc.EventHandler

Self for chaining.

on(name, callback, [scope])

Attach an event handler to an event.

obj.on('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console

Parameters

namestring

Name of the event to bind the callback to.

callbackpc.callbacks.HandleEvent

Function that is called when event is fired. Note the callback is limited to 8 arguments.

scopeobject

Object to use as 'this' when the event is fired, defaults to current this.

Returns

pc.EventHandler

Self for chaining.

once(name, callback, [scope])

Attach an event handler to an event. This handler will be removed after being fired once.

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

Parameters

namestring

Name of the event to bind the callback to.

callbackpc.callbacks.HandleEvent

Function that is called when event is fired. Note the callback is limited to 8 arguments.

scopeobject

Object to use as 'this' when the event is fired, defaults to current this.

Returns

pc.EventHandler

Self for chaining.