Moteur3D::Matrix3 Class Reference

#include <Matrix3.h>

List of all members.

Public Member Functions
	Matrix3 ()
	Default constructor. Does NOT initialise data for performance.
	Matrix3 (const Matrix3 &m)
	Copy Constructor.
	Matrix3 (Vector3 &v1, Vector3 &v2, Vector3 &v3)
	Builds a matrix from 3 vectors that serve as columns.
	Matrix3 (const float m00, const float m10, const float m20, const float m01, const float m11, const float m21, const float m02, const float m12, const float m22)
	Builds a matrix from 9 values. m00, m10 and m20 are the first column, and so on.
	Matrix3 (const float values[3][3])
	Builds a matrix from an array of values.
TestResult	Test ()
	Tests this class and returns the result in a TestResult structure.
std::string	ToString ()
	Returns a string that represents the actual object.
Vector3 *	operator[] (unsigned int col)
	Array indexing operator.
const Vector3 *	operator[] (unsigned int col) const
	Array indexing operator.
Matrix3 &	operator= (const Matrix3 &m)
	Assign operator.
Matrix3 &	operator+= (const Matrix3 &m)
	Adds a Matrix3 to this one.
Matrix3 &	operator-= (const Matrix3 &m)
	Subtracts a Matrix3 from this one.
Matrix3 &	operator *= (const Matrix3 &m)
	Multiplies the Matrix3 by another Matrix3.
Matrix3 &	operator *= (float f)
	Multiplies the Matrix3 by a float.
Matrix3 &	operator/= (float f)
	Divides the Matrix3 by a float.
Protected Attributes
float	mat3 [3][3]
Friends
bool	operator== (const Matrix3 &m1, const Matrix3 &m2)
	Are these two Matrix3's equal ?
bool	operator!= (const Matrix3 &m1, const Matrix3 &m2)
	Are these two Matrix3's not equal ?
Matrix3	operator+ (const Matrix3 &m1, const Matrix3 &m2)
	Add two Matrix3's.
Matrix3	operator- (const Matrix3 &m1, const Matrix3 &m2)
	Subtracts one Matrix3 from another.
Matrix3	operator * (const Matrix3 &m1, const Matrix3 &m2)
	Multiplies a Matrix3 by another one.
Vector3	operator * (const Matrix3 &m, const Vector3 &v)
	Multiplies a Matrix3 by a Vector3.
Vector3	operator * (const Vector3 &v, const Matrix3 &m)
	Multiplies a Vector3 by a Matrix3.
Matrix3	operator * (const Matrix3 &m, float f)
	Multiplies a Matrix3 by a float.
Matrix3	operator * (const float f, const Matrix3 &m)
	Multiplies a Matrix3 by a float.

---

Constructor & Destructor Documentation

Moteur3D::Matrix3::Matrix3 (   )  [inline]

Default constructor. Does NOT initialise data for performance. Note that internally data is stored column-wise.

Moteur3D::Matrix3::Matrix3 (  const Matrix3 &  m  )

Copy Constructor.

Moteur3D::Matrix3::Matrix3 (  Vector3 &  v1, Vector3 &  v2, Vector3 &  v3 )

Builds a matrix from 3 vectors that serve as columns.

Moteur3D::Matrix3::Matrix3 (  const float  m00, const float  m10, const float  m20, const float  m01, const float  m11, const float  m21, const float  m02, const float  m12, const float  m22 )

Builds a matrix from 9 values. m00, m10 and m20 are the first column, and so on.

Moteur3D::Matrix3::Matrix3 (  const float  values[3][3]  )

Builds a matrix from an array of values. Parameters: values  3x3 array of values.

---

Member Function Documentation

Matrix3& Moteur3D::Matrix3::operator *= (  float  f  )  [inline]

Multiplies the Matrix3 by a float.

Matrix3& Moteur3D::Matrix3::operator *= (  const Matrix3 &  m  )

Multiplies the Matrix3 by another Matrix3.

Matrix3& Moteur3D::Matrix3::operator+= (  const Matrix3 &  m  )  [inline]

Adds a Matrix3 to this one.

Matrix3& Moteur3D::Matrix3::operator-= (  const Matrix3 &  m  )  [inline]

Subtracts a Matrix3 from this one.

Matrix3& Moteur3D::Matrix3::operator/= (  float  f  )  [inline]

Divides the Matrix3 by a float.

Matrix3& Moteur3D::Matrix3::operator= (  const Matrix3 &  m  )  [inline]

Assign operator.

const Vector3* Moteur3D::Matrix3::operator[] (  unsigned int  col  )  const [inline]

Array indexing operator.

Vector3* Moteur3D::Matrix3::operator[] (  unsigned int  col  )  [inline]

Array indexing operator.

TestResult Moteur3D::Matrix3::Test (   )

Tests this class and returns the result in a TestResult structure. Returns: Testresult structure that holds the success (or not) of the test as well as remarks about the success or failure.

std::string Moteur3D::Matrix3::ToString (   )

Returns a string that represents the actual object. Returns: see brief :)

---

Friends And Related Function Documentation

Matrix3 operator * (  const float  f, const Matrix3 &  m )  [friend]

Multiplies a Matrix3 by a float.

Matrix3 operator * (  const Matrix3 &  m, float  f )  [friend]

Multiplies a Matrix3 by a float.

Vector3 operator * (  const Vector3 &  v, const Matrix3 &  m )  [friend]

Multiplies a Vector3 by a Matrix3.

Vector3 operator * (  const Matrix3 &  m, const Vector3 &  v )  [friend]

Multiplies a Matrix3 by a Vector3.

Matrix3 operator * (  const Matrix3 &  m1, const Matrix3 &  m2 )  [friend]

Multiplies a Matrix3 by another one.

bool operator!= (  const Matrix3 &  m1, const Matrix3 &  m2 )  [friend]

Are these two Matrix3's not equal ?

Matrix3 operator+ (  const Matrix3 &  m1, const Matrix3 &  m2 )  [friend]

Add two Matrix3's.

Matrix3 operator- (  const Matrix3 &  m1, const Matrix3 &  m2 )  [friend]

Subtracts one Matrix3 from another.

bool operator== (  const Matrix3 &  m1, const Matrix3 &  m2 )  [friend]

Are these two Matrix3's equal ?

---

Member Data Documentation

float Moteur3D::Matrix3::mat3[3][3] [protected]

---

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

• Math/Matrix3.h

---