@cesium/engine 24.0.0 → 26.0.0

package/Source/Scene/MVTDataProvider.js

@@ -0,0 +1,147 @@
+// @ts-check
+
+import Axis from "./Axis.js";
+import Empty3DTileContent from "./Empty3DTileContent.js";
+import RuntimeError from "../Core/RuntimeError.js";
+import UrlTemplate3DTilesDataProvider from "./UrlTemplate3DTilesDataProvider.js";
+import VectorGltf3DTileContent from "./VectorGltf3DTileContent.js";
+import buildVectorGltfFromMVT from "./buildVectorGltfFromMVT.js";
+import decodeMVT from "./decodeMVT.js";
+import oneTimeWarning from "../Core/oneTimeWarning.js";
+import defined from "../Core/defined.js";
+
+/** @import Cesium3DTile from "./Cesium3DTile.js"; */
+/** @import Cesium3DTileset from "./Cesium3DTileset.js"; */
+/** @import Rectangle from "../Core/Rectangle.js"; */
+/** @import Resource from "../Core/Resource.js"; */
+
+/**
+ * A Mapbox Vector Tiles (MVT) data provider. Loads .mvt or .pbf tiles, converting tiles
+ * dynamically (at runtime) into 3D Tiles.
+ *
+ * <div class="notice">
+ * This object is normally not instantiated directly, use {@link MVTDataProvider.fromUrl}.
+ * </div>
+ *
+ * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
+ */
+class MVTDataProvider extends UrlTemplate3DTilesDataProvider {
+  /**
+   * Creates an MVTDataProvider from the specified URL template and options.
+   *
+   * @param {Resource|string} url URL template, containing {z}, {x}, and {y} placeholders.
+   * @param {object} [options] Provider options.
+   * @param {number} [options.minZoom=0] Minimum zoom level represented in the generated tileset.
+   * @param {number} [options.maxZoom=14] Maximum zoom level represented in the generated tileset.
+   * @param {Rectangle} [options.extent] Optional geographic extent in radians to constrain the generated tile tree.
+   * @param {string} [options.featureIdProperty] MVT property name to use as feature ID.
+   */
+  static async fromUrl(url, options) {
+    return /** @type {Promise<MVTDataProvider>} */ (
+      super.fromUrl(url, options)
+    );
+  }
+
+  /**
+   * @returns {object}
+   * @protected
+   * @ignore
+   */
+  _createTilesetLoadOptions() {
+    return {
+      skipLevelOfDetail: false,
+      enablePick: true,
+      featureIdLabel: "featureId_0",
+      instanceFeatureIdLabel: "instanceFeatureId_0",
+    };
+  }
+
+  /**
+   * @param {Cesium3DTileset} tileset
+   * @protected
+   * @ignore
+   */
+  _configureTileset(tileset) {
+    tileset._modelUpAxis = Axis.Z;
+    tileset._modelForwardAxis = Axis.X;
+  }
+
+  /**
+   * @returns {object}
+   * @protected
+   * @ignore
+   */
+  _createCodec() {
+    const featureIdProperty = this._featureIdProperty;
+    return {
+      contentType: "mvt",
+      missingTilePolicy: { statusCodes: [404, 204] },
+
+      /**
+       * @param {Cesium3DTileset} tileset
+       * @param {Cesium3DTile} tile
+       * @param {Resource} resource
+       * @param {ArrayBuffer} arrayBuffer
+       * @ignore
+       */
+      createContent: async (tileset, tile, resource, arrayBuffer) => {
+        const decodedTile = decodeMVT(arrayBuffer);
+        const tileCoordinates = parseTileCoordinates(
+          resource.getUrlComponent(true),
+        );
+        const glb = buildVectorGltfFromMVT(decodedTile, tileCoordinates, {
+          featureIdProperty: featureIdProperty,
+        });
+        if (!defined(glb)) {
+          if (!hasAnyDecodedFeatures(decodedTile)) {
+            return new Empty3DTileContent(tileset, tile);
+          }
+          throw new RuntimeError(
+            "Decoded MVT tile did not produce vector glTF content.",
+          );
+        }
+        return VectorGltf3DTileContent.fromGltf(tileset, tile, resource, glb);
+      },
+    };
+  }
+}
+
+/**
+ * @param {string} url
+ * @returns {{tileZ:number, tileX:number, tileY:number}}
+ * @ignore
+ */
+function parseTileCoordinates(url) {
+  const match = url.match(/\/(\d+)\/(\d+)\/(\d+)(?:\.[^/?#]+)?(?:[?#]|$)/i);
+  if (!match) {
+    oneTimeWarning(
+      "MVTDataProvider.parseTileCoordinates",
+      `MVT tile URL did not match /{z}/{x}/{y} pattern. Falling back to z/x/y = 0/0/0. URL: ${url}`,
+    );
+    return { tileZ: 0, tileX: 0, tileY: 0 };
+  }
+  return {
+    tileZ: parseInt(match[1], 10),
+    tileX: parseInt(match[2], 10),
+    tileY: parseInt(match[3], 10),
+  };
+}
+
+/**
+ * @param {{layers:Array<{features:Array<*>}>}} decodedTile
+ * @returns {boolean}
+ * @ignore
+ */
+function hasAnyDecodedFeatures(decodedTile) {
+  const layers = decodedTile.layers;
+  for (let i = 0; i < layers.length; i++) {
+    if (layers[i].features.length > 0) {
+      return true;
+    }
+  }
+  return false;
+}
+
+MVTDataProvider._parseTileCoordinates = parseTileCoordinates;
+
+export default MVTDataProvider;

package/Source/Scene/MapMode2D.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 /**
  * Describes how the map will operate in 2D.
  *
@@ -20,4 +22,7 @@ const MapMode2D = {
    */
   INFINITE_SCROLL: 1,
 };
-export default Object.freeze(MapMode2D);
+
+Object.freeze(MapMode2D);
+
+export default MapMode2D;

package/Source/Scene/MetadataComponentType.js

@@ -593,4 +593,6 @@ MetadataComponentType.getDataViewAccessors = function (view, componentType) {
   return accessors[componentType];
 };
 
-export default Object.freeze(MetadataComponentType);
+Object.freeze(MetadataComponentType);
+
+export default MetadataComponentType;

package/Source/Scene/MetadataSchemaLoader.js

@@ -51,7 +51,6 @@ class MetadataSchemaLoader extends ResourceLoader {
   /**
    * The cache key of the resource.
    *
-   * @memberof MetadataSchemaLoader.prototype
    *
    * @type {string}
    * @readonly
@@ -64,7 +63,6 @@ class MetadataSchemaLoader extends ResourceLoader {
   /**
    * The metadata schema object.
    *
-   * @memberof MetadataSchemaLoader.prototype
    *
    * @type {MetadataSchema}
    * @readonly

package/Source/Scene/MetadataSemantic.js

@@ -1,7 +1,9 @@
+// @ts-check
+
 /**
  * An enum of built-in semantics.
  *
- * @enum MetadataSemantic
+ * @enum {string}
  *
  * @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.
@@ -150,4 +152,6 @@ const MetadataSemantic = {
   CONTENT_HORIZON_OCCLUSION_POINT: "CONTENT_HORIZON_OCCLUSION_POINT",
 };
 
-export default Object.freeze(MetadataSemantic);
+Object.freeze(MetadataSemantic);
+
+export default MetadataSemantic;

package/Source/Scene/MetadataType.js

@@ -217,4 +217,6 @@ MetadataType.getMathType = function (type) {
   }
 };
 
-export default Object.freeze(MetadataType);
+Object.freeze(MetadataType);
+
+export default MetadataType;

package/Source/Scene/Model/B3dmLoader.js

@@ -118,7 +118,6 @@ class B3dmLoader extends ResourceLoader {
   /**
    * true if textures are loaded, useful when incrementallyLoadTextures is true
    *
-   * @memberof B3dmLoader.prototype
    *
    * @type {boolean}
    * @readonly
@@ -131,7 +130,6 @@ class B3dmLoader extends ResourceLoader {
   /**
    * The cache key of the resource
    *
-   * @memberof B3dmLoader.prototype
    *
    * @type {string}
    * @readonly
@@ -144,7 +142,6 @@ class B3dmLoader extends ResourceLoader {
   /**
    * The loaded components.
    *
-   * @memberof B3dmLoader.prototype
    *
    * @type {ModelComponents.Components}
    * @readonly

package/Source/Scene/Model/CustomShaderMode.js

@@ -37,4 +37,6 @@ CustomShaderMode.getDefineName = function (customShaderMode) {
   return `CUSTOM_SHADER_${customShaderMode}`;
 };
 
-export default Object.freeze(CustomShaderMode);
+Object.freeze(CustomShaderMode);
+
+export default CustomShaderMode;

package/Source/Scene/Model/CustomShaderTranslucencyMode.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 /**
  * An enum for controling how {@link CustomShader} handles translucency compared with the original
  * primitive.
@@ -32,4 +34,6 @@ const CustomShaderTranslucencyMode = {
   TRANSLUCENT: 2,
 };
 
-export default Object.freeze(CustomShaderTranslucencyMode);
+Object.freeze(CustomShaderTranslucencyMode);
+
+export default CustomShaderTranslucencyMode;