@cesium/engine 24.0.0 → 25.0.0

package/Source/Core/ReferenceFrame.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 /**
  * Constants for identifying well-known reference frames.
  *
@@ -20,4 +22,7 @@ const ReferenceFrame = {
    */
   INERTIAL: 1,
 };
-export default Object.freeze(ReferenceFrame);
+
+Object.freeze(ReferenceFrame);
+
+export default ReferenceFrame;

package/Source/Core/RequestScheduler.js

@@ -7,6 +7,7 @@ import Heap from "./Heap.js";
 import isBlobUri from "./isBlobUri.js";
 import isDataUri from "./isDataUri.js";
 import RequestState from "./RequestState.js";
+import RuntimeError from "./RuntimeError.js";
 
 function sortRequests(a, b) {
   return a.priority - b.priority;
@@ -219,6 +220,7 @@ function getRequestReceivedFunction(request) {
 function getRequestFailedFunction(request) {
   return function (error) {
     if (request.state === RequestState.CANCELLED) {
+      // The error is handled in cancelRequest()
       // If the data request comes back but the request is cancelled, ignore it.
       return;
     }
@@ -249,12 +251,15 @@ function cancelRequest(request) {
   const active = request.state === RequestState.ACTIVE;
   request.state = RequestState.CANCELLED;
   ++statistics.numberOfCancelledRequests;
-  // check that deferred has not been cleared since cancelRequest can be called
-  // on a finished request, e.g. by clearForSpecs during tests
+  // If the request has resolved, request.deferred should now be undefined
+  // If it's in progress, fail the promise immediately and discard it, but ensure the failure is handled so the failure does not bubble up, e.g. by clearForSpecs during tests
   if (defined(request.deferred)) {
     const deferred = request.deferred;
+    deferred.promise.catch(() => {
+      // noop fallback handler
+    });
     request.deferred = undefined;
-    deferred.reject();
+    deferred.reject(new RuntimeError(`Request cancelled: "${request.url}"`));
   }
 
   if (active) {

package/Source/Core/RequestState.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 /**
  * State of the request.
  *
@@ -52,4 +54,7 @@ const RequestState = {
    */
   FAILED: 5,
 };
-export default Object.freeze(RequestState);
+
+Object.freeze(RequestState);
+
+export default RequestState;

package/Source/Core/RequestType.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 /**
  * An enum identifying the type of request. Used for finer grained logging and priority sorting.
  *
@@ -36,4 +38,7 @@ const RequestType = {
    */
   OTHER: 3,
 };
-export default Object.freeze(RequestType);
+
+Object.freeze(RequestType);
+
+export default RequestType;

package/Source/Core/ScreenSpaceEventType.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 /**
  * This enumerated type is for classifying mouse events: down, up, click, double click, move and move while a button is held down.
  *
@@ -124,4 +126,7 @@ const ScreenSpaceEventType = {
    */
   PINCH_MOVE: 19,
 };
-export default Object.freeze(ScreenSpaceEventType);
+
+Object.freeze(ScreenSpaceEventType);
+
+export default ScreenSpaceEventType;

package/Source/Core/TerrainQuantization.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 /**
  * This enumerated type is used to determine how the vertices of the terrain mesh are compressed.
  *
@@ -22,4 +24,7 @@ const TerrainQuantization = {
    */
   BITS12: 1,
 };
-export default Object.freeze(TerrainQuantization);
+
+Object.freeze(TerrainQuantization);
+
+export default TerrainQuantization;

package/Source/Core/TilingScheme.js

@@ -1,5 +1,13 @@
+// @ts-check
+
 import DeveloperError from "./DeveloperError.js";
 
+/** @import Cartesian2 from "./Cartesian2.js"; */
+/** @import Cartographic from "./Cartographic.js"; */
+/** @import Ellipsoid from "./Ellipsoid.js"; */
+/** @import MapProjection from "./MapProjection.js"; */
+/** @import Rectangle from "./Rectangle.js"; */
+
 /**
  * A tiling scheme for geometry or imagery on the surface of an ellipsoid.  At level-of-detail zero,
  * the coarsest, least-detailed level, the number of tiles is configurable.
@@ -7,126 +15,120 @@ import DeveloperError from "./DeveloperError.js";
  * At level of detail two, each of the level one tiles has four children, two in each direction.
  * This continues for as many levels as are present in the geometry or imagery source.
  *
- * @alias TilingScheme
- * @constructor
+ * @interface
  *
  * @see WebMercatorTilingScheme
  * @see GeographicTilingScheme
  */
-function TilingScheme(options) {
-  //>>includeStart('debug', pragmas.debug);
-  throw new DeveloperError(
-    "This type should not be instantiated directly.  Instead, use WebMercatorTilingScheme or GeographicTilingScheme.",
-  );
-  //>>includeEnd('debug');
-}
-
-Object.defineProperties(TilingScheme.prototype, {
+class TilingScheme {
   /**
    * Gets the ellipsoid that is tiled by the tiling scheme.
-   * @memberof TilingScheme.prototype
    * @type {Ellipsoid}
    */
-  ellipsoid: {
-    get: DeveloperError.throwInstantiationError,
-  },
+  ellipsoid;
 
   /**
    * Gets the rectangle, in radians, covered by this tiling scheme.
-   * @memberof TilingScheme.prototype
    * @type {Rectangle}
    */
-  rectangle: {
-    get: DeveloperError.throwInstantiationError,
-  },
+  rectangle;
 
   /**
    * Gets the map projection used by the tiling scheme.
-   * @memberof TilingScheme.prototype
    * @type {MapProjection}
    */
-  projection: {
-    get: DeveloperError.throwInstantiationError,
-  },
-});
+  projection;
 
-/**
- * Gets the total number of tiles in the X direction at a specified level-of-detail.
- * @function
- *
- * @param {number} level The level-of-detail.
- * @returns {number} The number of tiles in the X direction at the given level.
- */
-TilingScheme.prototype.getNumberOfXTilesAtLevel =
-  DeveloperError.throwInstantiationError;
+  /**
+   * @param {object} options
+   */
+  constructor(options) {
+    //>>includeStart('debug', pragmas.debug);
+    throw new DeveloperError(
+      "This type should not be instantiated directly.  Instead, use WebMercatorTilingScheme or GeographicTilingScheme.",
+    );
+    //>>includeEnd('debug');
+  }
 
-/**
- * Gets the total number of tiles in the Y direction at a specified level-of-detail.
- * @function
- *
- * @param {number} level The level-of-detail.
- * @returns {number} The number of tiles in the Y direction at the given level.
- */
-TilingScheme.prototype.getNumberOfYTilesAtLevel =
-  DeveloperError.throwInstantiationError;
+  /**
+   * Gets the total number of tiles in the X direction at a specified level-of-detail.
+   *
+   * @param {number} level The level-of-detail.
+   * @returns {number} The number of tiles in the X direction at the given level.
+   */
+  getNumberOfXTilesAtLevel(level) {
+    DeveloperError.throwInstantiationError();
+  }
 
-/**
- * Transforms a rectangle specified in geodetic radians to the native coordinate system
- * of this tiling scheme.
- * @function
- *
- * @param {Rectangle} rectangle The rectangle to transform.
- * @param {Rectangle} [result] The instance to which to copy the result, or undefined if a new instance
- *        should be created.
- * @returns {Rectangle} The specified 'result', or a new object containing the native rectangle if 'result'
- *          is undefined.
- */
-TilingScheme.prototype.rectangleToNativeRectangle =
-  DeveloperError.throwInstantiationError;
+  /**
+   * Gets the total number of tiles in the Y direction at a specified level-of-detail.
+   *
+   * @param {number} level The level-of-detail.
+   * @returns {number} The number of tiles in the Y direction at the given level.
+   */
+  getNumberOfYTilesAtLevel(level) {
+    DeveloperError.throwInstantiationError();
+  }
 
-/**
- * Converts tile x, y coordinates and level to a rectangle expressed in the native coordinates
- * of the tiling scheme.
- * @function
- *
- * @param {number} x The integer x coordinate of the tile.
- * @param {number} y The integer y coordinate of the tile.
- * @param {number} level The tile level-of-detail.  Zero is the least detailed.
- * @param {object} [result] The instance to which to copy the result, or undefined if a new instance
- *        should be created.
- * @returns {Rectangle} The specified 'result', or a new object containing the rectangle
- *          if 'result' is undefined.
- */
-TilingScheme.prototype.tileXYToNativeRectangle =
-  DeveloperError.throwInstantiationError;
+  /**
+   * Transforms a rectangle specified in geodetic radians to the native coordinate system
+   * of this tiling scheme.
+   *
+   * @param {Rectangle} rectangle The rectangle to transform.
+   * @param {Rectangle} [result] The instance to which to copy the result, or undefined if a new instance
+   *        should be created.
+   * @returns {Rectangle} The specified 'result', or a new object containing the native rectangle if 'result'
+   *          is undefined.
+   */
+  rectangleToNativeRectangle(rectangle, result) {
+    DeveloperError.throwInstantiationError();
+  }
 
-/**
- * Converts tile x, y coordinates and level to a cartographic rectangle in radians.
- * @function
- *
- * @param {number} x The integer x coordinate of the tile.
- * @param {number} y The integer y coordinate of the tile.
- * @param {number} level The tile level-of-detail.  Zero is the least detailed.
- * @param {object} [result] The instance to which to copy the result, or undefined if a new instance
- *        should be created.
- * @returns {Rectangle} The specified 'result', or a new object containing the rectangle
- *          if 'result' is undefined.
- */
-TilingScheme.prototype.tileXYToRectangle =
-  DeveloperError.throwInstantiationError;
+  /**
+   * Converts tile x, y coordinates and level to a rectangle expressed in the native coordinates
+   * of the tiling scheme.
+   *
+   * @param {number} x The integer x coordinate of the tile.
+   * @param {number} y The integer y coordinate of the tile.
+   * @param {number} level The tile level-of-detail.  Zero is the least detailed.
+   * @param {Rectangle} [result] The instance to which to copy the result, or undefined if a new instance
+   *        should be created.
+   * @returns {Rectangle} The specified 'result', or a new object containing the rectangle
+   *          if 'result' is undefined.
+   */
+  tileXYToNativeRectangle(x, y, level, result) {
+    DeveloperError.throwInstantiationError();
+  }
+
+  /**
+   * Converts tile x, y coordinates and level to a cartographic rectangle in radians.
+   *
+   * @param {number} x The integer x coordinate of the tile.
+   * @param {number} y The integer y coordinate of the tile.
+   * @param {number} level The tile level-of-detail.  Zero is the least detailed.
+   * @param {Rectangle} [result] The instance to which to copy the result, or undefined if a new instance
+   *        should be created.
+   * @returns {Rectangle} The specified 'result', or a new object containing the rectangle
+   *          if 'result' is undefined.
+   */
+  tileXYToRectangle(x, y, level, result) {
+    DeveloperError.throwInstantiationError();
+  }
+
+  /**
+   * Calculates the tile x, y coordinates of the tile containing
+   * a given cartographic position.
+   *
+   * @param {Cartographic} position The position.
+   * @param {number} level The tile level-of-detail.  Zero is the least detailed.
+   * @param {Cartesian2} [result] The instance to which to copy the result, or undefined if a new instance
+   *        should be created.
+   * @returns {Cartesian2} The specified 'result', or a new object containing the tile x, y coordinates
+   *          if 'result' is undefined.
+   */
+  positionToTileXY(position, level, result) {
+    DeveloperError.throwInstantiationError();
+  }
+}
 
-/**
- * Calculates the tile x, y coordinates of the tile containing
- * a given cartographic position.
- * @function
- *
- * @param {Cartographic} position The position.
- * @param {number} level The tile level-of-detail.  Zero is the least detailed.
- * @param {Cartesian2} [result] The instance to which to copy the result, or undefined if a new instance
- *        should be created.
- * @returns {Cartesian2} The specified 'result', or a new object containing the tile x, y coordinates
- *          if 'result' is undefined.
- */
-TilingScheme.prototype.positionToTileXY =
-  DeveloperError.throwInstantiationError;
 export default TilingScheme;

package/Source/Core/TimeConstants.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 /**
  * Constants for time conversions like those done by {@link JulianDate}.
  *
@@ -80,4 +82,7 @@ const TimeConstants = {
    */
   MODIFIED_JULIAN_DATE_DIFFERENCE: 2400000.5,
 };
-export default Object.freeze(TimeConstants);
+
+Object.freeze(TimeConstants);
+
+export default TimeConstants;

package/Source/Core/TimeStandard.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 /**
  * Provides the type of time standards which JulianDate can take as input.
  *
@@ -27,4 +29,7 @@ const TimeStandard = {
    */
   TAI: 1,
 };
-export default Object.freeze(TimeStandard);
+
+Object.freeze(TimeStandard);
+
+export default TimeStandard;

package/Source/Core/TrackingReferenceFrame.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 /**
  * Constants for identifying well-known tracking reference frames.
  *
@@ -42,4 +44,7 @@ const TrackingReferenceFrame = {
    */
   VELOCITY: 3,
 };
-export default Object.freeze(TrackingReferenceFrame);
+
+Object.freeze(TrackingReferenceFrame);
+
+export default TrackingReferenceFrame;

package/Source/Core/Visibility.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 /**
  * This enumerated type is used in determining to what extent an object, the occludee,
  * is visible during horizon culling. An occluder may fully block an occludee, in which case
@@ -31,4 +33,7 @@ const Visibility = {
    */
   FULL: 1,
 };
-export default Object.freeze(Visibility);
+
+Object.freeze(Visibility);
+
+export default Visibility;

package/Source/Core/VulkanConstants.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 /**
  * Enum containing Vulkan Constant values by name.
  *
@@ -283,4 +285,7 @@ const VulkanConstants = {
   VK_FORMAT_G16_B16R16_2PLANE_422_UNORM_KHR: 1000156032,
   VK_FORMAT_G16_B16_R16_3PLANE_444_UNORM_KHR: 1000156033,
 };
-export default Object.freeze(VulkanConstants);
+
+Object.freeze(VulkanConstants);
+
+export default VulkanConstants;

package/Source/Core/WebGLConstants.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 /**
  * Enum containing WebGL Constant values by name.
  * for use without an active WebGL context, or in cases where certain constants are unavailable using the WebGL context
@@ -611,4 +613,7 @@ const WebGLConstants = {
   // Extensions
   MAX_TEXTURE_MAX_ANISOTROPY_EXT: 0x84ff,
 };
-export default Object.freeze(WebGLConstants);
+
+Object.freeze(WebGLConstants);
+
+export default WebGLConstants;