@cesium/engine 2.4.1 → 3.0.0

package/Source/Scene/CreditDisplay.js

@@ -4,7 +4,6 @@ import Check from "../Core/Check.js";
 import Credit from "../Core/Credit.js";
 import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
-import deprecationWarning from "../Core/deprecationWarning.js";
 import destroyObject from "../Core/destroyObject.js";
 import Uri from "urijs";
 
@@ -424,21 +423,6 @@ function setCredit(creditDisplay, credits, credit, count) {
     creditDisplayElement.count += count;
   }
 }
-/**
- * Adds a credit to the list of current credits to be displayed in the credit container
- * for the next frame
- *
- * @param {Credit} credit The credit to display
- * @deprecated
- */
-CreditDisplay.prototype.addCredit = function (credit) {
-  deprecationWarning(
-    "CreditDisplay.addCredit",
-    "CreditDisplay.addCredit was deprecated in CesiumJS 1.105.  It will be removed in CesiumJS 1.107.  Use CreditDisplay.addCreditToNextFrame instead."
-  );
-
-  this.addCreditToNextFrame(credit);
-};
 
 /**
  * Adds a {@link Credit} that will show on screen or in the lightbox until
@@ -473,30 +457,6 @@ CreditDisplay.prototype.addCreditToNextFrame = function (credit) {
   setCredit(this, credits, credit);
 };
 
-/**
- * Adds credits that will persist until they are removed
- *
- * @param {Credit} credit The credit to added to defaults
- *
- * @deprecated
- */
-CreditDisplay.prototype.addDefaultCredit = function (credit) {
-  //>>includeStart('debug', pragmas.debug);
-  Check.defined("credit", credit);
-  //>>includeEnd('debug');
-
-  deprecationWarning(
-    "CreditDisplay.addDefaultCredit",
-    "CreditDisplay.addDefaultCredit was deprecated in CesiumJS 1.105.  It will be removed in CesiumJS 1.107.  Use CreditDisplay.addStaticCredit instead."
-  );
-
-  const defaultCredits = this._staticCredits;
-  if (!contains(defaultCredits, credit)) {
-    credit.showOnScreen = true;
-    defaultCredits.push(credit);
-  }
-};
-
 /**
  * Adds a {@link Credit} that will show on screen or in the lightbox until removed with {@link CreditDisplay.removeStaticCredit}.
  *
@@ -540,20 +500,6 @@ CreditDisplay.prototype.removeStaticCredit = function (credit) {
   }
 };
 
-/**
- * Removes a default credit.
- *
- * @param {Credit} credit The credit to be removed from defaults
- */
-CreditDisplay.prototype.removeDefaultCredit = function (credit) {
-  deprecationWarning(
-    "CreditDisplay.removeDefaultCredit",
-    "CreditDisplay.removeDefaultCredit was deprecated in CesiumJS 1.105.  It will be removed in CesiumJS 1.107.  Use CreditDisplay.addStaticCredit instead."
-  );
-
-  this.removeStaticCredit(credit);
-};
-
 /**
  * @private
  */

package/Source/Scene/DerivedCommand.js

@@ -278,16 +278,21 @@ function getPickShaderProgram(context, shaderProgram, pickId) {
     const sources = fs.sources;
     const length = sources.length;
 
-    const newMain =
-      `${
-        "void main() \n" +
-        "{ \n" +
-        "    czm_non_pick_main(); \n" +
-        "    if (out_FragColor.a == 0.0) { \n" +
-        "        discard; \n" +
-        "    } \n" +
-        "    out_FragColor = "
-      }${pickId}; \n` + `} \n`;
+    const hasFragData = sources.some((source) =>
+      source.includes("out_FragData")
+    );
+    const outputColorVariable = hasFragData
+      ? "out_FragData_0"
+      : "out_FragColor";
+    const newMain = `void main () 
+{ 
+    czm_non_pick_main(); 
+    if (${outputColorVariable}.a == 0.0) { 
+        discard; 
+    } 
+    ${outputColorVariable} = ${pickId}; 
+} `;
+
     const newSources = new Array(length + 1);
     for (let i = 0; i < length; ++i) {
       newSources[i] = ShaderSource.replaceMain(sources[i], "czm_non_pick_main");

package/Source/Scene/Empty3DTileContent.js

@@ -1,4 +1,3 @@
-import deprecationWarning from "../Core/deprecationWarning.js";
 import destroyObject from "../Core/destroyObject.js";
 import DeveloperError from "../Core/DeveloperError.js";
 
@@ -80,26 +79,6 @@ Object.defineProperties(Empty3DTileContent.prototype, {
     },
   },
 
-  /**
-   * Gets the promise that will be resolved when the tile's content is ready to render.
-   *
-   * @memberof Empty3DTileContent.prototype
-   *
-   * @type {Promise<Empty3DTileContent>}
-   * @readonly
-   * @deprecated
-   * @private
-   */
-  readyPromise: {
-    get: function () {
-      deprecationWarning(
-        "Empty3DTileContent.readyPromise",
-        "Empty3DTileContent.readyPromise was deprecated in CesiumJS 1.104. It will be removed in 1.107. Wait for Empty3DTileContent.ready to return true instead."
-      );
-      return Promise.resolve(this);
-    },
-  },
-
   tileset: {
     get: function () {
       return this._tileset;

package/Source/Scene/Geometry3DTileContent.js

@@ -1,7 +1,6 @@
 import Cartesian3 from "../Core/Cartesian3.js";
 import defaultValue from "../Core/defaultValue.js";
 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 getJsonFromTypedArray from "../Core/getJsonFromTypedArray.js";
@@ -45,12 +44,6 @@ function Geometry3DTileContent(
 
   this._ready = false;
 
-  // This is for backwards compatibility. It can be removed once readyPromise is removed.
-  this._resolveContent = undefined;
-  this._readyPromise = new Promise((resolve) => {
-    this._resolveContent = resolve;
-  });
-
   initialize(this, arrayBuffer, byteOffset);
 }
 
@@ -120,26 +113,6 @@ Object.defineProperties(Geometry3DTileContent.prototype, {
     },
   },
 
-  /**
-   * Gets the promise that will be resolved when the tile's content is ready to render.
-   *
-   * @memberof Geometry3DTileContent.prototype
-   *
-   * @type {Promise<Geometry3DTileContent>}
-   * @readonly
-   * @deprecated
-   * @private
-   */
-  readyPromise: {
-    get: function () {
-      deprecationWarning(
-        "Geometry3DTileContent.readyPromise",
-        "Geometry3DTileContent.readyPromise was deprecated in CesiumJS 1.104. It will be removed in 1.107. Wait for Geometry3DTileContent.ready to return true instead."
-      );
-      return this._readyPromise;
-    },
-  },
-
   tileset: {
     get: function () {
       return this._tileset;
@@ -329,7 +302,6 @@ function initialize(content, arrayBuffer, byteOffset) {
 
   if (byteLength === 0) {
     content._ready = true;
-    content._resolveContent(content);
     return;
   }
 
@@ -550,7 +522,6 @@ Geometry3DTileContent.prototype.update = function (tileset, frameState) {
   if (defined(this._batchTable) && this._geometries.ready) {
     this._batchTable.update(tileset, frameState);
     this._ready = true;
-    this._resolveContent(this);
   }
 };
 

package/Source/Scene/Globe.js

@@ -436,8 +436,6 @@ Object.defineProperties(Globe.prototype, {
         return true;
       }
       return (
-        // ready is deprecated. This is here for backwards compatibility
-        this._surface.tileProvider.ready &&
         this._surface._tileLoadQueueHigh.length === 0 &&
         this._surface._tileLoadQueueMedium.length === 0 &&
         this._surface._tileLoadQueueLow.length === 0
@@ -983,15 +981,9 @@ Globe.prototype.beginFrame = function (frameState) {
   const surface = this._surface;
   const tileProvider = surface.tileProvider;
   const terrainProvider = this.terrainProvider;
-  // ready is deprecated; This is here for backwards compatibility
-  const terrainReady =
-    defined(terrainProvider) &&
-    (defined(terrainProvider._ready)
-      ? terrainProvider._ready
-      : !defined(terrainProvider.ready) || terrainProvider.ready);
   const hasWaterMask =
     this.showWaterEffect &&
-    terrainReady &&
+    defined(terrainProvider) &&
     terrainProvider.hasWaterMask &&
     terrainProvider.hasWaterMask;
 

package/Source/Scene/GlobeSurfaceTile.js

@@ -345,14 +345,7 @@ GlobeSurfaceTile.prototype.processImagery = function (
 
     if (tileImagery.loadingImagery.state === ImageryState.PLACEHOLDER) {
       const imageryLayer = tileImagery.loadingImagery.imageryLayer;
-      // ImageryProvider.ready is deprecated. This is here for backwards compatibility
-      const imageryProvider = imageryLayer.imageryProvider;
-      if (
-        imageryLayer.ready &&
-        (defined(imageryProvider._ready)
-          ? imageryProvider._ready
-          : !defined(imageryProvider.ready) || imageryProvider.ready)
-      ) {
+      if (imageryLayer.ready) {
         // Remove the placeholder and add the actual skeletons (if any)
         // at the same position.  Then continue the loop at the same index.
         tileImagery.freeResources();
@@ -686,6 +679,11 @@ function upsample(surfaceTile, tile, frameState, terrainProvider, x, y, level) {
 
   Promise.resolve(terrainDataPromise)
     .then(function (terrainData) {
+      if (!defined(terrainData)) {
+        // The upsample request has been deferred - try again later.
+        return;
+      }
+
       surfaceTile.terrainData = terrainData;
       surfaceTile.terrainState = TerrainState.RECEIVED;
     })
@@ -696,6 +694,13 @@ function upsample(surfaceTile, tile, frameState, terrainProvider, x, y, level) {
 
 function requestTileGeometry(surfaceTile, terrainProvider, x, y, level) {
   function success(terrainData) {
+    if (!defined(terrainData)) {
+      // Throttled due to low priority - try again later.
+      surfaceTile.terrainState = TerrainState.UNLOADED;
+      surfaceTile.request = undefined;
+      return;
+    }
+
     surfaceTile.terrainData = terrainData;
     surfaceTile.terrainState = TerrainState.RECEIVED;
     surfaceTile.request = undefined;

package/Source/Scene/GlobeSurfaceTileProvider.js

@@ -229,43 +229,6 @@ Object.defineProperties(GlobeSurfaceTileProvider.prototype, {
     },
   },
 
-  /**
-   * Gets a value indicating whether or not the provider is ready for use.
-   * @memberof GlobeSurfaceTileProvider.prototype
-   * @type {boolean}
-   * @deprecated
-   */
-  ready: {
-    get: function () {
-      const terrainProvider = this._terrainProvider;
-      if (
-        !defined(terrainProvider) ||
-        // TerrainProvider.ready is deprecated; This is here for backwards compatibility
-        (defined(terrainProvider._ready)
-          ? !terrainProvider._ready
-          : defined(terrainProvider.ready) && !terrainProvider.ready)
-      ) {
-        return false;
-      }
-
-      if (this._imageryLayers.length === 0) {
-        return true;
-      }
-
-      const imageryLayer = this._imageryLayers.get(0);
-      if (!imageryLayer.ready) {
-        return false;
-      }
-
-      // ImageryProvider.ready is deprecated; This is here for backwards compatibility
-      const imageryProvider = imageryLayer.imageryProvider;
-      const imageryProviderReady = defined(imageryProvider._ready)
-        ? imageryProvider._ready
-        : !defined(imageryProvider.ready) || imageryProvider.ready;
-      return imageryProviderReady;
-    },
-  },
-
   /**
    * Gets the tiling scheme used by the provider.
    * @memberof GlobeSurfaceTileProvider.prototype
@@ -273,6 +236,10 @@ Object.defineProperties(GlobeSurfaceTileProvider.prototype, {
    */
   tilingScheme: {
     get: function () {
+      if (!defined(this._terrainProvider)) {
+        return undefined;
+      }
+
       return this._terrainProvider.tilingScheme;
     },
   },
@@ -364,29 +331,15 @@ GlobeSurfaceTileProvider.prototype.update = function (frameState) {
 function updateCredits(surface, frameState) {
   const creditDisplay = frameState.creditDisplay;
   const terrainProvider = surface._terrainProvider;
-  if (
-    defined(terrainProvider) &&
-    // ready is deprecated; This is here for backwards compatibility
-    (defined(terrainProvider._ready)
-      ? terrainProvider._ready
-      : !defined(terrainProvider.ready) || terrainProvider.ready) &&
-    defined(terrainProvider.credit)
-  ) {
+  if (defined(terrainProvider) && defined(terrainProvider.credit)) {
     creditDisplay.addCreditToNextFrame(terrainProvider.credit);
   }
 
   const imageryLayers = surface._imageryLayers;
   for (let i = 0, len = imageryLayers.length; i < len; ++i) {
     const layer = imageryLayers.get(i);
-    if (layer.ready) {
-      // ImageryProvider.ready is deprecated; This is here for backwards compatibility
-      const imageryProvider = layer.imageryProvider;
-      const imageryProviderReady = defined(imageryProvider._ready)
-        ? imageryProvider._ready
-        : !defined(imageryProvider.ready) || imageryProvider.ready;
-      if (imageryProviderReady && defined(layer.imageryProvider.credit)) {
-        creditDisplay.addCreditToNextFrame(layer.imageryProvider.credit);
-      }
+    if (layer.ready && layer.show && defined(layer.imageryProvider.credit)) {
+      creditDisplay.addCreditToNextFrame(layer.imageryProvider.credit);
     }
   }
 }
@@ -2168,12 +2121,7 @@ function addDrawCommandsForTile(tileProvider, tile, frameState) {
   const showOceanWaves = showReflectiveOcean && defined(oceanNormalMap);
   const terrainProvider = tileProvider.terrainProvider;
   const hasVertexNormals =
-    defined(terrainProvider) &&
-    // ready is deprecated; This is here for backwards compatibility
-    (defined(terrainProvider._ready)
-      ? terrainProvider._ready
-      : !defined(terrainProvider.ready) || terrainProvider.ready) &&
-    tileProvider.terrainProvider.hasVertexNormals;
+    defined(terrainProvider) && tileProvider.terrainProvider.hasVertexNormals;
   const enableFog =
     frameState.fog.enabled && frameState.fog.renderable && !cameraUnderground;
   const showGroundAtmosphere =

package/Source/Scene/GltfPipeline/removeUnusedElements.js

@@ -106,6 +106,15 @@ Remove.accessor = function (gltf, accessorId) {
       if (defined(indices) && indices > accessorId) {
         primitive.indices--;
       }
+
+      const ext = primitive.extensions;
+      if (
+        defined(ext) &&
+        defined(ext.CESIUM_primitive_outline) &&
+        ext.CESIUM_primitive_outline.indices > accessorId
+      ) {
+        --ext.CESIUM_primitive_outline.indices;
+      }
     });
   });
 
@@ -546,6 +555,24 @@ getListOfElementsIdsInUse.accessor = function (gltf) {
     });
   }
 
+  if (usesExtension(gltf, "CESIUM_primitive_outline")) {
+    ForEach.mesh(gltf, function (mesh) {
+      ForEach.meshPrimitive(mesh, function (primitive) {
+        const extensions = primitive.extensions;
+        if (
+          defined(extensions) &&
+          defined(extensions.CESIUM_primitive_outline)
+        ) {
+          const extension = extensions.CESIUM_primitive_outline;
+          const indicesAccessorId = extension.indices;
+          if (defined(indicesAccessorId)) {
+            usedAccessorIds[indicesAccessorId] = true;
+          }
+        }
+      });
+    });
+  }
+
   return usedAccessorIds;
 };
 

package/Source/Scene/GltfPipeline/updateVersion.js

@@ -33,6 +33,8 @@ const updateFunctions = {
  * @param {object} gltf A javascript object containing a glTF asset.
  * @param {object} [options] Options for updating the glTF.
  * @param {string} [options.targetVersion] The glTF will be upgraded until it hits the specified version.
+ * @param {string[]} [options.baseColorTextureNames] Names of uniforms that indicate base color textures.
+ * @param {string[]} [options.baseColorFactorNames] Names of uniforms that indicate base color factors.
  * @returns {object} The updated glTF asset.
  *
  * @private
@@ -73,7 +75,7 @@ function updateVersion(gltf, options) {
   }
 
   if (!options.keepLegacyExtensions) {
-    convertTechniquesToPbr(gltf);
+    convertTechniquesToPbr(gltf, options);
     convertMaterialsCommonToPbr(gltf);
   }
 
@@ -1003,8 +1005,13 @@ function glTF10to20(gltf) {
 // It's not possible to upgrade glTF 1.0 shaders to 2.0 PBR materials in a generic way,
 // but we can look for certain uniform names that are commonly found in glTF 1.0 assets
 // and create PBR materials out of those.
-const baseColorTextureNames = ["u_tex", "u_diffuse", "u_emission"];
-const baseColorFactorNames = ["u_diffuse"];
+const defaultBaseColorTextureNames = [
+  "u_tex",
+  "u_diffuse",
+  "u_emission",
+  "u_diffuse_tex",
+];
+const defaultBaseColorFactorNames = ["u_diffuse", "u_diffuse_mat"];
 
 function initializePbrMaterial(material) {
   material.pbrMetallicRoughness = defined(material.pbrMetallicRoughness)
@@ -1044,7 +1051,17 @@ function srgbToLinear(srgb) {
   return linear;
 }
 
-function convertTechniquesToPbr(gltf) {
+function convertTechniquesToPbr(gltf, options) {
+  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  const baseColorTextureNames = defaultValue(
+    options.baseColorTextureNames,
+    defaultBaseColorTextureNames
+  );
+  const baseColorFactorNames = defaultValue(
+    options.baseColorFactorNames,
+    defaultBaseColorFactorNames
+  );
+
   // Future work: convert other values like emissive, specular, etc. Only handling diffuse right now.
   ForEach.material(gltf, function (material) {
     ForEach.materialValue(material, function (value, name) {