Matrix Structure

RAGE Plugin Hook Documentation

[This is preliminary documentation and is subject to change.]

Defines a 4x4 matrix.

Namespace:  Rage
Assembly:  RagePluginHook (in RagePluginHook.dll) Version: 0.0.0.0 (0.56.1131.11510)
Syntax

[SerializableAttribute]
public struct Matrix : IEquatable<Matrix>

The Matrix type exposes the following members.

Properties

  NameDescription
Public propertyColumns
Public propertyStatic memberIdentity
Gets a Matrix that represents an identity matrix.
Public propertyIsIdentity
Gets a value indicating whether this instance is an identity matrix.
Public propertyItem
Public propertyRows
Top
Methods

  NameDescription
Public methodStatic memberAdd(Matrix, Matrix)
Determines the sum of two matrices.
Public methodStatic memberAdd(Matrix, Matrix, Matrix)
Determines the sum of two matrices.
Public methodStatic memberAffineTransformation(Single, Vector3, Quaternion, Vector3)
Creates a 3D affine transformation matrix.
Public methodStatic memberAffineTransformation(Single, Vector3, Quaternion, Vector3, Matrix)
Creates a 3D affine transformation matrix.
Public methodStatic memberAffineTransformation2D(Single, Vector2, Single, Vector2)
Creates a 2D affine transformation matrix.
Public methodStatic memberAffineTransformation2D(Single, Vector2, Single, Vector2, Matrix)
Creates a 2D affine transformation matrix.
Public methodStatic memberBillboard(Vector3, Vector3, Vector3, Vector3)
Creates a spherical billboard that rotates around a specified object position.
Public methodStatic memberBillboard(Vector3, Vector3, Vector3, Vector3, Matrix)
Creates a spherical billboard that rotates around a specified object position.
Public methodDecompose
Decomposes the matrix into its scalar, rotational, and translational elements.
Public methodDeterminant
Calculates the determinant of the matrix.
Public methodStatic memberDivide(Matrix, Matrix)
Determines the quotient of two matrices.
Public methodStatic memberDivide(Matrix, Single)
Scales a matrix by the given value.
Public methodStatic memberDivide(Matrix, Matrix, Matrix)
Determines the quotient of two matrices.
Public methodStatic memberDivide(Matrix, Single, Matrix)
Scales a matrix by the given value.
Public methodEquals(Object)
Returns a value that indicates whether the current instance is equal to a specified object.
(Overrides ValueTypeEquals(Object).)
Public methodEquals(Matrix)
Returns a value that indicates whether the current instance is equal to the specified object.
Public methodStatic memberEquals(Matrix, Matrix)
Determines whether the specified object instances are considered equal.
Public methodGetHashCode
Returns the hash code for this instance.
(Overrides ValueTypeGetHashCode.)
Public methodInvert
Inverts the matrix.
Public methodStatic memberInvert(Matrix)
Calculates the inverse of the specified matrix.
Public methodStatic memberInvert(Matrix, Matrix)
Calculates the inverse of the specified matrix.
Public methodStatic memberLerp(Matrix, Matrix, Single)
Performs a linear interpolation between two matricies.
Public methodStatic memberLerp(Matrix, Matrix, Single, Matrix)
Performs a linear interpolation between two matricies.
Public methodStatic memberLookAtLH(Vector3, Vector3, Vector3)
Creates a left-handed, look-at matrix.
Public methodStatic memberLookAtLH(Vector3, Vector3, Vector3, Matrix)
Creates a left-handed, look-at matrix.
Public methodStatic memberLookAtRH(Vector3, Vector3, Vector3)
Creates a right-handed, look-at matrix.
Public methodStatic memberLookAtRH(Vector3, Vector3, Vector3, Matrix)
Creates a right-handed, look-at matrix.
Public methodStatic memberMultiply(Matrix, Matrix)
Determines the product of two matrices.
Public methodStatic memberMultiply(Matrix, Single)
Scales a matrix by the given value.
Public methodStatic memberMultiply(Matrix, Matrix, Matrix)
Determines the product of two matrices.
Public methodStatic memberMultiply(Matrix, Single, Matrix)
Scales a matrix by the given value.
Public methodStatic memberMultiply(Matrix, Matrix, Matrix)
Determines the products of of an array of matrices by a single matrix.
Public methodStatic memberMultiply(Matrix, Matrix, Matrix)
Determines the products of two arrays of matrices.
Public methodStatic memberMultiply(Matrix*, Matrix*, Matrix*, Int32)
Determines the products of two arrays of matrices.
Public methodStatic memberMultiply(Matrix, Matrix, Matrix, Int32, Int32)
Determines the products of of an array of matrices by a single matrix.
Public methodStatic memberMultiply(Matrix, Matrix, Matrix, Int32, Int32)
Determines the products of two arrays of matrices.
Public methodStatic memberNegate(Matrix)
Negates a matrix.
Public methodStatic memberNegate(Matrix, Matrix)
Negates a matrix.
Public methodStatic memberOrthoLH(Single, Single, Single, Single)
Creates a left-handed, orthographic projection matrix.
Public methodStatic memberOrthoLH(Single, Single, Single, Single, Matrix)
Creates a left-handed, orthographic projection matrix.
Public methodStatic memberOrthoOffCenterLH(Single, Single, Single, Single, Single, Single)
Creates a left-handed, customized orthographic projection matrix.
Public methodStatic memberOrthoOffCenterLH(Single, Single, Single, Single, Single, Single, Matrix)
Creates a left-handed, customized orthographic projection matrix.
Public methodStatic memberOrthoOffCenterRH(Single, Single, Single, Single, Single, Single)
Creates a right-handed, customized orthographic projection matrix.
Public methodStatic memberOrthoOffCenterRH(Single, Single, Single, Single, Single, Single, Matrix)
Creates a right-handed, customized orthographic projection matrix.
Public methodStatic memberOrthoRH(Single, Single, Single, Single)
Creates a right-handed, orthographic projection matrix.
Public methodStatic memberOrthoRH(Single, Single, Single, Single, Matrix)
Creates a right-handed, orthographic projection matrix.
Public methodStatic memberPerspectiveFovLH(Single, Single, Single, Single)
Creates a left-handed, perspective projection matrix based on a field of view.
Public methodStatic memberPerspectiveFovLH(Single, Single, Single, Single, Matrix)
Creates a left-handed, perspective projection matrix based on a field of view.
Public methodStatic memberPerspectiveFovRH(Single, Single, Single, Single)
Creates a right-handed, perspective projection matrix based on a field of view.
Public methodStatic memberPerspectiveFovRH(Single, Single, Single, Single, Matrix)
Creates a right-handed, perspective projection matrix based on a field of view.
Public methodStatic memberPerspectiveLH(Single, Single, Single, Single)
Creates a left-handed, perspective projection matrix.
Public methodStatic memberPerspectiveLH(Single, Single, Single, Single, Matrix)
Creates a left-handed, perspective projection matrix.
Public methodStatic memberPerspectiveOffCenterLH(Single, Single, Single, Single, Single, Single)
Creates a left-handed, customized perspective projection matrix.
Public methodStatic memberPerspectiveOffCenterLH(Single, Single, Single, Single, Single, Single, Matrix)
Creates a left-handed, customized perspective projection matrix.
Public methodStatic memberPerspectiveOffCenterRH(Single, Single, Single, Single, Single, Single)
Creates a right-handed, customized perspective projection matrix.
Public methodStatic memberPerspectiveOffCenterRH(Single, Single, Single, Single, Single, Single, Matrix)
Creates a right-handed, customized perspective projection matrix.
Public methodStatic memberPerspectiveRH(Single, Single, Single, Single)
Creates a right-handed, perspective projection matrix.
Public methodStatic memberPerspectiveRH(Single, Single, Single, Single, Matrix)
Creates a right-handed, perspective projection matrix.
Public methodStatic memberRotationAxis(Vector3, Single)
Creates a matrix that rotates around an arbitary axis.
Public methodStatic memberRotationAxis(Vector3, Single, Matrix)
Creates a matrix that rotates around an arbitary axis.
Public methodStatic memberRotationQuaternion(Quaternion)
Creates a rotation matrix from a quaternion.
Public methodStatic memberRotationQuaternion(Quaternion, Matrix)
Creates a rotation matrix from a quaternion.
Public methodStatic memberRotationX(Single)
Creates a matrix that rotates around the x-axis.
Public methodStatic memberRotationX(Single, Matrix)
Creates a matrix that rotates around the x-axis.
Public methodStatic memberRotationY(Single)
Creates a matrix that rotates around the y-axis.
Public methodStatic memberRotationY(Single, Matrix)
Creates a matrix that rotates around the y-axis.
Public methodStatic memberRotationYawPitchRoll(Single, Single, Single)
Creates a rotation matrix with a specified yaw, pitch, and roll.
Public methodStatic memberRotationYawPitchRoll(Single, Single, Single, Matrix)
Creates a rotation matrix with a specified yaw, pitch, and roll.
Public methodStatic memberRotationZ(Single)
Creates a matrix that rotates around the z-axis.
Public methodStatic memberRotationZ(Single, Matrix)
Creates a matrix that rotates around the z-axis.
Public methodStatic memberScaling(Vector3)
Creates a matrix that scales along the x-axis, y-axis, and y-axis.
Public methodStatic memberScaling(Vector3, Matrix)
Creates a matrix that scales along the x-axis, y-axis, and y-axis.
Public methodStatic memberScaling(Single, Single, Single)
Creates a matrix that scales along the x-axis, y-axis, and y-axis.
Public methodStatic memberScaling(Single, Single, Single, Matrix)
Creates a matrix that scales along the x-axis, y-axis, and y-axis.
Public methodStatic memberSubtract(Matrix, Matrix)
Determines the difference between two matrices.
Public methodStatic memberSubtract(Matrix, Matrix, Matrix)
Determines the difference between two matrices.
Public methodToArray
Public methodToString
Converts the value of the object to its equivalent string representation.
(Overrides ValueTypeToString.)
Public methodStatic memberTransformation(Vector3, Quaternion, Vector3, Vector3, Quaternion, Vector3)
Creates a transformation matrix.
Public methodStatic memberTransformation(Vector3, Quaternion, Vector3, Vector3, Quaternion, Vector3, Matrix)
Creates a transformation matrix.
Public methodStatic memberTransformation2D(Vector2, Single, Vector2, Vector2, Single, Vector2)
Creates a 2D transformation matrix.
Public methodStatic memberTransformation2D(Vector2, Single, Vector2, Vector2, Single, Vector2, Matrix)
Creates a 2D transformation matrix.
Public methodStatic memberTranslation(Vector3)
Creates a translation matrix using the specified offsets.
Public methodStatic memberTranslation(Vector3, Matrix)
Creates a translation matrix using the specified offsets.
Public methodStatic memberTranslation(Single, Single, Single)
Creates a translation matrix using the specified offsets.
Public methodStatic memberTranslation(Single, Single, Single, Matrix)
Creates a translation matrix using the specified offsets.
Public methodStatic memberTranspose(Matrix)
Calculates the transpose of the specified matrix.
Public methodStatic memberTranspose(Matrix, Matrix)
Calculates the transpose of the specified matrix.
Top
Operators

  NameDescription
Public operatorStatic memberAddition
Adds two matricies.
Public operatorStatic memberDivision(Matrix, Matrix)
Divides two matricies.
Public operatorStatic memberDivision(Matrix, Single)
Scales a matrix by a given value.
Public operatorStatic memberEquality
Tests for equality between two objects.
Public operatorStatic memberInequality
Tests for inequality between two objects.
Public operatorStatic memberMultiply(Single, Matrix)
Scales a matrix by a given value.
Public operatorStatic memberMultiply(Matrix, Matrix)
Multiplies two matricies.
Public operatorStatic memberMultiply(Matrix, Single)
Scales a matrix by a given value.
Public operatorStatic memberSubtraction
Subtracts two matricies.
Public operatorStatic memberUnaryNegation
Negates a matrix.
Top
Fields

  NameDescription
Public fieldM11
Gets or sets the element of the matrix that exists in the first row and first column.
Public fieldM12
Gets or sets the element of the matrix that exists in the first row and second column.
Public fieldM13
Gets or sets the element of the matrix that exists in the first row and third column.
Public fieldM14
Gets or sets the element of the matrix that exists in the first row and fourth column.
Public fieldM21
Gets or sets the element of the matrix that exists in the second row and first column.
Public fieldM22
Gets or sets the element of the matrix that exists in the second row and second column.
Public fieldM23
Gets or sets the element of the matrix that exists in the second row and third column.
Public fieldM24
Gets or sets the element of the matrix that exists in the second row and fourth column.
Public fieldM31
Gets or sets the element of the matrix that exists in the third row and first column.
Public fieldM32
Gets or sets the element of the matrix that exists in the third row and second column.
Public fieldM33
Gets or sets the element of the matrix that exists in the third row and third column.
Public fieldM34
Gets or sets the element of the matrix that exists in the third row and fourth column.
Public fieldM41
Gets or sets the element of the matrix that exists in the fourth row and first column.
Public fieldM42
Gets or sets the element of the matrix that exists in the fourth row and second column.
Public fieldM43
Gets or sets the element of the matrix that exists in the fourth row and third column.
Public fieldM44
Gets or sets the element of the matrix that exists in the fourth row and fourth column.
Top
See Also

Reference