karto::Quaternion Class Reference

#include <Karto.h>

List of all members.

Public Member Functions
void	FromEulerAngles (kt_double yaw, kt_double pitch, kt_double roll)
kt_double	GetW () const
kt_double	GetX () const
kt_double	GetY () const
kt_double	GetZ () const
kt_bool	operator!= (const Quaternion &rOther) const
Quaternion &	operator= (const Quaternion &rQuaternion)
kt_bool	operator== (const Quaternion &rOther) const
	Quaternion (const Quaternion &rQuaternion)
	Quaternion (kt_double x, kt_double y, kt_double z, kt_double w)
	Quaternion ()
void	SetW (kt_double w)
void	SetX (kt_double x)
void	SetY (kt_double y)
void	SetZ (kt_double z)
void	ToEulerAngles (kt_double &rYaw, kt_double &rPitch, kt_double &rRoll) const
Private Attributes
kt_double	m_Values [4]
Friends
std::ostream &	operator<< (std::ostream &rStream, const Quaternion &rQuaternion)

---

Detailed Description

Definition at line 1401 of file Karto.h.

---

Constructor & Destructor Documentation

karto::Quaternion::Quaternion

(

)

[inline]

Create a quaternion with default (x=0, y=0, z=0, w=1) values

Definition at line 1407 of file Karto.h.

karto::Quaternion::Quaternion	(	kt_double	x,
		kt_double	y,
		kt_double	z,
		kt_double	w
	)			[inline]

Create a quaternion using x, y, z, w values.

Parameters:

	x
	y
	z
	w

Definition at line 1422 of file Karto.h.

karto::Quaternion::Quaternion

(

const Quaternion &

rQuaternion

)

[inline]

Copy constructor

Definition at line 1433 of file Karto.h.

---

Member Function Documentation

void karto::Quaternion::FromEulerAngles	(	kt_double	yaw,
		kt_double	pitch,
		kt_double	roll
	)			[inline]

Set x,y,z,w values of the quaternion based on Euler angles. Source: http://www.euclideanspace.com/maths/geometry/rotations/conversions/eulerToQuaternion/index.htm

Parameters:

	yaw
	pitch
	roll

Definition at line 1558 of file Karto.h.

kt_double karto::Quaternion::GetW

(

)

const [inline]

Returns the W-value

Returns:

Return the W-value of the quaternion

Definition at line 1500 of file Karto.h.

kt_double karto::Quaternion::GetX

(

)

const [inline]

Returns the X-value

Returns:

Return the X-value of the quaternion

Definition at line 1446 of file Karto.h.

kt_double karto::Quaternion::GetY

(

)

const [inline]

Returns the Y-value

Returns:

Return the Y-value of the quaternion

Definition at line 1464 of file Karto.h.

kt_double karto::Quaternion::GetZ

(

)

const [inline]

Returns the Z-value

Returns:

Return the Z-value of the quaternion

Definition at line 1482 of file Karto.h.

kt_bool karto::Quaternion::operator!=

(

const Quaternion &

rOther

)

const [inline]

Inequality operator returns true if any of the corresponding x, y, z, w values of each quaternion not the same.

Parameters:

rOther

Definition at line 1607 of file Karto.h.

Quaternion& karto::Quaternion::operator=

(

const Quaternion &

rQuaternion

)

[inline]

Assignment operator

Parameters:

rQuaternion

Definition at line 1584 of file Karto.h.

kt_bool karto::Quaternion::operator==

(

const Quaternion &

rOther

)

const [inline]

Equality operator returns true if the corresponding x, y, z, w values of each quaternion are the same values.

Parameters:

rOther

Definition at line 1598 of file Karto.h.

void karto::Quaternion::SetW

(

kt_double

w

)

[inline]

Sets the W-value

Parameters:

W-value

of the quaternion

Definition at line 1509 of file Karto.h.

void karto::Quaternion::SetX

(

kt_double

x

)

[inline]

Sets the X-value

Parameters:

X-value

of the quaternion

Definition at line 1455 of file Karto.h.

void karto::Quaternion::SetY

(

kt_double

y

)

[inline]

Sets the Y-value

Parameters:

Y-value

of the quaternion

Definition at line 1473 of file Karto.h.

void karto::Quaternion::SetZ

(

kt_double

z

)

[inline]

Sets the Z-value

Parameters:

Z-value

of the quaternion

Definition at line 1491 of file Karto.h.

void karto::Quaternion::ToEulerAngles	(	kt_double &	rYaw,
		kt_double &	rPitch,
		kt_double &	rRoll
	)			const [inline]

Converts this quaternion into Euler angles Source: http://www.euclideanspace.com/maths/geometry/rotations/conversions/quaternionToEuler/index.htm

Parameters:

	rYaw
	rPitch
	rRoll

Definition at line 1521 of file Karto.h.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	rStream,
		const Quaternion &	rQuaternion
	)			[friend]

Write this quaternion onto output stream

Parameters:

	rStream	output stream
	rQuaternion

Definition at line 1617 of file Karto.h.

---

Member Data Documentation

kt_double karto::Quaternion::m_Values[4] [private]

Definition at line 1624 of file Karto.h.

---

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

• Karto.h