Interface IMutableMatrix

Interface for mutable matrix operations. Extends IMatrix with methods that modify the matrix in place.

interface IMutableMatrix {
    _v: Float32Array;
    className: string;
    isIdentityMatrixClass: boolean;
    _swap(l: number, r: number): void;
    at(row_i: number, column_i: number): number;
    clone(): IMutableMatrix;
    copyComponents(mat: IMatrix): IMutableMatrix;
    determinant(): number;
    flattenAsArray(): number[];
    identity(): IMutableMatrix;
    invert(): IMutableMatrix;
    isDummy(): boolean;
    isTheSourceSame(arrayBuffer: ArrayBuffer): boolean;
    multiply(mat: IMatrix): IMutableMatrix;
    multiplyByLeft(mat: IMatrix): IMutableMatrix;
    multiplyScale(vec: IVector): IMutableMatrix;
    raw(): TypedArray;
    rotate(any: any): IMutableMatrix;
    scale(vec: IVector): IMutableMatrix;
    setAt(row_i: number, column_i: number, value: number): void;
    setComponents(...num: number[]): IMutableMatrix;
    toString(): string;
    toStringApproximately(): string;
    transpose(): IMutableMatrix;
    v(i: number): number;
    zero(): IMutableMatrix;
}

Hierarchy (View Summary)

IMatrix
- IMutableMatrix

Implemented by

Properties

_v

_v: Float32Array

Internal typed array storing matrix data in column-major order

`Readonly`className

className: string

Returns the class name of the matrix implementation

`Readonly`isIdentityMatrixClass

isIdentityMatrixClass: boolean

Indicates if this matrix is an identity matrix class

Methods

_swap

_swap(l: number, r: number): void
Swaps two elements in the internal array.
Parameters
- l: number
  Left index
- r: number
  Right index
Returns void
- Defined in foundation/math/IMatrix.ts:136

at

at(row_i: number, column_i: number): number
Gets the value at the specified row and column.
Parameters
- row_i: number
  Row index (0-based)
- column_i: number
  Column index (0-based)
Returns number
Value at the specified position
Inherited from IMatrix.at
- Defined in foundation/math/IMatrix.ts:54

clone

clone(): IMutableMatrix
Creates a deep copy of this matrix.

Returns IMutableMatrix
New mutable matrix with the same values
- Defined in foundation/math/IMatrix.ts:89

copyComponents

copyComponents(mat: IMatrix): IMutableMatrix
Copies components from another matrix.
Parameters
- mat: IMatrix
  Source matrix to copy from
Returns IMutableMatrix
This matrix for method chaining
- Defined in foundation/math/IMatrix.ts:117

determinant

determinant(): number
Calculates the determinant of the matrix.

Returns number
Determinant value
Inherited from IMatrix.determinant
- Defined in foundation/math/IMatrix.ts:67

flattenAsArray

flattenAsArray(): number[]
Flattens the matrix into a plain JavaScript array.

Returns number[]
Array containing all matrix elements
Inherited from IMatrix.flattenAsArray
- Defined in foundation/math/IMatrix.ts:40

identity

identity(): IMutableMatrix
Sets this matrix to the identity matrix.

Returns IMutableMatrix
This matrix for method chaining
- Defined in foundation/math/IMatrix.ts:129

invert

invert(): IMutableMatrix
Inverts this matrix in place.

Returns IMutableMatrix
This matrix for method chaining
- Defined in foundation/math/IMatrix.ts:148

isDummy

isDummy(): boolean
Checks if this is a dummy/placeholder matrix.

Returns boolean
True if this is a dummy matrix
Inherited from IMatrix.isDummy
- Defined in foundation/math/IMatrix.ts:46

isTheSourceSame

isTheSourceSame(arrayBuffer: ArrayBuffer): boolean
Checks if the internal array buffer is the same as the provided one.
Parameters
- arrayBuffer: ArrayBuffer
  Array buffer to compare against
Returns boolean
True if the source is the same
Inherited from IMatrix.isTheSourceSame
- Defined in foundation/math/IMatrix.ts:77

multiply

multiply(mat: IMatrix): IMutableMatrix
Multiplies this matrix by another matrix.
Parameters
- mat: IMatrix
  Matrix to multiply by
Returns IMutableMatrix
This matrix for method chaining
- Defined in foundation/math/IMatrix.ts:176

multiplyByLeft

multiplyByLeft(mat: IMatrix): IMutableMatrix
Multiplies this matrix by another matrix from the left.
Parameters
- mat: IMatrix
  Matrix to multiply from the left
Returns IMutableMatrix
This matrix for method chaining
- Defined in foundation/math/IMatrix.ts:183

multiplyScale

multiplyScale(vec: IVector): IMutableMatrix
Multiplies this matrix by a scale vector.
Parameters
- vec: IVector
  Scale vector
Returns IMutableMatrix
This matrix for method chaining
- Defined in foundation/math/IMatrix.ts:169

raw

raw(): TypedArray
Gets the raw typed array containing matrix data.

Returns TypedArray
Raw typed array
- Defined in foundation/math/IMatrix.ts:95

rotate

rotate(any: any): IMutableMatrix
Applies a rotation to this matrix.
Parameters
- any: any
  Rotation parameters (type varies by matrix dimension)
Returns IMutableMatrix
This matrix for method chaining
- Defined in foundation/math/IMatrix.ts:155

scale

scale(vec: IVector): IMutableMatrix
Applies scaling to this matrix.
Parameters
- vec: IVector
  Scale vector
Returns IMutableMatrix
This matrix for method chaining
- Defined in foundation/math/IMatrix.ts:162

setAt

setAt(row_i: number, column_i: number, value: number): void
Sets the value at the specified row and column.
Parameters
- row_i: number
  Row index (0-based)
- column_i: number
  Column index (0-based)
- value: number
  Value to set
Returns void
- Defined in foundation/math/IMatrix.ts:103

setComponents

setComponents(...num: number[]): IMutableMatrix
Sets all matrix components from individual values.
Parameters
- ...num: number[]
  Variable number of numeric values
Returns IMutableMatrix
This matrix for method chaining
- Defined in foundation/math/IMatrix.ts:110

toString

toString(): string
Converts the matrix to a string representation.

Returns string
String representation of the matrix
Inherited from IMatrix.toString
- Defined in foundation/math/IMatrix.ts:28

toStringApproximately

toStringApproximately(): string
Converts the matrix to an approximate string representation.

Returns string
Approximate string representation with rounded values
Inherited from IMatrix.toStringApproximately
- Defined in foundation/math/IMatrix.ts:34

transpose

transpose(): IMutableMatrix
Transposes this matrix in place.

Returns IMutableMatrix
This matrix for method chaining
- Defined in foundation/math/IMatrix.ts:142

v

v(i: number): number
Gets the value at the specified linear index.
Parameters
- i: number
  Linear index in the internal array
Returns number
Value at the specified index
Inherited from IMatrix.v
- Defined in foundation/math/IMatrix.ts:61

zero

zero(): IMutableMatrix
Sets all matrix elements to zero.

Returns IMutableMatrix
This matrix for method chaining
- Defined in foundation/math/IMatrix.ts:123

Interface IMutableMatrix

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

_v

ReadonlyclassName

ReadonlyisIdentityMatrixClass

Methods

_swap

Parameters

Returns void

at

Parameters

Returns number

clone

Returns IMutableMatrix

copyComponents

Parameters

Returns IMutableMatrix

determinant

Returns number

flattenAsArray

Returns number[]

identity

Returns IMutableMatrix

invert

Returns IMutableMatrix

isDummy

Returns boolean

isTheSourceSame

Parameters

Returns boolean

multiply

Parameters

Returns IMutableMatrix

multiplyByLeft

Parameters

Returns IMutableMatrix

multiplyScale

Parameters

Returns IMutableMatrix

raw

Returns TypedArray

rotate

Parameters

Returns IMutableMatrix

scale

Parameters

Returns IMutableMatrix

setAt

Parameters

Returns void

setComponents

Parameters

Returns IMutableMatrix

toString

Returns string

toStringApproximately

Returns string

transpose

Returns IMutableMatrix

v

Parameters

Returns number

zero

Returns IMutableMatrix

Settings

On This Page

`Readonly`className

`Readonly`isIdentityMatrixClass