@cesium/engine 24.0.0 → 26.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/Resource.js

@@ -173,7 +173,7 @@ function defaultClone(value, defaultValue) {
  *
  * @returns {Resource} If resource is a String, a Resource constructed with the url and options. Otherwise the resource parameter is returned.
  *
- * @private
+ * @ignore
  */
 Resource.createIfNeeded = function (resource) {
   if (resource instanceof Resource) {

package/Source/Core/ScreenSpaceEventHandler.js

@@ -22,21 +22,31 @@ function getPosition(screenSpaceEventHandler, event, result) {
   return result;
 }
 
-function getInputEventKey(type, modifier) {
-  let key = type;
-  if (defined(modifier)) {
-    key += `+${modifier}`;
+function getInputEventKey(type, modifiers) {
+  if (!defined(modifiers)) {
+    return `${type}`;
   }
-  return key;
+
+  const modifierList = Array.isArray(modifiers)
+    ? modifiers.toSorted()
+    : [modifiers];
+  return `${type}+${modifierList.join("+")}`;
 }
 
-function getModifier(event) {
+function getModifiers(event) {
+  const modifiers = [];
   if (event.shiftKey) {
-    return KeyboardEventModifier.SHIFT;
-  } else if (event.ctrlKey) {
-    return KeyboardEventModifier.CTRL;
-  } else if (event.altKey) {
-    return KeyboardEventModifier.ALT;
+    modifiers.push(KeyboardEventModifier.SHIFT);
+  }
+  if (event.ctrlKey) {
+    modifiers.push(KeyboardEventModifier.CTRL);
+  }
+  if (event.altKey) {
+    modifiers.push(KeyboardEventModifier.ALT);
+  }
+
+  if (modifiers.length) {
+    return modifiers;
   }
 
   return undefined;
@@ -223,11 +233,11 @@ function handleMouseDown(screenSpaceEventHandler, event) {
   Cartesian2.clone(position, screenSpaceEventHandler._primaryStartPosition);
   Cartesian2.clone(position, screenSpaceEventHandler._primaryPreviousPosition);
 
-  const modifier = getModifier(event);
+  const modifiers = getModifiers(event);
 
   const action = screenSpaceEventHandler.getInputAction(
     screenSpaceEventType,
-    modifier,
+    modifiers,
   );
 
   if (defined(action)) {
@@ -252,15 +262,15 @@ function cancelMouseEvent(
   clickScreenSpaceEventType,
   event,
 ) {
-  const modifier = getModifier(event);
+  const modifiers = getModifiers(event);
 
   const action = screenSpaceEventHandler.getInputAction(
     screenSpaceEventType,
-    modifier,
+    modifiers,
   );
   const clickAction = screenSpaceEventHandler.getInputAction(
     clickScreenSpaceEventType,
-    modifier,
+    modifiers,
   );
 
   if (defined(action) || defined(clickAction)) {
@@ -347,7 +357,7 @@ function handleMouseMove(screenSpaceEventHandler, event) {
     return;
   }
 
-  const modifier = getModifier(event);
+  const modifiers = getModifiers(event);
 
   const position = getPosition(
     screenSpaceEventHandler,
@@ -358,7 +368,7 @@ function handleMouseMove(screenSpaceEventHandler, event) {
 
   const action = screenSpaceEventHandler.getInputAction(
     ScreenSpaceEventType.MOUSE_MOVE,
-    modifier,
+    modifiers,
   );
 
   if (defined(action)) {
@@ -393,11 +403,11 @@ function handleDblClick(screenSpaceEventHandler, event) {
     return;
   }
 
-  const modifier = getModifier(event);
+  const modifiers = getModifiers(event);
 
   const action = screenSpaceEventHandler.getInputAction(
     screenSpaceEventType,
-    modifier,
+    modifiers,
   );
 
   if (defined(action)) {
@@ -437,10 +447,10 @@ function handleWheel(screenSpaceEventHandler, event) {
     return;
   }
 
-  const modifier = getModifier(event);
+  const modifiers = getModifiers(event);
   const action = screenSpaceEventHandler.getInputAction(
     ScreenSpaceEventType.WHEEL,
-    modifier,
+    modifiers,
   );
 
   if (defined(action)) {
@@ -530,7 +540,7 @@ const touchHoldEvent = {
 };
 
 function fireTouchEvents(screenSpaceEventHandler, event) {
-  const modifier = getModifier(event);
+  const modifiers = getModifiers(event);
   const positions = screenSpaceEventHandler._positions;
   const numberOfTouches = positions.length;
   let action;
@@ -551,7 +561,7 @@ function fireTouchEvents(screenSpaceEventHandler, event) {
 
     action = screenSpaceEventHandler.getInputAction(
       ScreenSpaceEventType.LEFT_UP,
-      modifier,
+      modifiers,
     );
 
     if (defined(action)) {
@@ -567,7 +577,7 @@ function fireTouchEvents(screenSpaceEventHandler, event) {
       // releasing single touch, check for CLICK
       clickAction = screenSpaceEventHandler.getInputAction(
         ScreenSpaceEventType.LEFT_CLICK,
-        modifier,
+        modifiers,
       );
 
       if (defined(clickAction)) {
@@ -602,7 +612,7 @@ function fireTouchEvents(screenSpaceEventHandler, event) {
 
     action = screenSpaceEventHandler.getInputAction(
       ScreenSpaceEventType.PINCH_END,
-      modifier,
+      modifiers,
     );
 
     if (defined(action)) {
@@ -624,7 +634,7 @@ function fireTouchEvents(screenSpaceEventHandler, event) {
 
     action = screenSpaceEventHandler.getInputAction(
       ScreenSpaceEventType.LEFT_DOWN,
-      modifier,
+      modifiers,
     );
 
     if (defined(action)) {
@@ -640,7 +650,7 @@ function fireTouchEvents(screenSpaceEventHandler, event) {
 
         clickAction = screenSpaceEventHandler.getInputAction(
           ScreenSpaceEventType.RIGHT_CLICK,
-          modifier,
+          modifiers,
         );
 
         if (defined(clickAction)) {
@@ -674,7 +684,7 @@ function fireTouchEvents(screenSpaceEventHandler, event) {
 
     action = screenSpaceEventHandler.getInputAction(
       ScreenSpaceEventType.PINCH_START,
-      modifier,
+      modifiers,
     );
 
     if (defined(action)) {
@@ -740,7 +750,7 @@ const touchPinchMovementEvent = {
 };
 
 function fireTouchMoveEvents(screenSpaceEventHandler, event) {
-  const modifier = getModifier(event);
+  const modifiers = getModifiers(event);
   const positions = screenSpaceEventHandler._positions;
   const previousPositions = screenSpaceEventHandler._previousPositions;
   const numberOfTouches = positions.length;
@@ -758,7 +768,7 @@ function fireTouchMoveEvents(screenSpaceEventHandler, event) {
 
     action = screenSpaceEventHandler.getInputAction(
       ScreenSpaceEventType.MOUSE_MOVE,
-      modifier,
+      modifiers,
     );
 
     if (defined(action)) {
@@ -776,7 +786,7 @@ function fireTouchMoveEvents(screenSpaceEventHandler, event) {
 
     action = screenSpaceEventHandler.getInputAction(
       ScreenSpaceEventType.PINCH_MOVE,
-      modifier,
+      modifiers,
     );
     if (defined(action)) {
       const position1 = positions.values[0];
@@ -1012,7 +1022,7 @@ function ScreenSpaceEventHandler(element) {
  *
  * @param {ScreenSpaceEventHandler.PositionedEventCallback|ScreenSpaceEventHandler.MotionEventCallback|ScreenSpaceEventHandler.WheelEventCallback|ScreenSpaceEventHandler.TwoPointEventCallback|ScreenSpaceEventHandler.TwoPointMotionEventCallback} action Function to be executed when the input event occurs.
  * @param {ScreenSpaceEventType} type The ScreenSpaceEventType of input event.
- * @param {KeyboardEventModifier} [modifier] A KeyboardEventModifier key that is held when a <code>type</code>
+ * @param {KeyboardEventModifier[] | KeyboardEventModifier} [modifiers] The KeyboardEventModifier keys that are held when a <code>type</code>
  * event occurs.
  *
  * @see ScreenSpaceEventHandler#getInputAction
@@ -1021,7 +1031,7 @@ function ScreenSpaceEventHandler(element) {
 ScreenSpaceEventHandler.prototype.setInputAction = function (
   action,
   type,
-  modifier,
+  modifiers,
 ) {
   //>>includeStart('debug', pragmas.debug);
   if (!defined(action)) {
@@ -1032,7 +1042,7 @@ ScreenSpaceEventHandler.prototype.setInputAction = function (
   }
   //>>includeEnd('debug');
 
-  const key = getInputEventKey(type, modifier);
+  const key = getInputEventKey(type, modifiers);
   this._inputEvents[key] = action;
 };
 
@@ -1040,7 +1050,7 @@ ScreenSpaceEventHandler.prototype.setInputAction = function (
  * Returns the function to be executed on an input event.
  *
  * @param {ScreenSpaceEventType} type The ScreenSpaceEventType of input event.
- * @param {KeyboardEventModifier} [modifier] A KeyboardEventModifier key that is held when a <code>type</code>
+ * @param {KeyboardEventModifier[] | KeyboardEventModifier} [modifiers] The KeyboardEventModifier keys that are held when a <code>type</code>
  * event occurs.
  *
  * @returns {ScreenSpaceEventHandler.PositionedEventCallback|ScreenSpaceEventHandler.MotionEventCallback|ScreenSpaceEventHandler.WheelEventCallback|ScreenSpaceEventHandler.TwoPointEventCallback|ScreenSpaceEventHandler.TwoPointMotionEventCallback} The function to be executed on an input event.
@@ -1048,14 +1058,14 @@ ScreenSpaceEventHandler.prototype.setInputAction = function (
  * @see ScreenSpaceEventHandler#setInputAction
  * @see ScreenSpaceEventHandler#removeInputAction
  */
-ScreenSpaceEventHandler.prototype.getInputAction = function (type, modifier) {
+ScreenSpaceEventHandler.prototype.getInputAction = function (type, modifiers) {
   //>>includeStart('debug', pragmas.debug);
   if (!defined(type)) {
     throw new DeveloperError("type is required.");
   }
   //>>includeEnd('debug');
 
-  const key = getInputEventKey(type, modifier);
+  const key = getInputEventKey(type, modifiers);
   return this._inputEvents[key];
 };
 
@@ -1063,7 +1073,7 @@ ScreenSpaceEventHandler.prototype.getInputAction = function (type, modifier) {
  * Removes the function to be executed on an input event.
  *
  * @param {ScreenSpaceEventType} type The ScreenSpaceEventType of input event.
- * @param {KeyboardEventModifier} [modifier] A KeyboardEventModifier key that is held when a <code>type</code>
+ * @param {KeyboardEventModifier[] | KeyboardEventModifier} [modifiers] The KeyboardEventModifier keys that are held when a <code>type</code>
  * event occurs.
  *
  * @see ScreenSpaceEventHandler#getInputAction
@@ -1071,7 +1081,7 @@ ScreenSpaceEventHandler.prototype.getInputAction = function (type, modifier) {
  */
 ScreenSpaceEventHandler.prototype.removeInputAction = function (
   type,
-  modifier,
+  modifiers,
 ) {
   //>>includeStart('debug', pragmas.debug);
   if (!defined(type)) {
@@ -1079,7 +1089,7 @@ ScreenSpaceEventHandler.prototype.removeInputAction = function (
   }
   //>>includeEnd('debug');
 
-  const key = getInputEventKey(type, modifier);
+  const key = getInputEventKey(type, modifiers);
   delete this._inputEvents[key];
 };
 

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;