@cesium/engine 24.0.0 → 26.0.0

package/Source/Scene/Cesium3DTileContent.js

@@ -1,5 +1,19 @@
+// @ts-check
+
 import DeveloperError from "../Core/DeveloperError.js";
 
+/** @import Cartesian3 from "../Core/Cartesian3.js"; */
+/** @import Cesium3DContentGroup from "./Cesium3DContentGroup.js"; */
+/** @import Cesium3DTile from "./Cesium3DTile.js"; */
+/** @import Cesium3DTileBatchTable from "./Cesium3DTileBatchTable.js"; */
+/** @import Cesium3DTileFeature from "./Cesium3DTileFeature.js"; */
+/** @import Cesium3DTileStyle from "./Cesium3DTileStyle.js"; */
+/** @import Cesium3DTileset from "./Cesium3DTileset.js"; */
+/** @import Color from "../Core/Color.js"; */
+/** @import FrameState from "./FrameState.js"; */
+/** @import ImplicitMetadataView from "./ImplicitMetadataView.js"; */
+/** @import Ray from "../Core/Ray.js"; */
+
 /**
  * The content of a tile in a {@link Cesium3DTileset}.
  * <p>
@@ -10,40 +24,35 @@ import DeveloperError from "../Core/DeveloperError.js";
  * This type describes an interface and is not intended to be instantiated directly.
  * </p>
  *
- * @alias Cesium3DTileContent
- * @constructor
+ * @interface
  */
-function Cesium3DTileContent() {
-  /**
-   * Gets or sets if any feature's property changed.  Used to
-   * optimized applying a style when a feature's property changed.
-   * <p>
-   * This is used to implement the <code>Cesium3DTileContent</code> interface, but is
-   * not part of the public Cesium API.
-   * </p>
-   *
-   * @type {boolean}
-   *
-   * @private
-   */
-  this.featurePropertiesDirty = false;
-}
+class Cesium3DTileContent {
+  constructor() {
+    /**
+     * Gets or sets if any feature's property changed.  Used to
+     * optimized applying a style when a feature's property changed.
+     * <p>
+     * This is used to implement the <code>Cesium3DTileContent</code> interface, but is
+     * not part of the public Cesium API.
+     * </p>
+     *
+     * @type {boolean}
+     *
+     * @protected
+     * @ignore
+     */
+    this.featurePropertiesDirty = false;
+  }
 
-Object.defineProperties(Cesium3DTileContent.prototype, {
   /**
    * Gets the number of features in the tile.
    *
-   * @memberof Cesium3DTileContent.prototype
    *
    * @type {number}
    * @readonly
+   * @constant
    */
-  featuresLength: {
-    // eslint-disable-next-line getter-return
-    get: function () {
-      DeveloperError.throwInstantiationError();
-    },
-  },
+  featuresLength;
 
   /**
    * Gets the number of points in the tile.
@@ -54,155 +63,105 @@ Object.defineProperties(Cesium3DTileContent.prototype, {
    *
    * @see {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/TileFormats/PointCloud#batched-points}
    *
-   * @memberof Cesium3DTileContent.prototype
    *
    * @type {number}
    * @readonly
+   * @constant
    */
-  pointsLength: {
-    // eslint-disable-next-line getter-return
-    get: function () {
-      DeveloperError.throwInstantiationError();
-    },
-  },
+  pointsLength;
 
   /**
    * Gets the number of triangles in the tile.
    *
-   * @memberof Cesium3DTileContent.prototype
    *
    * @type {number}
    * @readonly
+   * @constant
    */
-  trianglesLength: {
-    // eslint-disable-next-line getter-return
-    get: function () {
-      DeveloperError.throwInstantiationError();
-    },
-  },
+  trianglesLength;
 
   /**
    * Gets the tile's geometry memory in bytes.
    *
-   * @memberof Cesium3DTileContent.prototype
    *
    * @type {number}
    * @readonly
+   * @constant
    */
-  geometryByteLength: {
-    // eslint-disable-next-line getter-return
-    get: function () {
-      DeveloperError.throwInstantiationError();
-    },
-  },
+  geometryByteLength;
 
   /**
    * Gets the tile's texture memory in bytes.
    *
-   * @memberof Cesium3DTileContent.prototype
    *
    * @type {number}
    * @readonly
+   * @constant
    */
-  texturesByteLength: {
-    // eslint-disable-next-line getter-return
-    get: function () {
-      DeveloperError.throwInstantiationError();
-    },
-  },
+  texturesByteLength;
 
   /**
    * Gets the amount of memory used by the batch table textures and any binary
    * metadata properties not accounted for in geometryByteLength or
    * texturesByteLength
    *
-   * @memberof Cesium3DTileContent.prototype
    *
    * @type {number}
    * @readonly
+   * @constant
    */
-  batchTableByteLength: {
-    // eslint-disable-next-line getter-return
-    get: function () {
-      DeveloperError.throwInstantiationError();
-    },
-  },
+  batchTableByteLength;
 
   /**
    * Gets the array of {@link Cesium3DTileContent} objects for contents that contain other contents, such as composite tiles. The inner contents may in turn have inner contents, such as a composite tile that contains a composite tile.
    *
    * @see {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/TileFormats/Composite|Composite specification}
    *
-   * @memberof Cesium3DTileContent.prototype
    *
-   * @type {Array}
+   * @type {Array<*>}
    * @readonly
+   * @constant
    */
-  innerContents: {
-    // eslint-disable-next-line getter-return
-    get: function () {
-      DeveloperError.throwInstantiationError();
-    },
-  },
+  innerContents;
 
   /**
    * Returns true when the tile's content is ready to render; otherwise false
    *
-   * @memberof Cesium3DTileContent.prototype
    *
    * @type {boolean}
    * @readonly
+   * @constant
    */
-  ready: {
-    // eslint-disable-next-line getter-return
-    get: function () {
-      DeveloperError.throwInstantiationError();
-    },
-  },
+  ready;
 
   /**
    * Gets the tileset for this tile.
    *
-   * @memberof Cesium3DTileContent.prototype
    *
    * @type {Cesium3DTileset}
    * @readonly
+   * @constant
    */
-  tileset: {
-    // eslint-disable-next-line getter-return
-    get: function () {
-      DeveloperError.throwInstantiationError();
-    },
-  },
+  tileset;
 
   /**
    * Gets the tile containing this content.
    *
-   * @memberof Cesium3DTileContent.prototype
    *
    * @type {Cesium3DTile}
    * @readonly
+   * @constant
    */
-  tile: {
-    // eslint-disable-next-line getter-return
-    get: function () {
-      DeveloperError.throwInstantiationError();
-    },
-  },
+  tile;
 
   /**
    * Gets the url of the tile's content.
-   * @memberof Cesium3DTileContent.prototype
    *
    * @type {string}
    * @readonly
+   * @constant
    */
-  url: {
-    // eslint-disable-next-line getter-return
-    get: function () {
-      DeveloperError.throwInstantiationError();
-    },
-  },
+  url;
 
   /**
    * Gets the batch table for this content.
@@ -213,15 +172,11 @@ Object.defineProperties(Cesium3DTileContent.prototype, {
    *
    * @type {Cesium3DTileBatchTable}
    * @readonly
+   * @constant
    *
    * @private
    */
-  batchTable: {
-    // eslint-disable-next-line getter-return
-    get: function () {
-      DeveloperError.throwInstantiationError();
-    },
-  },
+  batchTable;
 
   /**
    * Gets the metadata for this content, whether it is available explicitly or via
@@ -236,15 +191,7 @@ Object.defineProperties(Cesium3DTileContent.prototype, {
    * @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.
    */
-  metadata: {
-    // eslint-disable-next-line getter-return
-    get: function () {
-      DeveloperError.throwInstantiationError();
-    },
-    set: function (value) {
-      DeveloperError.throwInstantiationError();
-    },
-  },
+  metadata;
 
   /**
    * Gets the group for this content if the content has metadata (3D Tiles 1.1) or
@@ -260,156 +207,150 @@ Object.defineProperties(Cesium3DTileContent.prototype, {
    * @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.
    */
-  group: {
-    // eslint-disable-next-line getter-return
-    get: function () {
-      DeveloperError.throwInstantiationError();
-    },
-    set: function (value) {
-      DeveloperError.throwInstantiationError();
-    },
-  },
-});
+  group;
 
-/**
- * Returns whether the feature has this property.
- *
- * @param {number} batchId The batchId for the feature.
- * @param {string} name The case-sensitive name of the property.
- * @returns {boolean} <code>true</code> if the feature has this property; otherwise, <code>false</code>.
- */
-Cesium3DTileContent.prototype.hasProperty = function (batchId, name) {
-  DeveloperError.throwInstantiationError();
-};
+  /**
+   * Returns whether the feature has this property.
+   *
+   * @param {number} batchId The batchId for the feature.
+   * @param {string} name The case-sensitive name of the property.
+   * @returns {boolean} <code>true</code> if the feature has this property; otherwise, <code>false</code>.
+   */
+  hasProperty(batchId, name) {
+    DeveloperError.throwInstantiationError();
+  }
 
-/**
- * Returns the {@link Cesium3DTileFeature} object for the feature with the
- * given <code>batchId</code>.  This object is used to get and modify the
- * feature's properties.
- * <p>
- * Features in a tile are ordered by <code>batchId</code>, an index used to retrieve their metadata from the batch table.
- * </p>
- *
- * @see {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/TileFormats/BatchTable}.
- *
- * @param {number} batchId The batchId for the feature.
- * @returns {Cesium3DTileFeature} The corresponding {@link Cesium3DTileFeature} object.
- *
- * @exception {DeveloperError} batchId must be between zero and {@link Cesium3DTileContent#featuresLength} - 1.
- */
-Cesium3DTileContent.prototype.getFeature = function (batchId) {
-  DeveloperError.throwInstantiationError();
-};
+  /**
+   * Returns the {@link Cesium3DTileFeature} object for the feature with the
+   * given <code>batchId</code>.  This object is used to get and modify the
+   * feature's properties.
+   * <p>
+   * Features in a tile are ordered by <code>batchId</code>, an index used to retrieve their metadata from the batch table.
+   * </p>
+   *
+   * @see {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/TileFormats/BatchTable}.
+   *
+   * @param {number} batchId The batchId for the feature.
+   * @returns {Cesium3DTileFeature} The corresponding {@link Cesium3DTileFeature} object.
+   *
+   * @exception {DeveloperError} batchId must be between zero and {@link Cesium3DTileContent#featuresLength} - 1.
+   */
+  getFeature(batchId) {
+    DeveloperError.throwInstantiationError();
+  }
 
-/**
-     * Called when {@link Cesium3DTileset#debugColorizeTiles} changes.
-     * <p>
-     * This is used to implement the <code>Cesium3DTileContent</code> interface, but is
-     * not part of the public Cesium API.
-     * </p>
-     *
-     * @param {boolean} enabled Whether to enable or disable debug settings.
-     * @returns {Cesium3DTileFeature} The corresponding {@link Cesium3DTileFeature} object.
+  /**
+       * Called when {@link Cesium3DTileset#debugColorizeTiles} changes.
+       * <p>
+       * This is used to implement the <code>Cesium3DTileContent</code> interface, but is
+       * not part of the public Cesium API.
+       * </p>
+       *
+       * @param {boolean} enabled Whether to enable or disable debug settings.
+       * @param {Color} color Debug color.
+       * @returns {Cesium3DTileFeature} The corresponding {@link Cesium3DTileFeature} object.
 
-     * @private
-     */
-Cesium3DTileContent.prototype.applyDebugSettings = function (enabled, color) {
-  DeveloperError.throwInstantiationError();
-};
+       * @private
+       */
+  applyDebugSettings(enabled, color) {
+    DeveloperError.throwInstantiationError();
+  }
 
-/**
- * Apply a style to the content
- * <p>
- * This is used to implement the <code>Cesium3DTileContent</code> interface, but is
- * not part of the public Cesium API.
- * </p>
- *
- * @param {Cesium3DTileStyle} style The style.
- * @returns {void}
- *
- * @private
- */
-Cesium3DTileContent.prototype.applyStyle = function (style) {
-  DeveloperError.throwInstantiationError();
-};
+  /**
+   * Apply a style to the content
+   * <p>
+   * This is used to implement the <code>Cesium3DTileContent</code> interface, but is
+   * not part of the public Cesium API.
+   * </p>
+   *
+   * @param {Cesium3DTileStyle} style The style.
+   * @returns {void}
+   *
+   * @private
+   */
+  applyStyle(style) {
+    DeveloperError.throwInstantiationError();
+  }
 
-/**
- * Called by the tile during tileset traversal to get the draw commands needed to render this content.
- * When the tile's content is in the PROCESSING state, this creates WebGL resources to ultimately
- * move to the READY state.
- * <p>
- * This is used to implement the <code>Cesium3DTileContent</code> interface, but is
- * not part of the public Cesium API.
- * </p>
- *
- * @param {Cesium3DTileset} tileset The tileset containing this tile.
- * @param {FrameState} frameState The frame state.
- * @returns {void}
- *
- * @private
- */
-Cesium3DTileContent.prototype.update = function (tileset, frameState) {
-  DeveloperError.throwInstantiationError();
-};
+  /**
+   * Called by the tile during tileset traversal to get the draw commands needed to render this content.
+   * When the tile's content is in the PROCESSING state, this creates WebGL resources to ultimately
+   * move to the READY state.
+   * <p>
+   * This is used to implement the <code>Cesium3DTileContent</code> interface, but is
+   * not part of the public Cesium API.
+   * </p>
+   *
+   * @param {Cesium3DTileset} tileset The tileset containing this tile.
+   * @param {FrameState} frameState The frame state.
+   * @returns {void}
+   *
+   * @private
+   */
+  update(tileset, frameState) {
+    DeveloperError.throwInstantiationError();
+  }
 
-/**
- * Find an intersection between a ray and the tile content surface that was rendered. The ray must be given in world coordinates.
- *
- * @param {Ray} ray The ray to test for intersection.
- * @param {FrameState} frameState The frame state.
- * @param {Cartesian3|undefined} [result] The intersection or <code>undefined</code> if none was found.
- * @returns {Cartesian3|undefined} The intersection or <code>undefined</code> if none was found.
- *
- * @private
- */
-Cesium3DTileContent.prototype.pick = function (ray, frameState, result) {
-  DeveloperError.throwInstantiationError();
-};
+  /**
+   * Find an intersection between a ray and the tile content surface that was rendered. The ray must be given in world coordinates.
+   *
+   * @param {Ray} ray The ray to test for intersection.
+   * @param {FrameState} frameState The frame state.
+   * @param {Cartesian3|undefined} [result] The intersection or <code>undefined</code> if none was found.
+   * @returns {Cartesian3|undefined} The intersection or <code>undefined</code> if none was found.
+   *
+   * @private
+   */
+  pick(ray, frameState, result) {
+    DeveloperError.throwInstantiationError();
+  }
 
-/**
- * Returns true if this object was destroyed; otherwise, false.
- * <br /><br />
- * If this object was destroyed, it should not be used; calling any function other than
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
- * <p>
- * This is used to implement the <code>Cesium3DTileContent</code> interface, but is
- * not part of the public Cesium API.
- * </p>
- *
- * @returns {boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
- *
- * @see Cesium3DTileContent#destroy
- *
- * @private
- */
-Cesium3DTileContent.prototype.isDestroyed = function () {
-  DeveloperError.throwInstantiationError();
-};
+  /**
+   * Returns true if this object was destroyed; otherwise, false.
+   * <br /><br />
+   * If this object was destroyed, it should not be used; calling any function other than
+   * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
+   * <p>
+   * This is used to implement the <code>Cesium3DTileContent</code> interface, but is
+   * not part of the public Cesium API.
+   * </p>
+   *
+   * @returns {boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
+   *
+   * @see Cesium3DTileContent#destroy
+   *
+   * @private
+   */
+  isDestroyed() {
+    DeveloperError.throwInstantiationError();
+  }
+
+  /**
+   * Destroys the WebGL resources held by this object.  Destroying an object allows for deterministic
+   * release of WebGL resources, instead of relying on the garbage collector to destroy this object.
+   * <br /><br />
+   * Once an object is destroyed, it should not be used; calling any function other than
+   * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.  Therefore,
+   * assign the return value (<code>undefined</code>) to the object as done in the example.
+   * <p>
+   * This is used to implement the <code>Cesium3DTileContent</code> interface, but is
+   * not part of the public Cesium API.
+   * </p>
+   *
+   * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
+   *
+   * @example
+   * content = content && content.destroy();
+   *
+   * @see Cesium3DTileContent#isDestroyed
+   *
+   * @returns {void}
+   *
+   * @private
+   */
+  destroy() {
+    DeveloperError.throwInstantiationError();
+  }
+}
 
-/**
- * Destroys the WebGL resources held by this object.  Destroying an object allows for deterministic
- * release of WebGL resources, instead of relying on the garbage collector to destroy this object.
- * <br /><br />
- * Once an object is destroyed, it should not be used; calling any function other than
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.  Therefore,
- * assign the return value (<code>undefined</code>) to the object as done in the example.
- * <p>
- * This is used to implement the <code>Cesium3DTileContent</code> interface, but is
- * not part of the public Cesium API.
- * </p>
- *
- * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
- *
- * @example
- * content = content && content.destroy();
- *
- * @see Cesium3DTileContent#isDestroyed
- *
- * @returns {void}
- *
- * @private
- */
-Cesium3DTileContent.prototype.destroy = function () {
-  DeveloperError.throwInstantiationError();
-};
 export default Cesium3DTileContent;

package/Source/Scene/Cesium3DTileContentFactory.js

@@ -101,7 +101,11 @@ const Cesium3DTileContentFactory = {
       return GaussianSplat3DTileContent.fromGltf(tileset, tile, resource, glb);
     }
 
-    if (tileset.isGltfExtensionUsed("CESIUM_mesh_vector")) {
+    // @deprecated CESIUM_mesh_vector to be removed after v1.142 release.
+    if (
+      tileset.hasExtension("3DTILES_content_gltf_vector") ||
+      tileset.isGltfExtensionUsed("CESIUM_mesh_vector")
+    ) {
       return VectorGltf3DTileContent.fromGltf(tileset, tile, resource, glb);
     }
 
@@ -114,7 +118,11 @@ const Cesium3DTileContentFactory = {
       return GaussianSplat3DTileContent.fromGltf(tileset, tile, resource, json);
     }
 
-    if (tileset.isGltfExtensionUsed("CESIUM_mesh_vector")) {
+    // @deprecated CESIUM_mesh_vector to be removed after v1.142 release.
+    if (
+      tileset.hasExtension("3DTILES_content_gltf_vector") ||
+      tileset.isGltfExtensionUsed("CESIUM_mesh_vector")
+    ) {
       return VectorGltf3DTileContent.fromGltf(tileset, tile, resource, json);
     }
 

package/Source/Scene/Cesium3DTileContentState.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 /**
  * @private
  */
@@ -9,4 +11,7 @@ const Cesium3DTileContentState = {
   EXPIRED: 4, // Is expired and will be unloaded once new content is loaded.
   FAILED: 5, // Request failed.
 };
-export default Object.freeze(Cesium3DTileContentState);
+
+Object.freeze(Cesium3DTileContentState);
+
+export default Cesium3DTileContentState;

package/Source/Scene/Cesium3DTileContentType.js

@@ -176,4 +176,6 @@ Cesium3DTileContentType.isBinaryFormat = function (contentType) {
   }
 };
 
-export default Object.freeze(Cesium3DTileContentType);
+Object.freeze(Cesium3DTileContentType);
+
+export default Cesium3DTileContentType;