Merge branch 'master' into more-typescript

Author: thw0rted

CHANGES.md

@@ -5,13 +5,16 @@
 ##### Additions :tada:
 
 - Add a `toString` method to the `Resource` class in case an instance gets logged as a string. [#8722](https://github.com/CesiumGS/cesium/issues/8722)
+- Exposed `Transforms.rotationMatrixFromPositionVelocity` method from Cesium's private API. [#8927](https://github.com/CesiumGS/cesium/issues/8927)
 
 ##### Fixes :wrench:
 
-- Improved `MaterialProperty` JSDoc and TypeScript type definitions, which were missing the ability to take primitive types in addition to Property instances in their constructor.
-- Fixed `EllipsoidGeodesic` JSDoc and TypeScript type definitions which incorrectly listed `result` as required.
+- Improved `MaterialProperty` JSDoc and TypeScript type definitions, which were missing the ability to take primitive types in addition to Property instances in their constructor. [#8904](https://github.com/CesiumGS/cesium/pull/8904)
+- Fixed `EllipsoidGeodesic` JSDoc and TypeScript type definitions which incorrectly listed `result` as required. [#8904](https://github.com/CesiumGS/cesium/pull/8904)
 - Fixed a bug with handling of PixelFormat's flipY. [#8893](https://github.com/CesiumGS/cesium/pull/8893)
-- Fixed JSDoc and TypeScript type definitions for all `ImageryProvider` types, which were missing `defaultNightAlpha` and `defaultDayAlpha` properties.
+- Fixed JSDoc and TypeScript type definitions for all `ImageryProvider` types, which were missing `defaultNightAlpha` and `defaultDayAlpha` properties. [#8908](https://github.com/CesiumGS/cesium/pull/8908)
+- Fixed JSDoc and TypeScript type definitions for `EllipsoidTangentPlane.fromPoints`, which takes an array of `Cartesian3`, not a single instance. [#8928](https://github.com/CesiumGS/cesium/pull/8928)
+- Fixed JSDoc and TypeScript type definitions for `EntityCollection.getById` and `CompositeEntityCollection.getById`, which can both return undefined. [#8928](https://github.com/CesiumGS/cesium/pull/8928)
 - Fixed JSDoc and TypeScript type definitions for `Viewer` options parameter, which was incorrectly listed as required.
 - Fixed a memory leak where some 3D Tiles requests were being unintentionally retained after the requests were cancelled. [#8843](https://github.com/CesiumGS/cesium/pull/8843)
 

CONTRIBUTORS.md

@@ -148,6 +148,8 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to Cesiu
   - [Joseph Stein](https://github.com/nahgrin)
 - [EOX IT Services GmbH](https://eox.at)
   - [Daniel Santillan](https://github.com/santilland)
+- [Navagis, Inc.](https://navagis.com/)
+  - [Jonathan Nogueira](https://github.com/LuminousPath)
 
 ## [Individual CLA](Documentation/Contributors/CLAs/individual-contributor-license-agreement-v1.0.pdf)
 
@@ -260,3 +262,5 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to Cesiu
 - [Edvinas Pranka](https://github.com/epranka)
 - [James Bromwell](https://github.com/thw0rted)
 - [Brandon Nguyen](https://github.com/bn-dignitas)
+- [Wang Bao](https://github.com/xiaobaogeit)
+- [John Remsberg](https://github.com/easternmotors)

Source/Core/EllipsoidTangentPlane.js

@@ -135,7 +135,7 @@ var tmp = new AxisAlignedBoundingBox();
  * Creates a new instance from the provided ellipsoid and the center
  * point of the provided Cartesians.
  *
- * @param {Cartesian3} cartesians The list of positions surrounding the center point.
+ * @param {Cartesian3[]} cartesians The list of positions surrounding the center point.
  * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid to use.
  */
 EllipsoidTangentPlane.fromPoints = function (cartesians, ellipsoid) {

Source/Core/Rectangle.js

@@ -57,6 +57,7 @@ Object.defineProperties(Rectangle.prototype, {
    * Gets the width of the rectangle in radians.
    * @memberof Rectangle.prototype
    * @type {Number}
+   * @readonly
    */
   width: {
     get: function () {
@@ -68,6 +69,7 @@ Object.defineProperties(Rectangle.prototype, {
    * Gets the height of the rectangle in radians.
    * @memberof Rectangle.prototype
    * @type {Number}
+   * @readonly
    */
   height: {
     get: function () {

Source/Core/Transforms.js

@@ -949,7 +949,13 @@ var rightScratch = new Cartesian3();
 var upScratch = new Cartesian3();
 
 /**
- * @private
+ * Transform a position and velocity to a rotation matrix.
+ *
+ * @param {Cartesian3} position The position to transform.
+ * @param {Cartesian3} velocity The velocity vector to transform.
+ * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid whose fixed frame is used in the transformation.
+ * @param {Matrix3} [result] The object onto which to store the result.
+ * @returns {Matrix3} The modified result parameter or a new Matrix3 instance if none was provided.
  */
 Transforms.rotationMatrixFromPositionVelocity = function (
   position,

Source/Core/buildModuleUrl.js

@@ -5,7 +5,7 @@ import Resource from "./Resource.js";
 
 /*global CESIUM_BASE_URL*/
 
-var cesiumScriptRegex = /((?:.*\/)|^)Cesium\.js$/;
+var cesiumScriptRegex = /((?:.*\/)|^)Cesium\.js(?:\?|\#|$)/;
 function getBaseUrlFromCesiumScript() {
   var scripts = document.getElementsByTagName("script");
   for (var i = 0, len = scripts.length; i < len; ++i) {

Source/DataSources/CompositeEntityCollection.js

@@ -463,7 +463,7 @@ CompositeEntityCollection.prototype.computeAvailability = function () {
  * Gets an entity with the specified id.
  *
  * @param {String} id The id of the entity to retrieve.
- * @returns {Entity} The entity with the provided id or undefined if the id did not exist in the collection.
+ * @returns {Entity|undefined} The entity with the provided id or undefined if the id did not exist in the collection.
  */
 CompositeEntityCollection.prototype.getById = function (id) {
   return this._composite.getById(id);

Source/DataSources/EntityCollection.js

@@ -397,7 +397,7 @@ EntityCollection.prototype.removeAll = function () {
  * Gets an entity with the specified id.
  *
  * @param {String} id The id of the entity to retrieve.
- * @returns {Entity} The entity with the provided id or undefined if the id did not exist in the collection.
+ * @returns {Entity|undefined} The entity with the provided id or undefined if the id did not exist in the collection.
  */
 EntityCollection.prototype.getById = function (id) {
   //>>includeStart('debug', pragmas.debug);

Source/Widgets/CesiumWidget/CesiumWidget.js

@@ -393,6 +393,7 @@ Object.defineProperties(CesiumWidget.prototype, {
    * @memberof CesiumWidget.prototype
    *
    * @type {Element}
+   * @readonly
    */
   container: {
     get: function () {
@@ -405,6 +406,7 @@ Object.defineProperties(CesiumWidget.prototype, {
    * @memberof CesiumWidget.prototype
    *
    * @type {HTMLCanvasElement}
+   * @readonly
    */
   canvas: {
     get: function () {
@@ -417,6 +419,7 @@ Object.defineProperties(CesiumWidget.prototype, {
    * @memberof CesiumWidget.prototype
    *
    * @type {Element}
+   * @readonly
    */
   creditContainer: {
     get: function () {
@@ -429,6 +432,7 @@ Object.defineProperties(CesiumWidget.prototype, {
    * @memberof CesiumWidget.prototype
    *
    * @type {Element}
+   * @readonly
    */
   creditViewport: {
     get: function () {
@@ -441,6 +445,7 @@ Object.defineProperties(CesiumWidget.prototype, {
    * @memberof CesiumWidget.prototype
    *
    * @type {Scene}
+   * @readonly
    */
   scene: {
     get: function () {
@@ -494,6 +499,7 @@ Object.defineProperties(CesiumWidget.prototype, {
    * @memberof CesiumWidget.prototype
    *
    * @type {Clock}
+   * @readonly
    */
   clock: {
     get: function () {
@@ -506,6 +512,7 @@ Object.defineProperties(CesiumWidget.prototype, {
    * @memberof CesiumWidget.prototype
    *
    * @type {ScreenSpaceEventHandler}
+   * @readonly
    */
   screenSpaceEventHandler: {
     get: function () {

Source/Widgets/Viewer/Viewer.js

@@ -235,8 +235,8 @@ function enableVRUI(viewer, enabled) {
  * @property {ProviderViewModel[]} [terrainProviderViewModels=createDefaultTerrainProviderViewModels()] The array of ProviderViewModels to be selectable from the BaseLayerPicker.  This value is only valid if `baseLayerPicker` is set to true.
  * @property {ImageryProvider} [imageryProvider=createWorldImagery()] The imagery provider to use.  This value is only valid if `baseLayerPicker` is set to false.
  * @property {TerrainProvider} [terrainProvider=new EllipsoidTerrainProvider()] The terrain provider to use
- * @property {SkyBox} [skyBox] The skybox used to render the stars.  When <code>undefined</code>, the default stars are used.
- * @property {SkyAtmosphere} [skyAtmosphere] Blue sky, and the glow around the Earth's limb.  Set to <code>false</code> to turn it off.
+ * @property {SkyBox|false} [skyBox] The skybox used to render the stars.  When <code>undefined</code>, the default stars are used. If set to <code>false</code>, no skyBox, Sun, or Moon will be added.
+ * @property {SkyAtmosphere|false} [skyAtmosphere] Blue sky, and the glow around the Earth's limb.  Set to <code>false</code> to turn it off.
  * @property {Element|String} [fullscreenElement=document.body] The element or id to be placed into fullscreen mode when the full screen button is pressed.
  * @property {Boolean} [useDefaultRenderLoop=true] True if this widget should control the render loop, false otherwise.
  * @property {Number} [targetFrameRate] The target frame rate when using the default render loop.

Specs/Core/TransformsSpec.js

@@ -1716,6 +1716,59 @@ describe("Core/Transforms", function () {
     expect(returnedResult).toEqualEpsilon(expected, CesiumMath.EPSILON12);
   });
 
+  it("rotationMatrixFromPositionVelocity works without a result parameter", function () {
+    var matrix = Transforms.rotationMatrixFromPositionVelocity(
+      Cartesian3.UNIT_X,
+      Cartesian3.UNIT_Y
+    );
+    var expected = new Matrix3(0, 0, 1, 1, 0, 0, 0, 1, 0);
+    expect(matrix).toEqualEpsilon(expected, CesiumMath.EPSILON14);
+
+    matrix = Transforms.rotationMatrixFromPositionVelocity(
+      Cartesian3.UNIT_X,
+      Cartesian3.UNIT_Z
+    );
+    expected = new Matrix3(0, 0, 1, 0, -1, 0, 1, 0, 0);
+    expect(matrix).toEqualEpsilon(expected, CesiumMath.EPSILON14);
+
+    matrix = Transforms.rotationMatrixFromPositionVelocity(
+      Cartesian3.UNIT_Y,
+      Cartesian3.UNIT_Z
+    );
+    expected = new Matrix3(0, 1, 0, 0, 0, 1, 1, 0, 0);
+    expect(matrix).toEqualEpsilon(expected, CesiumMath.EPSILON14);
+  });
+
+  it("rotationMatrixFromPositionVelocity works with a result parameter", function () {
+    var result = new Matrix3();
+    Transforms.rotationMatrixFromPositionVelocity(
+      Cartesian3.UNIT_X,
+      Cartesian3.UNIT_Y,
+      Ellipsoid.WGS84,
+      result
+    );
+    var expected = new Matrix3(0, 0, 1, 1, 0, 0, 0, 1, 0);
+    expect(result).toEqualEpsilon(expected, CesiumMath.EPSILON14);
+
+    Transforms.rotationMatrixFromPositionVelocity(
+      Cartesian3.UNIT_X,
+      Cartesian3.UNIT_Z,
+      Ellipsoid.WGS84,
+      result
+    );
+    expected = new Matrix3(0, 0, 1, 0, -1, 0, 1, 0, 0);
+    expect(result).toEqualEpsilon(expected, CesiumMath.EPSILON14);
+
+    Transforms.rotationMatrixFromPositionVelocity(
+      Cartesian3.UNIT_Y,
+      Cartesian3.UNIT_Z,
+      Ellipsoid.WGS84,
+      result
+    );
+    expected = new Matrix3(0, 1, 0, 0, 0, 1, 1, 0, 0);
+    expect(result).toEqualEpsilon(expected, CesiumMath.EPSILON14);
+  });
+
   it("basisTo2D projects translation", function () {
     var ellipsoid = Ellipsoid.WGS84;
     var projection = new GeographicProjection(ellipsoid);

Specs/Core/buildModuleUrlSpec.js

@@ -17,12 +17,25 @@ describe("Core/buildModuleUrl", function () {
     var r = buildModuleUrl._cesiumScriptRegex;
 
     expect(r.exec("Cesium.js")[1]).toEqual("");
+    expect(r.exec("Cesium.js?v=1.7")[1]).toEqual("");
     expect(r.exec("assets/foo/Cesium.js")[1]).toEqual("assets/foo/");
+    expect(r.exec("assets/foo/Cesium.js?v=1.7")[1]).toEqual("assets/foo/");
     expect(
       r.exec("http://example.invalid/Cesium/assets/foo/Cesium.js")[1]
     ).toEqual("http://example.invalid/Cesium/assets/foo/");
+    expect(
+      r.exec("http://example.invalid/Cesium/assets/foo/Cesium.js?v=1.7")[1]
+    ).toEqual("http://example.invalid/Cesium/assets/foo/");
 
+    expect(r.exec("cesium.js")).toBeNull();
+    expect(r.exec("Cesium.js%20")).toBeNull();
+    expect(r.exec("Cesium.min.js")).toBeNull();
+    expect(r.exec("CesiumSomething.js")).toBeNull();
+    expect(r.exec("CesiumSomething.js?v=1.7")).toBeNull();
     expect(r.exec("assets/foo/bar.cesium.js")).toBeNull();
+    expect(r.exec("assets/foo/bar.cesium.js?v=1.7")).toBeNull();
+    expect(r.exec("assets/foo/CesiumSomething.js")).toBeNull();
+    expect(r.exec("assets/foo/CesiumSomething.js?v=1.7")).toBeNull();
   });
 
   it("CESIUM_BASE_URL works with trailing slash", function () {

Specs/TypeScript/tsconfig.json

@@ -5,6 +5,6 @@
     "strict": true
   },
   "include": [
-    "../.."
+    "../../Source"
   ],
 }

gulpfile.cjs

@@ -1310,7 +1310,7 @@ function combineJavaScript(options) {
 }
 
 function glslToJavaScript(minify, minifyStateFilePath) {
-  fs.writeFileSync(minifyStateFilePath, minify);
+  fs.writeFileSync(minifyStateFilePath, minify.toString());
   var minifyStateFileLastModified = fs.existsSync(minifyStateFilePath)
     ? fs.statSync(minifyStateFilePath).mtime.getTime()
     : 0;