@cesium/engine 18.3.1-ion.1 → 20.0.0

package/Source/Renderer/SharedContext.js

@@ -0,0 +1,186 @@
+import clone from "../Core/clone.js";
+import destroyObject from "../Core/destroyObject.js";
+import DeveloperError from "../Core/DeveloperError.js";
+import Context from "./Context.js";
+
+/**
+ * Enables a single WebGL context to be used by any number of {@link Scene}s.
+ * You can pass a SharedContext in place of a {@link ContextOptions} to the constructors of {@link Scene}, {@link CesiumWidget}, and {@link Viewer}.
+ * {@link Primitive}s associated with the shared WebGL context can be displayed in any Scene that uses the same context.
+ * The context renders each Scene to an off-screen canvas, then blits the result to that Scene's on-screen canvas.
+ *
+ * @private
+ * @alias SharedContext
+ * @constructor
+ *
+ * @param {object} [options] Object with the following properties:
+ * @param {ContextOptions} [options.contextOptions] Context and WebGL creation properties.
+ * @param {boolean} [options.autoDestroy=true] Destroys this context and all of its WebGL resources after all Scenes using the context are destroyed.
+
+ * @see {@link http://www.khronos.org/registry/webgl/specs/latest/#5.2|WebGLContextAttributes}
+ *
+ * @example
+ * // Create two Scenes sharing a single WebGL context
+ * const context = new Cesium.SharedContext();
+ * const scene1 = new Cesium.Scene({
+ *   canvas: canvas1,
+ *   contextOptions: context,
+ * });
+ * const scene2 = new Cesium.Scene({
+ *   canvas: canvas2,
+ *   contextOptions: context,
+ * });
+ */
+function SharedContext(options) {
+  this._autoDestroy = options?.autoDestroy ?? true;
+  this._canvas = document.createElement("canvas");
+  this._context = new Context(this._canvas, clone(options?.contextOptions));
+  this._canvases = [];
+}
+
+/**
+ * Creates an instance of {@link Context} that manages the shared WebGL context for a specific canvas.
+ * @param {HTMLCanvasElement} canvas The canvas element to which the context will be associated
+ * @returns {Context} The created context instance
+ * @private
+ */
+SharedContext.prototype.createSceneContext = function (canvas) {
+  const context2d = canvas.getContext("2d", { alpha: true });
+
+  //>>includeStart('debug', pragmas.debug);
+  if (!context2d) {
+    throw new DeveloperError(
+      "canvas used with SharedContext must provide a 2d context",
+    );
+  }
+
+  if (this._canvases.includes(canvas)) {
+    throw new DeveloperError("canvas is already associated with a scene");
+  }
+  //>>includeEnd('debug');
+
+  const sharedContext = this;
+  sharedContext._canvases.push(canvas);
+
+  let isDestroyed = false;
+  const destroy = function () {
+    isDestroyed = true;
+    const index = sharedContext._canvases.indexOf(canvas);
+    if (-1 !== index) {
+      sharedContext._canvases.splice(index, 1);
+      if (sharedContext._autoDestroy && sharedContext._canvases.length === 0) {
+        sharedContext.destroy();
+      }
+    }
+  };
+
+  const beginFrame = function () {
+    // Ensure the off-screen canvas is at least as large as the on-screen canvas.
+    const sharedCanvas = sharedContext._context.canvas;
+
+    const width = this.drawingBufferWidth;
+    if (sharedCanvas.width < width) {
+      sharedCanvas.width = width;
+    }
+
+    const height = this.drawingBufferHeight;
+    if (sharedCanvas.height < height) {
+      sharedCanvas.height = height;
+    }
+  };
+
+  const endFrame = function () {
+    // Blit the image from the off-screen canvas to the on-screen canvas.
+    const w = this.drawingBufferWidth;
+    const h = this.drawingBufferHeight;
+    const yOffset = sharedContext._context.canvas.height - h; // drawImage has top as Y=0, GL has bottom as Y=0
+    context2d.drawImage(
+      sharedContext._context.canvas,
+      0,
+      yOffset,
+      w,
+      h,
+      0,
+      0,
+      w,
+      h,
+    );
+
+    // Do normal post-frame cleanup.
+    sharedContext._context.endFrame();
+  };
+
+  const proxy = new Proxy(this._context, {
+    get(target, prop, receiver) {
+      if (prop === "isDestroyed") {
+        return function () {
+          return isDestroyed;
+        };
+      } else if (isDestroyed) {
+        //>>includeStart('debug', pragmas.debug);
+        throw new DeveloperError(
+          "This object was destroyed, i.e., destroy() was called.",
+        );
+        //>>includeEnd('debug');
+      }
+
+      switch (prop) {
+        case "_canvas":
+          return canvas;
+        case "destroy":
+          return destroy;
+        case "drawingBufferWidth":
+          return canvas.width;
+        case "drawingBufferHeight":
+          return canvas.height;
+        case "beginFrame":
+          return beginFrame;
+        case "endFrame":
+          return endFrame;
+        default:
+          return Reflect.get(target, prop, receiver);
+      }
+    },
+  });
+
+  return proxy;
+};
+
+/**
+ * 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.
+ * <br /><br />
+ * By default, a SharedContext is destroyed automatically once the last Scene using it is destroyed, in which case it
+ * is not necessary to call this method directly.
+ *
+ * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
+ *
+ * @example
+ * context = context && context.destroy();
+ *
+ * @see SharedContext#isDestroyed
+ */
+SharedContext.prototype.destroy = function () {
+  this._context.destroy();
+  destroyObject(this);
+};
+
+/**
+ * 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.
+ *
+ * @returns {boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
+ *
+ * @see SharedContext#destroy
+ */
+SharedContext.prototype.isDestroyed = function () {
+  return false;
+};
+
+export default SharedContext;

package/Source/Renderer/Texture.js

@@ -623,13 +623,12 @@ Texture.fromFramebuffer = function (options) {
   //>>includeEnd('debug');
 
   const context = options.context;
-  const gl = context._gl;
   const {
     pixelFormat = PixelFormat.RGB,
     framebufferXOffset = 0,
     framebufferYOffset = 0,
-    width = gl.drawingBufferWidth,
-    height = gl.drawingBufferHeight,
+    width = context.drawingBufferWidth,
+    height = context.drawingBufferHeight,
     framebuffer,
   } = options;
 
@@ -656,12 +655,12 @@ Texture.fromFramebuffer = function (options) {
     framebufferYOffset,
     0,
   );
-  if (framebufferXOffset + width > gl.drawingBufferWidth) {
+  if (framebufferXOffset + width > context.drawingBufferWidth) {
     throw new DeveloperError(
       "framebufferXOffset + width must be less than or equal to drawingBufferWidth",
     );
   }
-  if (framebufferYOffset + height > gl.drawingBufferHeight) {
+  if (framebufferYOffset + height > context.drawingBufferHeight) {
     throw new DeveloperError(
       "framebufferYOffset + height must be less than or equal to drawingBufferHeight.",
     );

package/Source/Renderer/Texture3D.js

@@ -13,21 +13,30 @@ import Sampler from "./Sampler.js";
 import TextureMagnificationFilter from "./TextureMagnificationFilter.js";
 import TextureMinificationFilter from "./TextureMinificationFilter.js";
 
+/**
+ * @typedef {object} Texture3D.Source
+ * @property {number} width The width (in pixels) of the 3D texture source data.
+ * @property {number} height The height (in pixels) of the 3D texture source data.
+ * @property {number} depth The depth (in pixels) of the 3D texture source data.
+ * @property {TypedArray|DataView} arrayBufferView The source data for a 3D texture. The type of each element needs to match the pixelDatatype.
+ * @property {TypedArray|DataView} [mipLevels] An array of mip level data. Each element in the array should be a TypedArray or DataView that matches the pixelDatatype.
+ */
+
 /**
  * @typedef {object} Texture3D.ConstructorOptions
  *
  * @property {Context} context
- * @property {object} [source] The source for texel values to be loaded into the texture3D.
+ * @property {Texture3D.Source} [source] The source for texel values to be loaded into the 3D texture.
  * @property {PixelFormat} [pixelFormat=PixelFormat.RGBA] The format of each pixel, i.e., the number of components it has and what they represent.
  * @property {PixelDatatype} [pixelDatatype=PixelDatatype.UNSIGNED_BYTE] The data type of each pixel.
  * @property {boolean} [flipY=true] If true, the source values will be read as if the y-axis is inverted (y=0 at the top).
  * @property {boolean} [skipColorSpaceConversion=false] If true, color space conversions will be skipped when reading the texel values.
- * @property {Sampler} [sampler] Information about how to sample the texture3D.
- * @property {number} [width] The pixel width of the texture3D. If not supplied, must be available from the source.
- * @property {number} [height] The pixel height of the texture3D. If not supplied, must be available from the source.
- * @property {number} [depth] The pixel depth of the texture3D. If not supplied, must be available from the source.
+ * @property {Sampler} [sampler] Information about how to sample the 3D texture.
+ * @property {number} [width] The width (in pixels) of the 3D texture. If not supplied, must be available from the source.
+ * @property {number} [height] The height (in pixels) of the 3D texture. If not supplied, must be available from the source.
+ * @property {number} [depth] The depth (in pixels) of the 3D texture. If not supplied, must be available from the source.
  * @property {boolean} [preMultiplyAlpha] If true, the alpha channel will be multiplied into the other channels.
- * @property {string} [id] A unique identifier for the texture3D. If this is not given, then a GUID will be created.
+ * @property {string} [id] A unique identifier for the 3D texture. If this is not given, then a GUID will be created.
  *
  * @private
  */
@@ -253,7 +262,7 @@ function Texture3D(options) {
  * Load texel data from a buffer into a texture3D.
  *
  * @param {Texture3D} texture3D The texture3D to which texel values will be loaded.
- * @param {object} source The source for texel values to be loaded into the texture3D.
+ * @param {Texture3D.Source} source The source for texel values to be loaded into the texture3D.
  *
  * @private
  */
@@ -503,6 +512,7 @@ function setupSampler(texture3D, sampler) {
   gl.bindTexture(target, texture3D._texture);
   gl.texParameteri(target, gl.TEXTURE_MIN_FILTER, minificationFilter);
   gl.texParameteri(target, gl.TEXTURE_MAG_FILTER, magnificationFilter);
+  gl.texParameteri(target, gl.TEXTURE_WRAP_R, sampler.wrapR);
   gl.texParameteri(target, gl.TEXTURE_WRAP_S, sampler.wrapS);
   gl.texParameteri(target, gl.TEXTURE_WRAP_T, sampler.wrapT);
   if (defined(texture3D._textureFilterAnisotropic)) {

package/Source/Scene/ArcGisMapService.js

@@ -4,7 +4,7 @@ import Resource from "../Core/Resource.js";
 
 let defaultTokenCredit;
 const defaultAccessToken =
-  "AAPTxy8BH1VEsoebNVZXo8HurEOF051kAEKlhkOhBEc9BmTvj0sIevECBw-bvZAvk8zYQRQq68aswXB6_yVObhIYNHapUAk3eqDIvpDZAUjFHpy1wJdPnkcKqSGXXGM22C1fqVC0gbU2S_RjRHuIHK5WVIYP7fUJQPjRGD1weDGyD5vBqwZX1Ah4LLUPG9474k1fvB1_vIROH9r9R-Sd9f9pbBFr9FjKfISJZiiJdaXVas4.AT1_eWrg8X2i";
+  "AAPTxy8BH1VEsoebNVZXo8HurEOF051kAEKlhkOhBEc9BmRXcPUeuOd6ZTh-Z86vRv6teqZdBYLUWIxB6HTYajPhFtAlXhMdqTg07UwlBQ59KbiReC5wCeOF4LzLTW4oaSPp-t4pEcJHnFePlnFcIPXM7R565gTy6f6fMuZAXPvUEuZSMf8dvTqHyV9-Zd9eZGWokDzKC4uEtHME7OeAk3oyZ7vzkjEo8fpuIfFw0sH8vQU.AT1_PLgWE6Lc";
 /**
  * Default options for accessing the ArcGIS image tile service.
  *

package/Source/Scene/BillboardCollection.js

@@ -1118,7 +1118,7 @@ function writeCompressedAttrib1(
     }
   }
 
-  const imageWidth = billboard.width ?? 0;
+  const imageWidth = Math.round(billboard.width ?? 0);
   billboardCollection._maxSize = Math.max(
     billboardCollection._maxSize,
     imageWidth,

package/Source/Scene/BingMapsImageryProvider.js

@@ -160,7 +160,7 @@ async function requestMetadata(
   const cacheKey = metadataResource.url;
   let promise = BingMapsImageryProvider._metadataCache[cacheKey];
   if (!defined(promise)) {
-    promise = metadataResource.fetchJsonp("jsonp");
+    promise = metadataResource.fetchJson();
     BingMapsImageryProvider._metadataCache[cacheKey] = promise;
   }
 

package/Source/Scene/Cesium3DTileBatchTable.js

@@ -23,6 +23,7 @@ import getBinaryAccessor from "./getBinaryAccessor.js";
 import StencilConstants from "./StencilConstants.js";
 import StencilFunction from "./StencilFunction.js";
 import StencilOperation from "./StencilOperation.js";
+import addAllToArray from "../Core/addAllToArray.js";
 
 const DEFAULT_COLOR_VALUE = BatchTexture.DEFAULT_COLOR_VALUE;
 const DEFAULT_SHOW_VALUE = BatchTexture.DEFAULT_SHOW_VALUE;
@@ -369,13 +370,14 @@ Cesium3DTileBatchTable.prototype.getPropertyIds = function (batchId, results) {
   results.length = 0;
 
   const scratchPropertyIds = Object.keys(this._properties);
-  results.push.apply(results, scratchPropertyIds);
+  addAllToArray(results, scratchPropertyIds);
 
   if (defined(this._batchTableHierarchy)) {
-    results.push.apply(
-      results,
-      this._batchTableHierarchy.getPropertyIds(batchId, scratchPropertyIds),
+    const propertyIds = this._batchTableHierarchy.getPropertyIds(
+      batchId,
+      scratchPropertyIds,
     );
+    addAllToArray(results, propertyIds);
   }
 
   return results;

package/Source/Scene/Cesium3DTileContentFactory.js

@@ -93,28 +93,19 @@ const Cesium3DTileContentFactory = {
     const dataView = new DataView(arrayBuffer, byteOffset);
     const byteLength = dataView.getUint32(8, true);
     const glb = new Uint8Array(arrayBuffer, byteOffset, byteLength);
-    let hasGaussianSplatExtension = false;
-    if (tileset.isGltfExtensionRequired instanceof Function) {
-      hasGaussianSplatExtension = tileset.isGltfExtensionRequired(
-        "KHR_spz_gaussian_splats_compression",
-      );
-    }
-    if (hasGaussianSplatExtension) {
+
+    if (
+      GaussianSplat3DTileContent.tilesetRequiresGaussianSplattingExt(tileset)
+    ) {
       return GaussianSplat3DTileContent.fromGltf(tileset, tile, resource, glb);
     }
 
     return Model3DTileContent.fromGltf(tileset, tile, resource, glb);
   },
   gltf: function (tileset, tile, resource, json) {
-    const forceGaussianSplats =
-      tileset.debugTreatTilesetAsGaussianSplats ?? false;
-    let hasGaussianSplatExtension = false;
-    if (tileset.isGltfExtensionRequired instanceof Function) {
-      hasGaussianSplatExtension = tileset.isGltfExtensionRequired(
-        "KHR_spz_gaussian_splats_compression",
-      );
-    }
-    if (forceGaussianSplats || hasGaussianSplatExtension) {
+    if (
+      GaussianSplat3DTileContent.tilesetRequiresGaussianSplattingExt(tileset)
+    ) {
       return GaussianSplat3DTileContent.fromGltf(tileset, tile, resource, json);
     }
 

package/Source/Scene/Cesium3DTileStyle.js

@@ -1,3 +1,4 @@
+import addAllToArray from "../Core/addAllToArray.js";
 import clone from "../Core/clone.js";
 import Frozen from "../Core/Frozen.js";
 import defined from "../Core/defined.js";
@@ -1452,15 +1453,15 @@ Cesium3DTileStyle.prototype.getVariables = function () {
   let variables = [];
 
   if (defined(this.color) && defined(this.color.getVariables)) {
-    variables.push.apply(variables, this.color.getVariables());
+    addAllToArray(variables, this.color.getVariables());
   }
 
   if (defined(this.show) && defined(this.show.getVariables)) {
-    variables.push.apply(variables, this.show.getVariables());
+    addAllToArray(variables, this.show.getVariables());
   }
 
   if (defined(this.pointSize) && defined(this.pointSize.getVariables)) {
-    variables.push.apply(variables, this.pointSize.getVariables());
+    addAllToArray(variables, this.pointSize.getVariables());
   }
 
   // Remove duplicates

package/Source/Scene/Cesium3DTileset.js

@@ -119,7 +119,7 @@ import ImageryLayerCollection from "./ImageryLayerCollection.js";
  * @property {string|number} [instanceFeatureIdLabel="instanceFeatureId_0"] Label of the instance feature ID set used for picking and styling. If instanceFeatureIdLabel is set to an integer N, it is converted to the string "instanceFeatureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.
  * @property {boolean} [showCreditsOnScreen=false] Whether to display the credits of this tileset on screen.
  * @property {SplitDirection} [splitDirection=SplitDirection.NONE] The {@link SplitDirection} split to apply to this tileset.
- * @property {boolean} [enableCollision=false] When <code>true</code>, enables collisions for camera or CPU picking. While this is <code>true</code> the camera will be prevented from going below the tileset surface if {@link ScreenSpaceCameraController#enableCollisionDetection} is true.
+ * @property {boolean} [enableCollision=false] When <code>true</code>, enables collisions for camera or CPU picking. While this is <code>true</code> the camera will be prevented from going below the tileset surface if {@link ScreenSpaceCameraController#enableCollisionDetection} is true. This also affects the behavior of {@link HeightReference.CLAMP_TO_GROUND} when clamping to 3D Tiles surfaces. If <code>enableCollision</code> is <code>false</code>, entities may not be correctly clamped to the tileset geometry.
  * @property {boolean} [projectTo2D=false] Whether to accurately project the tileset to 2D. If this is true, the tileset will be projected accurately to 2D, but it will use more memory to do so. If this is false, the tileset will use less memory and will still render in 2D / CV mode, but its projected positions may be inaccurate. This cannot be set after the tileset has been created.
  * @property {boolean} [enablePick=false] Whether to allow collision and CPU picking with <code>pick</code> when using WebGL 1. If using WebGL 2 or above, this option will be ignored. If using WebGL 1 and this is true, the <code>pick</code> operation will work correctly, but it will use more memory to do so. If running with WebGL 1 and this is false, the model will use less memory, but <code>pick</code> will always return <code>undefined</code>. This cannot be set after the tileset has loaded.
  * @property {boolean} [asynchronouslyLoadImagery=false] Whether loading imagery that is draped over the tileset should be done asynchronously. If this is <code>true</code>, then tile content will be displayed with its original texture until the imagery texture is loaded. If this is <code>false</code>, then the tile content will not be displayed until the imagery is ready.
@@ -147,7 +147,7 @@ import ImageryLayerCollection from "./ImageryLayerCollection.js";
  *
  * @alias Cesium3DTileset
  * @constructor
- * @experimental Support for loading Gaussian splats content encoded with SPZ compression using the draft glTF extension {@link https://github.com/KhronosGroup/glTF/pull/2490 | KHR_spz_gaussian_splats_compression} is experimental and is subject change without Cesium's standard deprecation policy.
+ * @experimental Support for loading Gaussian splats content encoded with SPZ compression using the draft glTF extensions {@link https://github.com/CesiumGS/glTF/tree/draft-splat-spz/extensions/2.0/Khronos/KHR_gaussian_splatting | KHR_gaussian_splatting} and {@link https://github.com/CesiumGS/glTF/tree/draft-splat-spz/extensions/2.0/Khronos/KHR_gaussian_splatting_compression_spz_2 | KHR_gaussian_splatting_compression_spz_2} is experimental and is subject change without Cesium's standard deprecation policy.
  * @param {Cesium3DTileset.ConstructorOptions} options An object describing initialization options
  *
  * @exception {DeveloperError} The tileset must be 3D Tiles version 0.0 or 1.0.

package/Source/Scene/ConditionsExpression.js

@@ -1,3 +1,4 @@
+import addAllToArray from "../Core/addAllToArray.js";
 import clone from "../Core/clone.js";
 import defined from "../Core/defined.js";
 import Expression from "./Expression.js";
@@ -203,8 +204,8 @@ ConditionsExpression.prototype.getVariables = function () {
   const length = conditions.length;
   for (let i = 0; i < length; ++i) {
     const statement = conditions[i];
-    variables.push.apply(variables, statement.condition.getVariables());
-    variables.push.apply(variables, statement.expression.getVariables());
+    addAllToArray(variables, statement.condition.getVariables());
+    addAllToArray(variables, statement.expression.getVariables());
   }
 
   // Remove duplicates