@cesium/engine 2.0.0 → 2.2.0

package/Source/Core/TileAvailability.js

@@ -10,7 +10,7 @@ import Rectangle from "./Rectangle.js";
  * @constructor
  *
  * @param {TilingScheme} tilingScheme The tiling scheme in which to report availability.
- * @param {Number} maximumLevel The maximum tile level that is potentially available.
+ * @param {number} maximumLevel The maximum tile level that is potentially available.
  */
 function TileAvailability(tilingScheme, maximumLevel) {
   this._tilingScheme = tilingScheme;
@@ -37,11 +37,11 @@ function findNode(level, x, y, nodes) {
  * Marks a rectangular range of tiles in a particular level as being available.  For best performance,
  * add your ranges in order of increasing level.
  *
- * @param {Number} level The level.
- * @param {Number} startX The X coordinate of the first available tiles at the level.
- * @param {Number} startY The Y coordinate of the first available tiles at the level.
- * @param {Number} endX The X coordinate of the last available tiles at the level.
- * @param {Number} endY The Y coordinate of the last available tiles at the level.
+ * @param {number} level The level.
+ * @param {number} startX The X coordinate of the first available tiles at the level.
+ * @param {number} startY The Y coordinate of the first available tiles at the level.
+ * @param {number} endX The X coordinate of the last available tiles at the level.
+ * @param {number} endY The Y coordinate of the last available tiles at the level.
  */
 TileAvailability.prototype.addAvailableTileRange = function (
   level,
@@ -93,7 +93,7 @@ TileAvailability.prototype.addAvailableTileRange = function (
  * {@link TileAvailability#addAvailableTileRange}.
  *
  * @param {Cartographic} position The position for which to determine the maximum available level.  The height component is ignored.
- * @return {Number} The level of the most detailed tile covering the position.
+ * @return {number} The level of the most detailed tile covering the position.
  * @throws {DeveloperError} If position is outside any tile according to the tiling scheme.
  */
 TileAvailability.prototype.computeMaximumLevelAtPosition = function (position) {
@@ -127,7 +127,7 @@ const eastScratch = new Rectangle();
  * {@link TileAvailability#addAvailableTileRange}.
  *
  * @param {Rectangle} rectangle The rectangle.
- * @return {Number} The best available level for the entire rectangle.
+ * @return {number} The best available level for the entire rectangle.
  */
 TileAvailability.prototype.computeBestAvailableLevelOverRectangle = function (
   rectangle
@@ -187,10 +187,10 @@ const cartographicScratch = new Cartographic();
 
 /**
  * Determines if a particular tile is available.
- * @param {Number} level The tile level to check.
- * @param {Number} x The X coordinate of the tile to check.
- * @param {Number} y The Y coordinate of the tile to check.
- * @return {Boolean} True if the tile is available; otherwise, false.
+ * @param {number} level The tile level to check.
+ * @param {number} x The X coordinate of the tile to check.
+ * @param {number} y The Y coordinate of the tile to check.
+ * @return {boolean} True if the tile is available; otherwise, false.
  */
 TileAvailability.prototype.isTileAvailable = function (level, x, y) {
   // Get the center of the tile and find the maximum level at that position.
@@ -220,10 +220,10 @@ TileAvailability.prototype.isTileAvailable = function (level, x, y) {
  *     <tr><td>3</td><td>8</td><td>Northeast</td></tr>
  * </table>
  *
- * @param {Number} level The level of the parent tile.
- * @param {Number} x The X coordinate of the parent tile.
- * @param {Number} y The Y coordinate of the parent tile.
- * @return {Number} The bit mask indicating child availability.
+ * @param {number} level The level of the parent tile.
+ * @param {number} x The X coordinate of the parent tile.
+ * @param {number} y The Y coordinate of the parent tile.
+ * @return {number} The bit mask indicating child availability.
  */
 TileAvailability.prototype.computeChildMaskForTile = function (level, x, y) {
   const childLevel = level + 1;

package/Source/Core/TileProviderError.js

@@ -9,14 +9,14 @@ import formatError from "./formatError.js";
  * @constructor
  *
  * @param {ImageryProvider|TerrainProvider} provider The imagery or terrain provider that experienced the error.
- * @param {String} message A message describing the error.
- * @param {Number} [x] The X coordinate of the tile that experienced the error, or undefined if the error
+ * @param {string} message A message describing the error.
+ * @param {number} [x] The X coordinate of the tile that experienced the error, or undefined if the error
  *        is not specific to a particular tile.
- * @param {Number} [y] The Y coordinate of the tile that experienced the error, or undefined if the error
+ * @param {number} [y] The Y coordinate of the tile that experienced the error, or undefined if the error
  *        is not specific to a particular tile.
- * @param {Number} [level] The level of the tile that experienced the error, or undefined if the error
+ * @param {number} [level] The level of the tile that experienced the error, or undefined if the error
  *        is not specific to a particular tile.
- * @param {Number} [timesRetried=0] The number of times this operation has been retried.
+ * @param {number} [timesRetried=0] The number of times this operation has been retried.
  * @param {Error} [error] The error or exception that occurred, if any.
  */
 function TileProviderError(
@@ -36,34 +36,34 @@ function TileProviderError(
 
   /**
    * The message describing the error.
-   * @type {String}
+   * @type {string}
    */
   this.message = message;
 
   /**
    * The X coordinate of the tile that experienced the error.  If the error is not specific
    * to a particular tile, this property will be undefined.
-   * @type {Number}
+   * @type {number}
    */
   this.x = x;
 
   /**
    * The Y coordinate of the tile that experienced the error.  If the error is not specific
    * to a particular tile, this property will be undefined.
-   * @type {Number}
+   * @type {number}
    */
   this.y = y;
 
   /**
    * The level-of-detail of the tile that experienced the error.  If the error is not specific
    * to a particular tile, this property will be undefined.
-   * @type {Number}
+   * @type {number}
    */
   this.level = level;
 
   /**
    * The number of times this operation has been retried.
-   * @type {Number}
+   * @type {number}
    * @default 0
    */
   this.timesRetried = defaultValue(timesRetried, 0);
@@ -72,7 +72,7 @@ function TileProviderError(
    * True if the failed operation should be retried; otherwise, false.  The imagery or terrain provider
    * will set the initial value of this property before raising the event, but any listeners
    * can change it.  The value after the last listener is invoked will be acted upon.
-   * @type {Boolean}
+   * @type {boolean}
    * @default false
    */
   this.retry = false;
@@ -92,14 +92,14 @@ function TileProviderError(
  * @param {TileProviderError} previousError The error instance returned by this function the last
  *        time it was called for this error, or undefined if this is the first time this error has
  *        occurred.
- * @param {ImageryProvider|TerrainProvider} provider The imagery or terrain provider that encountered the error.
- * @param {Event} event The event to raise to inform listeners of the error.
- * @param {String} message The message describing the error.
- * @param {Number} x The X coordinate of the tile that experienced the error, or undefined if the
+ * @param {ImageryProvider|TerrainProvider} [provider] The imagery or terrain provider that encountered the error.
+ * @param {Event} [event] The event to raise to inform listeners of the error.
+ * @param {string} [message] The message describing the error.
+ * @param {number} [x] The X coordinate of the tile that experienced the error, or undefined if the
  *        error is not specific to a particular tile.
- * @param {Number} y The Y coordinate of the tile that experienced the error, or undefined if the
+ * @param {number} [y] The Y coordinate of the tile that experienced the error, or undefined if the
  *        error is not specific to a particular tile.
- * @param {Number} level The level-of-detail of the tile that experienced the error, or undefined if the
+ * @param {number} [level] The level-of-detail of the tile that experienced the error, or undefined if the
  *        error is not specific to a particular tile.
  * @param {Error} [errorDetails] The error or exception that occurred, if any.
  * @returns {TileProviderError} The error instance that was passed to the event listeners and that
@@ -138,9 +138,9 @@ TileProviderError.reportError = function (
     ++error.timesRetried;
   }
 
-  if (event.numberOfListeners > 0) {
+  if (defined(event) && event.numberOfListeners > 0) {
     event.raiseEvent(error);
-  } else {
+  } else if (defined(provider)) {
     console.log(
       `An error occurred in "${provider.constructor.name}": ${formatError(
         message

package/Source/Core/TilingScheme.js

@@ -54,8 +54,8 @@ Object.defineProperties(TilingScheme.prototype, {
  * 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.
+ * @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;
@@ -64,8 +64,8 @@ TilingScheme.prototype.getNumberOfXTilesAtLevel =
  * 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.
+ * @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;
@@ -89,10 +89,10 @@ TilingScheme.prototype.rectangleToNativeRectangle =
  * 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
+ * @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.
@@ -104,10 +104,10 @@ TilingScheme.prototype.tileXYToNativeRectangle =
  * 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
+ * @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.
@@ -121,7 +121,7 @@ TilingScheme.prototype.tileXYToRectangle =
  * @function
  *
  * @param {Cartographic} position The position.
- * @param {Number} level The tile level-of-detail.  Zero is the least detailed.
+ * @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

package/Source/Core/TimeConstants.js

@@ -10,63 +10,63 @@
 const TimeConstants = {
   /**
    * The number of seconds in one millisecond: <code>0.001</code>
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   SECONDS_PER_MILLISECOND: 0.001,
 
   /**
    * The number of seconds in one minute: <code>60</code>.
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   SECONDS_PER_MINUTE: 60.0,
 
   /**
    * The number of minutes in one hour: <code>60</code>.
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   MINUTES_PER_HOUR: 60.0,
 
   /**
    * The number of hours in one day: <code>24</code>.
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   HOURS_PER_DAY: 24.0,
 
   /**
    * The number of seconds in one hour: <code>3600</code>.
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   SECONDS_PER_HOUR: 3600.0,
 
   /**
    * The number of minutes in one day: <code>1440</code>.
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   MINUTES_PER_DAY: 1440.0,
 
   /**
    * The number of seconds in one day, ignoring leap seconds: <code>86400</code>.
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   SECONDS_PER_DAY: 86400.0,
 
   /**
    * The number of days in one Julian century: <code>36525</code>.
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   DAYS_PER_JULIAN_CENTURY: 36525.0,
 
   /**
    * One trillionth of a second.
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   PICOSECOND: 0.000000001,
@@ -75,7 +75,7 @@ const TimeConstants = {
    * The number of days to subtract from a Julian date to determine the
    * modified Julian date, which gives the number of days since midnight
    * on November 17, 1858.
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   MODIFIED_JULIAN_DATE_DIFFERENCE: 2400000.5,

package/Source/Core/TimeInterval.js

@@ -11,12 +11,12 @@ import JulianDate from "./JulianDate.js";
  * @alias TimeInterval
  * @constructor
  *
- * @param {Object} [options] Object with the following properties:
+ * @param {object} [options] Object with the following properties:
  * @param {JulianDate} [options.start=new JulianDate()] The start time of the interval.
  * @param {JulianDate} [options.stop=new JulianDate()] The stop time of the interval.
- * @param {Boolean} [options.isStartIncluded=true] <code>true</code> if <code>options.start</code> is included in the interval, <code>false</code> otherwise.
- * @param {Boolean} [options.isStopIncluded=true] <code>true</code> if <code>options.stop</code> is included in the interval, <code>false</code> otherwise.
- * @param {Object} [options.data] Arbitrary data associated with this interval.
+ * @param {boolean} [options.isStartIncluded=true] <code>true</code> if <code>options.start</code> is included in the interval, <code>false</code> otherwise.
+ * @param {boolean} [options.isStopIncluded=true] <code>true</code> if <code>options.stop</code> is included in the interval, <code>false</code> otherwise.
+ * @param {object} [options.data] Arbitrary data associated with this interval.
  *
  * @example
  * // Create an instance that spans August 1st, 1980 and is associated
@@ -83,14 +83,14 @@ function TimeInterval(options) {
 
   /**
    * Gets or sets whether or not the start time is included in this interval.
-   * @type {Boolean}
+   * @type {boolean}
    * @default true
    */
   this.isStartIncluded = defaultValue(options.isStartIncluded, true);
 
   /**
    * Gets or sets whether or not the stop time is included in this interval.
-   * @type {Boolean}
+   * @type {boolean}
    * @default true
    */
   this.isStopIncluded = defaultValue(options.isStopIncluded, true);
@@ -100,7 +100,7 @@ Object.defineProperties(TimeInterval.prototype, {
   /**
    * Gets whether or not this interval is empty.
    * @memberof TimeInterval.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   isEmpty: {
@@ -128,11 +128,11 @@ const scratchInterval = {
  *
  * @throws DeveloperError if options.iso8601 does not match proper formatting.
  *
- * @param {Object} options Object with the following properties:
- * @param {String} options.iso8601 An ISO 8601 interval.
- * @param {Boolean} [options.isStartIncluded=true] <code>true</code> if <code>options.start</code> is included in the interval, <code>false</code> otherwise.
- * @param {Boolean} [options.isStopIncluded=true] <code>true</code> if <code>options.stop</code> is included in the interval, <code>false</code> otherwise.
- * @param {Object} [options.data] Arbitrary data associated with this interval.
+ * @param {object} options Object with the following properties:
+ * @param {string} options.iso8601 An ISO 8601 interval.
+ * @param {boolean} [options.isStartIncluded=true] <code>true</code> if <code>options.start</code> is included in the interval, <code>false</code> otherwise.
+ * @param {boolean} [options.isStopIncluded=true] <code>true</code> if <code>options.stop</code> is included in the interval, <code>false</code> otherwise.
+ * @param {object} [options.data] Arbitrary data associated with this interval.
  * @param {TimeInterval} [result] An existing instance to use for the result.
  * @returns {TimeInterval} The modified result parameter or a new instance if none was provided.
  */
@@ -175,8 +175,8 @@ TimeInterval.fromIso8601 = function (options, result) {
  * Creates an ISO8601 representation of the provided interval.
  *
  * @param {TimeInterval} timeInterval The interval to be converted.
- * @param {Number} [precision] The number of fractional digits used to represent the seconds component.  By default, the most precise representation is used.
- * @returns {String} The ISO8601 representation of the provided interval.
+ * @param {number} [precision] The number of fractional digits used to represent the seconds component.  By default, the most precise representation is used.
+ * @returns {string} The ISO8601 representation of the provided interval.
  */
 TimeInterval.toIso8601 = function (timeInterval, precision) {
   //>>includeStart('debug', pragmas.debug);
@@ -217,7 +217,7 @@ TimeInterval.clone = function (timeInterval, result) {
  * @param {TimeInterval} [left] The first instance.
  * @param {TimeInterval} [right] The second instance.
  * @param {TimeInterval.DataComparer} [dataComparer] A function which compares the data of the two intervals.  If omitted, reference equality is used.
- * @returns {Boolean} <code>true</code> if the dates are equal; otherwise, <code>false</code>.
+ * @returns {boolean} <code>true</code> if the dates are equal; otherwise, <code>false</code>.
  */
 TimeInterval.equals = function (left, right, dataComparer) {
   return (
@@ -242,9 +242,9 @@ TimeInterval.equals = function (left, right, dataComparer) {
  *
  * @param {TimeInterval} [left] The first instance.
  * @param {TimeInterval} [right] The second instance.
- * @param {Number} [epsilon=0] The maximum number of seconds that should separate the two instances.
+ * @param {number} [epsilon=0] The maximum number of seconds that should separate the two instances.
  * @param {TimeInterval.DataComparer} [dataComparer] A function which compares the data of the two intervals.  If omitted, reference equality is used.
- * @returns {Boolean} <code>true</code> if the two dates are within <code>epsilon</code> seconds of each other; otherwise <code>false</code>.
+ * @returns {boolean} <code>true</code> if the two dates are within <code>epsilon</code> seconds of each other; otherwise <code>false</code>.
  */
 TimeInterval.equalsEpsilon = function (left, right, epsilon, dataComparer) {
   epsilon = defaultValue(epsilon, 0);
@@ -331,7 +331,7 @@ TimeInterval.intersect = function (left, right, result, mergeCallback) {
  *
  * @param {TimeInterval} timeInterval The interval.
  * @param {JulianDate} julianDate The date to check.
- * @returns {Boolean} <code>true</code> if the interval contains the specified date, <code>false</code> otherwise.
+ * @returns {boolean} <code>true</code> if the interval contains the specified date, <code>false</code> otherwise.
  */
 TimeInterval.contains = function (timeInterval, julianDate) {
   //>>includeStart('debug', pragmas.debug);
@@ -375,7 +375,7 @@ TimeInterval.prototype.clone = function (result) {
  *
  * @param {TimeInterval} [right] The right hand side interval.
  * @param {TimeInterval.DataComparer} [dataComparer] A function which compares the data of the two intervals.  If omitted, reference equality is used.
- * @returns {Boolean} <code>true</code> if they are equal, <code>false</code> otherwise.
+ * @returns {boolean} <code>true</code> if they are equal, <code>false</code> otherwise.
  */
 TimeInterval.prototype.equals = function (right, dataComparer) {
   return TimeInterval.equals(this, right, dataComparer);
@@ -387,9 +387,9 @@ TimeInterval.prototype.equals = function (right, dataComparer) {
  * <code>false</code> otherwise.
  *
  * @param {TimeInterval} [right] The right hand side interval.
- * @param {Number} [epsilon=0] The epsilon to use for equality testing.
+ * @param {number} [epsilon=0] The epsilon to use for equality testing.
  * @param {TimeInterval.DataComparer} [dataComparer] A function which compares the data of the two intervals.  If omitted, reference equality is used.
- * @returns {Boolean} <code>true</code> if they are within the provided epsilon, <code>false</code> otherwise.
+ * @returns {boolean} <code>true</code> if they are within the provided epsilon, <code>false</code> otherwise.
  */
 TimeInterval.prototype.equalsEpsilon = function (right, epsilon, dataComparer) {
   return TimeInterval.equalsEpsilon(this, right, epsilon, dataComparer);
@@ -398,7 +398,7 @@ TimeInterval.prototype.equalsEpsilon = function (right, epsilon, dataComparer) {
 /**
  * Creates a string representing this TimeInterval in ISO8601 format.
  *
- * @returns {String} A string representing this TimeInterval in ISO8601 format.
+ * @returns {string} A string representing this TimeInterval in ISO8601 format.
  */
 TimeInterval.prototype.toString = function () {
   return TimeInterval.toIso8601(this);
@@ -433,6 +433,6 @@ TimeInterval.EMPTY = Object.freeze(
  * @callback TimeInterval.DataComparer
  * @param {*} leftData The first data instance.
  * @param {*} rightData The second data instance.
- * @returns {Boolean} <code>true</code> if the provided instances are equal, <code>false</code> otherwise.
+ * @returns {boolean} <code>true</code> if the provided instances are equal, <code>false</code> otherwise.
  */
 export default TimeInterval;