Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

RmMatrix4x4 Class Reference

4x4 Matrix class More...

#include <RmMatrix.h>

List of all members.

Public Member Functions

 RmMatrix4x4 ()
 Constructor.

 RmMatrix4x4 (const RmMatrix4x4 &src)
 Constructor.

 RmMatrix4x4 (const float src[16])
 Constructor.

virtual ~RmMatrix4x4 ()
 Destructor.

float * GetElements ()
 Get elements.

const float * GetElements () const
 Get elements.

void operator= (const RmMatrix4x4 &src)
 Copy operator.

float * operator[] (int rowIndex)
 Indexing operator.

const float * operator[] (int rowIndex) const
 Indexing operator.

RmMatrix4x4 operator * (const RmMatrix4x4 &rhs) const
 Multiplication operator.

void operator *= (const RmMatrix4x4 &rhs)
 Multiplication and assign operator.

void SetEntries (float val)
 Set entries.

void SetEntries (const float src[16])
 Set Entries.

void Identity ()
 Set matrix to identity.

void Transpose ()
 Transpose matrix.

bool Inverse ()
 Inverse matrix.

void Rotate (const float xAxis, const float yAxis, const float zAxis, const float angle, const RmAngleType angleType)
 Rotate matrix.

void Translate (const float x, const float y, const float z)
 Translate matrix.

void Scale (const float x, const float y, const float z)
 Scale matrix.

void CopyTo (float dest[16]) const
 Copy to array of floats.

void CopyToTranspose (float dest[16]) const
 Copy to array of floats in transposed format.

RmVector3D TransformPoint (const RmVector3D &v) const
 Transform vector.

RmVector3D TransformVector (const RmVector3D &v) const
 Transform vector.


Detailed Description

4x4 Matrix class

Matrix4x4


Constructor & Destructor Documentation

RmMatrix4x4::RmMatrix4x4  ) 
 

Constructor.

Constructor

RmMatrix4x4::RmMatrix4x4 const RmMatrix4x4 src  ) 
 

Constructor.

Constructor with src to copy from

Parameters:
src Source matrix to copy values from

RmMatrix4x4::RmMatrix4x4 const float  src[16]  ) 
 

Constructor.

Constructor with 16 floats to initialize to

Parameters:
src 16 floats array to initalize values to

virtual RmMatrix4x4::~RmMatrix4x4  )  [virtual]
 

Destructor.

Destructor


Member Function Documentation

void RmMatrix4x4::CopyTo float  dest[16]  )  const
 

Copy to array of floats.

Copy contents of matrix to 16 floats

Parameters:
dest 16 floats to receive contents of this matrix
Returns:
None

void RmMatrix4x4::CopyToTranspose float  dest[16]  )  const
 

Copy to array of floats in transposed format.

Copy to array of floats in tranposed fromat

Parameters:
dest 16 floats to receive contents of this matrix
Returns:
None

const float* RmMatrix4x4::GetElements  )  const [inline]
 

Get elements.

Get elements

Returns:
Elements as row pointer

float* RmMatrix4x4::GetElements  )  [inline]
 

Get elements.

Get elements

Returns:
Elements as row pointer

void RmMatrix4x4::Identity  ) 
 

Set matrix to identity.

Set matrix to identity

Returns:
None

bool RmMatrix4x4::Inverse  ) 
 

Inverse matrix.

Inverse matrix, if matrix is singular, ( not invertible ) it will return false.

Returns:
True if inverting is successfull. False otherwise

RmMatrix4x4 RmMatrix4x4::operator * const RmMatrix4x4 rhs  )  const
 

Multiplication operator.

Concatenation of Matrix to Matrix

Parameters:
rhs Matrix to multiply with
Returns:
Result matrix aftre multiplication

void RmMatrix4x4::operator *= const RmMatrix4x4 rhs  ) 
 

Multiplication and assign operator.

Concatenation of Matrix to Matrix and put result into this matrix

Parameters:
rhs Matrix to multiply with
Returns:
None

void RmMatrix4x4::operator= const RmMatrix4x4 src  ) 
 

Copy operator.

Copy operator

Parameters:
src Matrix to copy from
Returns:
None

const float* RmMatrix4x4::operator[] int  rowIndex  )  const
 

Indexing operator.

Index operator.

Parameters:
rowIndex Index to row of matrix
Returns:
Pointer to beginning of row values.

float* RmMatrix4x4::operator[] int  rowIndex  ) 
 

Indexing operator.

Index operator.

Parameters:
rowIndex Index to row of matrix
Returns:
Pointer to beginning of row values.

void RmMatrix4x4::Rotate const float  xAxis,
const float  yAxis,
const float  zAxis,
const float  angle,
const RmAngleType  angleType
 

Rotate matrix.

Rotate matrix by given angle and rotaion axis

Parameters:
xAxis Rotation axis x component
yAxis Rotation axis y component
zAxis Rotation axis z component
angle Angle of rotation
angleType Type of angle ( radian or degree )
See also:
RmAngleType
Returns:
None

void RmMatrix4x4::Scale const float  x,
const float  y,
const float  z
 

Scale matrix.

Scale matrix by given scaler

Parameters:
Scaler x component
Scaler y component
Scaler z component
Returns:
None

void RmMatrix4x4::SetEntries const float  src[16]  ) 
 

Set Entries.

Copy entries from 16 floats array

Parameters:
src 16 floats
Returns:
None

void RmMatrix4x4::SetEntries float  val  ) 
 

Set entries.

Set Entries to one value. All matrix entrty will have this value.

Parameters:
val Value to set all entries to
Returns:
None

RmVector3D RmMatrix4x4::TransformPoint const RmVector3D v  )  const
 

Transform vector.

Transform vector. Result = v * this matrix

Parameters:
v Vector to transform
Returns:
Result vector, transformed by this matrix

RmVector3D RmMatrix4x4::TransformVector const RmVector3D v  )  const
 

Transform vector.

Transform vector. Result = v * this matrix

Parameters:
v Vector to transform
Returns:
Result vector, transformed by this matrix

void RmMatrix4x4::Translate const float  x,
const float  y,
const float  z
 

Translate matrix.

Translate matrix by give offset

Parameters:
x Translation x component
y Translation y component
z Translation z component
Returns:
None

void RmMatrix4x4::Transpose  ) 
 

Transpose matrix.

Transpose matrix

Returns:
None


The documentation for this class was generated from the following file:
Generated on Fri Feb 25 16:09:09 2005 for RenderMonkey SDK by doxygen 1.3.6