@cesium/engine 1.1.0 → 2.1.0

package/Source/Core/Matrix2.js

@@ -11,10 +11,10 @@ import DeveloperError from "./DeveloperError.js";
  * @constructor
  * @implements {ArrayLike<number>}
  *
- * @param {Number} [column0Row0=0.0] The value for column 0, row 0.
- * @param {Number} [column1Row0=0.0] The value for column 1, row 0.
- * @param {Number} [column0Row1=0.0] The value for column 0, row 1.
- * @param {Number} [column1Row1=0.0] The value for column 1, row 1.
+ * @param {number} [column0Row0=0.0] The value for column 0, row 0.
+ * @param {number} [column1Row0=0.0] The value for column 1, row 0.
+ * @param {number} [column0Row1=0.0] The value for column 0, row 1.
+ * @param {number} [column1Row1=0.0] The value for column 1, row 1.
  *
  * @see Matrix2.fromArray
  * @see Matrix2.fromColumnMajorArray
@@ -34,7 +34,7 @@ function Matrix2(column0Row0, column1Row0, column0Row1, column1Row1) {
 
 /**
  * The number of elements used to pack the object into an array.
- * @type {Number}
+ * @type {number}
  */
 Matrix2.packedLength = 4;
 
@@ -42,10 +42,10 @@ Matrix2.packedLength = 4;
  * Stores the provided instance into the provided array.
  *
  * @param {Matrix2} value The value to pack.
- * @param {Number[]} array The array to pack into.
- * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements.
+ * @param {number[]} array The array to pack into.
+ * @param {number} [startingIndex=0] The index into the array at which to start packing the elements.
  *
- * @returns {Number[]} The array that was packed into
+ * @returns {number[]} The array that was packed into
  */
 Matrix2.pack = function (value, array, startingIndex) {
   //>>includeStart('debug', pragmas.debug);
@@ -66,8 +66,8 @@ Matrix2.pack = function (value, array, startingIndex) {
 /**
  * Retrieves an instance from a packed array.
  *
- * @param {Number[]} array The packed array.
- * @param {Number} [startingIndex=0] The starting index of the element to be unpacked.
+ * @param {number[]} array The packed array.
+ * @param {number} [startingIndex=0] The starting index of the element to be unpacked.
  * @param {Matrix2} [result] The object into which to store the result.
  * @returns {Matrix2} The modified result parameter or a new Matrix2 instance if one was not provided.
  */
@@ -94,8 +94,8 @@ Matrix2.unpack = function (array, startingIndex, result) {
  * are stored in column-major order.
  *
  * @param {Matrix2[]} array The array of matrices to pack.
- * @param {Number[]} [result] The array onto which to store the result. If this is a typed array, it must have array.length * 4 components, else a {@link DeveloperError} will be thrown. If it is a regular array, it will be resized to have (array.length * 4) elements.
- * @returns {Number[]} The packed array.
+ * @param {number[]} [result] The array onto which to store the result. If this is a typed array, it must have array.length * 4 components, else a {@link DeveloperError} will be thrown. If it is a regular array, it will be resized to have (array.length * 4) elements.
+ * @returns {number[]} The packed array.
  */
 Matrix2.packArray = function (array, result) {
   //>>includeStart('debug', pragmas.debug);
@@ -125,7 +125,7 @@ Matrix2.packArray = function (array, result) {
 /**
  * Unpacks an array of column-major matrix components into an array of Matrix2s.
  *
- * @param {Number[]} array The array of components to unpack.
+ * @param {number[]} array The array of components to unpack.
  * @param {Matrix2[]} [result] The array onto which to store the result.
  * @returns {Matrix2[]} The unpacked array.
  */
@@ -177,8 +177,8 @@ Matrix2.clone = function (matrix, result) {
  * Creates a Matrix2 from 4 consecutive elements in an array.
  *
  * @function
- * @param {Number[]} array The array whose 4 consecutive elements correspond to the positions of the matrix.  Assumes column-major order.
- * @param {Number} [startingIndex=0] The offset into the array of the first element, which corresponds to first column first row position in the matrix.
+ * @param {number[]} array The array whose 4 consecutive elements correspond to the positions of the matrix.  Assumes column-major order.
+ * @param {number} [startingIndex=0] The offset into the array of the first element, which corresponds to first column first row position in the matrix.
  * @param {Matrix2} [result] The object onto which to store the result.
  * @returns {Matrix2} The modified result parameter or a new Matrix2 instance if one was not provided.
  *
@@ -198,7 +198,7 @@ Matrix2.fromArray = Matrix2.unpack;
 /**
  * Creates a Matrix2 instance from a column-major order array.
  *
- * @param {Number[]} values The column-major order array.
+ * @param {number[]} values The column-major order array.
  * @param {Matrix2} [result] The object in which the result will be stored, if undefined a new instance will be created.
  * @returns {Matrix2} The modified result parameter, or a new Matrix2 instance if one was not provided.
  */
@@ -214,7 +214,7 @@ Matrix2.fromColumnMajorArray = function (values, result) {
  * Creates a Matrix2 instance from a row-major order array.
  * The resulting matrix will be in column-major order.
  *
- * @param {Number[]} values The row-major order array.
+ * @param {number[]} values The row-major order array.
  * @param {Matrix2} [result] The object in which the result will be stored, if undefined a new instance will be created.
  * @returns {Matrix2} The modified result parameter, or a new Matrix2 instance if one was not provided.
  */
@@ -265,7 +265,7 @@ Matrix2.fromScale = function (scale, result) {
 /**
  * Computes a Matrix2 instance representing a uniform scale.
  *
- * @param {Number} scale The uniform scale factor.
+ * @param {number} scale The uniform scale factor.
  * @param {Matrix2} [result] The object in which the result will be stored, if undefined a new instance will be created.
  * @returns {Matrix2} The modified result parameter, or a new Matrix2 instance if one was not provided.
  *
@@ -294,7 +294,7 @@ Matrix2.fromUniformScale = function (scale, result) {
 /**
  * Creates a rotation matrix.
  *
- * @param {Number} angle The angle, in radians, of the rotation.  Positive angles are counterclockwise.
+ * @param {number} angle The angle, in radians, of the rotation.  Positive angles are counterclockwise.
  * @param {Matrix2} [result] The object in which the result will be stored, if undefined a new instance will be created.
  * @returns {Matrix2} The modified result parameter, or a new Matrix2 instance if one was not provided.
  *
@@ -327,8 +327,8 @@ Matrix2.fromRotation = function (angle, result) {
  * The array will be in column-major order.
  *
  * @param {Matrix2} matrix The matrix to use..
- * @param {Number[]} [result] The Array onto which to store the result.
- * @returns {Number[]} The modified Array parameter or a new Array instance if one was not provided.
+ * @param {number[]} [result] The Array onto which to store the result.
+ * @returns {number[]} The modified Array parameter or a new Array instance if one was not provided.
  */
 Matrix2.toArray = function (matrix, result) {
   //>>includeStart('debug', pragmas.debug);
@@ -348,9 +348,9 @@ Matrix2.toArray = function (matrix, result) {
 /**
  * Computes the array index of the element at the provided row and column.
  *
- * @param {Number} row The zero-based index of the row.
- * @param {Number} column The zero-based index of the column.
- * @returns {Number} The index of the element at the provided row and column.
+ * @param {number} row The zero-based index of the row.
+ * @param {number} column The zero-based index of the column.
+ * @returns {number} The index of the element at the provided row and column.
  *
  * @exception {DeveloperError} row must be 0 or 1.
  * @exception {DeveloperError} column must be 0 or 1.
@@ -377,7 +377,7 @@ Matrix2.getElementIndex = function (column, row) {
  * Retrieves a copy of the matrix column at the provided index as a Cartesian2 instance.
  *
  * @param {Matrix2} matrix The matrix to use.
- * @param {Number} index The zero-based index of the column to retrieve.
+ * @param {number} index The zero-based index of the column to retrieve.
  * @param {Cartesian2} result The object onto which to store the result.
  * @returns {Cartesian2} The modified result parameter.
  *
@@ -406,7 +406,7 @@ Matrix2.getColumn = function (matrix, index, result) {
  * Computes a new matrix that replaces the specified column in the provided matrix with the provided Cartesian2 instance.
  *
  * @param {Matrix2} matrix The matrix to use.
- * @param {Number} index The zero-based index of the column to set.
+ * @param {number} index The zero-based index of the column to set.
  * @param {Cartesian2} cartesian The Cartesian whose values will be assigned to the specified column.
  * @param {Cartesian2} result The object onto which to store the result.
  * @returns {Matrix2} The modified result parameter.
@@ -435,7 +435,7 @@ Matrix2.setColumn = function (matrix, index, cartesian, result) {
  * Retrieves a copy of the matrix row at the provided index as a Cartesian2 instance.
  *
  * @param {Matrix2} matrix The matrix to use.
- * @param {Number} index The zero-based index of the row to retrieve.
+ * @param {number} index The zero-based index of the row to retrieve.
  * @param {Cartesian2} result The object onto which to store the result.
  * @returns {Cartesian2} The modified result parameter.
  *
@@ -463,7 +463,7 @@ Matrix2.getRow = function (matrix, index, result) {
  * Computes a new matrix that replaces the specified row in the provided matrix with the provided Cartesian2 instance.
  *
  * @param {Matrix2} matrix The matrix to use.
- * @param {Number} index The zero-based index of the row to set.
+ * @param {number} index The zero-based index of the row to set.
  * @param {Cartesian2} cartesian The Cartesian whose values will be assigned to the specified row.
  * @param {Matrix2} result The object onto which to store the result.
  * @returns {Matrix2} The modified result parameter.
@@ -531,7 +531,7 @@ const scaleScratch2 = new Cartesian2();
  * This assumes the matrix is an affine transformation.
  *
  * @param {Matrix2} matrix The matrix to use.
- * @param {Number} scale The uniform scale that replaces the scale of the provided matrix.
+ * @param {number} scale The uniform scale that replaces the scale of the provided matrix.
  * @param {Matrix2} result The object onto which to store the result.
  * @returns {Matrix2} The modified result parameter.
  *
@@ -599,7 +599,7 @@ const scaleScratch3 = new Cartesian2();
  * The maximum scale is the maximum length of the column vectors.
  *
  * @param {Matrix2} matrix The matrix.
- * @returns {Number} The maximum scale.
+ * @returns {number} The maximum scale.
  */
 Matrix2.getMaximumScale = function (matrix) {
   Matrix2.getScale(matrix, scaleScratch3);
@@ -761,7 +761,7 @@ Matrix2.multiplyByVector = function (matrix, cartesian, result) {
  * Computes the product of a matrix and a scalar.
  *
  * @param {Matrix2} matrix The matrix.
- * @param {Number} scalar The number to multiply by.
+ * @param {number} scalar The number to multiply by.
  * @param {Matrix2} result The object onto which to store the result.
  * @returns {Matrix2} The modified result parameter.
  */
@@ -818,7 +818,7 @@ Matrix2.multiplyByScale = function (matrix, scale, result) {
  * Computes the product of a matrix times a uniform scale, as if the scale were a scale matrix.
  *
  * @param {Matrix2} matrix The matrix on the left-hand side.
- * @param {Number} scale The uniform scale on the right-hand side.
+ * @param {number} scale The uniform scale on the right-hand side.
  * @param {Matrix2} result The object onto which to store the result.
  * @returns {Matrix2} The modified result parameter.
  *
@@ -920,7 +920,7 @@ Matrix2.abs = function (matrix, result) {
  *
  * @param {Matrix2} [left] The first matrix.
  * @param {Matrix2} [right] The second matrix.
- * @returns {Boolean} <code>true</code> if left and right are equal, <code>false</code> otherwise.
+ * @returns {boolean} <code>true</code> if left and right are equal, <code>false</code> otherwise.
  */
 Matrix2.equals = function (left, right) {
   return (
@@ -953,8 +953,8 @@ Matrix2.equalsArray = function (matrix, array, offset) {
  *
  * @param {Matrix2} [left] The first matrix.
  * @param {Matrix2} [right] The second matrix.
- * @param {Number} [epsilon=0] The epsilon to use for equality testing.
- * @returns {Boolean} <code>true</code> if left and right are within the provided epsilon, <code>false</code> otherwise.
+ * @param {number} [epsilon=0] The epsilon to use for equality testing.
+ * @returns {boolean} <code>true</code> if left and right are within the provided epsilon, <code>false</code> otherwise.
  */
 Matrix2.equalsEpsilon = function (left, right, epsilon) {
   epsilon = defaultValue(epsilon, 0);
@@ -988,7 +988,7 @@ Matrix2.ZERO = Object.freeze(new Matrix2(0.0, 0.0, 0.0, 0.0));
 /**
  * The index into Matrix2 for column 0, row 0.
  *
- * @type {Number}
+ * @type {number}
  * @constant
  *
  * @example
@@ -1000,7 +1000,7 @@ Matrix2.COLUMN0ROW0 = 0;
 /**
  * The index into Matrix2 for column 0, row 1.
  *
- * @type {Number}
+ * @type {number}
  * @constant
  *
  * @example
@@ -1012,7 +1012,7 @@ Matrix2.COLUMN0ROW1 = 1;
 /**
  * The index into Matrix2 for column 1, row 0.
  *
- * @type {Number}
+ * @type {number}
  * @constant
  *
  * @example
@@ -1024,7 +1024,7 @@ Matrix2.COLUMN1ROW0 = 2;
 /**
  * The index into Matrix2 for column 1, row 1.
  *
- * @type {Number}
+ * @type {number}
  * @constant
  *
  * @example
@@ -1038,7 +1038,7 @@ Object.defineProperties(Matrix2.prototype, {
    * Gets the number of items in the collection.
    * @memberof Matrix2.prototype
    *
-   * @type {Number}
+   * @type {number}
    */
   length: {
     get: function () {
@@ -1062,7 +1062,7 @@ Matrix2.prototype.clone = function (result) {
  * <code>true</code> if they are equal, <code>false</code> otherwise.
  *
  * @param {Matrix2} [right] The right hand side matrix.
- * @returns {Boolean} <code>true</code> if they are equal, <code>false</code> otherwise.
+ * @returns {boolean} <code>true</code> if they are equal, <code>false</code> otherwise.
  */
 Matrix2.prototype.equals = function (right) {
   return Matrix2.equals(this, right);
@@ -1074,8 +1074,8 @@ Matrix2.prototype.equals = function (right) {
  * <code>false</code> otherwise.
  *
  * @param {Matrix2} [right] The right hand side matrix.
- * @param {Number} [epsilon=0] The epsilon to use for equality testing.
- * @returns {Boolean} <code>true</code> if they are within the provided epsilon, <code>false</code> otherwise.
+ * @param {number} [epsilon=0] The epsilon to use for equality testing.
+ * @returns {boolean} <code>true</code> if they are within the provided epsilon, <code>false</code> otherwise.
  */
 Matrix2.prototype.equalsEpsilon = function (right, epsilon) {
   return Matrix2.equalsEpsilon(this, right, epsilon);
@@ -1085,7 +1085,7 @@ Matrix2.prototype.equalsEpsilon = function (right, epsilon) {
  * Creates a string representing this Matrix with each row being
  * on a separate line and in the format '(column0, column1)'.
  *
- * @returns {String} A string representing the provided Matrix with each row being on a separate line and in the format '(column0, column1)'.
+ * @returns {string} A string representing the provided Matrix with each row being on a separate line and in the format '(column0, column1)'.
  */
 Matrix2.prototype.toString = function () {
   return `(${this[0]}, ${this[2]})\n` + `(${this[1]}, ${this[3]})`;