@cesium/engine 24.0.0 → 25.0.0

package/Source/Core/WebMercatorProjection.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import Cartesian3 from "./Cartesian3.js";
 import Cartographic from "./Cartographic.js";
 import defined from "./defined.js";
@@ -5,70 +7,129 @@ import DeveloperError from "./DeveloperError.js";
 import Ellipsoid from "./Ellipsoid.js";
 import CesiumMath from "./Math.js";
 
+/** @import MapProjection from "./MapProjection.js"; */
+
 /**
  * The map projection used by Google Maps, Bing Maps, and most of ArcGIS Online, EPSG:3857.  This
  * projection use longitude and latitude expressed with the WGS84 and transforms them to Mercator using
  * the spherical (rather than ellipsoidal) equations.
  *
- * @alias WebMercatorProjection
- * @constructor
- *
- * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid.
- *
  * @see GeographicProjection
+ *
+ * @implements MapProjection
  */
-function WebMercatorProjection(ellipsoid) {
-  this._ellipsoid = ellipsoid ?? Ellipsoid.WGS84;
-  this._semimajorAxis = this._ellipsoid.maximumRadius;
-  this._oneOverSemimajorAxis = 1.0 / this._semimajorAxis;
-}
+class WebMercatorProjection {
+  /**
+   * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid.
+   */
+  constructor(ellipsoid) {
+    this._ellipsoid = ellipsoid ?? Ellipsoid.WGS84;
+    this._semimajorAxis = this._ellipsoid.maximumRadius;
+    this._oneOverSemimajorAxis = 1.0 / this._semimajorAxis;
+  }
 
-Object.defineProperties(WebMercatorProjection.prototype, {
   /**
    * Gets the {@link Ellipsoid}.
    *
-   * @memberof WebMercatorProjection.prototype
-   *
    * @type {Ellipsoid}
    * @readonly
    */
-  ellipsoid: {
-    get: function () {
-      return this._ellipsoid;
-    },
-  },
-});
+  get ellipsoid() {
+    return this._ellipsoid;
+  }
 
-/**
- * Converts a Mercator angle, in the range -PI to PI, to a geodetic latitude
- * in the range -PI/2 to PI/2.
- *
- * @param {number} mercatorAngle The angle to convert.
- * @returns {number} The geodetic latitude in radians.
- */
-WebMercatorProjection.mercatorAngleToGeodeticLatitude = function (
-  mercatorAngle,
-) {
-  return CesiumMath.PI_OVER_TWO - 2.0 * Math.atan(Math.exp(-mercatorAngle));
-};
+  /**
+   * Converts a Mercator angle, in the range -PI to PI, to a geodetic latitude
+   * in the range -PI/2 to PI/2.
+   *
+   * @param {number} mercatorAngle The angle to convert.
+   * @returns {number} The geodetic latitude in radians.
+   */
+  static mercatorAngleToGeodeticLatitude(mercatorAngle) {
+    return CesiumMath.PI_OVER_TWO - 2.0 * Math.atan(Math.exp(-mercatorAngle));
+  }
 
-/**
- * Converts a geodetic latitude in radians, in the range -PI/2 to PI/2, to a Mercator
- * angle in the range -PI to PI.
- *
- * @param {number} latitude The geodetic latitude in radians.
- * @returns {number} The Mercator angle.
- */
-WebMercatorProjection.geodeticLatitudeToMercatorAngle = function (latitude) {
-  // Clamp the latitude coordinate to the valid Mercator bounds.
-  if (latitude > WebMercatorProjection.MaximumLatitude) {
-    latitude = WebMercatorProjection.MaximumLatitude;
-  } else if (latitude < -WebMercatorProjection.MaximumLatitude) {
-    latitude = -WebMercatorProjection.MaximumLatitude;
+  /**
+   * Converts a geodetic latitude in radians, in the range -PI/2 to PI/2, to a Mercator
+   * angle in the range -PI to PI.
+   *
+   * @param {number} latitude The geodetic latitude in radians.
+   * @returns {number} The Mercator angle.
+   */
+  static geodeticLatitudeToMercatorAngle(latitude) {
+    // Clamp the latitude coordinate to the valid Mercator bounds.
+    if (latitude > WebMercatorProjection.MaximumLatitude) {
+      latitude = WebMercatorProjection.MaximumLatitude;
+    } else if (latitude < -WebMercatorProjection.MaximumLatitude) {
+      latitude = -WebMercatorProjection.MaximumLatitude;
+    }
+    const sinLatitude = Math.sin(latitude);
+    return 0.5 * Math.log((1.0 + sinLatitude) / (1.0 - sinLatitude));
   }
-  const sinLatitude = Math.sin(latitude);
-  return 0.5 * Math.log((1.0 + sinLatitude) / (1.0 - sinLatitude));
-};
+
+  /**
+   * Converts geodetic ellipsoid coordinates, in radians, to the equivalent Web Mercator
+   * X, Y, Z coordinates expressed in meters and returned in a {@link Cartesian3}.  The height
+   * is copied unmodified to the Z coordinate.
+   *
+   * @param {Cartographic} cartographic The cartographic coordinates in radians.
+   * @param {Cartesian3} [result] The instance to which to copy the result, or undefined if a
+   *        new instance should be created.
+   * @returns {Cartesian3} The equivalent web mercator X, Y, Z coordinates, in meters.
+   */
+  project(cartographic, result) {
+    const semimajorAxis = this._semimajorAxis;
+    const x = cartographic.longitude * semimajorAxis;
+    const y =
+      WebMercatorProjection.geodeticLatitudeToMercatorAngle(
+        cartographic.latitude,
+      ) * semimajorAxis;
+    const z = cartographic.height;
+
+    if (!defined(result)) {
+      return new Cartesian3(x, y, z);
+    }
+
+    result.x = x;
+    result.y = y;
+    result.z = z;
+    return result;
+  }
+
+  /**
+   * Converts Web Mercator X, Y coordinates, expressed in meters, to a {@link Cartographic}
+   * containing geodetic ellipsoid coordinates.  The Z coordinate is copied unmodified to the
+   * height.
+   *
+   * @param {Cartesian3} cartesian The web mercator Cartesian position to unrproject with height (z) in meters.
+   * @param {Cartographic} [result] The instance to which to copy the result, or undefined if a
+   *        new instance should be created.
+   * @returns {Cartographic} The equivalent cartographic coordinates.
+   */
+  unproject(cartesian, result) {
+    //>>includeStart('debug', pragmas.debug);
+    if (!defined(cartesian)) {
+      throw new DeveloperError("cartesian is required");
+    }
+    //>>includeEnd('debug');
+
+    const oneOverEarthSemimajorAxis = this._oneOverSemimajorAxis;
+    const longitude = cartesian.x * oneOverEarthSemimajorAxis;
+    const latitude = WebMercatorProjection.mercatorAngleToGeodeticLatitude(
+      cartesian.y * oneOverEarthSemimajorAxis,
+    );
+    const height = cartesian.z;
+
+    if (!defined(result)) {
+      return new Cartographic(longitude, latitude, height);
+    }
+
+    result.longitude = longitude;
+    result.latitude = latitude;
+    result.height = height;
+    return result;
+  }
+}
 
 /**
  * The maximum latitude (both North and South) supported by a Web Mercator
@@ -87,66 +148,4 @@ WebMercatorProjection.geodeticLatitudeToMercatorAngle = function (latitude) {
 WebMercatorProjection.MaximumLatitude =
   WebMercatorProjection.mercatorAngleToGeodeticLatitude(Math.PI);
 
-/**
- * Converts geodetic ellipsoid coordinates, in radians, to the equivalent Web Mercator
- * X, Y, Z coordinates expressed in meters and returned in a {@link Cartesian3}.  The height
- * is copied unmodified to the Z coordinate.
- *
- * @param {Cartographic} cartographic The cartographic coordinates in radians.
- * @param {Cartesian3} [result] The instance to which to copy the result, or undefined if a
- *        new instance should be created.
- * @returns {Cartesian3} The equivalent web mercator X, Y, Z coordinates, in meters.
- */
-WebMercatorProjection.prototype.project = function (cartographic, result) {
-  const semimajorAxis = this._semimajorAxis;
-  const x = cartographic.longitude * semimajorAxis;
-  const y =
-    WebMercatorProjection.geodeticLatitudeToMercatorAngle(
-      cartographic.latitude,
-    ) * semimajorAxis;
-  const z = cartographic.height;
-
-  if (!defined(result)) {
-    return new Cartesian3(x, y, z);
-  }
-
-  result.x = x;
-  result.y = y;
-  result.z = z;
-  return result;
-};
-
-/**
- * Converts Web Mercator X, Y coordinates, expressed in meters, to a {@link Cartographic}
- * containing geodetic ellipsoid coordinates.  The Z coordinate is copied unmodified to the
- * height.
- *
- * @param {Cartesian3} cartesian The web mercator Cartesian position to unrproject with height (z) in meters.
- * @param {Cartographic} [result] The instance to which to copy the result, or undefined if a
- *        new instance should be created.
- * @returns {Cartographic} The equivalent cartographic coordinates.
- */
-WebMercatorProjection.prototype.unproject = function (cartesian, result) {
-  //>>includeStart('debug', pragmas.debug);
-  if (!defined(cartesian)) {
-    throw new DeveloperError("cartesian is required");
-  }
-  //>>includeEnd('debug');
-
-  const oneOverEarthSemimajorAxis = this._oneOverSemimajorAxis;
-  const longitude = cartesian.x * oneOverEarthSemimajorAxis;
-  const latitude = WebMercatorProjection.mercatorAngleToGeodeticLatitude(
-    cartesian.y * oneOverEarthSemimajorAxis,
-  );
-  const height = cartesian.z;
-
-  if (!defined(result)) {
-    return new Cartographic(longitude, latitude, height);
-  }
-
-  result.longitude = longitude;
-  result.latitude = latitude;
-  result.height = height;
-  return result;
-};
 export default WebMercatorProjection;