#include <Mat.h>

Public Types
using	value_type = T

using	ValueType = T

Public Member Functions
	Quat ()=default

	Quat (T x, T y, T z, T w)
	Constructor with four arguments, e.g. Quatf q(1,2,3,4);. More...

	Quat (T *a)
	Constructor with array argument, e.g. float a[4]; Quatf q(a);. More...

	Quat (const Vec3< T > &axis, T angle)

	Quat (math::Axis axis, T angle)
	Constructor given rotation as axis and angle. More...

template<typename T1 >
	Quat (const Mat3< T1 > &rot)
	Constructor given a rotation matrix. More...

T &	x ()
	Reference to the component, e.g. q.x() = 4.5f;. More...

T &	y ()

T &	z ()

T &	w ()

T	x () const
	Get the component, e.g. float f = q.w();. More...

T	y () const

T	z () const

T	w () const

T &	operator[] (int i)
	Array style reference to the components, e.g. q[3] = 1.34f;. More...

T	operator[] (int i) const
	Array style constant reference to the components, e.g. float f = q[1];. More...

	operator T * ()
	Cast to T*. More...

	operator const T * () const

T &	operator() (int i)
	Alternative indexed reference to the elements. More...

T	operator() (int i) const
	Alternative indexed constant reference to the elements,. More...

T	angle () const
	Return angle of rotation. More...

Vec3< T >	axis () const
	Return axis of rotation. More...

Quat &	init (T x, T y, T z, T w)
	"this" quaternion gets initialized to [x, y, z, w] More...

Quat &	init ()
	"this" quaternion gets initialized to identity, same as setIdentity() More...

Quat &	setAxisAngle (const Vec3< T > &axis, T angle)

Quat &	setZero ()
	Set "this" vector to zero. More...

Quat &	setIdentity ()
	Set "this" vector to identity. More...

Vec3< T >	eulerAngles (RotationOrder rotationOrder) const
	Returns vector of x,y,z rotational components. More...

bool	operator== (const Quat &q) const
	Equality operator, does exact floating point comparisons. More...

bool	eq (const Quat &q, T eps=1.0e-7) const
	Test if "this" is equivalent to q with tolerance of eps value. More...

Quat &	operator+= (const Quat &q)
	Add quaternion q to "this" quaternion, e.g. q += q1;. More...

Quat &	operator-= (const Quat &q)
	Subtract quaternion q from "this" quaternion, e.g. q -= q1;. More...

Quat &	operator*= (T scalar)
	Scale "this" quaternion by scalar, e.g. q *= scalar;. More...

Quat	operator+ (const Quat &q) const
	Return (this+q), e.g. q = q1 + q2;. More...

Quat	operator- (const Quat &q) const
	Return (this-q), e.g. q = q1 - q2;. More...

Quat	operator* (const Quat &q) const
	Return (thisq), e.g. q = q1 q2;. More...

Quat	operator*= (const Quat &q)
	Assigns this to (thisq), e.g. q = q1;. More...

Quat	operator* (T scalar) const
	Return (thisscalar), e.g. q = q1 scalar;. More...

Quat	operator/ (T scalar) const
	Return (this/scalar), e.g. q = q1 / scalar;. More...

Quat	operator- () const
	Negation operator, e.g. q = -q;. More...

Quat &	add (const Quat &q1, const Quat &q2)

Quat &	sub (const Quat &q1, const Quat &q2)

Quat &	mult (const Quat &q1, const Quat &q2)

Quat &	scale (T scale, const Quat &q)

T	dot (const Quat &q) const
	Dot product. More...

Quat	derivative (const Vec3< T > &omega) const

bool	normalize (T eps=T(1.0e-8))
	this = normalized this More...

Quat	unit () const
	this = normalized this More...

Quat	inverse (T tolerance=T(0)) const
	returns inverse of this More...

Quat	conjugate () const

Vec3< T >	rotateVector (const Vec3< T > &v) const
	Return rotated vector by "this" quaternion. More...

std::string	str () const

void	write (std::ostream &os) const

void	read (std::istream &is)

Static Public Member Functions
static unsigned	numElements ()

static Quat	zero ()
	Predefined constants, e.g. Quat q = Quat::identity();. More...

static Quat	identity ()

Static Public Attributes
static const int	size = 4

Protected Attributes
T	mm [4]

Friends
std::ostream &	operator<< (std::ostream &stream, const Quat &q)
	Output to the stream, e.g. std::cout << q << std::endl;. More...

Quat	slerp (const Quat &q1, const Quat &q2, T t, T tolerance)
	Linear interpolation between the two quaternions. More...

Detailed Description

template<typename T>
class openvdb::OPENVDB_VERSION_NAME::math::Quat< T >

Definition at line 164 of file Mat.h.

Member Typedef Documentation

template<typename T>

using openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::value_type = T

Definition at line 82 of file Quat.h.

template<typename T>

using openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::ValueType = T

Definition at line 83 of file Quat.h.

Constructor & Destructor Documentation

template<typename T>

openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::Quat ( )

default

Trivial constructor, the quaternion is NOT initialized

Note: destructor, copy constructor, assignment operator and move constructor are left to be defined by the compiler (default)

template<typename T>

openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::Quat	(	T	x,
		T	y,
		T	z,
		T	w
	)

inline

Constructor with four arguments, e.g. Quatf q(1,2,3,4);.

Definition at line 92 of file Quat.h.

template<typename T>

openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::Quat ( T * a )

inline

Constructor with array argument, e.g. float a[4]; Quatf q(a);.

Definition at line 102 of file Quat.h.

template<typename T>

openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::Quat	(	const Vec3< T > &	axis,
		T	angle
	)

inline

Constructor given rotation as axis and angle, the axis must be unit vector

Definition at line 113 of file Quat.h.

template<typename T>

openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::Quat	(	math::Axis	axis,
		T	angle
	)

inline

Constructor given rotation as axis and angle.

Definition at line 128 of file Quat.h.

template<typename T>

template<typename T1 >

openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::Quat ( const Mat3< T1 > & rot )

inline

Constructor given a rotation matrix.

Definition at line 141 of file Quat.h.

Member Function Documentation

template<typename T>

Quat& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::add	(	const Quat< T > &	q1,
		const Quat< T > &	q2
	)

inline

this = q1 + q2 "this", q1 and q2 need not be distinct objects, e.g. q.add(q1,q);

Definition at line 401 of file Quat.h.

template<typename T>

T openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::angle ( ) const

inline

Return angle of rotation.

Definition at line 225 of file Quat.h.

template<typename T>

Vec3<T> openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::axis ( ) const

inline

Return axis of rotation.

Definition at line 240 of file Quat.h.

template<typename T>

Quat openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::conjugate ( ) const

inline

Return the conjugate of "this", same as invert without unit quaternion test

Definition at line 501 of file Quat.h.

template<typename T>

Quat openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::derivative ( const Vec3< T > & omega ) const

inline

Return the quaternion rate corrsponding to the angular velocity omega and "this" current rotation

Definition at line 459 of file Quat.h.

template<typename T>

T openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::dot ( const Quat< T > & q ) const

inline

Dot product.

Definition at line 452 of file Quat.h.

template<typename T>

bool openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::eq	(	const Quat< T > &	q,
		T	eps = `1.0e-7`
	)		const

inline

Test if "this" is equivalent to q with tolerance of eps value.

Definition at line 311 of file Quat.h.

template<typename T>

Vec3<T> openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::eulerAngles ( RotationOrder rotationOrder ) const

inline

Returns vector of x,y,z rotational components.

Definition at line 298 of file Quat.h.

template<typename T>

static Quat openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::identity ( )

inlinestatic

Definition at line 515 of file Quat.h.

template<typename T>

Quat& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::init	(	T	x,
		T	y,
		T	z,
		T	w
	)

inline

"this" quaternion gets initialized to [x, y, z, w]

Definition at line 257 of file Quat.h.

template<typename T>

Quat& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::init ( )

inline

"this" quaternion gets initialized to identity, same as setIdentity()

Definition at line 264 of file Quat.h.

template<typename T>

Quat openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::inverse ( T tolerance = T(0) ) const

inline

returns inverse of this

Definition at line 487 of file Quat.h.

template<typename T>

Quat& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::mult	(	const Quat< T > &	q1,
		const Quat< T > &	q2
	)

inline

this = q1 * q2 q1 and q2 must be distinct objects than "this", e.g. q.mult(q1,q2);

Definition at line 425 of file Quat.h.

template<typename T>

bool openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::normalize ( T eps = T(1.0e-8) )

inline

this = normalized this

Definition at line 468 of file Quat.h.

template<typename T>

static unsigned openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::numElements ( )

inlinestatic

Definition at line 206 of file Quat.h.

template<typename T>

openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::operator const T * ( ) const

inline

Definition at line 216 of file Quat.h.

template<typename T>

openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::operator T * ( )

inline

Cast to T*.

Definition at line 215 of file Quat.h.

template<typename T>

T& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::operator() ( int i )

inline

Alternative indexed reference to the elements.

Definition at line 219 of file Quat.h.

template<typename T>

T openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::operator() ( int i ) const

inline

Alternative indexed constant reference to the elements,.

Definition at line 222 of file Quat.h.

template<typename T>

Quat openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::operator* ( const Quat< T > & q ) const

inline

Return (this*q), e.g. q = q1 * q2;.

Definition at line 363 of file Quat.h.

template<typename T>

Quat openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::operator* ( T scalar ) const

inline

Return (this*scalar), e.g. q = q1 * scalar;.

Definition at line 384 of file Quat.h.

template<typename T>

Quat& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::operator*= ( T scalar )

inline

Scale "this" quaternion by scalar, e.g. q *= scalar;.

Definition at line 340 of file Quat.h.

template<typename T>

Quat openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::operator*= ( const Quat< T > & q )

inline

Assigns this to (this*q), e.g. q *= q1;.

Definition at line 377 of file Quat.h.

template<typename T>

Quat openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::operator+ ( const Quat< T > & q ) const

inline

Return (this+q), e.g. q = q1 + q2;.

Definition at line 351 of file Quat.h.

template<typename T>

Quat& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::operator+= ( const Quat< T > & q )

inline

Add quaternion q to "this" quaternion, e.g. q += q1;.

Definition at line 318 of file Quat.h.

template<typename T>

Quat openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::operator- ( const Quat< T > & q ) const

inline

Return (this-q), e.g. q = q1 - q2;.

Definition at line 357 of file Quat.h.

template<typename T>

Quat openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::operator- ( ) const

inline

Negation operator, e.g. q = -q;.

Definition at line 396 of file Quat.h.

template<typename T>

Quat& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::operator-= ( const Quat< T > & q )

inline

Subtract quaternion q from "this" quaternion, e.g. q -= q1;.

Definition at line 329 of file Quat.h.

template<typename T>

Quat openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::operator/ ( T scalar ) const

inline

Return (this/scalar), e.g. q = q1 / scalar;.

Definition at line 390 of file Quat.h.

template<typename T>

bool openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::operator== ( const Quat< T > & q ) const

inline

Equality operator, does exact floating point comparisons.

Definition at line 302 of file Quat.h.

template<typename T>

T& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::operator[] ( int i )

inline

Array style reference to the components, e.g. q[3] = 1.34f;.

Definition at line 209 of file Quat.h.

template<typename T>

T openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::operator[] ( int i ) const

inline

Array style constant reference to the components, e.g. float f = q[1];.

Definition at line 212 of file Quat.h.

template<typename T>

void openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::read ( std::istream & is )

inline

Definition at line 545 of file Quat.h.

template<typename T>

Vec3<T> openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::rotateVector ( const Vec3< T > & v ) const

inline

Return rotated vector by "this" quaternion.

Definition at line 507 of file Quat.h.

template<typename T>

Quat& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::scale	(	T	scale,
		const Quat< T > &	q
	)

inline

this = scalar*q, q need not be distinct object than "this", e.g. q.scale(1.5,q1);

Definition at line 441 of file Quat.h.

template<typename T>

Quat& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::setAxisAngle	(	const Vec3< T > &	axis,
		T	angle
	)

inline

Set "this" quaternion to rotation specified by axis and angle, the axis must be unit vector

Definition at line 268 of file Quat.h.

template<typename T>

Quat& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::setIdentity ( )

inline

Set "this" vector to identity.

Definition at line 290 of file Quat.h.

template<typename T>

Quat& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::setZero ( )

inline

Set "this" vector to zero.

Definition at line 283 of file Quat.h.

template<typename T>

std::string openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::str ( ) const

inline

Returns: string representation of Classname

Definition at line 518 of file Quat.h.

template<typename T>

Quat& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::sub	(	const Quat< T > &	q1,
		const Quat< T > &	q2
	)

inline

this = q1 - q2 "this", q1 and q2 need not be distinct objects, e.g. q.sub(q1,q);

Definition at line 413 of file Quat.h.

template<typename T>

Quat openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::unit ( ) const

inline

this = normalized this

Definition at line 477 of file Quat.h.

template<typename T>

T& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::w ( )

inline

Definition at line 197 of file Quat.h.

template<typename T>

T openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::w ( ) const

inline

Definition at line 203 of file Quat.h.

template<typename T>

void openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::write ( std::ostream & os ) const

inline

Definition at line 544 of file Quat.h.

template<typename T>

T& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::x ( )

inline

Reference to the component, e.g. q.x() = 4.5f;.

Definition at line 194 of file Quat.h.

template<typename T>

T openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::x ( ) const

inline

Get the component, e.g. float f = q.w();.

Definition at line 200 of file Quat.h.

template<typename T>

T& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::y ( )

inline

Definition at line 195 of file Quat.h.

template<typename T>

T openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::y ( ) const

inline

Definition at line 201 of file Quat.h.

template<typename T>

T& openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::z ( )

inline

Definition at line 196 of file Quat.h.

template<typename T>

T openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::z ( ) const

inline

Definition at line 202 of file Quat.h.

template<typename T>

static Quat openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::zero ( )

inlinestatic

Predefined constants, e.g. Quat q = Quat::identity();.

Definition at line 514 of file Quat.h.

Friends And Related Function Documentation

template<typename T>

std::ostream& operator<<	(	std::ostream &	stream,
		const Quat< T > &	q
	)

friend

Output to the stream, e.g. std::cout << q << std::endl;.

Definition at line 536 of file Quat.h.

template<typename T>

Quat slerp	(	const Quat< T > &	q1,
		const Quat< T > &	q2,
		T	t,
		T	tolerance = `0.00001`
	)

friend

Linear interpolation between the two quaternions.

Definition at line 28 of file Quat.h.

Member Data Documentation

template<typename T>

T openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::mm[4]

protected

Definition at line 548 of file Quat.h.

template<typename T>

const int openvdb::OPENVDB_VERSION_NAME::math::Quat< T >::size = 4

static

Definition at line 84 of file Quat.h.

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

openvdb/math/Mat.h
openvdb/math/Quat.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Detailed Description

template<typename T> class openvdb::OPENVDB_VERSION_NAME::math::Quat< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<typename T>
class openvdb::OPENVDB_VERSION_NAME::math::Quat< T >