Matrix2 - Cesium Documentation

# Matrix2

#### new Matrix2(column0Row0, column1Row0, column0Row1, column1Row1)

  A 2x2 matrix, indexable as a column-major order array. Constructor parameters are in row-major order for code readability.

  Name | Type | Default | Description
  --- | --- | --- | ---
  `column0Row0` | Number | `0.0` | optional The value for column 0, row 0.
  `column1Row0` | Number | `0.0` | optional The value for column 1, row 0.
  `column0Row1` | Number | `0.0` | optional The value for column 0, row 1.
  `column1Row1` | Number | `0.0` | optional The value for column 1, row 1.

  ##### See:

  - Matrix2.fromColumnMajorArray
  - Matrix2.fromRowMajorArray
  - Matrix2.fromScale
  - Matrix2.fromUniformScale
  - Matrix3
  - Matrix4
  Source: Core/Matrix2.js, line 34

### Members

#### staticconstantMatrix2.COLUMN0ROW0 :Number

  The index into Matrix2 for column 0, row 0.

  ##### Example:

      var matrix = new Cesium.Matrix2();
      matrix[Cesium.Matrix2.COLUMN0ROW0] = 5.0; // set column 0, row 0 to 5.0

  Source: Core/Matrix2.js, line 869

#### staticconstantMatrix2.COLUMN0ROW1 :Number

  The index into Matrix2 for column 0, row 1.

  ##### Example:

      var matrix = new Cesium.Matrix2();
      matrix[Cesium.Matrix2.COLUMN0ROW1] = 5.0; // set column 0, row 1 to 5.0

  Source: Core/Matrix2.js, line 881

#### staticconstantMatrix2.COLUMN1ROW0 :Number

  The index into Matrix2 for column 1, row 0.

  ##### Example:

      var matrix = new Cesium.Matrix2();
      matrix[Cesium.Matrix2.COLUMN1ROW0] = 5.0; // set column 1, row 0 to 5.0

  Source: Core/Matrix2.js, line 893

#### staticconstantMatrix2.COLUMN1ROW1 :Number

  The index into Matrix2 for column 1, row 1.

  ##### Example:

      var matrix = new Cesium.Matrix2();
      matrix[Cesium.Matrix2.COLUMN1ROW1] = 5.0; // set column 1, row 1 to 5.0

  Source: Core/Matrix2.js, line 905

#### staticconstantMatrix2.IDENTITY :Matrix2

  An immutable Matrix2 instance initialized to the identity matrix.
  Source: Core/Matrix2.js, line 847

#### staticMatrix2.packedLength :Number

  The number of elements used to pack the object into an array.
  Source: Core/Matrix2.js, line 45

#### staticconstantMatrix2.ZERO :Matrix2

  An immutable Matrix2 instance initialized to the zero matrix.
  Source: Core/Matrix2.js, line 856

### Methods

#### clone(result) → Matrix2

  Duplicates the provided Matrix2 instance.

  Name | Type | Description
  --- | --- | ---
  `result` | Matrix2 | optional The object onto which to store the result.

  ##### Returns:

  The modified result parameter or a new Matrix2 instance if one was not provided.
  Source: Core/Matrix2.js, line 913

#### equals(right) → Boolean

  Compares this matrix to the provided matrix componentwise and returns `true` if they are equal, `false` otherwise.

  Name | Type | Description
  --- | --- | ---
  `right` | Matrix2 | optional The right hand side matrix.

  ##### Returns:

  `true` if they are equal, `false` otherwise.
  Source: Core/Matrix2.js, line 924

#### equalsEpsilon(right, epsilon) → Boolean

  Compares this matrix to the provided matrix componentwise and returns `true` if they are within the provided epsilon, `false` otherwise.

  Name | Type | Description
  --- | --- | ---
  `right` | Matrix2 | optional The right hand side matrix.
  `epsilon` | Number | The epsilon to use for equality testing.

  ##### Returns:

  `true` if they are within the provided epsilon, `false` otherwise.
  Source: Core/Matrix2.js, line 937

#### toString() → String

  Creates a string representing this Matrix with each row being on a separate line and in the format '(column0, column1)'.

  ##### Returns:

  A string representing the provided Matrix with each row being on a separate line and in the format '(column0, column1)'.
  Source: Core/Matrix2.js, line 947

#### staticMatrix2.abs(matrix, result) → Matrix2

  Computes a matrix, which contains the absolute (unsigned) values of the provided matrix's elements.

  Name | Type | Description
  --- | --- | ---
  `matrix` | Matrix2 | The matrix with signed elements.
  `result` | Matrix2 | The object onto which to store the result.

  ##### Returns:

  The modified result parameter.
  Source: Core/Matrix2.js, line 769

#### staticMatrix2.add(left, right, result) → Matrix2

  Computes the sum of two matrices.

  Name | Type | Description
  --- | --- | ---
  `left` | Matrix2 | The first matrix.
  `right` | Matrix2 | The second matrix.
  `result` | Matrix2 | The object onto which to store the result.

  ##### Returns:

  The modified result parameter.
  Source: Core/Matrix2.js, line 569

#### staticMatrix2.clone(matrix, result) → Matrix2

  Duplicates a Matrix2 instance.

  Name | Type | Description
  --- | --- | ---
  `matrix` | Matrix2 | The matrix to duplicate.
  `result` | Matrix2 | optional The object onto which to store the result.

  ##### Returns:

  The modified result parameter or a new Matrix2 instance if one was not provided. (Returns undefined if matrix is undefined)
  Source: Core/Matrix2.js, line 107

#### staticMatrix2.equals(left, right) → Boolean

  Compares the provided matrices componentwise and returns `true` if they are equal, `false` otherwise.

  Name | Type | Description
  --- | --- | ---
  `left` | Matrix2 | optional The first matrix.
  `right` | Matrix2 | optional The second matrix.

  ##### Returns:

  `true` if left and right are equal, `false` otherwise.
  Source: Core/Matrix2.js, line 795

#### staticMatrix2.equalsEpsilon(left, right, epsilon) → Boolean

  Compares the provided matrices componentwise and returns `true` if they are within the provided epsilon, `false` otherwise.

  Name | Type | Description
  --- | --- | ---
  `left` | Matrix2 | optional The first matrix.
  `right` | Matrix2 | optional The second matrix.
  `epsilon` | Number | The epsilon to use for equality testing.

  ##### Returns:

  `true` if left and right are within the provided epsilon, `false` otherwise.
  Source: Core/Matrix2.js, line 825

#### staticMatrix2.fromArray(array, startingIndex, result) → Matrix2

  Creates a Matrix2 from 4 consecutive elements in an array.

  Name | Type | Default | Description
  --- | --- | --- | ---
  `array` | Array.<Number> |  | The array whose 4 consecutive elements correspond to the positions of the matrix. Assumes column-major order.
  `startingIndex` | Number | `0` | optional The offset into the array of the first element, which corresponds to first column first row position in the matrix.
  `result` | Matrix2 |  | optional The object onto which to store the result.

  ##### Returns:

  The modified result parameter or a new Matrix2 instance if one was not provided.

  ##### Example:

      // Create the Matrix2:
      // [1.0, 2.0]
      // [1.0, 2.0]

      var v = [1.0, 1.0, 2.0, 2.0];
      var m = Cesium.Matrix2.fromArray(v);

      // Create same Matrix2 with using an offset into an array
      var v2 = [0.0, 0.0, 1.0, 1.0, 2.0, 2.0];
      var m2 = Cesium.Matrix2.fromArray(v2, 2);

  Source: Core/Matrix2.js, line 142

#### staticMatrix2.fromColumnMajorArray(values, result)

  Creates a Matrix2 instance from a column-major order array.

  Name | Type | Description
  --- | --- | ---
  `values` | Array.<Number> | The column-major order array.
  `result` | Matrix2 | optional The object in which the result will be stored, if undefined a new instance will be created.

  ##### Returns:

  The modified result parameter, or a new Matrix2 instance if one was not provided.
  Source: Core/Matrix2.js, line 169

#### staticMatrix2.fromRotation(angle, result)

  Creates a rotation matrix.

  Name | Type | Description
  --- | --- | ---
  `angle` | Number | The angle, in radians, of the rotation. Positive angles are counterclockwise.
  `result` | Matrix2 | optional The object in which the result will be stored, if undefined a new instance will be created.

  ##### Returns:

  The modified result parameter, or a new Matrix2 instance if one was not provided.

  ##### Example:

      // Rotate a point 45 degrees counterclockwise.
      var p = new Cesium.Cartesian2(5, 6);
      var m = Cesium.Matrix2.fromRotation(Cesium.Math.toRadians(45.0));
      var rotated = Cesium.Matrix2.multiplyByVector(m, p, new Cesium.Cartesian2());

  Source: Core/Matrix2.js, line 284

#### staticMatrix2.fromRowMajorArray(values, result)

  Creates a Matrix2 instance from a row-major order array. The resulting matrix will be in column-major order.

  Name | Type | Description
  --- | --- | ---
  `values` | Array.<Number> | The row-major order array.
  `result` | Matrix2 | optional The object in which the result will be stored, if undefined a new instance will be created.

  ##### Returns:

  The modified result parameter, or a new Matrix2 instance if one was not provided.
  Source: Core/Matrix2.js, line 187

#### staticMatrix2.fromScale(scale, result)

  Computes a Matrix2 instance representing a non-uniform scale.

  Name | Type | Description
  --- | --- | ---
  `scale` | Cartesian2 | The x and y scale factors.
  `result` | Matrix2 | optional The object in which the result will be stored, if undefined a new instance will be created.

  ##### Returns:

  The modified result parameter, or a new Matrix2 instance if one was not provided.

  ##### Example:

      // Creates
      //   [7.0, 0.0]
      //   [0.0, 8.0]
      var m = Cesium.Matrix2.fromScale(new Cesium.Cartesian2(7.0, 8.0));

  Source: Core/Matrix2.js, line 218

#### staticMatrix2.fromUniformScale(scale, result)

  Computes a Matrix2 instance representing a uniform scale.

  Name | Type | Description
  --- | --- | ---
  `scale` | Number | The uniform scale factor.
  `result` | Matrix2 | optional The object in which the result will be stored, if undefined a new instance will be created.

  ##### Returns:

  The modified result parameter, or a new Matrix2 instance if one was not provided.

  ##### Example:

      // Creates
      //   [2.0, 0.0]
      //   [0.0, 2.0]
      var m = Cesium.Matrix2.fromUniformScale(2.0);

  Source: Core/Matrix2.js, line 251

#### staticMatrix2.getColumn(matrix, index, result) → Cartesian2

  Retrieves a copy of the matrix column at the provided index as a Cartesian2 instance.

  Name | Type | Description
  --- | --- | ---
  `matrix` | Matrix2 | The matrix to use.
  `index` | Number | The zero-based index of the column to retrieve.
  `result` | Cartesian2 | The object onto which to store the result.

  ##### Returns:

  The modified result parameter.

  ##### Throws:

  - DeveloperError : index must be 0 or 1.
  Source: Core/Matrix2.js, line 370

#### staticMatrix2.getElementIndex(row, column) → Number

  Computes the array index of the element at the provided row and column.

  Name | Type | Description
  --- | --- | ---
  `row` | Number | The zero-based index of the row.
  `column` | Number | The zero-based index of the column.

  ##### Returns:

  The index of the element at the provided row and column.

  ##### Throws:

  - DeveloperError : row must be 0 or 1.
  - DeveloperError : column must be 0 or 1.

  ##### Example:

      var myMatrix = new Cesium.Matrix2();
      var column1Row0Index = Cesium.Matrix2.getElementIndex(1, 0);
      var column1Row0 = myMatrix[column1Row0Index]
      myMatrix[column1Row0Index] = 10.0;

  Source: Core/Matrix2.js, line 347

#### staticMatrix2.getMaximumScale(matrix) → Number

  Computes the maximum scale assuming the matrix is an affine transformation. The maximum scale is the maximum length of the column vectors.

  Name | Type | Description
  --- | --- | ---
  `matrix` | Matrix2 | The matrix.

  ##### Returns:

  The maximum scale.
  Source: Core/Matrix2.js, line 523

#### staticMatrix2.getRow(matrix, index, result) → Cartesian2

  Retrieves a copy of the matrix row at the provided index as a Cartesian2 instance.

  Name | Type | Description
  --- | --- | ---
  `matrix` | Matrix2 | The matrix to use.
  `index` | Number | The zero-based index of the row to retrieve.
  `result` | Cartesian2 | The object onto which to store the result.

  ##### Returns:

  The modified result parameter.

  ##### Throws:

  - DeveloperError : index must be 0 or 1.
  Source: Core/Matrix2.js, line 436

#### staticMatrix2.getScale(matrix, result) → Cartesian2

  Extracts the non-uniform scale assuming the matrix is an affine transformation.

  Name | Type | Description
  --- | --- | ---
  `matrix` | Matrix2 | The matrix.
  `result` | Cartesian2 | The object onto which to store the result.

  ##### Returns:

  The modified result parameter.
  Source: Core/Matrix2.js, line 499

#### staticMatrix2.multiply(left, right, result) → Matrix2

  Computes the product of two matrices.

  Name | Type | Description
  --- | --- | ---
  `left` | Matrix2 | The first matrix.
  `right` | Matrix2 | The second matrix.
  `result` | Matrix2 | The object onto which to store the result.

  ##### Returns:

  The modified result parameter.
  Source: Core/Matrix2.js, line 536

#### staticMatrix2.multiplyByScalar(matrix, scalar, result) → Matrix2

  Computes the product of a matrix and a scalar.

  Name | Type | Description
  --- | --- | ---
  `matrix` | Matrix2 | The matrix.
  `scalar` | Number | The number to multiply by.
  `result` | Matrix2 | The object onto which to store the result.

  ##### Returns:

  The modified result parameter.
  Source: Core/Matrix2.js, line 654

#### staticMatrix2.multiplyByScale(matrix, scale, result) → Matrix2

  Computes the product of a matrix times a (non-uniform) scale, as if the scale were a scale matrix.

  Name | Type | Description
  --- | --- | ---
  `matrix` | Matrix2 | The matrix on the left-hand side.
  `scale` | Cartesian2 | The non-uniform scale on the right-hand side.
  `result` | Matrix2 | The object onto which to store the result.

  ##### Returns:

  The modified result parameter.

  ##### Example:

      // Instead of Cesium.Matrix2.multiply(m, Cesium.Matrix2.fromScale(scale), m);
      Cesium.Matrix2.multiplyByScale(m, scale, m);

  ##### See:

  - Matrix2.fromScale
  - Matrix2.multiplyByUniformScale
  Source: Core/Matrix2.js, line 689

#### staticMatrix2.multiplyByVector(matrix, cartesian, result) → Cartesian2

  Computes the product of a matrix and a column vector.

  Name | Type | Description
  --- | --- | ---
  `matrix` | Matrix2 | The matrix.
  `cartesian` | Cartesian2 | The column.
  `result` | Cartesian2 | The object onto which to store the result.

  ##### Returns:

  The modified result parameter.
  Source: Core/Matrix2.js, line 625

#### staticMatrix2.negate(matrix, result) → Matrix2

  Creates a negated copy of the provided matrix.

  Name | Type | Description
  --- | --- | ---
  `matrix` | Matrix2 | The matrix to negate.
  `result` | Matrix2 | The object onto which to store the result.

  ##### Returns:

  The modified result parameter.
  Source: Core/Matrix2.js, line 716

#### staticMatrix2.pack(value, array, startingIndex)

  Stores the provided instance into the provided array.

  Name | Type | Default | Description
  --- | --- | --- | ---
  `value` | Matrix2 |  | The value to pack.
  `array` | Array.<Number> |  | The array to pack into.
  `startingIndex` | Number | `0` | optional The index into the array at which to start packing the elements.

  Source: Core/Matrix2.js, line 54

#### staticMatrix2.setColumn(matrix, index, cartesian, result) → Matrix2

  Computes a new matrix that replaces the specified column in the provided matrix with the provided Cartesian2 instance.

  Name | Type | Description
  --- | --- | ---
  `matrix` | Matrix2 | The matrix to use.
  `index` | Number | The zero-based index of the column to set.
  `cartesian` | Cartesian2 | The Cartesian whose values will be assigned to the specified column.
  `result` | Cartesian2 | The object onto which to store the result.

  ##### Returns:

  The modified result parameter.

  ##### Throws:

  - DeveloperError : index must be 0 or 1.
  Source: Core/Matrix2.js, line 403

#### staticMatrix2.setRow(matrix, index, cartesian, result) → Matrix2

  Computes a new matrix that replaces the specified row in the provided matrix with the provided Cartesian2 instance.

  Name | Type | Description
  --- | --- | ---
  `matrix` | Matrix2 | The matrix to use.
  `index` | Number | The zero-based index of the row to set.
  `cartesian` | Cartesian2 | The Cartesian whose values will be assigned to the specified row.
  `result` | Matrix2 | The object onto which to store the result.

  ##### Returns:

  The modified result parameter.

  ##### Throws:

  - DeveloperError : index must be 0 or 1.
  Source: Core/Matrix2.js, line 468

#### staticMatrix2.subtract(left, right, result) → Matrix2

  Computes the difference of two matrices.

  Name | Type | Description
  --- | --- | ---
  `left` | Matrix2 | The first matrix.
  `right` | Matrix2 | The second matrix.
  `result` | Matrix2 | The object onto which to store the result.

  ##### Returns:

  The modified result parameter.
  Source: Core/Matrix2.js, line 597

#### staticMatrix2.toArray(matrix, result) → Array.<Number>

  Creates an Array from the provided Matrix2 instance. The array will be in column-major order.

  Name | Type | Description
  --- | --- | ---
  `matrix` | Matrix2 | The matrix to use..
  `result` | Array.<Number> | optional The Array onto which to store the result.

  ##### Returns:

  The modified Array parameter or a new Array instance if one was not provided.
  Source: Core/Matrix2.js, line 314

#### staticMatrix2.transpose(matrix, result) → Matrix2

  Computes the transpose of the provided matrix.

  Name | Type | Description
  --- | --- | ---
  `matrix` | Matrix2 | The matrix to transpose.
  `result` | Matrix2 | The object onto which to store the result.

  ##### Returns:

  The modified result parameter.
  Source: Core/Matrix2.js, line 740

#### staticMatrix2.unpack(array, startingIndex, result)

  Retrieves an instance from a packed array.

  Name | Type | Default | Description
  --- | --- | --- | ---
  `array` | Array.<Number> |  | The packed array.
  `startingIndex` | Number | `0` | optional The starting index of the element to be unpacked.
  `result` | Matrix2 |  | optional The object into which to store the result.

  Source: Core/Matrix2.js, line 80