@cesium/engine 10.1.0 → 11.1.0

package/Source/Scene/Material.js

@@ -34,6 +34,7 @@ import SlopeRampMaterial from "../Shaders/Materials/SlopeRampMaterial.js";
 import StripeMaterial from "../Shaders/Materials/StripeMaterial.js";
 import TextureMagnificationFilter from "../Renderer/TextureMagnificationFilter.js";
 import TextureMinificationFilter from "../Renderer/TextureMinificationFilter.js";
+import WaterMaskMaterial from "../Shaders/Materials/WaterMaskMaterial.js";
 import WaterMaterial from "../Shaders/Materials/Water.js";
 
 /**
@@ -219,6 +220,11 @@ import WaterMaterial from "../Shaders/Materials/Water.js";
  *      <li><code>heights</code>: image of heights sorted from lowest to highest.</li>
  *      <li><code>colors</code>: image of colors at the corresponding heights.</li>
  * </ul>
+ * <li>WaterMask</li>
+ * <ul>
+ *      <li><code>waterColor</code>: diffuse color and alpha for the areas covered by water.</li>
+ *      <li><code>landColor</code>: diffuse color and alpha for the areas covered by land.</li>
+ * </ul>
  * </ul>
  * </ul>
  * </div>
@@ -233,7 +239,6 @@ import WaterMaterial from "../Shaders/Materials/Water.js";
  * @param {TextureMinificationFilter} [options.minificationFilter=TextureMinificationFilter.LINEAR] The {@link TextureMinificationFilter} to apply to this material's textures.
  * @param {TextureMagnificationFilter} [options.magnificationFilter=TextureMagnificationFilter.LINEAR] The {@link TextureMagnificationFilter} to apply to this material's textures.
  * @param {object} options.fabric The fabric JSON used to generate the material.
- *ructor
  *
  * @exception {DeveloperError} fabric: uniform has invalid type.
  * @exception {DeveloperError} fabric: uniforms and materials cannot share the same property.
@@ -245,7 +250,6 @@ import WaterMaterial from "../Shaders/Materials/Water.js";
  * @exception {DeveloperError} strict: shader source does not use material.
  *
  * @see {@link https://github.com/CesiumGS/cesium/wiki/Fabric|Fabric wiki page} for a more detailed options of Fabric.
- *
  * @demo {@link https://sandcastle.cesium.com/index.html?src=Materials.html|Cesium Sandcastle Materials Demo}
  *
  * @example
@@ -306,11 +310,11 @@ function Material(options) {
 
   this._minificationFilter = defaultValue(
     options.minificationFilter,
-    TextureMinificationFilter.LINEAR
+    TextureMinificationFilter.LINEAR,
   );
   this._magnificationFilter = defaultValue(
     options.magnificationFilter,
-    TextureMagnificationFilter.LINEAR
+    TextureMagnificationFilter.LINEAR,
   );
 
   this._strict = undefined;
@@ -586,13 +590,13 @@ function initializeMaterial(options, result) {
   result._strict = defaultValue(options.strict, false);
   result._count = defaultValue(options.count, 0);
   result._template = clone(
-    defaultValue(options.fabric, defaultValue.EMPTY_OBJECT)
+    defaultValue(options.fabric, defaultValue.EMPTY_OBJECT),
   );
   result._template.uniforms = clone(
-    defaultValue(result._template.uniforms, defaultValue.EMPTY_OBJECT)
+    defaultValue(result._template.uniforms, defaultValue.EMPTY_OBJECT),
   );
   result._template.materials = clone(
-    defaultValue(result._template.materials, defaultValue.EMPTY_OBJECT)
+    defaultValue(result._template.materials, defaultValue.EMPTY_OBJECT),
   );
 
   result.type = defined(result._template.type)
@@ -705,7 +709,7 @@ function checkForTemplateErrors(material) {
   //>>includeStart('debug', pragmas.debug);
   if (defined(components) && defined(template.source)) {
     throw new DeveloperError(
-      "fabric: cannot have source and components in the same template."
+      "fabric: cannot have source and components in the same template.",
     );
   }
   //>>includeEnd('debug');
@@ -716,7 +720,7 @@ function checkForTemplateErrors(material) {
     components,
     componentProperties,
     invalidNameError,
-    true
+    true,
   );
 
   // Make sure uniforms and materials do not share any of the same names.
@@ -1002,7 +1006,7 @@ function createUniform(material, uniformId) {
   //>>includeStart('debug', pragmas.debug);
   if (!defined(uniformType)) {
     throw new DeveloperError(
-      `fabric: uniform '${uniformId}' has invalid type.`
+      `fabric: uniform '${uniformId}' has invalid type.`,
     );
   }
   //>>includeEnd('debug');
@@ -1013,7 +1017,7 @@ function createUniform(material, uniformId) {
     //>>includeStart('debug', pragmas.debug);
     if (replacedTokenCount === 0 && strict) {
       throw new DeveloperError(
-        `strict: shader source does not use channels '${uniformId}'.`
+        `strict: shader source does not use channels '${uniformId}'.`,
       );
     }
     //>>includeEnd('debug');
@@ -1034,7 +1038,7 @@ function createUniform(material, uniformId) {
 
     // Add uniform declaration to source code.
     const uniformDeclarationRegex = new RegExp(
-      `uniform\\s+${uniformType}\\s+${uniformId}\\s*;`
+      `uniform\\s+${uniformType}\\s+${uniformId}\\s*;`,
     );
     if (!uniformDeclarationRegex.test(material.shaderSource)) {
       const uniformDeclaration = `uniform ${uniformType} ${uniformId};`;
@@ -1046,7 +1050,7 @@ function createUniform(material, uniformId) {
     //>>includeStart('debug', pragmas.debug);
     if (replacedTokenCount === 1 && strict) {
       throw new DeveloperError(
-        `strict: shader source does not use uniform '${uniformId}'.`
+        `strict: shader source does not use uniform '${uniformId}'.`,
       );
     }
     //>>includeEnd('debug');
@@ -1069,7 +1073,7 @@ function createUniform(material, uniformId) {
       material._uniforms[newUniformId] = function () {
         return matrixMap[uniformType].fromColumnMajorArray(
           material.uniforms[uniformId],
-          scratchMatrix
+          scratchMatrix,
         );
       };
     } else {
@@ -1146,11 +1150,11 @@ function createSubMaterials(material) {
       material._uniforms = combine(
         material._uniforms,
         subMaterial._uniforms,
-        true
+        true,
       );
       material.materials[subMaterialId] = subMaterial;
       material._translucentFunctions = material._translucentFunctions.concat(
-        subMaterial._translucentFunctions
+        subMaterial._translucentFunctions,
       );
 
       // Make the material's czm_getMaterial unique by appending the sub-material type.
@@ -1164,12 +1168,12 @@ function createSubMaterials(material) {
       const tokensReplacedCount = replaceToken(
         material,
         subMaterialId,
-        materialMethodCall
+        materialMethodCall,
       );
       //>>includeStart('debug', pragmas.debug);
       if (tokensReplacedCount === 0 && strict) {
         throw new DeveloperError(
-          `strict: shader source does not use material '${subMaterialId}'.`
+          `strict: shader source does not use material '${subMaterialId}'.`,
         );
       }
       //>>includeEnd('debug');
@@ -1186,17 +1190,16 @@ function replaceToken(material, token, newToken, excludePeriod) {
   const suffixChars = "([\\w])?";
   const prefixChars = `([\\w${excludePeriod ? "." : ""}])?`;
   const regExp = new RegExp(prefixChars + token + suffixChars, "g");
-  material.shaderSource = material.shaderSource.replace(regExp, function (
-    $0,
-    $1,
-    $2
-  ) {
-    if ($1 || $2) {
-      return $0;
-    }
-    count += 1;
-    return newToken;
-  });
+  material.shaderSource = material.shaderSource.replace(
+    regExp,
+    function ($0, $1, $2) {
+      if ($1 || $2) {
+        return $0;
+      }
+      count += 1;
+      return newToken;
+    },
+  );
   return count;
 }
 
@@ -1739,4 +1742,22 @@ Material._materialCache.addMaterial(Material.ElevationBandType, {
   translucent: true,
 });
 
+/**
+ * Gets the name of the water mask material.
+ * @type {string}
+ * @readonly
+ */
+Material.WaterMaskType = "WaterMask";
+Material._materialCache.addMaterial(Material.WaterMaskType, {
+  fabric: {
+    type: Material.WaterMaskType,
+    source: WaterMaskMaterial,
+    uniforms: {
+      waterColor: new Color(1.0, 1.0, 1.0, 1.0),
+      landColor: new Color(0.0, 0.0, 0.0, 0.0),
+    },
+  },
+  translucent: false,
+});
+
 export default Material;

package/Source/Scene/MaterialAppearance.js

@@ -53,7 +53,7 @@ function MaterialAppearance(options) {
   const closed = defaultValue(options.closed, false);
   const materialSupport = defaultValue(
     options.materialSupport,
-    MaterialAppearance.MaterialSupport.TEXTURED
+    MaterialAppearance.MaterialSupport.TEXTURED,
   );
 
   /**
@@ -81,16 +81,16 @@ function MaterialAppearance(options) {
 
   this._vertexShaderSource = defaultValue(
     options.vertexShaderSource,
-    materialSupport.vertexShaderSource
+    materialSupport.vertexShaderSource,
   );
   this._fragmentShaderSource = defaultValue(
     options.fragmentShaderSource,
-    materialSupport.fragmentShaderSource
+    materialSupport.fragmentShaderSource,
   );
   this._renderState = Appearance.getDefaultRenderState(
     translucent,
     closed,
-    options.renderState
+    options.renderState,
   );
   this._closed = closed;
 

package/Source/Scene/Megatexture.js

@@ -34,7 +34,7 @@ function Megatexture(
   dimensions,
   channelCount,
   componentType,
-  textureMemoryByteLength
+  textureMemoryByteLength,
 ) {
   // TODO there are a lot of texture packing rules, see https://github.com/CesiumGS/cesium/issues/9572
   // Unsigned short textures not allowed in webgl 1, so treat as float
@@ -76,18 +76,17 @@ function Megatexture(
   const defaultTextureMemoryByteLength = 128 * 1024 * 1024;
   textureMemoryByteLength = Math.min(
     defaultValue(textureMemoryByteLength, defaultTextureMemoryByteLength),
-    maximumTextureMemoryByteLength
+    maximumTextureMemoryByteLength,
   );
   const maximumTextureDimensionContext = ContextLimits.maximumTextureSize;
-  const componentTypeByteLength = MetadataComponentType.getSizeInBytes(
-    componentType
-  );
+  const componentTypeByteLength =
+    MetadataComponentType.getSizeInBytes(componentType);
   const texelCount = Math.floor(
-    textureMemoryByteLength / (channelCount * componentTypeByteLength)
+    textureMemoryByteLength / (channelCount * componentTypeByteLength),
   );
   const textureDimension = Math.min(
     maximumTextureDimensionContext,
-    CesiumMath.previousPowerOfTwo(Math.floor(Math.sqrt(texelCount)))
+    CesiumMath.previousPowerOfTwo(Math.floor(Math.sqrt(texelCount))),
   );
 
   const sliceCountPerRegionX = Math.ceil(Math.sqrt(dimensions.x));
@@ -95,10 +94,10 @@ function Megatexture(
   const voxelCountPerRegionX = sliceCountPerRegionX * dimensions.x;
   const voxelCountPerRegionY = sliceCountPerRegionY * dimensions.y;
   const regionCountPerMegatextureX = Math.floor(
-    textureDimension / voxelCountPerRegionX
+    textureDimension / voxelCountPerRegionX,
   );
   const regionCountPerMegatextureY = Math.floor(
-    textureDimension / voxelCountPerRegionY
+    textureDimension / voxelCountPerRegionY,
   );
 
   if (regionCountPerMegatextureX === 0 || regionCountPerMegatextureY === 0) {
@@ -136,7 +135,7 @@ function Megatexture(
    */
   this.regionCountPerMegatexture = new Cartesian2(
     regionCountPerMegatextureX,
-    regionCountPerMegatextureY
+    regionCountPerMegatextureY,
   );
 
   /**
@@ -145,7 +144,7 @@ function Megatexture(
    */
   this.voxelCountPerRegion = new Cartesian2(
     voxelCountPerRegionX,
-    voxelCountPerRegionY
+    voxelCountPerRegionY,
   );
 
   /**
@@ -154,7 +153,7 @@ function Megatexture(
    */
   this.sliceCountPerRegion = new Cartesian2(
     sliceCountPerRegionX,
-    sliceCountPerRegionY
+    sliceCountPerRegionY,
   );
 
   /**
@@ -163,7 +162,7 @@ function Megatexture(
    */
   this.voxelSizeUv = new Cartesian2(
     1.0 / textureDimension,
-    1.0 / textureDimension
+    1.0 / textureDimension,
   );
 
   /**
@@ -172,7 +171,7 @@ function Megatexture(
    */
   this.sliceSizeUv = new Cartesian2(
     dimensions.x / textureDimension,
-    dimensions.y / textureDimension
+    dimensions.y / textureDimension,
   );
 
   /**
@@ -181,7 +180,7 @@ function Megatexture(
    */
   this.regionSizeUv = new Cartesian2(
     voxelCountPerRegionX / textureDimension,
-    voxelCountPerRegionY / textureDimension
+    voxelCountPerRegionY / textureDimension,
   );
 
   /**
@@ -203,16 +202,15 @@ function Megatexture(
     }),
   });
 
-  const componentDatatype = MetadataComponentType.toComponentDatatype(
-    componentType
-  );
+  const componentDatatype =
+    MetadataComponentType.toComponentDatatype(componentType);
 
   /**
    * @type {Array}
    */
   this.tileVoxelDataTemp = ComponentDatatype.createTypedArray(
     componentDatatype,
-    voxelCountPerRegionX * voxelCountPerRegionY * channelCount
+    voxelCountPerRegionX * voxelCountPerRegionY * channelCount,
   );
 
   /**
@@ -351,7 +349,7 @@ Megatexture.getApproximateTextureMemoryByteLength = function (
   tileCount,
   dimensions,
   channelCount,
-  componentType
+  componentType,
 ) {
   // TODO there's a lot of code duplicate with Megatexture constructor
 
@@ -360,9 +358,8 @@ Megatexture.getApproximateTextureMemoryByteLength = function (
     componentType = MetadataComponentType.FLOAT32;
   }
 
-  const datatypeSizeInBytes = MetadataComponentType.getSizeInBytes(
-    componentType
-  );
+  const datatypeSizeInBytes =
+    MetadataComponentType.getSizeInBytes(componentType);
   const voxelCountTotal =
     tileCount * dimensions.x * dimensions.y * dimensions.z;
 
@@ -374,7 +371,7 @@ Megatexture.getApproximateTextureMemoryByteLength = function (
   // Find the power of two that can fit all tile data, accounting for slices.
   // There's probably a non-iterative solution for this, but this is good enough for now.
   let textureDimension = CesiumMath.previousPowerOfTwo(
-    Math.floor(Math.sqrt(voxelCountTotal))
+    Math.floor(Math.sqrt(voxelCountTotal)),
   );
   for (;;) {
     const regionCountX = Math.floor(textureDimension / voxelCountPerRegionX);

package/Source/Scene/MetadataClassProperty.js

@@ -81,7 +81,7 @@ function MetadataClassProperty(options) {
   this._isArray = defaultValue(options.isArray, false);
   this._isVariableLengthArray = defaultValue(
     options.isVariableLengthArray,
-    false
+    false,
   );
   this._arrayLength = options.arrayLength;
 
@@ -668,7 +668,7 @@ function parseType(property, enums) {
 
   //>>includeStart('debug', pragmas.debug);
   throw new DeveloperError(
-    `unknown metadata type {type: ${type}, componentType: ${componentType})`
+    `unknown metadata type {type: ${type}, componentType: ${componentType})`,
   );
   //>>includeEnd('debug');
 }
@@ -702,7 +702,7 @@ MetadataClassProperty.prototype.normalize = function (value) {
   return normalizeInPlace(
     value,
     this._valueType,
-    MetadataComponentType.normalize
+    MetadataComponentType.normalize,
   );
 };
 
@@ -735,7 +735,7 @@ MetadataClassProperty.prototype.unnormalize = function (value) {
   return normalizeInPlace(
     value,
     this._valueType,
-    MetadataComponentType.unnormalize
+    MetadataComponentType.unnormalize,
   );
 };
 
@@ -753,7 +753,7 @@ MetadataClassProperty.prototype.applyValueTransform = function (value) {
     value,
     this._offset,
     this._scale,
-    MetadataComponentType.applyValueTransform
+    MetadataComponentType.applyValueTransform,
   );
 };
 
@@ -771,7 +771,7 @@ MetadataClassProperty.prototype.unapplyValueTransform = function (value) {
     value,
     this._offset,
     this._scale,
-    MetadataComponentType.unapplyValueTransform
+    MetadataComponentType.unapplyValueTransform,
   );
 };
 
@@ -780,7 +780,7 @@ MetadataClassProperty.prototype.unapplyValueTransform = function (value) {
  */
 MetadataClassProperty.prototype.expandConstant = function (
   constant,
-  enableNestedArrays
+  enableNestedArrays,
 ) {
   enableNestedArrays = defaultValue(enableNestedArrays, false);
   const isArray = this._isArray;
@@ -871,7 +871,7 @@ function arrayEquals(left, right) {
  */
 MetadataClassProperty.prototype.unpackVectorAndMatrixTypes = function (
   value,
-  enableNestedArrays
+  enableNestedArrays,
 ) {
   enableNestedArrays = defaultValue(enableNestedArrays, false);
   const MathType = MetadataType.getMathType(this._type);
@@ -910,7 +910,7 @@ MetadataClassProperty.prototype.unpackVectorAndMatrixTypes = function (
  */
 MetadataClassProperty.prototype.packVectorAndMatrixTypes = function (
   value,
-  enableNestedArrays
+  enableNestedArrays,
 ) {
   enableNestedArrays = defaultValue(enableNestedArrays, false);
   const MathType = MetadataType.getMathType(this._type);
@@ -1145,7 +1145,7 @@ MetadataClassProperty.valueTransformInPlace = function (
   values,
   offsets,
   scales,
-  transformationFunction
+  transformationFunction,
 ) {
   if (!Array.isArray(values)) {
     // transform a single value
@@ -1158,7 +1158,7 @@ MetadataClassProperty.valueTransformInPlace = function (
       values[i],
       offsets[i],
       scales[i],
-      transformationFunction
+      transformationFunction,
     );
   }
 

package/Source/Scene/MetadataComponentType.js

@@ -295,7 +295,7 @@ MetadataComponentType.normalize = function (value, type) {
 
   return Math.max(
     Number(value) / Number(MetadataComponentType.getMaximum(type)),
-    -1.0
+    -1.0,
   );
 };
 

package/Source/Scene/MetadataEntity.js

@@ -135,7 +135,7 @@ MetadataEntity.prototype.setPropertyBySemantic = function (semantic, value) {
 MetadataEntity.hasProperty = function (
   propertyId,
   properties,
-  classDefinition
+  classDefinition,
 ) {
   //>>includeStart('debug', pragmas.debug);
   Check.typeOf.string("propertyId", propertyId);
@@ -173,7 +173,7 @@ MetadataEntity.hasProperty = function (
 MetadataEntity.hasPropertyBySemantic = function (
   semantic,
   properties,
-  classDefinition
+  classDefinition,
 ) {
   //>>includeStart('debug', pragmas.debug);
   Check.typeOf.string("semantic", semantic);
@@ -203,7 +203,7 @@ MetadataEntity.hasPropertyBySemantic = function (
 MetadataEntity.getPropertyIds = function (
   properties,
   classDefinition,
-  results
+  results,
 ) {
   //>>includeStart('debug', pragmas.debug);
   Check.typeOf.object("properties", properties);
@@ -256,7 +256,7 @@ MetadataEntity.getPropertyIds = function (
 MetadataEntity.getProperty = function (
   propertyId,
   properties,
-  classDefinition
+  classDefinition,
 ) {
   //>>includeStart('debug', pragmas.debug);
   Check.typeOf.string("propertyId", propertyId);
@@ -313,7 +313,7 @@ MetadataEntity.setProperty = function (
   propertyId,
   value,
   properties,
-  classDefinition
+  classDefinition,
 ) {
   //>>includeStart('debug', pragmas.debug);
   Check.typeOf.string("propertyId", propertyId);
@@ -361,7 +361,7 @@ MetadataEntity.setProperty = function (
 MetadataEntity.getPropertyBySemantic = function (
   semantic,
   properties,
-  classDefinition
+  classDefinition,
 ) {
   //>>includeStart('debug', pragmas.debug);
   Check.typeOf.string("semantic", semantic);
@@ -395,7 +395,7 @@ MetadataEntity.setPropertyBySemantic = function (
   semantic,
   value,
   properties,
-  classDefinition
+  classDefinition,
 ) {
   //>>includeStart('debug', pragmas.debug);
   Check.typeOf.string("semantic", semantic);
@@ -415,7 +415,7 @@ MetadataEntity.setPropertyBySemantic = function (
       property.id,
       value,
       properties,
-      classDefinition
+      classDefinition,
     );
   }
 

package/Source/Scene/MetadataEnum.js

@@ -45,7 +45,7 @@ function MetadataEnum(options) {
 
   const valueType = defaultValue(
     options.valueType,
-    MetadataComponentType.UINT16
+    MetadataComponentType.UINT16,
   );
 
   this._values = values;