Home | Download | Screen shots | Discussion | Documentation |
---|
A POD-struct comprising a quaternion. More...
#include <openvrml/basetypes.h>
Public Member Functions | |
quatf & | operator*= (const quatf &quat) throw () |
Multiply by a quaternion. | |
quatf & | operator*= (float scalar) throw () |
Multiply by a scalar. | |
quatf & | operator/= (float scalar) throw () |
Divide by a scalar. | |
quatf & | operator+= (const quatf &quat) throw () |
Add a quaternion. | |
quatf & | operator-= (const quatf &quat) throw () |
Subtract a quaternion. | |
const float & | operator[] (std::size_t index) const throw () |
Array element dereference operator (const version). | |
float & | operator[] (std::size_t index) throw () |
Array element dereference operator (non-const version). | |
float | x () const throw () |
Get the x component. | |
float | y () const throw () |
Get the y component. | |
float | z () const throw () |
Get the z component. | |
float | w () const throw () |
Get the w component. | |
void | x (float value) throw () |
Set the x component. | |
void | y (float value) throw () |
Set the y component. | |
void | z (float value) throw () |
Set the z component. | |
void | w (float value) throw () |
Set the w component. | |
const quatf | conjugate () const throw () |
Get the conjugate. | |
const quatf | inverse () const throw () |
Get the inverse. | |
float | norm () const throw () |
Get the norm. | |
const quatf | normalize () const throw () |
Normalize the quaternion. |
Public Attributes | |
float | quat [4] |
An array comprising the quaternion components. |
Related Functions | |
(Note that these are not member functions.) | |
const openvrml::quatf | make_quatf () throw() |
Create a default quatf . | |
const openvrml::quatf | make_quatf (const float x, const float y, const float z, const float w) throw() |
Create a quatf from four values. | |
const openvrml::quatf | make_quatf (const float(&quat)[4]) throw() |
Create a quatf from an array of four values. | |
const openvrml::quatf | make_quatf (const mat4f &mat) throw() |
Create a quatf from a rotation matrix. | |
const openvrml::quatf | make_quatf (const rotation &rot) throw() |
Create a quatf from a rotation . | |
const openvrml::quatf | operator* (const quatf &lhs, const quatf &rhs) throw() |
Multiply two quaternions. | |
const openvrml::quatf | operator* (const quatf &quat, const float scalar) throw() |
Multiply a quaternion by a scalar. | |
const openvrml::quatf | operator* (const float scalar, const quatf &quat) throw() |
Multiply a scalar by a quaternion. | |
const openvrml::quatf | operator/ (const quatf &quat, const float scalar) throw() |
Divide a quaternion by a scalar. | |
const openvrml::quatf | operator+ (const quatf &lhs, const quatf &rhs) throw() |
Add two quaternions. | |
const openvrml::quatf | operator- (const quatf &lhs, const quatf &rhs) throw() |
Take the difference between two quaternions. | |
std::ostream & | operator<< (std::ostream &out, const quatf &quat) |
Stream output. | |
bool | operator== (const quatf &lhs, const quatf &rhs) throw() |
Compare for equality. | |
bool | operator!= (const quatf &lhs, const quatf &rhs) throw() |
Compare for inequality. |
A POD-struct comprising a quaternion.
openvrml::quatf & openvrml::quatf::operator*= | ( | const quatf & | quat | ) | throw () |
Multiply by a quaternion.
[in] | quat | the quaternion by which to multiply. |
openvrml::quatf & openvrml::quatf::operator*= | ( | float | scalar | ) | throw () |
Multiply by a scalar.
[in] | scalar | value by which to multiply. |
openvrml::quatf & openvrml::quatf::operator/= | ( | float | scalar | ) | throw () |
Divide by a scalar.
[in] | scalar | value by which to divide. |
openvrml::quatf & openvrml::quatf::operator+= | ( | const quatf & | quat | ) | throw () |
Add a quaternion.
[in] | quat | the quaternion to add. |
openvrml::quatf & openvrml::quatf::operator-= | ( | const quatf & | quat | ) | throw () |
Subtract a quaternion.
[in] | quat | the quaternion to subtract. |
|
inline |
Array element dereference operator (const version).
[in] | index | an index from 0–3. |
index
is not larger than 3.
|
inline |
Array element dereference operator (non-const version).
[in] | index | an index from 0–3. |
index
is not larger than 3.
|
inline |
Get the x component.
|
inline |
Get the y component.
|
inline |
Get the z component.
|
inline |
Get the w component.
|
inline |
Set the x component.
[in] | value | x component value. |
|
inline |
Set the y component.
[in] | value | y component value. |
|
inline |
Set the z component.
[in] | value | z component value. |
|
inline |
Set the w component.
[in] | value | w component value. |
const openvrml::quatf openvrml::quatf::conjugate | ( | ) | const throw () |
Get the conjugate.
const openvrml::quatf openvrml::quatf::inverse | ( | ) | const throw () |
Get the inverse.
float openvrml::quatf::norm | ( | ) | const throw () |
Get the norm.
const openvrml::quatf openvrml::quatf::normalize | ( | ) | const throw () |
Normalize the quaternion.
|
related |
Create a default quatf
.
quatf
with the value [0.0, 0.0, 0.0, 1.0].
|
related |
Create a quatf
from four values.
[in] | x | the x vector component. |
[in] | y | the y vector component. |
[in] | z | the z vector component. |
[in] | w | the scalar value w. |
quatf
with the value [x
, y
, z
, w
].
|
related |
Create a quatf
from an array of four values.
[in] | quat | the first three values in the array are used for the x, y, and z vector components, respectively. The fourth value in the array is used for the scalar part of the quaternion. |
quatf
with the values in quat
.
|
related |
Create a quatf
from a rotation matrix.
[in] | mat | a rotation matrix. |
quatf
corresponding to the rotation applied by mat
.
|
related |
Create a quatf
from a rotation
.
[in] | rot | a rotation. |
quatf
corresponding to the rotation applied by rot
.
|
related |
Multiply two quaternions.
[in] | lhs | left-hand operand. |
[in] | rhs | right-hand operand. |
lhs
and rhs
.
|
related |
Multiply a quaternion by a scalar.
[in] | quat | quaternion. |
[in] | scalar | scalar. |
quat
and scalar
.
|
related |
Multiply a scalar by a quaternion.
[in] | scalar | scalar. |
[in] | quat | quaternion. |
scalar
and quat
.
|
related |
Divide a quaternion by a scalar.
[in] | quat | quaternion. |
[in] | scalar | scalar. |
quat
by scalar
.
|
related |
Add two quaternions.
[in] | lhs | left-hand operand. |
[in] | rhs | right-hand operand. |
lhs
and rhs
.
|
related |
Take the difference between two quaternions.
[in] | lhs | left-hand operand. |
[in] | rhs | right-hand operand. |
lhs
and rhs
.
|
related |
Stream output.
[in,out] | out | an output stream. |
[in] | quat | a quaternion. |
out
. Compare for equality.
[in] | lhs | left-hand operand. |
[in] | rhs | right-hand operand. |
true
if lhs
and rhs
are equal; false
otherwise. Compare for inequality.
[in] | lhs | left-hand operand. |
[in] | rhs | right-hand operand. |
true
if lhs
and rhs
are not equal; false
otherwise. float openvrml::quatf::quat[4] |
An array comprising the quaternion components.