FMQuaternion Class Reference
[Mathematics Classes.]

A quaternion. More...

#include <FMQuaternion.h>

List of all members.

Public Member Functions

 FMQuaternion ()
 Creates an empty FMQuaternion.
 FMQuaternion (float _x, float _y, float _z, float _w)
 Creates the FMQuaternion with the given component values.
 FMQuaternion (const FMVector3 &axis, float angle)
 Creates the FMQuaternion from a given axis and angle of rotation.
 operator float * ()
 Get this FMQuaternion as an array of floats.
 operator const float * () const
 Get this FMQuaternion as an array of floats.
FMQuaternionoperator= (const float *v)
 Assign this FMQuaternion to the given float array.
FMQuaternion operator * (const FMQuaternion &q) const
 Applys quaternion multiplication of the given FMQuaternion with this FMQuaternion and returns the value.

Static Public Member Functions

static FMQuaternion EulerRotationQuaternion (float _x, float _y, float _z)
 Get the FMQuaternion representation of the Euler rotation angles.

Public Attributes

float x
 The i component.
float y
 The j component.
float z
 The k component.
float w
 The scalar component.


Detailed Description

A quaternion.

Not used within FCollada

[Glaforte 03-08-2006] VERY EXPERIMENTAL CODE: DON'T USE.


Constructor & Destructor Documentation

FMQuaternion::FMQuaternion  )  [inline]
 

Creates an empty FMQuaternion.

The default values are non deterministic.

FMQuaternion::FMQuaternion float  _x,
float  _y,
float  _z,
float  _w
[inline]
 

Creates the FMQuaternion with the given component values.

Parameters:
_x The i component.
_y The j component.
_z The k component.
_w The scalar component.

FMQuaternion::FMQuaternion const FMVector3 axis,
float  angle
 

Creates the FMQuaternion from a given axis and angle of rotation.

Parameters:
axis The axis of rotation.
angle The angle of rotation in radians.


Member Function Documentation

static FMQuaternion FMQuaternion::EulerRotationQuaternion float  _x,
float  _y,
float  _z
[static]
 

Get the FMQuaternion representation of the Euler rotation angles.

Parameters:
_x The rotation about the x-axis (roll), in radians.
_y The rotation about the y-axis (pitch), in radians.
_z The rotation about the z-axis (yaw), in radians.

FMQuaternion FMQuaternion::operator * const FMQuaternion q  )  const
 

Applys quaternion multiplication of the given FMQuaternion with this FMQuaternion and returns the value.

Parameters:
q The FMQuaternion multiply with.
Returns:
The resulting FMQuaternion.

FMQuaternion::operator const float *  )  const [inline]
 

Get this FMQuaternion as an array of floats.

Returns:
The float array.

FMQuaternion::operator float *  )  [inline]
 

Get this FMQuaternion as an array of floats.

Returns:
The float array.

FMQuaternion& FMQuaternion::operator= const float *  v  )  [inline]
 

Assign this FMQuaternion to the given float array.

Assigns each coordinate of this FMQuaternion to the elements in the float array. The first element to the i component, the second to the j, the third to the k, and the forth to the scalar. It returns this FMQuaternion.

Parameters:
v The float array to assign with.
Returns:
This FMQuaternion.


The documentation for this class was generated from the following file:
Generated on Fri May 12 16:44:44 2006 for FCollada by  doxygen 1.4.6-NO