rc-js-util

Version:

A collection of TS and C++ utilities to help writing performant and correct applications, achieved through strict typing and (removable) invariant checking.

phuhgh.github.io/js-util/rc-js-util.html

phuhgh/js-util

632 lines (270 loc) • 6.62 kB

Markdown

[Home](./index.md) > [rc-js-util](./rc-js-util.md) > [Mat2](./rc-js-util.mat2.md) ## Mat2 class Row major 2x2 matrix. **Signature:** ```typescript export declare abstract class Mat2<TArray extends TTypedArray> extends ATypedArrayTuple<4, TArray> ``` **Extends:** [ATypedArrayTuple](./rc-js-util.atypedarraytuple.md)<4, TArray> ## Remarks See static properties for constructors. Instances are not an extension of this class, but of the static members. ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td> ["0"](./rc-js-util.mat2._0_.md) </td><td> </td><td> number </td><td> c1r1 </td></tr> <tr><td> ["1"](./rc-js-util.mat2._1_.md) </td><td> </td><td> number </td><td> c2r1 </td></tr> <tr><td> ["2"](./rc-js-util.mat2._2_.md) </td><td> </td><td> number </td><td> c2r2 </td></tr> <tr><td> ["3"](./rc-js-util.mat2._3_.md) </td><td> </td><td> number </td><td> c2r2 </td></tr> <tr><td> [constructor](./rc-js-util.mat2.constructor.md) </td><td> </td><td> [IMat2Ctor](./rc-js-util.imat2ctor.md)<TArray> </td><td> </td></tr> <tr><td> [constructors](./rc-js-util.mat2.constructors.md) </td><td> `protected` `static` </td><td> Map<import("../t-typed-array-ctor.js").[TFullSetTypedArrayCtor](./rc-js-util.tfullsettypedarrayctor.md), Function> </td><td> </td></tr> <tr><td> [f32](./rc-js-util.mat2.f32.md) </td><td> `static` </td><td> [IMat2Ctor](./rc-js-util.imat2ctor.md)<Float32Array> </td><td> </td></tr> <tr><td> [f64](./rc-js-util.mat2.f64.md) </td><td> `static` </td><td> [IMat2Ctor](./rc-js-util.imat2ctor.md)<Float64Array> </td><td> </td></tr> <tr><td> [i16](./rc-js-util.mat2.i16.md) </td><td> `static` </td><td> [IMat2Ctor](./rc-js-util.imat2ctor.md)<Int16Array> </td><td> </td></tr> <tr><td> [i32](./rc-js-util.mat2.i32.md) </td><td> `static` </td><td> [IMat2Ctor](./rc-js-util.imat2ctor.md)<Int32Array> </td><td> </td></tr> <tr><td> [i64](./rc-js-util.mat2.i64.md) </td><td> `static` </td><td> null </td><td> </td></tr> <tr><td> [i8](./rc-js-util.mat2.i8.md) </td><td> `static` </td><td> [IMat2Ctor](./rc-js-util.imat2ctor.md)<Int8Array> </td><td> </td></tr> <tr><td> [TTypeGuardMat2](./rc-js-util.mat2.ttypeguardmat2.md) </td><td> `protected` </td><td> true </td><td> </td></tr> <tr><td> [u16](./rc-js-util.mat2.u16.md) </td><td> `static` </td><td> [IMat2Ctor](./rc-js-util.imat2ctor.md)<Uint16Array> </td><td> </td></tr> <tr><td> [u32](./rc-js-util.mat2.u32.md) </td><td> `static` </td><td> [IMat2Ctor](./rc-js-util.imat2ctor.md)<Uint32Array> </td><td> </td></tr> <tr><td> [u64](./rc-js-util.mat2.u64.md) </td><td> `static` </td><td> null </td><td> </td></tr> <tr><td> [u8](./rc-js-util.mat2.u8.md) </td><td> `static` </td><td> [IMat2Ctor](./rc-js-util.imat2ctor.md)<Uint8Array> </td><td> </td></tr> <tr><td> [u8c](./rc-js-util.mat2.u8c.md) </td><td> `static` </td><td> [IMat2Ctor](./rc-js-util.imat2ctor.md)<Uint8ClampedArray> </td><td> </td></tr> </tbody></table> ## Methods <table><thead><tr><th> Method </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td> [castToBaseType()](./rc-js-util.mat2.casttobasetype.md) </td><td> </td><td> Although the typed array tuples extend a typed array, they are not structurally compatible. This function returns the argument passed without modification but cast as the underlying storage type, e.g. Float32Array. </td></tr> <tr><td> [copyFromBuffer(\_memoryDataView, \_pointer, \_littleEndian)](./rc-js-util.mat2.copyfrombuffer.md) </td><td> </td><td> If endianness is not supplied the platform's endianness will be used. </td></tr> <tr><td> [copyToBuffer(\_memoryDataView, \_pointer, \_littleEndian)](./rc-js-util.mat2.copytobuffer.md) </td><td> </td><td> If endianness is not supplied the platform's endianness will be used. </td></tr> <tr><td> [getCtor(ctor)](./rc-js-util.mat2.getctor.md) </td><td> `static` </td><td> </td></tr> <tr><td> [getLoggableValue()](./rc-js-util.mat2.getloggablevalue.md) </td><td> </td><td> </td></tr> <tr><td> [getRow(\_row, \_writeTo)](./rc-js-util.mat2.getrow.md) </td><td> </td><td> </td></tr> <tr><td> [getValueAt(\_column, \_row)](./rc-js-util.mat2.getvalueat.md) </td><td> </td><td> </td></tr> <tr><td> [getVec2MultiplyX(\_x)](./rc-js-util.mat2.getvec2multiplyx.md) </td><td> </td><td> </td></tr> <tr><td> [isEqualTo(\_other)](./rc-js-util.mat2.isequalto.md) </td><td> </td><td> Component-wise equals. </td></tr> <tr><td> [multiplyMat2(\_mat, \_result)](./rc-js-util.mat2.multiplymat2.md) </td><td> </td><td> </td></tr> <tr><td> [scalarAdd(\_value, \_result)](./rc-js-util.mat2.scalaradd.md) </td><td> </td><td> </td></tr> <tr><td> [scalarMultiply(\_value, \_result)](./rc-js-util.mat2.scalarmultiply.md) </td><td> </td><td> </td></tr> <tr><td> [setIdentityMatrix()](./rc-js-util.mat2.setidentitymatrix.md) </td><td> </td><td> </td></tr> <tr><td> [setRow(\_row, \_writeFrom)](./rc-js-util.mat2.setrow.md) </td><td> </td><td> </td></tr> <tr><td> [setScalingMatrix(\_scalingFactor)](./rc-js-util.mat2.setscalingmatrix.md) </td><td> </td><td> </td></tr> <tr><td> [setTranslationMatrix(\_translation)](./rc-js-util.mat2.settranslationmatrix.md) </td><td> </td><td> </td></tr> <tr><td> [setValueAt(\_column, \_row, \_value)](./rc-js-util.mat2.setvalueat.md) </td><td> </td><td> </td></tr> <tr><td> [update(\_args)](./rc-js-util.mat2.update.md) </td><td> </td><td> </td></tr> </tbody></table>