karto::Matrix3 Class Reference

#include <Karto.h>

Public Member Functions
void	Clear ()
void	FromAxisAngle (kt_double x, kt_double y, kt_double z, const kt_double radians)
Matrix3	Inverse () const
kt_bool	InverseFast (Matrix3 &rkInverse, kt_double fTolerance=KT_TOLERANCE) const
	Matrix3 ()
	Matrix3 (const Matrix3 &rOther)
kt_double &	operator() (kt_int32u row, kt_int32u column)
kt_double	operator() (kt_int32u row, kt_int32u column) const
Matrix3	operator* (const Matrix3 &rOther) const
Pose2	operator* (const Pose2 &rPose2) const
void	operator+= (const Matrix3 &rkMatrix)
Matrix3 &	operator= (const Matrix3 &rOther)
void	SetToIdentity ()
std::string	ToString () const
Matrix3	Transpose () const

Private Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Private Attributes
kt_double	m_Matrix [3][3]

Friends
class	boost::serialization::access
std::ostream &	operator<< (std::ostream &rStream, const Matrix3 &rMatrix)

Detailed Description

Defines a Matrix 3 x 3 class.

Definition at line 2444 of file Karto.h.

Constructor & Destructor Documentation

Matrix3() [1/2]

karto::Matrix3::Matrix3 ( )

inline

Default constructor

Definition at line 2450 of file Karto.h.

Matrix3() [2/2]

karto::Matrix3::Matrix3 ( const Matrix3 &  rOther )

inline

Copy constructor

Definition at line 2458 of file Karto.h.

Member Function Documentation

Clear()

void karto::Matrix3::Clear ( )

inline

Sets this matrix to zero matrix

Definition at line 2480 of file Karto.h.

FromAxisAngle()

void karto::Matrix3::FromAxisAngle ( kt_double  x, kt_double  y, kt_double  z, const kt_double  radians  )

inline

Sets this matrix to be the rotation matrix of rotation around given axis

Parameters

x	x-coordinate of axis
y	y-coordinate of axis
z	z-coordinate of axis
radians	amount of rotation

Definition at line 2492 of file Karto.h.

Inverse()

Matrix3 karto::Matrix3::Inverse ( ) const

inline

Returns the inverse of the matrix

Definition at line 2545 of file Karto.h.

InverseFast()

kt_bool karto::Matrix3::InverseFast ( Matrix3 &  rkInverse, kt_double  fTolerance = KT_TOLERANCE  ) const

inline

Internal helper method for inverse matrix calculation This code is lifted from the OgreMatrix3 class!!

Definition at line 2560 of file Karto.h.

operator()() [1/2]

kt_double& karto::Matrix3::operator() ( kt_int32u  row, kt_int32u  column  )

inline

Matrix element access, allows use of construct mat(r, c)

Parameters

row
column

Returns

reference to mat(r,c)

Definition at line 2631 of file Karto.h.

operator()() [2/2]

kt_double karto::Matrix3::operator() ( kt_int32u  row, kt_int32u  column  ) const

inline

Read-only matrix element access, allows use of construct mat(r, c)

Parameters

row
column

Returns

mat(r,c)

Definition at line 2642 of file Karto.h.

operator*() [1/2]

Matrix3 karto::Matrix3::operator* ( const Matrix3 &  rOther ) const

inline

Binary Matrix3 multiplication.

Parameters

rOther

Returns

Matrix3 product

Definition at line 2652 of file Karto.h.

operator*() [2/2]

Pose2 karto::Matrix3::operator* ( const Pose2 &  rPose2 ) const

inline

Matrix3 and Pose2 multiplication - matrix * pose [3x3 * 3x1 = 3x1]

Parameters

rPose2

Returns

Pose2 product

Definition at line 2674 of file Karto.h.

operator+=()

void karto::Matrix3::operator+= ( const Matrix3 &  rkMatrix )

inline

In place Matrix3 add.

Parameters

rkMatrix

Definition at line 2692 of file Karto.h.

operator=()

Matrix3& karto::Matrix3::operator= ( const Matrix3 &  rOther )

inline

Assignment operator

Definition at line 2619 of file Karto.h.

serialize()

template<class Archive >

void karto::Matrix3::serialize ( Archive &  ar, const unsigned int  version  )

inlineprivate

Definition at line 2718 of file Karto.h.

SetToIdentity()

void karto::Matrix3::SetToIdentity ( )

inline

Sets this matrix to identity matrix

Definition at line 2467 of file Karto.h.

ToString()

std::string karto::Matrix3::ToString ( ) const

inline

Returns a string representation of this matrix

Returns

string representation of this matrix

Definition at line 2599 of file Karto.h.

Transpose()

Matrix3 karto::Matrix3::Transpose ( ) const

inline

Returns transposed version of this matrix

Returns

transposed matrix

Definition at line 2527 of file Karto.h.

Friends And Related Function Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Definition at line 2716 of file Karto.h.

operator<<

std::ostream& operator<< ( std::ostream &  rStream, const Matrix3 &  rMatrix  )

friend

Write Matrix3 onto output stream

Parameters

rStream	output stream
rMatrix	to write

Definition at line 2708 of file Karto.h.

Member Data Documentation

m_Matrix

kt_double karto::Matrix3::m_Matrix[3][3]

private

Definition at line 2715 of file Karto.h.

---

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

• Karto.h