Engine API Reference - v2.6.1
    Preparing search index...

    Class XrInput

    Provides access to input sources for WebXR.

    Input sources represent:

    • hand held controllers - and their optional capabilities: gamepad and vibration
    • hands - with their individual joints
    • transient sources - such as touch screen taps and voice commands

    Hierarchy (View Summary)

    Index

    Accessors

    inputSources

    Methods

    fire hasEvent off on once

    Events

    EVENT_ADD EVENT_REMOVE EVENT_SELECT EVENT_SELECTEND EVENT_SELECTSTART EVENT_SQUEEZE EVENT_SQUEEZEEND EVENT_SQUEEZESTART

    Accessors

    Methods

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

      Parameters

      • name: string

        Name of event to fire.

      • Optionalarg1: any

        First argument that is passed to the event handler.

      • Optionalarg2: any

        Second argument that is passed to the event handler.

      • Optionalarg3: any

        Third argument that is passed to the event handler.

      • Optionalarg4: any

        Fourth argument that is passed to the event handler.

      • Optionalarg5: any

        Fifth argument that is passed to the event handler.

      • Optionalarg6: any

        Sixth argument that is passed to the event handler.

      • Optionalarg7: any

        Seventh argument that is passed to the event handler.

      • Optionalarg8: any

        Eighth argument that is passed to the event handler.

      Returns EventHandler

      Self for chaining.

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

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

      Parameters

      • name: string

        The name of the event to test.

      Returns boolean

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

      obj.on('test', () => {}); // 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.

      Parameters

      • Optionalname: string

        Name of the event to unbind.

      • Optionalcallback: HandleEventCallback

        Function to be unbound.

      • Optionalscope: any

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

      Returns EventHandler

      Self for chaining.

      const handler = () => {};
      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.

      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.

      • Optionalscope: any = ...

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

      Returns EventHandle

      Can be used for removing event in the future.

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

      const evt = obj.on('test', (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.

      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.

      • Optionalscope: any = ...

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

      Returns EventHandle

      • can be used for removing event in the future.
      obj.once('test', (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

    Events

    EVENT_ADD: string = 'add'

    Fired when a new XrInputSource is added to the list. The handler is passed the XrInputSource that has been added.

    app.xr.input.on('add', (inputSource) => {
        // new input source is added
    });
    EVENT_REMOVE: string = 'remove'

    Fired when an XrInputSource is removed from the list. The handler is passed the XrInputSource that has been removed.

    app.xr.input.on('remove', (inputSource) => {
        // input source is removed
    });
    EVENT_SELECT: string = 'select'

    Fired when XrInputSource has triggered primary action. This could be pressing a trigger button, or touching a screen. The handler is passed the XrInputSource that triggered the select event and the XRInputSourceEvent event from the WebXR API.

    const ray = new pc.Ray();
    app.xr.input.on('select', (inputSource, evt) => {
        ray.set(inputSource.getOrigin(), inputSource.getDirection());
        if (obj.intersectsRay(ray)) {
            // selected an object with input source
        }
    });
    EVENT_SELECTEND: string = 'selectend'

    Fired when XrInputSource has ended triggering primary action. The handler is passed the XrInputSource that triggered the selectend event and the XRInputSourceEvent event from the WebXR API.

    app.xr.input.on('selectend', (inputSource, evt) => {
        console.log('Select ended');
    });
    EVENT_SELECTSTART: string = 'selectstart'

    Fired when XrInputSource has started to trigger primary action. The handler is passed the XrInputSource that triggered the selectstart event and the XRInputSourceEvent event from the WebXR API.

    app.xr.input.on('selectstart', (inputSource, evt) => {
        console.log('Select started');
    });
    EVENT_SQUEEZE: string = 'squeeze'

    Fired when XrInputSource has triggered squeeze action. This is associated with "grabbing" action on the controllers. The handler is passed the XrInputSource that triggered the squeeze event and the XRInputSourceEvent event from the WebXR API.

    app.xr.input.on('squeeze', (inputSource, evt) => {
        console.log('Squeeze');
    });
    EVENT_SQUEEZEEND: string = 'squeezeend'

    Fired when XrInputSource has ended triggering squeeze action. The handler is passed the XrInputSource that triggered the squeezeend event and the XRInputSourceEvent event from the WebXR API.

    app.xr.input.on('squeezeend', (inputSource, evt) => {
        console.log('Squeeze ended');
    });
    EVENT_SQUEEZESTART: string = 'squeezestart'

    Fired when XrInputSource has started to trigger squeeze action. The handler is passed the XrInputSource that triggered the squeezestart event and the XRInputSourceEvent event from the WebXR API.

    app.xr.input.on('squeezestart', (inputSource, evt) => {
        if (obj.containsPoint(inputSource.getPosition())) {
            // grabbed an object
        }
    });

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods
    Events