Represents a 4x4 matrix containing 3D rotation, scale, transform, and projection. More...

Inheritance diagram for makVrl.Matrix4:

Collaboration diagram for makVrl.Matrix4:

Public Member Functions
	Matrix4 (Vector4 row0, Vector4 row1, Vector4 row2, Vector4 row3)
	Constructs a new instance. More...

	Matrix4 (float m00, float m01, float m02, float m03, float m10, float m11, float m12, float m13, float m20, float m21, float m22, float m23, float m30, float m31, float m32, float m33)
	Constructs a new instance. More...

void	Invert ()
	Converts this instance into its inverse. More...

void	Transpose ()
	Converts this instance into its transpose. More...

Matrix4	Normalized ()
	Returns a normalised copy of this instance. More...

void	Normalize ()
	Divides each element in the Matrix by the Determinant. More...

Matrix4	Inverted ()
	Returns an inverted copy of this instance. More...

Matrix4	ClearTranslation ()
	Returns a copy of this Matrix4 without translation. More...

Matrix4	ClearScale ()
	Returns a copy of this Matrix4 without scale. More...

Matrix4	ClearRotation ()
	Returns a copy of this Matrix4 without rotation. More...

Matrix4	ClearProjection ()
	Returns a copy of this Matrix4 without projection. More...

Vector3f	ExtractTranslation ()
	Returns the translation component of this instance. More...

Vector3f	ExtractScale ()
	Returns the scale component of this instance. More...

Quaternion	ExtractRotation (bool row_normalise=true)
	Returns the rotation component of this instance. More...

Vector4	ExtractProjection ()
	Returns the projection component of this instance. More...

override string	ToString ()
	Returns a System.String that represents the current Matrix4. More...

override int	GetHashCode ()
	Returns the hashcode for this instance. More...

override bool	Equals (object obj)
	Indicates whether this instance and a specified object are equal. More...

bool	Equals (Matrix4 other)
	Indicates whether the current matrix is equal to another matrix. More...

Static Public Member Functions
static void	CreateFromAxisAngle (Vector3f axis, float angle, out Matrix4 result)
	Build a rotation matrix from the specified axis/angle rotation. More...

static Matrix4	CreateFromAxisAngle (Vector3f axis, float angle)
	Build a rotation matrix from the specified axis/angle rotation. More...

static void	CreateFromQuaternion (ref Quaternion q, out Matrix4 result)
	Builds a rotation matrix from a quaternion. More...

static Matrix4	CreateFromQuaternion (Quaternion q)
	Builds a rotation matrix from a quaternion. More...

static void	CreateRotationX (float angle, out Matrix4 result)
	Builds a rotation matrix for a rotation around the x-axis. More...

static Matrix4	CreateRotationX (float angle)
	Builds a rotation matrix for a rotation around the x-axis. More...

static void	CreateRotationY (float angle, out Matrix4 result)
	Builds a rotation matrix for a rotation around the y-axis. More...

static Matrix4	CreateRotationY (float angle)
	Builds a rotation matrix for a rotation around the y-axis. More...

static void	CreateRotationZ (float angle, out Matrix4 result)
	Builds a rotation matrix for a rotation around the z-axis. More...

static Matrix4	CreateRotationZ (float angle)
	Builds a rotation matrix for a rotation around the z-axis. More...

static void	CreateTranslation (float x, float y, float z, out Matrix4 result)
	Creates a translation matrix. More...

static void	CreateTranslation (ref Vector3f vector, out Matrix4 result)
	Creates a translation matrix. More...

static Matrix4	CreateTranslation (float x, float y, float z)
	Creates a translation matrix. More...

static Matrix4	CreateTranslation (Vector3f vector)
	Creates a translation matrix. More...

static Matrix4	CreateScale (float scale)
	Creates a scale matrix. More...

static Matrix4	CreateScale (Vector3f scale)
	Creates a scale matrix. More...

static Matrix4	CreateScale (float x, float y, float z)
	Creates a scale matrix. More...

static void	CreateScale (float scale, out Matrix4 result)
	Creates a scale matrix. More...

static void	CreateScale (ref Vector3f scale, out Matrix4 result)
	Creates a scale matrix. More...

static void	CreateScale (float x, float y, float z, out Matrix4 result)
	Creates a scale matrix. More...

static void	CreateOrthographic (float width, float height, float zNear, float zFar, out Matrix4 result)
	Creates an orthographic projection matrix. More...

static Matrix4	CreateOrthographic (float width, float height, float zNear, float zFar)
	Creates an orthographic projection matrix. More...

static void	CreateOrthographicOffCenter (float left, float right, float bottom, float top, float zNear, float zFar, out Matrix4 result)
	Creates an orthographic projection matrix. More...

static Matrix4	CreateOrthographicOffCenter (float left, float right, float bottom, float top, float zNear, float zFar)
	Creates an orthographic projection matrix. More...

static void	CreatePerspectiveFieldOfView (float fovy, float aspect, float zNear, float zFar, out Matrix4 result)
	Creates a perspective projection matrix. More...

static Matrix4	CreatePerspectiveFieldOfView (float fovy, float aspect, float zNear, float zFar)
	Creates a perspective projection matrix. More...

static void	CreatePerspectiveOffCenter (float left, float right, float bottom, float top, float zNear, float zFar, out Matrix4 result)
	Creates an perspective projection matrix. More...

static Matrix4	CreatePerspectiveOffCenter (float left, float right, float bottom, float top, float zNear, float zFar)
	Creates an perspective projection matrix. More...

static Matrix4	Translation (Vector3f trans)
	Builds a translation matrix. More...

static Matrix4	Translation (float x, float y, float z)
	Build a translation matrix with the given translation More...

static Matrix4	RotateX (float angle)
	Build a rotation matrix that rotates about the x-axis More...

static Matrix4	RotateY (float angle)
	Build a rotation matrix that rotates about the y-axis More...

static Matrix4	RotateZ (float angle)
	Build a rotation matrix that rotates about the z-axis More...

static Matrix4	Rotate (Vector3f axis, float angle)
	Build a rotation matrix to rotate about the given axis More...

static Matrix4	Rotate (Quaternion q)
	Build a rotation matrix from a quaternion More...

static Matrix4	Scale (float scale)
	Build a scaling matrix More...

static Matrix4	Scale (Vector3f scale)
	Build a scaling matrix More...

static Matrix4	Scale (float x, float y, float z)
	Build a scaling matrix More...

static Matrix4	Frustum (float left, float right, float bottom, float top, float near, float far)
	Build a projection matrix More...

static Matrix4	Perspective (float fovy, float aspect, float near, float far)
	Build a projection matrix More...

static Matrix4	LookAt (Vector3f eye, Vector3f target, Vector3f up)
	Build a world space to camera space matrix More...

static Matrix4	LookAt (float eyeX, float eyeY, float eyeZ, float targetX, float targetY, float targetZ, float upX, float upY, float upZ)
	Build a world space to camera space matrix More...

static Matrix4	Add (Matrix4 left, Matrix4 right)
	Adds two instances. More...

static void	Add (ref Matrix4 left, ref Matrix4 right, out Matrix4 result)
	Adds two instances. More...

static Matrix4	Subtract (Matrix4 left, Matrix4 right)
	Subtracts one instance from another. More...

static void	Subtract (ref Matrix4 left, ref Matrix4 right, out Matrix4 result)
	Subtracts one instance from another. More...

static Matrix4	Mult (Matrix4 left, Matrix4 right)
	Multiplies two instances. More...

static void	Mult (ref Matrix4 left, ref Matrix4 right, out Matrix4 result)
	Multiplies two instances. More...

static Matrix4	Mult (Matrix4 left, float right)
	Multiplies an instance by a scalar. More...

static void	Mult (ref Matrix4 left, float right, out Matrix4 result)
	Multiplies an instance by a scalar. More...

static void	Invert (ref Matrix4 mat, out Matrix4 result)
	Calculate the inverse of the given matrix More...

static Matrix4	Invert (Matrix4 mat)
	Calculate the inverse of the given matrix More...

static Matrix4	Transpose (Matrix4 mat)
	Calculate the transpose of the given matrix More...

static void	Transpose (ref Matrix4 mat, out Matrix4 result)
	Calculate the transpose of the given matrix More...

static Matrix4	operator* (Matrix4 left, Matrix4 right)
	Matrix multiplication More...

static Matrix4	operator* (Matrix4 left, float right)
	Matrix-scalar multiplication More...

static Matrix4	operator+ (Matrix4 left, Matrix4 right)
	Matrix addition More...

static Matrix4	operator- (Matrix4 left, Matrix4 right)
	Matrix subtraction More...

static bool	operator== (Matrix4 left, Matrix4 right)
	Compares two instances for equality. More...

static bool	operator!= (Matrix4 left, Matrix4 right)
	Compares two instances for inequality. More...

Public Attributes
Vector4	Row0
	Top row of the matrix. More...

Vector4	Row1
	2nd row of the matrix. More...

Vector4	Row2
	3rd row of the matrix. More...

Vector4	Row3
	Bottom row of the matrix. More...

Static Public Attributes
static readonly Matrix4	Identity = new Matrix4(Vector4.UnitX, Vector4.UnitY, Vector4.UnitZ, Vector4.UnitW)
	The identity matrix. More...

static readonly Matrix4	Zero = new Matrix4(Vector4.Zero, Vector4.Zero, Vector4.Zero, Vector4.Zero)
	The zero matrix. More...

Properties
float	Determinant `[get]`
	Gets the determinant of this matrix. More...

Vector4	Column0 `[get, set]`
	Gets the first column of this matrix. More...

Vector4	Column1 `[get, set]`
	Gets the second column of this matrix. More...

Vector4	Column2 `[get, set]`
	Gets the third column of this matrix. More...

Vector4	Column3 `[get, set]`
	Gets the fourth column of this matrix. More...

float	M11 `[get, set]`
	Gets or sets the value at row 1, column 1 of this instance. More...

float	M12 `[get, set]`
	Gets or sets the value at row 1, column 2 of this instance. More...

float	M13 `[get, set]`
	Gets or sets the value at row 1, column 3 of this instance. More...

float	M14 `[get, set]`
	Gets or sets the value at row 1, column 4 of this instance. More...

float	M21 `[get, set]`
	Gets or sets the value at row 2, column 1 of this instance. More...

float	M22 `[get, set]`
	Gets or sets the value at row 2, column 2 of this instance. More...

float	M23 `[get, set]`
	Gets or sets the value at row 2, column 3 of this instance. More...

float	M24 `[get, set]`
	Gets or sets the value at row 2, column 4 of this instance. More...

float	M31 `[get, set]`
	Gets or sets the value at row 3, column 1 of this instance. More...

float	M32 `[get, set]`
	Gets or sets the value at row 3, column 2 of this instance. More...

float	M33 `[get, set]`
	Gets or sets the value at row 3, column 3 of this instance. More...

float	M34 `[get, set]`
	Gets or sets the value at row 3, column 4 of this instance. More...

float	M41 `[get, set]`
	Gets or sets the value at row 4, column 1 of this instance. More...

float	M42 `[get, set]`
	Gets or sets the value at row 4, column 2 of this instance. More...

float	M43 `[get, set]`
	Gets or sets the value at row 4, column 3 of this instance. More...

float	M44 `[get, set]`
	Gets or sets the value at row 4, column 4 of this instance. More...

Vector4	Diagonal `[get, set]`
	Gets or sets the values along the main diagonal of the matrix. More...

float	Trace `[get]`
	Gets the trace of the matrix, the sum of the values along the diagonal. More...

float	this[int rowIndex, int columnIndex] `[get, set]`
	Gets or sets the value at a specified row and column. More...

Detailed Description

Represents a 4x4 matrix containing 3D rotation, scale, transform, and projection.

See Also: Matrix4d

Constructor & Destructor Documentation

makVrl.Matrix4.Matrix4	(	Vector4	row0,
		Vector4	row1,
		Vector4	row2,
		Vector4	row3
	)

inline

Constructs a new instance.

Parameters

row0	Top row of the matrix.
row1	Second row of the matrix.
row2	Third row of the matrix.
row3	Bottom row of the matrix.

References makVrl.Matrix4.Row0, makVrl.Matrix4.Row1, makVrl.Matrix4.Row2, and makVrl.Matrix4.Row3.

Referenced by makVrl.Matrix4.Equals(), makVrl.Matrix4.Frustum(), and makVrl.Matrix4.Transpose().

makVrl.Matrix4.Matrix4	(	float	m00,
		float	m01,
		float	m02,
		float	m03,
		float	m10,
		float	m11,
		float	m12,
		float	m13,
		float	m20,
		float	m21,
		float	m22,
		float	m23,
		float	m30,
		float	m31,
		float	m32,
		float	m33
	)

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.
m03	Fourth 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.
m13	Fourth 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.
m23	First item of the third row of the matrix.
m30	Fourth item of the fourth row of the matrix.
m31	Second item of the fourth row of the matrix.
m32	Third item of the fourth row of the matrix.
m33	Fourth item of the fourth row of the matrix.

References makVrl.Matrix4.Row0, makVrl.Matrix4.Row1, makVrl.Matrix4.Row2, and makVrl.Matrix4.Row3.

Member Function Documentation

static Matrix4 makVrl.Matrix4.Add	(	Matrix4	left,
		Matrix4	right
	)

inlinestatic

Adds two instances.

Parameters

left	The left operand of the addition.
right	The right operand of the addition.

Returns: A new instance that is the result of the addition.

static void makVrl.Matrix4.Add	(	ref Matrix4	left,
		ref Matrix4	right,
		out Matrix4	result
	)

inlinestatic

Adds two instances.

Parameters

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

Matrix4 makVrl.Matrix4.ClearProjection ( )

inline

Returns a copy of this Matrix4 without projection.

References makVrl.Vector4.Zero.

Matrix4 makVrl.Matrix4.ClearRotation ( )

inline

Returns a copy of this Matrix4 without rotation.

References makVrl.Vector3f.Length, makVrl.Matrix4.Row0, makVrl.Matrix4.Row1, makVrl.Matrix4.Row2, and makVrl.Vector4.Xyz.

Matrix4 makVrl.Matrix4.ClearScale ( )

inline

Returns a copy of this Matrix4 without scale.

Matrix4 makVrl.Matrix4.ClearTranslation ( )

inline

Returns a copy of this Matrix4 without translation.

References makVrl.Vector3f.Zero.

static void makVrl.Matrix4.CreateFromAxisAngle	(	Vector3f	axis,
		float	angle,
		out Matrix4	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.Vector4.UnitW.

Referenced by makVrl.Matrix4.CreateFromAxisAngle(), makVrl.Matrix4.CreateFromQuaternion(), and makVrl.Matrix4.Rotate().

static Matrix4 makVrl.Matrix4.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.Matrix4.CreateFromAxisAngle().

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

inlinestatic

Builds a rotation matrix from a quaternion.

Parameters

q	The quaternion to rotate by.
result	A matrix instance.

References makVrl.Matrix4.CreateFromAxisAngle().

Referenced by makVrl.Matrix4.CreateFromQuaternion(), and makVrl.Matrix4.Rotate().

static Matrix4 makVrl.Matrix4.CreateFromQuaternion ( Quaternion q )

inlinestatic

Builds a rotation matrix from a quaternion.

Parameters

q	The quaternion to rotate by.

Returns: A matrix instance.

References makVrl.Matrix4.CreateFromQuaternion().

static void makVrl.Matrix4.CreateOrthographic	(	float	width,
		float	height,
		float	zNear,
		float	zFar,
		out Matrix4	result
	)

inlinestatic

Creates an orthographic projection matrix.

Parameters

width	The width of the projection volume.
height	The height of the projection volume.
zNear	The near edge of the projection volume.
zFar	The far edge of the projection volume.
result	The resulting Matrix4 instance.

References makVrl.Matrix4.CreateOrthographicOffCenter().

static Matrix4 makVrl.Matrix4.CreateOrthographic	(	float	width,
		float	height,
		float	zNear,
		float	zFar
	)

inlinestatic

Creates an orthographic projection matrix.

Parameters

width	The width of the projection volume.
height	The height of the projection volume.
zNear	The near edge of the projection volume.
zFar	The far edge of the projection volume.

<rereturns>The resulting Matrix4 instance.</rereturns>

References makVrl.Matrix4.CreateOrthographicOffCenter().

static void makVrl.Matrix4.CreateOrthographicOffCenter	(	float	left,
		float	right,
		float	bottom,
		float	top,
		float	zNear,
		float	zFar,
		out Matrix4	result
	)

inlinestatic

Creates an orthographic projection matrix.

Parameters

left	The left edge of the projection volume.
right	The right edge of the projection volume.
bottom	The bottom edge of the projection volume.
top	The top edge of the projection volume.
zNear	The near edge of the projection volume.
zFar	The far edge of the projection volume.
result	The resulting Matrix4 instance.

References makVrl.Matrix4.Identity.

Referenced by makVrl.Matrix4.CreateOrthographic(), and makVrl.Matrix4.CreateOrthographicOffCenter().

static Matrix4 makVrl.Matrix4.CreateOrthographicOffCenter	(	float	left,
		float	right,
		float	bottom,
		float	top,
		float	zNear,
		float	zFar
	)

inlinestatic

Creates an orthographic projection matrix.

Parameters

left	The left edge of the projection volume.
right	The right edge of the projection volume.
bottom	The bottom edge of the projection volume.
top	The top edge of the projection volume.
zNear	The near edge of the projection volume.
zFar	The far edge of the projection volume.

Returns: The resulting Matrix4 instance.

References makVrl.Matrix4.CreateOrthographicOffCenter().

static void makVrl.Matrix4.CreatePerspectiveFieldOfView	(	float	fovy,
		float	aspect,
		float	zNear,
		float	zFar,
		out Matrix4	result
	)

inlinestatic

Creates a perspective projection matrix.

Parameters

fovy	Angle of the field of view in the y direction (in radians)
aspect	Aspect ratio of the view (width / height)
zNear	Distance to the near clip plane
zFar	Distance to the far clip plane
result	A projection matrix that transforms camera space to raster space

Exceptions

System.ArgumentOutOfRangeException

Thrown under the following conditions:

fovy is zero, less than zero or larger than Math.PI
aspect is negative or zero
zNear is negative or zero
zFar is negative or zero
zNear is larger than zFar

References makVrl.Matrix4.CreatePerspectiveOffCenter().

Referenced by makVrl.Matrix4.CreatePerspectiveFieldOfView().

static Matrix4 makVrl.Matrix4.CreatePerspectiveFieldOfView	(	float	fovy,
		float	aspect,
		float	zNear,
		float	zFar
	)

inlinestatic

Creates a perspective projection matrix.

Parameters

fovy	Angle of the field of view in the y direction (in radians)
aspect	Aspect ratio of the view (width / height)
zNear	Distance to the near clip plane
zFar	Distance to the far clip plane

Returns: A projection matrix that transforms camera space to raster space

Exceptions

System.ArgumentOutOfRangeException

Thrown under the following conditions:

fovy is zero, less than zero or larger than Math.PI
aspect is negative or zero
zNear is negative or zero
zFar is negative or zero
zNear is larger than zFar

References makVrl.Matrix4.CreatePerspectiveFieldOfView().

static void makVrl.Matrix4.CreatePerspectiveOffCenter	(	float	left,
		float	right,
		float	bottom,
		float	top,
		float	zNear,
		float	zFar,
		out Matrix4	result
	)

inlinestatic

Creates an perspective projection matrix.

Parameters

left	Left edge of the view frustum
right	Right edge of the view frustum
bottom	Bottom edge of the view frustum
top	Top edge of the view frustum
zNear	Distance to the near clip plane
zFar	Distance to the far clip plane
result	A projection matrix that transforms camera space to raster space

Exceptions

System.ArgumentOutOfRangeException

Thrown under the following conditions:

zNear is negative or zero
zFar is negative or zero
zNear is larger than zFar

Referenced by makVrl.Matrix4.CreatePerspectiveFieldOfView(), and makVrl.Matrix4.CreatePerspectiveOffCenter().

static Matrix4 makVrl.Matrix4.CreatePerspectiveOffCenter	(	float	left,
		float	right,
		float	bottom,
		float	top,
		float	zNear,
		float	zFar
	)

inlinestatic

Creates an perspective projection matrix.

Parameters

left	Left edge of the view frustum
right	Right edge of the view frustum
bottom	Bottom edge of the view frustum
top	Top edge of the view frustum
zNear	Distance to the near clip plane
zFar	Distance to the far clip plane

Returns: A projection matrix that transforms camera space to raster space

Exceptions

System.ArgumentOutOfRangeException

Thrown under the following conditions:

zNear is negative or zero
zFar is negative or zero
zNear is larger than zFar

References makVrl.Matrix4.CreatePerspectiveOffCenter().

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

inlinestatic

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

Parameters

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

References makVrl.Matrix4.Identity.

Referenced by makVrl.Matrix4.CreateRotationX(), and makVrl.Matrix4.RotateX().

static Matrix4 makVrl.Matrix4.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 Matrix4 instance.

References makVrl.Matrix4.CreateRotationX().

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

inlinestatic

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

Parameters

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

References makVrl.Matrix4.Identity.

Referenced by makVrl.Matrix4.CreateRotationY(), and makVrl.Matrix4.RotateY().

static Matrix4 makVrl.Matrix4.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 Matrix4 instance.

References makVrl.Matrix4.CreateRotationY().

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

inlinestatic

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

Parameters

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

References makVrl.Matrix4.Identity.

Referenced by makVrl.Matrix4.CreateRotationZ(), and makVrl.Matrix4.RotateZ().

static Matrix4 makVrl.Matrix4.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 Matrix4 instance.

References makVrl.Matrix4.CreateRotationZ().

static Matrix4 makVrl.Matrix4.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.Matrix4.CreateScale().

static Matrix4 makVrl.Matrix4.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.Matrix4.CreateScale().

static Matrix4 makVrl.Matrix4.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.Matrix4.CreateScale().

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

inlinestatic

Creates a scale matrix.

Parameters

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

References makVrl.Matrix4.Identity.

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

inlinestatic

Creates a scale matrix.

Parameters

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

References makVrl.Matrix4.Identity.

static void makVrl.Matrix4.CreateScale	(	float	x,
		float	y,
		float	z,
		out Matrix4	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.Matrix4.Identity.

static void makVrl.Matrix4.CreateTranslation	(	float	x,
		float	y,
		float	z,
		out Matrix4	result
	)

inlinestatic

Creates a translation matrix.

Parameters

x	X translation.
y	Y translation.
z	Z translation.
result	The resulting Matrix4 instance.

References makVrl.Matrix4.Identity.

Referenced by makVrl.Matrix4.CreateTranslation(), and makVrl.Matrix4.Translation().

static void makVrl.Matrix4.CreateTranslation	(	ref Vector3f	vector,
		out Matrix4	result
	)

inlinestatic

Creates a translation matrix.

Parameters

vector	The translation vector.
result	The resulting Matrix4 instance.

References makVrl.Matrix4.Identity.

static Matrix4 makVrl.Matrix4.CreateTranslation	(	float	x,
		float	y,
		float	z
	)

inlinestatic

Creates a translation matrix.

Parameters

x	X translation.
y	Y translation.
z	Z translation.

Returns: The resulting Matrix4 instance.

References makVrl.Matrix4.CreateTranslation().

static Matrix4 makVrl.Matrix4.CreateTranslation ( Vector3f vector )

inlinestatic

Creates a translation matrix.

Parameters

vector The translation vector.

Returns: The resulting Matrix4 instance.

References makVrl.Matrix4.CreateTranslation(), makVrl.Vector3f.X, makVrl.Vector3f.Y, and makVrl.Vector3f.Z.

override bool makVrl.Matrix4.Equals ( object obj )

inline

Indicates whether this instance and a specified object are equal.

Parameters

obj	The object to compare tresult.

Returns: True if the instances are equal; false otherwise.

References makVrl.Matrix4.Matrix4().

bool makVrl.Matrix4.Equals ( Matrix4 other )

inline

Indicates whether the current matrix is equal to another matrix.

Parameters

other An matrix to compare with this matrix.

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

References makVrl.Matrix4.Row0, makVrl.Matrix4.Row1, makVrl.Matrix4.Row2, and makVrl.Matrix4.Row3.

Vector4 makVrl.Matrix4.ExtractProjection ( )

inline

Returns the projection component of this instance.

References makVrl.Matrix4.Column3.

Quaternion makVrl.Matrix4.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.

Vector3f makVrl.Matrix4.ExtractScale ( )

inline

Returns the scale component of this instance.

References makVrl.Vector3f.Length, makVrl.Matrix4.Row0, makVrl.Matrix4.Row1, makVrl.Matrix4.Row2, and makVrl.Vector4.Xyz.

Vector3f makVrl.Matrix4.ExtractTranslation ( )

inline

Returns the translation component of this instance.

static Matrix4 makVrl.Matrix4.Frustum	(	float	left,
		float	right,
		float	bottom,
		float	top,
		float	near,
		float	far
	)

inlinestatic

Build a projection matrix

Parameters

left	Left edge of the view frustum
right	Right edge of the view frustum
bottom	Bottom edge of the view frustum
top	Top edge of the view frustum
near	Distance to the near clip plane
far	Distance to the far clip plane

Returns: A projection matrix that transforms camera space to raster space

References makVrl.Matrix4.Matrix4().

Referenced by makVrl.Matrix4.Perspective().

override int makVrl.Matrix4.GetHashCode ( )

inline

Returns the hashcode for this instance.

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

References makVrl.Vector4.GetHashCode(), makVrl.Matrix4.Row1, and makVrl.Matrix4.Row3.

void makVrl.Matrix4.Invert ( )

inline

Converts this instance into its inverse.

Referenced by makVrl.Matrix4.Invert().

static void makVrl.Matrix4.Invert	(	ref Matrix4	mat,
		out Matrix4	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 Matrix4 is singular.

static Matrix4 makVrl.Matrix4.Invert ( Matrix4 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.Matrix4.Invert().

Matrix4 makVrl.Matrix4.Inverted ( )

inline

Returns an inverted copy of this instance.

References makVrl.Matrix4.Determinant.

static Matrix4 makVrl.Matrix4.LookAt	(	Vector3f	eye,
		Vector3f	target,
		Vector3f	up
	)

inlinestatic

Build a world space to camera space matrix

Parameters

eye	Eye (camera) position in world space
target	Target position in world space
up	Up vector in world space (should not be parallel to the camera direction, that is target - eye)

Returns: A Matrix4 that transforms world space to camera space

References makVrl.Vector3f.Y.

Referenced by makVrl.Matrix4.LookAt().

static Matrix4 makVrl.Matrix4.LookAt	(	float	eyeX,
		float	eyeY,
		float	eyeZ,
		float	targetX,
		float	targetY,
		float	targetZ,
		float	upX,
		float	upY,
		float	upZ
	)

inlinestatic

Build a world space to camera space matrix

Parameters

eyeX	Eye (camera) position in world space
eyeY	Eye (camera) position in world space
eyeZ	Eye (camera) position in world space
targetX	Target position in world space
targetY	Target position in world space
targetZ	Target position in world space
upX	Up vector in world space (should not be parallel to the camera direction, that is target - eye)
upY	Up vector in world space (should not be parallel to the camera direction, that is target - eye)
upZ	Up vector in world space (should not be parallel to the camera direction, that is target - eye)

Returns: A Matrix4 that transforms world space to camera space

References makVrl.Matrix4.LookAt().

static Matrix4 makVrl.Matrix4.Mult	(	Matrix4	left,
		Matrix4	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.Matrix4.Mult().

static void makVrl.Matrix4.Mult	(	ref Matrix4	left,
		ref Matrix4	right,
		out Matrix4	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.

static Matrix4 makVrl.Matrix4.Mult	(	Matrix4	left,
		float	right
	)

inlinestatic

Multiplies an instance by a scalar.

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

References makVrl.Matrix4.Mult().

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

inlinestatic

Multiplies an instance by a scalar.

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

void makVrl.Matrix4.Normalize ( )

inline

Divides each element in the Matrix by the Determinant.

References makVrl.Matrix4.Row0, makVrl.Matrix4.Row1, makVrl.Matrix4.Row2, and makVrl.Matrix4.Row3.

Matrix4 makVrl.Matrix4.Normalized ( )

inline

Returns a normalised copy of this instance.

static bool makVrl.Matrix4.operator!=	(	Matrix4	left,
		Matrix4	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.

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

inlinestatic

Matrix multiplication

Parameters

left	left-hand operand
right	right-hand operand

Returns: A new Matrix4 which holds the result of the multiplication

static Matrix4 makVrl.Matrix4.operator*	(	Matrix4	left,
		float	right
	)

inlinestatic

Matrix-scalar multiplication

Parameters

left	left-hand operand
right	right-hand operand

Returns: A new Matrix4 which holds the result of the multiplication

static Matrix4 makVrl.Matrix4.operator+	(	Matrix4	left,
		Matrix4	right
	)

inlinestatic

Matrix addition

Parameters

left	left-hand operand
right	right-hand operand

Returns: A new Matrix4 which holds the result of the addition

static Matrix4 makVrl.Matrix4.operator-	(	Matrix4	left,
		Matrix4	right
	)

inlinestatic

Matrix subtraction

Parameters

left	left-hand operand
right	right-hand operand

Returns: A new Matrix4 which holds the result of the subtraction

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

inlinestatic

Compares two instances for equality.

Parameters

left	The first instance.
right	The second instance.

Returns: True, if left equals right; false otherwise.

static Matrix4 makVrl.Matrix4.Perspective	(	float	fovy,
		float	aspect,
		float	near,
		float	far
	)

inlinestatic

Build a projection matrix

Parameters

fovy	Angle of the field of view in the y direction (in radians)
aspect	Aspect ratio of the view (width / height)
near	Distance to the near clip plane
far	Distance to the far clip plane

Returns: A projection matrix that transforms camera space to raster space

References makVrl.Matrix4.Frustum().

static Matrix4 makVrl.Matrix4.Rotate	(	Vector3f	axis,
		float	angle
	)

inlinestatic

Build a rotation matrix to rotate about the given axis

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 rotation matrix

References makVrl.Matrix4.CreateFromAxisAngle().

static Matrix4 makVrl.Matrix4.Rotate ( Quaternion q )

inlinestatic

Build a rotation matrix from a quaternion

Parameters

q	the quaternion

Returns: A rotation matrix

References makVrl.Matrix4.CreateFromQuaternion().

static Matrix4 makVrl.Matrix4.RotateX ( float angle )

inlinestatic

Build a rotation matrix that rotates about the x-axis

Parameters

angle angle in radians to rotate counter-clockwise around the x-axis

Returns: A rotation matrix

References makVrl.Matrix4.CreateRotationX().

static Matrix4 makVrl.Matrix4.RotateY ( float angle )

inlinestatic

Build a rotation matrix that rotates about the y-axis

Parameters

angle angle in radians to rotate counter-clockwise around the y-axis

Returns: A rotation matrix

References makVrl.Matrix4.CreateRotationY().

static Matrix4 makVrl.Matrix4.RotateZ ( float angle )

inlinestatic

Build a rotation matrix that rotates about the z-axis

Parameters

angle angle in radians to rotate counter-clockwise around the z-axis

Returns: A rotation matrix

References makVrl.Matrix4.CreateRotationZ().

static Matrix4 makVrl.Matrix4.Scale ( float scale )

inlinestatic

Build a scaling matrix

Parameters

scale Single scale factor for x,y and z axes

Returns: A scaling matrix

Referenced by makVrl.Matrix4.Scale().

static Matrix4 makVrl.Matrix4.Scale ( Vector3f scale )

inlinestatic

Build a scaling matrix

Parameters

scale Scale factors for x,y and z axes

Returns: A scaling matrix

References makVrl.Matrix4.Scale(), makVrl.Vector3f.X, makVrl.Vector3f.Y, and makVrl.Vector3f.Z.

static Matrix4 makVrl.Matrix4.Scale	(	float	x,
		float	y,
		float	z
	)

inlinestatic

Build a scaling matrix

Parameters

x	Scale factor for x-axis
y	Scale factor for y-axis
z	Scale factor for z-axis

Returns: A scaling matrix

References makVrl.Vector4.UnitW.

static Matrix4 makVrl.Matrix4.Subtract	(	Matrix4	left,
		Matrix4	right
	)

inlinestatic

Subtracts one instance from another.

Parameters

left	The left operand of the subraction.
right	The right operand of the subraction.

Returns: A new instance that is the result of the subraction.

static void makVrl.Matrix4.Subtract	(	ref Matrix4	left,
		ref Matrix4	right,
		out Matrix4	result
	)

inlinestatic

Subtracts one instance from another.

Parameters

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

override string makVrl.Matrix4.ToString ( )

inline

Returns a System.String that represents the current Matrix4.

Returns: The string representation of the matrix.

References makVrl.Matrix4.Row0, makVrl.Matrix4.Row1, makVrl.Matrix4.Row2, and makVrl.Matrix4.Row3.

static Matrix4 makVrl.Matrix4.Translation ( Vector3f trans )

inlinestatic

Builds a translation matrix.

Parameters

trans The translation vector.

Returns: A new Matrix4 instance.

References makVrl.Matrix4.CreateTranslation().

static Matrix4 makVrl.Matrix4.Translation	(	float	x,
		float	y,
		float	z
	)

inlinestatic

Build a translation matrix with the given translation

Parameters

x	X translation
y	Y translation
z	Z translation

Returns: A Translation matrix

References makVrl.Matrix4.CreateTranslation().

void makVrl.Matrix4.Transpose ( )

inline

Converts this instance into its transpose.

static Matrix4 makVrl.Matrix4.Transpose ( Matrix4 mat )

inlinestatic

Calculate the transpose of the given matrix

Parameters

mat	The matrix to transpose

Returns: The transpose of the given matrix

References makVrl.Matrix4.Column0, makVrl.Matrix4.Column1, makVrl.Matrix4.Column2, makVrl.Matrix4.Column3, and makVrl.Matrix4.Matrix4().

static void makVrl.Matrix4.Transpose	(	ref Matrix4	mat,
		out Matrix4	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 Matrix4 makVrl.Matrix4.Identity = new Matrix4(Vector4.UnitX, Vector4.UnitY, Vector4.UnitZ, Vector4.UnitW)

static

The identity matrix.

Referenced by makVrl.Matrix4d.CreateFromQuaternion(), makVrl.Matrix4.CreateOrthographicOffCenter(), makVrl.Matrix4.CreateRotationX(), makVrl.Matrix4.CreateRotationY(), makVrl.Matrix4.CreateRotationZ(), makVrl.Matrix4.CreateScale(), and makVrl.Matrix4.CreateTranslation().

Vector4 makVrl.Matrix4.Row0

Top row of the matrix.

Referenced by makVrl.Matrix4.ClearRotation(), makVrl.Matrix4.Equals(), makVrl.Matrix4.ExtractScale(), makVrl.Matrix4.Matrix4(), makVrl.Matrix4.Normalize(), makVrl.Matrix4.ToString(), and makVrl.Vector3f.TransformNormalInverse().

Vector4 makVrl.Matrix4.Row1

2nd row of the matrix.

Referenced by makVrl.Matrix4.ClearRotation(), makVrl.Matrix4.Equals(), makVrl.Matrix4.ExtractScale(), makVrl.Matrix4.GetHashCode(), makVrl.Matrix4.Matrix4(), makVrl.Matrix4.Normalize(), makVrl.Matrix4.ToString(), and makVrl.Vector3f.TransformNormalInverse().

Vector4 makVrl.Matrix4.Row2

3rd row of the matrix.

Referenced by makVrl.Matrix4.ClearRotation(), makVrl.Matrix4.Equals(), makVrl.Matrix4.ExtractScale(), makVrl.Matrix4.Matrix4(), makVrl.Matrix4.Normalize(), makVrl.Matrix4.ToString(), and makVrl.Vector3f.TransformNormalInverse().

Vector4 makVrl.Matrix4.Row3

Bottom row of the matrix.

Referenced by makVrl.Matrix4.Equals(), makVrl.Matrix4.GetHashCode(), makVrl.Matrix4.Matrix4(), makVrl.Matrix4.Normalize(), makVrl.Matrix4.ToString(), and makVrl.Vector3f.TransformPosition().

readonly Matrix4 makVrl.Matrix4.Zero = new Matrix4(Vector4.Zero, Vector4.Zero, Vector4.Zero, Vector4.Zero)

static

The zero matrix.

Property Documentation

Vector4 makVrl.Matrix4.Column0

getset

Gets the first column of this matrix.

Referenced by makVrl.Vector3f.TransformPosition(), makVrl.Vector3f.TransformVector(), and makVrl.Matrix4.Transpose().

Vector4 makVrl.Matrix4.Column1

getset

Gets the second column of this matrix.

Referenced by makVrl.Vector3f.TransformPosition(), makVrl.Vector3f.TransformVector(), and makVrl.Matrix4.Transpose().

Vector4 makVrl.Matrix4.Column2

getset

Gets the third column of this matrix.

Referenced by makVrl.Vector3f.TransformPosition(), makVrl.Vector3f.TransformVector(), and makVrl.Matrix4.Transpose().

Vector4 makVrl.Matrix4.Column3

getset

Gets the fourth column of this matrix.

Referenced by makVrl.Matrix4.ExtractProjection(), and makVrl.Matrix4.Transpose().

float makVrl.Matrix4.Determinant

get

Gets the determinant of this matrix.

Referenced by makVrl.Matrix4.Inverted().

Vector4 makVrl.Matrix4.Diagonal

getset

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

float makVrl.Matrix4.M11

getset

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

float makVrl.Matrix4.M12

getset

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

float makVrl.Matrix4.M13

getset

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

float makVrl.Matrix4.M14

getset

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

float makVrl.Matrix4.M21

getset

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

float makVrl.Matrix4.M22

getset

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

float makVrl.Matrix4.M23

getset

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

float makVrl.Matrix4.M24

getset

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

float makVrl.Matrix4.M31

getset

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

float makVrl.Matrix4.M32

getset

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

float makVrl.Matrix4.M33

getset

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

float makVrl.Matrix4.M34

getset

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

float makVrl.Matrix4.M41

getset

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

float makVrl.Matrix4.M42

getset

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

float makVrl.Matrix4.M43

getset

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

float makVrl.Matrix4.M44

getset

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

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

getset

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

float makVrl.Matrix4.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:

Matrix4.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation