@itowns/geographic 2.46.1-next.52 → 2.46.1-next.54

package/lib/Coordinates.d.ts

@@ -65,6 +65,7 @@ declare class Coordinates {
     /**
      * Sets the Coordinate Reference System.
      * @param crs - Coordinate Reference System (e.g. 'EPSG:4978')
+     * @returns
      */
     setCrs(crs: ProjectionLike): this;
     /**
@@ -73,6 +74,7 @@ declare class Coordinates {
      * @param x - x or longitude value.
      * @param y - y or latitude value.
      * @param z - z or altitude value.
+     * @returns
      */
     setFromValues(x?: number, y?: number, z?: number): this;
     /**
@@ -83,6 +85,7 @@ declare class Coordinates {
      *
      * @param array - The source array.
      * @param offset - Optional offset into the array. Default is 0.
+     * @returns
      */
     setFromArray(array: number[], offset?: number): this;
     /**
@@ -91,11 +94,13 @@ declare class Coordinates {
      * properties.
      *
      * @param v - The source object.
+     * @returns
      */
     setFromVector3(v: Vector3Like): this;
     /**
      * Returns a new coordinate with the same `(x, y, z)` vector and crs as this
      * one.
+     * @returns
      */
     clone(): Coordinates;
     /**
@@ -103,6 +108,7 @@ declare class Coordinates {
      * to this coordinate.
      *
      * @param src - The source coordinate to copy from.
+     * @returns
      */
     copy(src: CoordinatesLike): this;
     get longitude(): number;
@@ -111,6 +117,7 @@ declare class Coordinates {
     set altitude(value: number);
     /**
      * The geodesic normal of the coordinate.
+     * @returns
      */
     get geodesicNormal(): Vector3;
     /**
@@ -138,12 +145,16 @@ declare class Coordinates {
      * Computes the planar distance from this coordinates to `coord`.
      * **Planar distance** is the straight-line euclidean distance calculated in
      * a 2D cartesian coordinate system.
+     * @param coord
+     * @returns
      */
     planarDistanceTo(coord: Coordinates): number;
     /**
      * 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.
+     * @param coord
+     * @returns
      */
     geodeticDistanceTo(coord: Coordinates): number;
     /**
@@ -159,6 +170,7 @@ declare class Coordinates {
      * by `mat`, and divides by perspective.
      *
      * @param mat - The matrix.
+     * @returns
      */
     applyMatrix4(mat: Matrix4): this;
     /**

package/lib/Coordinates.js

@@ -93,6 +93,7 @@ class Coordinates {
   /**
    * Sets the Coordinate Reference System.
    * @param crs - Coordinate Reference System (e.g. 'EPSG:4978')
+   * @returns
    */
   setCrs(crs) {
     CRS.isValid(crs);
@@ -106,6 +107,7 @@ class Coordinates {
    * @param x - x or longitude value.
    * @param y - y or latitude value.
    * @param z - z or altitude value.
+   * @returns
    */
   setFromValues(x = 0, y = 0, z = 0) {
     this.x = x;
@@ -123,6 +125,7 @@ class Coordinates {
    *
    * @param array - The source array.
    * @param offset - Optional offset into the array. Default is 0.
+   * @returns
    */
   setFromArray(array, offset = 0) {
     return this.setFromValues(array[offset], array[offset + 1], array[offset + 2]);
@@ -134,6 +137,7 @@ class Coordinates {
    * properties.
    *
    * @param v - The source object.
+   * @returns
    */
   setFromVector3(v) {
     return this.setFromValues(v.x, v.y, v.z);
@@ -142,6 +146,7 @@ class Coordinates {
   /**
    * Returns a new coordinate with the same `(x, y, z)` vector and crs as this
    * one.
+   * @returns
    */
   clone() {
     return new Coordinates(this.crs, this.x, this.y, this.z);
@@ -152,6 +157,7 @@ class Coordinates {
    * to this coordinate.
    *
    * @param src - The source coordinate to copy from.
+   * @returns
    */
   copy(src) {
     this.crs = src.crs;
@@ -172,6 +178,7 @@ class Coordinates {
 
   /**
    * The geodesic normal of the coordinate.
+   * @returns
    */
   get geodesicNormal() {
     if (this._normalNeedsUpdate) {
@@ -218,6 +225,8 @@ class Coordinates {
    * Computes the planar distance from this coordinates to `coord`.
    * **Planar distance** is the straight-line euclidean distance calculated in
    * a 2D cartesian coordinate system.
+   * @param coord
+   * @returns
    */
   planarDistanceTo(coord) {
     this.toVector3(v0).setZ(0);
@@ -229,6 +238,8 @@ class Coordinates {
    * 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.
+   * @param coord
+   * @returns
    */
   geodeticDistanceTo(coord) {
     this.as('EPSG:4326', coord0);
@@ -254,6 +265,7 @@ class Coordinates {
    * by `mat`, and divides by perspective.
    *
    * @param mat - The matrix.
+   * @returns
    */
   applyMatrix4(mat) {
     Vector3.prototype.applyMatrix4.call(this, mat);

package/lib/Crs.d.ts

@@ -31,6 +31,7 @@ export declare const UNIT: {
  * @internal
  *
  * @param crs - The CRS to test.
+ * @returns
  */
 export declare function is4326(crs: ProjectionLike): crs is "EPSG:4326";
 /**
@@ -44,14 +45,16 @@ export declare function getUnit(crs: ProjectionLike): 1 | 2 | 3 | undefined;
  * Asserts that the CRS is using metric units.
  *
  * @param crs - The CRS to check.
- * @throws {@link Error} if the CRS is not valid.
+ * @returns
+ * @throws {Error} if the CRS is not valid.
  */
 export declare function isMetricUnit(crs: ProjectionLike): boolean;
 /**
  * Asserts that the CRS is geographic.
  *
  * @param crs - The CRS to check.
- * @throws {@link Error} if the CRS is not valid.
+ * @returns
+ * @throws {Error} if the CRS is not valid.
  */
 export declare function isGeographic(crs: ProjectionLike): boolean;
 /**
@@ -66,7 +69,7 @@ export declare function isGeocentric(crs: ProjectionLike): boolean;
  * includes an unit.
  *
  * @param crs - The CRS to test.
- * @throws {@link Error} if the crs is not valid.
+ * @throws {Error} if the crs is not valid.
  */
 export declare function isValid(crs: ProjectionLike): void;
 /**

package/lib/Crs.js

@@ -58,6 +58,7 @@ export const UNIT = {
  * @internal
  *
  * @param crs - The CRS to test.
+ * @returns
  */
 export function is4326(crs) {
   return crs === 'EPSG:4326';
@@ -97,7 +98,8 @@ export function getUnit(crs) {
  * Asserts that the CRS is using metric units.
  *
  * @param crs - The CRS to check.
- * @throws {@link Error} if the CRS is not valid.
+ * @returns
+ * @throws {Error} if the CRS is not valid.
  */
 export function isMetricUnit(crs) {
   return getUnit(crs) === UNIT.METER;
@@ -107,7 +109,8 @@ export function isMetricUnit(crs) {
  * Asserts that the CRS is geographic.
  *
  * @param crs - The CRS to check.
- * @throws {@link Error} if the CRS is not valid.
+ * @returns
+ * @throws {Error} if the CRS is not valid.
  */
 export function isGeographic(crs) {
   return getUnit(crs) === UNIT.DEGREE;
@@ -130,7 +133,7 @@ export function isGeocentric(crs) {
  * includes an unit.
  *
  * @param crs - The CRS to test.
- * @throws {@link Error} if the crs is not valid.
+ * @throws {Error} if the crs is not valid.
  */
 export function isValid(crs) {
   const proj = proj4.defs(crs);

package/lib/Ellipsoid.d.ts

@@ -28,6 +28,7 @@ declare class Ellipsoid {
      * @param cartesian - The given cartesian coordinate.
      * @param target - An object to store this vector to. If this is not
      * specified, a new vector will be created.
+     * @returns
      */
     geodeticSurfaceNormal(cartesian: Coordinates, target?: Vector3): Vector3;
     /**
@@ -37,6 +38,7 @@ declare class Ellipsoid {
      * @param coordCarto - The given geographic coordinate.
      * @param target - An object to store this vector to. If this is not
      * specified, a new vector will be created.
+     * @returns
      */
     geodeticSurfaceNormalCartographic(coordCarto: Coordinates, target?: Vector3): Vector3;
     /**
@@ -45,6 +47,7 @@ declare class Ellipsoid {
      * properties.
      *
      * @param size - The source vector.
+     * @returns
      */
     setSize(size: Vector3Like): this;
     cartographicToCartesian(coordCarto: Coordinates, target?: Vector3): Vector3;

package/lib/Ellipsoid.js

@@ -36,6 +36,7 @@ class Ellipsoid {
    * @param cartesian - The given cartesian coordinate.
    * @param target - An object to store this vector to. If this is not
    * specified, a new vector will be created.
+   * @returns
    */
   geodeticSurfaceNormal(cartesian, target = new Vector3()) {
     return cartesian.toVector3(target).multiply(this._invRadiiSquared).normalize();
@@ -48,6 +49,7 @@ class Ellipsoid {
    * @param coordCarto - The given geographic coordinate.
    * @param target - An object to store this vector to. If this is not
    * specified, a new vector will be created.
+   * @returns
    */
   geodeticSurfaceNormalCartographic(coordCarto, target = new Vector3()) {
     const longitude = MathUtils.degToRad(coordCarto.longitude);
@@ -62,6 +64,7 @@ class Ellipsoid {
    * properties.
    *
    * @param size - The source vector.
+   * @returns
    */
   setSize(size) {
     this.size.set(size.x, size.y, size.z);
@@ -134,7 +137,7 @@ class Ellipsoid {
       // both intersections are behind the ray origin
       return false;
     }
-    let t = 0;
+    let t;
     if (t1 <= EPSILON) {
       t = t2;
     } else if (t2 <= EPSILON) {

package/lib/Extent.d.ts

@@ -51,6 +51,7 @@ declare class Extent {
     constructor(crs: ProjectionLike, west?: number, east?: number, south?: number, north?: number);
     /**
      * Returns a new extent with the same bounds and crs as this one.
+     * @returns
      */
     clone(): Extent;
     /**
@@ -59,6 +60,7 @@ declare 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: string, target?: Extent): Extent;
     /**
@@ -66,6 +68,7 @@ declare class Extent {
      *
      * @param target - The target to store the center coordinate. If this not
      * provided a new coordinate will be created.
+     * @returns
      */
     center(target?: Coordinates): Coordinates;
     /**
@@ -75,6 +78,7 @@ declare class Extent {
      * 2D Cartesian coordinate system.
      *
      * @param target - optional target
+     * @returns
      */
     planarDimensions(target?: Vector2): Vector2;
     /**
@@ -84,6 +88,7 @@ declare class Extent {
      * across the curved surface of the ellipsoid.
      *
      * @param target - optional target
+     * @returns
      */
     geodeticDimensions(target?: Vector2): Vector2;
     /**
@@ -92,6 +97,7 @@ declare class Extent {
      *  Spatial euclidean distance chord is calculated in an ellispoid space.
      *
      * @param target - optional target
+     * @returns
      */
     spatialEuclideanDimensions(target?: Vector2): Vector2;
     /**
@@ -100,6 +106,7 @@ declare class Extent {
      * @param coord - the given coordinates.
      * @param epsilon - error margin when comparing to the coordinates.
      * Default is 0.
+     * @returns
      */
     isPointInside(coord: Coordinates, epsilon?: number): boolean;
     /**
@@ -107,6 +114,7 @@ declare class Extent {
      *
      * @param extent - the extent to check
      * @param epsilon - error margin when comparing the extent bounds.
+     * @returns
      */
     isInside(extent: Extent, epsilon?: number): boolean;
     /**
@@ -125,14 +133,41 @@ declare class Extent {
      * Checks wheter this bounding box intersects with the given extent
      * parameter.
      * @param extent - the provided extent
+     * @returns
      */
     intersectsExtent(extent: Extent): boolean;
+    /**
+     * 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: Extent, extentB: Extent): boolean;
     /**
      * 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: Extent): Extent;
+    intersect(extent: Extent, target?: Extent): Extent;
     /**
      * Set west, east, south and north values.
      *
@@ -140,6 +175,7 @@ declare 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: number, v1: number, v2: number, v3: number): this;
     /**
@@ -148,24 +184,28 @@ declare 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: ArrayLike<number>, offset?: number): this;
     /**
      * Sets this extent `west`, `east`, `south` and `north` properties from an
      * `extent` bounds.
      * @param extent - the source extent
+     * @returns
      */
     setFromExtent(extent: ExtentLike): this;
     /**
      * Copies the passed extent to this extent.
      * @param extent - extent to copy.
+     * @returns
      */
     copy(extent: Extent): this;
     /**
      * Union this extent with the input extent.
      * @param extent - the extent to union.
+     * @returns
      */
-    union(extent: Extent): void;
+    union(extent: Extent): this;
     /**
      * expandByCoordinates perfoms the minimal extension
      * for the coordinates to belong to this Extent object
@@ -173,12 +213,11 @@ declare class Extent {
      */
     expandByCoordinates(coordinates: Coordinates): void;
     /**
-    * 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: number, sn: number): void;
     /**
      * Instance Extent with THREE.Box3.
@@ -189,11 +228,13 @@ declare class Extent {
      *
      * @param crs - Projection of extent to instancied.
      * @param box - Bounding-box
+     * @returns
      */
     static fromBox3(crs: ProjectionLike, box: Box3): Extent;
     /**
      * Return values of extent in string, separated by the separator input.
      * @param sep - string separator
+     * @returns
      */
     toString(sep?: string): string;
     /**

package/lib/Extent.js

@@ -69,6 +69,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);
@@ -80,6 +81,7 @@ 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, target = new Extent('EPSG:4326')) {
     CRS.isValid(crs);
@@ -120,6 +122,7 @@ class Extent {
    *
    * @param target - The target to store the center coordinate. If this not
    * provided a new coordinate will be created.
+   * @returns
    */
   center(target = new Coordinates(this.crs)) {
     this.planarDimensions(_dim);
@@ -135,6 +138,7 @@ class Extent {
    * 2D Cartesian coordinate system.
    *
    * @param target - optional target
+   * @returns
    */
   planarDimensions(target = new Vector2()) {
     // Calculte the dimensions for x and y
@@ -148,6 +152,7 @@ class Extent {
    * across the curved surface of the ellipsoid.
    *
    * @param target - optional target
+   * @returns
    */
   geodeticDimensions(target = new Vector2()) {
     // set 3 corners extent
@@ -168,6 +173,7 @@ class Extent {
    *  Spatial euclidean distance chord is calculated in an ellispoid space.
    *
    * @param target - optional target
+   * @returns
    */
   spatialEuclideanDimensions(target = new Vector2()) {
     // set 3 corners extent
@@ -188,6 +194,7 @@ class Extent {
    * @param coord - the given coordinates.
    * @param epsilon - error margin when comparing to the coordinates.
    * Default is 0.
+   * @returns
    */
   isPointInside(coord, epsilon = 0) {
     if (this.crs == coord.crs) {
@@ -205,6 +212,7 @@ class Extent {
    *
    * @param extent - the extent to check
    * @param epsilon - error margin when comparing the extent bounds.
+   * @returns
    */
   isInside(extent, epsilon = CRS.reasonableEpsilon(this.crs)) {
     extent.as(this.crs, _extent);
@@ -239,28 +247,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));
   }
 
   /**
@@ -270,6 +305,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) {
@@ -301,6 +337,7 @@ 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, offset = 0) {
     this.west = array[offset];
@@ -314,6 +351,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;
@@ -326,6 +364,7 @@ class Extent {
   /**
    * Copies the passed extent to this extent.
    * @param extent - extent to copy.
+   * @returns
    */
   copy(extent) {
     this.crs = extent.crs;
@@ -335,6 +374,7 @@ class Extent {
   /**
    * Union this extent with the input extent.
    * @param extent - the extent to union.
+   * @returns
    */
   union(extent) {
     if (extent.crs != this.crs) {
@@ -360,6 +400,7 @@ class Extent {
         this.north = north;
       }
     }
+    return this;
   }
 
   /**
@@ -373,12 +414,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;
@@ -403,6 +443,7 @@ class Extent {
    *
    * @param crs - Projection of extent to instancied.
    * @param box - Bounding-box
+   * @returns
    */
   static fromBox3(crs, box) {
     if (CRS.isGeocentric(crs)) {
@@ -425,6 +466,7 @@ class Extent {
   /**
    * Return values of extent in string, separated by the separator input.
    * @param sep - string separator
+   * @returns
    */
   toString(sep = '') {
     return `${this.east}${sep}${this.north}${sep}${this.west}${sep}${this.south}`;

package/lib/OrientationUtils.d.ts

@@ -20,16 +20,16 @@ interface PhotogrammetryAngles {
 type Attitude = Partial<EulerAngles> | Partial<PhotogrammetryAngles>;
 type QuaternionFunction = (coords: Coordinates, target?: Quaternion) => Quaternion;
 type ProjectionLike = ProjectionDefinition | string;
-type LCCProjection = {
+interface LCCProjection {
     long0: number;
     lat0: number;
-};
-type TMercProjection = {
+}
+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)`.

package/lib/OrientationUtils.js

@@ -263,6 +263,7 @@ export function quaternionFromEnuToLongLat(coordinates, target = new Quaternion(
  * identity (0,0,0,1).
  *
  * @param proj - the unimplemented projection (may be parsed using proj4)
+ * @param proj.projName - the name of the projection
  * @param coordinates - the origin of the local East North Up (ENU) frame
  * @param target - output Quaternion
  * @returns The target quaternion if coordinates is defined, otherwise, a

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itowns/geographic",
-  "version": "2.46.1-next.52",
+  "version": "2.46.1-next.54",
   "description": "Proj4-based three.js geodesy toolkit",
   "type": "module",
   "main": "lib/index.js",

package/src/Coordinates.ts

@@ -77,7 +77,7 @@ class Coordinates {
      * @param y - y or latitude value.
      * @param z - z or altitude value.
      */
-    constructor(crs: ProjectionLike, x: number = 0, y: number = 0, z: number = 0) {
+    constructor(crs: ProjectionLike, x = 0, y = 0, z = 0) {
         this.isCoordinates = true;
 
         CRS.isValid(crs);
@@ -118,6 +118,7 @@ class Coordinates {
     /**
      * Sets the Coordinate Reference System.
      * @param crs - Coordinate Reference System (e.g. 'EPSG:4978')
+     * @returns
      */
     setCrs(crs: ProjectionLike): this {
         CRS.isValid(crs);
@@ -131,8 +132,9 @@ class Coordinates {
      * @param x - x or longitude value.
      * @param y - y or latitude value.
      * @param z - z or altitude value.
+     * @returns
      */
-    setFromValues(x: number = 0, y: number = 0, z: number = 0): this {
+    setFromValues(x = 0, y = 0, z = 0): this {
         this.x = x;
         this.y = y;
         this.z = z;
@@ -149,8 +151,9 @@ class Coordinates {
      *
      * @param array - The source array.
      * @param offset - Optional offset into the array. Default is 0.
+     * @returns
      */
-    setFromArray(array: number[], offset: number = 0): this {
+    setFromArray(array: number[], offset = 0): this {
         return this.setFromValues(
             array[offset],
             array[offset + 1],
@@ -164,6 +167,7 @@ class Coordinates {
      * properties.
      *
      * @param v - The source object.
+     * @returns
      */
     setFromVector3(v: Vector3Like): this {
         return this.setFromValues(v.x, v.y, v.z);
@@ -172,6 +176,7 @@ class Coordinates {
     /**
      * Returns a new coordinate with the same `(x, y, z)` vector and crs as this
      * one.
+     * @returns
      */
     clone(): Coordinates {
         return new Coordinates(this.crs, this.x, this.y, this.z);
@@ -182,6 +187,7 @@ class Coordinates {
      * to this coordinate.
      *
      * @param src - The source coordinate to copy from.
+     * @returns
      */
     copy(src: CoordinatesLike): this {
         this.crs = src.crs;
@@ -206,6 +212,7 @@ class Coordinates {
 
     /**
      * The geodesic normal of the coordinate.
+     * @returns
      */
     get geodesicNormal() {
         if (this._normalNeedsUpdate) {
@@ -246,7 +253,7 @@ class Coordinates {
      * @returns An array [x, y, z], or copies x, y and z into the provided
      * array.
      */
-    toArray(array: number[] = [], offset: number = 0): ArrayLike<number> {
+    toArray(array: number[] = [], offset = 0): ArrayLike<number> {
         return Vector3.prototype.toArray.call(this, array, offset);
     }
 
@@ -254,6 +261,8 @@ class Coordinates {
      * Computes the planar distance from this coordinates to `coord`.
      * **Planar distance** is the straight-line euclidean distance calculated in
      * a 2D cartesian coordinate system.
+     * @param coord
+     * @returns
      */
     planarDistanceTo(coord: Coordinates): number {
         this.toVector3(v0).setZ(0);
@@ -265,6 +274,8 @@ class Coordinates {
      * 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.
+     * @param coord
+     * @returns
      */
     geodeticDistanceTo(coord: Coordinates): number {
         this.as('EPSG:4326', coord0);
@@ -290,6 +301,7 @@ class Coordinates {
      * by `mat`, and divides by perspective.
      *
      * @param mat - The matrix.
+     * @returns
      */
     applyMatrix4(mat: Matrix4): this {
         Vector3.prototype.applyMatrix4.call(this, mat);

package/src/Crs.ts

@@ -2,12 +2,12 @@ import proj4 from 'proj4';
 import type { Converter } from 'proj4';
 import type { ProjectionDefinition } from 'proj4/dist/lib/defs';
 
-type proj4Def = {
-    type: string,
-    PROJCS: proj4Def,
-    unknown?: string,
-    (alias: string): proj4Def & { name: string },
-    title: string,
+interface proj4Def {
+    type: string;
+    PROJCS: proj4Def;
+    unknown?: string;
+    (alias: string): proj4Def & { name: string };
+    title: string;
 }
 
 proj4.defs('EPSG:4978', '+proj=geocent +datum=WGS84 +units=m +no_defs');
@@ -74,6 +74,7 @@ export const UNIT = {
  * @internal
  *
  * @param crs - The CRS to test.
+ * @returns
  */
 export function is4326(crs: ProjectionLike) {
     return crs === 'EPSG:4326';
@@ -114,7 +115,8 @@ export function getUnit(crs: ProjectionLike) {
  * Asserts that the CRS is using metric units.
  *
  * @param crs - The CRS to check.
- * @throws {@link Error} if the CRS is not valid.
+ * @returns
+ * @throws {Error} if the CRS is not valid.
  */
 export function isMetricUnit(crs: ProjectionLike) {
     return getUnit(crs) === UNIT.METER;
@@ -124,7 +126,8 @@ export function isMetricUnit(crs: ProjectionLike) {
  * Asserts that the CRS is geographic.
  *
  * @param crs - The CRS to check.
- * @throws {@link Error} if the CRS is not valid.
+ * @returns
+ * @throws {Error} if the CRS is not valid.
  */
 export function isGeographic(crs: ProjectionLike) {
     return getUnit(crs) === UNIT.DEGREE;
@@ -147,7 +150,7 @@ export function isGeocentric(crs: ProjectionLike) {
  * includes an unit.
  *
  * @param crs - The CRS to test.
- * @throws {@link Error} if the crs is not valid.
+ * @throws {Error} if the crs is not valid.
  */
 export function isValid(crs: ProjectionLike) {
     const proj = proj4.defs(crs);

package/src/Ellipsoid.ts

@@ -47,6 +47,7 @@ class Ellipsoid {
      * @param cartesian - The given cartesian coordinate.
      * @param target - An object to store this vector to. If this is not
      * specified, a new vector will be created.
+     * @returns
      */
     geodeticSurfaceNormal(
         cartesian: Coordinates,
@@ -62,6 +63,7 @@ class Ellipsoid {
      * @param coordCarto - The given geographic coordinate.
      * @param target - An object to store this vector to. If this is not
      * specified, a new vector will be created.
+     * @returns
      */
     geodeticSurfaceNormalCartographic(
         coordCarto: Coordinates,
@@ -82,6 +84,7 @@ class Ellipsoid {
      * properties.
      *
      * @param size - The source vector.
+     * @returns
      */
     setSize(size: Vector3Like): this {
         this.size.set(size.x, size.y, size.z);
@@ -146,7 +149,7 @@ class Ellipsoid {
 
         const phi = Math.atan(
             (position.z * (1 - f) + e * a * sinu * sinu * sinu) /
-                ((1 - f) * (rsqXY - e * a * cosu * cosu * cosu)));
+            ((1 - f) * (rsqXY - e * a * cosu * cosu * cosu)));
 
         const h = (rsqXY * Math.cos(phi)) +
             position.z * Math.sin(phi) -
@@ -202,7 +205,7 @@ class Ellipsoid {
             return false;
         }
 
-        let t = 0;
+        let t;
         if (t1 <= EPSILON) { t = t2; } else
             if (t2 <= EPSILON) { t = t1; } else { t = (t1 < t2) ? t1 : t2; }
 
@@ -236,7 +239,7 @@ class Ellipsoid {
 
         const distRad = Math.acos(
             Math.sin(latitude1) * Math.sin(latitude2) +
-                Math.cos(latitude1) * Math.cos(latitude2) * Math.cos(longitude2 - longitude1));
+            Math.cos(latitude1) * Math.cos(latitude2) * Math.cos(longitude2 - longitude1));
 
         const e = this.eccentricity;
         const latMoy = (latitude1 + latitude2) * 0.5;

package/src/Extent.ts

@@ -100,6 +100,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);
@@ -111,6 +112,7 @@ 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: string, target: Extent = new Extent('EPSG:4326')) {
         CRS.isValid(crs);
@@ -155,6 +157,7 @@ class Extent {
      *
      * @param target - The target to store the center coordinate. If this not
      * provided a new coordinate will be created.
+     * @returns
      */
     center(target = new Coordinates(this.crs)) {
         this.planarDimensions(_dim);
@@ -172,6 +175,7 @@ class Extent {
      * 2D Cartesian coordinate system.
      *
      * @param target - optional target
+     * @returns
      */
     planarDimensions(target = new Vector2()) {
         // Calculte the dimensions for x and y
@@ -185,6 +189,7 @@ class Extent {
      * across the curved surface of the ellipsoid.
      *
      * @param target - optional target
+     * @returns
      */
     geodeticDimensions(target = new Vector2()) {
         // set 3 corners extent
@@ -209,6 +214,7 @@ class Extent {
      *  Spatial euclidean distance chord is calculated in an ellispoid space.
      *
      * @param target - optional target
+     * @returns
      */
     spatialEuclideanDimensions(target = new Vector2()) {
         // set 3 corners extent
@@ -233,6 +239,7 @@ class Extent {
      * @param coord - the given coordinates.
      * @param epsilon - error margin when comparing to the coordinates.
      * Default is 0.
+     * @returns
      */
     isPointInside(coord: Coordinates, epsilon = 0) {
         if (this.crs == coord.crs) {
@@ -243,9 +250,9 @@ class Extent {
 
         // TODO this ignores altitude
         return _c.x <= this.east + epsilon &&
-               _c.x >= this.west - epsilon &&
-               _c.y <= this.north + epsilon &&
-               _c.y >= this.south - epsilon;
+            _c.x >= this.west - epsilon &&
+            _c.y <= this.north + epsilon &&
+            _c.y >= this.south - epsilon;
     }
 
     /**
@@ -253,13 +260,14 @@ class Extent {
      *
      * @param extent - the extent to check
      * @param epsilon - error margin when comparing the extent bounds.
+     * @returns
      */
     isInside(extent: 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;
+            _extent.west - this.west <= epsilon &&
+            this.north - _extent.north <= epsilon &&
+            _extent.south - this.south <= epsilon;
     }
 
     /**
@@ -294,13 +302,27 @@ class Extent {
      * Checks wheter this bounding box intersects with the given extent
      * parameter.
      * @param extent - the provided extent
+     * @returns
      */
     intersectsExtent(extent: 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: Extent, extentB: Extent) {
-        // 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 ||
@@ -310,16 +332,29 @@ class Extent {
 
     /**
      * 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: Extent) {
+    intersect(extent: 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,
+
+        return target.set(
             Math.max(this.west, extent.west),
             Math.min(this.east, extent.east),
             Math.max(this.south, extent.south),
@@ -333,6 +368,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: number, v1: number, v2: number, v3: number): this {
         if (v0 == undefined) {
@@ -370,8 +406,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: ArrayLike<number>, offset: number = 0): this {
+    setFromArray(array: ArrayLike<number>, offset = 0): this {
         this.west = array[offset];
         this.east = array[offset + 1];
         this.south = array[offset + 2];
@@ -383,6 +420,7 @@ class Extent {
      * Sets this extent `west`, `east`, `south` and `north` properties from an
      * `extent` bounds.
      * @param extent - the source extent
+     * @returns
      */
     setFromExtent(extent: ExtentLike): this {
         this.west = extent.west;
@@ -395,6 +433,7 @@ class Extent {
     /**
      * Copies the passed extent to this extent.
      * @param extent - extent to copy.
+     * @returns
      */
     copy(extent: Extent): this {
         this.crs = extent.crs;
@@ -404,6 +443,7 @@ class Extent {
     /**
      * Union this extent with the input extent.
      * @param extent - the extent to union.
+     * @returns
      */
     union(extent: Extent) {
         if (extent.crs != this.crs) {
@@ -432,6 +472,8 @@ class Extent {
                 this.north = north;
             }
         }
+
+        return this;
     }
 
     /**
@@ -445,12 +487,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: number, sn: number) {
         if (we < this.west) {
             this.west = we;
@@ -475,6 +516,7 @@ class Extent {
      *
      * @param crs - Projection of extent to instancied.
      * @param box - Bounding-box
+     * @returns
      */
     static fromBox3(crs: ProjectionLike, box: Box3) {
         if (CRS.isGeocentric(crs)) {
@@ -499,6 +541,7 @@ class Extent {
     /**
      * Return values of extent in string, separated by the separator input.
      * @param sep - string separator
+     * @returns
      */
     toString(sep = '') {
         return `${this.east}${sep}${this.north}${sep}${this.west}${sep}${this.south}`;

package/src/OrientationUtils.ts

@@ -34,8 +34,8 @@ type QuaternionFunction = (coords: Coordinates, target?: Quaternion) => Quaterni
 
 // To unify with Crs.js ProjectionLike type ?
 type ProjectionLike = ProjectionDefinition | string;
-type LCCProjection = { long0: number, lat0: number };
-type TMercProjection = { a: number, b: number, e?: number, long0: number };
+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)
@@ -367,6 +367,7 @@ export function quaternionUnimplemented(
  * identity (0,0,0,1).
  *
  * @param proj - the unimplemented projection (may be parsed using proj4)
+ * @param proj.projName - the name of the projection
  * @param coordinates - the origin of the local East North Up (ENU) frame
  * @param target - output Quaternion
  * @returns The target quaternion if coordinates is defined, otherwise, a