makVrl.Matrix3 Struct Reference

Represents a 3x3 matrix containing 3D rotation and scale. More...

Inheritance diagram for makVrl.Matrix3:

Collaboration diagram for makVrl.Matrix3:

Public Member Functions
	Matrix3 (Vector3f row0, Vector3f row1, Vector3f row2)
	Constructs a new instance.
	Matrix3 (float m00, float m01, float m02, float m10, float m11, float m12, float m20, float m21, float m22)
	Constructs a new instance.
	Matrix3 (Matrix4 matrix)
	Constructs a new instance.
void	Invert ()
	Converts this instance into its inverse.
void	Transpose ()
	Converts this instance into its transpose.
Matrix3	Normalized ()
	Returns a normalised copy of this instance.
void	Normalize ()
	Divides each element in the Matrix by the Determinant.
Matrix3	Inverted ()
	Returns an inverted copy of this instance.
Matrix3	ClearScale ()
	Returns a copy of this Matrix3 without scale.
Matrix3	ClearRotation ()
	Returns a copy of this Matrix3 without rotation.
Vector3f	ExtractScale ()
	Returns the scale component of this instance.
Quaternion	ExtractRotation (bool row_normalise=true)
	Returns the rotation component of this instance.
override string	ToString ()
	Returns a System.String that represents the current Matrix3d.
override int	GetHashCode ()
	Returns the hashcode for this instance.
override bool	Equals (object obj)
	Indicates whether this instance and a specified object are equal.
bool	Equals (Matrix3 other)
	Indicates whether the current matrix is equal to another matrix.

Static Public Member Functions
static void	CreateFromAxisAngle (Vector3f axis, float angle, out Matrix3 result)
	Build a rotation matrix from the specified axis/angle rotation.
static Matrix3	CreateFromAxisAngle (Vector3f axis, float angle)
	Build a rotation matrix from the specified axis/angle rotation.
static void	CreateFromQuaternion (ref Quaternion q, out Matrix3 result)
	Build a rotation matrix from the specified quaternion.
static Matrix3	CreateFromQuaternion (Quaternion q)
	Build a rotation matrix from the specified quaternion.
static void	CreateRotationX (float angle, out Matrix3 result)
	Builds a rotation matrix for a rotation around the x-axis.
static Matrix3	CreateRotationX (float angle)
	Builds a rotation matrix for a rotation around the x-axis.
static void	CreateRotationY (float angle, out Matrix3 result)
	Builds a rotation matrix for a rotation around the y-axis.
static Matrix3	CreateRotationY (float angle)
	Builds a rotation matrix for a rotation around the y-axis.
static void	CreateRotationZ (float angle, out Matrix3 result)
	Builds a rotation matrix for a rotation around the z-axis.
static Matrix3	CreateRotationZ (float angle)
	Builds a rotation matrix for a rotation around the z-axis.
static Matrix3	CreateScale (float scale)
	Creates a scale matrix.
static Matrix3	CreateScale (Vector3f scale)
	Creates a scale matrix.
static Matrix3	CreateScale (float x, float y, float z)
	Creates a scale matrix.
static void	CreateScale (float scale, out Matrix3 result)
	Creates a scale matrix.
static void	CreateScale (ref Vector3f scale, out Matrix3 result)
	Creates a scale matrix.
static void	CreateScale (float x, float y, float z, out Matrix3 result)
	Creates a scale matrix.
static Matrix3	Mult (Matrix3 left, Matrix3 right)
	Multiplies two instances.
static void	Mult (ref Matrix3 left, ref Matrix3 right, out Matrix3 result)
	Multiplies two instances.
static void	Invert (ref Matrix3 mat, out Matrix3 result)
	Calculate the inverse of the given matrix
static Matrix3	Invert (Matrix3 mat)
	Calculate the inverse of the given matrix
static Matrix3	Transpose (Matrix3 mat)
	Calculate the transpose of the given matrix
static void	Transpose (ref Matrix3 mat, out Matrix3 result)
	Calculate the transpose of the given matrix
static Matrix3	operator* (Matrix3 left, Matrix3 right)
	Matrix multiplication
static bool	operator== (Matrix3 left, Matrix3 right)
	Compares two instances for equality.
static bool	operator!= (Matrix3 left, Matrix3 right)
	Compares two instances for inequality.

Public Attributes
Vector3f	Row0
	First row of the matrix.
Vector3f	Row1
	Second row of the matrix.
Vector3f	Row2
	Third row of the matrix.

Static Public Attributes
static readonly Matrix3	Identity = new Matrix3(Vector3f.UnitX, Vector3f.UnitY, Vector3f.UnitZ)
	The identity matrix.
static readonly Matrix3	Zero = new Matrix3(Vector3f.Zero, Vector3f.Zero, Vector3f.Zero)
	The zero matrix.

Properties
float	Determinant [get]
	Gets the determinant of this matrix.
Vector3f	Column0 [get]
	Gets the first column of this matrix.
Vector3f	Column1 [get]
	Gets the second column of this matrix.
Vector3f	Column2 [get]
	Gets the third column of this matrix.
float	M11 [get, set]
	Gets or sets the value at row 1, column 1 of this instance.
float	M12 [get, set]
	Gets or sets the value at row 1, column 2 of this instance.
float	M13 [get, set]
	Gets or sets the value at row 1, column 3 of this instance.
float	M21 [get, set]
	Gets or sets the value at row 2, column 1 of this instance.
float	M22 [get, set]
	Gets or sets the value at row 2, column 2 of this instance.
float	M23 [get, set]
	Gets or sets the value at row 2, column 3 of this instance.
float	M31 [get, set]
	Gets or sets the value at row 3, column 1 of this instance.
float	M32 [get, set]
	Gets or sets the value at row 3, column 2 of this instance.
float	M33 [get, set]
	Gets or sets the value at row 3, column 3 of this instance.
Vector3f	Diagonal [get, set]
	Gets or sets the values along the main diagonal of the matrix.
float	Trace [get]
	Gets the trace of the matrix, the sum of the values along the diagonal.
float	this[int rowIndex, int columnIndex] [get, set]
	Gets or sets the value at a specified row and column.

Detailed Description

Represents a 3x3 matrix containing 3D rotation and scale.

Constructor & Destructor Documentation

makVrl.Matrix3.Matrix3 ( Vector3f  row0, Vector3f  row1, Vector3f  row2  )

inline

Constructs a new instance.

Parameters

row0	Top row of the matrix
row1	Second row of the matrix
row2	Bottom row of the matrix

References makVrl.Matrix3.Row0, makVrl.Matrix3.Row1, and makVrl.Matrix3.Row2.

Referenced by makVrl.Matrix3.Transpose().

makVrl.Matrix3.Matrix3 ( float  m00, float  m01, float  m02, float  m10, float  m11, float  m12, float  m20, float  m21, float  m22  )

inline

Constructs a new instance.

Parameters

m00	First item of the first row of the matrix.
m01	Second item of the first row of the matrix.
m02	Third item of the first row of the matrix.
m10	First item of the second row of the matrix.
m11	Second item of the second row of the matrix.
m12	Third item of the second row of the matrix.
m20	First item of the third row of the matrix.
m21	Second item of the third row of the matrix.
m22	Third item of the third row of the matrix.

References makVrl.Matrix3.Row0, makVrl.Matrix3.Row1, and makVrl.Matrix3.Row2.

makVrl.Matrix3.Matrix3 ( Matrix4  matrix )

inline

Constructs a new instance.

Parameters

matrix

A Matrix4 to take the upper-left 3x3 from.

References makVrl.Matrix3.Row0, makVrl.Matrix4.Row0, makVrl.Matrix3.Row1, makVrl.Matrix4.Row1, makVrl.Matrix3.Row2, makVrl.Matrix4.Row2, and makVrl.Vector4.Xyz.

Member Function Documentation

Matrix3 makVrl.Matrix3.ClearRotation ( )

inline

Returns a copy of this Matrix3 without rotation.

References makVrl.Vector3f.Length, makVrl.Matrix3.Row0, makVrl.Matrix3.Row1, and makVrl.Matrix3.Row2.

Matrix3 makVrl.Matrix3.ClearScale ( )

inline

Returns a copy of this Matrix3 without scale.

References makVrl.Vector3f.Normalized(), makVrl.Matrix3.Row0, makVrl.Matrix3.Row1, and makVrl.Matrix3.Row2.

static void makVrl.Matrix3.CreateFromAxisAngle ( Vector3f  axis, float  angle, out Matrix3  result  )

inlinestatic

Build a rotation matrix from the specified axis/angle rotation.

Parameters

axis	The axis to rotate about.
angle	Angle in radians to rotate counter-clockwise (looking in the direction of the given axis).
result	A matrix instance.

References makVrl.Vector3f.Normalize(), makVrl.Vector3f.X, makVrl.Vector3f.Y, and makVrl.Vector3f.Z.

Referenced by makVrl.Matrix3.CreateFromAxisAngle(), and makVrl.Matrix3.CreateFromQuaternion().

static Matrix3 makVrl.Matrix3.CreateFromAxisAngle ( Vector3f  axis, float  angle  )

inlinestatic

Build a rotation matrix from the specified axis/angle rotation.

Parameters

axis	The axis to rotate about.
angle	Angle in radians to rotate counter-clockwise (looking in the direction of the given axis).

Returns

A matrix instance.

References makVrl.Matrix3.CreateFromAxisAngle().

static void makVrl.Matrix3.CreateFromQuaternion ( ref Quaternion  q, out Matrix3  result  )

inlinestatic

Build a rotation matrix from the specified quaternion.

Parameters

q	Quaternion to translate.
result	Matrix result.

References makVrl.Matrix3.CreateFromAxisAngle().

Referenced by makVrl.Matrix3.CreateFromQuaternion().

static Matrix3 makVrl.Matrix3.CreateFromQuaternion ( Quaternion  q )

inlinestatic

Build a rotation matrix from the specified quaternion.

Parameters

q	Quaternion to translate.

Returns

A matrix instance.

References makVrl.Matrix3.CreateFromQuaternion().

static void makVrl.Matrix3.CreateRotationX ( float  angle, out Matrix3  result  )

inlinestatic

Builds a rotation matrix for a rotation around the x-axis.

Parameters

angle	The counter-clockwise angle in radians.
result	The resulting Matrix3 instance.

References makVrl.Matrix3.Identity, makVrl.Matrix3.Row1, and makVrl.Vector3f.Y.

Referenced by makVrl.Matrix3.CreateRotationX().

static Matrix3 makVrl.Matrix3.CreateRotationX ( float  angle )

inlinestatic

Builds a rotation matrix for a rotation around the x-axis.

Parameters

angle

The counter-clockwise angle in radians.

Returns

The resulting Matrix3 instance.

References makVrl.Matrix3.CreateRotationX().

static void makVrl.Matrix3.CreateRotationY ( float  angle, out Matrix3  result  )

inlinestatic

Builds a rotation matrix for a rotation around the y-axis.

Parameters

angle	The counter-clockwise angle in radians.
result	The resulting Matrix3 instance.

References makVrl.Matrix3.Identity, makVrl.Matrix3.Row0, and makVrl.Vector3f.X.

Referenced by makVrl.Matrix3.CreateRotationY().

static Matrix3 makVrl.Matrix3.CreateRotationY ( float  angle )

inlinestatic

Builds a rotation matrix for a rotation around the y-axis.

Parameters

angle

The counter-clockwise angle in radians.

Returns

The resulting Matrix3 instance.

References makVrl.Matrix3.CreateRotationY().

static void makVrl.Matrix3.CreateRotationZ ( float  angle, out Matrix3  result  )

inlinestatic

Builds a rotation matrix for a rotation around the z-axis.

Parameters

angle	The counter-clockwise angle in radians.
result	The resulting Matrix3 instance.

References makVrl.Matrix3.Identity, makVrl.Matrix3.Row0, and makVrl.Vector3f.X.

Referenced by makVrl.Matrix3.CreateRotationZ().

static Matrix3 makVrl.Matrix3.CreateRotationZ ( float  angle )

inlinestatic

Builds a rotation matrix for a rotation around the z-axis.

Parameters

angle

The counter-clockwise angle in radians.

Returns

The resulting Matrix3 instance.

References makVrl.Matrix3.CreateRotationZ().

static Matrix3 makVrl.Matrix3.CreateScale ( float  scale )

inlinestatic

Creates a scale matrix.

Parameters

scale

Single scale factor for the x, y, and z axes.

Returns

A scale matrix.

Referenced by makVrl.Matrix3.CreateScale().

static Matrix3 makVrl.Matrix3.CreateScale ( Vector3f  scale )

inlinestatic

Creates a scale matrix.

Parameters

scale

Scale factors for the x, y, and z axes.

Returns

A scale matrix.

References makVrl.Matrix3.CreateScale().

static Matrix3 makVrl.Matrix3.CreateScale ( float  x, float  y, float  z  )

inlinestatic

Creates a scale matrix.

Parameters

x	Scale factor for the x axis.
y	Scale factor for the y axis.
z	Scale factor for the z axis.

Returns

A scale matrix.

References makVrl.Matrix3.CreateScale().

static void makVrl.Matrix3.CreateScale ( float  scale, out Matrix3  result  )

inlinestatic

Creates a scale matrix.

Parameters

scale	Single scale factor for the x, y, and z axes.
result	A scale matrix.

References makVrl.Matrix3.Identity, makVrl.Matrix3.Row0, and makVrl.Vector3f.X.

static void makVrl.Matrix3.CreateScale ( ref Vector3f  scale, out Matrix3  result  )

inlinestatic

Creates a scale matrix.

Parameters

scale	Scale factors for the x, y, and z axes.
result	A scale matrix.

References makVrl.Matrix3.Identity, makVrl.Matrix3.Row0, and makVrl.Vector3f.X.

static void makVrl.Matrix3.CreateScale ( float  x, float  y, float  z, out Matrix3  result  )

inlinestatic

Creates a scale matrix.

Parameters

x	Scale factor for the x axis.
y	Scale factor for the y axis.
z	Scale factor for the z axis.
result	A scale matrix.

References makVrl.Matrix3.Identity, makVrl.Matrix3.Row0, and makVrl.Vector3f.X.

override bool makVrl.Matrix3.Equals ( object  obj )

inline

Indicates whether this instance and a specified object are equal.

Parameters

obj	The object to compare to.

Returns

True if the instances are equal; false otherwise.

Referenced by makVrl.Matrix3.operator!=(), and makVrl.Matrix3.operator==().

bool makVrl.Matrix3.Equals ( Matrix3  other )

inline

Indicates whether the current matrix is equal to another matrix.

Parameters

other

A matrix to compare with this matrix.

Returns

true if the current matrix is equal to the matrix parameter; otherwise, false.

References makVrl.Matrix3.Row0, makVrl.Matrix3.Row1, and makVrl.Matrix3.Row2.

Quaternion makVrl.Matrix3.ExtractRotation ( bool  row_normalise = true )

inline

Returns the rotation component of this instance.

Quite slow.

Parameters

row_normalise

Whether the method should row-normalise (i.e. remove scale from) the Matrix. Pass false if you know it's already normalised.

References makVrl.Quaternion.Normalize(), makVrl.Vector3f.Normalized(), makVrl.Matrix3.Row0, makVrl.Matrix3.Row1, makVrl.Matrix3.Row2, makVrl.Quaternion.W, makVrl.Quaternion.X, makVrl.Quaternion.Y, and makVrl.Quaternion.Z.

Vector3f makVrl.Matrix3.ExtractScale ( )

inline

Returns the scale component of this instance.

References makVrl.Vector3f.Length, makVrl.Matrix3.Row0, makVrl.Matrix3.Row1, and makVrl.Matrix3.Row2.

override int makVrl.Matrix3.GetHashCode ( )

inline

Returns the hashcode for this instance.

Returns

A System.Int32 containing the unique hashcode for this instance.

References makVrl.Vector3f.GetHashCode(), makVrl.Matrix3.Row0, makVrl.Matrix3.Row1, and makVrl.Matrix3.Row2.

void makVrl.Matrix3.Invert ( )

inline

Converts this instance into its inverse.

References makVrl.Matrix3.Invert().

Referenced by makVrl.Matrix3.Invert(), and makVrl.Matrix3.Inverted().

static void makVrl.Matrix3.Invert ( ref Matrix3  mat, out Matrix3  result  )

inlinestatic

Calculate the inverse of the given matrix

Parameters

mat	The matrix to invert
result	The inverse of the given matrix if it has one, or the input if it is singular

Exceptions

InvalidOperationException

Thrown if the Matrix3 is singular.

static Matrix3 makVrl.Matrix3.Invert ( Matrix3  mat )

inlinestatic

Calculate the inverse of the given matrix

Parameters

mat	The matrix to invert

Returns

The inverse of the given matrix if it has one, or the input if it is singular

Exceptions

InvalidOperationException

Thrown if the Matrix4 is singular.

References makVrl.Matrix3.Invert().

Matrix3 makVrl.Matrix3.Inverted ( )

inline

Returns an inverted copy of this instance.

References makVrl.Matrix3.Determinant, and makVrl.Matrix3.Invert().

static Matrix3 makVrl.Matrix3.Mult ( Matrix3  left, Matrix3  right  )

inlinestatic

Multiplies two instances.

Parameters

left	The left operand of the multiplication.
right	The right operand of the multiplication.

Returns

A new instance that is the result of the multiplication

Referenced by makVrl.Matrix3.operator*().

static void makVrl.Matrix3.Mult ( ref Matrix3  left, ref Matrix3  right, out Matrix3  result  )

inlinestatic

Multiplies two instances.

Parameters

left	The left operand of the multiplication.
right	The right operand of the multiplication.
result	A new instance that is the result of the multiplication

References makVrl.Matrix3.Row0, and makVrl.Vector3f.X.

void makVrl.Matrix3.Normalize ( )

inline

Divides each element in the Matrix by the Determinant.

References makVrl.Matrix3.Determinant, makVrl.Matrix3.Row0, makVrl.Matrix3.Row1, and makVrl.Matrix3.Row2.

Referenced by makVrl.Matrix3.Normalized().

Matrix3 makVrl.Matrix3.Normalized ( )

inline

Returns a normalised copy of this instance.

References makVrl.Matrix3.Normalize().

static bool makVrl.Matrix3.operator!= ( Matrix3  left, Matrix3  right  )

inlinestatic

Compares two instances for inequality.

Parameters

left	The first instance.
right	The second instance.

Returns

True, if left does not equal right; false otherwise.

References makVrl.Matrix3.Equals().

static Matrix3 makVrl.Matrix3.operator* ( Matrix3  left, Matrix3  right  )

inlinestatic

Matrix multiplication

Parameters

left	left-hand operand
right	right-hand operand

Returns

A new Matrix3d which holds the result of the multiplication

References makVrl.Matrix3.Mult().

static bool makVrl.Matrix3.operator== ( Matrix3  left, Matrix3  right  )

inlinestatic

Compares two instances for equality.

Parameters

left	The first instance.
right	The second instance.

Returns

True, if left equals right; false otherwise.

References makVrl.Matrix3.Equals().

override string makVrl.Matrix3.ToString ( )

inline

Returns a System.String that represents the current Matrix3d.

Returns

The string representation of the matrix.

References makVrl.Matrix3.Row0, makVrl.Matrix3.Row1, and makVrl.Matrix3.Row2.

void makVrl.Matrix3.Transpose ( )

inline

Converts this instance into its transpose.

References makVrl.Matrix3.Transpose().

Referenced by makVrl.Matrix3.Transpose().

static Matrix3 makVrl.Matrix3.Transpose ( Matrix3  mat )

inlinestatic

Calculate the transpose of the given matrix

Parameters

mat	The matrix to transpose

Returns

The transpose of the given matrix

References makVrl.Matrix3.Column0, makVrl.Matrix3.Column1, makVrl.Matrix3.Column2, and makVrl.Matrix3.Matrix3().

static void makVrl.Matrix3.Transpose ( ref Matrix3  mat, out Matrix3  result  )

inlinestatic

Calculate the transpose of the given matrix

Parameters

mat	The matrix to transpose
result	The result of the calculation

Member Data Documentation

readonly Matrix3 makVrl.Matrix3.Identity = new Matrix3(Vector3f.UnitX, Vector3f.UnitY, Vector3f.UnitZ)

static

The identity matrix.

Referenced by makVrl.Matrix3.CreateRotationX(), makVrl.Matrix3.CreateRotationY(), makVrl.Matrix3.CreateRotationZ(), and makVrl.Matrix3.CreateScale().

Vector3f makVrl.Matrix3.Row0

First row of the matrix.

Referenced by makVrl.Matrix3.ClearRotation(), makVrl.Matrix3.ClearScale(), makVrl.Matrix3.CreateRotationY(), makVrl.Matrix3.CreateRotationZ(), makVrl.Matrix3.CreateScale(), makVrl.Matrix3.Equals(), makVrl.Matrix3.ExtractRotation(), makVrl.Matrix3.ExtractScale(), makVrl.Matrix3.GetHashCode(), makVrl.Matrix3.Matrix3(), makVrl.Matrix3.Mult(), makVrl.Matrix3.Normalize(), and makVrl.Matrix3.ToString().

Vector3f makVrl.Matrix3.Row1

Second row of the matrix.

Referenced by makVrl.Matrix3.ClearRotation(), makVrl.Matrix3.ClearScale(), makVrl.Matrix3.CreateRotationX(), makVrl.Matrix3.Equals(), makVrl.Matrix3.ExtractRotation(), makVrl.Matrix3.ExtractScale(), makVrl.Matrix3.GetHashCode(), makVrl.Matrix3.Matrix3(), makVrl.Matrix3.Normalize(), and makVrl.Matrix3.ToString().

Vector3f makVrl.Matrix3.Row2

Third row of the matrix.

Referenced by makVrl.Matrix3.ClearRotation(), makVrl.Matrix3.ClearScale(), makVrl.Matrix3.Equals(), makVrl.Matrix3.ExtractRotation(), makVrl.Matrix3.ExtractScale(), makVrl.Matrix3.GetHashCode(), makVrl.Matrix3.Matrix3(), makVrl.Matrix3.Normalize(), and makVrl.Matrix3.ToString().

readonly Matrix3 makVrl.Matrix3.Zero = new Matrix3(Vector3f.Zero, Vector3f.Zero, Vector3f.Zero)

static

The zero matrix.

Property Documentation

Vector3f makVrl.Matrix3.Column0

get

Gets the first column of this matrix.

Referenced by makVrl.Matrix3.Transpose().

Vector3f makVrl.Matrix3.Column1

get

Gets the second column of this matrix.

Referenced by makVrl.Matrix3.Transpose().

Vector3f makVrl.Matrix3.Column2

get

Gets the third column of this matrix.

Referenced by makVrl.Matrix3.Transpose().

float makVrl.Matrix3.Determinant

get

Gets the determinant of this matrix.

Referenced by makVrl.Matrix3.Inverted(), and makVrl.Matrix3.Normalize().

Vector3f makVrl.Matrix3.Diagonal

getset

Gets or sets the values along the main diagonal of the matrix.

float makVrl.Matrix3.M11

getset

Gets or sets the value at row 1, column 1 of this instance.

float makVrl.Matrix3.M12

getset

Gets or sets the value at row 1, column 2 of this instance.

float makVrl.Matrix3.M13

getset

Gets or sets the value at row 1, column 3 of this instance.

float makVrl.Matrix3.M21

getset

Gets or sets the value at row 2, column 1 of this instance.

float makVrl.Matrix3.M22

getset

Gets or sets the value at row 2, column 2 of this instance.

float makVrl.Matrix3.M23

getset

Gets or sets the value at row 2, column 3 of this instance.

float makVrl.Matrix3.M31

getset

Gets or sets the value at row 3, column 1 of this instance.

float makVrl.Matrix3.M32

getset

Gets or sets the value at row 3, column 2 of this instance.

float makVrl.Matrix3.M33

getset

Gets or sets the value at row 3, column 3 of this instance.

float makVrl.Matrix3.this[int rowIndex, int columnIndex]

getset

Gets or sets the value at a specified row and column.

float makVrl.Matrix3.Trace

get

Gets the trace of the matrix, the sum of the values along the diagonal.

---

The documentation for this struct was generated from the following file:

• Matrix3.cs