xiiSimdQuat Class Reference

Public Member Functions
	XII_DECLARE_POD_TYPE ()
	xiiSimdQuat (const xiiSimdVec4f &v)
void	Normalize ()
	Normalizes the quaternion to unit length. ALL rotation-quaternions should be normalized at all times (automatically).
xiiResult	GetRotationAxisAndAngle (xiiSimdVec4f &ref_vAxis, xiiSimdFloat &ref_fAngle, const xiiSimdFloat &fEpsilon=xiiMath::DefaultEpsilon< float >()) const
	Returns the rotation-axis and angle (in Radians), that this quaternion rotates around.
xiiSimdMat4f	GetAsMat4 () const
	Returns the Quaternion as a matrix.
bool	IsValid (const xiiSimdFloat &fEpsilon=xiiMath::DefaultEpsilon< float >()) const
	Checks whether all components are neither NaN nor infinite and that the quaternion is normalized.
bool	IsNaN () const
	Checks whether any component is NaN.
bool	IsEqualRotation (const xiiSimdQuat &qOther, const xiiSimdFloat &fEpsilon) const
	Determines whether this and qOther represent the same rotation. This is a rather slow operation.
xiiSimdQuat	operator- () const
	Returns a Quaternion that represents the negative / inverted rotation.
xiiSimdVec4f	operator* (const xiiSimdVec4f &v) const
	Rotates v by q.
xiiSimdQuat	operator* (const xiiSimdQuat &q2) const
	Concatenates the rotations of q1 and q2.
bool	operator== (const xiiSimdQuat &q2) const
bool	operator!= (const xiiSimdQuat &q2) const

Static Public Member Functions
static const xiiSimdQuat	MakeIdentity ()
	Static function that returns a quaternion that represents the identity rotation (none).
static xiiSimdQuat	MakeFromElements (xiiSimdFloat x, xiiSimdFloat y, xiiSimdFloat z, xiiSimdFloat w)
	Sets the individual elements of the quaternion directly. Note that x,y,z do NOT represent a rotation axis, and w does NOT represent an angle.
static xiiSimdQuat	MakeFromAxisAndAngle (const xiiSimdVec4f &vRotationAxis, const xiiSimdFloat &fAngle)
	Creates a quaternion from a rotation-axis and an angle (angle is given in Radians or as a xiiAngle)
static xiiSimdQuat	MakeShortestRotation (const xiiSimdVec4f &vDirFrom, const xiiSimdVec4f &vDirTo)
	Creates a quaternion, that rotates through the shortest arc from "vDirFrom" to "vDirTo".
static xiiSimdQuat	MakeSlerp (const xiiSimdQuat &qFrom, const xiiSimdQuat &qTo, const xiiSimdFloat &t)
	Returns a quaternion that is the spherical linear interpolation of the other two.

Public Attributes
xiiSimdVec4f	m_v

Member Function Documentation

GetRotationAxisAndAngle()

xiiResult xiiSimdQuat::GetRotationAxisAndAngle ( xiiSimdVec4f & ref_vAxis, xiiSimdFloat & ref_fAngle, const xiiSimdFloat & fEpsilon = xiiMath::DefaultEpsilon<float>() ) const

inline

Returns the rotation-axis and angle (in Radians), that this quaternion rotates around.

Todo

optimize

IsEqualRotation()

bool xiiSimdQuat::IsEqualRotation	(	const xiiSimdQuat &	qOther,
		const xiiSimdFloat &	fEpsilon ) const

Determines whether this and qOther represent the same rotation. This is a rather slow operation.

Currently it fails when one of the given quaternions is identity (so no rotation, at all), as it tries to compare rotation axis' and angles, which is undefined for the identity quaternion (also there are infinite representations for 'identity', so it's difficult to check for it).

MakeFromAxisAndAngle()

xiiSimdQuat xiiSimdQuat::MakeFromAxisAndAngle ( const xiiSimdVec4f & vRotationAxis, const xiiSimdFloat & fAngle )

inlinestaticnodiscard

Creates a quaternion from a rotation-axis and an angle (angle is given in Radians or as a xiiAngle)

Todo

optimize

MakeFromElements()

XII_ALWAYS_INLINE xiiSimdQuat xiiSimdQuat::MakeFromElements ( xiiSimdFloat x, xiiSimdFloat y, xiiSimdFloat z, xiiSimdFloat w )

staticnodiscard

Sets the individual elements of the quaternion directly. Note that x,y,z do NOT represent a rotation axis, and w does NOT represent an angle.

Use this function only if you have good understanding of quaternion math and know exactly what you are doing.

---

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

• /home/runner/work/XII/XII/Source/Engine/Foundation/SimdMath/SimdQuat.h
• /home/runner/work/XII/XII/Source/Engine/Foundation/SimdMath/Implementation/SimdQuat.cpp
• /home/runner/work/XII/XII/Source/Engine/Foundation/SimdMath/Implementation/SimdQuat_inl.h