mobility-toolbox-js 2.0.0-beta.1 → 2.0.0-beta.6

package/common/mixins/TralisLayerMixin.js

@@ -1,402 +0,0 @@
-/* eslint-disable no-empty-function */
-/* eslint-disable no-useless-constructor */
-/* eslint-disable no-unused-vars */
-/* eslint-disable class-methods-use-this */
-/* eslint-disable max-classes-per-file */
-import GeoJSON from 'ol/format/GeoJSON';
-import Point from 'ol/geom/Point';
-import { intersects } from 'ol/extent';
-import { fromLonLat } from 'ol/proj';
-import { TralisAPI, TralisModes } from '../../api';
-
-/**
- * TralisLayerInterface.
- */
-export class TralisLayerInterface {
-  /*
-   * Constructor
-
-   * @param {Object} options Layer options.
-   * @param {string} options.url Tralis service url.
-   * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/).
-   * @param {boolean} [options.debug=false] Display additional debug informations.
-   * @param {TralisMode} [options.mode=TralisMode.TOPOGRAPHIC] Tralis's Mode.
-   * @param {number} [options.minZoomInterpolation=8] Minimal zoom when trains positions start to be interpolated.
-   * @param {number} [options.minZoomNonTrain=9] Minimal zoom when non trains vehicles are allowed to be displayed.
-   */
-  constructor(options = {}) {}
-
-  /**
-   * Initialize the layer subscribing to the Tralis api.
-   *
-   * @param {ol/Map~Map} map
-   */
-  init(map) {}
-
-  /**
-   * Terminate the layer unsubscribing to the Tralis api.
-   */
-  terminate() {}
-
-  /**
-   * Set the Tralis api's bbox.
-   *
-   * @param {Array<number>} extent  Extent to request, [minX, minY, maxX, maxY, zoom].
-   * @param {number} zoom  Zoom level to request. Must be an integer.
-   */
-  setBbox(extent, zoom) {}
-
-  /**
-   * Set the Tralis api's mode.
-   *
-   * @param {TralisMode} mode  Tralis mode
-   */
-  setMode(mode) {}
-
-  /**
-   * Request the stopSequence and the fullTrajectory informations for a vehicle.
-   *
-   * @param {string} id The vehicle identifier (the  train_id property).
-   * @param {TralisMode} mode The mode to request. If not defined, the layer´s mode propetrty will be used.
-   * @return {Promise<{stopSequence: StopSequence, fullTrajectory: FullTrajectory>} A promise that will be resolved with the trajectory informations.
-   */
-  getTrajectoryInfos(id, mode) {}
-
-  /**
-   * Define the style of the vehicle.
-   * Draw a blue circle with the id of the props parameter.
-   *
-   * @param {TralisTrajectory} trajectory  A trajectory
-   * @param {ViewState} viewState Map's view state (zoom, resolution, center, ...)
-   */
-  defaultStyle(trajectory, viewState) {}
-}
-
-/**
- * Mixin for TralisLayerInterface.
- *
- * @param {TrackerLayer} TrackerLayer A {TrackerLayer} class to extend with {TrajservLayerInterface} functionnalities.
- * @return {Class}  A class that implements {TralisLayerInterface} class and extends Base;
- * @private
- */
-const TralisLayerMixin = (TrackerLayer) =>
-  class extends TrackerLayer {
-    constructor(options = {}) {
-      super({ ...options });
-      this.debug = options.debug;
-      this.mode = options.mode || TralisModes.TOPOGRAPHIC;
-      this.api = options.api || new TralisAPI(options);
-      this.tenant = options.tenant || ''; // sbb,sbh or sbm
-      this.minZoomNonTrain = options.minZoomNonTrain || 9; // Min zoom level from which non trains are allowed to be displayed. Min value is 9 (as configured by the server
-      this.minZoomInterpolation = options.minZoomInterpolation || 8; // Min zoom level from which trains positions are not interpolated.
-      this.format = new GeoJSON();
-      this.generalizationLevelByZoom = options.generalizationLevelByZoom || {
-        0: 5,
-        1: 5,
-        2: 5,
-        3: 5,
-        4: 5,
-        5: 5,
-        6: 5,
-        7: 5,
-        8: 10,
-        9: 30,
-        10: 30,
-        11: 100,
-        12: 100,
-        13: 100,
-      };
-
-      // This property will call api.setBbox on each movend event
-      this.isUpdateBboxOnMoveEnd = options.isUpdateBboxOnMoveEnd !== false;
-
-      // Bind callbacks
-      this.onTrajectoryMessage = this.onTrajectoryMessage.bind(this);
-      this.onDeleteTrajectoryMessage =
-        this.onDeleteTrajectoryMessage.bind(this);
-      this.onDocumentVisibilityChange =
-        this.onDocumentVisibilityChange.bind(this);
-    }
-
-    init(map) {
-      super.init(map);
-
-      // To avoid browser hanging when the tab is not visible for a certain amount of time,
-      // We stop the rendering and the websocket when hide and start again when show.
-      document.addEventListener(
-        'visibilitychange',
-        this.onDocumentVisibilityChange,
-      );
-    }
-
-    terminate() {
-      document.removeEventListener(
-        'visibilitychange',
-        this.onDocumentVisibilityChange,
-      );
-      super.terminate();
-    }
-
-    start() {
-      super.start();
-      this.api.open();
-      this.api.subscribeTrajectory(
-        this.mode,
-        this.onTrajectoryMessage,
-        this.isUpdateBboxOnMoveEnd,
-      );
-      this.api.subscribeDeletedVehicles(
-        this.mode,
-        this.onDeleteTrajectoryMessage,
-        this.isUpdateBboxOnMoveEnd,
-      );
-
-      if (this.isUpdateBboxOnMoveEnd) {
-        // Update the bbox on each move end
-        this.setBbox();
-      }
-    }
-
-    stop() {
-      super.stop();
-      this.api.unsubscribeTrajectory(this.onTrajectoryMessage);
-      this.api.unsubscribeDeletedVehicles(this.onDeleteTrajectoryMessage);
-      this.api.close();
-    }
-
-    setBbox(extent, zoom) {
-      // Clean trajectories before sending the new bbox
-      // Purge trajectories:
-      // - which are outside the extent
-      // - when it's bus and zoom level is too low for them
-      const keys = Object.keys(this.trajectories);
-      for (let i = keys.length - 1; i >= 0; i -= 1) {
-        this.purgeTrajectory(this.trajectories[keys[i]], extent, zoom);
-      }
-
-      const bbox = [...extent];
-
-      if (this.isUpdateBboxOnMoveEnd) {
-        bbox.push(zoom);
-
-        if (this.tenant) {
-          bbox.push(`tenant=${this.tenant}`);
-        }
-
-        /* @ignore */
-        this.generalizationLevel = this.generalizationLevelByZoom[zoom];
-        if (this.generalizationLevel) {
-          bbox.push(`gen=${this.generalizationLevel}`);
-        }
-      }
-
-      this.api.bbox = bbox;
-    }
-
-    setMode(mode) {
-      if (this.mode === mode) {
-        return;
-      }
-      this.mode = mode;
-      this.api.subscribeTrajectory(
-        this.mode,
-        this.onTrajectoryMessage,
-        this.isUpdateBboxOnMoveEnd,
-      );
-      this.api.subscribeDeletedVehicles(
-        this.mode,
-        this.onDeleteTrajectoryMessage,
-        this.isUpdateBboxOnMoveEnd,
-      );
-    }
-
-    /**
-     * Request the stopSequence and the fullTrajectory informations for a vehicle.
-     *
-     * @param {string} id The vehicle identifier (the  train_id property).
-     * @return {Promise<{stopSequence: StopSequence, fullTrajectory: FullTrajectory>} A promise that will be resolved with the trajectory informations.
-     */
-    getTrajectoryInfos(id) {
-      // When a vehicle is selected, we request the complete stop sequence and the complete full trajectory.
-      // Then we combine them in one response and send them to inherited layers.
-      const promises = [
-        this.api.getStopSequence(id, this.mode),
-        this.api.getFullTrajectory(id, this.mode, this.generalizationLevel),
-      ];
-
-      return Promise.all(promises).then(([stopSequence, fullTrajectory]) => {
-        const response = {
-          stopSequence,
-          fullTrajectory,
-        };
-        return response;
-      });
-    }
-
-    /**
-     * Determine if the trajectory is useless and should be removed from the list or not.
-     * By default, this function exclude vehicles:
-     *  - that have their trajectory outside the current extent and
-     *  - that are not a train and zoom level is lower than layer's minZoomNonTrain property.
-     *
-     * @param {TralisTrajectory} trajectory
-     * @param {Array<number>} extent
-     * @param {number} zoom
-     * @return {boolean} if the trajectory must be displayed or not.
-     * @ignore
-     */
-    purgeTrajectory(trajectory, extent, zoom) {
-      const { type, bounds, train_id: id } = trajectory.properties;
-      if (
-        !intersects(extent, bounds) ||
-        (type !== 'rail' && zoom < (this.minZoomNonTrain || 9))
-      ) {
-        this.removeTrajectory(id);
-        return true;
-      }
-      return false;
-    }
-
-    /**
-     * Add a trajectory to the tracker.
-     * @param {TralisTrajectory} trajectory The trajectory to add.
-     * @private
-     */
-    addTrajectory(trajectory) {
-      if (this.filter && !this.filter(trajectory)) {
-        return;
-      }
-      this.trajectories[trajectory.properties.train_id] = trajectory;
-      this.renderTrajectories();
-    }
-
-    removeTrajectory(id) {
-      delete this.trajectories[id];
-    }
-
-    // getRefreshTimeInMs() {
-    //   return 5000;
-    // }
-    onDocumentVisibilityChange() {
-      if (!this.visible) {
-        return;
-      }
-      if (document.hidden) {
-        this.stop();
-      } else {
-        this.start();
-      }
-    }
-
-    /**
-     * Callback on websocket's trajectory channel events.
-     * It adds a trajectory to the list.
-     *
-     * @private
-     */
-    onTrajectoryMessage(data) {
-      if (!data.content) {
-        return;
-      }
-      const trajectory = data.content;
-
-      const {
-        geometry,
-        properties: {
-          train_id: id,
-          time_since_update: timeSinceUpdate,
-          raw_coordinates: rawCoordinates,
-        },
-      } = trajectory;
-
-      // ignore old events [SBAHNM-97]
-      if (timeSinceUpdate < 0) {
-        return;
-      }
-
-      // console.time(`onTrajectoryMessage${data.content.properties.train_id}`);
-      if (this.purgeTrajectory(trajectory)) {
-        return;
-      }
-
-      if (
-        this.debug &&
-        this.mode === TralisModes.TOPOGRAPHIC &&
-        rawCoordinates
-      ) {
-        trajectory.properties.olGeometry = {
-          type: 'Point',
-          coordinates: fromLonLat(
-            rawCoordinates,
-            this.map.getView().getProjection(),
-          ),
-        };
-      } else {
-        trajectory.properties.olGeometry = this.format.readGeometry(geometry);
-      }
-
-      // TODO Make sure the timeOffset is useful. May be we can remove it.
-      trajectory.properties.timeOffset = Date.now() - data.timestamp;
-      this.addTrajectory(trajectory);
-    }
-
-    /**
-     * Callback on websocket's deleted_vehicles channel events.
-     * It removes the trajectory from the list.
-     *
-     * @private
-     * @override
-     */
-    onDeleteTrajectoryMessage(data) {
-      if (!data.content) {
-        return;
-      }
-
-      this.removeTrajectory(data.content);
-    }
-
-    /**
-     * Callback when user moves the mouse/pointer over the map.
-     * It sets the layer's hoverVehicleId property with the current hovered vehicle's id.
-     *
-     * @private
-     * @override
-     */
-    onFeatureHover(features, layer, coordinate) {
-      const [feature] = features;
-      let id = null;
-      if (feature) {
-        id = feature.get('train_id');
-      }
-      if (this.hoverVehicleId !== id) {
-        /** @ignore */
-        this.hoverVehicleId = id;
-        this.renderTrajectories(true);
-      }
-      super.onFeatureHover(features, layer, coordinate);
-    }
-
-    /**
-     * Callback when user clicks on the map.
-     * It sets the layer's selectedVehicleId property with the current selected vehicle's id.
-     *
-     * @private
-     * @override
-     */
-    onFeatureClick(features, layer, coordinate) {
-      const [feature] = features;
-      let id = null;
-      if (feature) {
-        id = feature.get('train_id');
-      }
-      if (this.selectedVehicleId !== id) {
-        /** @ignore */
-        this.selectedVehicleId = id;
-        this.selectedVehicle = feature;
-        this.renderTrajectories(true);
-      }
-      super.onFeatureClick(features, layer, coordinate);
-    }
-  };
-
-export default TralisLayerMixin;

package/common/utils/simpleTrackerStyle.js

@@ -1,18 +0,0 @@
-/**
- * A very simple tracker style.
- * Display blue point for each train.
- */
-const canvas = document.createElement('canvas');
-canvas.width = 15;
-canvas.height = 15;
-const ctx = canvas.getContext('2d');
-ctx.arc(8, 8, 5, 0, 2 * Math.PI, false);
-ctx.fillStyle = '#8ED6FF';
-ctx.fill();
-ctx.lineWidth = 3;
-ctx.strokeStyle = 'black';
-ctx.stroke();
-ctx.lineWidth = 3;
-
-const style = () => canvas;
-export default style;