@cesium/engine 2.0.0 → 2.2.0

package/Source/Core/TimeIntervalCollection.js

@@ -61,7 +61,7 @@ Object.defineProperties(TimeIntervalCollection.prototype, {
   /**
    * Gets whether or not the start time is included in the collection.
    * @memberof TimeIntervalCollection.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   isStartIncluded: {
@@ -88,7 +88,7 @@ Object.defineProperties(TimeIntervalCollection.prototype, {
   /**
    * Gets whether or not the stop time is included in the collection.
    * @memberof TimeIntervalCollection.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   isStopIncluded: {
@@ -102,7 +102,7 @@ Object.defineProperties(TimeIntervalCollection.prototype, {
   /**
    * Gets the number of intervals in the collection.
    * @memberof TimeIntervalCollection.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   length: {
@@ -114,7 +114,7 @@ Object.defineProperties(TimeIntervalCollection.prototype, {
   /**
    * Gets whether or not the collection is empty.
    * @memberof TimeIntervalCollection.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   isEmpty: {
@@ -130,7 +130,7 @@ Object.defineProperties(TimeIntervalCollection.prototype, {
  *
  * @param {TimeIntervalCollection} [right] The right hand side collection.
  * @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.
  */
 TimeIntervalCollection.prototype.equals = function (right, dataComparer) {
   if (this === right) {
@@ -156,7 +156,7 @@ TimeIntervalCollection.prototype.equals = function (right, dataComparer) {
 /**
  * Gets the interval at the specified index.
  *
- * @param {Number} index The index of the interval to retrieve.
+ * @param {number} index The index of the interval to retrieve.
  * @returns {TimeInterval|undefined} The interval at the specified index, or <code>undefined</code> if no interval exists as that index.
  */
 TimeIntervalCollection.prototype.get = function (index) {
@@ -194,7 +194,7 @@ TimeIntervalCollection.prototype.findIntervalContainingDate = function (date) {
  * Finds and returns the data for the interval that contains the specified date.
  *
  * @param {JulianDate} date The date to search for.
- * @returns {Object} The data for the interval containing the specified date, or <code>undefined</code> if no such interval exists.
+ * @returns {object} The data for the interval containing the specified date, or <code>undefined</code> if no such interval exists.
  */
 TimeIntervalCollection.prototype.findDataForIntervalContainingDate = function (
   date
@@ -207,7 +207,7 @@ TimeIntervalCollection.prototype.findDataForIntervalContainingDate = function (
  * Checks if the specified date is inside this collection.
  *
  * @param {JulianDate} julianDate The date to check.
- * @returns {Boolean} <code>true</code> if the collection contains the specified date, <code>false</code> otherwise.
+ * @returns {boolean} <code>true</code> if the collection contains the specified date, <code>false</code> otherwise.
  */
 TimeIntervalCollection.prototype.contains = function (julianDate) {
   return this.indexOf(julianDate) >= 0;
@@ -219,7 +219,7 @@ const indexOfScratch = new TimeInterval();
  * Finds and returns the index of the interval in the collection that contains the specified date.
  *
  * @param {JulianDate} date The date to search for.
- * @returns {Number} The index of the interval that contains the specified date, if no such interval exists,
+ * @returns {number} The index of the interval that contains the specified date, if no such interval exists,
  * it returns a negative number which is the bitwise complement of the index of the next interval that
  * starts after the date, or if no interval starts after the specified date, the bitwise complement of
  * the length of the collection.
@@ -269,11 +269,11 @@ TimeIntervalCollection.prototype.indexOf = function (date) {
  * Returns the first interval in the collection that matches the specified parameters.
  * All parameters are optional and <code>undefined</code> parameters are treated as a don't care condition.
  *
- * @param {Object} [options] Object with the following properties:
+ * @param {object} [options] Object with the following properties:
  * @param {JulianDate} [options.start] The start time of the interval.
  * @param {JulianDate} [options.stop] The stop time of the interval.
- * @param {Boolean} [options.isStartIncluded] <code>true</code> if <code>options.start</code> is included in the interval, <code>false</code> otherwise.
- * @param {Boolean} [options.isStopIncluded] <code>true</code> if <code>options.stop</code> is included in the interval, <code>false</code> otherwise.
+ * @param {boolean} [options.isStartIncluded] <code>true</code> if <code>options.start</code> is included in the interval, <code>false</code> otherwise.
+ * @param {boolean} [options.isStopIncluded] <code>true</code> if <code>options.stop</code> is included in the interval, <code>false</code> otherwise.
  * @returns {TimeInterval|undefined} The first interval in the collection that matches the specified parameters.
  */
 TimeIntervalCollection.prototype.findInterval = function (options) {
@@ -505,7 +505,7 @@ TimeIntervalCollection.prototype.addInterval = function (
  * The data property of the input interval is ignored.
  *
  * @param {TimeInterval} interval The interval to remove.
- * @returns {Boolean} <code>true</code> if the interval was removed, <code>false</code> if no part of the interval was in the collection.
+ * @returns {boolean} <code>true</code> if the interval was removed, <code>false</code> if no part of the interval was in the collection.
  */
 TimeIntervalCollection.prototype.removeInterval = function (interval) {
   //>>includeStart('debug', pragmas.debug);
@@ -731,12 +731,12 @@ TimeIntervalCollection.prototype.intersect = function (
 /**
  * Creates a new instance from a JulianDate array.
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {JulianDate[]} options.julianDates An array of ISO 8601 dates.
- * @param {Boolean} [options.isStartIncluded=true] <code>true</code> if start time is included in the interval, <code>false</code> otherwise.
- * @param {Boolean} [options.isStopIncluded=true] <code>true</code> if stop time is included in the interval, <code>false</code> otherwise.
- * @param {Boolean} [options.leadingInterval=false] <code>true</code> if you want to add a interval from Iso8601.MINIMUM_VALUE to start time,  <code>false</code> otherwise.
- * @param {Boolean} [options.trailingInterval=false] <code>true</code> if you want to add a interval from stop time to Iso8601.MAXIMUM_VALUE,  <code>false</code> otherwise.
+ * @param {boolean} [options.isStartIncluded=true] <code>true</code> if start time is included in the interval, <code>false</code> otherwise.
+ * @param {boolean} [options.isStopIncluded=true] <code>true</code> if stop time is included in the interval, <code>false</code> otherwise.
+ * @param {boolean} [options.leadingInterval=false] <code>true</code> if you want to add a interval from Iso8601.MINIMUM_VALUE to start time,  <code>false</code> otherwise.
+ * @param {boolean} [options.trailingInterval=false] <code>true</code> if you want to add a interval from stop time to Iso8601.MAXIMUM_VALUE,  <code>false</code> otherwise.
  * @param {Function} [options.dataCallback] A function that will be return the data that is called with each interval before it is added to the collection. If unspecified, the data will be the index in the collection.
  * @param {TimeIntervalCollection} [result] An existing instance to use for the result.
  * @returns {TimeIntervalCollection} The modified result parameter or a new instance if none was provided.
@@ -898,9 +898,9 @@ const durationRegex = /P(?:([\d.,]+)Y)?(?:([\d.,]+)M)?(?:([\d.,]+)W)?(?:([\d.,]+
 /**
  * Parses ISO8601 duration string
  *
- * @param {String} iso8601 An ISO 8601 duration.
+ * @param {string} iso8601 An ISO 8601 duration.
  * @param {GregorianDate} result An existing instance to use for the result.
- * @returns {Boolean} True is parsing succeeded, false otherwise
+ * @returns {boolean} True is parsing succeeded, false otherwise
  *
  * @private
  */
@@ -981,12 +981,12 @@ const scratchDuration = new GregorianDate();
 /**
  * Creates a new instance from an {@link http://en.wikipedia.org/wiki/ISO_8601|ISO 8601} time interval (start/end/duration).
  *
- * @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 start time is included in the interval, <code>false</code> otherwise.
- * @param {Boolean} [options.isStopIncluded=true] <code>true</code> if stop time is included in the interval, <code>false</code> otherwise.
- * @param {Boolean} [options.leadingInterval=false] <code>true</code> if you want to add a interval from Iso8601.MINIMUM_VALUE to start time,  <code>false</code> otherwise.
- * @param {Boolean} [options.trailingInterval=false] <code>true</code> if you want to add a interval from stop time to Iso8601.MAXIMUM_VALUE,  <code>false</code> otherwise.
+ * @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 start time is included in the interval, <code>false</code> otherwise.
+ * @param {boolean} [options.isStopIncluded=true] <code>true</code> if stop time is included in the interval, <code>false</code> otherwise.
+ * @param {boolean} [options.leadingInterval=false] <code>true</code> if you want to add a interval from Iso8601.MINIMUM_VALUE to start time,  <code>false</code> otherwise.
+ * @param {boolean} [options.trailingInterval=false] <code>true</code> if you want to add a interval from stop time to Iso8601.MAXIMUM_VALUE,  <code>false</code> otherwise.
  * @param {Function} [options.dataCallback] A function that will be return the data that is called with each interval before it is added to the collection. If unspecified, the data will be the index in the collection.
  * @param {TimeIntervalCollection} [result] An existing instance to use for the result.
  * @returns {TimeIntervalCollection} The modified result parameter or a new instance if none was provided.
@@ -1038,12 +1038,12 @@ TimeIntervalCollection.fromIso8601 = function (options, result) {
 /**
  * Creates a new instance from a {@link http://en.wikipedia.org/wiki/ISO_8601|ISO 8601} date array.
  *
- * @param {Object} options Object with the following properties:
- * @param {String[]} options.iso8601Dates An array of ISO 8601 dates.
- * @param {Boolean} [options.isStartIncluded=true] <code>true</code> if start time is included in the interval, <code>false</code> otherwise.
- * @param {Boolean} [options.isStopIncluded=true] <code>true</code> if stop time is included in the interval, <code>false</code> otherwise.
- * @param {Boolean} [options.leadingInterval=false] <code>true</code> if you want to add a interval from Iso8601.MINIMUM_VALUE to start time,  <code>false</code> otherwise.
- * @param {Boolean} [options.trailingInterval=false] <code>true</code> if you want to add a interval from stop time to Iso8601.MAXIMUM_VALUE,  <code>false</code> otherwise.
+ * @param {object} options Object with the following properties:
+ * @param {string[]} options.iso8601Dates An array of ISO 8601 dates.
+ * @param {boolean} [options.isStartIncluded=true] <code>true</code> if start time is included in the interval, <code>false</code> otherwise.
+ * @param {boolean} [options.isStopIncluded=true] <code>true</code> if stop time is included in the interval, <code>false</code> otherwise.
+ * @param {boolean} [options.leadingInterval=false] <code>true</code> if you want to add a interval from Iso8601.MINIMUM_VALUE to start time,  <code>false</code> otherwise.
+ * @param {boolean} [options.trailingInterval=false] <code>true</code> if you want to add a interval from stop time to Iso8601.MAXIMUM_VALUE,  <code>false</code> otherwise.
  * @param {Function} [options.dataCallback] A function that will be return the data that is called with each interval before it is added to the collection. If unspecified, the data will be the index in the collection.
  * @param {TimeIntervalCollection} [result] An existing instance to use for the result.
  * @returns {TimeIntervalCollection} The modified result parameter or a new instance if none was provided.
@@ -1076,14 +1076,14 @@ TimeIntervalCollection.fromIso8601DateArray = function (options, result) {
 /**
  * Creates a new instance from a {@link http://en.wikipedia.org/wiki/ISO_8601|ISO 8601} duration array.
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {JulianDate} options.epoch An date that the durations are relative to.
- * @param {String} options.iso8601Durations An array of ISO 8601 durations.
- * @param {Boolean} [options.relativeToPrevious=false] <code>true</code> if durations are relative to previous date, <code>false</code> if always relative to the epoch.
- * @param {Boolean} [options.isStartIncluded=true] <code>true</code> if start time is included in the interval, <code>false</code> otherwise.
- * @param {Boolean} [options.isStopIncluded=true] <code>true</code> if stop time is included in the interval, <code>false</code> otherwise.
- * @param {Boolean} [options.leadingInterval=false] <code>true</code> if you want to add a interval from Iso8601.MINIMUM_VALUE to start time,  <code>false</code> otherwise.
- * @param {Boolean} [options.trailingInterval=false] <code>true</code> if you want to add a interval from stop time to Iso8601.MAXIMUM_VALUE,  <code>false</code> otherwise.
+ * @param {string} options.iso8601Durations An array of ISO 8601 durations.
+ * @param {boolean} [options.relativeToPrevious=false] <code>true</code> if durations are relative to previous date, <code>false</code> if always relative to the epoch.
+ * @param {boolean} [options.isStartIncluded=true] <code>true</code> if start time is included in the interval, <code>false</code> otherwise.
+ * @param {boolean} [options.isStopIncluded=true] <code>true</code> if stop time is included in the interval, <code>false</code> otherwise.
+ * @param {boolean} [options.leadingInterval=false] <code>true</code> if you want to add a interval from Iso8601.MINIMUM_VALUE to start time,  <code>false</code> otherwise.
+ * @param {boolean} [options.trailingInterval=false] <code>true</code> if you want to add a interval from stop time to Iso8601.MAXIMUM_VALUE,  <code>false</code> otherwise.
  * @param {Function} [options.dataCallback] A function that will be return the data that is called with each interval before it is added to the collection. If unspecified, the data will be the index in the collection.
  * @param {TimeIntervalCollection} [result] An existing instance to use for the result.
  * @returns {TimeIntervalCollection} The modified result parameter or a new instance if none was provided.

package/Source/Core/TimeStandard.js

@@ -1,7 +1,7 @@
 /**
  * Provides the type of time standards which JulianDate can take as input.
  *
- * @enum {Number}
+ * @enum {number}
  *
  * @see JulianDate
  */
@@ -13,7 +13,7 @@ const TimeStandard = {
    * <code>UTC = TAI - deltaT</code> where <code>deltaT</code> is the number of leap
    * seconds which have been introduced as of the time in TAI.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   UTC: 0,
@@ -22,7 +22,7 @@ const TimeStandard = {
    * Represents the International Atomic Time (TAI) time standard.
    * TAI is the principal time standard to which the other time standards are related.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   TAI: 1,

package/Source/Core/Tipsify.js

@@ -21,13 +21,13 @@ const Tipsify = {};
 /**
  * Calculates the average cache miss ratio (ACMR) for a given set of indices.
  *
- * @param {Object} options Object with the following properties:
- * @param {Number[]} options.indices Lists triads of numbers corresponding to the indices of the vertices
+ * @param {object} options Object with the following properties:
+ * @param {number[]} options.indices Lists triads of numbers corresponding to the indices of the vertices
  *                        in the vertex buffer that define the geometry's triangles.
- * @param {Number} [options.maximumIndex] The maximum value of the elements in <code>args.indices</code>.
+ * @param {number} [options.maximumIndex] The maximum value of the elements in <code>args.indices</code>.
  *                                     If not supplied, this value will be computed.
- * @param {Number} [options.cacheSize=24] The number of vertices that can be stored in the cache at any one time.
- * @returns {Number} The average cache miss ratio (ACMR).
+ * @param {number} [options.cacheSize=24] The number of vertices that can be stored in the cache at any one time.
+ * @returns {number} The average cache miss ratio (ACMR).
  *
  * @exception {DeveloperError} indices length must be a multiple of three.
  * @exception {DeveloperError} cacheSize must be greater than two.
@@ -99,13 +99,13 @@ Tipsify.calculateACMR = function (options) {
 /**
  * Optimizes triangles for the post-vertex shader cache.
  *
- * @param {Object} options Object with the following properties:
- * @param {Number[]} options.indices Lists triads of numbers corresponding to the indices of the vertices
+ * @param {object} options Object with the following properties:
+ * @param {number[]} options.indices Lists triads of numbers corresponding to the indices of the vertices
  *                        in the vertex buffer that define the geometry's triangles.
- * @param {Number} [options.maximumIndex] The maximum value of the elements in <code>args.indices</code>.
+ * @param {number} [options.maximumIndex] The maximum value of the elements in <code>args.indices</code>.
  *                                     If not supplied, this value will be computed.
- * @param {Number} [options.cacheSize=24] The number of vertices that can be stored in the cache at any one time.
- * @returns {Number[]} A list of the input indices in an optimized order.
+ * @param {number} [options.cacheSize=24] The number of vertices that can be stored in the cache at any one time.
+ * @returns {number[]} A list of the input indices in an optimized order.
  *
  * @exception {DeveloperError} indices length must be a multiple of three.
  * @exception {DeveloperError} cacheSize must be greater than two.

package/Source/Core/Transforms.js

@@ -90,9 +90,9 @@ let scratchThirdCartesian = new Cartesian3();
 /**
  * Generates a function that computes a 4x4 transformation matrix from a reference frame
  * centered at the provided origin to the provided ellipsoid's fixed reference frame.
- * @param  {String} firstAxis  name of the first axis of the local reference frame. Must be
+ * @param  {string} firstAxis  name of the first axis of the local reference frame. Must be
  *  'east', 'north', 'up', 'west', 'south' or 'down'.
- * @param  {String} secondAxis  name of the second axis of the local reference frame. Must be
+ * @param  {string} secondAxis  name of the second axis of the local reference frame. Must be
  *  'east', 'north', 'up', 'west', 'south' or 'down'.
  * @return {Transforms.LocalFrameToFixedFrame} The function that will computes a
  * 4x4 transformation matrix from a reference frame, with first axis and second axis compliant with the parameters,

package/Source/Core/TranslationRotationScale.js

@@ -46,7 +46,7 @@ function TranslationRotationScale(translation, rotation, scale) {
  * <code>true</code> if they are equal, <code>false</code> otherwise.
  *
  * @param {TranslationRotationScale} [right] The right hand side TranslationRotationScale.
- * @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.
  */
 TranslationRotationScale.prototype.equals = function (right) {
   return (

package/Source/Core/TridiagonalSystemSolver.js

@@ -13,9 +13,9 @@ const TridiagonalSystemSolver = {};
 /**
  * Solves a tridiagonal system of linear equations.
  *
- * @param {Number[]} diagonal An array with length <code>n</code> that contains the diagonal of the coefficient matrix.
- * @param {Number[]} lower An array with length <code>n - 1</code> that contains the lower diagonal of the coefficient matrix.
- * @param {Number[]} upper An array with length <code>n - 1</code> that contains the upper diagonal of the coefficient matrix.
+ * @param {number[]} diagonal An array with length <code>n</code> that contains the diagonal of the coefficient matrix.
+ * @param {number[]} lower An array with length <code>n - 1</code> that contains the lower diagonal of the coefficient matrix.
+ * @param {number[]} upper An array with length <code>n - 1</code> that contains the upper diagonal of the coefficient matrix.
  * @param {Cartesian3[]} right An array of Cartesians with length <code>n</code> that is the right side of the system of equations.
  *
  * @exception {DeveloperError} diagonal and right must have the same lengths.

package/Source/Core/TrustedServers.js

@@ -16,8 +16,8 @@ let _servers = {};
 /**
  * Adds a trusted server to the registry
  *
- * @param {String} host The host to be added.
- * @param {Number} port The port used to access the host.
+ * @param {string} host The host to be added.
+ * @param {number} port The port used to access the host.
  *
  * @example
  * // Add a trusted server
@@ -42,8 +42,8 @@ TrustedServers.add = function (host, port) {
 /**
  * Removes a trusted server from the registry
  *
- * @param {String} host The host to be removed.
- * @param {Number} port The port used to access the host.
+ * @param {string} host The host to be removed.
+ * @param {number} port The port used to access the host.
  *
  * @example
  * // Remove a trusted server
@@ -103,7 +103,7 @@ function getAuthority(url) {
 /**
  * Tests whether a server is trusted or not. The server must have been added with the port if it is included in the url.
  *
- * @param {String} url The url to be tested against the trusted list
+ * @param {string} url The url to be tested against the trusted list
  *
  * @returns {boolean} Returns true if url is trusted, false otherwise.
  *