Annwvyn::AnnQuaternion Class Reference

Represent a Quaternion. More...

#include <AnnQuaternion.hpp>

Inheritance diagram for Annwvyn::AnnQuaternion:
Collaboration diagram for Annwvyn::AnnQuaternion:

Public Member Functions

 AnnQuaternion ()
 
 AnnQuaternion (const Quaternion &q)
 Construct form an Ogre Quaternion. More...
 
 AnnQuaternion (float cw, float cx, float cy, float cz)
 Construct from 4 float WXYZ. More...
 
 AnnQuaternion (const Ogre::Matrix3 &rot)
 Construct from a rotation matrix 3x3. More...
 
 AnnQuaternion (AnnRadian angle, AnnVect3 raxis)
 Construct from an angle around an arbitrary axis. More...
 
 AnnQuaternion (const AnnVect3 &xAxis, const AnnVect3 &yAxis, const AnnVect3 &zAxis)
 Construct from a 3 axis base. More...
 
 AnnQuaternion (const AnnVect3 *vectorArray)
 Construct from a vector array. More...
 
 AnnQuaternion (float *floatArray)
 Construct from a float array. More...
 
 AnnQuaternion (const btQuaternion &q)
 Constrruct from a bullet Quaternion. More...
 
AnnVect3 getUpVector () const
 Get a vector pointing upwards from this quaternion. More...
 
AnnVect3 getAtVector () const
 Get a vector pointing in the direction if this quaternion. More...
 
btQuaternion getBtQuaternion () const
 get this quaternion as a bullet quaternion More...
 
bool isValid () const
 If true you can trust the data on this Quaternion. More...
 
 AnnQuaternion (bool validState)
 Used to say that the quaternion hasn't been retrieved. More...
 
 operator btQuaternion () const
 

Private Member Functions

void init ()
 Set valid to true. More...
 

Private Attributes

bool valid
 Validity boolean. More...
 

Detailed Description

Represent a Quaternion.

Definition at line 20 of file AnnQuaternion.hpp.

Constructor & Destructor Documentation

◆ AnnQuaternion() [1/10]

AnnQuaternion::AnnQuaternion ( )

Definition at line 8 of file AnnQuaternion.cpp.

Here is the call graph for this function:

◆ AnnQuaternion() [2/10]

AnnQuaternion::AnnQuaternion ( const Quaternion &  q)

Construct form an Ogre Quaternion.

Definition at line 10 of file AnnQuaternion.cpp.

Here is the call graph for this function:

◆ AnnQuaternion() [3/10]

AnnQuaternion::AnnQuaternion ( float  cw,
float  cx,
float  cy,
float  cz 
)

Construct from 4 float WXYZ.

Definition at line 13 of file AnnQuaternion.cpp.

Here is the call graph for this function:

◆ AnnQuaternion() [4/10]

AnnQuaternion::AnnQuaternion ( const Ogre::Matrix3 &  rot)

Construct from a rotation matrix 3x3.

Definition at line 16 of file AnnQuaternion.cpp.

Here is the call graph for this function:

◆ AnnQuaternion() [5/10]

AnnQuaternion::AnnQuaternion ( AnnRadian  angle,
AnnVect3  raxis 
)

Construct from an angle around an arbitrary axis.

Definition at line 19 of file AnnQuaternion.cpp.

Here is the call graph for this function:

◆ AnnQuaternion() [6/10]

AnnQuaternion::AnnQuaternion ( const AnnVect3 xAxis,
const AnnVect3 yAxis,
const AnnVect3 zAxis 
)

Construct from a 3 axis base.

Definition at line 22 of file AnnQuaternion.cpp.

Here is the call graph for this function:

◆ AnnQuaternion() [7/10]

AnnQuaternion::AnnQuaternion ( const AnnVect3 vectorArray)

Construct from a vector array.

Definition at line 25 of file AnnQuaternion.cpp.

Here is the call graph for this function:

◆ AnnQuaternion() [8/10]

AnnQuaternion::AnnQuaternion ( float *  floatArray)

Construct from a float array.

Definition at line 28 of file AnnQuaternion.cpp.

Here is the call graph for this function:

◆ AnnQuaternion() [9/10]

AnnQuaternion::AnnQuaternion ( const btQuaternion &  q)

Constrruct from a bullet Quaternion.

Definition at line 31 of file AnnQuaternion.cpp.

Here is the call graph for this function:

◆ AnnQuaternion() [10/10]

AnnQuaternion::AnnQuaternion ( bool  validState)

Used to say that the quaternion hasn't been retrieved.

Definition at line 34 of file AnnQuaternion.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ getAtVector()

AnnVect3 AnnQuaternion::getAtVector ( ) const

Get a vector pointing in the direction if this quaternion.

Definition at line 41 of file AnnQuaternion.cpp.

Here is the caller graph for this function:

◆ getBtQuaternion()

btQuaternion AnnQuaternion::getBtQuaternion ( ) const

get this quaternion as a bullet quaternion

Definition at line 51 of file AnnQuaternion.cpp.

Here is the caller graph for this function:

◆ getUpVector()

AnnVect3 AnnQuaternion::getUpVector ( ) const

Get a vector pointing upwards from this quaternion.

Definition at line 46 of file AnnQuaternion.cpp.

Here is the caller graph for this function:

◆ init()

void AnnQuaternion::init ( )
inlineprivate

Set valid to true.

Definition at line 56 of file AnnQuaternion.cpp.

Here is the caller graph for this function:

◆ isValid()

bool AnnQuaternion::isValid ( ) const

If true you can trust the data on this Quaternion.

Definition at line 61 of file AnnQuaternion.cpp.

◆ operator btQuaternion()

AnnQuaternion::operator btQuaternion ( ) const

Definition at line 66 of file AnnQuaternion.cpp.

Member Data Documentation

◆ valid

bool Annwvyn::AnnQuaternion::valid
private

Validity boolean.

Definition at line 64 of file AnnQuaternion.hpp.


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