Entity, nullelementEntity 

If XrInputSource#elementInput is true, this property will hold entity with Element component at which this input source is hovering, or null if not hovering over any element.

booleanelementInput 

Set to true to allow input source to interact with Element components. Defaults to true.

Gamepad, nullgamepad 

If input source has buttons, triggers, thumbstick or touchpad, then this object provides access to its states.

booleangrip 

If input source can be held, then it will have node with its world transformation, that can be used to position and rotate virtual joysticks based on it.

XrHand, nullhand 

If input source is a tracked hand, then it will point to XrHand otherwise it is null.

stringhandedness 

Describes which hand input source is associated with. Can be one of the following:

• XRHAND_NONE: None - input source is not meant to be held in hands.
• XRHAND_LEFT: Left - indicates that input source is meant to be held in left hand.
• XRHAND_RIGHT: Right - indicates that input source is meant to be held in right hand.

XrHitTestSource[]hitTestSources 

List of active XrHitTestSource instances created by this input source.

numberid 

Unique number associated with instance of input source. Same physical devices when reconnected will not share this ID.

objectinputSource 

XRInputSource object that is associated with this input source.

string[]profiles 

List of input profile names indicating both the preferred visual representation and behavior of the input source.

booleanselecting 

True if input source is in active primary action between selectstart and selectend events.

booleansqueezing 

True if input source is in active squeeze action between squeezestart and squeezeend events.

stringtargetRayMode 

Type of ray Input Device is based on. Can be one of the following:

• XRTARGETRAY_GAZE: Gaze - indicates the target ray will originate at the viewer and follow the direction it is facing. This is commonly referred to as a "gaze input" device in the context of head-mounted displays.
• XRTARGETRAY_SCREEN: Screen - indicates that the input source was an interaction with the canvas element associated with an inline session's output context, such as a mouse click or touch event.
• XRTARGETRAY_POINTER: Tracked Pointer - indicates that the target ray originates from either a handheld device or other hand-tracking mechanism and represents that the user is using their hands or the held device for pointing.

getDirection() 

Get the world space direction of input source ray.

Returns

Vec3

The world space direction of input source ray.

getLocalPosition() 

Get the local space position of input source if it is handheld (XrInputSource#grip is true). Local space is relative to parent of the XR camera. Otherwise it will return null.

Returns

Vec3, null

The world space position of handheld input source.

getLocalRotation() 

Get the local space rotation of input source if it is handheld (XrInputSource#grip is true). Local space is relative to parent of the XR camera. Otherwise it will return null.

Returns

Vec3, null

The world space rotation of handheld input source.

getOrigin() 

Get the world space origin of input source ray.

Returns

Vec3

The world space origin of input source ray.

getPosition() 

Get the world space position of input source if it is handheld (XrInputSource#grip is true). Otherwise it will return null.

Returns

Vec3, null

The world space position of handheld input source.

getRotation() 

Get the world space rotation of input source if it is handheld (XrInputSource#grip is true). Otherwise it will return null.

Returns

Quat, null

The world space rotation of handheld input source.

hitTestStart([options]) 

Attempts to start hit test source based on this input source.

app.xr.input.on('add', function (inputSource) {
    inputSource.hitTestStart({
        callback: function (err, hitTestSource) {
            if (err) return;
            hitTestSource.on('result', function (position, rotation) {
                // position and rotation of hit test result
                // that will be created from touch on mobile devices
            });
        }
    });
});

Parameters

options	object	Object for passing optional arguments.
options.entityTypes	string[]	Optional list of underlying entity types against which hit tests will be performed. Defaults to [ XRTRACKABLE_PLANE ]. Can be any combination of the following: XRTRACKABLE_POINT: Point - indicates that the hit test results will be computed based on the feature points detected by the underlying Augmented Reality system. XRTRACKABLE_PLANE: Plane - indicates that the hit test results will be computed based on the planes detected by the underlying Augmented Reality system. XRTRACKABLE_MESH: Mesh - indicates that the hit test results will be computed based on the meshes detected by the underlying Augmented Reality system.
options.offsetRay	Ray	Optional ray by which hit test ray can be offset.
options.callback	XrHitTestStartCallback	Optional callback function called once hit test source is created or failed.

remove 

Fired when XrInputSource is removed.

inputSource.once('remove', function () {
    // input source is not available anymore
});

select 

Fired when input source has triggered primary action. This could be pressing a trigger button, or touching a screen.

const ray = new pc.Ray();
inputSource.on('select', function (evt) {
    ray.set(inputSource.getOrigin(), inputSource.getDirection());
    if (obj.intersectsRay(ray)) {
        // selected an object with input source
    }
});

Parameters

evt

object

XRInputSourceEvent event data from WebXR API.

selectend 

Fired when input source has ended triggering primary action.

Parameters

evt

object

XRInputSourceEvent event data from WebXR API.

selectstart 

Fired when input source has started to trigger primary action.

Parameters

evt

object

XRInputSourceEvent event data from WebXR API.

squeeze 

Fired when input source has triggered squeeze action. This is associated with "grabbing" action on the controllers.

Parameters

evt

object

XRInputSourceEvent event data from WebXR API.

squeezeend 

Fired when input source has ended triggering squeeze action.

Parameters

evt

object

XRInputSourceEvent event data from WebXR API.

squeezestart 

Fired when input source has started to trigger squeeze action.

inputSource.on('squeezestart', function (evt) {
    if (obj.containsPoint(inputSource.getPosition())) {
        // grabbed an object
    }
});

Parameters

evt

object

XRInputSourceEvent event data from WebXR API.

hittest:add 

Fired when new XrHitTestSource is added to the input source.

inputSource.on('hittest:add', function (hitTestSource) {
    // new hit test source is added
});

Parameters

hitTestSource

XrHitTestSource

Hit test source that has been added.

hittest:remove 

Fired when XrHitTestSource is removed to the the input source.

inputSource.on('remove', function (hitTestSource) {
    // hit test source is removed
});

Parameters

hitTestSource

XrHitTestSource

Hit test source that has been removed.

hittest:result 

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

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

Parameters

hitTestSource	XrHitTestSource	Hit test source that produced the hit result.
position	Vec3	Position of hit test.
rotation	Quat	Rotation of hit test.

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

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

name

string

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.

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

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

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

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

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

EventHandler

Self for chaining.