@cesium/engine 1.1.0 → 2.1.0

package/Source/Core/IonResource.js

@@ -15,7 +15,7 @@ import RuntimeError from "./RuntimeError.js";
  * @constructor
  * @augments Resource
  *
- * @param {Object} endpoint The result of the Cesium ion asset endpoint service.
+ * @param {object} endpoint The result of the Cesium ion asset endpoint service.
  * @param {Resource} endpointResource The resource used to retreive the endpoint.
  *
  * @see Ion
@@ -80,11 +80,11 @@ if (defined(Object.create)) {
 /**
  * Asynchronously creates an instance.
  *
- * @param {Number} assetId The Cesium ion asset id.
- * @param {Object} [options] An object with the following properties:
- * @param {String} [options.accessToken=Ion.defaultAccessToken] The access token to use.
- * @param {String|Resource} [options.server=Ion.defaultServer] The resource to the Cesium ion API server.
- * @returns {Promise.<IonResource>} A Promise to am instance representing the Cesium ion Asset.
+ * @param {number} assetId The Cesium ion asset id.
+ * @param {object} [options] An object with the following properties:
+ * @param {string} [options.accessToken=Ion.defaultAccessToken] The access token to use.
+ * @param {string|Resource} [options.server=Ion.defaultServer] The resource to the Cesium ion API server.
+ * @returns {Promise<IonResource>} A Promise to am instance representing the Cesium ion Asset.
  *
  * @example
  * //Load a Cesium3DTileset with asset ID of 124624234

package/Source/Core/JulianDate.js

@@ -199,20 +199,20 @@ const iso8601ErrorMessage = "Invalid ISO 8601 date.";
  * @alias JulianDate
  * @constructor
  *
- * @param {Number} [julianDayNumber=0.0] The Julian Day Number representing the number of whole days.  Fractional days will also be handled correctly.
- * @param {Number} [secondsOfDay=0.0] The number of seconds into the current Julian Day Number.  Fractional seconds, negative seconds and seconds greater than a day will be handled correctly.
+ * @param {number} [julianDayNumber=0.0] The Julian Day Number representing the number of whole days.  Fractional days will also be handled correctly.
+ * @param {number} [secondsOfDay=0.0] The number of seconds into the current Julian Day Number.  Fractional seconds, negative seconds and seconds greater than a day will be handled correctly.
  * @param {TimeStandard} [timeStandard=TimeStandard.UTC] The time standard in which the first two parameters are defined.
  */
 function JulianDate(julianDayNumber, secondsOfDay, timeStandard) {
   /**
    * Gets or sets the number of whole days.
-   * @type {Number}
+   * @type {number}
    */
   this.dayNumber = undefined;
 
   /**
    * Gets or sets the number of seconds into the current day.
-   * @type {Number}
+   * @type {number}
    */
   this.secondsOfDay = undefined;
 
@@ -304,7 +304,7 @@ JulianDate.fromDate = function (date, result) {
  * This method is superior to <code>Date.parse</code> because it will handle all valid formats defined by the ISO 8601
  * specification, including leap seconds and sub-millisecond times, which discarded by most JavaScript implementations.
  *
- * @param {String} iso8601String An ISO 8601 date.
+ * @param {string} iso8601String An ISO 8601 date.
  * @param {JulianDate} [result] An existing instance to use for the result.
  * @returns {JulianDate} The modified result parameter or a new instance if none was provided.
  *
@@ -745,8 +745,8 @@ JulianDate.toDate = function (julianDate) {
  * Creates an ISO8601 representation of the provided date.
  *
  * @param {JulianDate} julianDate The date 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 date.
+ * @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 date.
  */
 JulianDate.toIso8601 = function (julianDate, precision) {
   //>>includeStart('debug', pragmas.debug);
@@ -858,7 +858,7 @@ JulianDate.clone = function (julianDate, result) {
  *
  * @param {JulianDate} left The first instance.
  * @param {JulianDate} right The second instance.
- * @returns {Number} A negative value if left is less than right, a positive value if left is greater than right, or zero if left and right are equal.
+ * @returns {number} A negative value if left is less than right, a positive value if left is greater than right, or zero if left and right are equal.
  */
 JulianDate.compare = function (left, right) {
   //>>includeStart('debug', pragmas.debug);
@@ -882,7 +882,7 @@ JulianDate.compare = function (left, right) {
  *
  * @param {JulianDate} [left] The first instance.
  * @param {JulianDate} [right] The second instance.
- * @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>.
  */
 JulianDate.equals = function (left, right) {
   return (
@@ -902,8 +902,8 @@ JulianDate.equals = function (left, right) {
  *
  * @param {JulianDate} [left] The first instance.
  * @param {JulianDate} [right] The second instance.
- * @param {Number} [epsilon=0] The maximum number of seconds that should separate the two instances.
- * @returns {Boolean} <code>true</code> if the two dates are within <code>epsilon</code> seconds of each other; otherwise <code>false</code>.
+ * @param {number} [epsilon=0] The maximum number of seconds that should separate the two instances.
+ * @returns {boolean} <code>true</code> if the two dates are within <code>epsilon</code> seconds of each other; otherwise <code>false</code>.
  */
 JulianDate.equalsEpsilon = function (left, right, epsilon) {
   epsilon = defaultValue(epsilon, 0);
@@ -920,7 +920,7 @@ JulianDate.equalsEpsilon = function (left, right, epsilon) {
  * Computes the total number of whole and fractional days represented by the provided instance.
  *
  * @param {JulianDate} julianDate The date.
- * @returns {Number} The Julian date as single floating point number.
+ * @returns {number} The Julian date as single floating point number.
  */
 JulianDate.totalDays = function (julianDate) {
   //>>includeStart('debug', pragmas.debug);
@@ -939,7 +939,7 @@ JulianDate.totalDays = function (julianDate) {
  *
  * @param {JulianDate} left The first instance.
  * @param {JulianDate} right The second instance.
- * @returns {Number} The difference, in seconds, when subtracting <code>right</code> from <code>left</code>.
+ * @returns {number} The difference, in seconds, when subtracting <code>right</code> from <code>left</code>.
  */
 JulianDate.secondsDifference = function (left, right) {
   //>>includeStart('debug', pragmas.debug);
@@ -961,7 +961,7 @@ JulianDate.secondsDifference = function (left, right) {
  *
  * @param {JulianDate} left The first instance.
  * @param {JulianDate} right The second instance.
- * @returns {Number} The difference, in days, when subtracting <code>right</code> from <code>left</code>.
+ * @returns {number} The difference, in days, when subtracting <code>right</code> from <code>left</code>.
  */
 JulianDate.daysDifference = function (left, right) {
   //>>includeStart('debug', pragmas.debug);
@@ -983,7 +983,7 @@ JulianDate.daysDifference = function (left, right) {
  * Computes the number of seconds the provided instance is ahead of UTC.
  *
  * @param {JulianDate} julianDate The date.
- * @returns {Number} The number of seconds the provided instance is ahead of UTC
+ * @returns {number} The number of seconds the provided instance is ahead of UTC
  */
 JulianDate.computeTaiMinusUtc = function (julianDate) {
   binarySearchScratchLeapSecond.julianDate = julianDate;
@@ -1007,7 +1007,7 @@ JulianDate.computeTaiMinusUtc = function (julianDate) {
  * Adds the provided number of seconds to the provided date instance.
  *
  * @param {JulianDate} julianDate The date.
- * @param {Number} seconds The number of seconds to add or subtract.
+ * @param {number} seconds The number of seconds to add or subtract.
  * @param {JulianDate} result An existing instance to use for the result.
  * @returns {JulianDate} The modified result parameter.
  */
@@ -1035,7 +1035,7 @@ JulianDate.addSeconds = function (julianDate, seconds, result) {
  * Adds the provided number of minutes to the provided date instance.
  *
  * @param {JulianDate} julianDate The date.
- * @param {Number} minutes The number of minutes to add or subtract.
+ * @param {number} minutes The number of minutes to add or subtract.
  * @param {JulianDate} result An existing instance to use for the result.
  * @returns {JulianDate} The modified result parameter.
  */
@@ -1061,7 +1061,7 @@ JulianDate.addMinutes = function (julianDate, minutes, result) {
  * Adds the provided number of hours to the provided date instance.
  *
  * @param {JulianDate} julianDate The date.
- * @param {Number} hours The number of hours to add or subtract.
+ * @param {number} hours The number of hours to add or subtract.
  * @param {JulianDate} result An existing instance to use for the result.
  * @returns {JulianDate} The modified result parameter.
  */
@@ -1087,7 +1087,7 @@ JulianDate.addHours = function (julianDate, hours, result) {
  * Adds the provided number of days to the provided date instance.
  *
  * @param {JulianDate} julianDate The date.
- * @param {Number} days The number of days to add or subtract.
+ * @param {number} days The number of days to add or subtract.
  * @param {JulianDate} result An existing instance to use for the result.
  * @returns {JulianDate} The modified result parameter.
  */
@@ -1113,7 +1113,7 @@ JulianDate.addDays = function (julianDate, days, result) {
  *
  * @param {JulianDate} left The first instance.
  * @param {JulianDate} right The second instance.
- * @returns {Boolean} <code>true</code> if <code>left</code> is earlier than <code>right</code>, <code>false</code> otherwise.
+ * @returns {boolean} <code>true</code> if <code>left</code> is earlier than <code>right</code>, <code>false</code> otherwise.
  */
 JulianDate.lessThan = function (left, right) {
   return JulianDate.compare(left, right) < 0;
@@ -1124,7 +1124,7 @@ JulianDate.lessThan = function (left, right) {
  *
  * @param {JulianDate} left The first instance.
  * @param {JulianDate} right The second instance.
- * @returns {Boolean} <code>true</code> if <code>left</code> is earlier than or equal to <code>right</code>, <code>false</code> otherwise.
+ * @returns {boolean} <code>true</code> if <code>left</code> is earlier than or equal to <code>right</code>, <code>false</code> otherwise.
  */
 JulianDate.lessThanOrEquals = function (left, right) {
   return JulianDate.compare(left, right) <= 0;
@@ -1135,7 +1135,7 @@ JulianDate.lessThanOrEquals = function (left, right) {
  *
  * @param {JulianDate} left The first instance.
  * @param {JulianDate} right The second instance.
- * @returns {Boolean} <code>true</code> if <code>left</code> is later than <code>right</code>, <code>false</code> otherwise.
+ * @returns {boolean} <code>true</code> if <code>left</code> is later than <code>right</code>, <code>false</code> otherwise.
  */
 JulianDate.greaterThan = function (left, right) {
   return JulianDate.compare(left, right) > 0;
@@ -1146,7 +1146,7 @@ JulianDate.greaterThan = function (left, right) {
  *
  * @param {JulianDate} left The first instance.
  * @param {JulianDate} right The second instance.
- * @returns {Boolean} <code>true</code> if <code>left</code> is later than or equal to <code>right</code>, <code>false</code> otherwise.
+ * @returns {boolean} <code>true</code> if <code>left</code> is later than or equal to <code>right</code>, <code>false</code> otherwise.
  */
 JulianDate.greaterThanOrEquals = function (left, right) {
   return JulianDate.compare(left, right) >= 0;
@@ -1166,7 +1166,7 @@ JulianDate.prototype.clone = function (result) {
  * Compares this and the provided instance and returns <code>true</code> if they are equal, <code>false</code> otherwise.
  *
  * @param {JulianDate} [right] The second instance.
- * @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>.
  */
 JulianDate.prototype.equals = function (right) {
   return JulianDate.equals(this, right);
@@ -1179,8 +1179,8 @@ JulianDate.prototype.equals = function (right) {
  * seconds, must be less than <code>epsilon</code>.
  *
  * @param {JulianDate} [right] The second instance.
- * @param {Number} [epsilon=0] The maximum number of seconds that should separate the two instances.
- * @returns {Boolean} <code>true</code> if the two dates are within <code>epsilon</code> seconds of each other; otherwise <code>false</code>.
+ * @param {number} [epsilon=0] The maximum number of seconds that should separate the two instances.
+ * @returns {boolean} <code>true</code> if the two dates are within <code>epsilon</code> seconds of each other; otherwise <code>false</code>.
  */
 JulianDate.prototype.equalsEpsilon = function (right, epsilon) {
   return JulianDate.equalsEpsilon(this, right, epsilon);
@@ -1189,7 +1189,7 @@ JulianDate.prototype.equalsEpsilon = function (right, epsilon) {
 /**
  * Creates a string representing this date in ISO8601 format.
  *
- * @returns {String} A string representing this date in ISO8601 format.
+ * @returns {string} A string representing this date in ISO8601 format.
  */
 JulianDate.prototype.toString = function () {
   return JulianDate.toIso8601(this);

package/Source/Core/KeyboardEventModifier.js

@@ -2,13 +2,13 @@
  * This enumerated type is for representing keyboard modifiers. These are keys
  * that are held down in addition to other event types.
  *
- * @enum {Number}
+ * @enum {number}
  */
 const KeyboardEventModifier = {
   /**
    * Represents the shift key being held down.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   SHIFT: 0,
@@ -16,7 +16,7 @@ const KeyboardEventModifier = {
   /**
    * Represents the control key being held down.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   CTRL: 1,
@@ -24,7 +24,7 @@ const KeyboardEventModifier = {
   /**
    * Represents the alt key being held down.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   ALT: 2,

package/Source/Core/LagrangePolynomialApproximation.js

@@ -12,8 +12,8 @@ const LagrangePolynomialApproximation = {
 /**
  * Given the desired degree, returns the number of data points required for interpolation.
  *
- * @param {Number} degree The desired degree of interpolation.
- * @returns {Number} The number of required data points needed for the desired degree of interpolation.
+ * @param {number} degree The desired degree of interpolation.
+ * @returns {number} The number of required data points needed for the desired degree of interpolation.
  */
 LagrangePolynomialApproximation.getRequiredDataPoints = function (degree) {
   return Math.max(degree + 1.0, 2);
@@ -22,15 +22,15 @@ LagrangePolynomialApproximation.getRequiredDataPoints = function (degree) {
 /**
  * Interpolates values using Lagrange Polynomial Approximation.
  *
- * @param {Number} x The independent variable for which the dependent variables will be interpolated.
- * @param {Number[]} xTable The array of independent variables to use to interpolate.  The values
+ * @param {number} x The independent variable for which the dependent variables will be interpolated.
+ * @param {number[]} xTable The array of independent variables to use to interpolate.  The values
  * in this array must be in increasing order and the same value must not occur twice in the array.
- * @param {Number[]} yTable The array of dependent variables to use to interpolate.  For a set of three
+ * @param {number[]} yTable The array of dependent variables to use to interpolate.  For a set of three
  * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}.
- * @param {Number} yStride The number of dependent variable values in yTable corresponding to
+ * @param {number} yStride The number of dependent variable values in yTable corresponding to
  * each independent variable value in xTable.
- * @param {Number[]} [result] An existing array into which to store the result.
- * @returns {Number[]} The array of interpolated values, or the result parameter if one was provided.
+ * @param {number[]} [result] An existing array into which to store the result.
+ * @returns {number[]} The array of interpolated values, or the result parameter if one was provided.
  */
 LagrangePolynomialApproximation.interpolateOrderZero = function (
   x,

package/Source/Core/LeapSecond.js

@@ -5,7 +5,7 @@
  * @constructor
  *
  * @param {JulianDate} [date] A Julian date representing the time of the leap second.
- * @param {Number} [offset] The cumulative number of seconds that TAI is ahead of UTC at the provided date.
+ * @param {number} [offset] The cumulative number of seconds that TAI is ahead of UTC at the provided date.
  */
 function LeapSecond(date, offset) {
   /**
@@ -17,7 +17,7 @@ function LeapSecond(date, offset) {
   /**
    * Gets or sets the cumulative number of seconds between the UTC and TAI time standards at the time
    * of this leap second.
-   * @type {Number}
+   * @type {number}
    */
   this.offset = offset;
 }

package/Source/Core/LinearApproximation.js

@@ -14,8 +14,8 @@ const LinearApproximation = {
  * Given the desired degree, returns the number of data points required for interpolation.
  * Since linear interpolation can only generate a first degree polynomial, this function
  * always returns 2.
- * @param {Number} degree The desired degree of interpolation.
- * @returns {Number} This function always returns 2.
+ * @param {number} degree The desired degree of interpolation.
+ * @returns {number} This function always returns 2.
  *
  */
 LinearApproximation.getRequiredDataPoints = function (degree) {
@@ -25,15 +25,15 @@ LinearApproximation.getRequiredDataPoints = function (degree) {
 /**
  * Interpolates values using linear approximation.
  *
- * @param {Number} x The independent variable for which the dependent variables will be interpolated.
- * @param {Number[]} xTable The array of independent variables to use to interpolate.  The values
+ * @param {number} x The independent variable for which the dependent variables will be interpolated.
+ * @param {number[]} xTable The array of independent variables to use to interpolate.  The values
  * in this array must be in increasing order and the same value must not occur twice in the array.
- * @param {Number[]} yTable The array of dependent variables to use to interpolate.  For a set of three
+ * @param {number[]} yTable The array of dependent variables to use to interpolate.  For a set of three
  * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}.
- * @param {Number} yStride The number of dependent variable values in yTable corresponding to
+ * @param {number} yStride The number of dependent variable values in yTable corresponding to
  * each independent variable value in xTable.
- * @param {Number[]} [result] An existing array into which to store the result.
- * @returns {Number[]} The array of interpolated values, or the result parameter if one was provided.
+ * @param {number[]} [result] An existing array into which to store the result.
+ * @returns {number[]} The array of interpolated values, or the result parameter if one was provided.
  */
 LinearApproximation.interpolateOrderZero = function (
   x,

package/Source/Core/LinearSpline.js

@@ -10,10 +10,10 @@ import Spline from "./Spline.js";
  * @alias LinearSpline
  * @constructor
  *
- * @param {Object} options Object with the following properties:
- * @param {Number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point.
+ * @param {object} options Object with the following properties:
+ * @param {number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point.
  *                The values are in no way connected to the clock time. They are the parameterization for the curve.
- * @param {Number[]|Cartesian3[]} options.points The array of control points.
+ * @param {number[]|Cartesian3[]} options.points The array of control points.
  *
  * @exception {DeveloperError} points.length must be greater than or equal to 2.
  * @exception {DeveloperError} times.length must be equal to points.length.
@@ -74,7 +74,7 @@ Object.defineProperties(LinearSpline.prototype, {
    *
    * @memberof LinearSpline.prototype
    *
-   * @type {Number[]}
+   * @type {number[]}
    * @readonly
    */
   times: {
@@ -88,7 +88,7 @@ Object.defineProperties(LinearSpline.prototype, {
    *
    * @memberof LinearSpline.prototype
    *
-   * @type {Number[]|Cartesian3[]}
+   * @type {number[]|Cartesian3[]}
    * @readonly
    */
   points: {
@@ -103,8 +103,8 @@ Object.defineProperties(LinearSpline.prototype, {
  * <code>time</code> is in the interval <code>[times[i], times[i + 1]]</code>.
  * @function
  *
- * @param {Number} time The time.
- * @returns {Number} The index for the element at the start of the interval.
+ * @param {number} time The time.
+ * @returns {number} The index for the element at the start of the interval.
  *
  * @exception {DeveloperError} time must be in the range <code>[t<sub>0</sub>, t<sub>n</sub>]</code>, where <code>t<sub>0</sub></code>
  *                             is the first element in the array <code>times</code> and <code>t<sub>n</sub></code> is the last element
@@ -116,8 +116,8 @@ LinearSpline.prototype.findTimeInterval = Spline.prototype.findTimeInterval;
  * Wraps the given time to the period covered by the spline.
  * @function
  *
- * @param {Number} time The time.
- * @return {Number} The time, wrapped around to the updated animation.
+ * @param {number} time The time.
+ * @return {number} The time, wrapped around to the updated animation.
  */
 LinearSpline.prototype.wrapTime = Spline.prototype.wrapTime;
 
@@ -125,17 +125,17 @@ LinearSpline.prototype.wrapTime = Spline.prototype.wrapTime;
  * Clamps the given time to the period covered by the spline.
  * @function
  *
- * @param {Number} time The time.
- * @return {Number} The time, clamped to the animation period.
+ * @param {number} time The time.
+ * @return {number} The time, clamped to the animation period.
  */
 LinearSpline.prototype.clampTime = Spline.prototype.clampTime;
 
 /**
  * Evaluates the curve at a given time.
  *
- * @param {Number} time The time at which to evaluate the curve.
+ * @param {number} time The time at which to evaluate the curve.
  * @param {Cartesian3} [result] The object onto which to store the result.
- * @returns {Number|Cartesian3} The modified result parameter or a new instance of the point on the curve at the given time.
+ * @returns {number|Cartesian3} The modified result parameter or a new instance of the point on the curve at the given time.
  *
  * @exception {DeveloperError} time must be in the range <code>[t<sub>0</sub>, t<sub>n</sub>]</code>, where <code>t<sub>0</sub></code>
  *                             is the first element in the array <code>times</code> and <code>t<sub>n</sub></code> is the last element

package/Source/Core/ManagedArray.js

@@ -8,7 +8,7 @@ import defaultValue from "./defaultValue.js";
  * @constructor
  * @private
  *
- * @param {Number} [length=0] The initial length of the array.
+ * @param {number} [length=0] The initial length of the array.
  */
 function ManagedArray(length) {
   length = defaultValue(length, 0);
@@ -22,7 +22,7 @@ Object.defineProperties(ManagedArray.prototype, {
    * If the set length is greater than the length of the internal array, the internal array is resized.
    *
    * @memberof ManagedArray.prototype
-   * @type Number
+   * @type {number}
    */
   length: {
     get: function () {
@@ -50,7 +50,7 @@ Object.defineProperties(ManagedArray.prototype, {
    * Gets the internal array.
    *
    * @memberof ManagedArray.prototype
-   * @type Array
+   * @type {Array}
    * @readonly
    */
   values: {
@@ -63,7 +63,7 @@ Object.defineProperties(ManagedArray.prototype, {
 /**
  * Gets the element at an index.
  *
- * @param {Number} index The index to get.
+ * @param {number} index The index to get.
  */
 ManagedArray.prototype.get = function (index) {
   //>>includeStart('debug', pragmas.debug);
@@ -76,7 +76,7 @@ ManagedArray.prototype.get = function (index) {
 /**
  * Sets the element at an index. Resizes the array if index is greater than the length of the array.
  *
- * @param {Number} index The index to set.
+ * @param {number} index The index to set.
  * @param {*} element The element to set at index.
  */
 ManagedArray.prototype.set = function (index, element) {
@@ -126,7 +126,7 @@ ManagedArray.prototype.pop = function () {
 /**
  * Resize the internal array if length > _array.length.
  *
- * @param {Number} length The length.
+ * @param {number} length The length.
  */
 ManagedArray.prototype.reserve = function (length) {
   //>>includeStart('debug', pragmas.debug);
@@ -141,7 +141,7 @@ ManagedArray.prototype.reserve = function (length) {
 /**
  * Resize the array.
  *
- * @param {Number} length The length.
+ * @param {number} length The length.
  */
 ManagedArray.prototype.resize = function (length) {
   //>>includeStart('debug', pragmas.debug);
@@ -154,7 +154,7 @@ ManagedArray.prototype.resize = function (length) {
 /**
  * Trim the internal array to the specified length. Defaults to the current length.
  *
- * @param {Number} [length] The length.
+ * @param {number} [length] The length.
  */
 ManagedArray.prototype.trim = function (length) {
   length = defaultValue(length, this._length);