itowns 2.44.3-next.40 → 2.44.3-next.41

package/lib/Core/Geographic/Coordinates.js

@@ -1,331 +0,0 @@
-import * as THREE from 'three';
-import proj4 from 'proj4';
-import * as CRS from "./Crs.js";
-import Ellipsoid from "../Math/Ellipsoid.js";
-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 class representing a geographic or geocentric coordinate.
- *
- * A coordinate is defined by a [CRS](http://inspire.ec.europa.eu/theme/rs)
- * (Coordinate Reference System) and a 3-dimensional vector `(x, y, z)`.
- * For geocentric projections, it is recommended to use the `latitude`,
- * `longitude` and `altitude` aliases to refer to vector components.
- *
- * To change a value, prefer the use of the `set*` methods.
- *
- * By default, the `EPSG:4978` and `EPSG:4326` projections are supported. To use
- * a different projection, it must have been declared previously with `proj4`.
- * A comprehensive list of projections and their corresponding proj4 string can
- * be found at [epsg.io](https://epsg.io/).
- *
- * @example Geocentric coordinates
- * ```js
- * new Coordinates('EPSG:4978', 20885167, 849862, 23385912);
- * ```
- *
- * @example Geographic coordinates
- * ```js
- * new Coordinates('EPSG:4326', 2.33, 48.24, 24999549);
- * ```
- *
- * @example Defining the EPSG:2154 projection with proj4
- * ```js
- * proj4.defs('EPSG:2154', `+proj=lcc +lat_0=46.5 +lon_0=3 +lat_1=49 +lat_2=44
- * +x_0=700000 +y_0=6600000 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m
- * +no_defs +type=crs`);
- * ```
- */
-class Coordinates {
-  /**
-   * Read-only flag to check if a given object is of type `Coordinates`.
-   */
-
-  /**
-   * A default or user-defined CRS (see {@link ProjectionLike}).
-   */
-
-  /** The x value (or longitude) of this coordinate. */
-
-  /** The y value (or latitude) of this coordinate. */
-
-  /** The z value (or altitude) of this coordinate. */
-
-  /**
-   * @param crs - A default or user-defined CRS (see {@link ProjectionLike}).
-   * @param x - x or longitude value.
-   * @param y - y or latitude value.
-   * @param z - z or altitude value.
-   */
-  constructor(crs) {
-    let x = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-    let y = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 0;
-    let z = 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();
-
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    if (x.length > 0) {
-      // deepscan-disable-line
-      console.warn('Deprecated Coordinates#constructor(string, number[]),', 'use `new Coordinates(string).setFromArray(number[])` instead.');
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      this.setFromArray(x);
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    } else if (x.isVector3 || x.isCoordinates) {
-      console.warn('Deprecated Coordinates#constructor(string, Vector3),', 'use `new Coordinates(string).setFromVector3(Vector3)` instead.');
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      this.setFromVector3(x);
-    } else {
-      this.setFromValues(x, y, z);
-    }
-    this._normalNeedsUpdate = true;
-  }
-
-  /**
-   * Sets the Coordinate Reference System.
-   * @param crs - Coordinate Reference System (e.g. 'EPSG:4978')
-   */
-  setCrs(crs) {
-    CRS.isValid(crs);
-    this.crs = crs;
-    return this;
-  }
-
-  /**
-   * Sets the x, y and z components of this coordinate.
-   *
-   * @param x - x or longitude value.
-   * @param y - y or latitude value.
-   * @param z - z or altitude value.
-   */
-  setFromValues() {
-    let x = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
-    let y = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-    let z = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 0;
-    this.x = x;
-    this.y = y;
-    this.z = z;
-    this._normalNeedsUpdate = true;
-    return this;
-  }
-
-  /**
-   * Sets the coordinates's {@link Coordinates#x | x} component to
-   * `array[offset + 0]`, {@link Coordinates#y | y} component to
-   * `array[offset + 1]` and {@link Coordinates#z | z} component to
-   * `array[offset + 2]`.
-   *
-   * @param array - The source array.
-   * @param offset - Optional offset into the array. Default is 0.
-   */
-  setFromArray(array) {
-    let offset = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-    return this.setFromValues(array[offset], array[offset + 1], array[offset + 2]);
-  }
-
-  /**
-   * Sets the `(x, y, z)` vector of this coordinate from a 3-dimensional
-   * vector-like object. This object shall have both `x`, `y` and `z`
-   * properties.
-   *
-   * @param v - The source object.
-   */
-  setFromVector3(v) {
-    return this.setFromValues(v.x, v.y, v.z);
-  }
-
-  /**
-   * Returns a new coordinate with the same `(x, y, z)` vector and crs as this
-   * one.
-   */
-  clone() {
-    return new Coordinates(this.crs, this.x, this.y, this.z);
-  }
-
-  /**
-   * Copies the `(x, y, z)` vector components and crs of the passed coordinate
-   * to this coordinate.
-   *
-   * @param src - The source coordinate to copy from.
-   */
-  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;
-  }
-
-  /**
-   * The geodesic normal of the coordinate.
-   */
-  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;
-  }
-
-  /**
-   * Copies the `x`, `y` and `z` components into the provided `THREE.Vector3`.
-   *
-   * @param target - An object to store this vector to. If this is not
-   * specified, a new vector will be created.
-   *
-   * @returns A vector `(x, y, z)`, or copies x, y and z into the provided
-   * vector.
-   */
-  toVector3() {
-    let target = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : new THREE.Vector3();
-    return target.copy(this);
-  }
-
-  /**
-   * Copies the `x`, `y` and `z` components into the provided array.
-   *
-   * @param array - An array to store this vector to. If this is not
-   * provided a new array will be created.
-   * @param offset - An optional offset into the array.
-   *
-   * @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);
-  }
-
-  /**
-   * Computes the planar distance from this coordinates to `coord`.
-   * **Planar distance** is the straight-line euclidean distance calculated in
-   * a 2D cartesian coordinate system.
-   */
-  planarDistanceTo(coord) {
-    this.toVector3(v0).setZ(0);
-    coord.toVector3(v1).setZ(0);
-    return v0.distanceTo(v1);
-  }
-
-  /**
-   * Computes the geodetic distance from this coordinates to `coord`.
-   * **Geodetic distance** is calculated in an ellipsoid space as the shortest
-   * distance across the curved surface of the ellipsoid.
-   */
-  geodeticDistanceTo(coord) {
-    this.as('EPSG:4326', coord0);
-    coord.as('EPSG:4326', coord1);
-    return ellipsoid.geodesicDistance(coord0, coord1);
-  }
-
-  /**
-   * Computes the euclidean distance from this coordinates to `coord` in a
-   * WGS84 projection.
-   *
-   * @param coord - The coordinate
-   * @returns 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 coordinate (with an implicit 1 in the 4th dimension)
-   * by `mat`, and divides by perspective.
-   *
-   * @param mat - The matrix.
-   */
-  applyMatrix4(mat) {
-    THREE.Vector3.prototype.applyMatrix4.call(this, mat);
-    return this;
-  }
-
-  /**
-   * Projects this coordinate to the specified
-   * [CRS](http://inspire.ec.europa.eu/theme/rs).
-   *
-   * @param crs - The target CRS to which the coordinate will be converted.
-   * @param target - The target to store the projected coordinate. If this not
-   * provided a new coordinate will be created.
-   *
-   * @returns The coordinate projected into the specified CRS.
-   *
-   * @example Conversion from a geographic to a geocentric reference system
-   * ```js
-   * const geographicCoords = new Coordinates('EPSG:4326',
-   *     2.33,        // longitude
-   *     48.24,       // latitude
-   *     24999549,    // altitude
-   * );
-   * const geocentricCoords = geographicCoords.as('EPSG:4978');
-   * ```
-   *
-   * @example Conversion from a geocentric to a geographic reference system
-   * ```js
-   * const geocentricCoords = new Coordinates('EPSG:4978',
-   *     20885167,    // x
-   *     849862,      // y
-   *     23385912,    // z
-   * );
-   * const geographicCoords = geocentricCoords.as('EPSG:4326');
-   * ```
-   */
-  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,170 +0,0 @@
-import proj4 from 'proj4';
-proj4.defs('EPSG:4978', '+proj=geocent +datum=WGS84 +units=m +no_defs');
-
-// Redefining proj4 global projections to match epsg.org database axis order.
-// See https://github.com/iTowns/itowns/pull/2465#issuecomment-2517024859
-proj4.defs('EPSG:4326').axis = 'neu';
-proj4.defs('EPSG:4269').axis = 'neu';
-proj4.defs('WGS84').axis = 'neu';
-
-/**
- * A projection as a CRS identifier string. This identifier references a
- * projection definition previously defined with
- * [`proj4.defs`](https://github.com/proj4js/proj4js#named-projections).
- */
-
-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}'`);
-  }
-}
-
-/**
- * System units supported for a coordinate system. See
- * [proj](https://proj4.org/en/9.5/operations/conversions/unitconvert.html#angular-units).
- * Note that only degree and meters units are supported for now.
- */
-export const UNIT = {
-  /**
-   * Angular unit in degree.
-   */
-  DEGREE: 1,
-  /**
-   * Distance unit in meter.
-   */
-  METER: 2,
-  /**
-   * Distance unit in foot.
-   */
-  FOOT: 3
-};
-
-/**
- * Checks that the CRS is EPSG:4326.
- * @internal
- *
- * @param crs - The CRS to test.
- */
-export function is4326(crs) {
-  return crs === 'EPSG:4326';
-}
-function unitFromProj4Unit(proj) {
-  if (proj.units === 'degrees') {
-    return UNIT.DEGREE;
-  } else if (proj.units === 'm' || proj.units === 'meter') {
-    return UNIT.METER;
-  } else if (proj.units === 'foot') {
-    return UNIT.FOOT;
-  } else if (proj.units === undefined && proj.to_meter === undefined) {
-    // See https://proj.org/en/9.4/usage/projections.html [17/10/2024]
-    // > The default unit for projected coordinates is the meter.
-    return UNIT.METER;
-  } else {
-    return undefined;
-  }
-}
-
-/**
- * Returns the horizontal coordinates system units associated with this CRS.
- *
- * @param crs - The CRS to extract the unit from.
- * @returns Either `UNIT.METER`, `UNIT.DEGREE`, `UNIT.FOOT` or `undefined`.
- */
-export function getUnit(crs) {
-  mustBeString(crs);
-  const p = proj4.defs(crs);
-  if (!p) {
-    return undefined;
-  }
-  return unitFromProj4Unit(p);
-}
-
-/**
- * Asserts that the CRS is using metric units.
- *
- * @param crs - The CRS to check.
- * @throws {@link Error} if the CRS is not valid.
- */
-export function isMetricUnit(crs) {
-  return getUnit(crs) === UNIT.METER;
-}
-
-/**
- * Asserts that the CRS is geographic.
- *
- * @param crs - The CRS to check.
- * @throws {@link Error} if the CRS is not valid.
- */
-export function isGeographic(crs) {
-  return getUnit(crs) === UNIT.DEGREE;
-}
-
-/**
- * Asserts that the CRS is geocentric.
- *
- * @param crs - The CRS to test.
- * @returns false if the crs isn't defined.
- */
-export function isGeocentric(crs) {
-  mustBeString(crs);
-  const projection = proj4.defs(crs);
-  return !projection ? false : projection.projName == 'geocent';
-}
-
-/**
- * Asserts that the CRS is valid, meaning it has been previously defined and
- * includes an unit.
- *
- * @param crs - The CRS to test.
- * @throws {@link Error} if the crs is not valid.
- */
-export function isValid(crs) {
-  const proj = proj4.defs(crs);
-  if (!proj) {
-    throw new Error(`Undefined crs '${crs}'. Add it with proj4.defs('${crs}', string)`);
-  }
-  if (!unitFromProj4Unit(proj)) {
-    throw new Error(`No valid unit found for crs '${crs}', found ${proj.units}`);
-  }
-}
-
-/**
- * Gives a reasonable epsilon for this CRS.
- *
- * @param crs - The CRS to use.
- * @returns 0.01 if the CRS is EPSG:4326, 0.001 otherwise.
- */
-export function reasonableEpsilon(crs) {
-  if (is4326(crs)) {
-    return 0.01;
-  } else {
-    return 0.001;
-  }
-}
-
-/**
- * Returns the axis parameter defined in proj4 for the provided crs.
- * Might be undefined depending on crs definition.
- *
- * @param crs - The CRS to get axis from.
- * @returns the matching proj4 axis string, 'enu' for instance (east, north, up)
- */
-export function axisOrder(crs) {
-  mustBeString(crs);
-  const projection = proj4.defs(crs);
-  return !projection ? undefined : projection.axis;
-}
-
-/**
- * Defines a proj4 projection as a named alias.
- * This function is a specialized wrapper over the
- * [`proj4.defs`](https://github.com/proj4js/proj4js#named-projections)
- * function.
- *
- * @param code - Named alias of the currently defined projection.
- * @param proj4def - Proj4 or WKT string of the defined projection.
- */
-export const defs = (code, proj4def) => proj4.defs(code, proj4def);