123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839 |
- import Cartesian3 from "./Cartesian3.js";
- import Check from "./Check.js";
- import defaultValue from "./defaultValue.js";
- import defined from "./defined.js";
- import DeveloperError from "./DeveloperError.js";
- import CesiumMath from "./Math.js";
- /**
- * A 3x3 matrix, indexable as a column-major order array.
- * Constructor parameters are in row-major order for code readability.
- * @alias Matrix3
- * @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} [column2Row0=0.0] The value for column 2, 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} [column2Row1=0.0] The value for column 2, row 1.
- * @param {number} [column0Row2=0.0] The value for column 0, row 2.
- * @param {number} [column1Row2=0.0] The value for column 1, row 2.
- * @param {number} [column2Row2=0.0] The value for column 2, row 2.
- *
- * @see Matrix3.fromArray
- * @see Matrix3.fromColumnMajorArray
- * @see Matrix3.fromRowMajorArray
- * @see Matrix3.fromQuaternion
- * @see Matrix3.fromHeadingPitchRoll
- * @see Matrix3.fromScale
- * @see Matrix3.fromUniformScale
- * @see Matrix3.fromCrossProduct
- * @see Matrix3.fromRotationX
- * @see Matrix3.fromRotationY
- * @see Matrix3.fromRotationZ
- * @see Matrix2
- * @see Matrix4
- */
- function Matrix3(
- column0Row0,
- column1Row0,
- column2Row0,
- column0Row1,
- column1Row1,
- column2Row1,
- column0Row2,
- column1Row2,
- column2Row2
- ) {
- this[0] = defaultValue(column0Row0, 0.0);
- this[1] = defaultValue(column0Row1, 0.0);
- this[2] = defaultValue(column0Row2, 0.0);
- this[3] = defaultValue(column1Row0, 0.0);
- this[4] = defaultValue(column1Row1, 0.0);
- this[5] = defaultValue(column1Row2, 0.0);
- this[6] = defaultValue(column2Row0, 0.0);
- this[7] = defaultValue(column2Row1, 0.0);
- this[8] = defaultValue(column2Row2, 0.0);
- }
- /**
- * The number of elements used to pack the object into an array.
- * @type {number}
- */
- Matrix3.packedLength = 9;
- /**
- * Stores the provided instance into the provided array.
- *
- * @param {Matrix3} 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.
- *
- * @returns {number[]} The array that was packed into
- */
- Matrix3.pack = function (value, array, startingIndex) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("value", value);
- Check.defined("array", array);
- //>>includeEnd('debug');
- startingIndex = defaultValue(startingIndex, 0);
- array[startingIndex++] = value[0];
- array[startingIndex++] = value[1];
- array[startingIndex++] = value[2];
- array[startingIndex++] = value[3];
- array[startingIndex++] = value[4];
- array[startingIndex++] = value[5];
- array[startingIndex++] = value[6];
- array[startingIndex++] = value[7];
- array[startingIndex++] = value[8];
- return array;
- };
- /**
- * 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 {Matrix3} [result] The object into which to store the result.
- * @returns {Matrix3} The modified result parameter or a new Matrix3 instance if one was not provided.
- */
- Matrix3.unpack = function (array, startingIndex, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.defined("array", array);
- //>>includeEnd('debug');
- startingIndex = defaultValue(startingIndex, 0);
- if (!defined(result)) {
- result = new Matrix3();
- }
- result[0] = array[startingIndex++];
- result[1] = array[startingIndex++];
- result[2] = array[startingIndex++];
- result[3] = array[startingIndex++];
- result[4] = array[startingIndex++];
- result[5] = array[startingIndex++];
- result[6] = array[startingIndex++];
- result[7] = array[startingIndex++];
- result[8] = array[startingIndex++];
- return result;
- };
- /**
- * Flattens an array of Matrix3s into an array of components. The components
- * are stored in column-major order.
- *
- * @param {Matrix3[]} 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 * 9 components, else a {@link DeveloperError} will be thrown. If it is a regular array, it will be resized to have (array.length * 9) elements.
- * @returns {number[]} The packed array.
- */
- Matrix3.packArray = function (array, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.defined("array", array);
- //>>includeEnd('debug');
- const length = array.length;
- const resultLength = length * 9;
- if (!defined(result)) {
- result = new Array(resultLength);
- } else if (!Array.isArray(result) && result.length !== resultLength) {
- //>>includeStart('debug', pragmas.debug);
- throw new DeveloperError(
- "If result is a typed array, it must have exactly array.length * 9 elements"
- );
- //>>includeEnd('debug');
- } else if (result.length !== resultLength) {
- result.length = resultLength;
- }
- for (let i = 0; i < length; ++i) {
- Matrix3.pack(array[i], result, i * 9);
- }
- return result;
- };
- /**
- * Unpacks an array of column-major matrix components into an array of Matrix3s.
- *
- * @param {number[]} array The array of components to unpack.
- * @param {Matrix3[]} [result] The array onto which to store the result.
- * @returns {Matrix3[]} The unpacked array.
- */
- Matrix3.unpackArray = function (array, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.defined("array", array);
- Check.typeOf.number.greaterThanOrEquals("array.length", array.length, 9);
- if (array.length % 9 !== 0) {
- throw new DeveloperError("array length must be a multiple of 9.");
- }
- //>>includeEnd('debug');
- const length = array.length;
- if (!defined(result)) {
- result = new Array(length / 9);
- } else {
- result.length = length / 9;
- }
- for (let i = 0; i < length; i += 9) {
- const index = i / 9;
- result[index] = Matrix3.unpack(array, i, result[index]);
- }
- return result;
- };
- /**
- * Duplicates a Matrix3 instance.
- *
- * @param {Matrix3} matrix The matrix to duplicate.
- * @param {Matrix3} [result] The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter or a new Matrix3 instance if one was not provided. (Returns undefined if matrix is undefined)
- */
- Matrix3.clone = function (matrix, result) {
- if (!defined(matrix)) {
- return undefined;
- }
- if (!defined(result)) {
- return new Matrix3(
- matrix[0],
- matrix[3],
- matrix[6],
- matrix[1],
- matrix[4],
- matrix[7],
- matrix[2],
- matrix[5],
- matrix[8]
- );
- }
- result[0] = matrix[0];
- result[1] = matrix[1];
- result[2] = matrix[2];
- result[3] = matrix[3];
- result[4] = matrix[4];
- result[5] = matrix[5];
- result[6] = matrix[6];
- result[7] = matrix[7];
- result[8] = matrix[8];
- return result;
- };
- /**
- * Creates a Matrix3 from 9 consecutive elements in an array.
- *
- * @function
- * @param {number[]} array The array whose 9 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 {Matrix3} [result] The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter or a new Matrix3 instance if one was not provided.
- *
- * @example
- * // Create the Matrix3:
- * // [1.0, 2.0, 3.0]
- * // [1.0, 2.0, 3.0]
- * // [1.0, 2.0, 3.0]
- *
- * const v = [1.0, 1.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 3.0];
- * const m = Cesium.Matrix3.fromArray(v);
- *
- * // Create same Matrix3 with using an offset into an array
- * const v2 = [0.0, 0.0, 1.0, 1.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 3.0];
- * const m2 = Cesium.Matrix3.fromArray(v2, 2);
- */
- Matrix3.fromArray = Matrix3.unpack;
- /**
- * Creates a Matrix3 instance from a column-major order array.
- *
- * @param {number[]} values The column-major order array.
- * @param {Matrix3} [result] The object in which the result will be stored, if undefined a new instance will be created.
- * @returns {Matrix3} The modified result parameter, or a new Matrix3 instance if one was not provided.
- */
- Matrix3.fromColumnMajorArray = function (values, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.defined("values", values);
- //>>includeEnd('debug');
- return Matrix3.clone(values, result);
- };
- /**
- * Creates a Matrix3 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 {Matrix3} [result] The object in which the result will be stored, if undefined a new instance will be created.
- * @returns {Matrix3} The modified result parameter, or a new Matrix3 instance if one was not provided.
- */
- Matrix3.fromRowMajorArray = function (values, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.defined("values", values);
- //>>includeEnd('debug');
- if (!defined(result)) {
- return new Matrix3(
- values[0],
- values[1],
- values[2],
- values[3],
- values[4],
- values[5],
- values[6],
- values[7],
- values[8]
- );
- }
- result[0] = values[0];
- result[1] = values[3];
- result[2] = values[6];
- result[3] = values[1];
- result[4] = values[4];
- result[5] = values[7];
- result[6] = values[2];
- result[7] = values[5];
- result[8] = values[8];
- return result;
- };
- /**
- * Computes a 3x3 rotation matrix from the provided quaternion.
- *
- * @param {Quaternion} quaternion the quaternion to use.
- * @param {Matrix3} [result] The object in which the result will be stored, if undefined a new instance will be created.
- * @returns {Matrix3} The 3x3 rotation matrix from this quaternion.
- */
- Matrix3.fromQuaternion = function (quaternion, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("quaternion", quaternion);
- //>>includeEnd('debug');
- const x2 = quaternion.x * quaternion.x;
- const xy = quaternion.x * quaternion.y;
- const xz = quaternion.x * quaternion.z;
- const xw = quaternion.x * quaternion.w;
- const y2 = quaternion.y * quaternion.y;
- const yz = quaternion.y * quaternion.z;
- const yw = quaternion.y * quaternion.w;
- const z2 = quaternion.z * quaternion.z;
- const zw = quaternion.z * quaternion.w;
- const w2 = quaternion.w * quaternion.w;
- const m00 = x2 - y2 - z2 + w2;
- const m01 = 2.0 * (xy - zw);
- const m02 = 2.0 * (xz + yw);
- const m10 = 2.0 * (xy + zw);
- const m11 = -x2 + y2 - z2 + w2;
- const m12 = 2.0 * (yz - xw);
- const m20 = 2.0 * (xz - yw);
- const m21 = 2.0 * (yz + xw);
- const m22 = -x2 - y2 + z2 + w2;
- if (!defined(result)) {
- return new Matrix3(m00, m01, m02, m10, m11, m12, m20, m21, m22);
- }
- result[0] = m00;
- result[1] = m10;
- result[2] = m20;
- result[3] = m01;
- result[4] = m11;
- result[5] = m21;
- result[6] = m02;
- result[7] = m12;
- result[8] = m22;
- return result;
- };
- /**
- * Computes a 3x3 rotation matrix from the provided headingPitchRoll. (see http://en.wikipedia.org/wiki/Conversion_between_quaternions_and_Euler_angles )
- *
- * @param {HeadingPitchRoll} headingPitchRoll the headingPitchRoll to use.
- * @param {Matrix3} [result] The object in which the result will be stored, if undefined a new instance will be created.
- * @returns {Matrix3} The 3x3 rotation matrix from this headingPitchRoll.
- */
- Matrix3.fromHeadingPitchRoll = function (headingPitchRoll, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("headingPitchRoll", headingPitchRoll);
- //>>includeEnd('debug');
- const cosTheta = Math.cos(-headingPitchRoll.pitch);
- const cosPsi = Math.cos(-headingPitchRoll.heading);
- const cosPhi = Math.cos(headingPitchRoll.roll);
- const sinTheta = Math.sin(-headingPitchRoll.pitch);
- const sinPsi = Math.sin(-headingPitchRoll.heading);
- const sinPhi = Math.sin(headingPitchRoll.roll);
- const m00 = cosTheta * cosPsi;
- const m01 = -cosPhi * sinPsi + sinPhi * sinTheta * cosPsi;
- const m02 = sinPhi * sinPsi + cosPhi * sinTheta * cosPsi;
- const m10 = cosTheta * sinPsi;
- const m11 = cosPhi * cosPsi + sinPhi * sinTheta * sinPsi;
- const m12 = -sinPhi * cosPsi + cosPhi * sinTheta * sinPsi;
- const m20 = -sinTheta;
- const m21 = sinPhi * cosTheta;
- const m22 = cosPhi * cosTheta;
- if (!defined(result)) {
- return new Matrix3(m00, m01, m02, m10, m11, m12, m20, m21, m22);
- }
- result[0] = m00;
- result[1] = m10;
- result[2] = m20;
- result[3] = m01;
- result[4] = m11;
- result[5] = m21;
- result[6] = m02;
- result[7] = m12;
- result[8] = m22;
- return result;
- };
- /**
- * Computes a Matrix3 instance representing a non-uniform scale.
- *
- * @param {Cartesian3} scale The x, y, and z scale factors.
- * @param {Matrix3} [result] The object in which the result will be stored, if undefined a new instance will be created.
- * @returns {Matrix3} The modified result parameter, or a new Matrix3 instance if one was not provided.
- *
- * @example
- * // Creates
- * // [7.0, 0.0, 0.0]
- * // [0.0, 8.0, 0.0]
- * // [0.0, 0.0, 9.0]
- * const m = Cesium.Matrix3.fromScale(new Cesium.Cartesian3(7.0, 8.0, 9.0));
- */
- Matrix3.fromScale = function (scale, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("scale", scale);
- //>>includeEnd('debug');
- if (!defined(result)) {
- return new Matrix3(scale.x, 0.0, 0.0, 0.0, scale.y, 0.0, 0.0, 0.0, scale.z);
- }
- result[0] = scale.x;
- result[1] = 0.0;
- result[2] = 0.0;
- result[3] = 0.0;
- result[4] = scale.y;
- result[5] = 0.0;
- result[6] = 0.0;
- result[7] = 0.0;
- result[8] = scale.z;
- return result;
- };
- /**
- * Computes a Matrix3 instance representing a uniform scale.
- *
- * @param {number} scale The uniform scale factor.
- * @param {Matrix3} [result] The object in which the result will be stored, if undefined a new instance will be created.
- * @returns {Matrix3} The modified result parameter, or a new Matrix3 instance if one was not provided.
- *
- * @example
- * // Creates
- * // [2.0, 0.0, 0.0]
- * // [0.0, 2.0, 0.0]
- * // [0.0, 0.0, 2.0]
- * const m = Cesium.Matrix3.fromUniformScale(2.0);
- */
- Matrix3.fromUniformScale = function (scale, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.number("scale", scale);
- //>>includeEnd('debug');
- if (!defined(result)) {
- return new Matrix3(scale, 0.0, 0.0, 0.0, scale, 0.0, 0.0, 0.0, scale);
- }
- result[0] = scale;
- result[1] = 0.0;
- result[2] = 0.0;
- result[3] = 0.0;
- result[4] = scale;
- result[5] = 0.0;
- result[6] = 0.0;
- result[7] = 0.0;
- result[8] = scale;
- return result;
- };
- /**
- * Computes a Matrix3 instance representing the cross product equivalent matrix of a Cartesian3 vector.
- *
- * @param {Cartesian3} vector the vector on the left hand side of the cross product operation.
- * @param {Matrix3} [result] The object in which the result will be stored, if undefined a new instance will be created.
- * @returns {Matrix3} The modified result parameter, or a new Matrix3 instance if one was not provided.
- *
- * @example
- * // Creates
- * // [0.0, -9.0, 8.0]
- * // [9.0, 0.0, -7.0]
- * // [-8.0, 7.0, 0.0]
- * const m = Cesium.Matrix3.fromCrossProduct(new Cesium.Cartesian3(7.0, 8.0, 9.0));
- */
- Matrix3.fromCrossProduct = function (vector, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("vector", vector);
- //>>includeEnd('debug');
- if (!defined(result)) {
- return new Matrix3(
- 0.0,
- -vector.z,
- vector.y,
- vector.z,
- 0.0,
- -vector.x,
- -vector.y,
- vector.x,
- 0.0
- );
- }
- result[0] = 0.0;
- result[1] = vector.z;
- result[2] = -vector.y;
- result[3] = -vector.z;
- result[4] = 0.0;
- result[5] = vector.x;
- result[6] = vector.y;
- result[7] = -vector.x;
- result[8] = 0.0;
- return result;
- };
- /**
- * Creates a rotation matrix around the x-axis.
- *
- * @param {number} angle The angle, in radians, of the rotation. Positive angles are counterclockwise.
- * @param {Matrix3} [result] The object in which the result will be stored, if undefined a new instance will be created.
- * @returns {Matrix3} The modified result parameter, or a new Matrix3 instance if one was not provided.
- *
- * @example
- * // Rotate a point 45 degrees counterclockwise around the x-axis.
- * const p = new Cesium.Cartesian3(5, 6, 7);
- * const m = Cesium.Matrix3.fromRotationX(Cesium.Math.toRadians(45.0));
- * const rotated = Cesium.Matrix3.multiplyByVector(m, p, new Cesium.Cartesian3());
- */
- Matrix3.fromRotationX = function (angle, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.number("angle", angle);
- //>>includeEnd('debug');
- const cosAngle = Math.cos(angle);
- const sinAngle = Math.sin(angle);
- if (!defined(result)) {
- return new Matrix3(
- 1.0,
- 0.0,
- 0.0,
- 0.0,
- cosAngle,
- -sinAngle,
- 0.0,
- sinAngle,
- cosAngle
- );
- }
- result[0] = 1.0;
- result[1] = 0.0;
- result[2] = 0.0;
- result[3] = 0.0;
- result[4] = cosAngle;
- result[5] = sinAngle;
- result[6] = 0.0;
- result[7] = -sinAngle;
- result[8] = cosAngle;
- return result;
- };
- /**
- * Creates a rotation matrix around the y-axis.
- *
- * @param {number} angle The angle, in radians, of the rotation. Positive angles are counterclockwise.
- * @param {Matrix3} [result] The object in which the result will be stored, if undefined a new instance will be created.
- * @returns {Matrix3} The modified result parameter, or a new Matrix3 instance if one was not provided.
- *
- * @example
- * // Rotate a point 45 degrees counterclockwise around the y-axis.
- * const p = new Cesium.Cartesian3(5, 6, 7);
- * const m = Cesium.Matrix3.fromRotationY(Cesium.Math.toRadians(45.0));
- * const rotated = Cesium.Matrix3.multiplyByVector(m, p, new Cesium.Cartesian3());
- */
- Matrix3.fromRotationY = function (angle, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.number("angle", angle);
- //>>includeEnd('debug');
- const cosAngle = Math.cos(angle);
- const sinAngle = Math.sin(angle);
- if (!defined(result)) {
- return new Matrix3(
- cosAngle,
- 0.0,
- sinAngle,
- 0.0,
- 1.0,
- 0.0,
- -sinAngle,
- 0.0,
- cosAngle
- );
- }
- result[0] = cosAngle;
- result[1] = 0.0;
- result[2] = -sinAngle;
- result[3] = 0.0;
- result[4] = 1.0;
- result[5] = 0.0;
- result[6] = sinAngle;
- result[7] = 0.0;
- result[8] = cosAngle;
- return result;
- };
- /**
- * Creates a rotation matrix around the z-axis.
- *
- * @param {number} angle The angle, in radians, of the rotation. Positive angles are counterclockwise.
- * @param {Matrix3} [result] The object in which the result will be stored, if undefined a new instance will be created.
- * @returns {Matrix3} The modified result parameter, or a new Matrix3 instance if one was not provided.
- *
- * @example
- * // Rotate a point 45 degrees counterclockwise around the z-axis.
- * const p = new Cesium.Cartesian3(5, 6, 7);
- * const m = Cesium.Matrix3.fromRotationZ(Cesium.Math.toRadians(45.0));
- * const rotated = Cesium.Matrix3.multiplyByVector(m, p, new Cesium.Cartesian3());
- */
- Matrix3.fromRotationZ = function (angle, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.number("angle", angle);
- //>>includeEnd('debug');
- const cosAngle = Math.cos(angle);
- const sinAngle = Math.sin(angle);
- if (!defined(result)) {
- return new Matrix3(
- cosAngle,
- -sinAngle,
- 0.0,
- sinAngle,
- cosAngle,
- 0.0,
- 0.0,
- 0.0,
- 1.0
- );
- }
- result[0] = cosAngle;
- result[1] = sinAngle;
- result[2] = 0.0;
- result[3] = -sinAngle;
- result[4] = cosAngle;
- result[5] = 0.0;
- result[6] = 0.0;
- result[7] = 0.0;
- result[8] = 1.0;
- return result;
- };
- /**
- * Creates an Array from the provided Matrix3 instance.
- * The array will be in column-major order.
- *
- * @param {Matrix3} 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.
- */
- Matrix3.toArray = function (matrix, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- //>>includeEnd('debug');
- if (!defined(result)) {
- return [
- matrix[0],
- matrix[1],
- matrix[2],
- matrix[3],
- matrix[4],
- matrix[5],
- matrix[6],
- matrix[7],
- matrix[8],
- ];
- }
- result[0] = matrix[0];
- result[1] = matrix[1];
- result[2] = matrix[2];
- result[3] = matrix[3];
- result[4] = matrix[4];
- result[5] = matrix[5];
- result[6] = matrix[6];
- result[7] = matrix[7];
- result[8] = matrix[8];
- return result;
- };
- /**
- * Computes the array index of the element at the provided row and column.
- *
- * @param {number} column The zero-based index of the column.
- * @param {number} row The zero-based index of the row.
- * @returns {number} The index of the element at the provided row and column.
- *
- * @exception {DeveloperError} row must be 0, 1, or 2.
- * @exception {DeveloperError} column must be 0, 1, or 2.
- *
- * @example
- * const myMatrix = new Cesium.Matrix3();
- * const column1Row0Index = Cesium.Matrix3.getElementIndex(1, 0);
- * const column1Row0 = myMatrix[column1Row0Index]
- * myMatrix[column1Row0Index] = 10.0;
- */
- Matrix3.getElementIndex = function (column, row) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.number.greaterThanOrEquals("row", row, 0);
- Check.typeOf.number.lessThanOrEquals("row", row, 2);
- Check.typeOf.number.greaterThanOrEquals("column", column, 0);
- Check.typeOf.number.lessThanOrEquals("column", column, 2);
- //>>includeEnd('debug');
- return column * 3 + row;
- };
- /**
- * Retrieves a copy of the matrix column at the provided index as a Cartesian3 instance.
- *
- * @param {Matrix3} matrix The matrix to use.
- * @param {number} index The zero-based index of the column to retrieve.
- * @param {Cartesian3} result The object onto which to store the result.
- * @returns {Cartesian3} The modified result parameter.
- *
- * @exception {DeveloperError} index must be 0, 1, or 2.
- */
- Matrix3.getColumn = function (matrix, index, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.number.greaterThanOrEquals("index", index, 0);
- Check.typeOf.number.lessThanOrEquals("index", index, 2);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- const startIndex = index * 3;
- const x = matrix[startIndex];
- const y = matrix[startIndex + 1];
- const z = matrix[startIndex + 2];
- result.x = x;
- result.y = y;
- result.z = z;
- return result;
- };
- /**
- * Computes a new matrix that replaces the specified column in the provided matrix with the provided Cartesian3 instance.
- *
- * @param {Matrix3} matrix The matrix to use.
- * @param {number} index The zero-based index of the column to set.
- * @param {Cartesian3} cartesian The Cartesian whose values will be assigned to the specified column.
- * @param {Matrix3} result The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter.
- *
- * @exception {DeveloperError} index must be 0, 1, or 2.
- */
- Matrix3.setColumn = function (matrix, index, cartesian, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.number.greaterThanOrEquals("index", index, 0);
- Check.typeOf.number.lessThanOrEquals("index", index, 2);
- Check.typeOf.object("cartesian", cartesian);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- result = Matrix3.clone(matrix, result);
- const startIndex = index * 3;
- result[startIndex] = cartesian.x;
- result[startIndex + 1] = cartesian.y;
- result[startIndex + 2] = cartesian.z;
- return result;
- };
- /**
- * Retrieves a copy of the matrix row at the provided index as a Cartesian3 instance.
- *
- * @param {Matrix3} matrix The matrix to use.
- * @param {number} index The zero-based index of the row to retrieve.
- * @param {Cartesian3} result The object onto which to store the result.
- * @returns {Cartesian3} The modified result parameter.
- *
- * @exception {DeveloperError} index must be 0, 1, or 2.
- */
- Matrix3.getRow = function (matrix, index, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.number.greaterThanOrEquals("index", index, 0);
- Check.typeOf.number.lessThanOrEquals("index", index, 2);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- const x = matrix[index];
- const y = matrix[index + 3];
- const z = matrix[index + 6];
- result.x = x;
- result.y = y;
- result.z = z;
- return result;
- };
- /**
- * Computes a new matrix that replaces the specified row in the provided matrix with the provided Cartesian3 instance.
- *
- * @param {Matrix3} matrix The matrix to use.
- * @param {number} index The zero-based index of the row to set.
- * @param {Cartesian3} cartesian The Cartesian whose values will be assigned to the specified row.
- * @param {Matrix3} result The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter.
- *
- * @exception {DeveloperError} index must be 0, 1, or 2.
- */
- Matrix3.setRow = function (matrix, index, cartesian, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.number.greaterThanOrEquals("index", index, 0);
- Check.typeOf.number.lessThanOrEquals("index", index, 2);
- Check.typeOf.object("cartesian", cartesian);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- result = Matrix3.clone(matrix, result);
- result[index] = cartesian.x;
- result[index + 3] = cartesian.y;
- result[index + 6] = cartesian.z;
- return result;
- };
- const scaleScratch1 = new Cartesian3();
- /**
- * Computes a new matrix that replaces the scale with the provided scale.
- * This assumes the matrix is an affine transformation.
- *
- * @param {Matrix3} matrix The matrix to use.
- * @param {Cartesian3} scale The scale that replaces the scale of the provided matrix.
- * @param {Matrix3} result The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter.
- *
- * @see Matrix3.setUniformScale
- * @see Matrix3.fromScale
- * @see Matrix3.fromUniformScale
- * @see Matrix3.multiplyByScale
- * @see Matrix3.multiplyByUniformScale
- * @see Matrix3.getScale
- */
- Matrix3.setScale = function (matrix, scale, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.object("scale", scale);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- const existingScale = Matrix3.getScale(matrix, scaleScratch1);
- const scaleRatioX = scale.x / existingScale.x;
- const scaleRatioY = scale.y / existingScale.y;
- const scaleRatioZ = scale.z / existingScale.z;
- result[0] = matrix[0] * scaleRatioX;
- result[1] = matrix[1] * scaleRatioX;
- result[2] = matrix[2] * scaleRatioX;
- result[3] = matrix[3] * scaleRatioY;
- result[4] = matrix[4] * scaleRatioY;
- result[5] = matrix[5] * scaleRatioY;
- result[6] = matrix[6] * scaleRatioZ;
- result[7] = matrix[7] * scaleRatioZ;
- result[8] = matrix[8] * scaleRatioZ;
- return result;
- };
- const scaleScratch2 = new Cartesian3();
- /**
- * Computes a new matrix that replaces the scale with the provided uniform scale.
- * This assumes the matrix is an affine transformation.
- *
- * @param {Matrix3} matrix The matrix to use.
- * @param {number} scale The uniform scale that replaces the scale of the provided matrix.
- * @param {Matrix3} result The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter.
- *
- * @see Matrix3.setScale
- * @see Matrix3.fromScale
- * @see Matrix3.fromUniformScale
- * @see Matrix3.multiplyByScale
- * @see Matrix3.multiplyByUniformScale
- * @see Matrix3.getScale
- */
- Matrix3.setUniformScale = function (matrix, scale, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.number("scale", scale);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- const existingScale = Matrix3.getScale(matrix, scaleScratch2);
- const scaleRatioX = scale / existingScale.x;
- const scaleRatioY = scale / existingScale.y;
- const scaleRatioZ = scale / existingScale.z;
- result[0] = matrix[0] * scaleRatioX;
- result[1] = matrix[1] * scaleRatioX;
- result[2] = matrix[2] * scaleRatioX;
- result[3] = matrix[3] * scaleRatioY;
- result[4] = matrix[4] * scaleRatioY;
- result[5] = matrix[5] * scaleRatioY;
- result[6] = matrix[6] * scaleRatioZ;
- result[7] = matrix[7] * scaleRatioZ;
- result[8] = matrix[8] * scaleRatioZ;
- return result;
- };
- const scratchColumn = new Cartesian3();
- /**
- * Extracts the non-uniform scale assuming the matrix is an affine transformation.
- *
- * @param {Matrix3} matrix The matrix.
- * @param {Cartesian3} result The object onto which to store the result.
- * @returns {Cartesian3} The modified result parameter.
- *
- * @see Matrix3.multiplyByScale
- * @see Matrix3.multiplyByUniformScale
- * @see Matrix3.fromScale
- * @see Matrix3.fromUniformScale
- * @see Matrix3.setScale
- * @see Matrix3.setUniformScale
- */
- Matrix3.getScale = function (matrix, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- result.x = Cartesian3.magnitude(
- Cartesian3.fromElements(matrix[0], matrix[1], matrix[2], scratchColumn)
- );
- result.y = Cartesian3.magnitude(
- Cartesian3.fromElements(matrix[3], matrix[4], matrix[5], scratchColumn)
- );
- result.z = Cartesian3.magnitude(
- Cartesian3.fromElements(matrix[6], matrix[7], matrix[8], scratchColumn)
- );
- return result;
- };
- const scaleScratch3 = new Cartesian3();
- /**
- * Computes the maximum scale assuming the matrix is an affine transformation.
- * The maximum scale is the maximum length of the column vectors.
- *
- * @param {Matrix3} matrix The matrix.
- * @returns {number} The maximum scale.
- */
- Matrix3.getMaximumScale = function (matrix) {
- Matrix3.getScale(matrix, scaleScratch3);
- return Cartesian3.maximumComponent(scaleScratch3);
- };
- const scaleScratch4 = new Cartesian3();
- /**
- * Sets the rotation assuming the matrix is an affine transformation.
- *
- * @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
- */
- Matrix3.setRotation = function (matrix, rotation, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- const scale = Matrix3.getScale(matrix, scaleScratch4);
- result[0] = rotation[0] * scale.x;
- result[1] = rotation[1] * scale.x;
- result[2] = rotation[2] * scale.x;
- result[3] = rotation[3] * scale.y;
- result[4] = rotation[4] * scale.y;
- result[5] = rotation[5] * scale.y;
- result[6] = rotation[6] * scale.z;
- result[7] = rotation[7] * scale.z;
- result[8] = rotation[8] * scale.z;
- return result;
- };
- const scaleScratch5 = new Cartesian3();
- /**
- * Extracts the rotation matrix assuming the matrix is an affine transformation.
- *
- * @param {Matrix3} matrix The matrix.
- * @param {Matrix3} result The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter.
- *
- * @see Matrix3.setRotation
- */
- Matrix3.getRotation = function (matrix, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- const scale = Matrix3.getScale(matrix, scaleScratch5);
- result[0] = matrix[0] / scale.x;
- result[1] = matrix[1] / scale.x;
- result[2] = matrix[2] / scale.x;
- result[3] = matrix[3] / scale.y;
- result[4] = matrix[4] / scale.y;
- result[5] = matrix[5] / scale.y;
- result[6] = matrix[6] / scale.z;
- result[7] = matrix[7] / scale.z;
- result[8] = matrix[8] / scale.z;
- return result;
- };
- /**
- * Computes the product of two matrices.
- *
- * @param {Matrix3} left The first matrix.
- * @param {Matrix3} right The second matrix.
- * @param {Matrix3} result The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter.
- */
- Matrix3.multiply = function (left, right, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("left", left);
- Check.typeOf.object("right", right);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- const column0Row0 =
- left[0] * right[0] + left[3] * right[1] + left[6] * right[2];
- const column0Row1 =
- left[1] * right[0] + left[4] * right[1] + left[7] * right[2];
- const column0Row2 =
- left[2] * right[0] + left[5] * right[1] + left[8] * right[2];
- const column1Row0 =
- left[0] * right[3] + left[3] * right[4] + left[6] * right[5];
- const column1Row1 =
- left[1] * right[3] + left[4] * right[4] + left[7] * right[5];
- const column1Row2 =
- left[2] * right[3] + left[5] * right[4] + left[8] * right[5];
- const column2Row0 =
- left[0] * right[6] + left[3] * right[7] + left[6] * right[8];
- const column2Row1 =
- left[1] * right[6] + left[4] * right[7] + left[7] * right[8];
- const column2Row2 =
- left[2] * right[6] + left[5] * right[7] + left[8] * right[8];
- result[0] = column0Row0;
- result[1] = column0Row1;
- result[2] = column0Row2;
- result[3] = column1Row0;
- result[4] = column1Row1;
- result[5] = column1Row2;
- result[6] = column2Row0;
- result[7] = column2Row1;
- result[8] = column2Row2;
- return result;
- };
- /**
- * Computes the sum of two matrices.
- *
- * @param {Matrix3} left The first matrix.
- * @param {Matrix3} right The second matrix.
- * @param {Matrix3} result The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter.
- */
- Matrix3.add = function (left, right, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("left", left);
- Check.typeOf.object("right", right);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- result[0] = left[0] + right[0];
- result[1] = left[1] + right[1];
- result[2] = left[2] + right[2];
- result[3] = left[3] + right[3];
- result[4] = left[4] + right[4];
- result[5] = left[5] + right[5];
- result[6] = left[6] + right[6];
- result[7] = left[7] + right[7];
- result[8] = left[8] + right[8];
- return result;
- };
- /**
- * Computes the difference of two matrices.
- *
- * @param {Matrix3} left The first matrix.
- * @param {Matrix3} right The second matrix.
- * @param {Matrix3} result The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter.
- */
- Matrix3.subtract = function (left, right, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("left", left);
- Check.typeOf.object("right", right);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- result[0] = left[0] - right[0];
- result[1] = left[1] - right[1];
- result[2] = left[2] - right[2];
- result[3] = left[3] - right[3];
- result[4] = left[4] - right[4];
- result[5] = left[5] - right[5];
- result[6] = left[6] - right[6];
- result[7] = left[7] - right[7];
- result[8] = left[8] - right[8];
- return result;
- };
- /**
- * Computes the product of a matrix and a column vector.
- *
- * @param {Matrix3} matrix The matrix.
- * @param {Cartesian3} cartesian The column.
- * @param {Cartesian3} result The object onto which to store the result.
- * @returns {Cartesian3} The modified result parameter.
- */
- Matrix3.multiplyByVector = function (matrix, cartesian, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.object("cartesian", cartesian);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- const vX = cartesian.x;
- const vY = cartesian.y;
- const vZ = cartesian.z;
- const x = matrix[0] * vX + matrix[3] * vY + matrix[6] * vZ;
- const y = matrix[1] * vX + matrix[4] * vY + matrix[7] * vZ;
- const z = matrix[2] * vX + matrix[5] * vY + matrix[8] * vZ;
- result.x = x;
- result.y = y;
- result.z = z;
- return result;
- };
- /**
- * Computes the product of a matrix and a scalar.
- *
- * @param {Matrix3} matrix The matrix.
- * @param {number} scalar The number to multiply by.
- * @param {Matrix3} result The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter.
- */
- Matrix3.multiplyByScalar = function (matrix, scalar, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.number("scalar", scalar);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- result[0] = matrix[0] * scalar;
- result[1] = matrix[1] * scalar;
- result[2] = matrix[2] * scalar;
- result[3] = matrix[3] * scalar;
- result[4] = matrix[4] * scalar;
- result[5] = matrix[5] * scalar;
- result[6] = matrix[6] * scalar;
- result[7] = matrix[7] * scalar;
- result[8] = matrix[8] * scalar;
- return 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 {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.
- *
- *
- * @example
- * // Instead of Cesium.Matrix3.multiply(m, Cesium.Matrix3.fromScale(scale), m);
- * Cesium.Matrix3.multiplyByScale(m, scale, m);
- *
- * @see Matrix3.multiplyByUniformScale
- * @see Matrix3.fromScale
- * @see Matrix3.fromUniformScale
- * @see Matrix3.setScale
- * @see Matrix3.setUniformScale
- * @see Matrix3.getScale
- */
- Matrix3.multiplyByScale = function (matrix, scale, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.object("scale", scale);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- result[0] = matrix[0] * scale.x;
- result[1] = matrix[1] * scale.x;
- result[2] = matrix[2] * scale.x;
- result[3] = matrix[3] * scale.y;
- result[4] = matrix[4] * scale.y;
- result[5] = matrix[5] * scale.y;
- result[6] = matrix[6] * scale.z;
- result[7] = matrix[7] * scale.z;
- result[8] = matrix[8] * scale.z;
- return result;
- };
- /**
- * Computes the product of a matrix times a uniform scale, as if the scale were a scale matrix.
- *
- * @param {Matrix3} matrix The matrix on the left-hand side.
- * @param {number} scale The uniform scale on the right-hand side.
- * @param {Matrix3} result The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter.
- *
- * @example
- * // Instead of Cesium.Matrix3.multiply(m, Cesium.Matrix3.fromUniformScale(scale), m);
- * Cesium.Matrix3.multiplyByUniformScale(m, scale, m);
- *
- * @see Matrix3.multiplyByScale
- * @see Matrix3.fromScale
- * @see Matrix3.fromUniformScale
- * @see Matrix3.setScale
- * @see Matrix3.setUniformScale
- * @see Matrix3.getScale
- */
- Matrix3.multiplyByUniformScale = function (matrix, scale, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.number("scale", scale);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- result[0] = matrix[0] * scale;
- result[1] = matrix[1] * scale;
- result[2] = matrix[2] * scale;
- result[3] = matrix[3] * scale;
- result[4] = matrix[4] * scale;
- result[5] = matrix[5] * scale;
- result[6] = matrix[6] * scale;
- result[7] = matrix[7] * scale;
- result[8] = matrix[8] * scale;
- return result;
- };
- /**
- * Creates a negated copy of the provided matrix.
- *
- * @param {Matrix3} matrix The matrix to negate.
- * @param {Matrix3} result The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter.
- */
- Matrix3.negate = function (matrix, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- result[0] = -matrix[0];
- result[1] = -matrix[1];
- result[2] = -matrix[2];
- result[3] = -matrix[3];
- result[4] = -matrix[4];
- result[5] = -matrix[5];
- result[6] = -matrix[6];
- result[7] = -matrix[7];
- result[8] = -matrix[8];
- return result;
- };
- /**
- * Computes the transpose of the provided matrix.
- *
- * @param {Matrix3} matrix The matrix to transpose.
- * @param {Matrix3} result The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter.
- */
- Matrix3.transpose = function (matrix, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- const column0Row0 = matrix[0];
- const column0Row1 = matrix[3];
- const column0Row2 = matrix[6];
- const column1Row0 = matrix[1];
- const column1Row1 = matrix[4];
- const column1Row2 = matrix[7];
- const column2Row0 = matrix[2];
- const column2Row1 = matrix[5];
- const column2Row2 = matrix[8];
- result[0] = column0Row0;
- result[1] = column0Row1;
- result[2] = column0Row2;
- result[3] = column1Row0;
- result[4] = column1Row1;
- result[5] = column1Row2;
- result[6] = column2Row0;
- result[7] = column2Row1;
- result[8] = column2Row2;
- return result;
- };
- function computeFrobeniusNorm(matrix) {
- let norm = 0.0;
- for (let i = 0; i < 9; ++i) {
- const temp = matrix[i];
- norm += temp * temp;
- }
- return Math.sqrt(norm);
- }
- const rowVal = [1, 0, 0];
- const colVal = [2, 2, 1];
- function offDiagonalFrobeniusNorm(matrix) {
- // Computes the "off-diagonal" Frobenius norm.
- // Assumes matrix is symmetric.
- let norm = 0.0;
- for (let i = 0; i < 3; ++i) {
- const temp = matrix[Matrix3.getElementIndex(colVal[i], rowVal[i])];
- norm += 2.0 * temp * temp;
- }
- return Math.sqrt(norm);
- }
- function shurDecomposition(matrix, result) {
- // This routine was created based upon Matrix Computations, 3rd ed., by Golub and Van Loan,
- // section 8.4.2 The 2by2 Symmetric Schur Decomposition.
- //
- // The routine takes a matrix, which is assumed to be symmetric, and
- // finds the largest off-diagonal term, and then creates
- // a matrix (result) which can be used to help reduce it
- const tolerance = CesiumMath.EPSILON15;
- let maxDiagonal = 0.0;
- let rotAxis = 1;
- // find pivot (rotAxis) based on max diagonal of matrix
- for (let i = 0; i < 3; ++i) {
- const temp = Math.abs(
- matrix[Matrix3.getElementIndex(colVal[i], rowVal[i])]
- );
- if (temp > maxDiagonal) {
- rotAxis = i;
- maxDiagonal = temp;
- }
- }
- let c = 1.0;
- let s = 0.0;
- const p = rowVal[rotAxis];
- const q = colVal[rotAxis];
- if (Math.abs(matrix[Matrix3.getElementIndex(q, p)]) > tolerance) {
- const qq = matrix[Matrix3.getElementIndex(q, q)];
- const pp = matrix[Matrix3.getElementIndex(p, p)];
- const qp = matrix[Matrix3.getElementIndex(q, p)];
- const tau = (qq - pp) / 2.0 / qp;
- let t;
- if (tau < 0.0) {
- t = -1.0 / (-tau + Math.sqrt(1.0 + tau * tau));
- } else {
- t = 1.0 / (tau + Math.sqrt(1.0 + tau * tau));
- }
- c = 1.0 / Math.sqrt(1.0 + t * t);
- s = t * c;
- }
- result = Matrix3.clone(Matrix3.IDENTITY, result);
- result[Matrix3.getElementIndex(p, p)] = result[
- Matrix3.getElementIndex(q, q)
- ] = c;
- result[Matrix3.getElementIndex(q, p)] = s;
- result[Matrix3.getElementIndex(p, q)] = -s;
- return result;
- }
- const jMatrix = new Matrix3();
- const jMatrixTranspose = new Matrix3();
- /**
- * Computes the eigenvectors and eigenvalues of a symmetric matrix.
- * <p>
- * Returns a diagonal matrix and unitary matrix such that:
- * <code>matrix = unitary matrix * diagonal matrix * transpose(unitary matrix)</code>
- * </p>
- * <p>
- * The values along the diagonal of the diagonal matrix are the eigenvalues. The columns
- * of the unitary matrix are the corresponding eigenvectors.
- * </p>
- *
- * @param {Matrix3} matrix The matrix to decompose into diagonal and unitary matrix. Expected to be symmetric.
- * @param {object} [result] An object with unitary and diagonal properties which are matrices onto which to store the result.
- * @returns {object} An object with unitary and diagonal properties which are the unitary and diagonal matrices, respectively.
- *
- * @example
- * const a = //... symetric matrix
- * const result = {
- * unitary : new Cesium.Matrix3(),
- * diagonal : new Cesium.Matrix3()
- * };
- * Cesium.Matrix3.computeEigenDecomposition(a, result);
- *
- * const unitaryTranspose = Cesium.Matrix3.transpose(result.unitary, new Cesium.Matrix3());
- * const b = Cesium.Matrix3.multiply(result.unitary, result.diagonal, new Cesium.Matrix3());
- * Cesium.Matrix3.multiply(b, unitaryTranspose, b); // b is now equal to a
- *
- * const lambda = Cesium.Matrix3.getColumn(result.diagonal, 0, new Cesium.Cartesian3()).x; // first eigenvalue
- * const v = Cesium.Matrix3.getColumn(result.unitary, 0, new Cesium.Cartesian3()); // first eigenvector
- * const c = Cesium.Cartesian3.multiplyByScalar(v, lambda, new Cesium.Cartesian3()); // equal to Cesium.Matrix3.multiplyByVector(a, v)
- */
- Matrix3.computeEigenDecomposition = function (matrix, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- //>>includeEnd('debug');
- // This routine was created based upon Matrix Computations, 3rd ed., by Golub and Van Loan,
- // section 8.4.3 The Classical Jacobi Algorithm
- const tolerance = CesiumMath.EPSILON20;
- const maxSweeps = 10;
- let count = 0;
- let sweep = 0;
- if (!defined(result)) {
- result = {};
- }
- const unitaryMatrix = (result.unitary = Matrix3.clone(
- Matrix3.IDENTITY,
- result.unitary
- ));
- const diagMatrix = (result.diagonal = Matrix3.clone(matrix, result.diagonal));
- const epsilon = tolerance * computeFrobeniusNorm(diagMatrix);
- while (sweep < maxSweeps && offDiagonalFrobeniusNorm(diagMatrix) > epsilon) {
- shurDecomposition(diagMatrix, jMatrix);
- Matrix3.transpose(jMatrix, jMatrixTranspose);
- Matrix3.multiply(diagMatrix, jMatrix, diagMatrix);
- Matrix3.multiply(jMatrixTranspose, diagMatrix, diagMatrix);
- Matrix3.multiply(unitaryMatrix, jMatrix, unitaryMatrix);
- if (++count > 2) {
- ++sweep;
- count = 0;
- }
- }
- return result;
- };
- /**
- * Computes a matrix, which contains the absolute (unsigned) values of the provided matrix's elements.
- *
- * @param {Matrix3} matrix The matrix with signed elements.
- * @param {Matrix3} result The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter.
- */
- Matrix3.abs = function (matrix, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- result[0] = Math.abs(matrix[0]);
- result[1] = Math.abs(matrix[1]);
- result[2] = Math.abs(matrix[2]);
- result[3] = Math.abs(matrix[3]);
- result[4] = Math.abs(matrix[4]);
- result[5] = Math.abs(matrix[5]);
- result[6] = Math.abs(matrix[6]);
- result[7] = Math.abs(matrix[7]);
- result[8] = Math.abs(matrix[8]);
- return result;
- };
- /**
- * Computes the determinant of the provided matrix.
- *
- * @param {Matrix3} matrix The matrix to use.
- * @returns {number} The value of the determinant of the matrix.
- */
- Matrix3.determinant = function (matrix) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- //>>includeEnd('debug');
- const m11 = matrix[0];
- const m21 = matrix[3];
- const m31 = matrix[6];
- const m12 = matrix[1];
- const m22 = matrix[4];
- const m32 = matrix[7];
- const m13 = matrix[2];
- const m23 = matrix[5];
- const m33 = matrix[8];
- return (
- m11 * (m22 * m33 - m23 * m32) +
- m12 * (m23 * m31 - m21 * m33) +
- m13 * (m21 * m32 - m22 * m31)
- );
- };
- /**
- * Computes the inverse of the provided matrix.
- *
- * @param {Matrix3} matrix The matrix to invert.
- * @param {Matrix3} result The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter.
- *
- * @exception {DeveloperError} matrix is not invertible.
- */
- Matrix3.inverse = function (matrix, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- const m11 = matrix[0];
- const m21 = matrix[1];
- const m31 = matrix[2];
- const m12 = matrix[3];
- const m22 = matrix[4];
- const m32 = matrix[5];
- const m13 = matrix[6];
- const m23 = matrix[7];
- const m33 = matrix[8];
- const determinant = Matrix3.determinant(matrix);
- //>>includeStart('debug', pragmas.debug);
- if (Math.abs(determinant) <= CesiumMath.EPSILON15) {
- throw new DeveloperError("matrix is not invertible");
- }
- //>>includeEnd('debug');
- result[0] = m22 * m33 - m23 * m32;
- result[1] = m23 * m31 - m21 * m33;
- result[2] = m21 * m32 - m22 * m31;
- result[3] = m13 * m32 - m12 * m33;
- result[4] = m11 * m33 - m13 * m31;
- result[5] = m12 * m31 - m11 * m32;
- result[6] = m12 * m23 - m13 * m22;
- result[7] = m13 * m21 - m11 * m23;
- result[8] = m11 * m22 - m12 * m21;
- const scale = 1.0 / determinant;
- return Matrix3.multiplyByScalar(result, scale, result);
- };
- const scratchTransposeMatrix = new Matrix3();
- /**
- * Computes the inverse transpose of a matrix.
- *
- * @param {Matrix3} matrix The matrix to transpose and invert.
- * @param {Matrix3} result The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter.
- */
- Matrix3.inverseTranspose = function (matrix, result) {
- //>>includeStart('debug', pragmas.debug);
- Check.typeOf.object("matrix", matrix);
- Check.typeOf.object("result", result);
- //>>includeEnd('debug');
- return Matrix3.inverse(
- Matrix3.transpose(matrix, scratchTransposeMatrix),
- result
- );
- };
- /**
- * Compares the provided matrices componentwise and returns
- * <code>true</code> if they are equal, <code>false</code> otherwise.
- *
- * @param {Matrix3} [left] The first matrix.
- * @param {Matrix3} [right] The second matrix.
- * @returns {boolean} <code>true</code> if left and right are equal, <code>false</code> otherwise.
- */
- Matrix3.equals = function (left, right) {
- return (
- left === right ||
- (defined(left) &&
- defined(right) &&
- left[0] === right[0] &&
- left[1] === right[1] &&
- left[2] === right[2] &&
- left[3] === right[3] &&
- left[4] === right[4] &&
- left[5] === right[5] &&
- left[6] === right[6] &&
- left[7] === right[7] &&
- left[8] === right[8])
- );
- };
- /**
- * Compares the provided matrices componentwise and returns
- * <code>true</code> if they are within the provided epsilon,
- * <code>false</code> otherwise.
- *
- * @param {Matrix3} [left] The first matrix.
- * @param {Matrix3} [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.
- */
- Matrix3.equalsEpsilon = function (left, right, epsilon) {
- epsilon = defaultValue(epsilon, 0);
- return (
- left === right ||
- (defined(left) &&
- defined(right) &&
- Math.abs(left[0] - right[0]) <= epsilon &&
- Math.abs(left[1] - right[1]) <= epsilon &&
- Math.abs(left[2] - right[2]) <= epsilon &&
- Math.abs(left[3] - right[3]) <= epsilon &&
- Math.abs(left[4] - right[4]) <= epsilon &&
- Math.abs(left[5] - right[5]) <= epsilon &&
- Math.abs(left[6] - right[6]) <= epsilon &&
- Math.abs(left[7] - right[7]) <= epsilon &&
- Math.abs(left[8] - right[8]) <= epsilon)
- );
- };
- /**
- * An immutable Matrix3 instance initialized to the identity matrix.
- *
- * @type {Matrix3}
- * @constant
- */
- Matrix3.IDENTITY = Object.freeze(
- new Matrix3(1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 1.0)
- );
- /**
- * An immutable Matrix3 instance initialized to the zero matrix.
- *
- * @type {Matrix3}
- * @constant
- */
- Matrix3.ZERO = Object.freeze(
- new Matrix3(0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0)
- );
- /**
- * The index into Matrix3 for column 0, row 0.
- *
- * @type {number}
- * @constant
- */
- Matrix3.COLUMN0ROW0 = 0;
- /**
- * The index into Matrix3 for column 0, row 1.
- *
- * @type {number}
- * @constant
- */
- Matrix3.COLUMN0ROW1 = 1;
- /**
- * The index into Matrix3 for column 0, row 2.
- *
- * @type {number}
- * @constant
- */
- Matrix3.COLUMN0ROW2 = 2;
- /**
- * The index into Matrix3 for column 1, row 0.
- *
- * @type {number}
- * @constant
- */
- Matrix3.COLUMN1ROW0 = 3;
- /**
- * The index into Matrix3 for column 1, row 1.
- *
- * @type {number}
- * @constant
- */
- Matrix3.COLUMN1ROW1 = 4;
- /**
- * The index into Matrix3 for column 1, row 2.
- *
- * @type {number}
- * @constant
- */
- Matrix3.COLUMN1ROW2 = 5;
- /**
- * The index into Matrix3 for column 2, row 0.
- *
- * @type {number}
- * @constant
- */
- Matrix3.COLUMN2ROW0 = 6;
- /**
- * The index into Matrix3 for column 2, row 1.
- *
- * @type {number}
- * @constant
- */
- Matrix3.COLUMN2ROW1 = 7;
- /**
- * The index into Matrix3 for column 2, row 2.
- *
- * @type {number}
- * @constant
- */
- Matrix3.COLUMN2ROW2 = 8;
- Object.defineProperties(Matrix3.prototype, {
- /**
- * Gets the number of items in the collection.
- * @memberof Matrix3.prototype
- *
- * @type {number}
- */
- length: {
- get: function () {
- return Matrix3.packedLength;
- },
- },
- });
- /**
- * Duplicates the provided Matrix3 instance.
- *
- * @param {Matrix3} [result] The object onto which to store the result.
- * @returns {Matrix3} The modified result parameter or a new Matrix3 instance if one was not provided.
- */
- Matrix3.prototype.clone = function (result) {
- return Matrix3.clone(this, result);
- };
- /**
- * Compares this matrix to the provided matrix componentwise and returns
- * <code>true</code> if they are equal, <code>false</code> otherwise.
- *
- * @param {Matrix3} [right] The right hand side matrix.
- * @returns {boolean} <code>true</code> if they are equal, <code>false</code> otherwise.
- */
- Matrix3.prototype.equals = function (right) {
- return Matrix3.equals(this, right);
- };
- /**
- * @private
- */
- Matrix3.equalsArray = function (matrix, array, offset) {
- return (
- matrix[0] === array[offset] &&
- matrix[1] === array[offset + 1] &&
- matrix[2] === array[offset + 2] &&
- matrix[3] === array[offset + 3] &&
- matrix[4] === array[offset + 4] &&
- matrix[5] === array[offset + 5] &&
- matrix[6] === array[offset + 6] &&
- matrix[7] === array[offset + 7] &&
- matrix[8] === array[offset + 8]
- );
- };
- /**
- * Compares this matrix to the provided matrix componentwise and returns
- * <code>true</code> if they are within the provided epsilon,
- * <code>false</code> otherwise.
- *
- * @param {Matrix3} [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.
- */
- Matrix3.prototype.equalsEpsilon = function (right, epsilon) {
- return Matrix3.equalsEpsilon(this, right, epsilon);
- };
- /**
- * Creates a string representing this Matrix with each row being
- * on a separate line and in the format '(column0, column1, column2)'.
- *
- * @returns {string} A string representing the provided Matrix with each row being on a separate line and in the format '(column0, column1, column2)'.
- */
- Matrix3.prototype.toString = function () {
- return (
- `(${this[0]}, ${this[3]}, ${this[6]})\n` +
- `(${this[1]}, ${this[4]}, ${this[7]})\n` +
- `(${this[2]}, ${this[5]}, ${this[8]})`
- );
- };
- export default Matrix3;
|