@cesium/engine 2.0.0 → 2.2.0

package/Source/Scene/Cesium3DTileBatchTable.js

@@ -88,7 +88,7 @@ Object.defineProperties(Cesium3DTileBatchTable.prototype, {
    * buffers and any binary properties. JSON data is not counted.
    *
    * @memberof Cesium3DTileBatchTable.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    * @private
    */
@@ -896,8 +896,8 @@ Cesium3DTileBatchTable.prototype.addDerivedCommands = function (
   const finalResolution = tile._finalResolution;
   const tileset = tile.tileset;
   const bivariateVisibilityTest =
-    tileset._skipLevelOfDetail &&
-    tileset._hasMixedContent &&
+    tileset.isSkippingLevelOfDetail &&
+    tileset.hasMixedContent &&
     frameState.context.stencilBuffer;
   const styleCommandsNeeded = getStyleCommandsNeeded(this);
 

package/Source/Scene/Cesium3DTileColorBlendMode.js

@@ -22,13 +22,13 @@
  * }
  * </code></pre>
  *
- * @enum {Number}
+ * @enum {number}
  */
 const Cesium3DTileColorBlendMode = {
   /**
    * Multiplies the source color by the feature color.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   HIGHLIGHT: 0,
@@ -36,7 +36,7 @@ const Cesium3DTileColorBlendMode = {
   /**
    * Replaces the source color with the feature color.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   REPLACE: 1,
@@ -44,7 +44,7 @@ const Cesium3DTileColorBlendMode = {
   /**
    * Blends the source color and feature color together.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   MIX: 2,

package/Source/Scene/Cesium3DTileContent.js

@@ -22,7 +22,7 @@ function Cesium3DTileContent() {
    * not part of the public Cesium API.
    * </p>
    *
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @private
    */
@@ -35,7 +35,7 @@ Object.defineProperties(Cesium3DTileContent.prototype, {
    *
    * @memberof Cesium3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   featuresLength: {
@@ -56,7 +56,7 @@ Object.defineProperties(Cesium3DTileContent.prototype, {
    *
    * @memberof Cesium3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   pointsLength: {
@@ -71,7 +71,7 @@ Object.defineProperties(Cesium3DTileContent.prototype, {
    *
    * @memberof Cesium3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   trianglesLength: {
@@ -86,7 +86,7 @@ Object.defineProperties(Cesium3DTileContent.prototype, {
    *
    * @memberof Cesium3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   geometryByteLength: {
@@ -101,7 +101,7 @@ Object.defineProperties(Cesium3DTileContent.prototype, {
    *
    * @memberof Cesium3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   texturesByteLength: {
@@ -118,7 +118,7 @@ Object.defineProperties(Cesium3DTileContent.prototype, {
    *
    * @memberof Cesium3DTileContent.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   batchTableByteLength: {
@@ -145,13 +145,29 @@ Object.defineProperties(Cesium3DTileContent.prototype, {
     },
   },
 
+  /**
+   * Returns true when the tile's content is ready to render; otherwise false
+   *
+   * @memberof Cesium3DTileContent.prototype
+   *
+   * @type {boolean}
+   * @readonly
+   */
+  ready: {
+    // eslint-disable-next-line getter-return
+    get: function () {
+      DeveloperError.throwInstantiationError();
+    },
+  },
+
   /**
    * Gets the promise that will be resolved when the tile's content is ready to render.
    *
    * @memberof Cesium3DTileContent.prototype
    *
-   * @type {Promise.<Cesium3DTileContent>}
+   * @type {Promise<Cesium3DTileContent>}
    * @readonly
+   * @deprecated
    */
   readyPromise: {
     // eslint-disable-next-line getter-return
@@ -194,7 +210,7 @@ Object.defineProperties(Cesium3DTileContent.prototype, {
    * Gets the url of the tile's content.
    * @memberof Cesium3DTileContent.prototype
    *
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   url: {
@@ -274,9 +290,9 @@ Object.defineProperties(Cesium3DTileContent.prototype, {
 /**
  * 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>.
+ * @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();
@@ -292,7 +308,7 @@ Cesium3DTileContent.prototype.hasProperty = function (batchId, name) {
  *
  * @see {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/TileFormats/BatchTable}.
  *
- * @param {Number} batchId The batchId for the feature.
+ * @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.
@@ -308,7 +324,7 @@ Cesium3DTileContent.prototype.getFeature = function (batchId) {
      * not part of the public Cesium API.
      * </p>
      *
-     * @param {Boolean} enabled Whether to enable or disable debug settings.
+     * @param {boolean} enabled Whether to enable or disable debug settings.
      * @returns {Cesium3DTileFeature} The corresponding {@link Cesium3DTileFeature} object.
 
      * @private
@@ -360,7 +376,7 @@ Cesium3DTileContent.prototype.update = function (tileset, frameState) {
  * not part of the public Cesium API.
  * </p>
  *
- * @returns {Boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
+ * @returns {boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
  *
  * @see Cesium3DTileContent#destroy
  *

package/Source/Scene/Cesium3DTileContentFactory.js

@@ -41,7 +41,7 @@ const Cesium3DTileContentFactory = {
   },
   cmpt: function (tileset, tile, resource, arrayBuffer, byteOffset) {
     // Send in the factory in order to avoid a cyclical dependency
-    return new Composite3DTileContent(
+    return Composite3DTileContent.fromTileType(
       tileset,
       tile,
       resource,
@@ -51,7 +51,7 @@ const Cesium3DTileContentFactory = {
     );
   },
   externalTileset: function (tileset, tile, resource, json) {
-    return new Tileset3DTileContent(tileset, tile, resource, json);
+    return Tileset3DTileContent.fromJson(tileset, tile, resource, json);
   },
   geom: function (tileset, tile, resource, arrayBuffer, byteOffset) {
     return new Geometry3DTileContent(
@@ -72,7 +72,7 @@ const Cesium3DTileContentFactory = {
     );
   },
   subt: function (tileset, tile, resource, arrayBuffer, byteOffset) {
-    return new Implicit3DTileContent(
+    return Implicit3DTileContent.fromSubtreeJson(
       tileset,
       tile,
       resource,
@@ -82,7 +82,7 @@ const Cesium3DTileContentFactory = {
     );
   },
   subtreeJson: function (tileset, tile, resource, json) {
-    return new Implicit3DTileContent(tileset, tile, resource, json);
+    return Implicit3DTileContent.fromSubtreeJson(tileset, tile, resource, json);
   },
   glb: function (tileset, tile, resource, arrayBuffer, byteOffset) {
     const arrayBufferByteLength = arrayBuffer.byteLength;

package/Source/Scene/Cesium3DTileContentType.js

@@ -4,7 +4,7 @@
  * unless otherwise noted. For JSON files, the enum value is a unique name
  * for internal use.
  *
- * @enum {String}
+ * @enum {string}
  * @see Cesium3DTileContent
  *
  * @private
@@ -14,7 +14,7 @@ const Cesium3DTileContentType = {
    * A Batched 3D Model. This is a binary format with
    * magic number <code>b3dm</code>
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @private
    */
@@ -23,7 +23,7 @@ const Cesium3DTileContentType = {
    * An Instanced 3D Model. This is a binary format with magic number
    * <code>i3dm</code>
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @private
    */
@@ -32,7 +32,7 @@ const Cesium3DTileContentType = {
    * A Composite model. This is a binary format with magic number
    * <code>cmpt</code>
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @private
    */
@@ -41,7 +41,7 @@ const Cesium3DTileContentType = {
    * A Point Cloud model. This is a binary format with magic number
    * <code>pnts</code>
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @private
    */
@@ -50,7 +50,7 @@ const Cesium3DTileContentType = {
    * Vector tiles. This is a binary format with magic number
    * <code>vctr</code>
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @private
    */
@@ -59,7 +59,7 @@ const Cesium3DTileContentType = {
    * Geometry tiles. This is a binary format with magic number
    * <code>geom</code>
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @private
    */
@@ -68,7 +68,7 @@ const Cesium3DTileContentType = {
    * A glTF model in JSON + external BIN form. This is treated
    * as a JSON format.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @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.
@@ -79,7 +79,7 @@ const Cesium3DTileContentType = {
    * changed from <code>glTF</code> to <code>glb</code> to distinguish it from
    * the JSON glTF format.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @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.
@@ -89,7 +89,7 @@ const Cesium3DTileContentType = {
    * For implicit tiling, availability bitstreams are stored in binary subtree files.
    * The magic number is <code>subt</code>
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @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.
@@ -98,7 +98,7 @@ const Cesium3DTileContentType = {
   /**
    * For implicit tiling. Subtrees can also be represented as JSON files.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @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.
@@ -108,7 +108,7 @@ const Cesium3DTileContentType = {
    * Contents can reference another tileset.json to use
    * as an external tileset. This is a JSON-based format.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @private
    */
@@ -117,7 +117,7 @@ const Cesium3DTileContentType = {
    * Multiple contents are handled separately from the other content types
    * due to differences in request scheduling.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @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.
@@ -126,7 +126,7 @@ const Cesium3DTileContentType = {
   /**
    * GeoJSON content for <code>MAXAR_content_geojson</code> extension.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @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.
@@ -135,7 +135,7 @@ const Cesium3DTileContentType = {
   /**
    * Binary voxel content for <code>3DTILES_content_voxels</code> extension.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @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.
@@ -144,7 +144,7 @@ const Cesium3DTileContentType = {
   /**
    * Binary voxel content for <code>3DTILES_content_voxels</code> extension.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    * @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.
@@ -156,7 +156,7 @@ const Cesium3DTileContentType = {
  * Check if a content is one of the supported binary formats. Otherwise,
  * the caller can assume a JSON format.
  * @param {Cesium3DTileContentType} contentType The content type of the content payload.
- * @return {Boolean} <code>true</code> if the content type is a binary format, or <code>false</code> if the content type is a JSON format.
+ * @return {boolean} <code>true</code> if the content type is a binary format, or <code>false</code> if the content type is a JSON format.
  * @private
  */
 Cesium3DTileContentType.isBinaryFormat = function (contentType) {

package/Source/Scene/Cesium3DTileFeature.js

@@ -49,7 +49,7 @@ Object.defineProperties(Cesium3DTileFeature.prototype, {
    *
    * @memberof Cesium3DTileFeature.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @default true
    */
@@ -160,7 +160,7 @@ Object.defineProperties(Cesium3DTileFeature.prototype, {
    *
    * @memberof Cesium3DTileFeature.prototype
    *
-   * @type {Number}
+   * @type {number}
    *
    * @readonly
    * @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.
@@ -187,8 +187,8 @@ Object.defineProperties(Cesium3DTileFeature.prototype, {
  *
  * @see {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy}
  *
- * @param {String} name The case-sensitive name of the property.
- * @returns {Boolean} Whether the feature contains this property.
+ * @param {string} name The case-sensitive name of the property.
+ * @returns {boolean} Whether the feature contains this property.
  */
 Cesium3DTileFeature.prototype.hasProperty = function (name) {
   return this._content.batchTable.hasProperty(this._batchId, name);
@@ -200,8 +200,8 @@ Cesium3DTileFeature.prototype.hasProperty = function (name) {
  *
  * @see {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy}
  *
- * @param {String[]} [results] An array into which to store the results.
- * @returns {String[]} The IDs of the feature's properties.
+ * @param {string[]} [results] An array into which to store the results.
+ * @returns {string[]} The IDs of the feature's properties.
  */
 Cesium3DTileFeature.prototype.getPropertyIds = function (results) {
   return this._content.batchTable.getPropertyIds(this._batchId, results);
@@ -213,7 +213,7 @@ Cesium3DTileFeature.prototype.getPropertyIds = function (results) {
  *
  * @see {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy}
  *
- * @param {String} name The case-sensitive name of the property.
+ * @param {string} name The case-sensitive name of the property.
  * @returns {*} The value of the property or <code>undefined</code> if the feature does not have this property.
  *
  * @example
@@ -259,8 +259,8 @@ Cesium3DTileFeature.prototype.getProperty = function (name) {
  * </p>
  *
  * @param {Cesium3DTileContent} content The content for accessing the metadata
- * @param {Number} batchId The batch ID (or feature ID) of the feature to get a property for
- * @param {String} name The semantic or property ID of the feature. Semantics are checked before property IDs in each granularity of metadata.
+ * @param {number} batchId The batch ID (or feature ID) of the feature to get a property for
+ * @param {string} name The semantic or property ID of the feature. Semantics are checked before property IDs in each granularity of metadata.
  * @return {*} The value of the property or <code>undefined</code> if the feature does not have this property.
  *
  * @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.
@@ -353,7 +353,7 @@ Cesium3DTileFeature.getPropertyInherited = function (content, batchId, name) {
  * tileset. Within each granularity, semantics are resolved first, then other
  * properties.
  * </p>
- * @param {String} name The case-sensitive name of the property.
+ * @param {string} name The case-sensitive name of the property.
  * @returns {*} The value of the property or <code>undefined</code> if the feature does not have this property.
  * @private
  */
@@ -371,7 +371,7 @@ Cesium3DTileFeature.prototype.getPropertyInherited = function (name) {
  * If a property with the given name doesn't exist, it is created.
  * </p>
  *
- * @param {String} name The case-sensitive name of the property.
+ * @param {string} name The case-sensitive name of the property.
  * @param {*} value The value of the property that will be copied.
  *
  * @exception {DeveloperError} Inherited batch table hierarchy property is read only.
@@ -404,8 +404,8 @@ Cesium3DTileFeature.prototype.setProperty = function (name, value) {
  * This function returns <code>false</code> if no batch table hierarchy is present.
  * </p>
  *
- * @param {String} className The name to check against.
- * @returns {Boolean} Whether the feature's class name equals <code>className</code>
+ * @param {string} className The name to check against.
+ * @returns {boolean} Whether the feature's class name equals <code>className</code>
  *
  * @private
  */
@@ -419,8 +419,8 @@ Cesium3DTileFeature.prototype.isExactClass = function (className) {
  * This function returns <code>false</code> if no batch table hierarchy is present.
  * </p>
  *
- * @param {String} className The name to check against.
- * @returns {Boolean} Whether the feature's class or inherited classes are named <code>className</code>
+ * @param {string} className The name to check against.
+ * @returns {boolean} Whether the feature's class or inherited classes are named <code>className</code>
  *
  * @private
  */
@@ -434,7 +434,7 @@ Cesium3DTileFeature.prototype.isClass = function (className) {
  * This function returns <code>undefined</code> if no batch table hierarchy is present.
  * </p>
  *
- * @returns {String} The feature's class name.
+ * @returns {string} The feature's class name.
  *
  * @private
  */

package/Source/Scene/Cesium3DTileOptimizationHint.js

@@ -1,7 +1,7 @@
 /**
  * Hint defining optimization support for a 3D tile
  *
- * @enum {Number}
+ * @enum {number}
  *
  * @private
  */

package/Source/Scene/Cesium3DTileOptimizations.js

@@ -25,7 +25,7 @@ const scratchAxis = new Cartesian3();
  * partially outside of the parent bounds.
  *
  * @param {Cesium3DTile} tile The tile to check.
- * @returns {Boolean} Whether the childrenWithinParent optimization is supported.
+ * @returns {boolean} Whether the childrenWithinParent optimization is supported.
  */
 Cesium3DTileOptimizations.checkChildrenWithinParent = function (tile) {
   //>>includeStart('debug', pragmas.debug);

package/Source/Scene/Cesium3DTilePass.js

@@ -1,6 +1,3 @@
-import Cesium3DTilesetMostDetailedTraversal from "./Cesium3DTilesetMostDetailedTraversal.js";
-import Cesium3DTilesetTraversal from "./Cesium3DTilesetTraversal.js";
-
 /**
  * The pass in which a 3D Tileset is updated.
  *
@@ -21,56 +18,56 @@ const Cesium3DTilePass = {
 const passOptions = new Array(Cesium3DTilePass.NUMBER_OF_PASSES);
 
 passOptions[Cesium3DTilePass.RENDER] = Object.freeze({
-  traversal: Cesium3DTilesetTraversal,
+  pass: Cesium3DTilePass.RENDER,
   isRender: true,
   requestTiles: true,
   ignoreCommands: false,
 });
 
 passOptions[Cesium3DTilePass.PICK] = Object.freeze({
-  traversal: Cesium3DTilesetTraversal,
+  pass: Cesium3DTilePass.PICK,
   isRender: false,
   requestTiles: false,
   ignoreCommands: false,
 });
 
 passOptions[Cesium3DTilePass.SHADOW] = Object.freeze({
-  traversal: Cesium3DTilesetTraversal,
+  pass: Cesium3DTilePass.SHADOW,
   isRender: false,
   requestTiles: true,
   ignoreCommands: false,
 });
 
 passOptions[Cesium3DTilePass.PRELOAD] = Object.freeze({
-  traversal: Cesium3DTilesetTraversal,
+  pass: Cesium3DTilePass.SHADOW,
   isRender: false,
   requestTiles: true,
   ignoreCommands: true,
 });
 
 passOptions[Cesium3DTilePass.PRELOAD_FLIGHT] = Object.freeze({
-  traversal: Cesium3DTilesetTraversal,
+  pass: Cesium3DTilePass.PRELOAD_FLIGHT,
   isRender: false,
   requestTiles: true,
   ignoreCommands: true,
 });
 
 passOptions[Cesium3DTilePass.REQUEST_RENDER_MODE_DEFER_CHECK] = Object.freeze({
-  traversal: Cesium3DTilesetTraversal,
+  pass: Cesium3DTilePass.REQUEST_RENDER_MODE_DEFER_CHECK,
   isRender: false,
   requestTiles: true,
   ignoreCommands: true,
 });
 
 passOptions[Cesium3DTilePass.MOST_DETAILED_PRELOAD] = Object.freeze({
-  traversal: Cesium3DTilesetMostDetailedTraversal,
+  pass: Cesium3DTilePass.MOST_DETAILED_PRELOAD,
   isRender: false,
   requestTiles: true,
   ignoreCommands: true,
 });
 
 passOptions[Cesium3DTilePass.MOST_DETAILED_PICK] = Object.freeze({
-  traversal: Cesium3DTilesetMostDetailedTraversal,
+  pass: Cesium3DTilePass.MOST_DETAILED_PICK,
   isRender: false,
   requestTiles: false,
   ignoreCommands: false,

package/Source/Scene/Cesium3DTilePassState.js

@@ -43,7 +43,7 @@ function Cesium3DTilePassState(options) {
   /**
    * A read-only property that indicates whether the pass is ready, i.e. all tiles needed by the pass are loaded.
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    * @default false
    */