@cesium/engine 2.0.0 → 2.2.0

package/Source/Core/RectangleGeometry.js

@@ -975,15 +975,15 @@ function computeRectangle(rectangle, granularity, rotation, ellipsoid, result) {
  * @alias RectangleGeometry
  * @constructor
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Rectangle} options.rectangle A cartographic rectangle with north, south, east and west properties in radians.
  * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed.
  * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the rectangle lies.
- * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
- * @param {Number} [options.height=0.0] The distance in meters between the rectangle and the ellipsoid surface.
- * @param {Number} [options.rotation=0.0] The rotation of the rectangle, in radians. A positive rotation is counter-clockwise.
- * @param {Number} [options.stRotation=0.0] The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise.
- * @param {Number} [options.extrudedHeight] The distance in meters between the rectangle's extruded face and the ellipsoid surface.
+ * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
+ * @param {number} [options.height=0.0] The distance in meters between the rectangle and the ellipsoid surface.
+ * @param {number} [options.rotation=0.0] The rotation of the rectangle, in radians. A positive rotation is counter-clockwise.
+ * @param {number} [options.stRotation=0.0] The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise.
+ * @param {number} [options.extrudedHeight] The distance in meters between the rectangle's extruded face and the ellipsoid surface.
  *
  * @exception {DeveloperError} <code>options.rectangle.north</code> must be in the interval [<code>-Pi/2</code>, <code>Pi/2</code>].
  * @exception {DeveloperError} <code>options.rectangle.south</code> must be in the interval [<code>-Pi/2</code>, <code>Pi/2</code>].
@@ -1056,7 +1056,7 @@ function RectangleGeometry(options) {
 
 /**
  * The number of elements used to pack the object into an array.
- * @type {Number}
+ * @type {number}
  */
 RectangleGeometry.packedLength =
   Rectangle.packedLength +
@@ -1068,10 +1068,10 @@ RectangleGeometry.packedLength =
  * Stores the provided instance into the provided array.
  *
  * @param {RectangleGeometry} value The value to pack.
- * @param {Number[]} array The array to pack into.
- * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements.
+ * @param {number[]} array The array to pack into.
+ * @param {number} [startingIndex=0] The index into the array at which to start packing the elements.
  *
- * @returns {Number[]} The array that was packed into
+ * @returns {number[]} The array that was packed into
  */
 RectangleGeometry.pack = function (value, array, startingIndex) {
   //>>includeStart('debug', pragmas.debug);
@@ -1119,8 +1119,8 @@ const scratchOptions = {
 /**
  * Retrieves an instance from a packed array.
  *
- * @param {Number[]} array The packed array.
- * @param {Number} [startingIndex=0] The starting index of the element to be unpacked.
+ * @param {number[]} array The packed array.
+ * @param {number} [startingIndex=0] The starting index of the element to be unpacked.
  * @param {RectangleGeometry} [result] The object into which to store the result.
  * @returns {RectangleGeometry} The modified result parameter or a new RectangleGeometry instance if one was not provided.
  */
@@ -1183,11 +1183,11 @@ RectangleGeometry.unpack = function (array, startingIndex, result) {
 /**
  * Computes the bounding rectangle based on the provided options
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Rectangle} options.rectangle A cartographic rectangle with north, south, east and west properties in radians.
  * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the rectangle lies.
- * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
- * @param {Number} [options.rotation=0.0] The rotation of the rectangle, in radians. A positive rotation is counter-clockwise.
+ * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
+ * @param {number} [options.rotation=0.0] The rotation of the rectangle, in radians. A positive rotation is counter-clockwise.
  * @param {Rectangle} [result] An object in which to store the result.
  *
  * @returns {Rectangle} The result rectangle

package/Source/Core/RectangleOutlineGeometry.js

@@ -247,13 +247,13 @@ function constructExtrudedRectangle(rectangleGeometry, computedOptions) {
  * @alias RectangleOutlineGeometry
  * @constructor
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Rectangle} options.rectangle A cartographic rectangle with north, south, east and west properties in radians.
  * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the rectangle lies.
- * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
- * @param {Number} [options.height=0.0] The distance in meters between the rectangle and the ellipsoid surface.
- * @param {Number} [options.rotation=0.0] The rotation of the rectangle, in radians. A positive rotation is counter-clockwise.
- * @param {Number} [options.extrudedHeight] The distance in meters between the rectangle's extruded face and the ellipsoid surface.
+ * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
+ * @param {number} [options.height=0.0] The distance in meters between the rectangle and the ellipsoid surface.
+ * @param {number} [options.rotation=0.0] The rotation of the rectangle, in radians. A positive rotation is counter-clockwise.
+ * @param {number} [options.extrudedHeight] The distance in meters between the rectangle's extruded face and the ellipsoid surface.
  *
  * @exception {DeveloperError} <code>options.rectangle.north</code> must be in the interval [<code>-Pi/2</code>, <code>Pi/2</code>].
  * @exception {DeveloperError} <code>options.rectangle.south</code> must be in the interval [<code>-Pi/2</code>, <code>Pi/2</code>].
@@ -309,7 +309,7 @@ function RectangleOutlineGeometry(options) {
 
 /**
  * The number of elements used to pack the object into an array.
- * @type {Number}
+ * @type {number}
  */
 RectangleOutlineGeometry.packedLength =
   Rectangle.packedLength + Ellipsoid.packedLength + 5;
@@ -318,10 +318,10 @@ RectangleOutlineGeometry.packedLength =
  * Stores the provided instance into the provided array.
  *
  * @param {RectangleOutlineGeometry} value The value to pack.
- * @param {Number[]} array The array to pack into.
- * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements.
+ * @param {number[]} array The array to pack into.
+ * @param {number} [startingIndex=0] The index into the array at which to start packing the elements.
  *
- * @returns {Number[]} The array that was packed into
+ * @returns {number[]} The array that was packed into
  */
 RectangleOutlineGeometry.pack = function (value, array, startingIndex) {
   //>>includeStart('debug', pragmas.debug);
@@ -366,8 +366,8 @@ const scratchOptions = {
 /**
  * Retrieves an instance from a packed array.
  *
- * @param {Number[]} array The packed array.
- * @param {Number} [startingIndex=0] The starting index of the element to be unpacked.
+ * @param {number[]} array The packed array.
+ * @param {number} [startingIndex=0] The starting index of the element to be unpacked.
  * @param {RectangleOutlineGeometry} [result] The object into which to store the result.
  * @returns {RectangleOutlineGeometry} The modified result parameter or a new Quaternion instance if one was not provided.
  */

package/Source/Core/ReferenceFrame.js

@@ -1,13 +1,13 @@
 /**
  * Constants for identifying well-known reference frames.
  *
- * @enum {Number}
+ * @enum {number}
  */
 const ReferenceFrame = {
   /**
    * The fixed frame.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   FIXED: 0,
@@ -15,7 +15,7 @@ const ReferenceFrame = {
   /**
    * The inertial frame.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   INERTIAL: 1,

package/Source/Core/Request.js

@@ -9,14 +9,14 @@ import RequestType from "./RequestType.js";
  * @alias Request
  * @constructor
 
- * @param {Object} [options] An object with the following properties:
- * @param {String} [options.url] The url to request.
+ * @param {object} [options] An object with the following properties:
+ * @param {string} [options.url] The url to request.
  * @param {Request.RequestCallback} [options.requestFunction] The function that makes the actual data request.
  * @param {Request.CancelCallback} [options.cancelFunction] The function that is called when the request is cancelled.
  * @param {Request.PriorityCallback} [options.priorityFunction] The function that is called to update the request's priority, which occurs once per frame.
- * @param {Number} [options.priority=0.0] The initial priority of the request.
- * @param {Boolean} [options.throttle=false] Whether to throttle and prioritize the request. If false, the request will be sent immediately. If true, the request will be throttled and sent based on priority.
- * @param {Boolean} [options.throttleByServer=false] Whether to throttle the request by server.
+ * @param {number} [options.priority=0.0] The initial priority of the request.
+ * @param {boolean} [options.throttle=false] Whether to throttle and prioritize the request. If false, the request will be sent immediately. If true, the request will be throttled and sent based on priority.
+ * @param {boolean} [options.throttleByServer=false] Whether to throttle the request by server.
  * @param {RequestType} [options.type=RequestType.OTHER] The type of request.
  */
 function Request(options) {
@@ -28,7 +28,7 @@ function Request(options) {
   /**
    * The URL to request.
    *
-   * @type {String}
+   * @type {string}
    */
   this.url = options.url;
 
@@ -60,7 +60,7 @@ function Request(options) {
    *
    * If priorityFunction is defined, this value is updated every frame with the result of that call.
    *
-   * @type {Number}
+   * @type {number}
    * @default 0.0
    */
   this.priority = defaultValue(options.priority, 0.0);
@@ -69,7 +69,7 @@ function Request(options) {
    * Whether to throttle and prioritize the request. If false, the request will be sent immediately. If true, the
    * request will be throttled and sent based on priority.
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @default false
@@ -81,7 +81,7 @@ function Request(options) {
    * for HTTP/1 servers, and an unlimited amount of connections for HTTP/2 servers. Setting this value
    * to <code>true</code> is preferable for requests going through HTTP/1 servers.
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @default false
@@ -101,7 +101,7 @@ function Request(options) {
   /**
    * A key used to identify the server that a request is going to. It is derived from the url's authority and scheme.
    *
-   * @type {String}
+   * @type {string}
    *
    * @private
    */
@@ -118,7 +118,7 @@ function Request(options) {
   /**
    * The requests's deferred promise.
    *
-   * @type {Object}
+   * @type {object}
    *
    * @private
    */
@@ -127,7 +127,7 @@ function Request(options) {
   /**
    * Whether the request was explicitly cancelled.
    *
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @private
    */
@@ -187,6 +187,6 @@ Request.prototype.clone = function (result) {
 /**
  * The function that is called to update the request's priority, which occurs once per frame.
  * @callback Request.PriorityCallback
- * @returns {Number} The updated priority value.
+ * @returns {number} The updated priority value.
  */
 export default Request;

package/Source/Core/RequestErrorEvent.js

@@ -7,9 +7,9 @@ import parseResponseHeaders from "./parseResponseHeaders.js";
  * @constructor
  * @alias RequestErrorEvent
  *
- * @param {Number} [statusCode] The HTTP error status code, such as 404.
- * @param {Object} [response] The response included along with the error.
- * @param {String|Object} [responseHeaders] The response headers, represented either as an object literal or as a
+ * @param {number} [statusCode] The HTTP error status code, such as 404.
+ * @param {object} [response] The response included along with the error.
+ * @param {string|object} [responseHeaders] The response headers, represented either as an object literal or as a
  *                        string in the format returned by XMLHttpRequest's getAllResponseHeaders() function.
  */
 function RequestErrorEvent(statusCode, response, responseHeaders) {
@@ -17,7 +17,7 @@ function RequestErrorEvent(statusCode, response, responseHeaders) {
    * The HTTP error status code, such as 404.  If the error does not have a particular
    * HTTP code, this property will be undefined.
    *
-   * @type {Number}
+   * @type {number}
    */
   this.statusCode = statusCode;
 
@@ -25,7 +25,7 @@ function RequestErrorEvent(statusCode, response, responseHeaders) {
    * The response included along with the error.  If the error does not include a response,
    * this property will be undefined.
    *
-   * @type {Object}
+   * @type {object}
    */
   this.response = response;
 
@@ -33,7 +33,7 @@ function RequestErrorEvent(statusCode, response, responseHeaders) {
    * The headers included in the response, represented as an object literal of key/value pairs.
    * If the error does not include any headers, this property will be undefined.
    *
-   * @type {Object}
+   * @type {object}
    */
   this.responseHeaders = responseHeaders;
 
@@ -46,7 +46,7 @@ function RequestErrorEvent(statusCode, response, responseHeaders) {
  * Creates a string representing this RequestErrorEvent.
  * @memberof RequestErrorEvent
  *
- * @returns {String} A string representing the provided RequestErrorEvent.
+ * @returns {string} A string representing the provided RequestErrorEvent.
  */
 RequestErrorEvent.prototype.toString = function () {
   let str = "Request has failed.";

package/Source/Core/RequestScheduler.js

@@ -51,7 +51,7 @@ function RequestScheduler() {}
 
 /**
  * The maximum number of simultaneous active requests. Un-throttled requests do not observe this limit.
- * @type {Number}
+ * @type {number}
  * @default 50
  */
 RequestScheduler.maximumRequests = 50;
@@ -59,14 +59,14 @@ RequestScheduler.maximumRequests = 50;
 /**
  * The maximum number of simultaneous active requests per server. Un-throttled requests or servers specifically
  * listed in {@link requestsByServer} do not observe this limit.
- * @type {Number}
+ * @type {number}
  * @default 6
  */
 RequestScheduler.maximumRequestsPerServer = 6;
 
 /**
  * A per server key list of overrides to use for throttling instead of <code>maximumRequestsPerServer</code>
- * @type {Object}
+ * @type {object}
  *
  * @example
  * RequestScheduler.requestsByServer = {
@@ -76,19 +76,19 @@ RequestScheduler.maximumRequestsPerServer = 6;
  */
 RequestScheduler.requestsByServer = {
   "api.cesium.com:443": 18,
-  "assets.cesium.com:443": 18,
+  "assets.ion.cesium.com:443": 18,
 };
 
 /**
  * Specifies if the request scheduler should throttle incoming requests, or let the browser queue requests under its control.
- * @type {Boolean}
+ * @type {boolean}
  * @default true
  */
 RequestScheduler.throttleRequests = true;
 
 /**
  * When true, log statistics to the console every frame
- * @type {Boolean}
+ * @type {boolean}
  * @default false
  * @private
  */
@@ -110,7 +110,7 @@ Object.defineProperties(RequestScheduler, {
    *
    * @memberof RequestScheduler
    *
-   * @type Object
+   * @type {object}
    * @readonly
    * @private
    */
@@ -125,7 +125,7 @@ Object.defineProperties(RequestScheduler, {
    *
    * @memberof RequestScheduler
    *
-   * @type {Number}
+   * @type {number}
    * @default 20
    * @private
    */
@@ -157,9 +157,9 @@ function updatePriority(request) {
 
 /**
  * Check if there are open slots for a particular server key. If desiredRequests is greater than 1, this checks if the queue has room for scheduling multiple requests.
- * @param {String} serverKey The server key returned by {@link RequestScheduler.getServerKey}.
- * @param {Number} [desiredRequests=1] How many requests the caller plans to request
- * @return {Boolean} True if there are enough open slots for <code>desiredRequests</code> more requests.
+ * @param {string} serverKey The server key returned by {@link RequestScheduler.getServerKey}.
+ * @param {number} [desiredRequests=1] How many requests the caller plans to request
+ * @return {boolean} True if there are enough open slots for <code>desiredRequests</code> more requests.
  * @private
  */
 RequestScheduler.serverHasOpenSlots = function (serverKey, desiredRequests) {
@@ -179,8 +179,8 @@ RequestScheduler.serverHasOpenSlots = function (serverKey, desiredRequests) {
  * Check if the priority heap has open slots, regardless of which server they
  * are from. This is used in {@link Multiple3DTileContent} for determining when
  * all requests can be scheduled
- * @param {Number} desiredRequests The number of requests the caller intends to make
- * @return {Boolean} <code>true</code> if the heap has enough available slots to meet the desiredRequests. <code>false</code> otherwise.
+ * @param {number} desiredRequests The number of requests the caller intends to make
+ * @return {boolean} <code>true</code> if the heap has enough available slots to meet the desiredRequests. <code>false</code> otherwise.
  *
  * @private
  */
@@ -341,8 +341,8 @@ RequestScheduler.update = function () {
 /**
  * Get the server key from a given url.
  *
- * @param {String} url The url.
- * @returns {String} The server key.
+ * @param {string} url The url.
+ * @returns {string} The server key.
  * @private
  */
 RequestScheduler.getServerKey = function (url) {

package/Source/Core/RequestState.js

@@ -1,13 +1,13 @@
 /**
  * State of the request.
  *
- * @enum {Number}
+ * @enum {number}
  */
 const RequestState = {
   /**
    * Initial unissued state.
    *
-   * @type Number
+   * @type {number}
    * @constant
    */
   UNISSUED: 0,
@@ -15,7 +15,7 @@ const RequestState = {
   /**
    * Issued but not yet active. Will become active when open slots are available.
    *
-   * @type Number
+   * @type {number}
    * @constant
    */
   ISSUED: 1,
@@ -23,7 +23,7 @@ const RequestState = {
   /**
    * Actual http request has been sent.
    *
-   * @type Number
+   * @type {number}
    * @constant
    */
   ACTIVE: 2,
@@ -31,7 +31,7 @@ const RequestState = {
   /**
    * Request completed successfully.
    *
-   * @type Number
+   * @type {number}
    * @constant
    */
   RECEIVED: 3,
@@ -39,7 +39,7 @@ const RequestState = {
   /**
    * Request was cancelled, either explicitly or automatically because of low priority.
    *
-   * @type Number
+   * @type {number}
    * @constant
    */
   CANCELLED: 4,
@@ -47,7 +47,7 @@ const RequestState = {
   /**
    * Request failed.
    *
-   * @type Number
+   * @type {number}
    * @constant
    */
   FAILED: 5,

package/Source/Core/RequestType.js

@@ -1,13 +1,13 @@
 /**
  * An enum identifying the type of request. Used for finer grained logging and priority sorting.
  *
- * @enum {Number}
+ * @enum {number}
  */
 const RequestType = {
   /**
    * Terrain request.
    *
-   * @type Number
+   * @type {number}
    * @constant
    */
   TERRAIN: 0,
@@ -15,7 +15,7 @@ const RequestType = {
   /**
    * Imagery request.
    *
-   * @type Number
+   * @type {number}
    * @constant
    */
   IMAGERY: 1,
@@ -23,7 +23,7 @@ const RequestType = {
   /**
    * 3D Tiles request.
    *
-   * @type Number
+   * @type {number}
    * @constant
    */
   TILES3D: 2,
@@ -31,7 +31,7 @@ const RequestType = {
   /**
    * Other request.
    *
-   * @type Number
+   * @type {number}
    * @constant
    */
   OTHER: 3,