@itowns/geographic 2.46.1-next.6 → 2.46.1-next.60

package/lib/Extent.js

@@ -10,7 +10,6 @@ const cSouthWest = /* @__PURE__ */new Coordinates('EPSG:4326', 0, 0, 0);
 const cNorthEast = /* @__PURE__ */new Coordinates('EPSG:4326', 0, 0, 0);
 const southWest = /* @__PURE__ */new Vector3();
 const northEast = /* @__PURE__ */new Vector3();
-let _extent;
 const cardinals = [/* @__PURE__ */new Coordinates('EPSG:4326', 0, 0, 0), /* @__PURE__ */new Coordinates('EPSG:4326', 0, 0, 0), /* @__PURE__ */new Coordinates('EPSG:4326', 0, 0, 0), /* @__PURE__ */new Coordinates('EPSG:4326', 0, 0, 0), /* @__PURE__ */new Coordinates('EPSG:4326', 0, 0, 0), /* @__PURE__ */new Coordinates('EPSG:4326', 0, 0, 0), /* @__PURE__ */new Coordinates('EPSG:4326', 0, 0, 0), /* @__PURE__ */new Coordinates('EPSG:4326', 0, 0, 0)];
 const _c = /* @__PURE__ */new Coordinates('EPSG:4326', 0, 0);
 /**
@@ -54,11 +53,7 @@ class Extent {
    * @param south - the `south` value of this extent. Default is 0.
    * @param north - the `north` value of this extent. Default is 0.
    */
-  constructor(crs) {
-    let west = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-    let east = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 0;
-    let south = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 0;
-    let north = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : 0;
+  constructor(crs, west = 0, east = 0, south = 0, north = 0) {
     if (CRS.isGeocentric(crs)) {
       throw new Error(`Non-compatible geocentric projection ${crs} to build a geographical extent`);
     }
@@ -73,6 +68,7 @@ class Extent {
 
   /**
    * Returns a new extent with the same bounds and crs as this one.
+   * @returns
    */
   clone() {
     return new Extent(this.crs, this.west, this.east, this.south, this.north);
@@ -84,9 +80,9 @@ class Extent {
    * @param crs - target's projection.
    * @param target - The target to store the projected extent. If this not
    * provided a new extent will be created.
+   * @returns
    */
-  as(crs) {
-    let target = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : new Extent('EPSG:4326');
+  as(crs, target = new Extent('EPSG:4326')) {
     CRS.isValid(crs);
     if (this.crs != crs) {
       // Compute min/max in x/y by projecting 8 cardinal points,
@@ -125,9 +121,9 @@ class Extent {
    *
    * @param target - The target to store the center coordinate. If this not
    * provided a new coordinate will be created.
+   * @returns
    */
-  center() {
-    let target = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : new Coordinates(this.crs);
+  center(target = new Coordinates(this.crs)) {
     this.planarDimensions(_dim);
     target.crs = this.crs;
     target.setFromValues(this.west + _dim.x * 0.5, this.south + _dim.y * 0.5);
@@ -141,9 +137,9 @@ class Extent {
    * 2D Cartesian coordinate system.
    *
    * @param target - optional target
+   * @returns
    */
-  planarDimensions() {
-    let target = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : new Vector2();
+  planarDimensions(target = new Vector2()) {
     // Calculte the dimensions for x and y
     return target.set(Math.abs(this.east - this.west), Math.abs(this.north - this.south));
   }
@@ -155,9 +151,9 @@ class Extent {
    * across the curved surface of the ellipsoid.
    *
    * @param target - optional target
+   * @returns
    */
-  geodeticDimensions() {
-    let target = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : new Vector2();
+  geodeticDimensions(target = new Vector2()) {
     // set 3 corners extent
     cNorthWest.crs = this.crs;
     cSouthWest.crs = this.crs;
@@ -176,9 +172,9 @@ class Extent {
    *  Spatial euclidean distance chord is calculated in an ellispoid space.
    *
    * @param target - optional target
+   * @returns
    */
-  spatialEuclideanDimensions() {
-    let target = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : new Vector2();
+  spatialEuclideanDimensions(target = new Vector2()) {
     // set 3 corners extent
     cNorthWest.crs = this.crs;
     cSouthWest.crs = this.crs;
@@ -197,9 +193,9 @@ class Extent {
    * @param coord - the given coordinates.
    * @param epsilon - error margin when comparing to the coordinates.
    * Default is 0.
+   * @returns
    */
-  isPointInside(coord) {
-    let epsilon = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
+  isPointInside(coord, epsilon = 0) {
     if (this.crs == coord.crs) {
       _c.copy(coord);
     } else {
@@ -215,9 +211,9 @@ class Extent {
    *
    * @param extent - the extent to check
    * @param epsilon - error margin when comparing the extent bounds.
+   * @returns
    */
-  isInside(extent) {
-    let epsilon = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : CRS.reasonableEpsilon(this.crs);
+  isInside(extent, epsilon = CRS.reasonableEpsilon(this.crs)) {
     extent.as(this.crs, _extent);
     return this.east - _extent.east <= epsilon && _extent.west - this.west <= epsilon && this.north - _extent.north <= epsilon && _extent.south - this.south <= epsilon;
   }
@@ -233,8 +229,7 @@ class Extent {
    * south-north, the `z` property the scale on west-east, the `w` property
    * the scale on south-north.
    */
-  offsetToParent(extent) {
-    let target = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : new Vector4();
+  offsetToParent(extent, target = new Vector4()) {
     if (this.crs != extent.crs) {
       throw new Error('unsupported mix');
     }
@@ -251,28 +246,55 @@ class Extent {
    * Checks wheter this bounding box intersects with the given extent
    * parameter.
    * @param extent - the provided extent
+   * @returns
    */
   intersectsExtent(extent) {
     return Extent.intersectsExtent(this, extent);
   }
+
+  /**
+   * Tests whether two extents intersect.
+   *
+   * This method checks if the geographic extents `extentA` and `extentB`
+   * overlap. If their coordinate reference systems (CRS) differ, `extentB`
+   * is reprojected into the CRS of `extentA` before performing the test.
+   *
+   * Extents that touch at an edge or a corner aren't treated as intersecting.
+   *
+   * @param extentA - The reference extent.
+   * @param extentB - The extent to test against.
+   *
+   * @returns `true` if the extents intersect, `false` otherwise.
+   */
   static intersectsExtent(extentA, extentB) {
-    // TODO don't work when is on limit
     const other = extentB.crs == extentA.crs ? extentB : extentB.as(extentA.crs, _extent);
     return !(extentA.west >= other.east || extentA.east <= other.west || extentA.south >= other.north || extentA.north <= other.south);
   }
 
   /**
    * Returns the intersection of this extent with another one.
-   * @param extent - extent to intersect
+   *
+   * This method computes the overlapping region between this extent and
+   * another extent. If their coordinate reference systems (CRS) differ,
+   * the other extent is reprojected into the CRS of this extent before
+   * performing the intersection.
+   *
+   *
+   * @param extent - The extent to intersect with this one.
+   * @param target - The target extent to store the result. If not provided,
+   * a new extent will be created.
+   *
+   * @returns The intersection extent
+   * (may be empty if extents do not intersect).
    */
-  intersect(extent) {
+  intersect(extent, target = new Extent(this.crs)) {
     if (!this.intersectsExtent(extent)) {
-      return new Extent(this.crs);
+      return target;
     }
     if (extent.crs != this.crs) {
       extent = extent.as(this.crs, _extent);
     }
-    return new Extent(this.crs, Math.max(this.west, extent.west), Math.min(this.east, extent.east), Math.max(this.south, extent.south), Math.min(this.north, extent.north));
+    return target.set(Math.max(this.west, extent.west), Math.min(this.east, extent.east), Math.max(this.south, extent.south), Math.min(this.north, extent.north));
   }
 
   /**
@@ -282,6 +304,7 @@ class Extent {
    * @param v1 - the `east` value of this extent. Default is 0.
    * @param v2 - the `south` value of this extent. Default is 0.
    * @param v3 - the `north` value of this extent. Default is 0.
+   * @returns
    */
   set(v0, v1, v2, v3) {
     if (v0 == undefined) {
@@ -313,9 +336,9 @@ class Extent {
    * `north` property to `array[offset + 3]`.
    * @param array - the source array
    * @param offset - offset into the array. Default is 0.
+   * @returns
    */
-  setFromArray(array) {
-    let offset = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
+  setFromArray(array, offset = 0) {
     this.west = array[offset];
     this.east = array[offset + 1];
     this.south = array[offset + 2];
@@ -327,6 +350,7 @@ class Extent {
    * Sets this extent `west`, `east`, `south` and `north` properties from an
    * `extent` bounds.
    * @param extent - the source extent
+   * @returns
    */
   setFromExtent(extent) {
     this.west = extent.west;
@@ -339,6 +363,7 @@ class Extent {
   /**
    * Copies the passed extent to this extent.
    * @param extent - extent to copy.
+   * @returns
    */
   copy(extent) {
     this.crs = extent.crs;
@@ -348,6 +373,7 @@ class Extent {
   /**
    * Union this extent with the input extent.
    * @param extent - the extent to union.
+   * @returns
    */
   union(extent) {
     if (extent.crs != this.crs) {
@@ -373,6 +399,7 @@ class Extent {
         this.north = north;
       }
     }
+    return this;
   }
 
   /**
@@ -386,12 +413,11 @@ class Extent {
   }
 
   /**
-  * expandByValuesCoordinates perfoms the minimal extension
-  * for the coordinates values to belong to this Extent object
-  * @param we - The coordinate on west-east
-  * @param sn - The coordinate on south-north
-  *
-  */
+   * expandByValuesCoordinates perfoms the minimal extension
+   * for the coordinates values to belong to this Extent object
+   * @param we - The coordinate on west-east
+   * @param sn - The coordinate on south-north
+   */
   expandByValuesCoordinates(we, sn) {
     if (we < this.west) {
       this.west = we;
@@ -416,6 +442,7 @@ class Extent {
    *
    * @param crs - Projection of extent to instancied.
    * @param box - Bounding-box
+   * @returns
    */
   static fromBox3(crs, box) {
     if (CRS.isGeocentric(crs)) {
@@ -438,9 +465,9 @@ class Extent {
   /**
    * Return values of extent in string, separated by the separator input.
    * @param sep - string separator
+   * @returns
    */
-  toString() {
-    let sep = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
+  toString(sep = '') {
     return `${this.east}${sep}${this.north}${sep}${this.west}${sep}${this.south}`;
   }
 
@@ -461,8 +488,7 @@ class Extent {
    * @param scheme - The scheme to subdivise.
    * @returns subdivised extents.
    */
-  subdivisionByScheme() {
-    let scheme = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : defaultScheme;
+  subdivisionByScheme(scheme = defaultScheme) {
     const subdivisedExtents = [];
     const dimSub = this.planarDimensions(_dim).divide(scheme);
     for (let x = scheme.x - 1; x >= 0; x--) {
@@ -509,9 +535,7 @@ class Extent {
    * @param north - The max north
    * @returns this extent
    */
-  clampSouthNorth() {
-    let south = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : this.south;
-    let north = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : this.north;
+  clampSouthNorth(south = this.south, north = this.north) {
     this.south = Math.max(this.south, south);
     this.north = Math.min(this.north, north);
     return this;
@@ -524,9 +548,7 @@ class Extent {
    * @param east - The max east
    * @returns this extent
    */
-  clampWestEast() {
-    let west = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : this.west;
-    let east = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : this.east;
+  clampWestEast(west = this.west, east = this.east) {
     this.west = Math.max(this.west, west);
     this.east = Math.min(this.east, east);
     return this;
@@ -543,5 +565,5 @@ class Extent {
     return this.clampWestEast(extent.west, extent.east);
   }
 }
-_extent = /* @__PURE__ */new Extent('EPSG:4326');
+const _extent = /* @__PURE__ */new Extent('EPSG:4326');
 export default Extent;

package/lib/OrientationUtils.d.ts

@@ -0,0 +1,105 @@
+import { Quaternion } from 'three';
+import { type ProjectionDefinition } from 'proj4';
+import Coordinates from './Coordinates';
+interface EulerAngles {
+    /** angle in degrees */
+    roll: number;
+    /** angle in degrees */
+    pitch: number;
+    /** angle in degrees */
+    heading: number;
+}
+interface PhotogrammetryAngles {
+    /** angle in degrees */
+    omega: number;
+    /** angle in degrees */
+    phi: number;
+    /** angle in degrees */
+    kappa: number;
+}
+type Attitude = Partial<EulerAngles> | Partial<PhotogrammetryAngles>;
+type QuaternionFunction = (coords: Coordinates, target?: Quaternion) => Quaternion;
+type ProjectionLike = ProjectionDefinition | string;
+interface LCCProjection {
+    long0: number;
+    lat0: number;
+}
+interface TMercProjection {
+    a: number;
+    b: number;
+    e?: number;
+    long0: number;
+}
+/**
+ * The transform from the platform frame to the local East, North, Up (ENU)
+ * frame is `RotationZ(heading).RotationX(pitch).RotationY(roll)`.
+ *
+ * @param roll - angle in degrees. Default is 0.
+ * @param pitch - angle in degrees. Default is 0.
+ * @param heading - angle in degrees. Default is 0
+ * @param target - output Quaternion
+ *
+ * @returns The target quaternion
+ */
+export declare function quaternionFromRollPitchHeading(roll?: number, pitch?: number, heading?: number, target?: Quaternion): Quaternion;
+/**
+ * From
+ * [DocMicMac](https://github.com/micmacIGN/Documentation/raw/master/DocMicMac.pdf),
+ * the transform from the platform frame to the local East, North, Up (ENU)
+ * frame is:
+ *
+ * ```
+ * RotationX(omega).RotationY(phi).RotationZ(kappa).RotationX(PI)
+ * Converts between the 2 conventions for the camera local frame:
+ * RotationX(PI) <=> Quaternion(1,0,0,0)
+ * X right, Y bottom, Z front : convention in photogrammetry and computer vision
+ * X right, Y top,    Z back  : convention in webGL, threejs
+ * ```
+ *
+ * @param omega - angle in degrees. Default is 0.
+ * @param phi - angle in degrees. Default is 0.
+ * @param kappa - angle in degrees. Default is 0.
+ * @param target - output quaternion
+ *
+ * @returns The target quaternion
+ */
+export declare function quaternionFromOmegaPhiKappa(omega?: number, phi?: number, kappa?: number, target?: Quaternion): Quaternion;
+/**
+ * Sets the quaternion according to the rotation from the platform frame to the
+ * local frame.
+ *
+ * @param attitude - either euler angles or photogrammetry angles
+ * @param target - output Quaternion
+ *
+ * @returns The target quaternion
+ */
+export declare function quaternionFromAttitude(attitude: Attitude, target?: Quaternion): Quaternion;
+export declare function quaternionFromEnuToGeocent(): QuaternionFunction;
+export declare function quaternionFromEnuToGeocent(coords: Coordinates, target?: Quaternion): Quaternion;
+export declare function quaternionFromGeocentToEnu(): QuaternionFunction;
+export declare function quaternionFromGeocentToEnu(coords: Coordinates, target?: Quaternion): Quaternion;
+export declare function quaternionFromLCCToEnu(proj: LCCProjection): QuaternionFunction;
+export declare function quaternionFromLCCToEnu(proj: LCCProjection, coords: Coordinates, target?: Quaternion): Quaternion;
+export declare function quaternionFromEnuToLCC(proj: LCCProjection): QuaternionFunction;
+export declare function quaternionFromEnuToLCC(proj: LCCProjection, coords: Coordinates, target?: Quaternion): Quaternion;
+export declare function quaternionFromTMercToEnu(proj: TMercProjection): QuaternionFunction;
+export declare function quaternionFromTMercToEnu(proj: TMercProjection, coords: Coordinates, target?: Quaternion): Quaternion;
+export declare function quaternionFromEnuToTMerc(proj: TMercProjection): QuaternionFunction;
+export declare function quaternionFromEnuToTMerc(proj: TMercProjection, coords: Coordinates, target?: Quaternion): Quaternion;
+export declare function quaternionFromLongLatToEnu(): QuaternionFunction;
+export declare function quaternionFromLongLatToEnu(coords: Coordinates, target?: Quaternion): Quaternion;
+export declare function quaternionFromEnuToLongLat(): QuaternionFunction;
+export declare function quaternionFromEnuToLongLat(coords: Coordinates, target?: Quaternion): Quaternion;
+export declare function quaternionUnimplemented(proj: {
+    projName?: string;
+}): QuaternionFunction;
+export declare function quaternionUnimplemented(proj: {
+    projName?: string;
+}, coords: Coordinates, target?: Quaternion): Quaternion;
+export declare function quaternionFromEnuToCRS(proj: ProjectionLike): QuaternionFunction;
+export declare function quaternionFromEnuToCRS(proj: ProjectionLike, coords: Coordinates, target?: Quaternion): Quaternion;
+export declare function quaternionFromCRSToEnu(proj: ProjectionLike): QuaternionFunction;
+export declare function quaternionFromCRSToEnu(proj: ProjectionLike, coords: Coordinates, target?: Quaternion): Quaternion;
+export declare function quaternionFromCRSToCRS(crsIn: string, crsOut: string): QuaternionFunction;
+export declare function quaternionFromCRSToCRS(crsIn: string, crsOut: string, coords: Coordinates, target?: Quaternion): Quaternion;
+export {};