@cesium/engine 9.1.0 → 10.0.0

package/Source/Scene/GltfLoaderUtil.js

@@ -35,9 +35,7 @@ const GltfLoaderUtil = {};
  */
 GltfLoaderUtil.getImageIdFromTexture = function (options) {
   options = defaultValue(options, defaultValue.EMPTY_OBJECT);
-  const gltf = options.gltf;
-  const textureId = options.textureId;
-  const supportedImageFormats = options.supportedImageFormats;
+  const { gltf, textureId, supportedImageFormats } = options;
 
   //>>includeStart('debug', pragmas.debug);
   Check.typeOf.object("options.gltf", gltf);
@@ -73,12 +71,7 @@ GltfLoaderUtil.getImageIdFromTexture = function (options) {
  */
 GltfLoaderUtil.createSampler = function (options) {
   options = defaultValue(options, defaultValue.EMPTY_OBJECT);
-  const gltf = options.gltf;
-  const textureInfo = options.textureInfo;
-  const compressedTextureNoMipmap = defaultValue(
-    options.compressedTextureNoMipmap,
-    false
-  );
+  const { gltf, textureInfo, compressedTextureNoMipmap = false } = options;
 
   //>>includeStart('debug', pragmas.debug);
   Check.typeOf.object("options.gltf", gltf);
@@ -140,9 +133,7 @@ const defaultScale = new Cartesian2(1.0, 1.0);
  */
 GltfLoaderUtil.createModelTextureReader = function (options) {
   options = defaultValue(options, defaultValue.EMPTY_OBJECT);
-  const textureInfo = options.textureInfo;
-  const channels = options.channels;
-  const texture = options.texture;
+  const { textureInfo, channels, texture } = options;
 
   //>>includeStart('debug', pragmas.debug);
   Check.typeOf.object("options.textureInfo", textureInfo);
@@ -151,10 +142,7 @@ GltfLoaderUtil.createModelTextureReader = function (options) {
   let texCoord = defaultValue(textureInfo.texCoord, 0);
   let transform;
 
-  const textureTransform = defaultValue(
-    textureInfo.extensions,
-    defaultValue.EMPTY_OBJECT
-  ).KHR_texture_transform;
+  const textureTransform = textureInfo.extensions?.KHR_texture_transform;
 
   if (defined(textureTransform)) {
     texCoord = defaultValue(textureTransform.texCoord, texCoord);
@@ -186,6 +174,7 @@ GltfLoaderUtil.createModelTextureReader = function (options) {
   modelTextureReader.index = textureInfo.index;
   modelTextureReader.texture = texture;
   modelTextureReader.texCoord = texCoord;
+  modelTextureReader.scale = textureInfo.scale;
   modelTextureReader.transform = transform;
   modelTextureReader.channels = channels;
 

package/Source/Scene/GltfPipeline/forEachTextureInMaterial.js

@@ -33,10 +33,11 @@ function forEachTextureInMaterial(material, handler) {
     }
   }
 
-  if (defined(material.extensions)) {
+  const { extensions } = material;
+  if (defined(extensions)) {
     // Spec gloss extension
     const pbrSpecularGlossiness =
-      material.extensions.KHR_materials_pbrSpecularGlossiness;
+      extensions.KHR_materials_pbrSpecularGlossiness;
     if (defined(pbrSpecularGlossiness)) {
       if (defined(pbrSpecularGlossiness.diffuseTexture)) {
         const textureInfo = pbrSpecularGlossiness.diffuseTexture;
@@ -54,13 +55,28 @@ function forEachTextureInMaterial(material, handler) {
       }
     }
 
+    // Specular extension
+    const specular = extensions.KHR_materials_specular;
+    if (defined(specular)) {
+      const { specularTexture, specularColorTexture } = specular;
+      if (defined(specularTexture)) {
+        const value = handler(specularTexture.index, specularTexture);
+        if (defined(value)) {
+          return value;
+        }
+      }
+      if (defined(specularColorTexture)) {
+        const value = handler(specularColorTexture.index, specularColorTexture);
+        if (defined(value)) {
+          return value;
+        }
+      }
+    }
+
     // Materials common extension (may be present in models converted from glTF 1.0)
-    const materialsCommon = material.extensions.KHR_materials_common;
+    const materialsCommon = extensions.KHR_materials_common;
     if (defined(materialsCommon) && defined(materialsCommon.values)) {
-      const diffuse = materialsCommon.values.diffuse;
-      const ambient = materialsCommon.values.ambient;
-      const emission = materialsCommon.values.emission;
-      const specular = materialsCommon.values.specular;
+      const { diffuse, ambient, emission, specular } = materialsCommon.values;
       if (defined(diffuse) && defined(diffuse.index)) {
         const value = handler(diffuse.index, diffuse);
         if (defined(value)) {

package/Source/Scene/GltfStructuralMetadataLoader.js

@@ -34,15 +34,17 @@ import ResourceLoaderState from "./ResourceLoaderState.js";
  */
 function GltfStructuralMetadataLoader(options) {
   options = defaultValue(options, defaultValue.EMPTY_OBJECT);
-  const gltf = options.gltf;
-  const extension = options.extension;
-  const extensionLegacy = options.extensionLegacy;
-  const gltfResource = options.gltfResource;
-  const baseResource = options.baseResource;
-  const supportedImageFormats = options.supportedImageFormats;
-  const frameState = options.frameState;
-  const cacheKey = options.cacheKey;
-  const asynchronous = defaultValue(options.asynchronous, true);
+  const {
+    gltf,
+    extension,
+    extensionLegacy,
+    gltfResource,
+    baseResource,
+    supportedImageFormats,
+    frameState,
+    cacheKey,
+    asynchronous = true,
+  } = options;
 
   //>>includeStart('debug', pragmas.debug);
   Check.typeOf.object("options.gltf", gltf);

package/Source/Scene/GoogleEarthEnterpriseImageryProvider.js

@@ -45,7 +45,7 @@ GoogleEarthEnterpriseDiscardPolicy.prototype.shouldDiscardImage = function (
  *
  * Initialization options for the GoogleEarthEnterpriseImageryProvider constructor
  *
- * @property {Ellipsoid} [ellipsoid] The ellipsoid.  If not specified, the WGS84 ellipsoid is used.
+ * @property {Ellipsoid} [ellipsoid=Ellipsoid.default] The ellipsoid.  If not specified, the default ellipsoid is used.
  * @property {TileDiscardPolicy} [tileDiscardPolicy] The policy that determines if a tile
  *        is invalid and should be discarded. If this value is not specified, a default
  *        is to discard tiles that fail to download.

package/Source/Scene/GoogleEarthEnterpriseMapsProvider.js

@@ -41,7 +41,7 @@ import ImageryProvider from "./ImageryProvider.js";
  * @property {TileDiscardPolicy} [tileDiscardPolicy] The policy that determines if a tile
  *        is invalid and should be discarded. To ensure that no tiles are discarded, construct and pass
  *        a {@link NeverTileDiscardPolicy} for this parameter.
- * @property {Ellipsoid} [ellipsoid] The ellipsoid.  If not specified, the WGS84 ellipsoid is used.
+ * @property {Ellipsoid} [ellipsoid=Ellipsoid.default] The ellipsoid.  If not specified, the default ellipsoid is used.
  */
 
 /**

package/Source/Scene/GridImageryProvider.js

@@ -14,9 +14,9 @@ const defaultBackgroundColor = new Color(0.0, 0.5, 0.0, 0.2);
  * Initialization options for the GridImageryProvider constructor
  *
  * @property {TilingScheme} [tilingScheme=new GeographicTilingScheme()] The tiling scheme for which to draw tiles.
- * @property {Ellipsoid} [ellipsoid] The ellipsoid.  If the tilingScheme is specified,
+ * @property {Ellipsoid} [ellipsoid=Ellipsoid.default] The ellipsoid.  If the tilingScheme is specified,
  *                    this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither
- *                    parameter is specified, the WGS84 ellipsoid is used.
+ *                    parameter is specified, the default ellipsoid is used.
  * @property {number} [cells=8] The number of grids cells.
  * @property {Color} [color=Color(1.0, 1.0, 1.0, 0.4)] The color to draw grid lines.
  * @property {Color} [glowColor=Color(0.0, 1.0, 0.0, 0.05)] The color to draw glow for grid lines.

package/Source/Scene/ImageryLayerCollection.js

@@ -436,7 +436,7 @@ ImageryLayerCollection.prototype.pickImageryLayers = function (ray, scene) {
     return;
   }
 
-  const pickedLocation = scene.globe.ellipsoid.cartesianToCartographic(
+  const pickedLocation = scene.ellipsoid.cartesianToCartographic(
     pickedPosition
   );
 
@@ -491,7 +491,7 @@ ImageryLayerCollection.prototype.pickImageryLayerFeatures = function (
     return;
   }
 
-  const pickedLocation = scene.globe.ellipsoid.cartesianToCartographic(
+  const pickedLocation = scene.ellipsoid.cartesianToCartographic(
     pickedPosition
   );
 

package/Source/Scene/Label.js

@@ -91,7 +91,7 @@ function parseFont(label) {
  * Initialization options for the Label constructor
  *
  * @property {Cartesian3} position The cartesian position of the label.
- * @property {string} [id] A user-defined object to return when the label is picked with {@link Scene#pick}.
+ * @property {*} [id] A user-defined object to return when the label is picked with {@link Scene#pick}.
  * @property {boolean} [show=true] Determines if this label will be shown.
  * @property {string} [text] A string specifying the text of the label.
  * @property {string} [font='30px sans-serif'] A string specifying the font used to draw this label. Fonts are specified using the same syntax as the CSS 'font' property.

package/Source/Scene/MapboxImageryProvider.js

@@ -19,7 +19,7 @@ const defaultCredit = new Credit(
  * @property {string} mapId The Mapbox Map ID.
  * @property {string} accessToken The public access token for the imagery.
  * @property {string} [format='png'] The format of the image request.
- * @property {Ellipsoid} [ellipsoid] The ellipsoid.  If not specified, the WGS84 ellipsoid is used.
+ * @property {Ellipsoid} [ellipsoid=Ellipsoid.default] The ellipsoid.  If not specified, the default ellipsoid is used.
  * @property {number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider.  Take care when specifying
  *                 this that the number of tiles at the minimum level is small, such as four or less.  A larger number is likely
  *                 to result in rendering problems.

package/Source/Scene/MapboxStyleImageryProvider.js

@@ -21,7 +21,7 @@ const defaultCredit = new Credit(
  * @property {string} accessToken The public access token for the imagery.
  * @property {number} [tilesize=512] The size of the image tiles.
  * @property {boolean} [scaleFactor] Determines if tiles are rendered at a @2x scale factor.
- * @property {Ellipsoid} [ellipsoid] The ellipsoid.  If not specified, the WGS84 ellipsoid is used.
+ * @property {Ellipsoid} [ellipsoid=Ellipsoid.default] The ellipsoid.  If not specified, the default ellipsoid is used.
  * @property {number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider.  Take care when specifying
  *                 this that the number of tiles at the minimum level is small, such as four or less.  A larger number is likely
  *                 to result in rendering problems.

package/Source/Scene/MetadataSemantic.js

@@ -65,7 +65,7 @@ const MetadataSemantic = {
    */
   TILE_BOUNDING_SPHERE: "TILE_BOUNDING_SPHERE",
   /**
-   * The minimum height of a tile above (or below) the WGS84 ellipsoid, stored as a <code>FLOAT32</code> or a <code>FLOAT64</code>. This semantic is used to tighten bounding regions implicitly calculated in implicit tiling.
+   * The minimum height of a tile above (or below) the ellipsoid, stored as a <code>FLOAT32</code> or a <code>FLOAT64</code>. This semantic is used to tighten bounding regions implicitly calculated in implicit tiling.
    *
    * @type {string}
    * @constant
@@ -73,7 +73,7 @@ const MetadataSemantic = {
    */
   TILE_MINIMUM_HEIGHT: "TILE_MINIMUM_HEIGHT",
   /**
-   * The maximum height of a tile above (or below) the WGS84 ellipsoid, stored as a <code>FLOAT32</code> or a <code>FLOAT64</code>. This semantic is used to tighten bounding regions implicitly calculated in implicit tiling.
+   * The maximum height of a tile above (or below) the ellipsoid, stored as a <code>FLOAT32</code> or a <code>FLOAT64</code>. This semantic is used to tighten bounding regions implicitly calculated in implicit tiling.
    *
    * @type {string}
    * @constant
@@ -123,7 +123,7 @@ const MetadataSemantic = {
    */
   CONTENT_BOUNDING_SPHERE: "CONTENT_BOUNDING_SPHERE",
   /**
-   * The minimum height of the content of a tile above (or below) the WGS84 ellipsoid, stored as a <code>FLOAT32</code> or a <code>FLOAT64</code>
+   * The minimum height of the content of a tile above (or below) the ellipsoid, stored as a <code>FLOAT32</code> or a <code>FLOAT64</code>
    *
    * @type {string}
    * @constant
@@ -131,7 +131,7 @@ const MetadataSemantic = {
    */
   CONTENT_MINIMUM_HEIGHT: "CONTENT_MINIMUM_HEIGHT",
   /**
-   * The maximum height of the content of a tile above (or below) the WGS84 ellipsoid, stored as a <code>FLOAT32</code> or a <code>FLOAT64</code>
+   * The maximum height of the content of a tile above (or below) the ellipsoid, stored as a <code>FLOAT32</code> or a <code>FLOAT64</code>
    *
    * @type {string}
    * @constant

package/Source/Scene/Model/AlphaPipelineStage.js

@@ -7,7 +7,7 @@ import Pass from "../../Renderer/Pass.js";
 /**
  * A pipeline stage for configuring the alpha options for handling translucency.
  *
- * @namespace MaterialPipelineStage
+ * @namespace AlphaPipelineStage
  *
  * @private
  */

package/Source/Scene/Model/GeometryPipelineStage.js

@@ -63,8 +63,7 @@ GeometryPipelineStage.process = function (
   primitive,
   frameState
 ) {
-  const shaderBuilder = renderResources.shaderBuilder;
-  const model = renderResources.model;
+  const { shaderBuilder, model } = renderResources;
 
   // These structs are similar, though the fragment shader version has a couple
   // additional fields.
@@ -125,8 +124,7 @@ GeometryPipelineStage.process = function (
   );
 
   // .pnts point clouds store sRGB color rather than linear color
-  const modelType = model.type;
-  if (modelType === ModelType.TILE_PNTS) {
+  if (model.type === ModelType.TILE_PNTS) {
     shaderBuilder.addDefine(
       "HAS_SRGB_COLOR",
       undefined,
@@ -246,8 +244,7 @@ function processAttribute(
 }
 
 function addSemanticDefine(shaderBuilder, attribute) {
-  const semantic = attribute.semantic;
-  const setIndex = attribute.setIndex;
+  const { semantic, setIndex } = attribute;
   switch (semantic) {
     case VertexAttributeSemantic.NORMAL:
       shaderBuilder.addDefine("HAS_NORMALS");
@@ -272,19 +269,11 @@ function addAttributeToRenderResources(
   attributeIndex,
   modifyFor2D
 ) {
-  const quantization = attribute.quantization;
-  let type;
-  let componentDatatype;
-  if (defined(quantization)) {
-    type = quantization.type;
-    componentDatatype = quantization.componentDatatype;
-  } else {
-    type = attribute.type;
-    componentDatatype = attribute.componentDatatype;
-  }
+  const { quantization, semantic, setIndex } = attribute;
+  const { type, componentDatatype } = defined(quantization)
+    ? quantization
+    : attribute;
 
-  const semantic = attribute.semantic;
-  const setIndex = attribute.setIndex;
   if (
     semantic === VertexAttributeSemantic.FEATURE_ID &&
     setIndex >= renderResources.featureIdVertexAttributeSetIndex
@@ -337,18 +326,10 @@ function addMatrixAttributeToRenderResources(
   attributeIndex,
   columnCount
 ) {
-  const quantization = attribute.quantization;
-  let type;
-  let componentDatatype;
-  if (defined(quantization)) {
-    type = quantization.type;
-    componentDatatype = quantization.componentDatatype;
-  } else {
-    type = attribute.type;
-    componentDatatype = attribute.componentDatatype;
-  }
-
-  const normalized = attribute.normalized;
+  const { quantization, normalized } = attribute;
+  const { type, componentDatatype } = defined(quantization)
+    ? quantization
+    : attribute;
 
   // componentCount is either 4, 9 or 16
   const componentCount = AttributeType.getNumberOfComponents(type);
@@ -435,7 +416,7 @@ function addAttributeDeclaration(shaderBuilder, attributeInfo, modifyFor2D) {
 function updateAttributesStruct(shaderBuilder, attributeInfo, use2D) {
   const vsStructId = GeometryPipelineStage.STRUCT_ID_PROCESSED_ATTRIBUTES_VS;
   const fsStructId = GeometryPipelineStage.STRUCT_ID_PROCESSED_ATTRIBUTES_FS;
-  const variableName = attributeInfo.variableName;
+  const { variableName, glslType } = attributeInfo;
 
   if (variableName === "tangentMC") {
     // The w component of the tangent is only used for computing the bitangent,
@@ -451,16 +432,8 @@ function updateAttributesStruct(shaderBuilder, attributeInfo, use2D) {
     shaderBuilder.addStructField(vsStructId, "vec3", "normalMC");
     shaderBuilder.addStructField(fsStructId, "vec3", "normalEC");
   } else {
-    shaderBuilder.addStructField(
-      vsStructId,
-      attributeInfo.glslType,
-      variableName
-    );
-    shaderBuilder.addStructField(
-      fsStructId,
-      attributeInfo.glslType,
-      variableName
-    );
+    shaderBuilder.addStructField(vsStructId, glslType, variableName);
+    shaderBuilder.addStructField(fsStructId, glslType, variableName);
   }
 
   if (variableName === "positionMC" && use2D) {
@@ -501,8 +474,7 @@ function updateInitializeAttributesFunction(
 }
 
 function updateSetDynamicVaryingsFunction(shaderBuilder, attributeInfo) {
-  const semantic = attributeInfo.attribute.semantic;
-  const setIndex = attributeInfo.attribute.setIndex;
+  const { semantic, setIndex } = attributeInfo.attribute;
   if (defined(semantic) && !defined(setIndex)) {
     // positions, normals, and tangents are handled statically in
     // GeometryStageVS

package/Source/Scene/Model/ImageBasedLightingPipelineStage.js

@@ -8,6 +8,13 @@ const ImageBasedLightingPipelineStage = {
   name: "ImageBasedLightingPipelineStage", // Helps with debugging
 };
 
+/**
+ * Add shader code, uniforms, and defines related to image based lighting
+ * @param {ModelRenderResources} renderResources
+ * @param {Model} model
+ * @param {FrameState} frameState
+ * @private
+ */
 ImageBasedLightingPipelineStage.process = function (
   renderResources,
   model,

package/Source/Scene/Model/InstancingPipelineStage.js

@@ -276,7 +276,7 @@ function projectPositionTo2D(
     projectedPositionScratch
   );
 
-  result = SceneTransforms.computeActualWgs84Position(
+  result = SceneTransforms.computeActualEllipsoidPosition(
     frameState,
     finalPosition,
     result
@@ -432,7 +432,7 @@ function computeReferencePoint2D(renderResources, frameState) {
     scratchProjectedMin
   );
 
-  const projectedMin = SceneTransforms.computeActualWgs84Position(
+  const projectedMin = SceneTransforms.computeActualEllipsoidPosition(
     frameState,
     transformedPositionMin,
     transformedPositionMin
@@ -444,7 +444,7 @@ function computeReferencePoint2D(renderResources, frameState) {
     scratchProjectedMax
   );
 
-  const projectedMax = SceneTransforms.computeActualWgs84Position(
+  const projectedMax = SceneTransforms.computeActualEllipsoidPosition(
     frameState,
     transformedPositionMax,
     transformedPositionMax

package/Source/Scene/Model/LightingPipelineStage.js

@@ -28,9 +28,7 @@ const LightingPipelineStage = {
  * @private
  */
 LightingPipelineStage.process = function (renderResources, primitive) {
-  const model = renderResources.model;
-  const lightingOptions = renderResources.lightingOptions;
-  const shaderBuilder = renderResources.shaderBuilder;
+  const { model, lightingOptions, shaderBuilder } = renderResources;
 
   if (defined(model.lightColor)) {
     shaderBuilder.addDefine(
@@ -53,7 +51,7 @@ LightingPipelineStage.process = function (renderResources, primitive) {
 
   // The lighting model is always set by the material. However, custom shaders
   // can override this.
-  const lightingModel = lightingOptions.lightingModel;
+  const { lightingModel } = lightingOptions;
 
   if (lightingModel === LightingModel.PBR) {
     shaderBuilder.addDefine(