@cesium/engine 21.0.1-ion.0 → 22.0.0

package/Source/Scene/Scene.js

@@ -761,6 +761,15 @@ function Scene(options) {
    */
   this.light = new SunLight();
 
+  /**
+   * Whether or not to enable edge visibility rendering for 3D tiles.
+   * When enabled, creates a framebuffer with multiple render targets
+   * for advanced edge detection and visibility techniques.
+   * @type {boolean}
+   * @default false
+   */
+  this._enableEdgeVisibility = false;
+
   // Give frameState, camera, and screen space camera controller initial state before rendering
   updateFrameNumber(this, 0.0, JulianDate.now());
   this.updateFrameState();
@@ -1350,7 +1359,7 @@ Object.defineProperties(Scene.prototype, {
    *
    * @memberof Scene.prototype
    *
-   * @type {Object | undefined}
+   * @type {object | undefined}
    * @readonly
    *
    * @default undefined
@@ -2567,6 +2576,48 @@ function performTranslucent3DTilesClassification(
   );
 }
 
+function performCesium3DTileEdgesPass(scene, passState, frustumCommands) {
+  scene.context.uniformState.updatePass(Pass.CESIUM_3D_TILE_EDGES);
+
+  const originalFramebuffer = passState.framebuffer;
+
+  scene.context.uniformState.edgeColorTexture = scene.context.defaultTexture;
+  scene.context.uniformState.edgeIdTexture = scene.context.defaultTexture;
+  scene.context.uniformState.edgeDepthTexture = scene.context.defaultTexture;
+
+  // Set edge framebuffer for rendering
+  if (
+    scene._enableEdgeVisibility &&
+    defined(scene._view) &&
+    defined(scene._view.edgeFramebuffer)
+  ) {
+    passState.framebuffer = scene._view.edgeFramebuffer.framebuffer;
+  }
+
+  // performPass
+  const commands = frustumCommands.commands[Pass.CESIUM_3D_TILE_EDGES];
+  const commandCount = frustumCommands.indices[Pass.CESIUM_3D_TILE_EDGES];
+
+  // clear edge framebuffer
+  if (
+    scene._enableEdgeVisibility &&
+    defined(scene._view) &&
+    defined(scene._view.edgeFramebuffer)
+  ) {
+    const clearCommand = scene._view.edgeFramebuffer.getClearCommand(
+      new Color(0.0, 0.0, 0.0, 0.0),
+    );
+    clearCommand.execute(scene.context, passState);
+  }
+
+  // Then execute edge rendering commands
+  for (let j = 0; j < commandCount; ++j) {
+    executeCommand(commands[j], scene, passState);
+  }
+
+  passState.framebuffer = originalFramebuffer;
+}
+
 /**
  * Execute the draw commands for all the render passes.
  *
@@ -2709,6 +2760,48 @@ function executeCommands(scene, passState) {
     }
 
     let commandCount;
+
+    // Draw edges FIRST - before binding textures to avoid feedback loop
+    performCesium3DTileEdgesPass(scene, passState, frustumCommands);
+
+    if (
+      scene._enableEdgeVisibility &&
+      defined(scene._view) &&
+      defined(scene._view.edgeFramebuffer)
+    ) {
+      // Get edge color texture (attachment 0)
+      const colorTexture = scene._view.edgeFramebuffer.colorTexture;
+      if (defined(colorTexture)) {
+        scene.context.uniformState.edgeColorTexture = colorTexture;
+      } else {
+        scene.context.uniformState.edgeColorTexture =
+          scene.context.defaultTexture;
+      }
+
+      // Get edge ID texture (attachment 1)
+      const idTexture = scene._view.edgeFramebuffer.idTexture;
+      if (defined(idTexture)) {
+        scene.context.uniformState.edgeIdTexture = idTexture;
+      } else {
+        scene.context.uniformState.edgeIdTexture = scene.context.defaultTexture;
+      }
+
+      // Get edge depth texture (attachment 2)
+      const edgeDepthTexture = scene._view.edgeFramebuffer.depthTexture;
+      if (defined(edgeDepthTexture)) {
+        scene.context.uniformState.edgeDepthTexture = edgeDepthTexture;
+      } else {
+        scene.context.uniformState.edgeDepthTexture =
+          scene.context.defaultTexture;
+      }
+    } else {
+      scene.context.uniformState.edgeColorTexture =
+        scene.context.defaultTexture;
+      scene.context.uniformState.edgeIdTexture = scene.context.defaultTexture;
+      scene.context.uniformState.edgeDepthTexture =
+        scene.context.defaultTexture;
+    }
+
     if (!useInvertClassification || picking || renderTranslucentDepthForPick) {
       // Common/fastest path. Draw 3D Tiles and classification normally.
 
@@ -3595,9 +3688,20 @@ function updateShadowMaps(scene) {
 function updateAndRenderPrimitives(scene) {
   const frameState = scene._frameState;
 
+  // Reset per-frame edge visibility request flag before primitives update
+  frameState.edgeVisibilityRequested = false;
+
   scene._groundPrimitives.update(frameState);
   scene._primitives.update(frameState);
 
+  // If any primitive requested edge visibility this frame, flip the scene flag lazily.
+  if (
+    frameState.edgeVisibilityRequested &&
+    scene._enableEdgeVisibility === false
+  ) {
+    scene._enableEdgeVisibility = true;
+  }
+
   updateDebugFrustumPlanes(scene);
   updateShadowMaps(scene);
 
@@ -3714,6 +3818,13 @@ function updateAndClearFramebuffers(scene, passState, clearColor) {
 
   const useInvertClassification = (environmentState.useInvertClassification =
     !picking && defined(passState.framebuffer) && scene.invertClassification);
+
+  // Update edge framebuffer for 3D tile edge rendering
+  const useEdgeFramebuffer = !picking && scene._enableEdgeVisibility;
+  if (useEdgeFramebuffer) {
+    view.edgeFramebuffer.update(context, view.viewport, scene._hdr);
+  }
+
   if (useInvertClassification) {
     let depthFramebuffer;
     if (frameState.invertClassificationColor.alpha === 1.0) {
@@ -4399,10 +4510,11 @@ Scene.prototype.clampLineWidth = function (width) {
  * @param {Cartesian2} windowPosition Window coordinates to perform picking on.
  * @param {number} [width=3] Width of the pick rectangle.
  * @param {number} [height=3] Height of the pick rectangle.
- * @returns {Object | undefined} Object containing the picked primitive or <code>undefined</code> if nothing is at the location.
+ * @returns {object | undefined} Object containing the picked primitive or <code>undefined</code> if nothing is at the location.
  */
 Scene.prototype.pick = function (windowPosition, width, height) {
-  return this._picking.pick(this, windowPosition, width, height);
+  // Picking one object, result is either [object] or []
+  return this._picking.pick(this, windowPosition, width, height, 1)[0];
 };
 
 /**
@@ -4674,7 +4786,7 @@ function updateRequestRenderModeDeferCheckPass(scene) {
  * @private
  *
  * @param {Ray} ray The ray.
- * @param {Object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to exclude from the ray intersection.
+ * @param {object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to exclude from the ray intersection.
  * @param {number} [width=0.1] Width of the intersection volume in meters.
  * @returns {object | undefined} An object containing the object and position of the first intersection or <code>undefined</code> if there are no intersections.
  *
@@ -4699,9 +4811,9 @@ Scene.prototype.pickFromRay = function (ray, objectsToExclude, width) {
  *
  * @param {Ray} ray The ray.
  * @param {number} [limit=Number.MAX_VALUE] If supplied, stop finding intersections after this many intersections.
- * @param {Object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to exclude from the ray intersection.
+ * @param {object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to exclude from the ray intersection.
  * @param {number} [width=0.1] Width of the intersection volume in meters.
- * @returns {Object[]} List of objects containing the object and position of each intersection.
+ * @returns {object[]} List of objects containing the object and position of each intersection.
  *
  * @exception {DeveloperError} Ray intersections are only supported in 3D mode.
  */
@@ -4727,7 +4839,7 @@ Scene.prototype.drillPickFromRay = function (
  * @private
  *
  * @param {Ray} ray The ray.
- * @param {Object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to exclude from the ray intersection.
+ * @param {object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to exclude from the ray intersection.
  * @param {number} [width=0.1] Width of the intersection volume in meters.
  * @returns {Promise<object>} A promise that resolves to an object containing the object and position of the first intersection.
  *
@@ -4754,7 +4866,7 @@ Scene.prototype.pickFromRayMostDetailed = function (
  *
  * @param {Ray} ray The ray.
  * @param {number} [limit=Number.MAX_VALUE] If supplied, stop finding intersections after this many intersections.
- * @param {Object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to exclude from the ray intersection.
+ * @param {object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to exclude from the ray intersection.
  * @param {number} [width=0.1] Width of the intersection volume in meters.
  * @returns {Promise<Object[]>} A promise that resolves to a list of objects containing the object and position of each intersection.
  *
@@ -4785,7 +4897,7 @@ Scene.prototype.drillPickFromRayMostDetailed = function (
  * </p>
  *
  * @param {Cartographic} position The cartographic position to sample height from.
- * @param {Object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to not sample height from.
+ * @param {object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to not sample height from.
  * @param {number} [width=0.1] Width of the intersection volume in meters.
  * @returns {number | undefined} The height. This may be <code>undefined</code> if there was no scene geometry to sample height from.
  *
@@ -4815,7 +4927,7 @@ Scene.prototype.sampleHeight = function (position, objectsToExclude, width) {
  * </p>
  *
  * @param {Cartesian3} cartesian The cartesian position.
- * @param {Object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to not clamp to.
+ * @param {object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to not clamp to.
  * @param {number} [width=0.1] Width of the intersection volume in meters.
  * @param {Cartesian3} [result] An optional object to return the clamped position.
  * @returns {Cartesian3 | undefined} The modified result parameter or a new Cartesian3 instance if one was not provided. This may be <code>undefined</code> if there was no scene geometry to clamp to.
@@ -4855,7 +4967,7 @@ Scene.prototype.clampToHeight = function (
  * the height is set to <code>undefined</code>.
  *
  * @param {Cartographic[]} positions The cartographic positions to update with sampled heights.
- * @param {Object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to not sample height from.
+ * @param {object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to not sample height from.
  * @param {number} [width=0.1] Width of the intersection volume in meters.
  * @returns {Promise<Array<Cartographic | undefined>>} A promise that resolves to the provided list of positions when the query has completed. Positions may become <code>undefined</code> if the height cannot be determined.
  *
@@ -4895,7 +5007,7 @@ Scene.prototype.sampleHeightMostDetailed = function (
  * can be sampled at that location, or another error occurs, the element in the array is set to undefined.
  *
  * @param {Cartesian3[]} cartesians The cartesian positions to update with clamped positions.
- * @param {Object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to not clamp to.
+ * @param {object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to not clamp to.
  * @param {number} [width=0.1] Width of the intersection volume in meters.
  * @returns {Promise<Array<Cartesian3 | undefined>>} A promise that resolves to the provided list of positions when the query has completed. Positions may become <code>undefined</code> if they cannot be clamped.
  *

package/Source/Scene/ScreenSpaceCameraController.js

@@ -139,7 +139,7 @@ function ScreenSpaceCameraController(scene) {
 
   /**
    * A multiplier for the speed at which the camera will zoom.
-   * @type {Number}
+   * @type {number}
    * @default 5.0
    */
   this.zoomFactor = 5.0;

package/Source/Scene/SensorVolumePortionToDisplay.js

@@ -3,27 +3,27 @@ import DeveloperError from "../Core/DeveloperError.js";
 /**
  * Constants used to indicated what part of the sensor volume to display.
  *
- * @enum {Number}
+ * @enum {number}
  */
 const SensorVolumePortionToDisplay = {
   /**
    * 0x0000.  Display the complete sensor volume.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   COMPLETE: 0x0000,
   /**
    * 0x0001.  Display the portion of the sensor volume that lies below the true horizon of the ellipsoid.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   BELOW_ELLIPSOID_HORIZON: 0x0001,
   /**
    * 0x0002.  Display the portion of the sensor volume that lies above the true horizon of the ellipsoid.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   ABOVE_ELLIPSOID_HORIZON: 0x0002,
@@ -34,7 +34,7 @@ const SensorVolumePortionToDisplay = {
  *
  * @param {SensorVolumePortionToDisplay} portionToDisplay The value to validate.
  *
- * @returns {Boolean} <code>true</code> if the provided value is a valid enumeration value; otherwise, <code>false</code>.
+ * @returns {boolean} <code>true</code> if the provided value is a valid enumeration value; otherwise, <code>false</code>.
  */
 SensorVolumePortionToDisplay.validate = function (portionToDisplay) {
   return (
@@ -49,7 +49,7 @@ SensorVolumePortionToDisplay.validate = function (portionToDisplay) {
  *
  * @param {SensorVolumePortionToDisplay} portionToDisplay The value to be converted to its corresponding enumeration string.
  *
- * @returns {String} The enumeration string corresponding to the value.
+ * @returns {string} The enumeration string corresponding to the value.
  */
 SensorVolumePortionToDisplay.toString = function (portionToDisplay) {
   switch (portionToDisplay) {

package/Source/Scene/SingleTileImageryProvider.js

@@ -283,18 +283,18 @@ async function doRequest(resource, provider, previousError) {
 }
 
 /**
- * @typedef {Object} SingleTileImageryProvider.fromUrlOptions
+ * @typedef {object} SingleTileImageryProvider.fromUrlOptions
  *
  * Initialization options for the SingleTileImageryProvider constructor when using SingleTileImageryProvider.fromUrl
  *
  * @property {Rectangle} [rectangle=Rectangle.MAX_VALUE] The rectangle, in radians, covered by the image.
- * @property {Credit|String} [credit] A credit for the data source, which is displayed on the canvas.
+ * @property {Credit|string} [credit] A credit for the data source, which is displayed on the canvas.
  * @property {Ellipsoid} [ellipsoid] The ellipsoid.  If not specified, the WGS84 ellipsoid is used.
  */
 
 /**
  * Creates a provider for a single, top-level imagery tile.  The single image is assumed to use a
- * @param {Resource|String} url The url for the tile
+ * @param {Resource|string} url The url for the tile
  * @param {SingleTileImageryProvider.fromUrlOptions} [options] Object describing initialization options.
  * @returns {Promise.<SingleTileImageryProvider>} The resolved SingleTileImageryProvider.
  *

package/Source/Scene/Terrain.js

@@ -112,9 +112,9 @@ Object.defineProperties(Terrain.prototype, {
  *
  * @function
  *
- * @param {Object} [options] Object with the following properties:
- * @param {Boolean} [options.requestVertexNormals=false] Flag that indicates if the client should request additional lighting information from the server if available.
- * @param {Boolean} [options.requestWaterMask=false] Flag that indicates if the client should request per tile water masks from the server if available.
+ * @param {object} [options] Object with the following properties:
+ * @param {boolean} [options.requestVertexNormals=false] Flag that indicates if the client should request additional lighting information from the server if available.
+ * @param {boolean} [options.requestWaterMask=false] Flag that indicates if the client should request per tile water masks from the server if available.
  * @returns {Terrain} An asynchronous helper object for a CesiumTerrainProvider
  *
  * @see Ion
@@ -162,8 +162,8 @@ Terrain.fromWorldTerrain = function (options) {
  *
  * @function
  *
- * @param {Object} [options] Object with the following properties:
- * @param {Boolean} [options.requestVertexNormals=false] Flag that indicates if the client should request additional lighting information from the server if available.
+ * @param {object} [options] Object with the following properties:
+ * @param {boolean} [options.requestVertexNormals=false] Flag that indicates if the client should request additional lighting information from the server if available.
  * @returns {Terrain} An asynchronous helper object for a CesiumTerrainProvider
  *
  * @see Ion

package/Source/Scene/TileMapServiceImageryProvider.js

@@ -107,7 +107,7 @@ TileMapServiceImageryProvider._requestMetadata = async function (
 /**
  * Creates a TileMapServiceImageryProvider from the specified url.
  *
- * @param {Resource|String} url Path to image tiles on server.
+ * @param {Resource|string} url Path to image tiles on server.
  * @param {TileMapServiceImageryProvider.ConstructorOptions} [options] Object describing initialization options.
  * @returns {Promise<TileMapServiceImageryProvider>} A promise that resolves to the created TileMapServiceImageryProvider.
  *
@@ -205,7 +205,7 @@ function calculateSafeMinimumDetailLevel(
  * Parses the results of a successful xml request
  * @private
  *
- * @param {Object} xml
+ * @param {object} xml
  * @param {TileMapServiceImageryProvider.ConstructorOptions} options
  * @param {Resource} tmsResource
  * @param {Resource} xmlResource

package/Source/Scene/UrlTemplateImageryProvider.js

@@ -134,7 +134,7 @@ const pickFeaturesTags = combine(tags, {
  *        that this can be dynamically overridden by modifying the {@link UriTemplateImageryProvider#enablePickFeatures}
  *        property.
  * @property {TileDiscardPolicy} [tileDiscardPolicy] A policy for discarding tile images according to some criteria
- * @property {Object} [customTags] Allow to replace custom keywords in the URL template. The object must have strings as keys and functions as values.
+ * @property {object} [customTags] Allow to replace custom keywords in the URL template. The object must have strings as keys and functions as values.
  */
 
 /**

package/Source/Scene/View.js

@@ -10,6 +10,7 @@ import ClearCommand from "../Renderer/ClearCommand.js";
 import Pass from "../Renderer/Pass.js";
 import PassState from "../Renderer/PassState.js";
 import Camera from "./Camera.js";
+import EdgeFramebuffer from "./EdgeFramebuffer.js";
 import FrustumCommands from "./FrustumCommands.js";
 import GlobeDepth from "./GlobeDepth.js";
 import GlobeTranslucencyFramebuffer from "./GlobeTranslucencyFramebuffer.js";
@@ -63,6 +64,7 @@ function View(scene, camera, viewport) {
   this.pickFramebuffer = new PickFramebuffer(context);
   this.pickDepthFramebuffer = new PickDepthFramebuffer();
   this.sceneFramebuffer = new SceneFramebuffer();
+  this.edgeFramebuffer = new EdgeFramebuffer();
   this.globeDepth = globeDepth;
   this.globeTranslucencyFramebuffer = new GlobeTranslucencyFramebuffer();
   this.oit = oit;
@@ -445,6 +447,7 @@ View.prototype.destroy = function () {
     this.pickDepthFramebuffer && this.pickDepthFramebuffer.destroy();
   this.sceneFramebuffer =
     this.sceneFramebuffer && this.sceneFramebuffer.destroy();
+  this.edgeFramebuffer = this.edgeFramebuffer && this.edgeFramebuffer.destroy();
   this.globeDepth = this.globeDepth && this.globeDepth.destroy();
   this.oit = this.oit && this.oit.destroy();
   this.translucentTileClassification =