@cesium/engine 2.0.0 → 2.2.0

package/Source/Scene/Multiple3DTileContent.js

@@ -1,4 +1,5 @@
 import defined from "../Core/defined.js";
+import deprecationWarning from "../Core/deprecationWarning.js";
 import destroyObject from "../Core/destroyObject.js";
 import DeveloperError from "../Core/DeveloperError.js";
 import Request from "../Core/Request.js";
@@ -27,7 +28,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.
@@ -54,6 +55,12 @@ function Multiple3DTileContent(tileset, tile, tilesetResource, contentsJson) {
   const contentCount = this._innerContentHeaders.length;
   this._arrayFetchPromises = new Array(contentCount);
   this._requests = new Array(contentCount);
+  this._ready = false;
+
+  this._resolveContent = undefined;
+  this._readyPromise = new Promise((resolve) => {
+    this._resolveContent = resolve;
+  });
 
   this._innerContentResources = new Array(contentCount);
   this._serverKeys = new Array(contentCount);
@@ -70,9 +77,6 @@ function Multiple3DTileContent(tileset, tile, tilesetResource, contentsJson) {
     this._innerContentResources[i] = contentResource;
     this._serverKeys[i] = serverKey;
   }
-
-  // undefined until the first time requests are scheduled
-  this._contentsFetchedPromise = undefined;
 }
 
 Object.defineProperties(Multiple3DTileContent.prototype, {
@@ -80,7 +84,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 +115,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    *
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    *
    * @private
@@ -128,7 +132,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    *
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    *
    * @private
@@ -145,7 +149,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    *
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    *
    * @private
@@ -162,7 +166,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    *
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    *
    * @private
@@ -179,7 +183,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    *
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    *
    * @private
@@ -196,7 +200,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    *
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    *
    * @private
@@ -214,34 +218,41 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
   },
 
   /**
-   * Part of the {@link Cesium3DTileContent} interface. This behaves
-   * differently for <code>Multiple3DTileContent</code>: it returns
-   * undefined if the inner contents have not yet been created. This
-   * is handled specially in {@link Cesium3DTile}.
+   * Returns true when the tile's content is ready to render; otherwise false
    *
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {Promise.<Cesium3DTileContent>|undefined}
+   * @type {boolean}
    * @readonly
-   *
    * @private
    */
-  readyPromise: {
+  ready: {
     get: function () {
-      // The contents haven't been created yet, short-circuit. The tile
-      // will handle this as a special case
       if (!this._contentsCreated) {
-        return undefined;
+        return false;
       }
 
-      const readyPromises = this._contents.map(function (content) {
-        return content.readyPromise;
-      });
+      return this._ready;
+    },
+  },
 
-      const that = this;
-      return Promise.all(readyPromises).then(function () {
-        return that;
-      });
+  /**
+   * Gets the promise that will be resolved when the tile's content is ready to render.
+   *
+   * @memberof Multiple3DTileContent.prototype
+   *
+   * @type {Promise<Multiple3DTileContent>}
+   * @readonly
+   * @deprecated
+   * @private
+   */
+  readyPromise: {
+    get: function () {
+      deprecationWarning(
+        "Multiple3DTileContent.readyPromise",
+        "Multiple3DTileContent.readyPromise was deprecated in CesiumJS 1.104. It will be removed in 1.107. Wait for Multiple3DTileContent.ready to return true instead."
+      );
+      return this._readyPromise;
     },
   },
 
@@ -263,7 +274,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    * have a single URL, so this returns undefined.
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {String}
+   * @type {string}
    * @readonly
    * @private
    */
@@ -327,7 +338,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
    * {@link Cesium3DTileset#debugShowUrl}.
    * @memberof Multiple3DTileContent.prototype
    *
-   * @type {String[]}
+   * @type {string[]}
    * @readonly
    * @private
    */
@@ -338,21 +349,6 @@ Object.defineProperties(Multiple3DTileContent.prototype, {
       });
     },
   },
-
-  /**
-   * A promise that resolves when all of the inner contents have been fetched.
-   * This promise is undefined until the first frame where all array buffer
-   * requests have been scheduled.
-   * @memberof Multiple3DTileContent.prototype
-   *
-   * @type {Promise}
-   * @private
-   */
-  contentsFetchedPromise: {
-    get: function () {
-      return this._contentsFetchedPromise;
-    },
-  },
 });
 
 function updatePendingRequests(multipleContents, deltaRequestCount) {
@@ -386,7 +382,7 @@ function cancelPendingRequests(multipleContents, originalContentState) {
  * requests are successfully scheduled.
  * </p>
  *
- * @return {Number} The number of attempted requests that were unable to be scheduled.
+ * @return {Promise<void>|undefined} A promise that resolves when the request completes, or undefined if there is no request needed, or the request cannot be scheduled.
  * @private
  */
 Multiple3DTileContent.prototype.requestInnerContents = function () {
@@ -395,32 +391,32 @@ Multiple3DTileContent.prototype.requestInnerContents = function () {
   // if we can schedule all the requests at once. If not, no requests are
   // scheduled
   if (!canScheduleAllRequests(this._serverKeys)) {
-    return this._serverKeys.length;
+    this.tileset.statistics.numberOfAttemptedRequests += this._serverKeys.length;
+    return;
   }
 
   const contentHeaders = this._innerContentHeaders;
   updatePendingRequests(this, contentHeaders.length);
 
+  const originalCancelCount = this._cancelCount;
   for (let i = 0; i < contentHeaders.length; i++) {
     // The cancel count is needed to avoid a race condition where a content
     // is canceled multiple times.
     this._arrayFetchPromises[i] = requestInnerContent(
       this,
       i,
-      this._cancelCount,
+      originalCancelCount,
       this._tile._contentState
     );
   }
 
-  this._contentsFetchedPromise = createInnerContents(this);
-
-  return 0;
+  return createInnerContents(this);
 };
 
 /**
  * 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) {
@@ -476,28 +472,39 @@ function requestInnerContent(
 
   const promise = contentResource.fetchArrayBuffer();
   if (!defined(promise)) {
-    return Promise.resolve(undefined);
+    return;
   }
 
   return promise
     .then(function (arrayBuffer) {
-      // Short circuit if another inner content was canceled.
+      // Pending requests have already been canceled.
       if (originalCancelCount < multipleContents._cancelCount) {
-        return undefined;
+        return;
+      }
+
+      if (
+        contentResource.request.cancelled ||
+        contentResource.request.state === RequestState.CANCELLED
+      ) {
+        cancelPendingRequests(multipleContents, originalContentState);
+        return;
       }
 
       updatePendingRequests(multipleContents, -1);
       return arrayBuffer;
     })
     .catch(function (error) {
-      // Short circuit if another inner content was canceled.
+      // Pending requests have already been canceled.
       if (originalCancelCount < multipleContents._cancelCount) {
-        return undefined;
+        return;
       }
 
-      if (contentResource.request.state === RequestState.CANCELLED) {
+      if (
+        contentResource.request.cancelled ||
+        contentResource.request.state === RequestState.CANCELLED
+      ) {
         cancelPendingRequests(multipleContents, originalContentState);
-        return undefined;
+        return;
       }
 
       updatePendingRequests(multipleContents, -1);
@@ -505,85 +512,90 @@ function requestInnerContent(
     });
 }
 
-function createInnerContents(multipleContents) {
+async function createInnerContents(multipleContents) {
   const originalCancelCount = multipleContents._cancelCount;
-  return Promise.all(multipleContents._arrayFetchPromises).then(function (
-    arrayBuffers
-  ) {
-    // Short circuit if inner contents were canceled
-    if (originalCancelCount < multipleContents._cancelCount) {
-      return undefined;
-    }
-
-    const contents = arrayBuffers.map(function (arrayBuffer, i) {
-      if (!defined(arrayBuffer)) {
-        // Content was not fetched. The error was handled in
-        // the fetch promise. Return undefined to indicate partial failure.
-        return undefined;
-      }
+  const arrayBuffers = await Promise.all(multipleContents._arrayFetchPromises);
+  // Request have been cancelled
+  if (originalCancelCount < multipleContents._cancelCount) {
+    return;
+  }
 
-      return createInnerContent(multipleContents, arrayBuffer, i);
-    });
+  const promises = arrayBuffers.map((arrayBuffer, i) =>
+    createInnerContent(multipleContents, arrayBuffer, i)
+  );
 
-    // Even if we had a partial success, mark that we finished creating
-    // contents
-    multipleContents._contentsCreated = true;
-    multipleContents._contents = contents.filter(defined);
-  });
+  // Even if we had a partial success (in which case the inner promise will be handled, but the content will not be returned), mark that we finished creating
+  // contents
+  const contents = await Promise.all(promises);
+  multipleContents._contentsCreated = true;
+  multipleContents._contents = contents.filter(defined);
+  return contents;
 }
 
-function createInnerContent(multipleContents, arrayBuffer, index) {
-  const preprocessed = preprocess3DTileContent(arrayBuffer);
-
-  if (preprocessed.contentType === Cesium3DTileContentType.EXTERNAL_TILESET) {
-    const error = new RuntimeError(
-      "External tilesets are disallowed inside multiple contents"
-    );
-
-    return handleInnerContentFailed(multipleContents, index, error);
+async function createInnerContent(multipleContents, arrayBuffer, index) {
+  if (!defined(arrayBuffer)) {
+    // Content was not fetched. The error was handled in
+    // the fetch promise. Return undefined to indicate partial failure.
+    return;
   }
 
-  multipleContents._disableSkipLevelOfDetail =
-    multipleContents._disableSkipLevelOfDetail ||
-    preprocessed.contentType === Cesium3DTileContentType.GEOMETRY ||
-    preprocessed.contentType === Cesium3DTileContentType.VECTOR;
+  try {
+    const preprocessed = preprocess3DTileContent(arrayBuffer);
 
-  const tileset = multipleContents._tileset;
-  const resource = multipleContents._innerContentResources[index];
-  const tile = multipleContents._tile;
-
-  let content;
-  const contentFactory = Cesium3DTileContentFactory[preprocessed.contentType];
-  if (defined(preprocessed.binaryPayload)) {
-    content = contentFactory(
-      tileset,
-      tile,
-      resource,
-      preprocessed.binaryPayload.buffer,
-      0
-    );
-  } else {
-    // JSON formats
-    content = contentFactory(tileset, tile, resource, preprocessed.jsonPayload);
-  }
+    if (preprocessed.contentType === Cesium3DTileContentType.EXTERNAL_TILESET) {
+      throw new RuntimeError(
+        "External tilesets are disallowed inside multiple contents"
+      );
+    }
 
-  const contentHeader = multipleContents._innerContentHeaders[index];
+    multipleContents._disableSkipLevelOfDetail =
+      multipleContents._disableSkipLevelOfDetail ||
+      preprocessed.contentType === Cesium3DTileContentType.GEOMETRY ||
+      preprocessed.contentType === Cesium3DTileContentType.VECTOR;
+
+    const tileset = multipleContents._tileset;
+    const resource = multipleContents._innerContentResources[index];
+    const tile = multipleContents._tile;
+
+    let content;
+    const contentFactory = Cesium3DTileContentFactory[preprocessed.contentType];
+    if (defined(preprocessed.binaryPayload)) {
+      content = await Promise.resolve(
+        contentFactory(
+          tileset,
+          tile,
+          resource,
+          preprocessed.binaryPayload.buffer,
+          0
+        )
+      );
+    } else {
+      // JSON formats
+      content = await Promise.resolve(
+        contentFactory(tileset, tile, resource, preprocessed.jsonPayload)
+      );
+    }
 
-  if (tile.hasImplicitContentMetadata) {
-    const subtree = tile.implicitSubtree;
-    const coordinates = tile.implicitCoordinates;
-    content.metadata = subtree.getContentMetadataView(coordinates, index);
-  } else if (!tile.hasImplicitContent) {
-    content.metadata = findContentMetadata(tileset, contentHeader);
-  }
+    const contentHeader = multipleContents._innerContentHeaders[index];
 
-  const groupMetadata = findGroupMetadata(tileset, contentHeader);
-  if (defined(groupMetadata)) {
-    content.group = new Cesium3DContentGroup({
-      metadata: groupMetadata,
-    });
+    if (tile.hasImplicitContentMetadata) {
+      const subtree = tile.implicitSubtree;
+      const coordinates = tile.implicitCoordinates;
+      content.metadata = subtree.getContentMetadataView(coordinates, index);
+    } else if (!tile.hasImplicitContent) {
+      content.metadata = findContentMetadata(tileset, contentHeader);
+    }
+
+    const groupMetadata = findGroupMetadata(tileset, contentHeader);
+    if (defined(groupMetadata)) {
+      content.group = new Cesium3DContentGroup({
+        metadata: groupMetadata,
+      });
+    }
+    return content;
+  } catch (error) {
+    handleInnerContentFailed(multipleContents, index, error);
   }
-  return content;
 }
 
 function handleInnerContentFailed(multipleContents, index, error) {
@@ -653,8 +665,15 @@ Multiple3DTileContent.prototype.applyStyle = function (style) {
 Multiple3DTileContent.prototype.update = function (tileset, frameState) {
   const contents = this._contents;
   const length = contents.length;
+  let ready = true;
   for (let i = 0; i < length; ++i) {
     contents[i].update(tileset, frameState);
+    ready = ready && contents[i].ready;
+  }
+
+  if (!this._ready && ready) {
+    this._ready = true;
+    this._resolveContent(this);
   }
 };
 

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
  */