@cesium/engine 23.0.1 → 25.0.0

package/Source/Scene/BufferPrimitiveMaterial.js

@@ -0,0 +1,140 @@
+// @ts-check
+
+import Color from "../Core/Color.js";
+import Frozen from "../Core/Frozen.js";
+
+/** @import Packable from "../Core/Packable.js"; */
+/** @import BufferPrimitive from "./BufferPrimitive.js"; */
+
+/**
+ * @typedef {object} BufferPrimitiveMaterialOptions
+ * @property {Color} [color=Color.WHITE] Color of fill.
+ * @property {Color} [outlineColor=Color.WHITE] Color of outline.
+ * @property {number} [outlineWidth=0.0] Width of outline, 0-255px.
+ */
+
+/**
+ * Material description for a {@link BufferPrimitive}. Abstract.
+ *
+ * <p>BufferPrimitiveMaterial objects are {@link Packable|packable}, stored
+ * when calling {@link BufferPrimitive#setMaterial}. Subsequent changes to the
+ * material will not affect the primitive until setMaterial() is called again.</p>
+ *
+ * @see BufferPointMaterial
+ * @see BufferPolylineMaterial
+ * @see BufferPolygonMaterial
+ * @see Packable
+ *
+ * @abstract
+ * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
+ */
+class BufferPrimitiveMaterial {
+  /** @ignore */
+  static Layout = {
+    COLOR_U32: 0,
+    OUTLINE_COLOR_U32: 4,
+    OUTLINE_WIDTH_U8: 8,
+    __BYTE_LENGTH: 12,
+  };
+
+  /**
+   * @type {BufferPrimitiveMaterial}
+   * @ignore
+   */
+  static DEFAULT_MATERIAL;
+
+  /**
+   * @param {BufferPrimitiveMaterialOptions} [options]
+   */
+  constructor(options = Frozen.EMPTY_OBJECT) {
+    /**
+     * Color of fill.
+     * @type {Color}
+     */
+    this.color = Color.clone(options.color ?? Color.WHITE);
+
+    /**
+     * Color of outline.
+     * @type {Color}
+     */
+    this.outlineColor = Color.clone(options.outlineColor ?? Color.WHITE);
+
+    /**
+     * Width of outline, 0-255px.
+     * @type {number}
+     */
+    this.outlineWidth = options.outlineWidth ?? 0;
+  }
+
+  /** @type {number} */
+  static get packedLength() {
+    return this.Layout.__BYTE_LENGTH;
+  }
+
+  /**
+   * Stores the provided material into the provided array.
+   *
+   * @param {BufferPrimitiveMaterial} material
+   * @param {DataView} view
+   * @param {number} byteOffset
+   */
+  static pack(material, view, byteOffset) {
+    view.setUint32(
+      this.Layout.COLOR_U32 + byteOffset,
+      material.color.toRgba(),
+      true,
+    );
+    view.setUint32(
+      this.Layout.OUTLINE_COLOR_U32 + byteOffset,
+      material.outlineColor.toRgba(),
+      true,
+    );
+    view.setUint8(
+      this.Layout.OUTLINE_WIDTH_U8 + byteOffset,
+      material.outlineWidth,
+    );
+  }
+
+  /**
+   * Retrieves a material from a packed array.
+   *
+   * @param {DataView} view The packed array.
+   * @param {number} byteOffset Starting index of the element to be unpacked.
+   * @param {BufferPrimitiveMaterial} result Material into which results are unpacked.
+   * @returns {BufferPrimitiveMaterial} Modified result material, with results unpacked.
+   */
+  static unpack(view, byteOffset, result) {
+    Color.fromRgba(
+      view.getUint32(this.Layout.COLOR_U32 + byteOffset, true),
+      result.color,
+    );
+    Color.fromRgba(
+      view.getUint32(this.Layout.OUTLINE_COLOR_U32 + byteOffset, true),
+      result.outlineColor,
+    );
+    result.outlineWidth = view.getUint8(
+      this.Layout.OUTLINE_WIDTH_U8 + byteOffset,
+    );
+    return result;
+  }
+
+  /////////////////////////////////////////////////////////////////////////////
+  // DEBUG
+
+  /**
+   * Returns a JSON-serializable object representing the material. This encoding
+   * is not memory-efficient, and should generally be used for debugging and
+   * testing.
+   *
+   * @returns {Object} JSON-serializable object.
+   */
+  toJSON() {
+    return {
+      color: this.color.toCssHexString(),
+      outlineColor: this.outlineColor.toCssHexString(),
+      outlineWidth: this.outlineWidth,
+    };
+  }
+}
+
+export default BufferPrimitiveMaterial;

package/Source/Scene/CameraEventType.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 /**
  * Enumerates the available input for interacting with the camera.
  *
@@ -44,4 +46,7 @@ const CameraEventType = {
    */
   PINCH: 4,
 };
-export default Object.freeze(CameraEventType);
+
+Object.freeze(CameraEventType);
+
+export default CameraEventType;

package/Source/Scene/Cesium3DTileColorBlendMode.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 /**
  * Defines how per-feature colors set from the Cesium API or declarative styling blend with the source colors from
  * the original feature, e.g. glTF material or per-point color in the tile.
@@ -49,4 +51,7 @@ const Cesium3DTileColorBlendMode = {
    */
   MIX: 2,
 };
-export default Object.freeze(Cesium3DTileColorBlendMode);
+
+Object.freeze(Cesium3DTileColorBlendMode);
+
+export default Cesium3DTileColorBlendMode;

package/Source/Scene/Cesium3DTileContent.js

@@ -255,7 +255,7 @@ Object.defineProperties(Cesium3DTileContent.prototype, {
    * not part of the public Cesium API.
    * </p>
    *
-   * @type {Cesium3DTileContentGroup|undefined}
+   * @type {Cesium3DContentGroup|undefined}
    *
    * @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.
@@ -325,6 +325,7 @@ Cesium3DTileContent.prototype.applyDebugSettings = function (enabled, color) {
  * </p>
  *
  * @param {Cesium3DTileStyle} style The style.
+ * @returns {void}
  *
  * @private
  */
@@ -343,6 +344,7 @@ Cesium3DTileContent.prototype.applyStyle = function (style) {
  *
  * @param {Cesium3DTileset} tileset The tileset containing this tile.
  * @param {FrameState} frameState The frame state.
+ * @returns {void}
  *
  * @private
  */
@@ -403,6 +405,8 @@ Cesium3DTileContent.prototype.isDestroyed = function () {
  *
  * @see Cesium3DTileContent#isDestroyed
  *
+ * @returns {void}
+ *
  * @private
  */
 Cesium3DTileContent.prototype.destroy = function () {

package/Source/Scene/Cesium3DTileContentFactory.js

@@ -4,6 +4,7 @@ import Implicit3DTileContent from "./Implicit3DTileContent.js";
 import Model3DTileContent from "./Model/Model3DTileContent.js";
 import Tileset3DTileContent from "./Tileset3DTileContent.js";
 import Vector3DTileContent from "./Vector3DTileContent.js";
+import VectorGltf3DTileContent from "./VectorGltf3DTileContent.js";
 import GaussianSplat3DTileContent from "./GaussianSplat3DTileContent.js";
 import RuntimeError from "../Core/RuntimeError.js";
 
@@ -100,6 +101,10 @@ const Cesium3DTileContentFactory = {
       return GaussianSplat3DTileContent.fromGltf(tileset, tile, resource, glb);
     }
 
+    if (tileset.isGltfExtensionUsed("CESIUM_mesh_vector")) {
+      return VectorGltf3DTileContent.fromGltf(tileset, tile, resource, glb);
+    }
+
     return Model3DTileContent.fromGltf(tileset, tile, resource, glb);
   },
   gltf: function (tileset, tile, resource, json) {
@@ -109,6 +114,10 @@ const Cesium3DTileContentFactory = {
       return GaussianSplat3DTileContent.fromGltf(tileset, tile, resource, json);
     }
 
+    if (tileset.isGltfExtensionUsed("CESIUM_mesh_vector")) {
+      return VectorGltf3DTileContent.fromGltf(tileset, tile, resource, json);
+    }
+
     return Model3DTileContent.fromGltf(tileset, tile, resource, json);
   },
   geoJson: function (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;