src/core/classes/ZingEvent.js

/**
 * @file ZingEvent.js
 * Contains logic for ZingEvents
 */

import util from '../util.js';

const INITIAL_COORDINATE = 0;
/**
 * An event wrapper that normalizes events across browsers and input devices
 * @class ZingEvent
 */
class ZingEvent {
  /**
   * @constructor
   * @param {Event} event - The event object being wrapped.
   * @param {Array} event.touches - The number of touches on a screen (mobile only).
   * @param {Object} event.changedTouches - The TouchList representing points that
   * participated in the event.
   * @param {Number} touchIdentifier - The index of touch if applicable
   */
  constructor(event, touchIdentifier) {
    /**
     * The original event object.
     * @type {Event}
     */
    this.originalEvent = event;

    /**
     * The type of event or null if it is an event not predetermined.
     * @see util.normalizeEvent
     * @type {String | null}
     */
    this.type = util.normalizeEvent(event.type);

    /**
     * The X coordinate for the event, based off of the client.
     * @type {number}
     */
    this.x = INITIAL_COORDINATE;

    /**
     * The Y coordinate for the event, based off of the client.
     * @type {number}
     */
    this.y = INITIAL_COORDINATE;

    var eventObj;
    if (event.touches && event.changedTouches) {
      for (var i = 0; i < event.changedTouches.length; i++) {
        if (event.changedTouches[i].identifier === touchIdentifier) {
          eventObj = event.changedTouches[i];
          break;
        }
      }
    } else {
      eventObj = event;
    }

    this.x = this.clientX = eventObj.clientX;
    this.y = this.clientY = eventObj.clientY;

    /**
     * The pageX coordinate for the event
     * @type {number}
     */
    this.pageX = eventObj.pageX;

    /**
     * The pageY coordinate for the event
     * @type {number}
     */
    this.pageY = eventObj.pageY;

    /**
     * The screenX coordinate for the event
     * @type {number}
     */
    this.screenX = eventObj.screenX;

    /**
     * The screenY coordinate for the event
     * @type {number}
     */
    this.screenY = eventObj.screenY;
  }

  /*constructor*/
}

export default ZingEvent;