@cesium/engine 23.0.1 → 25.0.0

package/Source/Core/WebMercatorTilingScheme.js

@@ -1,291 +1,295 @@
+// @ts-check
+
 import Cartesian2 from "./Cartesian2.js";
+import Cartesian3 from "./Cartesian3.js";
+import Cartographic from "./Cartographic.js";
 import Frozen from "./Frozen.js";
 import defined from "./defined.js";
 import Ellipsoid from "./Ellipsoid.js";
 import Rectangle from "./Rectangle.js";
 import WebMercatorProjection from "./WebMercatorProjection.js";
 
+/** @import MapProjection from "./MapProjection.js"; */
+/** @import TilingScheme from "./TilingScheme.js"; */
+
+const southwestScratch = new Cartographic();
+const northeastScratch = new Cartographic();
+
+const southwestCartesianScratch = new Cartesian3();
+const northeastCartesianScratch = new Cartesian3();
+
 /**
  * A tiling scheme for geometry referenced to a {@link WebMercatorProjection}, EPSG:3857.  This is
  * the tiling scheme used by Google Maps, Microsoft Bing Maps, and most of ESRI ArcGIS Online.
  *
- * @alias WebMercatorTilingScheme
- * @constructor
- *
- * @param {object} [options] Object with the following properties:
- * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.default] The ellipsoid whose surface is being tiled. Defaults to
- * the default ellipsoid.
- * @param {number} [options.numberOfLevelZeroTilesX=1] The number of tiles in the X direction at level zero of
- *        the tile tree.
- * @param {number} [options.numberOfLevelZeroTilesY=1] The number of tiles in the Y direction at level zero of
- *        the tile tree.
- * @param {Cartesian2} [options.rectangleSouthwestInMeters] The southwest corner of the rectangle covered by the
- *        tiling scheme, in meters.  If this parameter or rectangleNortheastInMeters is not specified, the entire
- *        globe is covered in the longitude direction and an equal distance is covered in the latitude
- *        direction, resulting in a square projection.
- * @param {Cartesian2} [options.rectangleNortheastInMeters] The northeast corner of the rectangle covered by the
- *        tiling scheme, in meters.  If this parameter or rectangleSouthwestInMeters is not specified, the entire
- *        globe is covered in the longitude direction and an equal distance is covered in the latitude
- *        direction, resulting in a square projection.
+ * @implements {TilingScheme}
  */
-function WebMercatorTilingScheme(options) {
-  options = options ?? Frozen.EMPTY_OBJECT;
-
-  this._ellipsoid = options.ellipsoid ?? Ellipsoid.default;
-  this._numberOfLevelZeroTilesX = options.numberOfLevelZeroTilesX ?? 1;
-  this._numberOfLevelZeroTilesY = options.numberOfLevelZeroTilesY ?? 1;
-
-  this._projection = new WebMercatorProjection(this._ellipsoid);
-
-  if (
-    defined(options.rectangleSouthwestInMeters) &&
-    defined(options.rectangleNortheastInMeters)
-  ) {
-    this._rectangleSouthwestInMeters = options.rectangleSouthwestInMeters;
-    this._rectangleNortheastInMeters = options.rectangleNortheastInMeters;
-  } else {
-    const semimajorAxisTimesPi = this._ellipsoid.maximumRadius * Math.PI;
-    this._rectangleSouthwestInMeters = new Cartesian2(
-      -semimajorAxisTimesPi,
-      -semimajorAxisTimesPi,
-    );
-    this._rectangleNortheastInMeters = new Cartesian2(
-      semimajorAxisTimesPi,
-      semimajorAxisTimesPi,
+class WebMercatorTilingScheme {
+  /**
+   * @type {Cartesian2}
+   * @private
+   */
+  _rectangleSouthwestInMeters;
+
+  /**
+   * @type {Cartesian2}
+   * @private
+   */
+  _rectangleNortheastInMeters;
+
+  /**
+   * @param {object} [options] Object with the following properties:
+   * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.default] The ellipsoid whose surface is being tiled. Defaults to
+   * the default ellipsoid.
+   * @param {number} [options.numberOfLevelZeroTilesX=1] The number of tiles in the X direction at level zero of
+   *        the tile tree.
+   * @param {number} [options.numberOfLevelZeroTilesY=1] The number of tiles in the Y direction at level zero of
+   *        the tile tree.
+   * @param {Cartesian2} [options.rectangleSouthwestInMeters] The southwest corner of the rectangle covered by the
+   *        tiling scheme, in meters.  If this parameter or rectangleNortheastInMeters is not specified, the entire
+   *        globe is covered in the longitude direction and an equal distance is covered in the latitude
+   *        direction, resulting in a square projection.
+   * @param {Cartesian2} [options.rectangleNortheastInMeters] The northeast corner of the rectangle covered by the
+   *        tiling scheme, in meters.  If this parameter or rectangleSouthwestInMeters is not specified, the entire
+   *        globe is covered in the longitude direction and an equal distance is covered in the latitude
+   *        direction, resulting in a square projection.
+   */
+  constructor(options) {
+    options = options ?? Frozen.EMPTY_OBJECT;
+
+    this._ellipsoid = options.ellipsoid ?? Ellipsoid.default;
+    this._numberOfLevelZeroTilesX = options.numberOfLevelZeroTilesX ?? 1;
+    this._numberOfLevelZeroTilesY = options.numberOfLevelZeroTilesY ?? 1;
+
+    this._projection = new WebMercatorProjection(this._ellipsoid);
+
+    if (
+      defined(options.rectangleSouthwestInMeters) &&
+      defined(options.rectangleNortheastInMeters)
+    ) {
+      this._rectangleSouthwestInMeters = options.rectangleSouthwestInMeters;
+      this._rectangleNortheastInMeters = options.rectangleNortheastInMeters;
+    } else {
+      const semimajorAxisTimesPi = this._ellipsoid.maximumRadius * Math.PI;
+      this._rectangleSouthwestInMeters = new Cartesian2(
+        -semimajorAxisTimesPi,
+        -semimajorAxisTimesPi,
+      );
+      this._rectangleNortheastInMeters = new Cartesian2(
+        semimajorAxisTimesPi,
+        semimajorAxisTimesPi,
+      );
+    }
+
+    let { x, y } = this._rectangleSouthwestInMeters;
+    Cartesian3.fromElements(x, y, 0, southwestCartesianScratch);
+    this._projection.unproject(southwestCartesianScratch, southwestScratch);
+
+    ({ x, y } = this._rectangleNortheastInMeters);
+    Cartesian3.fromElements(x, y, 0, northeastCartesianScratch);
+    this._projection.unproject(northeastCartesianScratch, northeastScratch);
+
+    this._rectangle = new Rectangle(
+      southwestScratch.longitude,
+      southwestScratch.latitude,
+      northeastScratch.longitude,
+      northeastScratch.latitude,
     );
   }
 
-  const southwest = this._projection.unproject(
-    this._rectangleSouthwestInMeters,
-  );
-  const northeast = this._projection.unproject(
-    this._rectangleNortheastInMeters,
-  );
-  this._rectangle = new Rectangle(
-    southwest.longitude,
-    southwest.latitude,
-    northeast.longitude,
-    northeast.latitude,
-  );
-}
-
-Object.defineProperties(WebMercatorTilingScheme.prototype, {
   /**
    * Gets the ellipsoid that is tiled by this tiling scheme.
-   * @memberof WebMercatorTilingScheme.prototype
    * @type {Ellipsoid}
    */
-  ellipsoid: {
-    get: function () {
-      return this._ellipsoid;
-    },
-  },
+  get ellipsoid() {
+    return this._ellipsoid;
+  }
 
   /**
    * Gets the rectangle, in radians, covered by this tiling scheme.
-   * @memberof WebMercatorTilingScheme.prototype
    * @type {Rectangle}
    */
-  rectangle: {
-    get: function () {
-      return this._rectangle;
-    },
-  },
+  get rectangle() {
+    return this._rectangle;
+  }
 
   /**
    * Gets the map projection used by this tiling scheme.
-   * @memberof WebMercatorTilingScheme.prototype
    * @type {MapProjection}
    */
-  projection: {
-    get: function () {
-      return this._projection;
-    },
-  },
-});
+  get projection() {
+    return this._projection;
+  }
 
-/**
- * Gets the total number of tiles in the X direction at a specified level-of-detail.
- *
- * @param {number} level The level-of-detail.
- * @returns {number} The number of tiles in the X direction at the given level.
- */
-WebMercatorTilingScheme.prototype.getNumberOfXTilesAtLevel = function (level) {
-  return this._numberOfLevelZeroTilesX << level;
-};
+  /**
+   * Gets the total number of tiles in the X direction at a specified level-of-detail.
+   *
+   * @param {number} level The level-of-detail.
+   * @returns {number} The number of tiles in the X direction at the given level.
+   */
+  getNumberOfXTilesAtLevel(level) {
+    return this._numberOfLevelZeroTilesX << level;
+  }
 
-/**
- * Gets the total number of tiles in the Y direction at a specified level-of-detail.
- *
- * @param {number} level The level-of-detail.
- * @returns {number} The number of tiles in the Y direction at the given level.
- */
-WebMercatorTilingScheme.prototype.getNumberOfYTilesAtLevel = function (level) {
-  return this._numberOfLevelZeroTilesY << level;
-};
+  /**
+   * Gets the total number of tiles in the Y direction at a specified level-of-detail.
+   *
+   * @param {number} level The level-of-detail.
+   * @returns {number} The number of tiles in the Y direction at the given level.
+   */
+  getNumberOfYTilesAtLevel(level) {
+    return this._numberOfLevelZeroTilesY << level;
+  }
 
-/**
- * Transforms a rectangle specified in geodetic radians to the native coordinate system
- * of this tiling scheme.
- *
- * @param {Rectangle} rectangle The rectangle to transform.
- * @param {Rectangle} [result] The instance to which to copy the result, or undefined if a new instance
- *        should be created.
- * @returns {Rectangle} The specified 'result', or a new object containing the native rectangle if 'result'
- *          is undefined.
- */
-WebMercatorTilingScheme.prototype.rectangleToNativeRectangle = function (
-  rectangle,
-  result,
-) {
-  const projection = this._projection;
-  const southwest = projection.project(Rectangle.southwest(rectangle));
-  const northeast = projection.project(Rectangle.northeast(rectangle));
-
-  if (!defined(result)) {
-    return new Rectangle(southwest.x, southwest.y, northeast.x, northeast.y);
+  /**
+   * Transforms a rectangle specified in geodetic radians to the native coordinate system
+   * of this tiling scheme.
+   *
+   * @param {Rectangle} rectangle The rectangle to transform.
+   * @param {Rectangle} [result] The instance to which to copy the result, or undefined if a new instance
+   *        should be created.
+   * @returns {Rectangle} The specified 'result', or a new object containing the native rectangle if 'result'
+   *          is undefined.
+   */
+  rectangleToNativeRectangle(rectangle, result) {
+    const projection = this._projection;
+    const southwest = projection.project(Rectangle.southwest(rectangle));
+    const northeast = projection.project(Rectangle.northeast(rectangle));
+
+    if (!defined(result)) {
+      return new Rectangle(southwest.x, southwest.y, northeast.x, northeast.y);
+    }
+
+    result.west = southwest.x;
+    result.south = southwest.y;
+    result.east = northeast.x;
+    result.north = northeast.y;
+    return result;
   }
 
-  result.west = southwest.x;
-  result.south = southwest.y;
-  result.east = northeast.x;
-  result.north = northeast.y;
-  return result;
-};
+  /**
+   * Converts tile x, y coordinates and level to a rectangle expressed in the native coordinates
+   * of the tiling scheme.
+   *
+   * @param {number} x The integer x coordinate of the tile.
+   * @param {number} y The integer y coordinate of the tile.
+   * @param {number} level The tile level-of-detail.  Zero is the least detailed.
+   * @param {Rectangle} [result] The instance to which to copy the result, or undefined if a new instance
+   *        should be created.
+   * @returns {Rectangle} The specified 'result', or a new object containing the rectangle
+   *          if 'result' is undefined.
+   */
+  tileXYToNativeRectangle(x, y, level, result) {
+    const xTiles = this.getNumberOfXTilesAtLevel(level);
+    const yTiles = this.getNumberOfYTilesAtLevel(level);
 
-/**
- * Converts tile x, y coordinates and level to a rectangle expressed in the native coordinates
- * of the tiling scheme.
- *
- * @param {number} x The integer x coordinate of the tile.
- * @param {number} y The integer y coordinate of the tile.
- * @param {number} level The tile level-of-detail.  Zero is the least detailed.
- * @param {object} [result] The instance to which to copy the result, or undefined if a new instance
- *        should be created.
- * @returns {Rectangle} The specified 'result', or a new object containing the rectangle
- *          if 'result' is undefined.
- */
-WebMercatorTilingScheme.prototype.tileXYToNativeRectangle = function (
-  x,
-  y,
-  level,
-  result,
-) {
-  const xTiles = this.getNumberOfXTilesAtLevel(level);
-  const yTiles = this.getNumberOfYTilesAtLevel(level);
-
-  const xTileWidth =
-    (this._rectangleNortheastInMeters.x - this._rectangleSouthwestInMeters.x) /
-    xTiles;
-  const west = this._rectangleSouthwestInMeters.x + x * xTileWidth;
-  const east = this._rectangleSouthwestInMeters.x + (x + 1) * xTileWidth;
-
-  const yTileHeight =
-    (this._rectangleNortheastInMeters.y - this._rectangleSouthwestInMeters.y) /
-    yTiles;
-  const north = this._rectangleNortheastInMeters.y - y * yTileHeight;
-  const south = this._rectangleNortheastInMeters.y - (y + 1) * yTileHeight;
-
-  if (!defined(result)) {
-    return new Rectangle(west, south, east, north);
+    const xTileWidth =
+      (this._rectangleNortheastInMeters.x -
+        this._rectangleSouthwestInMeters.x) /
+      xTiles;
+    const west = this._rectangleSouthwestInMeters.x + x * xTileWidth;
+    const east = this._rectangleSouthwestInMeters.x + (x + 1) * xTileWidth;
+
+    const yTileHeight =
+      (this._rectangleNortheastInMeters.y -
+        this._rectangleSouthwestInMeters.y) /
+      yTiles;
+    const north = this._rectangleNortheastInMeters.y - y * yTileHeight;
+    const south = this._rectangleNortheastInMeters.y - (y + 1) * yTileHeight;
+
+    if (!defined(result)) {
+      return new Rectangle(west, south, east, north);
+    }
+
+    result.west = west;
+    result.south = south;
+    result.east = east;
+    result.north = north;
+    return result;
   }
 
-  result.west = west;
-  result.south = south;
-  result.east = east;
-  result.north = north;
-  return result;
-};
+  /**
+   * Converts tile x, y coordinates and level to a cartographic rectangle in radians.
+   *
+   * @param {number} x The integer x coordinate of the tile.
+   * @param {number} y The integer y coordinate of the tile.
+   * @param {number} level The tile level-of-detail.  Zero is the least detailed.
+   * @param {Rectangle} [result] The instance to which to copy the result, or undefined if a new instance
+   *        should be created.
+   * @returns {Rectangle} The specified 'result', or a new object containing the rectangle
+   *          if 'result' is undefined.
+   */
+  tileXYToRectangle(x, y, level, result) {
+    const nativeRectangle = this.tileXYToNativeRectangle(x, y, level, result);
 
-/**
- * Converts tile x, y coordinates and level to a cartographic rectangle in radians.
- *
- * @param {number} x The integer x coordinate of the tile.
- * @param {number} y The integer y coordinate of the tile.
- * @param {number} level The tile level-of-detail.  Zero is the least detailed.
- * @param {object} [result] The instance to which to copy the result, or undefined if a new instance
- *        should be created.
- * @returns {Rectangle} The specified 'result', or a new object containing the rectangle
- *          if 'result' is undefined.
- */
-WebMercatorTilingScheme.prototype.tileXYToRectangle = function (
-  x,
-  y,
-  level,
-  result,
-) {
-  const nativeRectangle = this.tileXYToNativeRectangle(x, y, level, result);
-
-  const projection = this._projection;
-  const southwest = projection.unproject(
-    new Cartesian2(nativeRectangle.west, nativeRectangle.south),
-  );
-  const northeast = projection.unproject(
-    new Cartesian2(nativeRectangle.east, nativeRectangle.north),
-  );
-
-  nativeRectangle.west = southwest.longitude;
-  nativeRectangle.south = southwest.latitude;
-  nativeRectangle.east = northeast.longitude;
-  nativeRectangle.north = northeast.latitude;
-  return nativeRectangle;
-};
+    const projection = this._projection;
+    const southwest = projection.unproject(
+      new Cartesian3(nativeRectangle.west, nativeRectangle.south),
+    );
+    const northeast = projection.unproject(
+      new Cartesian3(nativeRectangle.east, nativeRectangle.north),
+    );
 
-/**
- * Calculates the tile x, y coordinates of the tile containing
- * a given cartographic position.
- *
- * @param {Cartographic} position The position.
- * @param {number} level The tile level-of-detail.  Zero is the least detailed.
- * @param {Cartesian2} [result] The instance to which to copy the result, or undefined if a new instance
- *        should be created.
- * @returns {Cartesian2} The specified 'result', or a new object containing the tile x, y coordinates
- *          if 'result' is undefined.
- */
-WebMercatorTilingScheme.prototype.positionToTileXY = function (
-  position,
-  level,
-  result,
-) {
-  const rectangle = this._rectangle;
-  if (!Rectangle.contains(rectangle, position)) {
-    // outside the bounds of the tiling scheme
-    return undefined;
+    nativeRectangle.west = southwest.longitude;
+    nativeRectangle.south = southwest.latitude;
+    nativeRectangle.east = northeast.longitude;
+    nativeRectangle.north = northeast.latitude;
+    return nativeRectangle;
   }
 
-  const xTiles = this.getNumberOfXTilesAtLevel(level);
-  const yTiles = this.getNumberOfYTilesAtLevel(level);
+  /**
+   * Calculates the tile x, y coordinates of the tile containing
+   * a given cartographic position.
+   *
+   * @param {Cartographic} position The position.
+   * @param {number} level The tile level-of-detail.  Zero is the least detailed.
+   * @param {Cartesian2} [result] The instance to which to copy the result, or undefined if a new instance
+   *        should be created.
+   * @returns {Cartesian2} The specified 'result', or a new object containing the tile x, y coordinates
+   *          if 'result' is undefined.
+   */
+  positionToTileXY(position, level, result) {
+    const rectangle = this._rectangle;
+    if (!Rectangle.contains(rectangle, position)) {
+      // outside the bounds of the tiling scheme
+      return undefined;
+    }
 
-  const overallWidth =
-    this._rectangleNortheastInMeters.x - this._rectangleSouthwestInMeters.x;
-  const xTileWidth = overallWidth / xTiles;
-  const overallHeight =
-    this._rectangleNortheastInMeters.y - this._rectangleSouthwestInMeters.y;
-  const yTileHeight = overallHeight / yTiles;
+    const xTiles = this.getNumberOfXTilesAtLevel(level);
+    const yTiles = this.getNumberOfYTilesAtLevel(level);
 
-  const projection = this._projection;
+    const overallWidth =
+      this._rectangleNortheastInMeters.x - this._rectangleSouthwestInMeters.x;
+    const xTileWidth = overallWidth / xTiles;
+    const overallHeight =
+      this._rectangleNortheastInMeters.y - this._rectangleSouthwestInMeters.y;
+    const yTileHeight = overallHeight / yTiles;
 
-  const webMercatorPosition = projection.project(position);
-  const distanceFromWest =
-    webMercatorPosition.x - this._rectangleSouthwestInMeters.x;
-  const distanceFromNorth =
-    this._rectangleNortheastInMeters.y - webMercatorPosition.y;
+    const projection = this._projection;
 
-  let xTileCoordinate = (distanceFromWest / xTileWidth) | 0;
-  if (xTileCoordinate >= xTiles) {
-    xTileCoordinate = xTiles - 1;
-  }
-  let yTileCoordinate = (distanceFromNorth / yTileHeight) | 0;
-  if (yTileCoordinate >= yTiles) {
-    yTileCoordinate = yTiles - 1;
-  }
+    const webMercatorPosition = projection.project(position);
+    const distanceFromWest =
+      webMercatorPosition.x - this._rectangleSouthwestInMeters.x;
+    const distanceFromNorth =
+      this._rectangleNortheastInMeters.y - webMercatorPosition.y;
+
+    let xTileCoordinate = (distanceFromWest / xTileWidth) | 0;
+    if (xTileCoordinate >= xTiles) {
+      xTileCoordinate = xTiles - 1;
+    }
+    let yTileCoordinate = (distanceFromNorth / yTileHeight) | 0;
+    if (yTileCoordinate >= yTiles) {
+      yTileCoordinate = yTiles - 1;
+    }
 
-  if (!defined(result)) {
-    return new Cartesian2(xTileCoordinate, yTileCoordinate);
+    if (!defined(result)) {
+      return new Cartesian2(xTileCoordinate, yTileCoordinate);
+    }
+
+    result.x = xTileCoordinate;
+    result.y = yTileCoordinate;
+    return result;
   }
+}
 
-  result.x = xTileCoordinate;
-  result.y = yTileCoordinate;
-  return result;
-};
 export default WebMercatorTilingScheme;

package/Source/Core/WindingOrder.js

@@ -33,4 +33,6 @@ WindingOrder.validate = function (windingOrder) {
   );
 };
 
-export default Object.freeze(WindingOrder);
+Object.freeze(WindingOrder);
+
+export default WindingOrder;

package/Source/Core/assert.js

@@ -0,0 +1,27 @@
+// @ts-check
+
+import DeveloperError from "./DeveloperError.js";
+
+/**
+ * Checks that a condition is truthy, throwing a specified message if condition
+ * fails. The `asserts condition` return type allows TypeScript to narrow the
+ * types of the condition and enforce stricter types without further if/else
+ * checks or nullish coalescing.
+ *
+ * @example
+ * assert(object.optionalProperty, 'Missing .optionalProperty');
+ * object.optionalProperty.toString(); // safe; no type error.
+ *
+ * @function
+ *
+ * @param {*} condition
+ * @param {string} msg
+ * @ignore
+ */
+function assert(condition, msg) {
+  if (!condition) {
+    throw new DeveloperError(msg);
+  }
+}
+
+export default assert;

package/Source/Core/globalTypes.js

@@ -8,6 +8,10 @@
  * @typedef {Float64ArrayConstructor|Float32ArrayConstructor|Uint32ArrayConstructor|Uint16ArrayConstructor|Uint8ArrayConstructor|Int32ArrayConstructor|Int16ArrayConstructor|Int8ArrayConstructor} TypedArrayConstructor
  */
 
+/**
+ * @typedef {{destroy: Function}} Destroyable
+ */
+
 /**
  * This file is omitted from 'workspaceSourceFiles' in 'scripts/build.js', and
  * must provide type-only exports exclusively, without runtime values.

package/Source/DataSources/CzmlDataSource.js

@@ -3645,6 +3645,15 @@ function processPath(entity, packet, entityCollection, sourceUri) {
     sourceUri,
     entityCollection,
   );
+  processPacketData(
+    String,
+    path,
+    "relativeTo",
+    pathData.relativeTo,
+    interval,
+    sourceUri,
+    entityCollection,
+  );
 }
 
 function processPoint(entity, packet, entityCollection, sourceUri) {

package/Source/DataSources/PathGraphics.js

@@ -17,6 +17,7 @@ import createPropertyDescriptor from "./createPropertyDescriptor.js";
  * @property {Property | number} [resolution=60] A numeric Property specifying the maximum number of seconds to step when sampling the position.
  * @property {MaterialProperty | Color} [material=Color.WHITE] A Property specifying the material used to draw the path.
  * @property {Property | DistanceDisplayCondition} [distanceDisplayCondition] A Property specifying at what distance from the camera that this path will be displayed.
+ * @property {Property | string} [relativeTo] A Property specifying the frame in which to visualize the path. Use another entity's id to visualize the path relative to that entity, or use the string values "FIXED" or "INERTIAL" to visualize the path in those reference frames.
  */
 
 /**
@@ -43,6 +44,8 @@ function PathGraphics(options) {
   this._materialSubscription = undefined;
   this._distanceDisplayCondition = undefined;
   this._distanceDisplayConditionSubscription = undefined;
+  this._relativeTo = undefined;
+  this._relativeToSubscription = undefined;
 
   this.merge(options ?? Frozen.EMPTY_OBJECT);
 }
@@ -114,6 +117,14 @@ Object.defineProperties(PathGraphics.prototype, {
   distanceDisplayCondition: createPropertyDescriptor(
     "distanceDisplayCondition",
   ),
+
+  /**
+   * Gets or sets the frame in which to visualize the path. Use another entity's id to visualize the path relative to that entity, or use the string values "FIXED" or "INERTIAL" to visualize the path in those reference frames.
+   * @memberof PathGraphics.prototype
+   * @type {Property|undefined}
+   * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
+   */
+  relativeTo: createPropertyDescriptor("relativeTo"),
 });
 
 /**
@@ -133,6 +144,7 @@ PathGraphics.prototype.clone = function (result) {
   result.resolution = this.resolution;
   result.material = this.material;
   result.distanceDisplayCondition = this.distanceDisplayCondition;
+  result.relativeTo = this.relativeTo;
   return result;
 };
 
@@ -157,5 +169,6 @@ PathGraphics.prototype.merge = function (source) {
   this.material = this.material ?? source.material;
   this.distanceDisplayCondition =
     this.distanceDisplayCondition ?? source.distanceDisplayCondition;
+  this.relativeTo = this.relativeTo ?? source.relativeTo;
 };
 export default PathGraphics;