matrix4 Class Reference

#include <matrix4.h>

Public Member Functions

• void buildCameraLookAtMatrixLH (const vector3df &position, const vector3df &forwardVector, const vector3df &rightVector, const vector3df &upVector)

  Builds a left-handed look-at matrix based on position and already normalized world vectors.
  

• void buildCameraLookAtMatrixLH (const vector3df &position, const vector3df &target, const vector3df &upVector)

  Builds a left-handed look-at matrix.
  

• void buildCameraLookAtMatrixRH (const vector3df &position, const vector3df &forwardVector, const vector3df &rightVector, const vector3df &upVector)

  Builds a right-handed look-at matrix based on position and already normalized world vectors.
  

• void buildCameraLookAtMatrixRH (const vector3df &position, const vector3df &target, const vector3df &upVector)

  Builds a right-handed look-at matrix.
  

• void buildNDCToDCMatrix (const core::rect< s32 > &area, f32 zScale)

  Builds a matrix which transforms a normalized Device Corrdinate to Device Coordinates.
  

• void buildProjectionMatrixOrthoLH (f32 widthOfViewVolume, f32 heightOfViewVolume, f32 zNear, f32 zFar)

  Builds a left-handed orthogonal projection matrix.
  

• void buildProjectionMatrixOrthoRH (f32 widthOfViewVolume, f32 heightOfViewVolume, f32 zNear, f32 zFar)

  Builds a right-handed orthogonal projection matrix.
  

• void buildProjectionMatrixPerspectiveFovLH (f32 fieldOfViewRadians, f32 aspectRatio, f32 zNear, f32 zFar)

  Builds a left-handed perspective projection matrix based on a field of view.
  

• void buildProjectionMatrixPerspectiveFovRH (f32 fieldOfViewRadians, f32 aspectRatio, f32 zNear, f32 zFar)

  Builds a right-handed perspective projection matrix based on a field of view.
  

• void buildProjectionMatrixPerspectiveLH (f32 widthOfViewVolume, f32 heightOfViewVolume, f32 zNear, f32 zFar)

  Builds a left-handed perspective projection matrix.
  

• void buildProjectionMatrixPerspectiveRH (f32 widthOfViewVolume, f32 heightOfViewVolume, f32 zNear, f32 zFar)

  Builds a right-handed perspective projection matrix.
  

• void buildShadowMatrix (const core::vector3df &light, core::plane3df plane, f32 point=1.0f)

  Builds a matrix that flattens geometry into a plane.
  

• f32 getDeterminant () const

  Gets the determinant of the matrix.
  

• void getInverse (matrix4 &out) const
• core::vector3df getRotationDegrees () const

  Returns the rotation, as set by setRotation(). This code was orginally written by by Chev.
  

• core::vector3df getScale () const

  Get Scale.
  

• vector3df getTranslation () const

  Gets the current translation.
  

• matrix4 getTransposed () const

  returns transposed matrix
  

• matrix4 interpolate (const core::matrix4 &b, f32 time) const
• void inverseRotateVect (vector3df &vect) const

  Rotate a vector by the inverse of the rotation part of this matrix.
  

• void inverseTranslateVect (vector3df &vect) const

  Translate a vector by the inverse of the translation part of this matrix.
  

• bool isIdentity () const

  Returns true if the matrix is the identity matrix.
  

• void makeIdentity ()

  Set matrix to identity.
  

• void makeInverse ()

  Makes this matrix, the inverse of itself.
  

• void makeTransposed ()

  Transposes this matrix.
  

• matrix4 (const f32 &_00, const f32 &_01, const f32 &_02, const f32 &_03, const f32 &_10, const f32 &_11, const f32 &_12, const f32 &_13, const f32 &_20, const f32 &_21, const f32 &_22, const f32 &_23, const f32 &_30, const f32 &_31, const f32 &_32, const f32 &_33)

  Constructor with individual values.
  

• matrix4 (const matrix4 &other)

  Copy Contructor.
  

• matrix4 ()

  Constructor.
  

• void multiplyWith1x4Matrix (f32 *matrix) const

  Multiplies this matrix by a 1x4 matrix.
  

• matrix4 operator * (const f32 &scalar) const

  Multiply by scalar.
  

• plane3df operator * (const plane3df &plane) const

  Transform a plane3df using the * operator.
  

• vector4df operator * (const vector4df &vector) const

  Transform a vector4df using the * operator.
  

• vector3df operator * (const vector3df &vector) const

  Transform a vector3df using the * operator.
  

• matrix4 operator * (const matrix4 &other) const

  multiply by another matrix
  

• matrix4 & operator *= (const f32 &scalar)

  Multiply by scalar.
  

• matrix4 & operator *= (const matrix4 &other)

  Multiply by another matrix.
  

• bool operator!= (const matrix4 &other) const

  Returns true if other matrix is not equal to this matrix.
  

• const f32 & operator() (s32 row, s32 col) const

  Simple operator for directly accessing every element of the matrix.
  

• f32 & operator() (s32 row, s32 col)

  Simple operator for directly accessing every element of the matrix.
  

• matrix4 & operator= (const matrix4 &other)

  Sets this matrix equal to the other matrix.
  

• bool operator== (const matrix4 &other) const

  Returns true if other matrix is equal to this matrix.
  

• void rotateVect (vector3df &vect) const

  Rotate a vector by the rotation part of this matrix.
  

• void setbyproduct (const matrix4 &other_a, const matrix4 &other_b)

  multiply by another matrix
  

• void setbyproduct_nocheck (const matrix4 &other_a, const matrix4 &other_b)

  multiply by another matrix
  

• void setInverseRotationDegrees (const vector3df &rotation)

  Make an inverted rotation matrix from Euler angles. The 4th row and column are unmodified.
  

• void setInverseRotationRadians (const vector3df &rotation)

  Make an inverted rotation matrix from Euler angles. The 4th row and column are unmodified.
  

• void setInverseTranslation (const vector3df &translation)

  Set the inverse translation of the current matrix. Will erase any previous values.
  

• void setRotationDegrees (const vector3df &rotation)

  Make a rotation matrix from Euler angles. The 4th row and column are unmodified.
  

• void setRotationRadians (const vector3df &rotation)

  Make a rotation matrix from Euler angles. The 4th row and column are unmodified.
  

• void setScale (const f32 &x, const f32 &y, const f32 &z)

  Set Scale.
  

• void setScale (const vector3df &scale)

  Set Scale.
  

• void setTranslation (const vector3df &translation)

  Set the translation of the current matrix. Will erase any previous values.
  

• void transformBox (core::aabbox3d< f32 > &box) const

  Transforms a axis aligned bounding box.
  

• void transformBoxEx (core::aabbox3d< f32 > &box) const

  Transforms a axis aligned bounding box more accurately than transformBox().
  

• void transformPlane (const core::plane3d< f32 > &in, core::plane3d< f32 > &out) const

  Transforms a plane by this matrix.
  

• void transformPlane (core::plane3d< f32 > &plane) const

  Transforms a plane by this matrix.
  

• void transformVect (vector4df &out, const vector4df &in) const

  Transforms the in 4D vector by this matrix and stores the result in the out 4D vector.
  

• void transformVect (vector4df &vect) const

  Transforms the 4D vector by this matrix.
  

• void transformVect (f32 *out, const core::vector3df &in) const

  An alternate transform vector method, writing into an array of 4 floats.
  

• void transformVect (vector3df &out, const vector3df &in) const

  Transforms input vector by this matrix and stores result in output vector.
  

• void transformVect (vector3df &vect) const

  Transforms the vector by this matrix.
  

• void translateVect (vector3df &vect) const

  Translate a vector by the translation part of this matrix.
  

Data Fields

• union {
  •    struct {
    •       f32    m00
    •       f32    m01
    •       f32    m02
    •       f32    m03
    •       f32    m10
    •       f32    m11
    •       f32    m12
    •       f32    m13
    •       f32    m20
    •       f32    m21
    •       f32    m22
    •       f32    m23
    •       f32    m30
    •       f32    m31
    •       f32    m32
    •       f32    m33
  •    }
  •    f32    m [4][4]
  •    f32    M [16]
• };

  Matrix data, stored in column-major order.
  

---

Constructor & Destructor Documentation

matrix4

(

)

[inline]

matrix4

(

const matrix4 &

other

)

[inline]

matrix4	(	const f32 &	_00,
		const f32 &	_01,
		const f32 &	_02,
		const f32 &	_03,
		const f32 &	_10,
		const f32 &	_11,
		const f32 &	_12,
		const f32 &	_13,
		const f32 &	_20,
		const f32 &	_21,
		const f32 &	_22,
		const f32 &	_23,
		const f32 &	_30,
		const f32 &	_31,
		const f32 &	_32,
		const f32 &	_33
	)			[inline]

---

Member Function Documentation

void buildCameraLookAtMatrixLH	(	const vector3df &	position,
		const vector3df &	forwardVector,
		const vector3df &	rightVector,
		const vector3df &	upVector
	)			[inline]

void buildCameraLookAtMatrixLH	(	const vector3df &	position,
		const vector3df &	target,
		const vector3df &	upVector
	)			[inline]

void buildCameraLookAtMatrixRH	(	const vector3df &	position,
		const vector3df &	forwardVector,
		const vector3df &	rightVector,
		const vector3df &	upVector
	)			[inline]

void buildCameraLookAtMatrixRH	(	const vector3df &	position,
		const vector3df &	target,
		const vector3df &	upVector
	)			[inline]

void buildNDCToDCMatrix	(	const core::rect< s32 > &	area,
		f32	zScale
	)			[inline]

Used to scale <-1,-1><1,1> to viewport, for example from von <-1,-1> <1,1> to the viewport <0,0><0,640>

void buildProjectionMatrixOrthoLH	(	f32	widthOfViewVolume,
		f32	heightOfViewVolume,
		f32	zNear,
		f32	zFar
	)			[inline]

void buildProjectionMatrixOrthoRH	(	f32	widthOfViewVolume,
		f32	heightOfViewVolume,
		f32	zNear,
		f32	zFar
	)			[inline]

void buildProjectionMatrixPerspectiveFovLH	(	f32	fieldOfViewRadians,
		f32	aspectRatio,
		f32	zNear,
		f32	zFar
	)			[inline]

void buildProjectionMatrixPerspectiveFovRH	(	f32	fieldOfViewRadians,
		f32	aspectRatio,
		f32	zNear,
		f32	zFar
	)			[inline]

void buildProjectionMatrixPerspectiveLH	(	f32	widthOfViewVolume,
		f32	heightOfViewVolume,
		f32	zNear,
		f32	zFar
	)			[inline]

void buildProjectionMatrixPerspectiveRH	(	f32	widthOfViewVolume,
		f32	heightOfViewVolume,
		f32	zNear,
		f32	zFar
	)			[inline]

void buildShadowMatrix	(	const core::vector3df &	light,
		core::plane3df	plane,
		f32	point = 1.0f
	)			[inline]

Builds a matrix that flattens geometry into a plane.

Parameters:

	light,:	light source
	plane,:	plane into which the geometry if flattened into
	point,:	value between 0 and 1, describing the light source. If this is 1, it is a point light, if it is 0, it is a directional light.

f32 getDeterminant

(

)

const [inline]

void getInverse

(

matrix4 &

out

)

const [inline]

returns the inversed matrix of this one

Parameters:

out,:

where result matrix is written to.

Returns:

Returns false if there is no inverse matrix.

core::vector3df getRotationDegrees

(

)

const [inline]

Returns the rotation, as set by setRotation(). This code was sent in by Chev.

vector3df getScale

(

)

const [inline]

vector3df getTranslation

(

)

const [inline]

matrix4 getTransposed

(

)

const [inline]

matrix4 interpolate	(	const core::matrix4 &	b,
		f32	time
	)			const [inline]

creates a new matrix as interpolated matrix from to other ones.

Parameters:

	b,:	other matrix to interpolate with
	time,:	Must be a value between 0 and 1.

void inverseRotateVect

(

vector3df &

vect

)

const [inline]

void inverseTranslateVect

(

vector3df &

vect

)

const [inline]

bool isIdentity

(

)

const [inline]

void makeIdentity

(

)

[inline]

void makeInverse

(

)

[inline]

void makeTransposed

(

)

[inline]

void multiplyWith1x4Matrix

(

f32 *

matrix

)

const [inline]

matrix4 operator *

(

const f32 &

scalar

)

const [inline]

plane3df operator *

(

const plane3df &

plane

)

const [inline]

vector4df operator *

(

const vector4df &

vector

)

const [inline]

vector3df operator *

(

const vector3df &

vector

)

const [inline]

matrix4 operator *

(

const matrix4 &

other

)

const [inline]

matrix4 & operator *=

(

const f32 &

scalar

)

[inline]

matrix4 & operator *=

(

const matrix4 &

other

)

[inline]

bool operator!=

(

const matrix4 &

other

)

const [inline]

const f32& operator()	(	s32	row,
		s32	col
	)			const [inline]

f32& operator()	(	s32	row,
		s32	col
	)			[inline]

matrix4 & operator=

(

const matrix4 &

other

)

[inline]

bool operator==

(

const matrix4 &

other

)

const [inline]

void rotateVect

(

vector3df &

vect

)

const [inline]

void setbyproduct	(	const matrix4 &	other_a,
		const matrix4 &	other_b
	)			[inline]

void setbyproduct_nocheck	(	const matrix4 &	other_a,
		const matrix4 &	other_b
	)			[inline]

set this matrix to the product of two matrices, no logical optimation use it if you know you never have a identity matrix

void setInverseRotationDegrees

(

const vector3df &

rotation

)

[inline]

void setInverseRotationRadians

(

const vector3df &

rotation

)

[inline]

void setInverseTranslation

(

const vector3df &

translation

)

[inline]

void setRotationDegrees

(

const vector3df &

rotation

)

[inline]

void setRotationRadians

(

const vector3df &

rotation

)

[inline]

void setScale	(	const f32 &	x,
		const f32 &	y,
		const f32 &	z
	)			[inline]

void setScale

(

const vector3df &

scale

)

[inline]

void setTranslation

(

const vector3df &

translation

)

[inline]

void transformBox

(

core::aabbox3d< f32 > &

box

)

const [inline]

The result box of this operation may not be very accurate. For accurate results, use transformBoxEx()

void transformBoxEx

(

core::aabbox3d< f32 > &

box

)

const [inline]

The result box of this operation should by quite accurate, but this operation is slower than transformBox().

void transformPlane	(	const core::plane3d< f32 > &	in,
		core::plane3d< f32 > &	out
	)			const [inline]

void transformPlane

(

core::plane3d< f32 > &

plane

)

const [inline]

void transformVect	(	vector4df &	out,
		const vector4df &	in
	)			const [inline]

void transformVect

(

vector4df &

vect

)

const [inline]

void transformVect	(	f32 *	out,
		const core::vector3df &	in
	)			const [inline]

void transformVect	(	vector3df &	out,
		const vector3df &	in
	)			const [inline]

void transformVect

(

vector3df &

vect

)

const [inline]

void translateVect

(

vector3df &

vect

)

const [inline]

---

Field Documentation

union { ... }

f32 m[4][4]

f32 M[16]

f32 m00

f32 m01

f32 m02

f32 m03

f32 m10

f32 m11

f32 m12

f32 m13

f32 m20

f32 m21

f32 m22

f32 m23

f32 m30

f32 m31

f32 m32

f32 m33

---