@twick/core 0.11.0

package/lib/types/Matrix2D.d.ts

@@ -0,0 +1,363 @@
+import type { Type, WebGLConvertible } from './Type';
+import type { PossibleVector2 } from './Vector';
+import { Vector2 } from './Vector';
+export type PossibleMatrix2D = Matrix2D | DOMMatrix | [number, number, number, number, number, number] | [PossibleVector2, PossibleVector2, PossibleVector2] | undefined;
+/**
+ * A specialized 2x3 Matrix representing a 2D transformation.
+ *
+ * A Matrix2D contains six elements defined as
+ * [a, b,
+ *  c, d,
+ *  tx, ty]
+ *
+ * This is a shortcut for a 3x3 matrix of the form
+ * [a, b, 0,
+ *  c, d, 0
+ *  tx, ty, 1]
+ *
+ * Note that because a Matrix2D ignores the z-values of each component vectors,
+ * it does not satisfy all properties of a "real" 3x3 matrix.
+ *
+ *   - A Matrix2D has no transpose
+ *   - A(B + C) = AB + AC does not hold for a Matrix2D
+ *   - (rA)^-1 = r^-1 A^-1, r != 0 does not hold for a Matrix2D
+ *   - r(AB) = (rA)B = A(rB) does not hold for a Matrix2D
+ */
+export declare class Matrix2D implements Type, WebGLConvertible {
+    static readonly symbol: unique symbol;
+    readonly values: Float32Array;
+    static readonly identity: Matrix2D;
+    static readonly zero: Matrix2D;
+    static fromRotation(angle: number): Matrix2D;
+    static fromTranslation(translation: PossibleVector2): Matrix2D;
+    static fromScaling(scale: PossibleVector2): Matrix2D;
+    get x(): Vector2;
+    get y(): Vector2;
+    get scaleX(): number;
+    set scaleX(value: number);
+    get skewX(): number;
+    set skewX(value: number);
+    get scaleY(): number;
+    set scaleY(value: number);
+    get skewY(): number;
+    set skewY(value: number);
+    get translateX(): number;
+    set translateX(value: number);
+    get translateY(): number;
+    set translateY(value: number);
+    get rotation(): number;
+    set rotation(angle: number);
+    get translation(): Vector2;
+    set translation(translation: PossibleVector2);
+    get scaling(): Vector2;
+    set scaling(value: PossibleVector2);
+    /**
+     * Get the inverse of the matrix.
+     *
+     * @remarks
+     * If the matrix is not invertible, i.e. its determinant is `0`, this will
+     * return `null`, instead.
+     *
+     * @example
+     * ```ts
+     * const matrix = new Matrix2D(
+     *   [1, 2],
+     *   [3, 4],
+     *   [5, 6],
+     * );
+     *
+     * const inverse = matrix.inverse;
+     * // => Matrix2D(
+     * //      [-2, 1],
+     * //      [1.5, -0.5],
+     * //      [1, -2],
+     * //   )
+     * ```
+     */
+    get inverse(): Matrix2D | null;
+    /**
+     * Get the determinant of the matrix.
+     */
+    get determinant(): number;
+    get domMatrix(): DOMMatrix;
+    constructor();
+    constructor(matrix: PossibleMatrix2D);
+    constructor(x: PossibleVector2, y: PossibleVector2, z: PossibleVector2);
+    constructor(a: number, b: number, c: number, d: number, tx: number, ty: number);
+    /**
+     * Get the nth component vector of the matrix. Only defined for 0, 1, and 2.
+     *
+     * @example
+     * ```ts
+     * const matrix = new Matrix2D(
+     *   [1, 0],
+     *   [0, 0],
+     *   [1, 0],
+     * );
+     *
+     * const x = matrix.column(0);
+     * // Vector2(1, 0)
+     *
+     * const y = matrix.column(1);
+     * // Vector2(0, 0)
+     *
+     * const z = matrix.column(1);
+     * // Vector2(1, 0)
+     * ```
+     *
+     * @param index - The index of the component vector to retrieve.
+     */
+    column(index: number): Vector2;
+    /**
+     * Returns the nth row of the matrix. Only defined for 0 and 1.
+     *
+     * @example
+     * ```ts
+     * const matrix = new Matrix2D(
+     *   [1, 0],
+     *   [0, 0],
+     *   [1, 0],
+     * );
+     *
+     * const firstRow = matrix.column(0);
+     * // [1, 0, 1]
+     *
+     * const secondRow = matrix.column(1);
+     * // [0, 0, 0]
+     * ```
+     *
+     * @param index - The index of the row to retrieve.
+     */
+    row(index: number): [number, number, number];
+    /**
+     * Returns the matrix product of this matrix with the provided matrix.
+     *
+     * @remarks
+     * This method returns a new matrix representing the result of the
+     * computation. It will not modify the source matrix.
+     *
+     * @example
+     * ```ts
+     * const a = new Matrix2D(
+     *   [1, 2],
+     *   [0, 1],
+     *   [1, 1],
+     * );
+     * const b = new Matrix2D(
+     *   [2, 1],
+     *   [1, 1],
+     *   [1, 1],
+     * );
+     *
+     * const result = a.mul(b);
+     * // => Matrix2D(
+     * //     [2, 5],
+     * //     [1, 3],
+     * //     [2, 4],
+     * //   )
+     * ```
+     *
+     * @param other - The matrix to multiply with
+     */
+    mul(other: Matrix2D): Matrix2D;
+    /**
+     * Rotate the matrix by the provided angle. By default, the angle is
+     * provided in degrees.
+     *
+     * @remarks
+     * This method returns a new matrix representing the result of the
+     * computation. It will not modify the source matrix.
+     *
+     * @example
+     * ```ts
+     * const a = new Matrix2D(
+     *   [1, 2],
+     *   [3, 4],
+     *   [5, 6],
+     * );
+     *
+     * const result = a.rotate(90);
+     * // => Matrix2D(
+     * //     [3, 4],
+     * //     [-1, -2],
+     * //     [5, 6],
+     * //   )
+     *
+     * // Provide the angle in radians
+     * const result = a.rotate(Math.PI * 0.5, true);
+     * // => Matrix2D(
+     * //     [3, 4],
+     * //     [-1, -2],
+     * //     [5, 6],
+     * //   )
+     * ```
+     *
+     * @param angle - The angle by which to rotate the matrix.
+     * @param degrees - Whether the angle is provided in degrees.
+     */
+    rotate(angle: number, degrees?: boolean): Matrix2D;
+    /**
+     * Scale the x and y component vectors of the matrix.
+     *
+     * @remarks
+     * If `vec` is provided as a vector, the x and y component vectors of the
+     * matrix will be scaled by the x and y parts of the vector, respectively.
+     *
+     * If `vec` is provided as a scalar, the x and y component vectors will be
+     * scaled uniformly by this factor.
+     *
+     * This method returns a new matrix representing the result of the
+     * computation. It will not modify the source matrix.
+     *
+     * @example
+     * ```ts
+     * const matrix = new Matrix2D(
+     *   [1, 2],
+     *   [3, 4],
+     *   [5, 6],
+     * );
+     *
+     * const result1 = matrix.scale([2, 3]);
+     * // => new Matrix2D(
+     * //      [2, 4],
+     * //      [9, 12],
+     * //      [5, 6],
+     * //    )
+     *
+     * const result2 = matrix.scale(2);
+     * // => new Matrix2D(
+     * //      [2, 4],
+     * //      [6, 8],
+     * //      [5, 6],
+     * //    )
+     * ```
+     *
+     * @param vec - The factor by which to scale the matrix
+     */
+    scale(vec: PossibleVector2): Matrix2D;
+    /**
+     * Multiply each value of the matrix by a scalar.
+     *
+     * * @example
+     * ```ts
+     * const matrix = new Matrix2D(
+     *   [1, 2],
+     *   [3, 4],
+     *   [5, 6],
+     * );
+     *
+     * const result1 = matrix.mulScalar(2);
+     * // => new Matrix2D(
+     * //      [2, 4],
+     * //      [6, 8],
+     * //      [10, 12],
+     * //    )
+     * ```
+     *
+     * @param s - The value by which to scale each term
+     */
+    mulScalar(s: number): Matrix2D;
+    /**
+     * Translate the matrix by the dimensions of the provided vector.
+     *
+     * @remarks
+     * If `vec` is provided as a scalar, matrix will be translated uniformly
+     * by this factor.
+     *
+     * This method returns a new matrix representing the result of the
+     * computation. It will not modify the source matrix.
+     *
+     * @example
+     * ```ts
+     * const matrix = new Matrix2D(
+     *   [1, 2],
+     *   [3, 4],
+     *   [5, 6],
+     * );
+     *
+     * const result1 = matrix.translate([2, 3]);
+     * // => new Matrix2D(
+     * //      [1, 2],
+     * //      [3, 4],
+     * //      [16, 22],
+     * //    )
+     *
+     * const result2 = matrix.translate(2);
+     * // => new Matrix2D(
+     * //      [1, 2],
+     * //      [3, 4],
+     * //      [13, 18],
+     * //    )
+     * ```
+     *
+     * @param vec - The vector by which to translate the matrix
+     */
+    translate(vec: PossibleVector2): Matrix2D;
+    /**
+     * Add the provided matrix to this matrix.
+     *
+     * @remarks
+     * This method returns a new matrix representing the result of the
+     * computation. It will not modify the source matrix.
+     *
+     * @example
+     * ```ts
+     * const a = new Matrix2D(
+     *   [1, 2],
+     *   [3, 4],
+     *   [5, 6],
+     * );
+     * const a = new Matrix2D(
+     *   [7, 8],
+     *   [9, 10],
+     *   [11, 12],
+     * );
+     *
+     * const result = a.add(b);
+     * // => Matrix2D(
+     * //      [8, 10],
+     * //      [12, 14],
+     * //      [16, 18],
+     * //    )
+     * ```
+     *
+     * @param other - The matrix to add
+     */
+    add(other: Matrix2D): Matrix2D;
+    /**
+     * Subtract the provided matrix from this matrix.
+     *
+     * @remarks
+     * This method returns a new matrix representing the result of the
+     * computation. It will not modify the source matrix.
+     *
+     * @example
+     * ```ts
+     * const a = new Matrix2D(
+     *   [1, 2],
+     *   [3, 4],
+     *   [5, 6],
+     * );
+     * const a = new Matrix2D(
+     *   [7, 8],
+     *   [9, 10],
+     *   [11, 12],
+     * );
+     *
+     * const result = a.sub(b);
+     * // => Matrix2D(
+     * //      [-6, -6],
+     * //      [-6, -6],
+     * //      [-6, -6],
+     * //    )
+     * ```
+     *
+     * @param other - The matrix to subract
+     */
+    sub(other: Matrix2D): Matrix2D;
+    toSymbol(): symbol;
+    toUniform(gl: WebGL2RenderingContext, location: WebGLUniformLocation): void;
+    equals(other: Matrix2D, threshold?: number): boolean;
+    exactlyEquals(other: Matrix2D): boolean;
+}
+//# sourceMappingURL=Matrix2D.d.ts.map

package/lib/types/Matrix2D.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Matrix2D.d.ts","sourceRoot":"","sources":["../../src/types/Matrix2D.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,IAAI,EAAE,gBAAgB,EAAC,MAAM,QAAQ,CAAC;AAEnD,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAC,OAAO,EAAC,MAAM,UAAU,CAAC;AAEjC,MAAM,MAAM,gBAAgB,GACxB,QAAQ,GACR,SAAS,GACT,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,GAChD,CAAC,eAAe,EAAE,eAAe,EAAE,eAAe,CAAC,GACnD,SAAS,CAAC;AAEd;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,QAAS,YAAW,IAAI,EAAE,gBAAgB;IACrD,gBAAuB,MAAM,gBAA4C;IAEzE,SAAgB,MAAM,EAAE,YAAY,CAAuB;IAC3D,gBAAuB,QAAQ,EAAE,QAAQ,CAAkC;IAC3E,gBAAuB,IAAI,EAAE,QAAQ,CAAkC;WAEzD,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ;WAIrC,eAAe,CAAC,WAAW,EAAE,eAAe,GAAG,QAAQ;WAIvD,WAAW,CAAC,KAAK,EAAE,eAAe,GAAG,QAAQ;IAI3D,IAAW,CAAC,IAAI,OAAO,CAEtB;IAED,IAAW,CAAC,IAAI,OAAO,CAEtB;IAED,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED,IAAW,MAAM,CAAC,KAAK,EAAE,MAAM,EAE9B;IAED,IAAW,KAAK,IAAI,MAAM,CAEzB;IAED,IAAW,KAAK,CAAC,KAAK,EAAE,MAAM,EAE7B;IAED,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED,IAAW,MAAM,CAAC,KAAK,EAAE,MAAM,EAE9B;IAED,IAAW,KAAK,IAAI,MAAM,CAEzB;IAED,IAAW,KAAK,CAAC,KAAK,EAAE,MAAM,EAE7B;IAED,IAAW,UAAU,IAAI,MAAM,CAE9B;IAED,IAAW,UAAU,CAAC,KAAK,EAAE,MAAM,EAElC;IAED,IAAW,UAAU,IAAI,MAAM,CAE9B;IAED,IAAW,UAAU,CAAC,KAAK,EAAE,MAAM,EAElC;IAED,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED,IAAW,QAAQ,CAAC,KAAK,EAAE,MAAM,EAOhC;IAED,IAAW,WAAW,IAAI,OAAO,CAEhC;IAED,IAAW,WAAW,CAAC,WAAW,EAAE,eAAe,EAIlD;IAED,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED,IAAW,OAAO,CAAC,KAAK,EAAE,eAAe,EAUxC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAW,OAAO,IAAI,QAAQ,GAAG,IAAI,CAwBpC;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,MAAM,CAE/B;IAED,IAAW,SAAS,IAAI,SAAS,CAShC;;gBAGkB,MAAM,EAAE,gBAAgB;gBAEzC,CAAC,EAAE,eAAe,EAClB,CAAC,EAAE,eAAe,EAClB,CAAC,EAAE,eAAe;gBAGlB,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,EAAE,EAAE,MAAM,EACV,EAAE,EAAE,MAAM;IAoFZ;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAIrC;;;;;;;;;;;;;;;;;;;OAmBG;IACI,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;IAInD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACI,GAAG,CAAC,KAAK,EAAE,QAAQ,GAAG,QAAQ;IAwBrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACI,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,UAAO,GAAG,QAAQ;IAwBtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACI,KAAK,CAAC,GAAG,EAAE,eAAe,GAAG,QAAQ;IAa5C;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,QAAQ;IAWrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACI,SAAS,CAAC,GAAG,EAAE,eAAe,GAAG,QAAQ;IAahD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACI,GAAG,CAAC,KAAK,EAAE,QAAQ,GAAG,QAAQ;IAWrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACI,GAAG,CAAC,KAAK,EAAE,QAAQ,GAAG,QAAQ;IAW9B,QAAQ,IAAI,MAAM;IAIlB,SAAS,CACd,EAAE,EAAE,sBAAsB,EAC1B,QAAQ,EAAE,oBAAoB,GAC7B,IAAI;IAIA,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,GAAE,MAAgB,GAAG,OAAO;IAgB7D,aAAa,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO;CAU/C"}