@tlua/gmod 1.0.1

package/vmatrix.d.tlua

@@ -0,0 +1,392 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * A 4x4 matrix. This page lists all possible functions to manipulate matrices.
+ * Created by Global.Matrix.
+ *
+ * Arithmetic operators are typed as metamethod members, which tlua dispatches
+ * ambiently on the declared type: `VMatrix * Vector` yields a Vector and
+ * `VMatrix * VMatrix` yields a VMatrix, selected by the right operand.
+ */
+interface VMatrix {
+    __add(l: VMatrix, r: VMatrix): VMatrix;
+    __sub(l: VMatrix, r: VMatrix): VMatrix;
+    __mul(l: VMatrix, r: Vector): Vector;
+    __mul(l: VMatrix, r: VMatrix): VMatrix;
+    __unm(m: VMatrix): VMatrix;
+}
+
+interface VMatrix {
+    /**
+     * Adds given matrix to this matrix.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:Add
+     */
+    Add(self: VMatrix, input: VMatrix): void;
+}
+
+interface VMatrix {
+    /**
+     * Returns the absolute rotation of the matrix. Scaled matrix might produce unexpected results!
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:GetAngles
+     */
+    GetAngles(self: VMatrix): Angle;
+}
+
+interface VMatrix {
+    /**
+     * Returns a specific field in the matrix.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:GetField
+     */
+    GetField(self: VMatrix, row: number, column: number): number;
+}
+
+interface VMatrix {
+    /**
+     * Gets the forward direction of the matrix.
+     *
+     * ie. The first column of the matrix, excluding the w coordinate.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:GetForward
+     */
+    GetForward(self: VMatrix): Vector;
+}
+
+interface VMatrix {
+    /**
+     * Returns an inverted matrix without modifying the original matrix.
+     *
+     * Inverting the matrix will fail if its [determinant](https://en.wikipedia.org/wiki/Determinant) is 0 or close to 0. (ie. its "scale" in any direction is 0.)
+     *
+     * See also [VMatrix:GetInverseTR](https://wiki.facepunch.com/gmod/VMatrix:GetInverseTR).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:GetInverse
+     */
+    GetInverse(self: VMatrix): VMatrix;
+}
+
+interface VMatrix {
+    /**
+     * Returns an inverted matrix without modifying the original matrix. This function will not fail, but only works correctly on matrices that contain only translation and/or rotation.
+     *
+     * Using this function on a matrix with modified scale may return an incorrect inverted matrix.
+     *
+     * To get the inverse of a matrix that contains other modifications, see [VMatrix:GetInverse](https://wiki.facepunch.com/gmod/VMatrix:GetInverse).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:GetInverseTR
+     */
+    GetInverseTR(self: VMatrix): VMatrix;
+}
+
+interface VMatrix {
+    /**
+     * Gets the right direction of the matrix.
+     *
+     * ie. The second column of the matrix, negated, excluding the w coordinate.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:GetRight
+     */
+    GetRight(self: VMatrix): Vector;
+}
+
+interface VMatrix {
+    /**
+     * Returns the absolute scale of the matrix.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:GetScale
+     */
+    GetScale(self: VMatrix): Vector;
+}
+
+interface VMatrix {
+    /**
+     * Returns the absolute translation of the matrix.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:GetTranslation
+     */
+    GetTranslation(self: VMatrix): Vector;
+}
+
+interface VMatrix {
+    /**
+     * Returns the transpose (each row becomes a column) of this matrix.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:GetTransposed
+     */
+    GetTransposed(self: VMatrix): VMatrix;
+}
+
+interface VMatrix {
+    /**
+     * Gets the up direction of the matrix.
+     *
+     * ie. The third column of the matrix, excluding the w coordinate.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:GetUp
+     */
+    GetUp(self: VMatrix): Vector;
+}
+
+interface VMatrix {
+    /**
+     * Initializes the matrix as Identity matrix.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:Identity
+     */
+    Identity(self: VMatrix): void;
+}
+
+interface VMatrix {
+    /**
+     * Inverts the matrix.
+     *
+     * Inverting the matrix will fail if its [determinant](https://en.wikipedia.org/wiki/Determinant) is 0 or close to 0. (ie. its "scale" in any direction is 0.)
+     *
+     * If the matrix cannot be inverted, it does not get modified.
+     *
+     * See also [VMatrix:InvertTR](https://wiki.facepunch.com/gmod/VMatrix:InvertTR).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:Invert
+     */
+    Invert(self: VMatrix): boolean;
+}
+
+interface VMatrix {
+    /**
+     * Quickly inverts the matrix. This function will not fail, but only works correctly on matrices that contain only translation and/or rotation.
+     *
+     * Using this function on a matrix with modified scale may return an incorrect inverted matrix.
+     *
+     * To invert a matrix that contains other modifications, see [VMatrix:Invert](https://wiki.facepunch.com/gmod/VMatrix:Invert). This function is faster.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:InvertTR
+     */
+    InvertTR(self: VMatrix): void;
+}
+
+interface VMatrix {
+    /**
+     * Returns whether the matrix is equal to Identity matrix or not.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:IsIdentity
+     */
+    IsIdentity(self: VMatrix): boolean;
+}
+
+interface VMatrix {
+    /**
+     * Returns whether the matrix is a rotation matrix or not.
+     *
+     * Technically it checks if the forward, right and up vectors are orthogonal and normalized.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:IsRotationMatrix
+     */
+    IsRotationMatrix(self: VMatrix): boolean;
+}
+
+interface VMatrix {
+    /**
+     * Checks whenever all fields of the matrix are 0, aka if this is a [null matrix](https://en.wikipedia.org/wiki/Zero_matrix).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:IsZero
+     */
+    IsZero(self: VMatrix): boolean;
+}
+
+interface VMatrix {
+    /**
+     * Multiplies this matrix by given matrix.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:Mul
+     */
+    Mul(self: VMatrix, input: VMatrix): void;
+}
+
+interface VMatrix {
+    /**
+     * Rotates the matrix by the given angle.
+     *
+     * Postmultiplies the matrix by a rotation matrix (A = AR).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:Rotate
+     */
+    Rotate(self: VMatrix, rotation: Angle): void;
+}
+
+interface VMatrix {
+    /**
+     * Scales the matrix by the given vector.
+     *
+     * Postmultiplies the matrix by a scaling matrix (A = AS).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:Scale
+     */
+    Scale(self: VMatrix, scale: Vector): void;
+}
+
+interface VMatrix {
+    /**
+     * Scales the absolute translation with the given value.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:ScaleTranslation
+     */
+    ScaleTranslation(self: VMatrix, scale: number): void;
+}
+
+interface VMatrix {
+    /**
+     * Copies values from the given matrix object.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:Set
+     */
+    Set(self: VMatrix, src: VMatrix): void;
+}
+
+interface VMatrix {
+    /**
+     * Sets the absolute rotation of the matrix.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:SetAngles
+     */
+    SetAngles(self: VMatrix, angle: Angle): void;
+}
+
+interface VMatrix {
+    /**
+     * Sets a specific field in the matrix.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:SetField
+     */
+    SetField(self: VMatrix, row: number, column: number, value: number): void;
+}
+
+interface VMatrix {
+    /**
+     * Sets the forward direction of the matrix.
+     *
+     * ie. The first column of the matrix, excluding the w coordinate.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:SetForward
+     */
+    SetForward(self: VMatrix, forward: Vector): void;
+}
+
+interface VMatrix {
+    /**
+     * Sets the right direction of the matrix.
+     *
+     * ie. The second column of the matrix, negated, excluding the w coordinate.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:SetRight
+     */
+    SetRight(self: VMatrix, right: Vector): void;
+}
+
+interface VMatrix {
+    /**
+     * Modifies the scale of the matrix while preserving the rotation and translation.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:SetScale
+     */
+    SetScale(self: VMatrix, scale: Vector): void;
+}
+
+interface VMatrix {
+    /**
+     * Sets the absolute translation of the matrix.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:SetTranslation
+     */
+    SetTranslation(self: VMatrix, translation: Vector): void;
+}
+
+interface VMatrix {
+    /**
+     * Sets each component of the matrix.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:SetUnpacked
+     */
+    SetUnpacked(self: VMatrix, e11: number, e12: number, e13: number, e14: number, e21: number, e22: number, e23: number, e24: number, e31: number, e32: number, e33: number, e34: number, e41: number, e42: number, e43: number, e44: number): void;
+}
+
+interface VMatrix {
+    /**
+     * Sets the up direction of the matrix.
+     *
+     * ie. The third column of the matrix, excluding the w coordinate.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:SetUp
+     */
+    SetUp(self: VMatrix, up: Vector): void;
+}
+
+interface VMatrix {
+    /**
+     * Subtracts given matrix from this matrix.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:Sub
+     */
+    Sub(self: VMatrix, input: VMatrix): void;
+}
+
+interface VMatrix {
+    /**
+     * Converts the matrix to a 4x4 table. See [Global.Matrix](https://wiki.facepunch.com/gmod/Global.Matrix) function.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:ToTable
+     */
+    ToTable(self: VMatrix): table;
+}
+
+interface VMatrix {
+    /**
+     * Translates the matrix by the given vector aka. adds the vector to the translation.
+     *
+     * Postmultiplies the matrix by a translation matrix (A = AT).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:Translate
+     */
+    Translate(self: VMatrix, translation: Vector): void;
+}
+
+interface VMatrix {
+    /**
+     * Returns each component of the matrix, expanding rows before columns.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:Unpack
+     */
+    Unpack(self: VMatrix): (number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number);
+}
+
+interface VMatrix {
+    /**
+     * Sets all components of the matrix to 0, also known as a [null matrix](https://en.wikipedia.org/wiki/Zero_matrix).
+     *
+     * This function is more efficient than setting each element manually.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/VMatrix:Zero
+     */
+    Zero(self: VMatrix): void;
+}
+