@cesium/engine 12.0.1 → 13.0.0

package/Source/Core/ITwinPlatform.js

@@ -0,0 +1,359 @@
+import Check from "./Check.js";
+import defined from "./defined.js";
+import DeveloperError from "./DeveloperError.js";
+import Resource from "./Resource.js";
+import RuntimeError from "./RuntimeError.js";
+
+/**
+ * Default settings for accessing the iTwin platform.
+ *
+ * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
+ *
+ * @see ITwinData
+ * @namespace ITwinPlatform
+ */
+const ITwinPlatform = {};
+
+/**
+ * Status states for a mesh-export export.
+ * Valid values are: <code>NotStarted</code>, <code>InProgress</code>, <code>Complete</code>, <code>Invalid</code>
+ * @enum {string}
+ */
+ITwinPlatform.ExportStatus = Object.freeze({
+  NotStarted: "NotStarted",
+  InProgress: "InProgress",
+  Complete: "Complete",
+  Invalid: "Invalid",
+});
+
+/**
+ * Types of mesh-export exports. CesiumJS only supports loading <code>3DTILES</code> type exports.
+ * Valid values are: <code>IMODEL</code>, <code>CESIUM</code>, <code>3DTILES</code>
+ * @enum {string}
+ */
+ITwinPlatform.ExportType = Object.freeze({
+  IMODEL: "IMODEL",
+  CESIUM: "CESIUM",
+  "3DTILES": "3DTILES",
+});
+
+/**
+ * Types of Reality data
+ * @see https://developer.bentley.com/apis/reality-management/rm-rd-details/#types
+ * @enum {string}
+ */
+ITwinPlatform.RealityDataType = Object.freeze({
+  Cesium3DTiles: "Cesium3DTiles",
+  PNTS: "PNTS",
+  OPC: "OPC",
+  RealityMesh3DTiles: "RealityMesh3DTiles",
+  Terrain3DTiles: "Terrain3DTiles",
+  "3MX": "3MX",
+  "3SM": "3SM",
+  CCCloudProject: "CCCloudProject",
+  CCImageCollection: "CCImageCollection",
+  CCOrientations: "CCOrientations",
+  ContextCaptureInputs: "ContextCaptureInputs",
+  ContextDetector: "ContextDetector",
+  ContextScene: "ContextScene",
+  DAE: "DAE",
+  DGN: "DGN",
+  DSM: "DSM",
+  FBX: "FBX",
+  GLB: "GLB",
+  GLTF: "GLTF",
+  KML: "KML",
+  LAS: "LAS",
+  LAZ: "LAZ",
+  LOD: "LOD",
+  LodTree: "LodTree",
+  OBJ: "OBJ",
+  OMI: "OMI",
+  OMR: "OMR",
+  Orthophoto: "Orthophoto",
+  OrthophotoDSM: "OrthophotoDSM",
+  OSGB: "OSGB",
+  OVF: "OVF",
+  OBT: "OBT",
+  PLY: "PLY",
+  PointCloud: "PointCloud",
+  S3C: "S3C",
+  ScanCollection: "ScanCollection",
+  SHP: "SHP",
+  SLPK: "SLPK",
+  SpaceEyes3D: "SpaceEyes3D",
+  STL: "STL",
+  TSM: "TSM",
+  Unstructured: "Unstructured",
+  Other: "Other",
+});
+
+/**
+ * Gets or sets the default iTwin access token. This token should have the <code>itwin-platform</code> scope.
+ *
+ * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
+ *
+ * @type {string|undefined}
+ */
+ITwinPlatform.defaultAccessToken = undefined;
+
+/**
+ * Gets or sets the default iTwin API endpoint.
+ *
+ * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
+ *
+ * @type {string|Resource}
+ * @default "https://api.bentley.com"
+ */
+ITwinPlatform.apiEndpoint = new Resource({
+  url: "https://api.bentley.com",
+});
+
+/**
+ * @typedef {Object} ExportRequest
+ * @private
+ * @property {string} iModelId
+ * @property {string} changesetId
+ * @property {ITwinPlatform.ExportType} exportType Type of the export. CesiumJS only supports the 3DTILES type
+ */
+
+/**
+ * @typedef {Object} Link
+ * @private
+ * @property {string} href
+ */
+
+/**
+ * @typedef {Object} ExportRepresentation
+ * The export objects from get-exports when using return=representation
+ * @private
+ * @property {string} id Export id
+ * @property {string} displayName Name of the iModel
+ * @property {ITwinPlatform.ExportStatus} status Status of this export
+ * @property {string} lastModified
+ * @property {ExportRequest} request Object containing info about the export itself
+ * @property {{mesh: Link}} _links Object containing relevant links. For Exports this includes the access url for the mesh itself
+ */
+
+/**
+ * @typedef {Object} GetExportsResponse
+ * @private
+ * @property {ExportRepresentation[]} exports The list of exports for the current page
+ * @property {{self: Link, next: Link | undefined, prev: Link | undefined}} _links Pagination links
+ */
+
+/**
+ * Get the list of exports for the specified iModel at it's most current version.
+ * This will only return the top 5 exports with {@link ITwinPlatform.ExportType} of <code>3DTILES</code>.
+ *
+ * @private
+ *
+ * @param {string} iModelId iModel id
+ * @returns {Promise<GetExportsResponse>}
+ *
+ * @throws {RuntimeError} If the iTwin API request is not successful
+ */
+ITwinPlatform.getExports = async function (iModelId) {
+  //>>includeStart('debug', pragmas.debug);
+  Check.typeOf.string("iModelId", iModelId);
+  if (!defined(ITwinPlatform.defaultAccessToken)) {
+    throw new DeveloperError("Must set ITwinPlatform.defaultAccessToken first");
+  }
+  //>>includeEnd('debug')
+
+  const resource = new Resource({
+    url: `${ITwinPlatform.apiEndpoint}mesh-export`,
+    headers: {
+      Authorization: `Bearer ${ITwinPlatform.defaultAccessToken}`,
+      Accept: "application/vnd.bentley.itwin-platform.v1+json",
+      Prefer: "return=representation",
+    },
+    queryParameters: {
+      iModelId: iModelId,
+      exportType: ITwinPlatform.ExportType["3DTILES"],
+      // With the export auto-generation it will auto-delete the 6th export so
+      // there should never be more than 5 results. Just request them all and parse
+      // for ones that are COMPLETE
+      $top: "5",
+      client: "CesiumJS",
+    },
+  });
+  /* global CESIUM_VERSION */
+  if (typeof CESIUM_VERSION !== "undefined") {
+    resource.appendQueryParameters({ clientVersion: CESIUM_VERSION });
+  }
+
+  try {
+    const response = await resource.fetchJson();
+    return response;
+  } catch (error) {
+    const result = JSON.parse(error.response);
+    if (error.statusCode === 401) {
+      throw new RuntimeError(
+        `Unauthorized, bad token, wrong scopes or headers bad. ${result.error.details[0].code}`,
+      );
+    } else if (error.statusCode === 403) {
+      console.error(result.error.code, result.error.message);
+      throw new RuntimeError("Not allowed, forbidden");
+    } else if (error.statusCode === 422) {
+      throw new RuntimeError(
+        `Unprocessable Entity:${result.error.code} ${result.error.message}`,
+      );
+    } else if (error.statusCode === 429) {
+      throw new RuntimeError("Too many requests");
+    }
+    throw new RuntimeError(`Unknown request failure ${error.statusCode}`);
+  }
+};
+
+/**
+ * @typedef {Object} RealityDataExtent
+ * @private
+ * @property {{latitude: number, longitude: number}} southWest
+ * @property {{latitude: number, longitude: number}} northEast
+ */
+
+/**
+ * @typedef {Object} RealityDataRepresentation
+ * @private
+ * @property {string} id "95d8dccd-d89e-4287-bb5f-3219acbc71ae",
+ * @property {string} displayName "Name of reality data",
+ * @property {string} dataset "Dataset",
+ * @property {string} group "73d09423-28c3-4fdb-ab4a-03a47a5b04f8",
+ * @property {string} description "Description of reality data",
+ * @property {string} rootDocument "Directory/SubDirectory/realityData.3mx",
+ * @property {number} size 6521212,
+ * @property {string} classification "Model",
+ * @property {ITwinPlatform.RealityDataType} type "3MX",
+ * @property {{startDateTime: string, endDateTime: string, acquirer: string}} acquisition
+ * @property {RealityDataExtent} extent
+ * @property {boolean} authoring false,
+ * @property {string} dataCenterLocation "North Europe",
+ * @property {string} modifiedDateTime "2021-04-09T19:03:12Z",
+ * @property {string} lastAccessedDateTime "2021-04-09T00:00:00Z",
+ * @property {string} createdDateTime "2021-02-22T20:03:40Z",
+ * @property {string} ownerId "f1d49cc7-f9b3-494f-9c67-563ea5597063",
+ */
+
+/**
+ * Load the full metadata for the given iTwin id and reality data id.
+ *
+ * @private
+ *
+ * @param {string} iTwinId The id of the iTwin to load data from
+ * @param {string} realityDataId The id of the reality data to load
+ * @returns {Promise<RealityDataRepresentation>}
+ */
+ITwinPlatform.getRealityDataMetadata = async function (iTwinId, realityDataId) {
+  //>>includeStart('debug', pragmas.debug);
+  Check.typeOf.string("iTwinId", iTwinId);
+  Check.typeOf.string("realityDataId", realityDataId);
+  if (!defined(ITwinPlatform.defaultAccessToken)) {
+    throw new DeveloperError("Must set ITwinPlatform.defaultAccessToken first");
+  }
+  //>>includeEnd('debug')
+
+  const resource = new Resource({
+    url: `${ITwinPlatform.apiEndpoint}reality-management/reality-data/${realityDataId}`,
+    headers: {
+      Authorization: `Bearer ${ITwinPlatform.defaultAccessToken}`,
+      Accept: "application/vnd.bentley.itwin-platform.v1+json",
+    },
+    queryParameters: { iTwinId: iTwinId },
+  });
+
+  try {
+    const response = await resource.fetchJson();
+    return response.realityData;
+  } catch (error) {
+    const result = JSON.parse(error.response);
+    if (error.statusCode === 401) {
+      throw new RuntimeError(
+        `Unauthorized, bad token, wrong scopes or headers bad. ${result.error.details[0].code}`,
+      );
+    } else if (error.statusCode === 403) {
+      console.error(result.error.code, result.error.message);
+      throw new RuntimeError("Not allowed, forbidden");
+    } else if (error.statusCode === 404) {
+      throw new RuntimeError(
+        `Reality data not found: ${iTwinId}, ${realityDataId}`,
+      );
+    } else if (error.statusCode === 422) {
+      throw new RuntimeError(
+        `Unprocessable Entity:${result.error.code} ${result.error.message}`,
+      );
+    } else if (error.statusCode === 429) {
+      throw new RuntimeError("Too many requests");
+    }
+    throw new RuntimeError(`Unknown request failure ${error.statusCode}`);
+  }
+};
+
+/**
+ * Request the access url for the given iTwin id, reality data id and root document.
+ * The root document can be requested from the list using <code>return=representation</code>
+ * or the metadata route from {@link ITwinPlatform.getRealityDataMetadata}
+ *
+ * @private
+ *
+ * @param {string} iTwinId The id of the iTwin to load data from
+ * @param {string} realityDataId The id of the reality data to load
+ * @param {string} rootDocument The path of the root document for this reality data
+ * @returns {Promise<string>}
+ */
+ITwinPlatform.getRealityDataURL = async function (
+  iTwinId,
+  realityDataId,
+  rootDocument,
+) {
+  //>>includeStart('debug', pragmas.debug);
+  Check.typeOf.string("iTwinId", iTwinId);
+  Check.typeOf.string("realityDataId", realityDataId);
+  Check.typeOf.string("rootDocument", rootDocument);
+  if (!defined(ITwinPlatform.defaultAccessToken)) {
+    throw new DeveloperError("Must set ITwinPlatform.defaultAccessToken first");
+  }
+  //>>includeEnd('debug')
+
+  const resource = new Resource({
+    url: `${ITwinPlatform.apiEndpoint}reality-management/reality-data/${realityDataId}/readaccess`,
+    headers: {
+      Authorization: `Bearer ${ITwinPlatform.defaultAccessToken}`,
+      Accept: "application/vnd.bentley.itwin-platform.v1+json",
+    },
+    queryParameters: { iTwinId: iTwinId },
+  });
+
+  try {
+    const result = await resource.fetchJson();
+
+    const containerUrl = result._links.containerUrl.href;
+    const tilesetUrl = new URL(containerUrl);
+    tilesetUrl.pathname = `${tilesetUrl.pathname}/${rootDocument}`;
+
+    return tilesetUrl.toString();
+  } catch (error) {
+    const result = JSON.parse(error.response);
+    if (error.statusCode === 401) {
+      throw new RuntimeError(
+        `Unauthorized, bad token, wrong scopes or headers bad. ${result.error.details[0].code}`,
+      );
+    } else if (error.statusCode === 403) {
+      console.error(result.error.code, result.error.message);
+      throw new RuntimeError("Not allowed, forbidden");
+    } else if (error.statusCode === 404) {
+      throw new RuntimeError(
+        `Reality data not found: ${iTwinId}, ${realityDataId}`,
+      );
+    } else if (error.statusCode === 422) {
+      throw new RuntimeError(
+        `Unprocessable Entity:${result.error.code} ${result.error.message}`,
+      );
+    } else if (error.statusCode === 429) {
+      throw new RuntimeError("Too many requests");
+    }
+    throw new RuntimeError(`Unknown request failure ${error.statusCode}`);
+  }
+};
+
+export default ITwinPlatform;

package/Source/Core/Ion.js

@@ -4,7 +4,7 @@ import Resource from "./Resource.js";
 
 let defaultTokenCredit;
 const defaultAccessToken =
-  "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiZjBmMDE4Ny05M2JlLTRlMzgtYjIxYi05YmJjM2QwMzJkYWMiLCJpZCI6MjU5LCJpYXQiOjE3MzA0NjY3MDl9.t-7gCGPUe-oGCyCoeXPtYmlMVdgqUQD9mn-Da23yUoI";
+  "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI0ZDdmNWJiNy0wMmNlLTQ1MWUtODM2YS02NGM1MTBlOGMwMWQiLCJpZCI6MjU5LCJpYXQiOjE3MzMxNTc4OTV9.B3URHf0VdHDtGckb-hv7uqATdn8KfvkiuoAFZUq8tAo";
 /**
  * Default settings for accessing the Cesium ion API.
  *

package/Source/Core/IonGeocodeProviderType.js

@@ -0,0 +1,33 @@
+/**
+ * Underlying geocoding services that can be used via Cesium ion.
+ *
+ * @enum {string}
+ */
+const IonGeocodeProviderType = {
+  /**
+   * Google geocoder, for use with Google data.
+   *
+   * @type {string}
+   * @constant
+   */
+  GOOGLE: "GOOGLE",
+
+  /**
+   * Bing geocoder, for use with Bing data.
+   *
+   * @type {string}
+   * @constant
+   */
+  BING: "BING",
+
+  /**
+   * Use the default geocoder as set on the server.  Used when neither Bing or
+   * Google data is used.
+   *
+   * @type {string}
+   * @constant
+   */
+  DEFAULT: "DEFAULT",
+};
+
+export default Object.freeze(IonGeocodeProviderType);

package/Source/Core/IonGeocoderService.js

@@ -2,10 +2,45 @@ import Check from "./Check.js";
 import Credit from "./Credit.js";
 import defaultValue from "./defaultValue.js";
 import defined from "./defined.js";
+import DeveloperError from "./DeveloperError.js";
 import Ion from "./Ion.js";
+import IonGeocodeProviderType from "./IonGeocodeProviderType.js";
 import PeliasGeocoderService from "./PeliasGeocoderService.js";
 import Resource from "./Resource.js";
 
+/**
+ * @param {*} geocodeProviderType
+ * @throws {DeveloperError}
+ * @private
+ */
+function validateIonGeocodeProviderType(geocodeProviderType) {
+  if (
+    !Object.values(IonGeocodeProviderType).some(
+      (value) => value === geocodeProviderType,
+    )
+  ) {
+    throw new DeveloperError(
+      `Invalid geocodeProviderType: "${geocodeProviderType}"`,
+    );
+  }
+}
+
+const providerToParameterMap = Object.freeze({
+  [IonGeocodeProviderType.GOOGLE]: "google",
+  [IonGeocodeProviderType.BING]: "bing",
+  [IonGeocodeProviderType.DEFAULT]: undefined,
+});
+
+function providerToQueryParameter(provider) {
+  return providerToParameterMap[provider];
+}
+
+function queryParameterToProvider(parameter) {
+  return Object.entries(providerToParameterMap).find(
+    (entry) => entry[1] === parameter,
+  )[0];
+}
+
 /**
  * Provides geocoding through Cesium ion.
  * @alias IonGeocoderService
@@ -15,6 +50,7 @@ import Resource from "./Resource.js";
  * @param {Scene} options.scene The scene
  * @param {string} [options.accessToken=Ion.defaultAccessToken] The access token to use.
  * @param {string|Resource} [options.server=Ion.defaultServer] The resource to the Cesium ion API server.
+ * @param {IonGeocodeProviderType} [options.geocodeProviderType=IonGeocodeProviderType.DEFAULT] The geocoder the Cesium ion API server should use to fulfill this request.
  *
  * @see Ion
  */
@@ -25,6 +61,14 @@ function IonGeocoderService(options) {
   Check.typeOf.object("options.scene", options.scene);
   //>>includeEnd('debug');
 
+  const geocodeProviderType = defaultValue(
+    options.geocodeProviderType,
+    IonGeocodeProviderType.DEFAULT,
+  );
+  //>>includeStart('debug', pragmas.debug);
+  validateIonGeocodeProviderType(geocodeProviderType);
+  //>>includeEnd('debug');
+
   const accessToken = defaultValue(options.accessToken, Ion.defaultAccessToken);
   const server = Resource.createIfNeeded(
     defaultValue(options.server, Ion.defaultServer),
@@ -49,6 +93,9 @@ function IonGeocoderService(options) {
   this._accessToken = accessToken;
   this._server = server;
   this._pelias = new PeliasGeocoderService(searchEndpoint);
+  // geocoderProviderType isn't stored here directly but instead relies on the
+  // query parameters of this._pelias.url.  Use the setter logic to update value.
+  this.geocodeProviderType = geocodeProviderType;
 }
 
 Object.defineProperties(IonGeocoderService.prototype, {
@@ -64,6 +111,31 @@ Object.defineProperties(IonGeocoderService.prototype, {
       return undefined;
     },
   },
+  /**
+   * The geocoding service that Cesium ion API server should use to fulfill geocding requests.
+   * @memberof IonGeocoderService.prototype
+   * @type {IonGeocodeProviderType}
+   * @default IonGeocodeProviderType.DEFAULT
+   */
+  geocodeProviderType: {
+    get: function () {
+      return queryParameterToProvider(
+        this._pelias.url.queryParameters["geocoder"],
+      );
+    },
+    set: function (geocodeProviderType) {
+      validateIonGeocodeProviderType(geocodeProviderType);
+      const query = {
+        ...this._pelias.url.queryParameters,
+        geocoder: providerToQueryParameter(geocodeProviderType),
+      };
+      // Delete the geocoder parameter to prevent sending &geocoder=undefined in the query
+      if (!defined(query.geocoder)) {
+        delete query.geocoder;
+      }
+      this._pelias.url.setQueryParameters(query);
+    },
+  },
 });
 
 /**

package/Source/Core/Rectangle.js

@@ -7,7 +7,6 @@ import Ellipsoid from "./Ellipsoid.js";
 import CesiumMath from "./Math.js";
 import Transforms from "./Transforms.js";
 import Matrix4 from "./Matrix4.js";
-import deprecationWarning from "./deprecationWarning.js";
 
 /**
  * A two dimensional region specified as longitude and latitude coordinates.
@@ -533,25 +532,6 @@ Rectangle.prototype.equalsEpsilon = function (other, epsilon) {
   return Rectangle.equalsEpsilon(this, other, epsilon);
 };
 
-/**
- * Checks a Rectangle's properties and throws if they are not in valid ranges.
- *
- * @param {Rectangle} rectangle The rectangle to validate
- *
- * @exception {DeveloperError} <code>north</code> must be in the interval [<code>-Pi/2</code>, <code>Pi/2</code>].
- * @exception {DeveloperError} <code>south</code> must be in the interval [<code>-Pi/2</code>, <code>Pi/2</code>].
- * @exception {DeveloperError} <code>east</code> must be in the interval [<code>-Pi</code>, <code>Pi</code>].
- * @exception {DeveloperError} <code>west</code> must be in the interval [<code>-Pi</code>, <code>Pi</code>].
- * @deprecated This function is deprecated and will be removed in Cesium 1.124. See <a href="https://github.com/CesiumGS/cesium/issues/4921">Issue 4921</a>
- */
-Rectangle.validate = function (rectangle) {
-  deprecationWarning(
-    "Rectangle.validate",
-    "Rectangle.validate is a no-op and has been deprecated. It will be removed in Cesium 1.124.",
-  );
-  return Rectangle._validate(rectangle);
-};
-
 /**
  * Checks a Rectangle's properties and throws if they are not in valid ranges.
  *

package/Source/Core/TrackingReferenceFrame.js

@@ -0,0 +1,45 @@
+/**
+ * Constants for identifying well-known tracking reference frames.
+ *
+ * @enum {number}
+ */
+const TrackingReferenceFrame = {
+  /**
+   * Auto-detect algorithm. The reference frame used to track the Entity will
+   * be automatically selected based on its trajectory: near-surface slow moving
+   * objects will be tracked in the entity's local east-north-up reference
+   * frame, while faster objects like satellites will use VVLH (Vehicle Velocity,
+   * Local Horizontal).
+   *
+   * @type {number}
+   * @constant
+   */
+  AUTODETECT: 0,
+
+  /**
+   * The entity's local East-North-Up reference frame.
+   *
+   * @type {number}
+   * @constant
+   */
+  ENU: 1,
+
+  /**
+   * The entity's inertial reference frame. If entity has no defined orientation
+   * property, it falls back to auto-detect algorithm.
+   *
+   * @type {number}
+   * @constant
+   */
+  INERTIAL: 2,
+
+  /**
+   * The entity's inertial reference frame with orientation fixed to its
+   * {@link VelocityOrientationProperty}, ignoring its own orientation.
+   *
+   * @type {number}
+   * @constant
+   */
+  VELOCITY: 3,
+};
+export default Object.freeze(TrackingReferenceFrame);

package/Source/DataSources/Entity.js

@@ -10,6 +10,7 @@ import CesiumMath from "../Core/Math.js";
 import Matrix3 from "../Core/Matrix3.js";
 import Matrix4 from "../Core/Matrix4.js";
 import Quaternion from "../Core/Quaternion.js";
+import TrackingReferenceFrame from "../Core/TrackingReferenceFrame.js";
 import Transforms from "../Core/Transforms.js";
 import GroundPolylinePrimitive from "../Scene/GroundPolylinePrimitive.js";
 import GroundPrimitive from "../Scene/GroundPrimitive.js";
@@ -73,8 +74,9 @@ function createPropertyTypeDescriptor(name, Type) {
  * @property {string} [name] A human readable name to display to users. It does not have to be unique.
  * @property {TimeIntervalCollection} [availability] The availability, if any, associated with this object.
  * @property {boolean} [show] A boolean value indicating if the entity and its children are displayed.
+ * @property {TrackingReferenceFrame} [trackingReferenceFrame=TrackingReferenceFrame.AUTODETECT] The reference frame used when this entity is being tracked. <br/> If <code>undefined</code>, reference frame is determined based on entity velocity: near-surface slow moving entities are tracked using the local east-north-up reference frame, whereas fast moving entities such as satellites are tracked using VVLH (Vehicle Velocity, Local Horizontal).
  * @property {Property | string} [description] A string Property specifying an HTML description for this entity.
- * @property {PositionProperty | Cartesian3 | CallbackProperty} [position] A Property specifying the entity position.
+ * @property {PositionProperty | Cartesian3 | CallbackPositionProperty} [position] A Property specifying the entity position.
  * @property {Property | Quaternion} [orientation=Transforms.eastNorthUpToFixedFrame(position)] A Property specifying the entity orientation in respect to Earth-fixed-Earth-centered (ECEF). If undefined, east-north-up at entity position is used.
  * @property {Property | Cartesian3} [viewFrom] A suggested initial offset for viewing this object.
  * @property {Entity} [parent] A parent entity to associate with this entity.
@@ -122,6 +124,10 @@ function Entity(options) {
   this._definitionChanged = new Event();
   this._name = options.name;
   this._show = defaultValue(options.show, true);
+  this._trackingReferenceFrame = defaultValue(
+    options.trackingReferenceFrame,
+    TrackingReferenceFrame.AUTODETECT,
+  );
   this._parent = undefined;
   this._propertyNames = [
     "billboard",
@@ -296,6 +302,14 @@ Object.defineProperties(Entity.prototype, {
       this._definitionChanged.raiseEvent(this, "show", value, !value);
     },
   },
+  /**
+   * Gets or sets the entity's tracking reference frame.
+   * @demo {@link https://sandcastle.cesium.com/index.html?src=Entity tracking.html|Cesium Sandcastle Entity tracking Demo}
+   *
+   * @memberof Entity.prototype
+   * @type {TrackingReferenceFrame}
+   */
+  trackingReferenceFrame: createRawPropertyDescriptor("trackingReferenceFrame"),
   /**
    * Gets whether this entity is being displayed, taking into account
    * the visibility of any ancestor entities.