Open Reality Reference Guide
FBMatrix Class Reference

Four x Four (double) Matrix. More...

#include <fbtypes.h>

Public Member Functions

 FBMatrix ()
 Constructor Initializes matrix to identity. More...
 
 FBMatrix (const double *pValue)
 Constructor. More...
 
 FBMatrix (const FBMatrix &pMatrix)
 Copy Constructor. More...
 
void Identity ()
 Load identity matrix. More...
 
void Set (const double *pValue)
 Set matrix from an array. More...
 
 operator double * () const
 Overloaded double* cast. More...
 
double ** GetData () const
 return internal Data More...
 
double & operator() (int i, int j)
 Overloaded operator (,) More...
 
const FBMatrixoperator= (const FBMatrix &pMatrix)
 Overloaded equal operator. More...
 
const FBMatrixoperator= (const double *pValue)
 assign operator. More...
 
bool operator!= (const FBMatrix &pMatrix)
 not equal operator. More...
 
bool operator== (const FBMatrix &pMatrix)
 equal operator. More...
 
const FBMatrix operator+ (const FBMatrix &pMatrix) const
 add operator. More...
 
FBMatrixoperator+= (const FBMatrix &pMatrix)
 add operator in place. More...
 
const FBMatrix operator- ()
 unary minus operator. More...
 
const FBMatrix operator- (const FBMatrix &pMatrix) const
 minus operator. More...
 
FBMatrixoperator-= (const FBMatrix &pMatrix)
 minus operator in place. More...
 
const FBMatrix operator* (const FBMatrix &pMatrix) const
 multiply operator. More...
 
FBMatrixoperator*= (const FBMatrix &pMatrix)
 multiply operator in place. More...
 
const FBMatrix operator* (const double pN) const
 multiply operator for double. More...
 
FBMatrixoperator*= (const double pN)
 multiply operator for double in place. More...
 
FBMatrixInverse ()
 Get Inversed matrix. More...
 
FBMatrixTranspose ()
 Get Transposed matrix. More...
 
bool Validate ()
 Validated matrix. More...
 
const FBMatrix InverseProduct (const FBMatrix &pMatrix)
 InverseProduct Matrix. More...
 

Detailed Description

Four x Four (double) Matrix.

Definition at line 289 of file fbtypes.h.

Constructor & Destructor Documentation

◆ FBMatrix() [1/3]

FBMatrix ( )

Constructor Initializes matrix to identity.

◆ FBMatrix() [2/3]

FBMatrix ( const double *  pValue)

Constructor.

Parameters
pValueArray to intialize matrix from.

◆ FBMatrix() [3/3]

FBMatrix ( const FBMatrix pMatrix)

Copy Constructor.

Parameters
pMatrixMatrix to copy.

Member Function Documentation

◆ GetData()

double** GetData ( ) const

return internal Data

Returns
return an array[4][4].

◆ Identity()

void Identity ( )

Load identity matrix.

◆ Inverse()

FBMatrix& Inverse ( )

Get Inversed matrix.

Returns
the matrix Inversed.

◆ InverseProduct()

const FBMatrix InverseProduct ( const FBMatrix pMatrix)

InverseProduct Matrix.

Parameters
pMatrixMatrix to Product.
Returns
result matrix.

◆ operator double *()

operator double * ( ) const

Overloaded double* cast.

Returns
Matrix as an array.

◆ operator!=()

bool operator!= ( const FBMatrix pMatrix)

not equal operator.

Parameters
pMatrixMatrix to compare.
Returns
true if not equal.

◆ operator()()

double& operator() ( int  i,
int  j 
)

Overloaded operator (,)

Returns
element at position i,j

◆ operator*() [1/2]

const FBMatrix operator* ( const double  pN) const

multiply operator for double.

Parameters
pNdouble to multiply.
Returns
result Matrix.

◆ operator*() [2/2]

const FBMatrix operator* ( const FBMatrix pMatrix) const

multiply operator.

Parameters
pMatrixMatrix to multiply.
Returns
result Matrix.

◆ operator*=() [1/2]

FBMatrix& operator*= ( const double  pN)

multiply operator for double in place.

Parameters
pNdouble to multiply.
Returns
this matrix.

◆ operator*=() [2/2]

FBMatrix& operator*= ( const FBMatrix pMatrix)

multiply operator in place.

Parameters
pMatrixMatrix to multiply.
Returns
this matrix.

◆ operator+()

const FBMatrix operator+ ( const FBMatrix pMatrix) const

add operator.

Parameters
pMatrixMatrix to add.
Returns
result Matrix.

◆ operator+=()

FBMatrix& operator+= ( const FBMatrix pMatrix)

add operator in place.

Parameters
pMatrixMatrix to add.
Returns
this matrix as a const.

◆ operator-() [1/2]

const FBMatrix operator- ( )

unary minus operator.

Returns
this matrix as a const.

◆ operator-() [2/2]

const FBMatrix operator- ( const FBMatrix pMatrix) const

minus operator.

Parameters
pMatrixMatrix to minus.
Returns
result Matrix.

◆ operator-=()

FBMatrix& operator-= ( const FBMatrix pMatrix)

minus operator in place.

Parameters
pMatrixMatrix to minus.
Returns
this matrix.

◆ operator=() [1/2]

const FBMatrix& operator= ( const double *  pValue)

assign operator.

Parameters
pValuearray to assign.
Returns
this matrix as a const.

◆ operator=() [2/2]

const FBMatrix& operator= ( const FBMatrix pMatrix)

Overloaded equal operator.

Parameters
pMatrixMatrix to copy.
Returns
this matrix as a const.

◆ operator==()

bool operator== ( const FBMatrix pMatrix)

equal operator.

Parameters
pMatrixMatrix to compare.
Returns
true if equal.

◆ Set()

void Set ( const double *  pValue)

Set matrix from an array.

Parameters
pValueArray to intialize matrix from.

◆ Transpose()

FBMatrix& Transpose ( )

Get Transposed matrix.

Returns
the matrix Transposed.

◆ Validate()

bool Validate ( )

Validated matrix.

Returns
true if matrix Validated.

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