NRE::Math::Quaternion< T > Class Template Reference

A quaternion represented by a 3D rotation axis and an angle. More...

#include <NRE_Quaternion.hpp>

Inheritance diagram for NRE::Math::Quaternion< T >:

Public Member Functions
constexpr	Quaternion ()=default
template<class K , class L , class N , class M >
constexpr	Quaternion (K x, L y, N z, M w)
template<class K , class L , class N >
	Quaternion (K x, L y, N z, Angle w)
template<class K , class L >
constexpr	Quaternion (Vector3D< K > const &ax, L an)
template<class K >
	Quaternion (Vector3D< K > const &ax, Angle an)
constexpr	Quaternion (Quaternion const &q)=default
constexpr	Quaternion (Quaternion &&q)=default
template<class K >
constexpr	Quaternion (Quaternion< K > const &q)
	~Quaternion ()=default
constexpr T	getX () const
constexpr T	getY () const
constexpr T	getZ () const
constexpr T	getW () const
constexpr Vector3D< T >	getAxis () const
constexpr Vector4D< T > const &	getQuaternion () const
template<class K >
constexpr void	setX (K x)
template<class K >
constexpr void	setY (K y)
template<class K >
constexpr void	setZ (K z)
template<class K >
constexpr void	setW (K w)
template<class K >
void	setAngleAxis (Vector3D< K > const &axis, Angle w)
constexpr void	setIdentity ()
long double	norm () const
constexpr T	normSquared () const
Quaternion	normalize ()
constexpr const T *	value () const
constexpr Quaternion &	operator= (Quaternion const &q)=default
constexpr Quaternion &	operator= (Quaternion &&q)=default
template<class K >
constexpr Quaternion &	operator= (Quaternion< K > const &q)
template<class K >
constexpr Quaternion &	operator= (Quaternion< K > &&q)
template<class K >
constexpr Quaternion &	operator*= (Quaternion< K > const &q)
template<class K >
constexpr Quaternion< std::common_type_t< T, K > >	operator* (Quaternion< K > const &q) const
Utility::String	toString () const

Detailed Description

template<class T>
class NRE::Math::Quaternion< T >

A quaternion represented by a 3D rotation axis and an angle.

Constructor & Destructor Documentation

template<class T>

constexpr NRE::Math::Quaternion< T >::Quaternion ( )

default

The internal quaternion Construct the identity quaternion

template<class T>

template<class K , class L , class N , class M >

constexpr NRE::Math::Quaternion< T >::Quaternion	(	K	x,
		L	y,
		N	z,
		M	w
	)

Construct a quaternion with direct assignment

Parameters

x	the x coordinate
y	the y coordinate
z	the z coordinate
w	the w coordinate

template<class T>

template<class K , class L , class N >

NRE::Math::Quaternion< T >::Quaternion	(	K	x,
		L	y,
		N	z,
		Angle	w
	)

Construct a quaternion from angle-axis construction

Parameters

x	the x coordinate
y	the y coordinate
z	the z coordinate
w	the rotation's angle

template<class T>

template<class K , class L >

constexpr NRE::Math::Quaternion< T >::Quaternion	(	Vector3D< K > const &	ax,
		L	an
	)

Construct a quaternion with direct assignment

Parameters

ax	the rotation's axis
an	the rotation's angle

template<class T>

template<class K >

NRE::Math::Quaternion< T >::Quaternion	(	Vector3D< K > const &	ax,
		Angle	an
	)

Construct a quaternion from angle-axis construction

Parameters

ax	the rotation's axis
an	the rotation's angle

template<class T>

constexpr NRE::Math::Quaternion< T >::Quaternion ( Quaternion< T > const &  q )

default

Copy q into this

Parameters

q	the object to copy

template<class T>

constexpr NRE::Math::Quaternion< T >::Quaternion ( Quaternion< T > &&  q )

default

Move q into this

Parameters

q	the object to move

template<class T>

template<class K >

constexpr NRE::Math::Quaternion< T >::Quaternion

(

Quaternion< K > const &

q

)

Convert a K-type quaternion into a T-type quaternion

Parameters

q	the K-type quaternion to convert

template<class T>

NRE::Math::Quaternion< T >::~Quaternion ( )

default

Quaternion Deconstructor

Member Function Documentation

template<class T>

constexpr Vector3D<T> NRE::Math::Quaternion< T >::getAxis

(

)

const

Returns

the rotation's axis

template<class T>

constexpr Vector4D<T> const& NRE::Math::Quaternion< T >::getQuaternion

(

)

const

Returns

the internal quaternion

template<class T>

constexpr T NRE::Math::Quaternion< T >::getW

(

)

const

Returns

the w value

template<class T>

constexpr T NRE::Math::Quaternion< T >::getX

(

)

const

Returns

the x value

template<class T>

constexpr T NRE::Math::Quaternion< T >::getY

(

)

const

Returns

the y value

template<class T>

constexpr T NRE::Math::Quaternion< T >::getZ

(

)

const

Returns

the z value

template<class T>

long double NRE::Math::Quaternion< T >::norm

(

)

const

Returns

the quaternion's norm

template<class T>

Quaternion NRE::Math::Quaternion< T >::normalize

(

)

Normalize the quaternion

template<class T>

constexpr T NRE::Math::Quaternion< T >::normSquared

(

)

const

Returns

the squared quaternion's norm

template<class T>

template<class K >

constexpr Quaternion<std::common_type_t<T, K> > NRE::Math::Quaternion< T >::operator*

(

Quaternion< K > const &

q

)

const

Compute the quaternion resulting in the multiplication of this and q

Parameters

q	the second quaternion

Returns

the computed quaternion

template<class T>

template<class K >

constexpr Quaternion& NRE::Math::Quaternion< T >::operator*=

(

Quaternion< K > const &

q

)

Multiply 2 quaternions together

Parameters

q	the second quaternion

Returns

the reference of himself

template<class T>

constexpr Quaternion& NRE::Math::Quaternion< T >::operator= ( Quaternion< T > const &  q )

default

Copy q into this

Parameters

q	the object to copy into this

Returns

the reference of himself

template<class T>

constexpr Quaternion& NRE::Math::Quaternion< T >::operator= ( Quaternion< T > &&  q )

default

Move q into this

Parameters

q	the object to move into this

Returns

the reference of himself

template<class T>

template<class K >

constexpr Quaternion& NRE::Math::Quaternion< T >::operator=

(

Quaternion< K > const &

q

)

Copy q into this

Parameters

q	the object to copy into this

Returns

the reference of himself

template<class T>

template<class K >

constexpr Quaternion& NRE::Math::Quaternion< T >::operator=

(

Quaternion< K > &&

q

)

Move q into this

Parameters

q	the object to move into this

Returns

the reference of himself

template<class T>

template<class K >

void NRE::Math::Quaternion< T >::setAngleAxis ( Vector3D< K > const &  axis, Angle  w  )

inline

Angle axis setter

Parameters

axis	the new rotation's axis
w	the new rotation's angle

template<class T>

constexpr void NRE::Math::Quaternion< T >::setIdentity

(

)

Set the quaternion to the identity quaternion

template<class T>

template<class K >

constexpr void NRE::Math::Quaternion< T >::setW

(

K

w

)

W setter

Parameters

w	the new value for w

template<class T>

template<class K >

constexpr void NRE::Math::Quaternion< T >::setX

(

K

x

)

X setter

Parameters

x	the new value for x

template<class T>

template<class K >

constexpr void NRE::Math::Quaternion< T >::setY

(

K

y

)

Y setter

Parameters

y	the new value for y

template<class T>

template<class K >

constexpr void NRE::Math::Quaternion< T >::setZ

(

K

z

)

Z setter

Parameters

z	the new value for z

template<class T>

Utility::String NRE::Math::Quaternion< T >::toString

(

)

const

Convert the quaternion into a string

Returns

the converted quaternion

template<class T>

constexpr const T* NRE::Math::Quaternion< T >::value

(

)

const

Returns

a pointer to the quaternion's data

---

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

• /mnt/c/Users/abell/Documents/GitHub/NRE-Math/src/Math/Matrix/4D/NRE_Matrix4x4.hpp
• /mnt/c/Users/abell/Documents/GitHub/NRE-Math/src/Math/Quaternion/NRE_Quaternion.hpp