rc-js-util/bin/esm/array/typed-array/mat2/mat2.d.ts

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

import { ATypedArrayTuple, TTypedArrayTupleMutativeMethods } from "../a-typed-array-tuple.js";
import { TTypedArray } from "../t-typed-array.js";
import { ITypedArrayTupleFactory } from "../i-typed-array-tuple-factory.js";
import { TTypedArrayCtor } from "../t-typed-array-ctor.js";
import { IReadonlyVec2, Vec2 } from "../vec2/vec2.js";
import { TPickExcept } from "../../../typescript/t-pick-except.js";
/**
 * @public
 */
export type TMat2CtorArgs = [c1r1: number, c2r1: number, c2r2: number, c2r2: number];
/**
 * @public
 * Constructor for {@link Mat2}.
 */
export interface IMat2Ctor<TArray extends TTypedArray> {
    /**
     * The size in bytes of each element in the array.
     */
    readonly BYTES_PER_ELEMENT: number;
    readonly prototype: Mat2<TArray>;
    readonly factory: ITypedArrayTupleFactory<Mat2<TArray>, TMat2CtorArgs>;
    new (): Mat2<TArray>;
}
/**
 * @public
 * {@link Mat2}.
 */
export interface IReadonlyMat2<TArray extends TTypedArray> extends TPickExcept<Readonly<Mat2<TArray>>, "update" | "setValueAt" | "setRow" | "copyFromBuffer" | "scalarMultiply" | "scalarAdd" | TTypedArrayTupleMutativeMethods> {
}
/**
 * @public
 * Row major 2x2 matrix.
 *
 * @remarks
 * See static properties for constructors. Instances are not an extension of this class, but of the static members.
 */
export declare abstract class Mat2<TArray extends TTypedArray> extends ATypedArrayTuple<4, TArray> {
    static f64: IMat2Ctor<Float64Array>;
    static f32: IMat2Ctor<Float32Array>;
    static i64: null;
    static u64: null;
    static u32: IMat2Ctor<Uint32Array>;
    static i32: IMat2Ctor<Int32Array>;
    static u16: IMat2Ctor<Uint16Array>;
    static i16: IMat2Ctor<Int16Array>;
    static u8c: IMat2Ctor<Uint8ClampedArray>;
    static u8: IMat2Ctor<Uint8Array>;
    static i8: IMat2Ctor<Int8Array>;
    static getCtor<TCtor extends TTypedArrayCtor>(ctor: TCtor): IMat2Ctor<InstanceType<TCtor>>;
    protected static constructors: Map<import("../t-typed-array-ctor.js").TFullSetTypedArrayCtor, Function>;
    ["constructor"]: IMat2Ctor<TArray>;
    /**
     * c1r1
     */
    0: number;
    /**
     * c2r1
     */
    1: number;
    /**
     * c2r2
     */
    2: number;
    /**
     * c2r2
     */
    3: number;
    /**
     * Component-wise equals.
     */
    isEqualTo(_other: Mat2<TTypedArray>): boolean;
    update(..._args: TMat2CtorArgs): void;
    setIdentityMatrix(): Mat2<TArray>;
    getValueAt(_column: number, _row: number): number;
    setValueAt(_column: number, _row: number, _value: number): void;
    setScalingMatrix(_scalingFactor: number): Mat2<TArray>;
    setTranslationMatrix(_translation: number): Mat2<TArray>;
    scalarMultiply<TResult extends TTypedArray = TArray>(_value: number, _result?: Mat2<TResult>): Mat2<TResult>;
    scalarAdd<TResult extends TTypedArray = TArray>(_value: number, _result?: Mat2<TResult>): Mat2<TResult>;
    multiplyMat2<TResult extends TTypedArray = TArray>(_mat: IReadonlyMat2<TTypedArray>, _result?: Mat2<TResult>): Mat2<TResult>;
    getVec2MultiplyX(_x: number): number;
    getRow<TResult extends TTypedArray = TArray>(_row: number, _writeTo?: Vec2<TResult>): Vec2<TResult>;
    setRow(_row: number, _writeFrom: IReadonlyVec2<TTypedArray>): void;
    getLoggableValue(): number[][];
    /**
     * If endianness is not supplied the platform's endianness will be used.
     */
    copyFromBuffer(_memoryDataView: DataView, _pointer: number, _littleEndian?: boolean): void;
    /**
     * If endianness is not supplied the platform's endianness will be used.
     */
    copyToBuffer(_memoryDataView: DataView, _pointer: number, _littleEndian?: boolean): void;
    /**
     * 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.
     */
    castToBaseType(): TArray;
    protected TTypeGuardMat2: true;
}
/**
 * @public
 * Float32 {@link Mat2}.
 */
export type TF32Mat2 = Mat2<Float32Array>;
/**
 * @public
 * Float64 {@link Mat2}.
 */
export type TF64Mat2 = Mat2<Float64Array>;
//# sourceMappingURL=mat2.d.ts.map