#include <OgreMathLib.h>

Public Member Functions
	Matrix4 ()

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

	Matrix4 (const Matrix3 &m3x3)

	Matrix4 (const Quaternion &rot)

void	swap (Matrix4 &other)

Real *	operator[] (size_t iRow)

const Real *	operator[] (size_t iRow) const

Matrix4	concatenate (const Matrix4 &m2) const

Matrix4	operator* (const Matrix4 &m2) const

Vector3	operator* (const Vector3 &v) const

Vector4	operator* (const Vector4 &v) const

Matrix4	operator+ (const Matrix4 &m2) const

Matrix4	operator- (const Matrix4 &m2) const

bool	operator== (const Matrix4 &m2) const

bool	operator!= (const Matrix4 &m2) const

void	operator= (const Matrix3 &mat3)

Matrix4	transpose (void) const

void	setTrans (const Vector3 &v)

Vector3	getTrans () const

void	makeTrans (const Vector3 &v)

void	makeTrans (Real tx, Real ty, Real tz)

void	setScale (const Vector3 &v)

void	extract3x3Matrix (Matrix3 &m3x3) const

bool	hasScale () const

bool	hasNegativeScale () const

Quaternion	extractQuaternion () const

Matrix4	operator* (Real scalar) const

Matrix4	adjoint () const

Real	determinant () const

Matrix4	inverse () const

void	makeTransform (const Vector3 &position, const Vector3 &scale, const Quaternion &orientation)

void	makeInverseTransform (const Vector3 &position, const Vector3 &scale, const Quaternion &orientation)

void	decomposition (Vector3 &position, Vector3 &scale, Quaternion &orientation) const

bool	isAffine (void) const

Matrix4	inverseAffine (void) const

Matrix4	concatenateAffine (const Matrix4 &m2) const

Vector3	transformAffine (const Vector3 &v) const

Static Public Member Functions
static Matrix4	getTrans (const Vector3 &v)

static Matrix4	getTrans (Real t_x, Real t_y, Real t_z)

static Matrix4	getScale (const Vector3 &v)

static Matrix4	getScale (Real s_x, Real s_y, Real s_z)

Static Public Attributes
static const Matrix4	ZERO

static const Matrix4	IDENTITY

static const Matrix4	CLIPSPACE2DTOIMAGESPACE

Protected Attributes
union {
Real m [4][4]

Real _m [16]

};
	The matrix entries, indexed by [row][col].

Friends
OGREMATHLIB_EXPORT friend std::ostream &	operator<< (std::ostream &o, const Matrix4 &mat)

Detailed Description

Class encapsulating a standard 4x4 homogeneous matrix.

Remarks: OGRE uses column vectors when applying matrix multiplications, This means a vector is represented as a single column, 4-row matrix. This has the effect that the transformations implemented by the matrices happens right-to-left e.g. if vector V is to be transformed by M1 then M2 then M3, the calculation would be M3 * M2 * M1 * V. The order that matrices are concatenated is vital since matrix multiplication is not commutative, i.e. you can get a different result if you concatenate in the wrong order.

: The use of column vectors and right-to-left ordering is the standard in most mathematical texts, and is the same as used in OpenGL. It is, however, the opposite of Direct3D, which has inexplicably chosen to differ from the accepted standard and uses row vectors and left-to-right matrix multiplication.

: OGRE deals with the differences between D3D and OpenGL etc. internally when operating through different render systems. OGRE users only need to conform to standard maths conventions, i.e. right-to-left matrix multiplication, (OGRE transposes matrices it passes to D3D to compensate).

The generic form M * V which shows the layout of the matrix entries is shown below:

[ m[0][0]  m[0][1]  m[0][2]  m[0][3] ]   {x}
| m[1][0]  m[1][1]  m[1][2]  m[1][3] | * {y}
| m[2][0]  m[2][1]  m[2][2]  m[2][3] |   {z}
[ m[3][0]  m[3][1]  m[3][2]  m[3][3] ]   {1}

Constructor & Destructor Documentation

◆ Matrix4() [1/3]

OgreMathLib::Matrix4::Matrix4 ( )

inline

Default constructor.

Note: It does NOT initialize the matrix for efficiency.

◆ Matrix4() [2/3]

OgreMathLib::Matrix4::Matrix4 ( const Matrix3 & m3x3 )

inline

Creates a standard 4x4 transformation matrix with a zero translation part from a rotation/scaling 3x3 matrix.

◆ Matrix4() [3/3]

OgreMathLib::Matrix4::Matrix4 ( const Quaternion & rot )

inline

Creates a standard 4x4 transformation matrix with a zero translation part from a rotation/scaling Quaternion.

Member Function Documentation

◆ concatenateAffine()

Matrix4 OgreMathLib::Matrix4::concatenateAffine ( const Matrix4 & m2 ) const

inline

Concatenate two affine matrices.

Note: The matrices must be affine matrix.

See also: Matrix4::isAffine.

◆ decomposition()

void OgreMathLib::Matrix4::decomposition	(	Vector3 &	position,
		Vector3 &	scale,
		Quaternion &	orientation
	)		const

Decompose a Matrix4 to orientation / scale / position.

◆ extract3x3Matrix()

void OgreMathLib::Matrix4::extract3x3Matrix ( Matrix3 & m3x3 ) const

inline

Extracts the rotation / scaling part of the Matrix as a 3x3 matrix.

Parameters

m3x3	Destination Matrix3

◆ extractQuaternion()

Quaternion OgreMathLib::Matrix4::extractQuaternion ( ) const

inline

Extracts the rotation / scaling part as a quaternion from the Matrix.

◆ getScale() [1/2]

static Matrix4 OgreMathLib::Matrix4::getScale ( const Vector3 & v )

inlinestatic

Gets a scale matrix.

◆ getScale() [2/2]

static Matrix4 OgreMathLib::Matrix4::getScale	(	Real	s_x,
		Real	s_y,
		Real	s_z
	)

inlinestatic

Gets a scale matrix - variation for not using a vector.

◆ getTrans() [1/3]

Vector3 OgreMathLib::Matrix4::getTrans ( ) const

inline

Extracts the translation transformation part of the matrix.

◆ getTrans() [2/3]

static Matrix4 OgreMathLib::Matrix4::getTrans ( const Vector3 & v )

inlinestatic

Gets a translation matrix.

◆ getTrans() [3/3]

static Matrix4 OgreMathLib::Matrix4::getTrans	(	Real	t_x,
		Real	t_y,
		Real	t_z
	)

inlinestatic

Gets a translation matrix - variation for not using a vector.

◆ hasNegativeScale()

bool OgreMathLib::Matrix4::hasNegativeScale ( ) const

inline

Determines if this matrix involves a negative scaling.

◆ hasScale()

bool OgreMathLib::Matrix4::hasScale ( ) const

inline

Determines if this matrix involves a scaling.

◆ inverseAffine()

Matrix4 OgreMathLib::Matrix4::inverseAffine ( void ) const

Returns the inverse of the affine matrix.

Note: The matrix must be an affine matrix.

See also: Matrix4::isAffine.

◆ isAffine()

bool OgreMathLib::Matrix4::isAffine ( void ) const

inline

Check whether or not the matrix is affine matrix.

Remarks: An affine matrix is a 4x4 matrix with row 3 equal to (0, 0, 0, 1), e.g. no projective coefficients.

◆ makeInverseTransform()

void OgreMathLib::Matrix4::makeInverseTransform	(	const Vector3 &	position,
		const Vector3 &	scale,
		const Quaternion &	orientation
	)

Building an inverse Matrix4 from orientation / scale / position.

Remarks: As makeTransform except it build the inverse given the same data as makeTransform, so performing -translation, -rotate, 1/scale in that order.

◆ makeTrans()

void OgreMathLib::Matrix4::makeTrans ( const Vector3 & v )

inline

Builds a translation matrix

◆ makeTransform()

void OgreMathLib::Matrix4::makeTransform	(	const Vector3 &	position,
		const Vector3 &	scale,
		const Quaternion &	orientation
	)

Building a Matrix4 from orientation / scale / position.

Remarks: Transform is performed in the order scale, rotate, translation, i.e. translation is independent of orientation axes, scale does not affect size of translation, rotation and scaling are always centered on the origin.

◆ operator!=()

bool OgreMathLib::Matrix4::operator!= ( const Matrix4 & m2 ) const

inline

Tests 2 matrices for inequality.

◆ operator*() [1/2]

Matrix4 OgreMathLib::Matrix4::operator* ( const Matrix4 & m2 ) const

inline

Matrix concatenation using '*'.

◆ operator*() [2/2]

Vector3 OgreMathLib::Matrix4::operator* ( const Vector3 & v ) const

inline

Vector transformation using '*'.

Remarks: Transforms the given 3-D vector by the matrix, projecting the result back into w = 1.

Note: This means that the initial w is considered to be 1.0, and then all the tree elements of the resulting 3-D vector are divided by the resulting w.

◆ operator+()

Matrix4 OgreMathLib::Matrix4::operator+ ( const Matrix4 & m2 ) const

inline

Matrix addition.

◆ operator-()

Matrix4 OgreMathLib::Matrix4::operator- ( const Matrix4 & m2 ) const

inline

Matrix subtraction.

◆ operator=()

void OgreMathLib::Matrix4::operator= ( const Matrix3 & mat3 )

inline

Assignment from 3x3 matrix.

◆ operator==()

bool OgreMathLib::Matrix4::operator== ( const Matrix4 & m2 ) const

inline

Tests 2 matrices for equality.

◆ setScale()

void OgreMathLib::Matrix4::setScale ( const Vector3 & v )

inline

Sets the scale part of the matrix.

◆ setTrans()

void OgreMathLib::Matrix4::setTrans ( const Vector3 & v )

inline

Sets the translation transformation part of the matrix.

◆ swap()

void OgreMathLib::Matrix4::swap ( Matrix4 & other )

inline

Exchange the contents of this matrix with another.

◆ transformAffine()

Vector3 OgreMathLib::Matrix4::transformAffine ( const Vector3 & v ) const

inline

3-D Vector transformation specially for an affine matrix.

Remarks: Transforms the given 3-D vector by the matrix, projecting the result back into w = 1.

Note: The matrix must be an affine matrix.

See also: Matrix4::isAffine.

Friends And Related Function Documentation

◆ operator<<

OGREMATHLIB_EXPORT friend std::ostream& operator<<	(	std::ostream &	o,
		const Matrix4 &	mat
	)

friend

Function for writing to a stream.

Member Data Documentation

◆ CLIPSPACE2DTOIMAGESPACE

const Matrix4 OgreMathLib::Matrix4::CLIPSPACE2DTOIMAGESPACE

static

Useful little matrix which takes 2D clipspace {-1, 1} to {0,1} and inverts the Y.

The documentation for this class was generated from the following files:

OgreMathLib.h
OgreMathLib.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Matrix4() [1/3]

◆ Matrix4() [2/3]

◆ Matrix4() [3/3]

Member Function Documentation

◆ concatenateAffine()

◆ decomposition()

◆ extract3x3Matrix()

◆ extractQuaternion()

◆ getScale() [1/2]

◆ getScale() [2/2]

◆ getTrans() [1/3]

◆ getTrans() [2/3]

◆ getTrans() [3/3]

◆ hasNegativeScale()

◆ hasScale()

◆ inverseAffine()

◆ isAffine()

◆ makeInverseTransform()

◆ makeTrans()

◆ makeTransform()

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator+()

◆ operator-()

◆ operator=()

◆ operator==()

◆ setScale()

◆ setTrans()

◆ swap()

◆ transformAffine()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ CLIPSPACE2DTOIMAGESPACE