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.
776 lines (331 loc) • 7.24 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [rc-js-util](./rc-js-util.md) > [Mat4](./rc-js-util.mat4.md)
## Mat4 class
Row major 4x4 matrix.
**Signature:**
```typescript
export declare abstract class Mat4<TArray extends TTypedArray> extends ATypedArrayTuple<16, TArray>
```
**Extends:** [ATypedArrayTuple](./rc-js-util.atypedarraytuple.md)<!-- --><16, 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.mat4._0_.md)
</td><td>
</td><td>
number
</td><td>
c1r1
</td></tr>
<tr><td>
["1"](./rc-js-util.mat4._1_.md)
</td><td>
</td><td>
number
</td><td>
c2r1
</td></tr>
<tr><td>
["10"](./rc-js-util.mat4._10_.md)
</td><td>
</td><td>
number
</td><td>
c3r3
</td></tr>
<tr><td>
["11"](./rc-js-util.mat4._11_.md)
</td><td>
</td><td>
number
</td><td>
c4r3
</td></tr>
<tr><td>
["12"](./rc-js-util.mat4._12_.md)
</td><td>
</td><td>
number
</td><td>
c1r4
</td></tr>
<tr><td>
["13"](./rc-js-util.mat4._13_.md)
</td><td>
</td><td>
number
</td><td>
c2r4
</td></tr>
<tr><td>
["14"](./rc-js-util.mat4._14_.md)
</td><td>
</td><td>
number
</td><td>
c3r4
</td></tr>
<tr><td>
["15"](./rc-js-util.mat4._15_.md)
</td><td>
</td><td>
number
</td><td>
c4r4
</td></tr>
<tr><td>
["2"](./rc-js-util.mat4._2_.md)
</td><td>
</td><td>
number
</td><td>
c3r1
</td></tr>
<tr><td>
["3"](./rc-js-util.mat4._3_.md)
</td><td>
</td><td>
number
</td><td>
c4r1
</td></tr>
<tr><td>
["4"](./rc-js-util.mat4._4_.md)
</td><td>
</td><td>
number
</td><td>
c1r2
</td></tr>
<tr><td>
["5"](./rc-js-util.mat4._5_.md)
</td><td>
</td><td>
number
</td><td>
c2r2
</td></tr>
<tr><td>
["6"](./rc-js-util.mat4._6_.md)
</td><td>
</td><td>
number
</td><td>
c3r2
</td></tr>
<tr><td>
["7"](./rc-js-util.mat4._7_.md)
</td><td>
</td><td>
number
</td><td>
c4r2
</td></tr>
<tr><td>
["8"](./rc-js-util.mat4._8_.md)
</td><td>
</td><td>
number
</td><td>
c1r3
</td></tr>
<tr><td>
["9"](./rc-js-util.mat4._9_.md)
</td><td>
</td><td>
number
</td><td>
c2r3
</td></tr>
<tr><td>
[constructor](./rc-js-util.mat4.constructor.md)
</td><td>
</td><td>
[IMat4Ctor](./rc-js-util.imat4ctor.md)<!-- --><TArray>
</td><td>
</td></tr>
<tr><td>
[constructors](./rc-js-util.mat4.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.mat4.f32.md)
</td><td>
`static`
</td><td>
[IMat4Ctor](./rc-js-util.imat4ctor.md)<!-- --><Float32Array>
</td><td>
</td></tr>
<tr><td>
[f64](./rc-js-util.mat4.f64.md)
</td><td>
`static`
</td><td>
[IMat4Ctor](./rc-js-util.imat4ctor.md)<!-- --><Float64Array>
</td><td>
</td></tr>
<tr><td>
[i16](./rc-js-util.mat4.i16.md)
</td><td>
`static`
</td><td>
[IMat4Ctor](./rc-js-util.imat4ctor.md)<!-- --><Int16Array>
</td><td>
</td></tr>
<tr><td>
[i32](./rc-js-util.mat4.i32.md)
</td><td>
`static`
</td><td>
[IMat4Ctor](./rc-js-util.imat4ctor.md)<!-- --><Int32Array>
</td><td>
</td></tr>
<tr><td>
[i64](./rc-js-util.mat4.i64.md)
</td><td>
`static`
</td><td>
null
</td><td>
</td></tr>
<tr><td>
[i8](./rc-js-util.mat4.i8.md)
</td><td>
`static`
</td><td>
[IMat4Ctor](./rc-js-util.imat4ctor.md)<!-- --><Int8Array>
</td><td>
</td></tr>
<tr><td>
[TTypeGuardMat4](./rc-js-util.mat4.ttypeguardmat4.md)
</td><td>
`protected`
</td><td>
true
</td><td>
</td></tr>
<tr><td>
[u16](./rc-js-util.mat4.u16.md)
</td><td>
`static`
</td><td>
[IMat4Ctor](./rc-js-util.imat4ctor.md)<!-- --><Uint16Array>
</td><td>
</td></tr>
<tr><td>
[u32](./rc-js-util.mat4.u32.md)
</td><td>
`static`
</td><td>
[IMat4Ctor](./rc-js-util.imat4ctor.md)<!-- --><Uint32Array>
</td><td>
</td></tr>
<tr><td>
[u64](./rc-js-util.mat4.u64.md)
</td><td>
`static`
</td><td>
null
</td><td>
</td></tr>
<tr><td>
[u8](./rc-js-util.mat4.u8.md)
</td><td>
`static`
</td><td>
[IMat4Ctor](./rc-js-util.imat4ctor.md)<!-- --><Uint8Array>
</td><td>
</td></tr>
<tr><td>
[u8c](./rc-js-util.mat4.u8c.md)
</td><td>
`static`
</td><td>
[IMat4Ctor](./rc-js-util.imat4ctor.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.mat4.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.mat4.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.mat4.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.mat4.getctor.md)
</td><td>
`static`
</td><td>
</td></tr>
<tr><td>
[getLoggableValue()](./rc-js-util.mat4.getloggablevalue.md)
</td><td>
</td><td>
</td></tr>
<tr><td>
[getRow(\_row, \_writeTo)](./rc-js-util.mat4.getrow.md)
</td><td>
</td><td>
</td></tr>
<tr><td>
[getValueAt(\_column, \_row)](./rc-js-util.mat4.getvalueat.md)
</td><td>
</td><td>
</td></tr>
<tr><td>
[isEqualTo(\_other)](./rc-js-util.mat4.isequalto.md)
</td><td>
</td><td>
Component-wise equals.
</td></tr>
<tr><td>
[setIdentityMatrix()](./rc-js-util.mat4.setidentitymatrix.md)
</td><td>
</td><td>
</td></tr>
<tr><td>
[setRow(\_row, \_writeFrom)](./rc-js-util.mat4.setrow.md)
</td><td>
</td><td>
</td></tr>
<tr><td>
[setValueAt(\_column, \_row, \_value)](./rc-js-util.mat4.setvalueat.md)
</td><td>
</td><td>
</td></tr>
</tbody></table>