@mlightcad/geometry-engine 1.0.0

package/lib/math/AcGeMatrix3d.d.ts

@@ -0,0 +1,279 @@
+import { AcGeMatrix2d } from './AcGeMatrix2d';
+import { AcGeQuaternion } from './AcGeQuaternion';
+import { AcGeVector3d, AcGeVector3dLike } from './AcGeVector3d';
+/**
+ * The class representing a 4x4 matrix.
+ */
+export declare class AcGeMatrix3d {
+    /**
+     * Identity matrix.
+     */
+    static IDENTITY: Readonly<AcGeMatrix3d>;
+    /**
+     * A column-major list of matrix values.
+     */
+    elements: number[];
+    /**
+     * Create a 4x4 matrix with the given arguments in row-major order. If no arguments are provided,
+     * the constructor initializes the Matrix4 to the 4x4 identity matrix.
+     *
+     * @param n11 Input element in the first row and the first column
+     * @param n12 Input element in the first row and the second column
+     * @param n13 Input element in the first row and the third column
+     * @param n14 Input element in the first row and the forth column
+     * @param n21 Input element in the second row and the first column
+     * @param n22 Input element in the second row and the second column
+     * @param n23 Input element in the second row and the third column
+     * @param n24 Input element in the second row and the forth column
+     * @param n31 Input element in the third row and the first column
+     * @param n32 Input element in the third row and the second column
+     * @param n33 Input element in the third row and the third column
+     * @param n34 Input element in the third row and the forth column
+     * @param n41 Input element in the forth row and the first column
+     * @param n42 Input element in the forth row and the second column
+     * @param n43 Input element in the forth row and the third column
+     * @param n44 Input element in the forth row and the forth column
+     */
+    constructor(n11?: number, n12?: number, n13?: number, n14?: number, n21?: number, n22?: number, n23?: number, n24?: number, n31?: number, n32?: number, n33?: number, n34?: number, n41?: number, n42?: number, n43?: number, n44?: number);
+    /**
+     * Set the elements of this matrix to the supplied row-major values n11, n12, ... n44.
+     *
+     * @param n11 Input element in the first row and the first column
+     * @param n12 Input element in the first row and the second column
+     * @param n13 Input element in the first row and the third column
+     * @param n14 Input element in the first row and the forth column
+     * @param n21 Input element in the second row and the first column
+     * @param n22 Input element in the second row and the second column
+     * @param n23 Input element in the second row and the third column
+     * @param n24 Input element in the second row and the forth column
+     * @param n31 Input element in the third row and the first column
+     * @param n32 Input element in the third row and the second column
+     * @param n33 Input element in the third row and the third column
+     * @param n34 Input element in the third row and the forth column
+     * @param n41 Input element in the forth row and the first column
+     * @param n42 Input element in the forth row and the second column
+     * @param n43 Input element in the forth row and the third column
+     * @param n44 Input element in the forth row and the forth column
+     * @returns Return this matrix
+     */
+    set(n11: number, n12: number, n13: number, n14: number, n21: number, n22: number, n23: number, n24: number, n31: number, n32: number, n33: number, n34: number, n41: number, n42: number, n43: number, n44: number): this;
+    /**
+     * Reset this matrix to the identity matrix.
+     * @returns Return this matrix
+     */
+    identity(): this;
+    clone(): AcGeMatrix3d;
+    /**
+     * Copy the elements of matrix m into this matrix.
+     * @param m Input one matrix copied from
+     * @returns Return this matrix
+     */
+    copy(m: AcGeMatrix3d): this;
+    /**
+     * Copy the translation component of the supplied matrix m into this matrix's translation component.
+     * @param m Input the matrix copied from
+     * @returns Return this matrix
+     */
+    copyPosition(m: AcGeMatrix3d): this;
+    /**
+     * Set the upper 3x3 elements of this matrix to the values of the 3x3 matrix m.
+     * @param m Input one 3x3 matrix
+     * @returns Return this matrix
+     */
+    setFromMatrix3(m: AcGeMatrix2d): this;
+    /**
+     * Create transform matrix according to the given the normalized extrusion vector
+     * @param extrusion Input the normalized extrusion vector
+     * @returns Return this matrix
+     */
+    setFromExtrusionDirection(extrusion: AcGeVector3d): this;
+    /**
+     * Extracts the basis of this matrix into the three axis vectors provided.
+     * @param xAxis Input X axis vector
+     * @param yAxis Input Y axis vector
+     * @param zAxis Input Z axis vector
+     * @returns Return this matrix
+     */
+    extractBasis(xAxis: AcGeVector3d, yAxis: AcGeVector3d, zAxis: AcGeVector3d): this;
+    /**
+     * Set this to the basis matrix consisting of the three provided basis vectors:
+     * @param xAxis Input X axis vector
+     * @param yAxis Input Y axis vector
+     * @param zAxis Input Z axis vector
+     * @returns Return this matrix
+     */
+    makeBasis(xAxis: AcGeVector3dLike, yAxis: AcGeVector3dLike, zAxis: AcGeVector3dLike): this;
+    /**
+     * Extracts the rotation component of the supplied matrix m into this matrix's rotation component.
+     * @param m Input one 4x4 matrix
+     * @returns Return this matrix
+     */
+    extractRotation(m: AcGeMatrix3d): this;
+    /**
+     * Set the rotation component of this matrix to the rotation specified by q
+     * @param q Input one uaternion
+     * @returns Return this matrix
+     */
+    makeRotationFromQuaternion(q: AcGeQuaternion): this;
+    /**
+     * Construct a rotation matrix, looking from eye towards target oriented by the up vector.
+     * @param eye Input eye vector
+     * @param target Input target vector
+     * @param up Input up vector
+     * @returns Return this matrix
+     */
+    lookAt(eye: AcGeVector3d, target: AcGeVector3d, up: AcGeVector3d): this;
+    /**
+     * Post-multiply this matrix by m.
+     * @param m Input one 4x4 matrix
+     * @returns Return this matrix
+     */
+    multiply(m: AcGeMatrix3d): this;
+    /**
+     * Pre-multiply this matrix by m.
+     * @param m Input one 4x4 matrix
+     * @returns Return this matrix
+     */
+    premultiply(m: AcGeMatrix3d): this;
+    /**
+     * Set this matrix to a x b.
+     * @param a Input one 4x4 matrix
+     * @param b Input one 4x4 matrix
+     * @returns Return this matrix
+     */
+    multiplyMatrices(a: AcGeMatrix3d, b: AcGeMatrix3d): this;
+    /**
+     * Multiply every component of the matrix by a scalar value s.
+     * @param s Input one scalar value
+     * @returns Return this matrix
+     */
+    multiplyScalar(s: number): this;
+    /**
+     * Compute and return the determinant of this matrix.
+     * @returns Return the determinant of this matrix.
+     */
+    determinant(): number;
+    /**
+     * Transposes this matrix.
+     * @returns Return this matrix
+     */
+    transpose(): this;
+    /**
+     * Set the position component for this matrix from vector v, without affecting the rest of the matrix.
+     * @param x Input one number or one vector
+     * @param y Input one number
+     * @param z Input one number
+     * @returns Return this matrix
+     */
+    setPosition(x: number | AcGeVector3d, y: number, z: number): this;
+    /**
+     * Invert this matrix, using the analytic method. You can not invert with a determinant of zero.
+     * If you attempt this, the method produces a zero matrix instead.
+     * @returns Return this matrix
+     */
+    invert(): this;
+    /**
+     * Multiply the columns of this matrix by vector v.
+     * @param v Input one vector
+     * @returns Return this matrix
+     */
+    scale(v: AcGeVector3d): this;
+    /**
+     * Get the maximum scale value of the 3 axes.
+     * @returns Return the maximum scale value of the 3 axes.
+     */
+    getMaxScaleOnAxis(): number;
+    /**
+     * Set this matrix as a translation transform from vector v, or numbers x, y and z.
+     * @param x Input one vector or one number
+     * @param y Input one number
+     * @param z Input one number
+     * @returns Return this matrix
+     */
+    makeTranslation(x: number | AcGeVector3d, y?: number, z?: number): this;
+    /**
+     * Set this matrix as a rotational transformation around the X axis by theta (θ) radians.
+     * @param theta Input rotation angle in radians.
+     * @returns Return this matrix
+     */
+    makeRotationX(theta: number): this;
+    /**
+     * Set this matrix as a rotational transformation around the Y axis by theta (θ) radians.
+     * @param theta Input rotation angle in radians.
+     * @returns Return this matrix
+     */
+    makeRotationY(theta: number): this;
+    /**
+     * Set this matrix as a rotational transformation around the Z axis by theta (θ) radians.
+     * @param theta Input rotation angle in radians.
+     * @returns Return this matrix
+     */
+    makeRotationZ(theta: number): this;
+    /**
+     * Set this matrix as rotation transform around axis by theta radians.
+     * @param axis Input rotation axis, should be normalized.
+     * @param angle Input rotation angle in radians.
+     * @returns Return this matrix
+     */
+    makeRotationAxis(axis: AcGeVector3d, angle: number): this;
+    /**
+     * Set this matrix as scale transform.
+     * @param x Input x scale
+     * @param y Input y scale
+     * @param z Input z scale
+     * @returns Return this matrix
+     */
+    makeScale(x: number, y: number, z: number): this;
+    /**
+     * Set this matrix as a shear transform.
+     * @param xy Input the amount to shear X by Y.
+     * @param xz Input the amount to shear X by Z.
+     * @param yx Input the amount to shear Y by X.
+     * @param yz Input the amount to shear Y by Z.
+     * @param zx Input the amount to shear Z by X.
+     * @param zy Input the amount to shear Z by Y.
+     * @returns Return this matrix
+     */
+    makeShear(xy: number, xz: number, yx: number, yz: number, zx: number, zy: number): this;
+    /**
+     * Set this matrix to the transformation composed of position, quaternion and scale.
+     * @param position Input position
+     * @param quaternion Input quaternion
+     * @param scale Input scale
+     * @returns Return this matrix
+     */
+    compose(position: AcGeVector3d, quaternion: AcGeQuaternion, scale: AcGeVector3d): this;
+    /**
+     * Decompose this matrix into its position, quaternion and scale components.
+     *
+     * Note: Not all matrices are decomposable in this way. For example, if an object has a non-uniformly
+     * scaled parent, then the object's world matrix may not be decomposable, and this method may not be
+     * appropriate.
+     * @param position Input position to output
+     * @param quaternion Input quaternion to output
+     * @param scale Input scale to output
+     * @returns Return this matrix
+     */
+    decompose(position: AcGeVector3d, quaternion: AcGeQuaternion, scale: AcGeVector3d): this;
+    /**
+     * Return true if this matrix and m are equal.
+     * @param matrix Input one matrix to compare
+     * @returns Return true if this matrix and m are equal.
+     */
+    equals(matrix: AcGeMatrix3d): boolean;
+    /**
+     * Set the elements of this matrix based on an array in column-major format.
+     * @param array Input the array to read the elements from.
+     * @param offset Input (optional) offset into the array. Default is 0.
+     * @returns
+     */
+    fromArray(array: number[], offset?: number): this;
+    /**
+     * Write the elements of this matrix to an array in column-major format.
+     * @param array Input (optional) array to store the resulting vector in.
+     * @param offset Input (optional) offset in the array at which to put the result.
+     * @returns Return an array in column-major format by writing the elements of this matrix to it
+     */
+    toArray(array?: number[], offset?: number): number[];
+}
+//# sourceMappingURL=AcGeMatrix3d.d.ts.map

package/lib/math/AcGeMatrix3d.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AcGeMatrix3d.d.ts","sourceRoot":"","sources":["../../src/math/AcGeMatrix3d.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAE/D;;GAEG;AACH,qBAAa,YAAY;IACvB;;OAEG;IACH,MAAM,CAAC,QAAQ,yBAAoC;IACnD;;OAEG;IACI,QAAQ,EAAE,MAAM,EAAE,CAAA;IAEzB;;;;;;;;;;;;;;;;;;;;OAoBG;gBAED,GAAG,CAAC,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM;IA2Cd;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CACD,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM;IAwBb;;;OAGG;IACH,QAAQ;IAKR,KAAK;IAIL;;;;OAIG;IACH,IAAI,CAAC,CAAC,EAAE,YAAY;IAwBpB;;;;OAIG;IACH,YAAY,CAAC,CAAC,EAAE,YAAY;IAW5B;;;;OAIG;IACH,cAAc,CAAC,CAAC,EAAE,YAAY;IAyB9B;;;;OAIG;IACH,yBAAyB,CAAC,SAAS,EAAE,YAAY;IAoCjD;;;;;;OAMG;IACH,YAAY,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY;IAQ1E;;;;;;OAMG;IACH,SAAS,CACP,KAAK,EAAE,gBAAgB,EACvB,KAAK,EAAE,gBAAgB,EACvB,KAAK,EAAE,gBAAgB;IAwBzB;;;;OAIG;IACH,eAAe,CAAC,CAAC,EAAE,YAAY;IAoK/B;;;;OAIG;IACH,0BAA0B,CAAC,CAAC,EAAE,cAAc;IAI5C;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,EAAE,YAAY;IA2ChE;;;;OAIG;IACH,QAAQ,CAAC,CAAC,EAAE,YAAY;IAIxB;;;;OAIG;IACH,WAAW,CAAC,CAAC,EAAE,YAAY;IAI3B;;;;;OAKG;IACH,gBAAgB,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,YAAY;IA8DjD;;;;OAIG;IACH,cAAc,CAAC,CAAC,EAAE,MAAM;IAuBxB;;;OAGG;IACH,WAAW;IAuDX;;;OAGG;IACH,SAAS;IA2BT;;;;;;OAMG;IACH,WAAW,CAAC,CAAC,EAAE,MAAM,GAAG,YAAY,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM;IAgB1D;;;;OAIG;IACH,MAAM;IAkKN;;;;OAIG;IACH,KAAK,CAAC,CAAC,EAAE,YAAY;IAsBrB;;;OAGG;IACH,iBAAiB;IAUjB;;;;;;OAMG;IACH,eAAe,CAAC,CAAC,EAAE,MAAM,GAAG,YAAY,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM;IAUhE;;;;OAIG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM;IAS3B;;;;OAIG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM;IAS3B;;;;OAIG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM;IAS3B;;;;;OAKG;IACH,gBAAgB,CAAC,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM;IAkClD;;;;;;OAMG;IACH,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM;IAMzC;;;;;;;;;OASG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,EAAE,EAAE,MAAM,EACV,EAAE,EAAE,MAAM,EACV,EAAE,EAAE,MAAM,EACV,EAAE,EAAE,MAAM,EACV,EAAE,EAAE,MAAM;IAOZ;;;;;;OAMG;IACH,OAAO,CACL,QAAQ,EAAE,YAAY,EACtB,UAAU,EAAE,cAAc,EAC1B,KAAK,EAAE,YAAY;IAgDrB;;;;;;;;;;OAUG;IACH,SAAS,CACP,QAAQ,EAAE,YAAY,EACtB,UAAU,EAAE,cAAc,EAC1B,KAAK,EAAE,YAAY;IAmJrB;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,YAAY;IAW3B;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,MAAM,SAAI;IAQrC;;;;;OAKG;IACH,OAAO,CAAC,KAAK,GAAE,MAAM,EAAO,EAAE,MAAM,GAAE,MAAU;CAyBjD"}