itowns 2.44.3-next.9 → 2.45.0

package/lib/Core/Geographic/Coordinates.js

@@ -1,320 +0,0 @@
-import * as THREE from 'three';
-import proj4 from 'proj4';
-import CRS from "./Crs.js";
-import Ellipsoid from "../Math/Ellipsoid.js";
-proj4.defs('EPSG:4978', '+proj=geocent +datum=WGS84 +units=m +no_defs');
-const ellipsoid = new Ellipsoid();
-const projectionCache = {};
-const v0 = new THREE.Vector3();
-const v1 = new THREE.Vector3();
-let coord0;
-let coord1;
-function proj4cache(crsIn, crsOut) {
-  if (!projectionCache[crsIn]) {
-    projectionCache[crsIn] = {};
-  }
-  if (!projectionCache[crsIn][crsOut]) {
-    projectionCache[crsIn][crsOut] = proj4(crsIn, crsOut);
-  }
-  return projectionCache[crsIn][crsOut];
-}
-
-/**
- * A Coordinates object, defined by a [crs](http://inspire.ec.europa.eu/theme/rs)
- * and three values. These values are accessible through `x`, `y` and `z`,
- * although it can also be accessible through `latitude`, `longitude` and
- * `altitude`. To change a value, prefer the `set()` method below.
- *
- * `EPSG:4978` and `EPSG:4326` are supported by default. To use another CRS,
- * you have to declare it with `proj4`. You can find most projections and their
- * proj4 code at [epsg.io](https://epsg.io/).
- *
- * @example
- * new Coordinates('EPSG:4978', 20885167, 849862, 23385912); //Geocentric coordinates
- * new Coordinates('EPSG:4326', 2.33, 48.24, 24999549); //Geographic coordinates
- *
- * @example
- * // Declare EPSG:3946 with proj4
- * itowns.proj4.defs('EPSG:3946', '+proj=lcc +lat_1=45.25 +lat_2=46.75 +lat_0=46 +lon_0=3 +x_0=1700000 +y_0=5200000 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m +no_defs');
- *
- * @property {boolean} isCoordinates - Used to checkout whether this coordinates
- * is a Coordinates. Default is true. You should not change this, as it is used
- * internally for optimisation.
- * @property {string} crs - A supported crs by default in
- * [`proj4js`](https://github.com/proj4js/proj4js#named-projections), or an
- * added crs to `proj4js` (using `proj4.defs`). Note that `EPSG:4978` is also
- * supported by default in itowns.
- * @property {number} x - The first value of the coordinate.
- * @property {number} y - The second value of the coordinate.
- * @property {number} z - The third value of the coordinate.
- * @property {number} latitude - The first value of the coordinate.
- * @property {number} longitude - The second value of the coordinate.
- * @property {number} altitude - The third value of the coordinate.
- * @property {THREE.Vector3} geodesicNormal - The geodesic normal of the
- * coordinate.
- */
-class Coordinates {
-  /**
-   * @param {string} crs - A supported Coordinate Reference System.
-   * @param {number|Array<number>|Coordinates|THREE.Vector3} [v0=0] -
-   * x or longitude value, or a more complex one: it can be an array of three
-   * numbers, being x/lon, y/lat, z/alt, or it can be `THREE.Vector3`. It can
-   * also simply be a Coordinates.
-   * @param {number} [v1=0] - y or latitude value.
-   * @param {number} [v2=0] - z or altitude value.
-   */
-  constructor(crs) {
-    let v0 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-    let v1 = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 0;
-    let v2 = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 0;
-    this.isCoordinates = true;
-    CRS.isValid(crs);
-    this.crs = crs;
-
-    // Storing the coordinates as is, not in arrays, as it is
-    // slower (see https://jsbench.me/40jumfag6g/1)
-    this.x = 0;
-    this.y = 0;
-    this.z = 0;
-
-    // Normal
-    this._normal = new THREE.Vector3();
-    if (v0.length > 0) {
-      this.setFromArray(v0);
-    } else if (v0.isVector3 || v0.isCoordinates) {
-      this.setFromVector3(v0);
-    } else {
-      this.setFromValues(v0, v1, v2);
-    }
-    this._normalNeedsUpdate = true;
-  }
-
-  /**
-   * Sets the Coordinate Reference System.
-   * @param {String} crs Coordinate Reference System (e.g. 'EPSG:4978')
-   */
-  setCrs(crs) {
-    CRS.isValid(crs);
-    this.crs = crs;
-  }
-
-  /**
-   * Set the values of this Coordinates.
-   *
-   * @param {number} [v0=0] - x or longitude value.
-   * @param {number} [v1=0] - y or latitude value.
-   * @param {number} [v2=0] - z or altitude value.
-   *
-   * @return {Coordinates} This Coordinates.
-   */
-  setFromValues() {
-    let v0 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
-    let v1 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-    let v2 = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 0;
-    this.x = v0 == undefined ? 0 : v0;
-    this.y = v1 == undefined ? 0 : v1;
-    this.z = v2 == undefined ? 0 : v2;
-    this._normalNeedsUpdate = true;
-    return this;
-  }
-
-  /**
-   * Set the values of this Coordinates from an array.
-   *
-   * @param {Array<number>} array - An array of number to assign to the
-   * Coordinates.
-   * @param {number} [offset] - Optional offset into the array.
-   *
-   * @return {Coordinates} This Coordinates.
-   */
-  setFromArray(array) {
-    let offset = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-    return this.setFromValues(array[offset], array[offset + 1], array[offset + 2]);
-  }
-
-  /**
-   * Set the values of this Coordinates from a `THREE.Vector3` or an `Object`
-   * having `x/y/z` properties, like a `Coordinates`.
-   *
-   * @param {THREE.Vector3|Coordinates} v0 - The object to read the values
-   * from.
-   *
-   * @return {Coordinates} This Coordinates.
-   */
-  setFromVector3(v0) {
-    return this.setFromValues(v0.x, v0.y, v0.z);
-  }
-
-  /**
-   * Returns a new Coordinates with the same values as this one. It will
-   * instantiate a new Coordinates with the same CRS as this one.
-   *
-   * @return {Coordinates} The target with its new coordinates.
-   */
-  clone() {
-    return new Coordinates(this.crs, this);
-  }
-
-  /**
-   * Copies the values of the passed Coordinates to this one. The CRS is
-   * however not copied.
-   *
-   * @param {Coordinates} src - The source to copy from.
-   *
-   * @return {Coordinates} This Coordinates.
-   */
-  copy(src) {
-    this.crs = src.crs;
-    return this.setFromVector3(src);
-  }
-  get longitude() {
-    return this.x;
-  }
-  get latitude() {
-    return this.y;
-  }
-  get altitude() {
-    return this.z;
-  }
-  set altitude(value) {
-    this.z = value;
-  }
-  get geodesicNormal() {
-    if (this._normalNeedsUpdate) {
-      this._normalNeedsUpdate = false;
-      if (CRS.is4326(this.crs)) {
-        ellipsoid.geodeticSurfaceNormalCartographic(this, this._normal);
-      } else if (this.crs == 'EPSG:4978') {
-        ellipsoid.geodeticSurfaceNormal(this, this._normal);
-      } else {
-        this._normal.set(0, 0, 1);
-      }
-    }
-    return this._normal;
-  }
-
-  /**
-   * Return this Coordinates values into a `THREE.Vector3`.
-   *
-   * @param {THREE.Vector3} [target] - The target to put the values in. If not
-   * specified, a new vector will be created.
-   *
-   * @return {THREE.Vector3}
-   */
-  toVector3() {
-    let target = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : new THREE.Vector3();
-    return target.copy(this);
-  }
-
-  /**
-   * Copy values coordinates to array
-   *
-   * @param  {number[]} array - array to store this vector to. If this is not
-   * provided a new array will be created.
-   * @param  {number} [offset=0] - optional offset into the array.
-   *
-   * @return {number[]} Returns an array [x, y, z], or copies x, y and z into
-   * the provided array.
-   */
-  toArray() {
-    let array = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
-    let offset = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-    return THREE.Vector3.prototype.toArray.call(this, array, offset);
-  }
-
-  /**
-   * Calculate planar distance between this coordinates and `coord`.
-   * Planar distance is the straight-line euclidean distance calculated in a 2D cartesian coordinate system.
-   *
-   * @param  {Coordinates}  coord  The coordinate
-   * @return {number} planar distance
-   *
-   */
-  planarDistanceTo(coord) {
-    this.toVector3(v0).setZ(0);
-    coord.toVector3(v1).setZ(0);
-    return v0.distanceTo(v1);
-  }
-
-  /**
-   * Calculate geodetic distance between this coordinates and `coord`.
-   * **Geodetic distance** is calculated in an ellispoid space as the shortest distance
-   * across the curved surface of the world.
-   *
-   * => As the crow flies/ Orthodromy
-   *
-   * @param  {Coordinates}  coord  The coordinate
-   * @return {number} geodetic distance
-   *
-   */
-  geodeticDistanceTo(coord) {
-    this.as('EPSG:4326', coord0);
-    coord.as('EPSG:4326', coord1);
-    return ellipsoid.geodesicDistance(coord0, coord1);
-  }
-
-  /**
-   * Calculate earth euclidean distance between this coordinates and `coord`.
-   *
-   * @param  {Coordinates}  coord  The coordinate
-   * @return {number} earth euclidean distance
-   *
-   */
-  spatialEuclideanDistanceTo(coord) {
-    this.as('EPSG:4978', coord0).toVector3(v0);
-    coord.as('EPSG:4978', coord1).toVector3(v1);
-    return v0.distanceTo(v1);
-  }
-
-  /**
-   * Multiplies this `coordinates` (with an implicit 1 in the 4th dimension) and `mat`.
-   *
-   * @param      {THREE.Matrix4}  mat The matrix.
-   * @return     {Coordinates}  return this object.
-   */
-  applyMatrix4(mat) {
-    return THREE.Vector3.prototype.applyMatrix4.call(this, mat);
-  }
-
-  /**
-   * Returns coordinates in the wanted [CRS](http://inspire.ec.europa.eu/theme/rs).
-   *
-   * @param {string} crs - The CRS to convert the Coordinates into.
-   * @param {Coordinates} [target] - The target to put the converted
-   * Coordinates into. If not specified a new one will be created.
-   *
-   * @return {Coordinates} - The resulting Coordinates after the conversion.
-   *
-   * @example
-   * const position = { longitude: 2.33, latitude: 48.24, altitude: 24999549 };
-   * const coords = new Coordinates('EPSG:4326', position.longitude, position.latitude, position.altitude); // Geographic system
-   * const coordinates = coords.as('EPSG:4978'); // Geocentric system
-   *
-   * @example
-   * const position = { x: 20885167, y: 849862, z: 23385912 };
-   * const coords = new Coordinates('EPSG:4978', position.x, position.y, position.z);  // Geocentric system
-   * const coordinates = coords.as('EPSG:4326');  // Geographic system
-   *
-   * @example
-   * new Coordinates('EPSG:4326', longitude: 2.33, latitude: 48.24, altitude: 24999549).as('EPSG:4978'); // Geocentric system
-   *
-   * @example
-   * new Coordinates('EPSG:4978', x: 20885167, y: 849862, z: 23385912).as('EPSG:4326'); // Geographic system
-   */
-  as(crs) {
-    let target = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : new Coordinates(crs);
-    if (this.crs == crs) {
-      target.copy(this);
-    } else {
-      if (CRS.is4326(this.crs) && crs == 'EPSG:3857') {
-        this.y = THREE.MathUtils.clamp(this.y, -89.999999, 89.999999);
-      }
-      target.setFromArray(proj4cache(this.crs, crs).forward([this.x, this.y, this.z]));
-    }
-    target.crs = crs;
-    return target;
-  }
-}
-coord0 = new Coordinates('EPSG:4326', 0, 0, 0);
-coord1 = new Coordinates('EPSG:4326', 0, 0, 0);
-export default Coordinates;

package/lib/Core/Geographic/Crs.js

@@ -1,175 +0,0 @@
-import proj4 from 'proj4';
-proj4.defs('EPSG:4978', '+proj=geocent +datum=WGS84 +units=m +no_defs');
-function isString(s) {
-  return typeof s === 'string' || s instanceof String;
-}
-function mustBeString(crs) {
-  if (!isString(crs)) {
-    throw new Error(`Crs parameter value must be a string: '${crs}'`);
-  }
-}
-function isTms(crs) {
-  return isString(crs) && crs.startsWith('TMS');
-}
-function isEpsg(crs) {
-  return isString(crs) && crs.startsWith('EPSG');
-}
-function formatToTms(crs) {
-  mustBeString(crs);
-  return isTms(crs) ? crs : `TMS:${crs.match(/\d+/)[0]}`;
-}
-function formatToEPSG(crs) {
-  mustBeString(crs);
-  return isEpsg(crs) ? crs : `EPSG:${crs.match(/\d+/)[0]}`;
-}
-const UNIT = {
-  DEGREE: 1,
-  METER: 2
-};
-function is4326(crs) {
-  return crs === 'EPSG:4326';
-}
-function isGeocentric(crs) {
-  mustBeString(crs);
-  const projection = proj4.defs(crs);
-  return !projection ? false : projection.projName == 'geocent';
-}
-function _unitFromProj4Unit(projunit) {
-  if (projunit === 'degrees') {
-    return UNIT.DEGREE;
-  } else if (projunit === 'm') {
-    return UNIT.METER;
-  } else {
-    return undefined;
-  }
-}
-function toUnit(crs) {
-  mustBeString(crs);
-  switch (crs) {
-    case 'EPSG:4326':
-      return UNIT.DEGREE;
-    case 'EPSG:4978':
-      return UNIT.METER;
-    default:
-      {
-        const p = proj4.defs(formatToEPSG(crs));
-        if (!p) {
-          return undefined;
-        }
-        return _unitFromProj4Unit(p.units);
-      }
-  }
-}
-function toUnitWithError(crs) {
-  mustBeString(crs);
-  const u = toUnit(crs);
-  if (u === undefined) {
-    throw new Error(`No unit found for crs: '${crs}'`);
-  }
-  return u;
-}
-
-/**
- * This module provides basic methods to manipulate a CRS (as a string).
- *
- * @module CRS
- */
-export default {
-  /**
-   * Units that can be used for a CRS.
-   *
-   * @enum {number}
-   */
-  UNIT,
-  /**
-   * Assert that the CRS is valid one.
-   *
-   * @param {string} crs - The CRS to validate.
-   *
-   * @throws {Error} if the CRS is not valid.
-   */
-  isValid(crs) {
-    toUnitWithError(crs);
-  },
-  /**
-   * Assert that the CRS is geographic.
-   *
-   * @param {string} crs - The CRS to validate.
-   * @return {boolean}
-   * @throws {Error} if the CRS is not valid.
-   */
-  isGeographic(crs) {
-    return toUnitWithError(crs) == UNIT.DEGREE;
-  },
-  /**
-   * Assert that the CRS is using metric units.
-   *
-   * @param {string} crs - The CRS to validate.
-   * @return {boolean}
-   * @throws {Error} if the CRS is not valid.
-   */
-  isMetricUnit(crs) {
-    return toUnit(crs) == UNIT.METER;
-  },
-  /**
-   * Get the unit to use with the CRS.
-   *
-   * @param {string} crs - The CRS to get the unit from.
-   * @return {number} Either `UNIT.METER`, `UNIT.DEGREE` or `undefined`.
-   */
-  toUnit,
-  /**
-   * Is the CRS EPSG:4326 ?
-   *
-   * @param {string} crs - The CRS to test.
-   * @return {boolean}
-   */
-  is4326,
-  /**
-   * Is the CRS geocentric ?
-   * if crs isn't defined the method returns false.
-   *
-   * @param {string} crs - The CRS to test.
-   * @return {boolean}
-   */
-  isGeocentric,
-  /**
-   * Give a reasonnable epsilon to use with this CRS.
-   *
-   * @param {string} crs - The CRS to use.
-   * @return {number} 0.01 if the CRS is EPSG:4326, 0.001 otherwise.
-   */
-  reasonnableEpsilon(crs) {
-    if (is4326(crs)) {
-      return 0.01;
-    } else {
-      return 0.001;
-    }
-  },
-  /**
-   * format crs to European Petroleum Survey Group notation : EPSG:XXXX.
-   *
-   * @param      {string}  crs     The crs to format
-   * @return     {string}  formated crs
-   */
-  formatToEPSG,
-  /**
-   * format crs to tile matrix set notation : TMS:XXXX.
-   *
-   * @param      {string}  crs     The crs to format
-   * @return     {string}  formated crs
-   */
-  formatToTms,
-  isTms,
-  isEpsg,
-  tms_3857: 'TMS:3857',
-  tms_4326: 'TMS:4326',
-  /**
-   * Define a proj4 projection as a string and reference.
-   *
-   * @param {string}  code    code is the projection's SRS code (only used internally by the Proj4js library)
-   * @param {string}  proj4def is the Proj4 definition string for the projection to use
-   * @return {undefined}
-   */
-  defs: (code, proj4def) => proj4.defs(code, proj4def)
-};