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

    Class TouchDevice

    Manages touch input by handling and dispatching touch events. Extends EventHandler to fire touchstart, touchend, touchmove, and touchcancel events (see TouchEvent).

    Detects and processes touch interactions with the attached DOM element, allowing applications to respond to common touch gestures. The TouchDevice instance must be attached to a DOM element before it can detect touch events.

    Your application's TouchDevice instance is managed and accessible via AppBase#touch.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    attach detach fire hasEvent off on once

    Events

    EVENT_TOUCHCANCEL EVENT_TOUCHEND EVENT_TOUCHMOVE EVENT_TOUCHSTART

    Constructors

    Methods

    • Attach a device to an element in the DOM. If the device is already attached to an element this method will detach it first.

      Parameters

      • element: Element

        The element to attach to.

      Returns void

    • 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_TOUCHCANCEL: string = 'touchcancel'

    Fired when a touch is interrupted in some way. The exact reasons for canceling a touch can vary from device to device. For example, a modal alert pops up during the interaction; the touch point leaves the document area, or there are more touch points than the device supports, in which case the earliest touch point is canceled. The handler is passed a TouchEvent.

    app.touch.on('touchcancel', (e) => {
        console.log(`Touch canceled at position: ${e.x}, ${e.y}`);
    });
    EVENT_TOUCHEND: string = 'touchend'

    Fired when a touch ends. The handler is passed a TouchEvent.

    app.touch.on('touchend', (e) => {
        console.log(`Touch ended at position: ${e.x}, ${e.y}`);
    });
    EVENT_TOUCHMOVE: string = 'touchmove'

    Fired when a touch moves. The handler is passed a TouchEvent.

    app.touch.on('touchmove', (e) => {
        console.log(`Touch moved to position: ${e.x}, ${e.y}`);
    });
    EVENT_TOUCHSTART: string = 'touchstart'

    Fired when a touch starts. The handler is passed a TouchEvent.

    app.touch.on('touchstart', (e) => {
        console.log(`Touch started at position: ${e.x}, ${e.y}`);
    });

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Events