@cesium/engine 2.0.0 → 2.1.0

package/Source/Scene/Multiple3DTileContent.js

@@ -27,7 +27,7 @@ import preprocess3DTileContent from "./preprocess3DTileContent.js";
  * @param {Cesium3DTileset} tileset The tileset this content belongs to
  * @param {Cesium3DTile} tile The content this content belongs to
  * @param {Resource} tilesetResource The resource that points to the tileset. This will be used to derive each inner content's resource.
- * @param {Object} contentsJson Either the tile JSON containing the contents array (3D Tiles 1.1), or <code>3DTILES_multiple_contents</code> extension JSON
+ * @param {object} contentsJson Either the tile JSON containing the contents array (3D Tiles 1.1), or <code>3DTILES_multiple_contents</code> extension JSON
  *
  * @private
  * @experimental This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
@@ -80,7 +80,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    * Part of the {@link Cesium3DTileContent} interface.  <code>Multiple3DTileContent</code> checks if any of the inner contents have dirty featurePropertiesDirty.
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @private
    */
@@ -111,7 +111,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    *
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    *
    * @private
@@ -128,7 +128,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    *
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    *
    * @private
@@ -145,7 +145,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    *
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    *
    * @private
@@ -162,7 +162,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    *
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    *
    * @private
@@ -179,7 +179,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    *
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    *
    * @private
@@ -196,7 +196,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    *
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    *
    * @private
@@ -221,7 +221,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    *
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {Promise.<Cesium3DTileContent>|undefined}
+   * @type {Promise<Cesium3DTileContent>|undefined}
    * @readonly
    *
    * @private
@@ -263,7 +263,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    * have a single URL, so this returns undefined.
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {String}
+   * @type {string}
    * @readonly
    * @private
    */
@@ -327,7 +327,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    * {@link Cesium3DTileset#debugShowUrl}.
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {String[]}
+   * @type {string[]}
    * @readonly
    * @private
    */
@@ -386,7 +386,7 @@ function cancelPendingRequests(multipleContents, originalContentState) {
  * requests are successfully scheduled.
  * </p>
  *
- * @return {Number} The number of attempted requests that were unable to be scheduled.
+ * @return {number} The number of attempted requests that were unable to be scheduled.
  * @private
  */
 Multiple3DTileContent.prototype.requestInnerContents = function () {
@@ -419,8 +419,8 @@ Multiple3DTileContent.prototype.requestInnerContents = function () {
 
 /**
  * Check if all requests for inner contents can be scheduled at once. This is slower, but it avoids a potential memory leak.
- * @param {String[]} serverKeys The server keys for all of the inner contents
- * @return {Boolean} True if the request scheduler has enough open slots for all inner contents
+ * @param {string[]} serverKeys The server keys for all of the inner contents
+ * @return {boolean} True if the request scheduler has enough open slots for all inner contents
  * @private
  */
 function canScheduleAllRequests(serverKeys) {

package/Source/Scene/NeverTileDiscardPolicy.js

@@ -10,7 +10,7 @@ function NeverTileDiscardPolicy(options) {}
 
 /**
  * Determines if the discard policy is ready to process images.
- * @returns {Boolean} True if the discard policy is ready to process images; otherwise, false.
+ * @returns {boolean} True if the discard policy is ready to process images; otherwise, false.
  */
 NeverTileDiscardPolicy.prototype.isReady = function () {
   return true;
@@ -20,7 +20,7 @@ NeverTileDiscardPolicy.prototype.isReady = function () {
  * Given a tile image, decide whether to discard that image.
  *
  * @param {HTMLImageElement} image An image to test.
- * @returns {Boolean} True if the image should be discarded; otherwise, false.
+ * @returns {boolean} True if the image should be discarded; otherwise, false.
  */
 NeverTileDiscardPolicy.prototype.shouldDiscardImage = function (image) {
   return false;

package/Source/Scene/OIT.js

@@ -131,8 +131,8 @@ function destroyResources(oit) {
  * @private
  * @param {OIT} oit
  * @param {Context} context
- * @param {Number} width
- * @param {Number} height
+ * @param {number} width
+ * @param {number} height
  */
 function updateTextures(oit, context, width, height) {
   destroyTextures(oit);
@@ -165,7 +165,7 @@ function updateTextures(oit, context, width, height) {
  * @private
  * @param {OIT} oit
  * @param {Context} context
- * @returns {Boolean}
+ * @returns {boolean}
  */
 function updateFramebuffers(oit, context) {
   destroyFramebuffers(oit);
@@ -236,8 +236,8 @@ function updateFramebuffers(oit, context) {
  * @param {Context} context
  * @param {PassState} passState
  * @param {Framebuffer} framebuffer
- * @param {Boolean} useHDR
- * @param {Number} numSamples
+ * @param {boolean} useHDR
+ * @param {number} numSamples
  */
 OIT.prototype.update = function (
   context,
@@ -510,8 +510,8 @@ const alphaShaderSource =
  * @private
  * @param {Context} context
  * @param {ShaderProgram} shaderProgram
- * @param {String} keyword
- * @param {String} source
+ * @param {string} keyword
+ * @param {string} source
  * @returns {ShaderProgram}
  */
 function getTranslucentShaderProgram(context, shaderProgram, keyword, source) {
@@ -941,7 +941,7 @@ OIT.prototype.clear = function (context, passState, clearColor) {
 
 /**
  * @private
- * @returns {Boolean}
+ * @returns {boolean}
  */
 OIT.prototype.isSupported = function () {
   return this._translucentMRTSupport || this._translucentMultipassSupport;
@@ -949,7 +949,7 @@ OIT.prototype.isSupported = function () {
 
 /**
  * @private
- * @returns {Boolean}
+ * @returns {boolean}
  */
 OIT.prototype.isDestroyed = function () {
   return false;

package/Source/Scene/OctahedralProjectedCubeMap.js

@@ -2,6 +2,7 @@ import Cartesian3 from "../Core/Cartesian3.js";
 import ComponentDatatype from "../Core/ComponentDatatype.js";
 import defined from "../Core/defined.js";
 import destroyObject from "../Core/destroyObject.js";
+import Event from "../Core/Event.js";
 import IndexDatatype from "../Core/IndexDatatype.js";
 import loadKTX2 from "../Core/loadKTX2.js";
 import PixelFormat from "../Core/PixelFormat.js";
@@ -43,33 +44,14 @@ function OctahedralProjectedCubeMap(url) {
   this._loading = false;
   this._ready = false;
 
-  const cubeMap = this;
-  this._readyPromise = new Promise((resolve, reject) => {
-    cubeMap._completeLoadFromCache = (cachedTexture) => {
-      cleanupResources(this);
-      this._texture = cachedTexture;
-      this._maximumMipmapLevel = this._texture.maximumMipmapLevel;
-      this._ready = true;
-      resolve();
-      return;
-    };
-
-    cubeMap._failLoad = (error) => {
-      reject(error);
-    };
-
-    cubeMap._completeLoad = () => {
-      this._ready = true;
-      resolve();
-    };
-  });
+  this._errorEvent = new Event();
 }
 
 Object.defineProperties(OctahedralProjectedCubeMap.prototype, {
   /**
    * The url to the KTX2 file containing the specular environment map and convoluted mipmaps.
    * @memberof OctahedralProjectedCubeMap.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   url: {
@@ -77,6 +59,18 @@ Object.defineProperties(OctahedralProjectedCubeMap.prototype, {
       return this._url;
     },
   },
+  /**
+   * Gets an event that is raised when encountering an asynchronous error.  By subscribing
+   * to the event, you will be notified of the error and can potentially recover from it.
+   * @memberof OctahedralProjectedCubeMap.prototype
+   * @type {Event}
+   * @readonly
+   */
+  errorEvent: {
+    get: function () {
+      return this._errorEvent;
+    },
+  },
   /**
    * A texture containing all the packed convolutions.
    * @memberof OctahedralProjectedCubeMap.prototype
@@ -91,7 +85,7 @@ Object.defineProperties(OctahedralProjectedCubeMap.prototype, {
   /**
    * The maximum number of mip levels.
    * @memberOf OctahedralProjectedCubeMap.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   maximumMipmapLevel: {
@@ -102,7 +96,7 @@ Object.defineProperties(OctahedralProjectedCubeMap.prototype, {
   /**
    * Determines if the texture atlas is complete and ready to use.
    * @memberof OctahedralProjectedCubeMap.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   ready: {
@@ -110,17 +104,6 @@ Object.defineProperties(OctahedralProjectedCubeMap.prototype, {
       return this._ready;
     },
   },
-  /**
-   * Gets a promise that resolves when the texture atlas is ready to use.
-   * @memberof OctahedralProjectedCubeMap.prototype
-   * @type {Promise<void>}
-   * @readonly
-   */
-  readyPromise: {
-    get: function () {
-      return this._readyPromise;
-    },
-  },
 });
 
 OctahedralProjectedCubeMap.isSupported = function (context) {
@@ -298,7 +281,10 @@ OctahedralProjectedCubeMap.prototype.update = function (frameState) {
   if (!defined(this._texture) && !this._loading) {
     const cachedTexture = frameState.context.textureCache.getTexture(this._url);
     if (defined(cachedTexture)) {
-      this._completeLoadFromCache(cachedTexture);
+      cleanupResources(this);
+      this._texture = cachedTexture;
+      this._maximumMipmapLevel = this._texture.maximumMipmapLevel;
+      this._ready = true;
     }
   }
 
@@ -310,8 +296,11 @@ OctahedralProjectedCubeMap.prototype.update = function (frameState) {
         that._cubeMapBuffers = buffers;
         that._loading = false;
       })
-      .catch(function (e) {
-        that._failLoad(e);
+      .catch(function (error) {
+        if (that.isDestroyed()) {
+          return;
+        }
+        that._errorEvent.raiseEvent(error);
       });
     this._loading = true;
   }
@@ -417,7 +406,7 @@ OctahedralProjectedCubeMap.prototype.update = function (frameState) {
   });
   frameState.commandList.push(atlasCommand);
 
-  this._completeLoad();
+  this._ready = true;
 };
 
 /**
@@ -427,7 +416,7 @@ OctahedralProjectedCubeMap.prototype.update = function (frameState) {
  * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
  * </p>
  *
- * @returns {Boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
+ * @returns {boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
  *
  * @see OctahedralProjectedCubeMap#destroy
  */

package/Source/Scene/OpenStreetMapImageryProvider.js

@@ -12,17 +12,17 @@ const defaultCredit = new Credit(
 );
 
 /**
- * @typedef {Object} OpenStreetMapImageryProvider.ConstructorOptions
+ * @typedef {object} OpenStreetMapImageryProvider.ConstructorOptions
  *
  * Initialization options for the OpenStreetMapImageryProvider constructor
  *
- * @property {String} [url='https://a.tile.openstreetmap.org'] The OpenStreetMap server url.
- * @property {String} [fileExtension='png'] The file extension for images on the server.
+ * @property {string} [url='https://a.tile.openstreetmap.org'] The OpenStreetMap server url.
+ * @property {string} [fileExtension='png'] The file extension for images on the server.
  * @property {Rectangle} [rectangle=Rectangle.MAX_VALUE] The rectangle of the layer.
- * @property {Number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider.
- * @property {Number} [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
+ * @property {number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider.
+ * @property {number} [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
  * @property {Ellipsoid} [ellipsoid] The ellipsoid.  If not specified, the WGS84 ellipsoid is used.
- * @property {Credit|String} [credit='MapQuest, Open Street Map and contributors, CC-BY-SA'] A credit for the data source, which is displayed on the canvas.
+ * @property {Credit|string} [credit='MapQuest, Open Street Map and contributors, CC-BY-SA'] A credit for the data source, which is displayed on the canvas.
  */
 
 /**

package/Source/Scene/OrderedGroundPrimitiveCollection.js

@@ -23,7 +23,7 @@ Object.defineProperties(OrderedGroundPrimitiveCollection.prototype, {
    *
    * @memberof OrderedGroundPrimitiveCollection.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   length: {
@@ -37,7 +37,7 @@ Object.defineProperties(OrderedGroundPrimitiveCollection.prototype, {
  * Adds a primitive to the collection.
  *
  * @param {GroundPrimitive} primitive The primitive to add.
- * @param {Number} [zIndex = 0] The index of the primitive
+ * @param {number} [zIndex = 0] The index of the primitive
  * @returns {GroundPrimitive} The primitive added to the collection.
  */
 OrderedGroundPrimitiveCollection.prototype.add = function (primitive, zIndex) {
@@ -72,7 +72,7 @@ OrderedGroundPrimitiveCollection.prototype.add = function (primitive, zIndex) {
 /**
  * Adjusts the z-index
  * @param {GroundPrimitive} primitive
- * @param {Number} zIndex
+ * @param {number} zIndex
  */
 OrderedGroundPrimitiveCollection.prototype.set = function (primitive, zIndex) {
   //>>includeStart('debug', pragmas.debug);
@@ -93,9 +93,9 @@ OrderedGroundPrimitiveCollection.prototype.set = function (primitive, zIndex) {
 /**
  * Removes a primitive from the collection.
  *
- * @param {Object} primitive The primitive to remove.
- * @param {Boolean} [doNotDestroy = false]
- * @returns {Boolean} <code>true</code> if the primitive was removed; <code>false</code> if the primitive is <code>undefined</code> or was not found in the collection.
+ * @param {object} primitive The primitive to remove.
+ * @param {boolean} [doNotDestroy = false]
+ * @returns {boolean} <code>true</code> if the primitive was removed; <code>false</code> if the primitive is <code>undefined</code> or was not found in the collection.
  */
 OrderedGroundPrimitiveCollection.prototype.remove = function (
   primitive,
@@ -153,8 +153,8 @@ OrderedGroundPrimitiveCollection.prototype.removeAll = function () {
 /**
  * Determines if this collection contains a primitive.
  *
- * @param {Object} primitive The primitive to check for.
- * @returns {Boolean} <code>true</code> if the primitive is in the collection; <code>false</code> if the primitive is <code>undefined</code> or was not found in the collection.
+ * @param {object} primitive The primitive to check for.
+ * @returns {boolean} <code>true</code> if the primitive is in the collection; <code>false</code> if the primitive is <code>undefined</code> or was not found in the collection.
  */
 OrderedGroundPrimitiveCollection.prototype.contains = function (primitive) {
   if (!defined(primitive)) {
@@ -184,7 +184,7 @@ OrderedGroundPrimitiveCollection.prototype.update = function (frameState) {
  * If this object was destroyed, it should not be used; calling any function other than
  * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
  *
- * @returns {Boolean} True if this object was destroyed; otherwise, false.
+ * @returns {boolean} True if this object was destroyed; otherwise, false.
  *
  * @see OrderedGroundPrimitiveCollection#destroy
  */

package/Source/Scene/Particle.js

@@ -12,16 +12,16 @@ const defaultSize = new Cartesian2(1.0, 1.0);
  * @alias Particle
  * @constructor
  *
- * @param {Object} options An object with the following properties:
- * @param {Number} [options.mass=1.0] The mass of the particle in kilograms.
+ * @param {object} options An object with the following properties:
+ * @param {number} [options.mass=1.0] The mass of the particle in kilograms.
  * @param {Cartesian3} [options.position=Cartesian3.ZERO] The initial position of the particle in world coordinates.
  * @param {Cartesian3} [options.velocity=Cartesian3.ZERO] The velocity vector of the particle in world coordinates.
- * @param {Number} [options.life=Number.MAX_VALUE] The life of the particle in seconds.
- * @param {Object} [options.image] The URI, HTMLImageElement, or HTMLCanvasElement to use for the billboard.
+ * @param {number} [options.life=Number.MAX_VALUE] The life of the particle in seconds.
+ * @param {object} [options.image] The URI, HTMLImageElement, or HTMLCanvasElement to use for the billboard.
  * @param {Color} [options.startColor=Color.WHITE] The color of a particle when it is born.
  * @param {Color} [options.endColor=Color.WHITE] The color of a particle when it dies.
- * @param {Number} [options.startScale=1.0] The scale of the particle when it is born.
- * @param {Number} [options.endScale=1.0] The scale of the particle when it dies.
+ * @param {number} [options.startScale=1.0] The scale of the particle when it is born.
+ * @param {number} [options.endScale=1.0] The scale of the particle when it dies.
  * @param {Cartesian2} [options.imageSize=new Cartesian2(1.0, 1.0)] The dimensions, width by height, to scale the particle image in pixels.
  */
 function Particle(options) {
@@ -29,7 +29,7 @@ function Particle(options) {
 
   /**
    * The mass of the particle in kilograms.
-   * @type {Number}
+   * @type {number}
    * @default 1.0
    */
   this.mass = defaultValue(options.mass, 1.0);
@@ -51,13 +51,13 @@ function Particle(options) {
   );
   /**
    * The life of the particle in seconds.
-   * @type {Number}
+   * @type {number}
    * @default Number.MAX_VALUE
    */
   this.life = defaultValue(options.life, Number.MAX_VALUE);
   /**
    * The image to use for the particle.
-   * @type {Object}
+   * @type {object}
    * @default undefined
    */
   this.image = options.image;
@@ -75,13 +75,13 @@ function Particle(options) {
   this.endColor = Color.clone(defaultValue(options.endColor, Color.WHITE));
   /**
    * the scale of the particle when it is born.
-   * @type {Number}
+   * @type {number}
    * @default 1.0
    */
   this.startScale = defaultValue(options.startScale, 1.0);
   /**
    * The scale of the particle when it dies.
-   * @type {Number}
+   * @type {number}
    * @default 1.0
    */
   this.endScale = defaultValue(options.endScale, 1.0);
@@ -105,7 +105,7 @@ Object.defineProperties(Particle.prototype, {
   /**
    * Gets the age of the particle in seconds.
    * @memberof Particle.prototype
-   * @type {Number}
+   * @type {number}
    */
   age: {
     get: function () {
@@ -115,7 +115,7 @@ Object.defineProperties(Particle.prototype, {
   /**
    * Gets the age normalized to a value in the range [0.0, 1.0].
    * @memberof Particle.prototype
-   * @type {Number}
+   * @type {number}
    */
   normalizedAge: {
     get: function () {

package/Source/Scene/ParticleBurst.js

@@ -6,29 +6,29 @@ import defaultValue from "../Core/defaultValue.js";
  * @alias ParticleBurst
  * @constructor
  *
- * @param {Object} [options] An object with the following properties:
- * @param {Number} [options.time=0.0] The time in seconds after the beginning of the particle system's lifetime that the burst will occur.
- * @param {Number} [options.minimum=0.0] The minimum number of particles emmitted in the burst.
- * @param {Number} [options.maximum=50.0] The maximum number of particles emitted in the burst.
+ * @param {object} [options] An object with the following properties:
+ * @param {number} [options.time=0.0] The time in seconds after the beginning of the particle system's lifetime that the burst will occur.
+ * @param {number} [options.minimum=0.0] The minimum number of particles emmitted in the burst.
+ * @param {number} [options.maximum=50.0] The maximum number of particles emitted in the burst.
  */
 function ParticleBurst(options) {
   options = defaultValue(options, defaultValue.EMPTY_OBJECT);
 
   /**
    * The time in seconds after the beginning of the particle system's lifetime that the burst will occur.
-   * @type {Number}
+   * @type {number}
    * @default 0.0
    */
   this.time = defaultValue(options.time, 0.0);
   /**
    * The minimum number of particles emitted.
-   * @type {Number}
+   * @type {number}
    * @default 0.0
    */
   this.minimum = defaultValue(options.minimum, 0.0);
   /**
    * The maximum number of particles emitted.
-   * @type {Number}
+   * @type {number}
    * @default 50.0
    */
   this.maximum = defaultValue(options.maximum, 50.0);
@@ -40,7 +40,7 @@ Object.defineProperties(ParticleBurst.prototype, {
   /**
    * <code>true</code> if the burst has been completed; <code>false</code> otherwise.
    * @memberof ParticleBurst.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   complete: {
     get: function () {