@cesium/engine 0.1.0 → 1.1.0

package/Source/Core/EarthOrientationParameters.js

@@ -1,4 +1,5 @@
 import binarySearch from "./binarySearch.js";
+import Check from "./Check.js";
 import defaultValue from "./defaultValue.js";
 import defined from "./defined.js";
 import EarthOrientationParametersSample from "./EarthOrientationParametersSample.js";
@@ -14,15 +15,12 @@ import TimeStandard from "./TimeStandard.js";
  * These Earth Orientation Parameters (EOP) are primarily used in the transformation from
  * the International Celestial Reference Frame (ICRF) to the International Terrestrial
  * Reference Frame (ITRF).
+ * This object is normally not instantiated directly, use {@link EarthOrientationParameters.fromUrl}.
  *
  * @alias EarthOrientationParameters
  * @constructor
  *
  * @param {Object} [options] Object with the following properties:
- * @param {Resource|String} [options.url] The URL from which to obtain EOP data.  If neither this
- *                 parameter nor options.data is specified, all EOP values are assumed
- *                 to be 0.0.  If options.data is specified, this parameter is
- *                 ignored.
  * @param {Object} [options.data] The actual EOP data.  If neither this
  *                 parameter nor options.data is specified, all EOP values are assumed
  *                 to be 0.0.
@@ -32,22 +30,6 @@ import TimeStandard from "./TimeStandard.js";
  *                  new leap seconds should be handled correctly in the context
  *                  of the EOP data but otherwise ignored.
  *
- * @example
- * // An example EOP data file, EOP.json:
- * {
- *   "columnNames" : ["dateIso8601","modifiedJulianDateUtc","xPoleWanderRadians","yPoleWanderRadians","ut1MinusUtcSeconds","lengthOfDayCorrectionSeconds","xCelestialPoleOffsetRadians","yCelestialPoleOffsetRadians","taiMinusUtcSeconds"],
- *   "samples" : [
- *      "2011-07-01T00:00:00Z",55743.0,2.117957047295119e-7,2.111518721609984e-6,-0.2908948,-2.956e-4,3.393695767766752e-11,3.3452143996557983e-10,34.0,
- *      "2011-07-02T00:00:00Z",55744.0,2.193297093339541e-7,2.115460256837405e-6,-0.29065,-1.824e-4,-8.241832578862112e-11,5.623838700870617e-10,34.0,
- *      "2011-07-03T00:00:00Z",55745.0,2.262286080161428e-7,2.1191157519929706e-6,-0.2905572,1.9e-6,-3.490658503988659e-10,6.981317007977318e-10,34.0
- *   ]
- * }
- *
- * @example
- * // Loading the EOP data
- * const eop = new Cesium.EarthOrientationParameters({ url : 'Data/EOP.json' });
- * Cesium.Transforms.earthOrientationParameters = eop;
- *
  * @private
  */
 function EarthOrientationParameters(options) {
@@ -67,27 +49,11 @@ function EarthOrientationParameters(options) {
   this._columnCount = 0;
   this._lastIndex = -1;
 
-  this._downloadPromise = undefined;
-  this._dataError = undefined;
-
   this._addNewLeapSeconds = defaultValue(options.addNewLeapSeconds, true);
 
   if (defined(options.data)) {
     // Use supplied EOP data.
     onDataReady(this, options.data);
-  } else if (defined(options.url)) {
-    const resource = Resource.createIfNeeded(options.url);
-
-    // Download EOP data.
-    const that = this;
-    this._downloadPromise = resource
-      .fetchJson()
-      .then(function (eopData) {
-        onDataReady(that, eopData);
-      })
-      .catch(function () {
-        that._dataError = `An error occurred while retrieving the EOP data from the URL ${resource.url}.`;
-      });
   } else {
     // Use all zeros for EOP data.
     onDataReady(this, {
@@ -107,13 +73,64 @@ function EarthOrientationParameters(options) {
   }
 }
 
+/**
+ *
+ * @param {Resource|String} [url] The URL from which to obtain EOP data.  If neither this
+ *                 parameter nor options.data is specified, all EOP values are assumed
+ *                 to be 0.0.  If options.data is specified, this parameter is
+ *                 ignored.
+ * @param {Object} [options] Object with the following properties:
+ * @param {Boolean} [options.addNewLeapSeconds=true] True if leap seconds that
+ *                  are specified in the EOP data but not in {@link JulianDate.leapSeconds}
+ *                  should be added to {@link JulianDate.leapSeconds}.  False if
+ *                  new leap seconds should be handled correctly in the context
+ *                  of the EOP data but otherwise ignored.
+ *
+ * @example
+ * // An example EOP data file, EOP.json:
+ * {
+ *   "columnNames" : ["dateIso8601","modifiedJulianDateUtc","xPoleWanderRadians","yPoleWanderRadians","ut1MinusUtcSeconds","lengthOfDayCorrectionSeconds","xCelestialPoleOffsetRadians","yCelestialPoleOffsetRadians","taiMinusUtcSeconds"],
+ *   "samples" : [
+ *      "2011-07-01T00:00:00Z",55743.0,2.117957047295119e-7,2.111518721609984e-6,-0.2908948,-2.956e-4,3.393695767766752e-11,3.3452143996557983e-10,34.0,
+ *      "2011-07-02T00:00:00Z",55744.0,2.193297093339541e-7,2.115460256837405e-6,-0.29065,-1.824e-4,-8.241832578862112e-11,5.623838700870617e-10,34.0,
+ *      "2011-07-03T00:00:00Z",55745.0,2.262286080161428e-7,2.1191157519929706e-6,-0.2905572,1.9e-6,-3.490658503988659e-10,6.981317007977318e-10,34.0
+ *   ]
+ * }
+ *
+ * @example
+ * // Loading the EOP data
+ * const eop = await Cesium.EarthOrientationParameters.fromUrl('Data/EOP.json');
+ * Cesium.Transforms.earthOrientationParameters = eop;
+ */
+EarthOrientationParameters.fromUrl = async function (url, options) {
+  //>>includeStart('debug', pragmas.debug);
+  Check.defined("url", url);
+  //>>includeEnd('debug');
+
+  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+
+  const resource = Resource.createIfNeeded(url);
+
+  // Download EOP data.
+  let eopData;
+  try {
+    eopData = await resource.fetchJson();
+  } catch (e) {
+    throw new RuntimeError(
+      `An error occurred while retrieving the EOP data from the URL ${resource.url}.`
+    );
+  }
+
+  return new EarthOrientationParameters({
+    addNewLeapSeconds: options.addNewLeapSeconds,
+    data: eopData,
+  });
+};
+
 /**
  * A default {@link EarthOrientationParameters} instance that returns zero for all EOP values.
  */
 EarthOrientationParameters.NONE = Object.freeze({
-  getPromiseToLoad: function () {
-    return Promise.resolve();
-  },
   compute: function (date, result) {
     if (!defined(result)) {
       result = new EarthOrientationParametersSample(0.0, 0.0, 0.0, 0.0, 0.0);
@@ -128,16 +145,6 @@ EarthOrientationParameters.NONE = Object.freeze({
   },
 });
 
-/**
- * Gets a promise that, when resolved, indicates that the EOP data has been loaded and is
- * ready to use.
- *
- * @returns {Promise<void>} The promise.
- */
-EarthOrientationParameters.prototype.getPromiseToLoad = function () {
-  return Promise.resolve(this._downloadPromise);
-};
-
 /**
  * Computes the Earth Orientation Parameters (EOP) for a given date by interpolating.
  * If the EOP data has not yet been download, this method returns undefined.
@@ -151,15 +158,11 @@ EarthOrientationParameters.prototype.getPromiseToLoad = function () {
  *
  * @exception {RuntimeError} The loaded EOP data has an error and cannot be used.
  *
- * @see EarthOrientationParameters#getPromiseToLoad
+ * @see EarthOrientationParameters#fromUrl
  */
 EarthOrientationParameters.prototype.compute = function (date, result) {
   // We cannot compute until the samples are available.
   if (!defined(this._samples)) {
-    if (defined(this._dataError)) {
-      throw new RuntimeError(this._dataError);
-    }
-
     return undefined;
   }
 
@@ -237,15 +240,15 @@ function compareLeapSecondDates(leapSecond, dateToFind) {
 
 function onDataReady(eop, eopData) {
   if (!defined(eopData.columnNames)) {
-    eop._dataError =
-      "Error in loaded EOP data: The columnNames property is required.";
-    return;
+    throw new RuntimeError(
+      "Error in loaded EOP data: The columnNames property is required."
+    );
   }
 
   if (!defined(eopData.samples)) {
-    eop._dataError =
-      "Error in loaded EOP data: The samples property is required.";
-    return;
+    throw new RuntimeError(
+      "Error in loaded EOP data: The samples property is required."
+    );
   }
 
   const dateColumn = eopData.columnNames.indexOf("modifiedJulianDateUtc");
@@ -277,9 +280,9 @@ function onDataReady(eop, eopData) {
     yCelestialPoleOffsetRadiansColumn < 0 ||
     taiMinusUtcSecondsColumn < 0
   ) {
-    eop._dataError =
-      "Error in loaded EOP data: The columnNames property must include modifiedJulianDateUtc, xPoleWanderRadians, yPoleWanderRadians, ut1MinusUtcSeconds, xCelestialPoleOffsetRadians, yCelestialPoleOffsetRadians, and taiMinusUtcSeconds columns";
-    return;
+    throw new RuntimeError(
+      "Error in loaded EOP data: The columnNames property must include modifiedJulianDateUtc, xPoleWanderRadians, yPoleWanderRadians, ut1MinusUtcSeconds, xCelestialPoleOffsetRadians, yCelestialPoleOffsetRadians, and taiMinusUtcSeconds columns"
+    );
   }
 
   const samples = (eop._samples = eopData.samples);
@@ -428,4 +431,5 @@ function interpolate(eop, dates, samples, date, before, after, result) {
   );
   return result;
 }
+
 export default EarthOrientationParameters;

package/Source/Core/Ion.js

@@ -4,7 +4,7 @@ import Resource from "./Resource.js";
 
 let defaultTokenCredit;
 const defaultAccessToken =
-  "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI0NTkyNGVkMi04YTg1LTQ4YzktYTI3MS05NTNiZWM3MTg2ZGEiLCJpZCI6MjU5LCJpYXQiOjE2NjQ4MTQyODl9.mGZTN2DeKa-mQnQr6BInj8GzOK6wq3dZMwcyU0iwInA";
+  "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyZTlhMmUzMS1iZjI3LTRhMmQtYjFkZi02MDhlMDZjZDlmNDIiLCJpZCI6MjU5LCJpYXQiOjE2NzI2ODQyMDR9.GfS2oIjtP-hkhYm4g_Y6Vvpdp954z30qPWJnlNBF-co";
 
 /**
  * Default settings for accessing the Cesium ion API.

package/Source/Core/Matrix2.js

@@ -613,6 +613,7 @@ const scaleScratch4 = new Cartesian2();
  *
  * @param {Matrix2} matrix The matrix.
  * @param {Matrix2} rotation The rotation matrix.
+ * @param {Matrix2} result The object onto which to store the result.
  * @returns {Matrix2} The modified result parameter.
  *
  * @see Matrix2.fromRotation
@@ -782,7 +783,7 @@ Matrix2.multiplyByScalar = function (matrix, scalar, result) {
  * Computes the product of a matrix times a (non-uniform) scale, as if the scale were a scale matrix.
  *
  * @param {Matrix2} matrix The matrix on the left-hand side.
- * @param {Number} scale The non-uniform scale on the right-hand side.
+ * @param {Cartesian2} scale The non-uniform scale on the right-hand side.
  * @param {Matrix2} result The object onto which to store the result.
  * @returns {Matrix2} The modified result parameter.
  *

package/Source/Core/Matrix3.js

@@ -974,6 +974,7 @@ const scaleScratch4 = new Cartesian3();
  *
  * @param {Matrix3} matrix The matrix.
  * @param {Matrix3} rotation The rotation matrix.
+ * @param {Matrix3} result The object onto which to store the result.
  * @returns {Matrix3} The modified result parameter.
  *
  * @see Matrix3.getRotation
@@ -1193,7 +1194,7 @@ Matrix3.multiplyByScalar = function (matrix, scalar, result) {
  * Computes the product of a matrix times a (non-uniform) scale, as if the scale were a scale matrix.
  *
  * @param {Matrix3} matrix The matrix on the left-hand side.
- * @param {Number} scale The non-uniform scale on the right-hand side.
+ * @param {Cartesian3} scale The non-uniform scale on the right-hand side.
  * @param {Matrix3} result The object onto which to store the result.
  * @returns {Matrix3} The modified result parameter.
  *

package/Source/Core/Matrix4.js

@@ -1633,6 +1633,7 @@ const scaleScratch4 = new Cartesian3();
  *
  * @param {Matrix4} matrix The matrix.
  * @param {Matrix3} rotation The rotation matrix.
+ * @param {Matrix4} result The object onto which to store the result.
  * @returns {Matrix4} The modified result parameter.
  *
  * @see Matrix4.fromRotation

package/Source/Core/OrientedBoundingBox.js

@@ -18,13 +18,13 @@ import Rectangle from "./Rectangle.js";
 
 /**
  * Creates an instance of an OrientedBoundingBox.
- * An OrientedBoundingBox of some object is a closed and convex cuboid. It can provide a tighter bounding volume than {@link BoundingSphere} or {@link AxisAlignedBoundingBox} in many cases.
+ * An OrientedBoundingBox of some object is a closed and convex rectangular cuboid. It can provide a tighter bounding volume than {@link BoundingSphere} or {@link AxisAlignedBoundingBox} in many cases.
  * @alias OrientedBoundingBox
  * @constructor
  *
  * @param {Cartesian3} [center=Cartesian3.ZERO] The center of the box.
  * @param {Matrix3} [halfAxes=Matrix3.ZERO] The three orthogonal half-axes of the bounding box.
- *                                          Equivalently, the transformation matrix, to rotate and scale a 0x0x0
+ *                                          Equivalently, the transformation matrix, to rotate and scale a 1x1x1
  *                                          cube centered at the origin.
  *
  *
@@ -334,7 +334,7 @@ const scratchPlane = new Plane(Cartesian3.UNIT_X, 0.0);
  * @param {OrientedBoundingBox} [result] The object onto which to store the result.
  * @returns {OrientedBoundingBox} The modified result parameter or a new OrientedBoundingBox instance if none was provided.
  *
- * @exception {DeveloperError} rectangle.width must be between 0 and pi.
+ * @exception {DeveloperError} rectangle.width must be between 0 and 2 * pi.
  * @exception {DeveloperError} rectangle.height must be between 0 and pi.
  * @exception {DeveloperError} ellipsoid must be an ellipsoid of revolution (<code>radii.x == radii.y</code>)
  */
@@ -350,7 +350,7 @@ OrientedBoundingBox.fromRectangle = function (
     throw new DeveloperError("rectangle is required");
   }
   if (rectangle.width < 0.0 || rectangle.width > CesiumMath.TWO_PI) {
-    throw new DeveloperError("Rectangle width must be between 0 and 2*pi");
+    throw new DeveloperError("Rectangle width must be between 0 and 2 * pi");
   }
   if (rectangle.height < 0.0 || rectangle.height > CesiumMath.PI) {
     throw new DeveloperError("Rectangle height must be between 0 and pi");

package/Source/Core/S2Cell.js

@@ -264,7 +264,7 @@ S2Cell.getIdFromToken = function (token) {
  * Converts a 64-bit S2 cell ID to an S2 cell token.
  *
  * @param {BigInt} [cellId] The S2 cell ID.
- * @returns {BigInt} Returns hexadecimal representation of an S2CellId.
+ * @returns {string} Returns hexadecimal representation of an S2CellId.
  * @private
  */
 S2Cell.getTokenFromId = function (cellId) {
@@ -378,7 +378,7 @@ S2Cell.prototype.getParentAtLevel = function (level) {
  * Get center of the S2 cell.
  *
  * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid.
- * @returns {Cartesian} The position of center of the S2 cell.
+ * @returns {Cartesian3} The position of center of the S2 cell.
  * @private
  */
 S2Cell.prototype.getCenter = function (ellipsoid) {
@@ -400,7 +400,7 @@ S2Cell.prototype.getCenter = function (ellipsoid) {
  *
  * @param {Number} index An integer index of the vertex. Must be in the range [0-3].
  * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid.
- * @returns {Cartesian} The position of the vertex of the S2 cell.
+ * @returns {Cartesian3} The position of the vertex of the S2 cell.
  * @private
  */
 S2Cell.prototype.getVertex = function (index, ellipsoid) {

package/Source/Core/Transforms.js

@@ -659,9 +659,8 @@ const j2000ttDays = 2451545.0;
  *
  * @example
  * const interval = new Cesium.TimeInterval(...);
- * Promise.resolve(Cesium.Transforms.preloadIcrfFixed(interval)).then(function() {
- *     // the data is now loaded
- * });
+ * await Cesium.Transforms.preloadIcrfFixed(interval));
+ * // the data is now loaded
  *
  * @see Transforms.computeIcrfToFixedMatrix
  * @see Transforms.computeFixedToIcrfMatrix
@@ -672,15 +671,12 @@ Transforms.preloadIcrfFixed = function (timeInterval) {
   const stopDayTT = timeInterval.stop.dayNumber;
   const stopSecondTT = timeInterval.stop.secondsOfDay + ttMinusTai;
 
-  const xysPromise = Transforms.iau2006XysData.preload(
+  return Transforms.iau2006XysData.preload(
     startDayTT,
     startSecondTT,
     stopDayTT,
     stopSecondTT
   );
-  const eopPromise = Transforms.earthOrientationParameters.getPromiseToLoad();
-
-  return Promise.all([xysPromise, eopPromise]);
 };
 
 /**

package/Source/DataSources/GpxDataSource.js

@@ -41,11 +41,9 @@ const autolinker = new Autolinker({
   stripPrefix: false,
   email: false,
   replaceFn: function (linker, match) {
-    if (!match.protocolUrlMatch) {
-      // Prevent matching of non-explicit urls.
-      // i.e. foo.id won't match but http://foo.id will
-      return false;
-    }
+    //Prevent matching of non-explicit urls.
+    //i.e. foo.id won't match but http://foo.id will
+    return match.urlMatchType === "scheme" || match.urlMatchType === "www";
   },
 });
 
@@ -754,7 +752,7 @@ function GpxDataSource() {
   this._error = new Event();
   this._loading = new Event();
   this._clock = undefined;
-  this._entityCollection = new EntityCollection();
+  this._entityCollection = new EntityCollection(this);
   this._entityCluster = new EntityCluster();
   this._name = undefined;
   this._version = undefined;

package/Source/DataSources/KmlDataSource.js

@@ -143,11 +143,9 @@ const autolinker = new Autolinker({
   stripPrefix: false,
   email: false,
   replaceFn: function (match) {
-    if (!match.protocolUrlMatch) {
-      //Prevent matching of non-explicit urls.
-      //i.e. foo.id won't match but http://foo.id will
-      return false;
-    }
+    //Prevent matching of non-explicit urls.
+    //i.e. foo.id won't match but http://foo.id will
+    return match.urlMatchType === "scheme" || match.urlMatchType === "www";
   },
 });