karto::Matrix3 Class Reference

#include <Karto.h>

List of all members.

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 (const Matrix3 &rOther)
 Matrix3 ()
kt_double operator() (kt_int32u row, kt_int32u column) const
kt_doubleoperator() (kt_int32u row, kt_int32u column)
Pose2 operator* (const Pose2 &rPose2) const
Matrix3 operator* (const Matrix3 &rOther) const
void operator+= (const Matrix3 &rkMatrix)
Matrix3operator= (const Matrix3 &rOther)
void SetToIdentity ()
std::string ToString () const
Matrix3 Transpose () const

Private Attributes

kt_double m_Matrix [3][3]

Friends

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

Detailed Description

Defines a Matrix 3 x 3 class.

Definition at line 2237 of file Karto.h.


Constructor & Destructor Documentation

karto::Matrix3::Matrix3 (  )  [inline]

Default constructor

Definition at line 2243 of file Karto.h.

karto::Matrix3::Matrix3 ( const Matrix3 rOther  )  [inline]

Copy constructor

Definition at line 2251 of file Karto.h.


Member Function Documentation

void karto::Matrix3::Clear (  )  [inline]

Sets this matrix to zero matrix

Definition at line 2273 of file Karto.h.

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 2285 of file Karto.h.

Matrix3 karto::Matrix3::Inverse (  )  const [inline]

Returns the inverse of the matrix

Definition at line 2338 of file Karto.h.

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 2353 of file Karto.h.

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 2433 of file Karto.h.

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 2422 of file Karto.h.

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 2463 of file Karto.h.

Matrix3 karto::Matrix3::operator* ( const Matrix3 rOther  )  const [inline]

Binary Matrix3 multiplication.

Parameters:
rkMatrix 
Returns:
Matrix3 product

Definition at line 2443 of file Karto.h.

void karto::Matrix3::operator+= ( const Matrix3 rkMatrix  )  [inline]

In place Matrix3 add.

Parameters:
rkMatrix 

Definition at line 2478 of file Karto.h.

Matrix3& karto::Matrix3::operator= ( const Matrix3 rOther  )  [inline]

Assignment operator

Definition at line 2410 of file Karto.h.

void karto::Matrix3::SetToIdentity (  )  [inline]

Sets this matrix to identity matrix

Definition at line 2260 of file Karto.h.

std::string karto::Matrix3::ToString (  )  const [inline]

Returns a string representation of this matrix

Returns:
string representation of this matrix

Definition at line 2390 of file Karto.h.

Matrix3 karto::Matrix3::Transpose (  )  const [inline]

Returns transposed version of this matrix

Returns:
transposed matrix

Definition at line 2320 of file Karto.h.


Friends And Related Function Documentation

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 2494 of file Karto.h.


Member Data Documentation

Definition at line 2501 of file Karto.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


karto
Author(s): SRI International (package maintained by Brian Gerkey)
autogenerated on Fri Jan 11 10:07:05 2013