XrInput
Extends: EventHandler
Provides access to input sources for WebXR.
Summary
Properties
inputSources | List of active XrInputSource instances. |
Events
add | Fired when new XrInputSource is added to the list. |
remove | Fired when XrInputSource is removed to the list. |
select | Fired when XrInputSource has triggered primary action. |
selectend | Fired when XrInputSource has ended triggerring primary action. |
selectstart | Fired when XrInputSource has started to trigger primary action. |
squeeze | Fired when XrInputSource has triggered squeeze action. |
squeezeend | Fired when XrInputSource has ended triggerring sqeeze action. |
squeezestart | Fired when XrInputSource has started to trigger sqeeze action. |
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
Properties
Events
add
Fired when new XrInputSource is added to the list.
app.xr.input.on('add', function (inputSource) {
// new input source is added
});
Parameters
inputSource | XrInputSource | Input source that has been added. |
remove
Fired when XrInputSource is removed to the list.
app.xr.input.on('remove', function (inputSource) {
// input source is removed
});
Parameters
inputSource | XrInputSource | Input source that has been removed. |
select
Fired when XrInputSource has triggered primary action. This could be pressing a trigger button, or touching a screen.
const ray = new pc.Ray();
app.xr.input.on('select', function (inputSource, evt) {
ray.set(inputSource.getOrigin(), inputSource.getDirection());
if (obj.intersectsRay(ray)) {
// selected an object with input source
}
});
Parameters
inputSource | XrInputSource | Input source that triggered select event. |
evt | object | XRInputSourceEvent event data from WebXR API. |
selectend
Fired when XrInputSource has ended triggerring primary action.
Parameters
inputSource | XrInputSource | Input source that triggered selectend event. |
evt | object | XRInputSourceEvent event data from WebXR API. |
selectstart
Fired when XrInputSource has started to trigger primary action.
Parameters
inputSource | XrInputSource | Input source that triggered selectstart event. |
evt | object | XRInputSourceEvent event data from WebXR API. |
squeeze
Fired when XrInputSource has triggered squeeze action. This is associated with "grabbing" action on the controllers.
Parameters
inputSource | XrInputSource | Input source that triggered squeeze event. |
evt | object | XRInputSourceEvent event data from WebXR API. |
squeezeend
Fired when XrInputSource has ended triggerring sqeeze action.
Parameters
inputSource | XrInputSource | Input source that triggered squeezeend event. |
evt | object | XRInputSourceEvent event data from WebXR API. |
squeezestart
Fired when XrInputSource has started to trigger sqeeze action.
app.xr.input.on('squeezestart', function (inputSource, evt) {
if (obj.containsPoint(inputSource.getPosition())) {
// grabbed an object
}
});
Parameters
inputSource | XrInputSource | Input source that triggered squeezestart event. |
evt | object | XRInputSourceEvent event data from WebXR API. |
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
name | string | 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
EventHandlerSelf 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
name | string | The name of the event to test. |
Returns
booleanTrue 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.
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
Parameters
name | string | Name of the event to unbind. |
callback | HandleEventCallback | Function to be unbound. |
scope | object | Scope that was used as the this when the event is fired. |
Returns
EventHandlerSelf 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
name | string | Name of the event to bind the callback to. |
callback | HandleEventCallback | Function that is called when event is fired. Note the callback is limited to 8 arguments. |
scope | object | Object to use as 'this' when the event is fired, defaults to current this. |
Returns
EventHandlerSelf 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
name | string | Name of the event to bind the callback to. |
callback | HandleEventCallback | Function that is called when event is fired. Note the callback is limited to 8 arguments. |
scope | object | Object to use as 'this' when the event is fired, defaults to current this. |
Returns
EventHandlerSelf for chaining.