@cesium/engine 3.0.0 → 3.0.1

package/Source/Scene/{parseBoundingVolumeSemantics.js → BoundingVolumeSemantics.js}

@@ -1,5 +1,14 @@
 import Check from "../Core/Check.js";
 import defined from "../Core/defined.js";
+import DeveloperError from "../Core/DeveloperError.js";
+
+/**
+ * Utilities for parsing bounding volume semantics from 3D Tiles 1.1 metadata.
+ *
+ * @namespace BoundingVolumeSemantics
+ * @private
+ */
+const BoundingVolumeSemantics = {};
 
 /**
  * Parse the bounding volume-related semantics such as
@@ -19,24 +28,44 @@ import defined from "../Core/defined.js";
  * @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.
  */
-function parseBoundingVolumeSemantics(tileMetadata) {
+BoundingVolumeSemantics.parseAllBoundingVolumeSemantics = function (
+  tileMetadata
+) {
   //>>includeStart('debug', pragmas.debug);
   Check.typeOf.object("tileMetadata", tileMetadata);
   //>>includeEnd('debug');
 
   return {
     tile: {
-      boundingVolume: parseBoundingVolume("TILE", tileMetadata),
-      minimumHeight: parseMinimumHeight("TILE", tileMetadata),
-      maximumHeight: parseMaximumHeight("TILE", tileMetadata),
+      boundingVolume: BoundingVolumeSemantics.parseBoundingVolumeSemantic(
+        "TILE",
+        tileMetadata
+      ),
+      minimumHeight: BoundingVolumeSemantics._parseMinimumHeight(
+        "TILE",
+        tileMetadata
+      ),
+      maximumHeight: BoundingVolumeSemantics._parseMaximumHeight(
+        "TILE",
+        tileMetadata
+      ),
     },
     content: {
-      boundingVolume: parseBoundingVolume("CONTENT", tileMetadata),
-      minimumHeight: parseMinimumHeight("CONTENT", tileMetadata),
-      maximumHeight: parseMaximumHeight("CONTENT", tileMetadata),
+      boundingVolume: BoundingVolumeSemantics.parseBoundingVolumeSemantic(
+        "CONTENT",
+        tileMetadata
+      ),
+      minimumHeight: BoundingVolumeSemantics._parseMinimumHeight(
+        "CONTENT",
+        tileMetadata
+      ),
+      maximumHeight: BoundingVolumeSemantics._parseMaximumHeight(
+        "CONTENT",
+        tileMetadata
+      ),
     },
   };
-}
+};
 
 /**
  * Parse the bounding volume from a tile metadata. If the metadata specify
@@ -52,7 +81,18 @@ function parseBoundingVolumeSemantics(tileMetadata) {
  * @return {object} An object representing the JSON description of the tile metadata
  * @private
  */
-function parseBoundingVolume(prefix, tileMetadata) {
+BoundingVolumeSemantics.parseBoundingVolumeSemantic = function (
+  prefix,
+  tileMetadata
+) {
+  //>>includeStart('debug', pragmas.debug);
+  Check.typeOf.string("prefix", prefix);
+  if (prefix !== "TILE" && prefix !== "CONTENT") {
+    throw new DeveloperError("prefix must be either 'TILE' or 'CONTENT'");
+  }
+  Check.typeOf.object("tileMetadata", tileMetadata);
+  //>>includeEnd('debug');
+
   const boundingBoxSemantic = `${prefix}_BOUNDING_BOX`;
   const boundingBox = tileMetadata.getPropertyBySemantic(boundingBoxSemantic);
 
@@ -86,7 +126,7 @@ function parseBoundingVolume(prefix, tileMetadata) {
   }
 
   return undefined;
-}
+};
 
 /**
  * Parse the minimum height from tile metadata. This is used for making tighter
@@ -98,10 +138,18 @@ function parseBoundingVolume(prefix, tileMetadata) {
  * @return {number} The minimum height
  * @private
  */
-function parseMinimumHeight(prefix, tileMetadata) {
+BoundingVolumeSemantics._parseMinimumHeight = function (prefix, tileMetadata) {
+  //>>includeStart('debug', pragmas.debug);
+  Check.typeOf.string("prefix", prefix);
+  if (prefix !== "TILE" && prefix !== "CONTENT") {
+    throw new DeveloperError("prefix must be either 'TILE' or 'CONTENT'");
+  }
+  Check.typeOf.object("tileMetadata", tileMetadata);
+  //>>includeEnd('debug');
+
   const minimumHeightSemantic = `${prefix}_MINIMUM_HEIGHT`;
   return tileMetadata.getPropertyBySemantic(minimumHeightSemantic);
-}
+};
 
 /**
  * Parse the maximum height from tile metadata. This is used for making tighter
@@ -113,9 +161,17 @@ function parseMinimumHeight(prefix, tileMetadata) {
  * @return {number} The maximum height
  * @private
  */
-function parseMaximumHeight(prefix, tileMetadata) {
+BoundingVolumeSemantics._parseMaximumHeight = function (prefix, tileMetadata) {
+  //>>includeStart('debug', pragmas.debug);
+  Check.typeOf.string("prefix", prefix);
+  if (prefix !== "TILE" && prefix !== "CONTENT") {
+    throw new DeveloperError("prefix must be either 'TILE' or 'CONTENT'");
+  }
+  Check.typeOf.object("tileMetadata", tileMetadata);
+  //>>includeEnd('debug');
+
   const maximumHeightSemantic = `${prefix}_MAXIMUM_HEIGHT`;
   return tileMetadata.getPropertyBySemantic(maximumHeightSemantic);
-}
+};
 
-export default parseBoundingVolumeSemantics;
+export default BoundingVolumeSemantics;

package/Source/Scene/Cesium3DTile.js

@@ -35,6 +35,7 @@ import findGroupMetadata from "./findGroupMetadata.js";
 import findTileMetadata from "./findTileMetadata.js";
 import hasExtension from "./hasExtension.js";
 import Multiple3DTileContent from "./Multiple3DTileContent.js";
+import BoundingVolumeSemantics from "./BoundingVolumeSemantics.js";
 import preprocess3DTileContent from "./preprocess3DTileContent.js";
 import SceneMode from "./SceneMode.js";
 import TileBoundingRegion from "./TileBoundingRegion.js";
@@ -107,6 +108,20 @@ function Cesium3DTile(tileset, baseResource, header, parent) {
    */
   this.computedTransform = computedTransform;
 
+  /**
+   * When tile metadata is present (3D Tiles 1.1) or the <code>3DTILES_metadata</code> extension is used,
+   * this stores a {@link TileMetadata} object for accessing tile metadata.
+   *
+   * @type {TileMetadata}
+   * @readonly
+   * @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.
+   */
+  this.metadata = findTileMetadata(tileset, header);
+
+  // Important: tile metadata must be parsed before this line so that the
+  // metadata semantics TILE_BOUNDING_BOX, TILE_BOUNDING_REGION, or TILE_BOUNDING_SPHERE
+  // can override header.boundingVolume (if necessary)
   this._boundingVolume = this.createBoundingVolume(
     header.boundingVolume,
     computedTransform
@@ -328,17 +343,6 @@ function Cesium3DTile(tileset, baseResource, header, parent) {
    */
   this.hasMultipleContents = hasMultipleContents;
 
-  /**
-   * When tile metadata is present (3D Tiles 1.1) or the <code>3DTILES_metadata</code> extension is used,
-   * this stores a {@link TileMetadata} object for accessing tile metadata.
-   *
-   * @type {TileMetadata}
-   * @readonly
-   * @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.
-   */
-  this.metadata = findTileMetadata(tileset, header);
-
   /**
    * The node in the tileset's LRU cache, used to determine when to unload a tile's content.
    *
@@ -1763,6 +1767,20 @@ Cesium3DTile.prototype.createBoundingVolume = function (
   transform,
   result
 ) {
+  // if explicit tile metadata includes TILE_BOUNDING_BOX, TILE_BOUNDING_REGION,
+  // or TILE_BOUNDING_SPHERE, override tile.boundingVolume.
+  const tileMetadata = this.metadata;
+  let metadataBoundingVolumeHeader;
+  if (defined(tileMetadata)) {
+    metadataBoundingVolumeHeader = BoundingVolumeSemantics.parseBoundingVolumeSemantic(
+      "TILE",
+      tileMetadata
+    );
+  }
+  if (defined(metadataBoundingVolumeHeader)) {
+    boundingVolumeHeader = metadataBoundingVolumeHeader;
+  }
+
   if (!defined(boundingVolumeHeader)) {
     throw new RuntimeError("boundingVolume must be defined");
   }
@@ -2003,8 +2021,8 @@ function updateContent(tile, tileset, frameState) {
  *  - clipping function (union v. intersection)
 
  * @private
- * @param {Cesium3DTile} tile 
- * @param {Cesium3DTileset} tileset 
+ * @param {Cesium3DTile} tile
+ * @param {Cesium3DTileset} tileset
  */
 function updateClippingPlanes(tile, tileset) {
   const clippingPlanes = tileset.clippingPlanes;

package/Source/Scene/Implicit3DTileContent.js

@@ -14,7 +14,7 @@ import S2Cell from "../Core/S2Cell.js";
 import ImplicitSubtree from "./ImplicitSubtree.js";
 import hasExtension from "./hasExtension.js";
 import MetadataSemantic from "./MetadataSemantic.js";
-import parseBoundingVolumeSemantics from "./parseBoundingVolumeSemantics.js";
+import BoundingVolumeSemantics from "./BoundingVolumeSemantics.js";
 
 /**
  * A specialized {@link Cesium3DTileContent} that lazily evaluates an implicit
@@ -465,7 +465,9 @@ function deriveChildTile(
   if (defined(subtree.tilePropertyTableJson)) {
     tileMetadata = subtree.getTileMetadataView(implicitCoordinates);
 
-    const boundingVolumeSemantics = parseBoundingVolumeSemantics(tileMetadata);
+    const boundingVolumeSemantics = BoundingVolumeSemantics.parseAllBoundingVolumeSemantics(
+      tileMetadata
+    );
     tileBounds = boundingVolumeSemantics.tile;
     contentBounds = boundingVolumeSemantics.content;
   }