@cesium/engine 2.0.0 → 2.2.0

package/Source/Scene/BingMapsStyle.js

@@ -1,7 +1,7 @@
 /**
  * The types of imagery provided by Bing Maps.
  *
- * @enum {Number}
+ * @enum {number}
  *
  * @see BingMapsImageryProvider
  */
@@ -9,7 +9,7 @@ const BingMapsStyle = {
   /**
    * Aerial imagery.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   AERIAL: "Aerial",
@@ -17,7 +17,7 @@ const BingMapsStyle = {
   /**
    * Aerial imagery with a road overlay.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @deprecated See https://github.com/CesiumGS/cesium/issues/7128.
    * Use `BingMapsStyle.AERIAL_WITH_LABELS_ON_DEMAND` instead
@@ -27,7 +27,7 @@ const BingMapsStyle = {
   /**
    * Aerial imagery with a road overlay.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   AERIAL_WITH_LABELS_ON_DEMAND: "AerialWithLabelsOnDemand",
@@ -35,7 +35,7 @@ const BingMapsStyle = {
   /**
    * Roads without additional imagery.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @deprecated See https://github.com/CesiumGS/cesium/issues/7128.
    * Use `BingMapsStyle.ROAD_ON_DEMAND` instead
@@ -45,7 +45,7 @@ const BingMapsStyle = {
   /**
    * Roads without additional imagery.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   ROAD_ON_DEMAND: "RoadOnDemand",
@@ -53,7 +53,7 @@ const BingMapsStyle = {
   /**
    * A dark version of the road maps.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   CANVAS_DARK: "CanvasDark",
@@ -61,7 +61,7 @@ const BingMapsStyle = {
   /**
    * A lighter version of the road maps.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   CANVAS_LIGHT: "CanvasLight",
@@ -69,7 +69,7 @@ const BingMapsStyle = {
   /**
    * A grayscale version of the road maps.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   CANVAS_GRAY: "CanvasGray",
@@ -77,7 +77,7 @@ const BingMapsStyle = {
   /**
    * Ordnance Survey imagery. This imagery is visible only for the London, UK area.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   ORDNANCE_SURVEY: "OrdnanceSurvey",
@@ -85,7 +85,7 @@ const BingMapsStyle = {
   /**
    * Collins Bart imagery.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   COLLINS_BART: "CollinsBart",

package/Source/Scene/BlendEquation.js

@@ -3,13 +3,13 @@ import WebGLConstants from "../Core/WebGLConstants.js";
 /**
  * Determines how two pixels' values are combined.
  *
- * @enum {Number}
+ * @enum {number}
  */
 const BlendEquation = {
   /**
    * Pixel values are added componentwise.  This is used in additive blending for translucency.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   ADD: WebGLConstants.FUNC_ADD,
@@ -17,7 +17,7 @@ const BlendEquation = {
   /**
    * Pixel values are subtracted componentwise (source - destination).  This is used in alpha blending for translucency.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   SUBTRACT: WebGLConstants.FUNC_SUBTRACT,
@@ -25,7 +25,7 @@ const BlendEquation = {
   /**
    * Pixel values are subtracted componentwise (destination - source).
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   REVERSE_SUBTRACT: WebGLConstants.FUNC_REVERSE_SUBTRACT,
@@ -35,7 +35,7 @@ const BlendEquation = {
    *
    * This equation operates on each pixel color component.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   MIN: WebGLConstants.MIN,
@@ -45,7 +45,7 @@ const BlendEquation = {
    *
    * This equation operates on each pixel color component.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   MAX: WebGLConstants.MAX,

package/Source/Scene/BlendFunction.js

@@ -3,13 +3,13 @@ import WebGLConstants from "../Core/WebGLConstants.js";
 /**
  * Determines how blending factors are computed.
  *
- * @enum {Number}
+ * @enum {number}
  */
 const BlendFunction = {
   /**
    * The blend factor is zero.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   ZERO: WebGLConstants.ZERO,
@@ -17,7 +17,7 @@ const BlendFunction = {
   /**
    * The blend factor is one.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   ONE: WebGLConstants.ONE,
@@ -25,7 +25,7 @@ const BlendFunction = {
   /**
    * The blend factor is the source color.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   SOURCE_COLOR: WebGLConstants.SRC_COLOR,
@@ -33,7 +33,7 @@ const BlendFunction = {
   /**
    * The blend factor is one minus the source color.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   ONE_MINUS_SOURCE_COLOR: WebGLConstants.ONE_MINUS_SRC_COLOR,
@@ -41,7 +41,7 @@ const BlendFunction = {
   /**
    * The blend factor is the destination color.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   DESTINATION_COLOR: WebGLConstants.DST_COLOR,
@@ -49,7 +49,7 @@ const BlendFunction = {
   /**
    * The blend factor is one minus the destination color.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   ONE_MINUS_DESTINATION_COLOR: WebGLConstants.ONE_MINUS_DST_COLOR,
@@ -57,7 +57,7 @@ const BlendFunction = {
   /**
    * The blend factor is the source alpha.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   SOURCE_ALPHA: WebGLConstants.SRC_ALPHA,
@@ -65,7 +65,7 @@ const BlendFunction = {
   /**
    * The blend factor is one minus the source alpha.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   ONE_MINUS_SOURCE_ALPHA: WebGLConstants.ONE_MINUS_SRC_ALPHA,
@@ -73,7 +73,7 @@ const BlendFunction = {
   /**
    * The blend factor is the destination alpha.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   DESTINATION_ALPHA: WebGLConstants.DST_ALPHA,
@@ -81,7 +81,7 @@ const BlendFunction = {
   /**
    * The blend factor is one minus the destination alpha.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   ONE_MINUS_DESTINATION_ALPHA: WebGLConstants.ONE_MINUS_DST_ALPHA,
@@ -89,7 +89,7 @@ const BlendFunction = {
   /**
    * The blend factor is the constant color.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   CONSTANT_COLOR: WebGLConstants.CONSTANT_COLOR,
@@ -97,7 +97,7 @@ const BlendFunction = {
   /**
    * The blend factor is one minus the constant color.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   ONE_MINUS_CONSTANT_COLOR: WebGLConstants.ONE_MINUS_CONSTANT_COLOR,
@@ -105,7 +105,7 @@ const BlendFunction = {
   /**
    * The blend factor is the constant alpha.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   CONSTANT_ALPHA: WebGLConstants.CONSTANT_ALPHA,
@@ -113,7 +113,7 @@ const BlendFunction = {
   /**
    * The blend factor is one minus the constant alpha.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   ONE_MINUS_CONSTANT_ALPHA: WebGLConstants.ONE_MINUS_CONSTANT_ALPHA,
@@ -121,7 +121,7 @@ const BlendFunction = {
   /**
    * The blend factor is the saturated source alpha.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   SOURCE_ALPHA_SATURATE: WebGLConstants.SRC_ALPHA_SATURATE,

package/Source/Scene/BlendOption.js

@@ -1,26 +1,26 @@
 /**
  * Determines how opaque and translucent parts of billboards, points, and labels are blended with the scene.
  *
- * @enum {Number}
+ * @enum {number}
  */
 const BlendOption = {
   /**
    * The billboards, points, or labels in the collection are completely opaque.
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   OPAQUE: 0,
 
   /**
    * The billboards, points, or labels in the collection are completely translucent.
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   TRANSLUCENT: 1,
 
   /**
    * The billboards, points, or labels in the collection are both opaque and translucent.
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   OPAQUE_AND_TRANSLUCENT: 2,

package/Source/Scene/BlendingState.js

@@ -15,7 +15,7 @@ const BlendingState = {
   /**
    * Blending is disabled.
    *
-   * @type {Object}
+   * @type {object}
    * @constant
    */
   DISABLED: Object.freeze({
@@ -25,7 +25,7 @@ const BlendingState = {
   /**
    * Blending is enabled using alpha blending, <code>source(source.alpha) + destination(1 - source.alpha)</code>.
    *
-   * @type {Object}
+   * @type {object}
    * @constant
    */
   ALPHA_BLEND: Object.freeze({
@@ -41,7 +41,7 @@ const BlendingState = {
   /**
    * Blending is enabled using alpha blending with premultiplied alpha, <code>source + destination(1 - source.alpha)</code>.
    *
-   * @type {Object}
+   * @type {object}
    * @constant
    */
   PRE_MULTIPLIED_ALPHA_BLEND: Object.freeze({
@@ -57,7 +57,7 @@ const BlendingState = {
   /**
    * Blending is enabled using additive blending, <code>source(source.alpha) + destination</code>.
    *
-   * @type {Object}
+   * @type {object}
    * @constant
    */
   ADDITIVE_BLEND: Object.freeze({

package/Source/Scene/BufferLoader.js

@@ -14,10 +14,10 @@ import ResourceLoaderState from "./ResourceLoaderState.js";
  * @constructor
  * @augments ResourceLoader
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Uint8Array} [options.typedArray] The typed array containing the embedded buffer contents. Mutually exclusive with options.resource.
  * @param {Resource} [options.resource] The {@link Resource} pointing to the external buffer. Mutually exclusive with options.typedArray.
- * @param {String} [options.cacheKey] The cache key of the resource.
+ * @param {string} [options.cacheKey] The cache key of the resource.
  *
  * @exception {DeveloperError} One of options.typedArray and options.resource must be defined.
  *
@@ -50,26 +50,14 @@ if (defined(Object.create)) {
 }
 
 Object.defineProperties(BufferLoader.prototype, {
-  /**
-   * A promise that resolves to the resource when the resource is ready, or undefined if the resource hasn't started loading.
-   *
-   * @memberof BufferLoader.prototype
-   *
-   * @type {Promise.<BufferLoader>|undefined}
-   * @readonly
-   */
-  promise: {
-    get: function () {
-      return this._promise;
-    },
-  },
   /**
    * The cache key of the resource.
    *
    * @memberof BufferLoader.prototype
    *
-   * @type {String}
+   * @type {string}
    * @readonly
+   * @private
    */
   cacheKey: {
     get: function () {
@@ -83,6 +71,7 @@ Object.defineProperties(BufferLoader.prototype, {
    *
    * @type {Uint8Array}
    * @readonly
+   * @private
    */
   typedArray: {
     get: function () {
@@ -93,38 +82,44 @@ Object.defineProperties(BufferLoader.prototype, {
 
 /**
  * Loads the resource.
- * @returns {Promise.<BufferLoader>} A promise which resolves to the loader when the resource loading is completed.
+ * @returns {Promise<BufferLoader>} A promise which resolves to the loader when the resource loading is completed.
  * @private
  */
-BufferLoader.prototype.load = function () {
+BufferLoader.prototype.load = async function () {
+  if (defined(this._promise)) {
+    return this._promise;
+  }
+
   if (defined(this._typedArray)) {
     this._promise = Promise.resolve(this);
-  } else {
-    this._promise = loadExternalBuffer(this);
+    return this._promise;
   }
+
+  this._promise = loadExternalBuffer(this);
   return this._promise;
 };
 
-function loadExternalBuffer(bufferLoader) {
+async function loadExternalBuffer(bufferLoader) {
   const resource = bufferLoader._resource;
   bufferLoader._state = ResourceLoaderState.LOADING;
-  return BufferLoader._fetchArrayBuffer(resource)
-    .then(function (arrayBuffer) {
-      if (bufferLoader.isDestroyed()) {
-        return;
-      }
-      bufferLoader._typedArray = new Uint8Array(arrayBuffer);
-      bufferLoader._state = ResourceLoaderState.READY;
-      return bufferLoader;
-    })
-    .catch(function (error) {
-      if (bufferLoader.isDestroyed()) {
-        return;
-      }
-      bufferLoader._state = ResourceLoaderState.FAILED;
-      const errorMessage = `Failed to load external buffer: ${resource.url}`;
-      return Promise.reject(bufferLoader.getError(errorMessage, error));
-    });
+  try {
+    const arrayBuffer = await BufferLoader._fetchArrayBuffer(resource);
+    if (bufferLoader.isDestroyed()) {
+      return;
+    }
+
+    bufferLoader._typedArray = new Uint8Array(arrayBuffer);
+    bufferLoader._state = ResourceLoaderState.READY;
+    return bufferLoader;
+  } catch (error) {
+    if (bufferLoader.isDestroyed()) {
+      return;
+    }
+
+    bufferLoader._state = ResourceLoaderState.FAILED;
+    const errorMessage = `Failed to load external buffer: ${resource.url}`;
+    throw bufferLoader.getError(errorMessage, error);
+  }
 }
 
 /**