Loading...
Searching...
No Matches
Quat.h
Go to the documentation of this file.
// Copyright Contributors to the OpenVDB Project
// SPDX-License-Identifier: MPL-2.0
#ifndef OPENVDB_MATH_QUAT_H_HAS_BEEN_INCLUDED
#define OPENVDB_MATH_QUAT_H_HAS_BEEN_INCLUDED
#include "Mat.h"
#include "Mat3.h"
#include "Math.h"
#include "Vec3.h"
#include <openvdb/Exceptions.h>
#include <cmath>
#include <iostream>
#include <sstream>
#include <string>
namespace openvdb {
OPENVDB_USE_VERSION_NAMESPACE
namespace OPENVDB_VERSION_NAME {
namespace math {
template<typename T> class Quat;
/// Linear interpolation between the two quaternions
template <typename T>
Quat<T> slerp(const Quat<T> &q1, const Quat<T> &q2, T t, T tolerance=0.00001)
{
T qdot, angle, sineAngle;
qdot = q1.dot(q2);
if (fabs(qdot) >= 1.0) {
angle = 0; // not necessary but suppresses compiler warning
sineAngle = 0;
} else {
angle = acos(qdot);
sineAngle = sin(angle);
}
//
// Denominator close to 0 corresponds to the case where the
// two quaternions are close to the same rotation. In this
// case linear interpolation is used but we normalize to
// guarantee unit length
//
if (sineAngle <= tolerance) {
T s = 1.0 - t;
Quat<T> qtemp(s * q1[0] + t * q2[0], s * q1[1] + t * q2[1],
s * q1[2] + t * q2[2], s * q1[3] + t * q2[3]);
//
// Check the case where two close to antipodal quaternions were
// blended resulting in a nearly zero result which can happen,
// for example, if t is close to 0.5. In this case it is not safe
// to project back onto the sphere.
//
double lengthSquared = qtemp.dot(qtemp);
if (lengthSquared <= tolerance * tolerance) {
qtemp = (t < 0.5) ? q1 : q2;
} else {
qtemp *= 1.0 / sqrt(lengthSquared);
}
return qtemp;
} else {
T sine = 1.0 / sineAngle;
T a = sin((1.0 - t) * angle) * sine;
T b = sin(t * angle) * sine;
return Quat<T>(a * q1[0] + b * q2[0], a * q1[1] + b * q2[1],
a * q1[2] + b * q2[2], a * q1[3] + b * q2[3]);
}
}
template<typename T>
class Quat
{
public:
using value_type = T;
using ValueType = T;
static const int size = 4;
/// 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)
Quat() = default;
/// Constructor with four arguments, e.g. Quatf q(1,2,3,4);
Quat(T x, T y, T z, T w)
{
mm[0] = x;
mm[1] = y;
mm[2] = z;
mm[3] = w;
}
/// Constructor with array argument, e.g. float a[4]; Quatf q(a);
Quat(T *a)
{
mm[0] = a[0];
mm[1] = a[1];
mm[2] = a[2];
mm[3] = a[3];
}
/// Constructor given rotation as axis and angle, the axis must be
/// unit vector
Quat(const Vec3<T> &axis, T angle)
{
// assert( REL_EQ(axis.length(), 1.) );
T s = T(sin(angle*T(0.5)));
mm[0] = axis.x() * s;
mm[1] = axis.y() * s;
mm[2] = axis.z() * s;
mm[3] = T(cos(angle*T(0.5)));
}
/// Constructor given rotation as axis and angle
Quat(math::Axis axis, T angle)
{
T s = T(sin(angle*T(0.5)));
mm[0] = (axis==math::X_AXIS) * s;
mm[1] = (axis==math::Y_AXIS) * s;
mm[2] = (axis==math::Z_AXIS) * s;
mm[3] = T(cos(angle*T(0.5)));
}
/// Constructor given a rotation matrix
template<typename T1>
Quat(const Mat3<T1> &rot) {
// verify that the matrix is really a rotation
if(!isUnitary(rot)) { // unitary is reflection or rotation
OPENVDB_THROW(ArithmeticError,
"A non-rotation matrix can not be used to construct a quaternion");
}
if (!isApproxEqual(rot.det(), T1(1))) { // rule out reflection
OPENVDB_THROW(ArithmeticError,
"A reflection matrix can not be used to construct a quaternion");
}
T trace(rot.trace());
if (trace > 0) {
T q_w = 0.5 * std::sqrt(trace+1);
T factor = 0.25 / q_w;
mm[0] = factor * (rot(1,2) - rot(2,1));
mm[1] = factor * (rot(2,0) - rot(0,2));
mm[2] = factor * (rot(0,1) - rot(1,0));
mm[3] = q_w;
} else if (rot(0,0) > rot(1,1) && rot(0,0) > rot(2,2)) {
T q_x = 0.5 * sqrt(rot(0,0)- rot(1,1)-rot(2,2)+1);
T factor = 0.25 / q_x;
mm[0] = q_x;
mm[1] = factor * (rot(0,1) + rot(1,0));
mm[2] = factor * (rot(2,0) + rot(0,2));
mm[3] = factor * (rot(1,2) - rot(2,1));
} else if (rot(1,1) > rot(2,2)) {
T q_y = 0.5 * sqrt(rot(1,1)-rot(0,0)-rot(2,2)+1);
T factor = 0.25 / q_y;
mm[0] = factor * (rot(0,1) + rot(1,0));
mm[1] = q_y;
mm[2] = factor * (rot(1,2) + rot(2,1));
mm[3] = factor * (rot(2,0) - rot(0,2));
} else {
T q_z = 0.5 * sqrt(rot(2,2)-rot(0,0)-rot(1,1)+1);
T factor = 0.25 / q_z;
mm[0] = factor * (rot(2,0) + rot(0,2));
mm[1] = factor * (rot(1,2) + rot(2,1));
mm[2] = q_z;
mm[3] = factor * (rot(0,1) - rot(1,0));
}
}
/// Reference to the component, e.g. q.x() = 4.5f;
T& x() { return mm[0]; }
T& y() { return mm[1]; }
T& z() { return mm[2]; }
T& w() { return mm[3]; }
/// Get the component, e.g. float f = q.w();
T x() const { return mm[0]; }
T y() const { return mm[1]; }
T z() const { return mm[2]; }
T w() const { return mm[3]; }
// Number of elements
static unsigned numElements() { return 4; }
/// Array style reference to the components, e.g. q[3] = 1.34f;
T& operator[](int i) { return mm[i]; }
/// Array style constant reference to the components, e.g. float f = q[1];
T operator[](int i) const { return mm[i]; }
/// Cast to T*
operator T*() { return mm; }
operator const T*() const { return mm; }
/// Alternative indexed reference to the elements
T& operator()(int i) { return mm[i]; }
/// Alternative indexed constant reference to the elements,
T operator()(int i) const { return mm[i]; }
/// Return angle of rotation
T angle() const
{
T sqrLength = mm[0]*mm[0] + mm[1]*mm[1] + mm[2]*mm[2];
if ( sqrLength > 1.0e-8 ) {
return T(T(2.0) * acos(mm[3]));
} else {
return T(0.0);
}
}
/// Return axis of rotation
Vec3<T> axis() const
{
T sqrLength = mm[0]*mm[0] + mm[1]*mm[1] + mm[2]*mm[2];
if ( sqrLength > 1.0e-8 ) {
T invLength = T(T(1)/sqrt(sqrLength));
return Vec3<T>( mm[0]*invLength, mm[1]*invLength, mm[2]*invLength );
} else {
return Vec3<T>(1,0,0);
}
}
/// "this" quaternion gets initialized to [x, y, z, w]
Quat& init(T x, T y, T z, T w)
{
mm[0] = x; mm[1] = y; mm[2] = z; mm[3] = w;
return *this;
}
/// "this" quaternion gets initialized to identity, same as setIdentity()
Quat& init() { return setIdentity(); }
/// Set "this" quaternion to rotation specified by axis and angle,
/// the axis must be unit vector
Quat& setAxisAngle(const Vec3<T>& axis, T angle)
{
T s = T(sin(angle*T(0.5)));
mm[0] = axis.x() * s;
mm[1] = axis.y() * s;
mm[2] = axis.z() * s;
mm[3] = T(cos(angle*T(0.5)));
return *this;
} // axisAngleTest
/// Set "this" vector to zero
Quat& setZero()
{
mm[0] = mm[1] = mm[2] = mm[3] = 0;
return *this;
}
/// Set "this" vector to identity
Quat& setIdentity()
{
mm[0] = mm[1] = mm[2] = 0;
mm[3] = 1;
return *this;
}
/// Returns vector of x,y,z rotational components
Vec3<T> eulerAngles(RotationOrder rotationOrder) const
{ return math::eulerAngles(Mat3<T>(*this), rotationOrder); }
/// Equality operator, does exact floating point comparisons
bool operator==(const Quat &q) const
{
return (isExactlyEqual(mm[0],q.mm[0]) &&
isExactlyEqual(mm[1],q.mm[1]) &&
isExactlyEqual(mm[2],q.mm[2]) &&
isExactlyEqual(mm[3],q.mm[3]) );
}
/// Test if "this" is equivalent to q with tolerance of eps value
bool eq(const Quat &q, T eps=1.0e-7) const
{
return isApproxEqual(mm[0],q.mm[0],eps) && isApproxEqual(mm[1],q.mm[1],eps) &&
isApproxEqual(mm[2],q.mm[2],eps) && isApproxEqual(mm[3],q.mm[3],eps) ;
} // trivial
/// Add quaternion q to "this" quaternion, e.g. q += q1;
Quat& operator+=(const Quat &q)
{
mm[0] += q.mm[0];
mm[1] += q.mm[1];
mm[2] += q.mm[2];
mm[3] += q.mm[3];
return *this;
}
/// Subtract quaternion q from "this" quaternion, e.g. q -= q1;
Quat& operator-=(const Quat &q)
{
mm[0] -= q.mm[0];
mm[1] -= q.mm[1];
mm[2] -= q.mm[2];
mm[3] -= q.mm[3];
return *this;
}
/// Scale "this" quaternion by scalar, e.g. q *= scalar;
Quat& operator*=(T scalar)
{
mm[0] *= scalar;
mm[1] *= scalar;
mm[2] *= scalar;
mm[3] *= scalar;
return *this;
}
/// Return (this+q), e.g. q = q1 + q2;
Quat operator+(const Quat &q) const
{
return Quat<T>(mm[0]+q.mm[0], mm[1]+q.mm[1], mm[2]+q.mm[2], mm[3]+q.mm[3]);
}
/// Return (this-q), e.g. q = q1 - q2;
Quat operator-(const Quat &q) const
{
return Quat<T>(mm[0]-q.mm[0], mm[1]-q.mm[1], mm[2]-q.mm[2], mm[3]-q.mm[3]);
}
/// Return (this*q), e.g. q = q1 * q2;
Quat operator*(const Quat &q) const
{
Quat<T> prod;
prod.mm[0] = mm[3]*q.mm[0] + mm[0]*q.mm[3] + mm[1]*q.mm[2] - mm[2]*q.mm[1];
prod.mm[1] = mm[3]*q.mm[1] + mm[1]*q.mm[3] + mm[2]*q.mm[0] - mm[0]*q.mm[2];
prod.mm[2] = mm[3]*q.mm[2] + mm[2]*q.mm[3] + mm[0]*q.mm[1] - mm[1]*q.mm[0];
prod.mm[3] = mm[3]*q.mm[3] - mm[0]*q.mm[0] - mm[1]*q.mm[1] - mm[2]*q.mm[2];
return prod;
}
/// Assigns this to (this*q), e.g. q *= q1;
Quat operator*=(const Quat &q)
{
*this = *this * q;
return *this;
}
/// Return (this*scalar), e.g. q = q1 * scalar;
Quat operator*(T scalar) const
{
return Quat<T>(mm[0]*scalar, mm[1]*scalar, mm[2]*scalar, mm[3]*scalar);
}
/// Return (this/scalar), e.g. q = q1 / scalar;
Quat operator/(T scalar) const
{
return Quat<T>(mm[0]/scalar, mm[1]/scalar, mm[2]/scalar, mm[3]/scalar);
}
/// Negation operator, e.g. q = -q;
Quat operator-() const
{ return Quat<T>(-mm[0], -mm[1], -mm[2], -mm[3]); }
/// this = q1 + q2
/// "this", q1 and q2 need not be distinct objects, e.g. q.add(q1,q);
Quat& add(const Quat &q1, const Quat &q2)
{
mm[0] = q1.mm[0] + q2.mm[0];
mm[1] = q1.mm[1] + q2.mm[1];
mm[2] = q1.mm[2] + q2.mm[2];
mm[3] = q1.mm[3] + q2.mm[3];
return *this;
}
/// this = q1 - q2
/// "this", q1 and q2 need not be distinct objects, e.g. q.sub(q1,q);
Quat& sub(const Quat &q1, const Quat &q2)
{
mm[0] = q1.mm[0] - q2.mm[0];
mm[1] = q1.mm[1] - q2.mm[1];
mm[2] = q1.mm[2] - q2.mm[2];
mm[3] = q1.mm[3] - q2.mm[3];
return *this;
}
/// this = q1 * q2
/// q1 and q2 must be distinct objects than "this", e.g. q.mult(q1,q2);
Quat& mult(const Quat &q1, const Quat &q2)
{
mm[0] = q1.mm[3]*q2.mm[0] + q1.mm[0]*q2.mm[3] +
q1.mm[1]*q2.mm[2] - q1.mm[2]*q2.mm[1];
mm[1] = q1.mm[3]*q2.mm[1] + q1.mm[1]*q2.mm[3] +
q1.mm[2]*q2.mm[0] - q1.mm[0]*q2.mm[2];
mm[2] = q1.mm[3]*q2.mm[2] + q1.mm[2]*q2.mm[3] +
q1.mm[0]*q2.mm[1] - q1.mm[1]*q2.mm[0];
mm[3] = q1.mm[3]*q2.mm[3] - q1.mm[0]*q2.mm[0] -
q1.mm[1]*q2.mm[1] - q1.mm[2]*q2.mm[2];
return *this;
}
/// this = scalar*q, q need not be distinct object than "this",
/// e.g. q.scale(1.5,q1);
Quat& scale(T scale, const Quat &q)
{
mm[0] = scale * q.mm[0];
mm[1] = scale * q.mm[1];
mm[2] = scale * q.mm[2];
mm[3] = scale * q.mm[3];
return *this;
}
/// Dot product
T dot(const Quat &q) const
{
return (mm[0]*q.mm[0] + mm[1]*q.mm[1] + mm[2]*q.mm[2] + mm[3]*q.mm[3]);
}
/// Return the quaternion rate corrsponding to the angular velocity omega
/// and "this" current rotation
Quat derivative(const Vec3<T>& omega) const
{
return Quat<T>( +w()*omega.x() -z()*omega.y() +y()*omega.z() ,
+z()*omega.x() +w()*omega.y() -x()*omega.z() ,
-y()*omega.x() +x()*omega.y() +w()*omega.z() ,
-x()*omega.x() -y()*omega.y() -z()*omega.z() );
}
/// this = normalized this
bool normalize(T eps = T(1.0e-8))
{
T d = T(sqrt(mm[0]*mm[0] + mm[1]*mm[1] + mm[2]*mm[2] + mm[3]*mm[3]));
if( isApproxEqual(d, T(0.0), eps) ) return false;
*this *= ( T(1)/d );
return true;
}
/// this = normalized this
Quat unit() const
{
T d = sqrt(mm[0]*mm[0] + mm[1]*mm[1] + mm[2]*mm[2] + mm[3]*mm[3]);
if( isExactlyEqual(d , T(0.0) ) )
OPENVDB_THROW(ArithmeticError,
"Normalizing degenerate quaternion");
return *this / d;
}
/// returns inverse of this
Quat inverse(T tolerance = T(0)) const
{
T d = mm[0]*mm[0] + mm[1]*mm[1] + mm[2]*mm[2] + mm[3]*mm[3];
if( isApproxEqual(d, T(0.0), tolerance) )
OPENVDB_THROW(ArithmeticError,
"Cannot invert degenerate quaternion");
Quat result = *this/-d;
result.mm[3] = -result.mm[3];
return result;
}
/// Return the conjugate of "this", same as invert without
/// unit quaternion test
Quat conjugate() const
{
return Quat<T>(-mm[0], -mm[1], -mm[2], mm[3]);
}
/// Return rotated vector by "this" quaternion
Vec3<T> rotateVector(const Vec3<T> &v) const
{
Mat3<T> m(*this);
return m.transform(v);
}
/// Predefined constants, e.g. Quat q = Quat::identity();
static Quat zero() { return Quat<T>(0,0,0,0); }
static Quat identity() { return Quat<T>(0,0,0,1); }
/// @return string representation of Classname
std::string str() const
{
std::ostringstream buffer;
buffer << "[";
// For each column
for (unsigned j(0); j < 4; j++) {
if (j) buffer << ", ";
buffer << mm[j];
}
buffer << "]";
return buffer.str();
}
/// Output to the stream, e.g. std::cout << q << std::endl;
friend std::ostream& operator<<(std::ostream &stream, const Quat &q)
{
stream << q.str();
return stream;
}
friend Quat slerp<>(const Quat &q1, const Quat &q2, T t, T tolerance);
void write(std::ostream& os) const { os.write(static_cast<char*>(&mm), sizeof(T) * 4); }
void read(std::istream& is) { is.read(static_cast<char*>(&mm), sizeof(T) * 4); }
protected:
T mm[4];
};
/// Multiply each element of the given quaternion by @a scalar and return the result.
template <typename S, typename T>
Quat<T> operator*(S scalar, const Quat<T> &q) { return q*scalar; }
/// @brief Interpolate between m1 and m2.
/// Converts to quaternion form and uses slerp
/// m1 and m2 must be rotation matrices!
template <typename T, typename T0>
Mat3<T> slerp(const Mat3<T0> &m1, const Mat3<T0> &m2, T t)
{
using MatType = Mat3<T>;
Quat<T> q1(m1);
Quat<T> q2(m2);
if (q1.dot(q2) < 0) q2 *= -1;
Quat<T> qslerp = slerp<T>(q1, q2, static_cast<T>(t));
MatType m = rotation<MatType>(qslerp);
return m;
}
/// Interpolate between m1 and m4 by converting m1 ... m4 into
/// quaternions and treating them as control points of a Bezier
/// curve using slerp in place of lerp in the De Castlejeau evaluation
/// algorithm. Just like a cubic Bezier curve, this will interpolate
/// m1 at t = 0 and m4 at t = 1 but in general will not pass through
/// m2 and m3. Unlike a standard Bezier curve this curve will not have
/// the convex hull property.
/// m1 ... m4 must be rotation matrices!
template <typename T, typename T0>
Mat3<T> bezLerp(const Mat3<T0> &m1, const Mat3<T0> &m2,
const Mat3<T0> &m3, const Mat3<T0> &m4,
T t)
{
Mat3<T> m00, m01, m02, m10, m11;
m00 = slerp(m1, m2, t);
m01 = slerp(m2, m3, t);
m02 = slerp(m3, m4, t);
m10 = slerp(m00, m01, t);
m11 = slerp(m01, m02, t);
return slerp(m10, m11, t);
}
using Quats = Quat<float>;
using Quatd = Quat<double>;
OPENVDB_IS_POD(Quats)
OPENVDB_IS_POD(Quatd)
} // namespace math
template<> inline math::Quats zeroVal<math::Quats >() { return math::Quats::zero(); }
template<> inline math::Quatd zeroVal<math::Quatd >() { return math::Quatd::zero(); }
} // namespace OPENVDB_VERSION_NAME
} // namespace openvdb
#endif //OPENVDB_MATH_QUAT_H_HAS_BEEN_INCLUDED
Mat3.h
Mat.h
Math.h
General-purpose arithmetic and comparison routines, most of which accept arbitrary value types (or at...
OPENVDB_IS_POD
#define OPENVDB_IS_POD(Type)
Definition Math.h:56
Vec3.h
openvdb::v10_0::ArithmeticError
Definition Exceptions.h:56
openvdb::v10_0::math::Mat3
3x3 matrix class.
Definition Mat3.h:29
openvdb::v10_0::math::Mat3::trace
T trace() const
Trace of matrix.
Definition Mat3.h:488
openvdb::v10_0::math::Mat3::det
T det() const
Determinant of matrix.
Definition Mat3.h:479
openvdb::v10_0::math::Mat3::transform
Vec3< T0 > transform(const Vec3< T0 > &v) const
Definition Mat3.h:505
openvdb::v10_0::math::Quat
Definition Quat.h:79
openvdb::v10_0::math::Quat< Real >::angle
Real angle() const
Definition Quat.h:224
openvdb::v10_0::math::Quat< Real >::x
Real & x()
Definition Quat.h:193
openvdb::v10_0::math::Quat::sub
Quat & sub(const Quat &q1, const Quat &q2)
Definition Quat.h:412
openvdb::v10_0::math::Quat::conjugate
Quat conjugate() const
Definition Quat.h:500
openvdb::v10_0::math::Quat< Real >::axis
Vec3< Real > axis() const
Definition Quat.h:239
openvdb::v10_0::math::Quat::operator/
Quat operator/(T scalar) const
Return (this/scalar), e.g. q = q1 / scalar;.
Definition Quat.h:389
openvdb::v10_0::math::Quat::operator*=
Quat & operator*=(T scalar)
Scale "this" quaternion by scalar, e.g. q *= scalar;.
Definition Quat.h:339
openvdb::v10_0::math::Quat::setAxisAngle
Quat & setAxisAngle(const Vec3< T > &axis, T angle)
Definition Quat.h:267
openvdb::v10_0::math::Quat::unit
Quat unit() const
this = normalized this
Definition Quat.h:476
openvdb::v10_0::math::Quat::write
void write(std::ostream &os) const
Definition Quat.h:543
openvdb::v10_0::math::Quat::operator*
Quat operator*(const Quat &q) const
Return (this*q), e.g. q = q1 * q2;.
Definition Quat.h:362
openvdb::v10_0::math::Quat::operator==
bool operator==(const Quat &q) const
Equality operator, does exact floating point comparisons.
Definition Quat.h:301
openvdb::v10_0::math::Quat::Quat
Quat(T *a)
Constructor with array argument, e.g. float a[4]; Quatf q(a);.
Definition Quat.h:101
openvdb::v10_0::math::Quat::add
Quat & add(const Quat &q1, const Quat &q2)
Definition Quat.h:400
openvdb::v10_0::math::Quat::operator<<
friend std::ostream & operator<<(std::ostream &stream, const Quat &q)
Output to the stream, e.g. std::cout << q << std::endl;.
Definition Quat.h:535
openvdb::v10_0::math::Quat::w
T w() const
Definition Quat.h:202
openvdb::v10_0::math::Quat::Quat
Quat(math::Axis axis, T angle)
Constructor given rotation as axis and angle.
Definition Quat.h:127
openvdb::v10_0::math::Quat::operator+=
Quat & operator+=(const Quat &q)
Add quaternion q to "this" quaternion, e.g. q += q1;.
Definition Quat.h:317
openvdb::v10_0::math::Quat::Quat
Quat()=default
openvdb::v10_0::math::Quat::operator-
Quat operator-() const
Negation operator, e.g. q = -q;.
Definition Quat.h:395
openvdb::v10_0::math::Quat::operator()
T & operator()(int i)
Alternative indexed reference to the elements.
Definition Quat.h:218
openvdb::v10_0::math::Quat< Real >::y
Real & y()
Definition Quat.h:194
openvdb::v10_0::math::Quat< Real >::z
Real & z()
Definition Quat.h:195
openvdb::v10_0::math::Quat::Quat
Quat(const Vec3< T > &axis, T angle)
Definition Quat.h:112
openvdb::v10_0::math::Quat::scale
Quat & scale(T scale, const Quat &q)
Definition Quat.h:440
openvdb::v10_0::math::Quat::operator()
T operator()(int i) const
Alternative indexed constant reference to the elements,.
Definition Quat.h:221
openvdb::v10_0::math::Quat::Quat
Quat(const Mat3< T1 > &rot)
Constructor given a rotation matrix.
Definition Quat.h:140
openvdb::v10_0::math::Quat< Real >::setIdentity
Quat & setIdentity()
Definition Quat.h:289
openvdb::v10_0::math::Quat::operator+
Quat operator+(const Quat &q) const
Return (this+q), e.g. q = q1 + q2;.
Definition Quat.h:350
openvdb::v10_0::math::Quat::init
Quat & init()
"this" quaternion gets initialized to identity, same as setIdentity()
Definition Quat.h:263
openvdb::v10_0::math::Quat::operator*=
Quat operator*=(const Quat &q)
Assigns this to (this*q), e.g. q *= q1;.
Definition Quat.h:376
openvdb::v10_0::math::Quat::Quat
Quat(T x, T y, T z, T w)
Constructor with four arguments, e.g. Quatf q(1,2,3,4);.
Definition Quat.h:91
openvdb::v10_0::math::Quat::rotateVector
Vec3< T > rotateVector(const Vec3< T > &v) const
Return rotated vector by "this" quaternion.
Definition Quat.h:506
openvdb::v10_0::math::Quat::x
T x() const
Get the component, e.g. float f = q.w();.
Definition Quat.h:199
openvdb::v10_0::math::Quat< Real >::size
static const int size
Definition Quat.h:83
openvdb::v10_0::math::Quat::normalize
bool normalize(T eps=T(1.0e-8))
this = normalized this
Definition Quat.h:467
openvdb::v10_0::math::Quat::identity
static Quat identity()
Definition Quat.h:514
openvdb::v10_0::math::Quat::init
Quat & init(T x, T y, T z, T w)
"this" quaternion gets initialized to [x, y, z, w]
Definition Quat.h:256
openvdb::v10_0::math::Quat::z
T z() const
Definition Quat.h:201
openvdb::v10_0::math::Quat::y
T y() const
Definition Quat.h:200
openvdb::v10_0::math::Quat::eulerAngles
Vec3< T > eulerAngles(RotationOrder rotationOrder) const
Returns vector of x,y,z rotational components.
Definition Quat.h:297
openvdb::v10_0::math::Quat::operator[]
T operator[](int i) const
Array style constant reference to the components, e.g. float f = q[1];.
Definition Quat.h:211
openvdb::v10_0::math::Quat::numElements
static unsigned numElements()
Definition Quat.h:205
openvdb::v10_0::math::Quat::derivative
Quat derivative(const Vec3< T > &omega) const
Definition Quat.h:458
openvdb::v10_0::math::Quat::operator[]
T & operator[](int i)
Array style reference to the components, e.g. q[3] = 1.34f;.
Definition Quat.h:208
openvdb::v10_0::math::Quat::operator*
Quat operator*(T scalar) const
Return (this*scalar), e.g. q = q1 * scalar;.
Definition Quat.h:383
openvdb::v10_0::math::Quat< Real >::mm
Real mm[4]
Definition Quat.h:547
openvdb::v10_0::math::Quat::str
std::string str() const
Definition Quat.h:517
openvdb::v10_0::math::Quat< Real >::slerp
friend Quat slerp(const Quat &q1, const Quat &q2, Real t, Real tolerance)
openvdb::v10_0::math::Quat::operator-=
Quat & operator-=(const Quat &q)
Subtract quaternion q from "this" quaternion, e.g. q -= q1;.
Definition Quat.h:328
openvdb::v10_0::math::Quat< Real >::ValueType
Real ValueType
Definition Quat.h:82
openvdb::v10_0::math::Quat::mult
Quat & mult(const Quat &q1, const Quat &q2)
Definition Quat.h:424
openvdb::v10_0::math::Quat::zero
static Quat zero()
Predefined constants, e.g. Quat q = Quat::identity();.
Definition Quat.h:513
openvdb::v10_0::math::Quat::inverse
Quat inverse(T tolerance=T(0)) const
returns inverse of this
Definition Quat.h:486
openvdb::v10_0::math::Quat::eq
bool eq(const Quat &q, T eps=1.0e-7) const
Test if "this" is equivalent to q with tolerance of eps value.
Definition Quat.h:310
openvdb::v10_0::math::Quat::setZero
Quat & setZero()
Set "this" vector to zero.
Definition Quat.h:282
openvdb::v10_0::math::Quat::operator-
Quat operator-(const Quat &q) const
Return (this-q), e.g. q = q1 - q2;.
Definition Quat.h:356
openvdb::v10_0::math::Quat< Real >::value_type
Real value_type
Definition Quat.h:81
openvdb::v10_0::math::Quat< Real >::w
Real & w()
Definition Quat.h:196
openvdb::v10_0::math::Quat::read
void read(std::istream &is)
Definition Quat.h:544
openvdb::v10_0::math::Quat::dot
T dot(const Quat &q) const
Dot product.
Definition Quat.h:451
openvdb::v10_0::math::Vec3
Definition Vec3.h:24
openvdb::v10_0::math::Vec3::x
T & x()
Reference to the component, e.g. v.x() = 4.5f;.
Definition Vec3.h:85
openvdb::v10_0::math::Vec3::y
T & y()
Definition Vec3.h:86
openvdb::v10_0::math::Vec3::z
T & z()
Definition Vec3.h:87
openvdb::v10_0::math::operator*
Mat3< typename promote< T0, T1 >::type > operator*(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Multiply m0 by m1 and return the resulting matrix.
Definition Mat3.h:597
openvdb::v10_0::math::eulerAngles
Vec3< typename MatType::value_type > eulerAngles(const MatType &mat, RotationOrder rotationOrder, typename MatType::value_type eps=static_cast< typename MatType::value_type >(1.0e-8))
Return the Euler angles composing the given rotation matrix.
Definition Mat.h:333
openvdb::v10_0::math::isApproxEqual
bool isApproxEqual(const Type &a, const Type &b, const Type &tolerance)
Return true if a is equal to b to within the given tolerance.
Definition Math.h:406
openvdb::v10_0::math::isUnitary
bool isUnitary(const MatType &m)
Determine if a matrix is unitary (i.e., rotation or reflection).
Definition Mat.h:889
openvdb::v10_0::math::rotation
MatType rotation(const Quat< typename MatType::value_type > &q, typename MatType::value_type eps=static_cast< typename MatType::value_type >(1.0e-8))
Return the rotation matrix specified by the given quaternion.
Definition Mat.h:172
openvdb::v10_0::math::angle
T angle(const Vec2< T > &v1, const Vec2< T > &v2)
Definition Vec2.h:446
openvdb::v10_0::math::isExactlyEqual
bool isExactlyEqual(const T0 &a, const T1 &b)
Return true if a is exactly equal to b.
Definition Math.h:443
openvdb::v10_0::math::Quatd
Quat< double > Quatd
Definition Quat.h:601
openvdb::v10_0::math::Axis
Axis
Definition Math.h:901
openvdb::v10_0::math::Z_AXIS
@ Z_AXIS
Definition Math.h:904
openvdb::v10_0::math::X_AXIS
@ X_AXIS
Definition Math.h:902
openvdb::v10_0::math::Y_AXIS
@ Y_AXIS
Definition Math.h:903
openvdb::v10_0::math::Quats
Quat< float > Quats
Definition Quat.h:600
openvdb::v10_0::math::bezLerp
Mat3< T > bezLerp(const Mat3< T0 > &m1, const Mat3< T0 > &m2, const Mat3< T0 > &m3, const Mat3< T0 > &m4, T t)
Definition Quat.h:584
openvdb::v10_0::math::RotationOrder
RotationOrder
Definition Math.h:908
openvdb::v10_0::math::slerp
Quat< T > slerp(const Quat< T > &q1, const Quat< T > &q2, T t, T tolerance=0.00001)
Linear interpolation between the two quaternions.
Definition Quat.h:27
openvdb::v10_0::zeroVal
T zeroVal()
Return the value of type T that corresponds to zero.
Definition Math.h:70
openvdb
Definition Exceptions.h:13
Exceptions.h
OPENVDB_THROW
#define OPENVDB_THROW(exception, message)
Definition Exceptions.h:74
OPENVDB_VERSION_NAME
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition version.h.in:121
OPENVDB_USE_VERSION_NAMESPACE
#define OPENVDB_USE_VERSION_NAMESPACE
Definition version.h.in:212