HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
quatf.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the terms set forth in the LICENSE.txt file available at
5 // https://openusd.org/license.
6 //
7 ////////////////////////////////////////////////////////////////////////
8 // This file is generated by a script. Do not edit directly. Edit the
9 // quat.template.h file to make changes.
10 
11 #ifndef PXR_BASE_GF_QUATF_H
12 #define PXR_BASE_GF_QUATF_H
13 
14 /// \file gf/quatf.h
15 /// \ingroup group_gf_LinearAlgebra
16 
17 #include "pxr/pxr.h"
18 #include "pxr/base/gf/api.h"
19 #include "pxr/base/gf/declare.h"
20 #include "pxr/base/gf/vec3f.h"
21 #include "pxr/base/gf/traits.h"
22 #include "pxr/base/tf/hash.h"
23 
24 #include <iosfwd>
25 
27 
28 template <>
29 struct GfIsGfQuat<class GfQuatf> { static const bool value = true; };
30 
31 
32 /// Return the dot (inner) product of two quaternions.
33 float GfDot(const GfQuatf& q1, const GfQuatf& q2);
34 
35 
36 /// \class GfQuatf
37 /// \ingroup group_gf_LinearAlgebra
38 ///
39 /// Basic type: a quaternion, a complex number with a real coefficient and
40 /// three imaginary coefficients, stored as a 3-vector.
41 ///
42 class GfQuatf
43 {
44  public:
45  typedef float ScalarType;
47 
48  /// Default constructor leaves the quaternion undefined.
49  GfQuatf() {}
50 
51  /// Initialize the real coefficient to \p realVal and the imaginary
52  /// coefficients to zero.
53  ///
54  /// Since quaternions typically must be normalized, reasonable values for
55  /// \p realVal are -1, 0, or 1. Other values are legal but are likely to
56  /// be meaningless.
57  ///
58  explicit GfQuatf (float realVal) : _imaginary(0), _real(realVal) {}
59 
60  /// Initialize the real and imaginary coefficients.
61  GfQuatf(float real, float i, float j, float k)
62  : _imaginary(i, j, k), _real(real)
63  {
64  }
65 
66  /// Initialize the real and imaginary coefficients.
67  GfQuatf(float real, const GfVec3f &imaginary)
68  : _imaginary(imaginary), _real(real)
69  {
70  }
71 
72  /// Construct from GfQuatd.
73  GF_API
74  explicit GfQuatf(class GfQuatd const &other);
75  /// Implicitly convert from GfQuath.
76  GF_API
77  GfQuatf(class GfQuath const &other);
78 
79  /// Return the zero quaternion, with real coefficient 0 and an
80  /// imaginary coefficients all zero.
81  static GfQuatf GetZero() { return GfQuatf(0.0); }
82 
83  /// Return the identity quaternion, with real coefficient 1 and an
84  /// imaginary coefficients all zero.
85  static GfQuatf GetIdentity() { return GfQuatf(1.0); }
86 
87  /// Return the real coefficient.
88  float GetReal() const { return _real; }
89 
90  /// Set the real coefficient.
91  void SetReal(float real) { _real = real; }
92 
93  /// Return the imaginary coefficient.
94  const GfVec3f &GetImaginary() const { return _imaginary; }
95 
96  /// Set the imaginary coefficients.
97  void SetImaginary(const GfVec3f &imaginary) {
98  _imaginary = imaginary;
99  }
100 
101  /// Set the imaginary coefficients.
102  void SetImaginary(float i, float j, float k) {
103  _imaginary.Set(i, j, k);
104  }
105 
106  /// Return geometric length of this quaternion.
107  float GetLength() const { return GfSqrt(_GetLengthSquared()); }
108 
109  /// length of this quaternion is smaller than \p eps, return the identity
110  /// quaternion.
111  GfQuatf
112  GetNormalized(float eps = GF_MIN_VECTOR_LENGTH) const {
113  GfQuatf ret(*this);
114  ret.Normalize(eps);
115  return ret;
116  }
117 
118  /// Normalizes this quaternion in place to unit length, returning the
119  /// length before normalization. If the length of this quaternion is
120  /// smaller than \p eps, this sets the quaternion to identity.
121  GF_API
122  float Normalize(float eps = GF_MIN_VECTOR_LENGTH);
123 
124  /// Return this quaternion's conjugate, which is the quaternion with the
125  /// same real coefficient and negated imaginary coefficients.
127  return GfQuatf(GetReal(), -GetImaginary());
128  }
129 
130  /// Return this quaternion's inverse, or reciprocal. This is the
131  /// quaternion's conjugate divided by it's squared length.
132  GfQuatf GetInverse() const {
133  return GetConjugate() / _GetLengthSquared();
134  }
135 
136  /// Transform the GfVec3f point. If the quaternion is normalized,
137  /// the transformation is a rotation. Given a GfQuatf q, q.Transform(point)
138  /// is equivalent to:
139  ///
140  /// (q * GfQuatf(0, point) * q.GetInverse()).GetImaginary()
141  ///
142  /// but is more efficient.
143  GF_API
144  GfVec3f Transform(const GfVec3f& point) const;
145 
146  /// Hash.
147  friend inline size_t hash_value(const GfQuatf &q) {
148  return TfHash::Combine(q.GetReal(), q.GetImaginary());
149  }
150 
151  /// Component-wise negation.
152  GfQuatf operator-() const {
153  return GfQuatf(-GetReal(), -GetImaginary());
154  }
155 
156  /// Component-wise quaternion equality test. The real and imaginary parts
157  /// must match exactly for quaternions to be considered equal.
158  bool operator==(const GfQuatf &q) const {
159  return (GetReal() == q.GetReal() &&
160  GetImaginary() == q.GetImaginary());
161  }
162 
163  /// Component-wise quaternion inequality test. The real and imaginary
164  /// parts must match exactly for quaternions to be considered equal.
165  bool operator!=(const GfQuatf &q) const {
166  return !(*this == q);
167  }
168 
169  /// Post-multiply quaternion \p q into this quaternion.
170  GF_API
171  GfQuatf &operator *=(const GfQuatf &q);
172 
173  /// Multiply this quaternion's coefficients by \p s.
175  _real *= s;
176  _imaginary *= s;
177  return *this;
178  }
179 
180  /// Divide this quaternion's coefficients by \p s.
182  _real /= s;
183  _imaginary /= s;
184  return *this;
185  }
186 
187  /// Add quaternion \p q to this quaternion.
189  _real += q._real;
190  _imaginary += q._imaginary;
191  return *this;
192  }
193 
194  /// Component-wise unary difference operator.
196  _real -= q._real;
197  _imaginary -= q._imaginary;
198  return *this;
199  }
200 
201  /// Component-wise binary sum operator.
202  friend GfQuatf
203  operator +(const GfQuatf &q1, const GfQuatf &q2) {
204  return GfQuatf(q1) += q2;
205  }
206 
207  /// Component-wise binary difference operator.
208  friend GfQuatf
209  operator -(const GfQuatf &q1, const GfQuatf &q2) {
210  return GfQuatf(q1) -= q2;
211  }
212 
213  /// Returns the product of quaternions \p q1 and \p q2.
214  friend GfQuatf
215  operator *(const GfQuatf &q1, const GfQuatf &q2) {
216  return GfQuatf(q1) *= q2;
217  }
218 
219  /// Returns the product of quaternion \p q and scalar \p s.
220  friend GfQuatf
221  operator *(const GfQuatf &q, float s) {
222  return GfQuatf(q) *= s;
223  }
224 
225  /// Returns the product of quaternion \p q and scalar \p s.
226  friend GfQuatf
227  operator *(float s, const GfQuatf &q) {
228  return GfQuatf(q) *= s;
229  }
230 
231  /// Returns the product of quaternion \p q and scalar 1 / \p s.
232  friend GfQuatf
233  operator /(const GfQuatf &q, float s) {
234  return GfQuatf(q) /= s;
235  }
236 
237  private:
238  /// Imaginary part
239  GfVec3f _imaginary;
240 
241  /// Real part
242  float _real;
243 
244  /// Returns the square of the length
245  float
246  _GetLengthSquared() const {
247  return GfDot(*this, *this);
248  }
249 };
250 
251 /// Spherically linearly interpolate between \p q0 and \p q1.
252 ///
253 /// If the interpolant \p alpha is zero, then the result is \p q0, while
254 /// \p alpha of one yields \p q1.
256 GfSlerp(double alpha, const GfQuatf& q0, const GfQuatf& q1);
257 
259 GfSlerp(const GfQuatf& q0, const GfQuatf& q1, double alpha);
260 
261 inline float
262 GfDot(GfQuatf const &q1, GfQuatf const &q2) {
263  return GfDot(q1.GetImaginary(), q2.GetImaginary()) +
264  q1.GetReal()*q2.GetReal();
265 }
266 
267 /// Output a GfQuatd using the format (re, i, j, k)
268 /// \ingroup group_gf_DebuggingOutput
269 GF_API std::ostream& operator<<(std::ostream &, GfQuatf const &);
270 
272 
273 #endif // PXR_BASE_GF_QUATF_H
Definition: quath.h:43
GfQuatf operator-() const
Component-wise negation.
Definition: quatf.h:152
GfQuatf()
Default constructor leaves the quaternion undefined.
Definition: quatf.h:49
static GfQuatf GetIdentity()
Definition: quatf.h:85
GfQuatf(float real, const GfVec3f &imaginary)
Initialize the real and imaginary coefficients.
Definition: quatf.h:67
float GetLength() const
Return geometric length of this quaternion.
Definition: quatf.h:107
double GfSqrt(double f)
Definition: math.h:187
*get result *(waiting if necessary)*A common idiom is to fire a bunch of sub tasks at the and then *wait for them to all complete We provide a helper class
Definition: thread.h:632
GLsizei const GLfloat * value
Definition: glcorearb.h:824
Definition: vec3f.h:45
GLdouble s
Definition: glad.h:3009
GfQuatf(float realVal)
Definition: quatf.h:58
GLdouble GLdouble GLdouble q
Definition: glad.h:2445
GF_API GfQuatf GfSlerp(double alpha, const GfQuatf &q0, const GfQuatf &q1)
GF_API GfQuatf & operator*=(const GfQuatf &q)
Post-multiply quaternion q into this quaternion.
Definition: quatf.h:42
GfQuatf(float real, float i, float j, float k)
Initialize the real and imaginary coefficients.
Definition: quatf.h:61
float GetReal() const
Return the real coefficient.
Definition: quatf.h:88
friend GfQuatf operator*(const GfQuatf &q1, const GfQuatf &q2)
Returns the product of quaternions q1 and q2.
Definition: quatf.h:215
GfQuatf & operator/=(float s)
Divide this quaternion's coefficients by s.
Definition: quatf.h:181
GF_API std::ostream & operator<<(std::ostream &, GfQuatf const &)
bool operator!=(const GfQuatf &q) const
Definition: quatf.h:165
void SetImaginary(const GfVec3f &imaginary)
Set the imaginary coefficients.
Definition: quatf.h:97
void SetReal(float real)
Set the real coefficient.
Definition: quatf.h:91
GfVec3f & Set(float s0, float s1, float s2)
Set all elements with passed arguments.
Definition: vec3f.h:112
GLfloat GLfloat GLfloat alpha
Definition: glcorearb.h:112
float GfDot(const GfQuatf &q1, const GfQuatf &q2)
Return the dot (inner) product of two quaternions.
Definition: quatf.h:262
friend size_t hash_value(const GfQuatf &q)
Hash.
Definition: quatf.h:147
GfQuatf GetInverse() const
Definition: quatf.h:132
GF_API GfVec3f Transform(const GfVec3f &point) const
float ScalarType
Definition: quatf.h:45
GLint j
Definition: glad.h:2733
GfVec3f ImaginaryType
Definition: quatf.h:46
GfQuatf GetConjugate() const
Definition: quatf.h:126
static size_t Combine(Args &&...args)
Produce a hash code by combining the hash codes of several objects.
Definition: hash.h:487
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1425
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:74
friend GfQuatf operator+(const GfQuatf &q1, const GfQuatf &q2)
Component-wise binary sum operator.
Definition: quatf.h:203
bool operator==(const GfQuatf &q) const
Definition: quatf.h:158
GfQuatf & operator-=(const GfQuatf &q)
Component-wise unary difference operator.
Definition: quatf.h:195
GfQuatf GetNormalized(float eps=GF_MIN_VECTOR_LENGTH) const
Definition: quatf.h:112
Definition: quatd.h:42
void SetImaginary(float i, float j, float k)
Set the imaginary coefficients.
Definition: quatf.h:102
static GfQuatf GetZero()
Definition: quatf.h:81
const GfVec3f & GetImaginary() const
Return the imaginary coefficient.
Definition: quatf.h:94
GF_API float Normalize(float eps=GF_MIN_VECTOR_LENGTH)
friend GfQuatf operator/(const GfQuatf &q, float s)
Returns the product of quaternion q and scalar 1 / s.
Definition: quatf.h:233
GfQuatf & operator+=(const GfQuatf &q)
Add quaternion q to this quaternion.
Definition: quatf.h:188
#define GF_MIN_VECTOR_LENGTH
Definition: limits.h:17
#define GF_API
Definition: api.h:23