wisemapping-frontend/packages/mindplot/src/components/ScreenManager.ts

/*
 *    Copyright [2021] [wisemapping]
 *
 *   Licensed under WiseMapping Public License, Version 1.0 (the "License").
 *   It is basically the Apache License, Version 2.0 (the "License") plus the
 *   "powered by wisemapping" text requirement on every single page;
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the license at
 *
 *       http://www.wisemapping.org/license
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
import $ from 'jquery';
import { $assert } from '@wisemapping/core-js';
import { Point } from '@wisemapping/web2d';
// https://stackoverflow.com/questions/60357083/does-not-use-passive-listeners-to-improve-scrolling-performance-lighthouse-repo
// https://web.dev/uses-passive-event-listeners/?utm_source=lighthouse&utm_medium=lr
// eslint-disable-next-line import/extensions
import registerTouchHandler from '../../../../libraries/jquery.touchevent';

registerTouchHandler($);

class ScreenManager {
  private _divContainer: JQuery;

  private _padding: { x: number; y: number };

  private _clickEvents;

  private _scale: number;

  constructor(divElement: JQuery) {
    $assert(divElement, 'can not be null');
    this._divContainer = divElement;
    this._padding = { x: 0, y: 0 };

    // Ignore default click event propagation. Prevent 'click' event on drag.
    this._clickEvents = [];
    this._divContainer.bind('click', (event: { stopPropagation: () => void }) => {
      event.stopPropagation();
    });

    this._divContainer.bind(
      'dblclick',
      (event: { stopPropagation: () => void; preventDefault: () => void }) => {
        event.stopPropagation();
        event.preventDefault();
      },
    );
  }

  /**
   * Return the current visibile area in the browser.
   */
  getVisibleBrowserSize(): { width: number; height: number } {
    return {
      width: window.innerWidth,
      height: window.innerHeight - Number.parseInt(this._divContainer.css('top'), 10),
    };
  }

  setScale(scale: number) {
    $assert(scale, 'Screen scale can not be null');
    this._scale = scale;
  }

  addEvent(eventType: string, listener) {
    if (eventType === 'click') {
      this._clickEvents.push(listener);
    } else {
      this._divContainer.bind(eventType, listener);
    }
  }

  removeEvent(event: string, listener) {
    if (event === 'click') {
      this._clickEvents.remove(listener);
    } else {
      this._divContainer.unbind(event, listener);
    }
  }

  fireEvent(type: string, event: UIEvent = null) {
    if (type === 'click') {
      this._clickEvents.forEach((listener) => {
        listener(type, event);
      });
    } else {
      this._divContainer.trigger(type, event);
    }
  }

  private mouseEvents = ['mousedown', 'mouseup', 'mousemove', 'dblclick', 'click'];

  private tocuchEvents = ['touchstart', 'touchend', 'touchmove'];

  // the received type was changed from MouseEvent to "any", because we must support touch events
  getWorkspaceMousePosition(event: any) {
    let x;
    let y;

    if (this.mouseEvents.includes(event.type)) {
      // Retrieve current mouse position.
      x = event.clientX;
      y = event.clientY;
    } else if (this.tocuchEvents.includes(event.type)) {
      x = event.touches[0].clientX;
      y = event.touches[0].clientY;
    }

    // if value is zero assert throws error
    if (x !== 0) {
      $assert(x, `clientX can not be null, eventType= ${event.type}`);
    }
    if (y !== 0) {
      $assert(y, `clientY can not be null, eventType= ${event.type}`);
    }

    // Adjust the deviation of the container positioning ...
    const containerPosition = this.getContainer().position();
    x -= containerPosition.left;
    y -= containerPosition.top;

    // Scale coordinate in order to be relative to the workspace. That's coordSize/size;
    x *= this._scale;
    y *= this._scale;

    // Add workspace offset.
    x += this._padding.x;
    y += this._padding.y;

    // Remove decimal part..
    return new Point(x, y);
  }

  getContainer() {
    return this._divContainer;
  }

  setOffset(x: number, y: number) {
    this._padding.x = x;
    this._padding.y = y;
  }
}

export default ScreenManager;