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 Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 ////////////////////////////////////////////////////////////////////////
25 // This file is generated by a script. Do not edit directly. Edit the
26 // quat.template.h file to make changes.
27 
28 #ifndef PXR_BASE_GF_QUATF_H
29 #define PXR_BASE_GF_QUATF_H
30 
31 /// \file gf/quatf.h
32 /// \ingroup group_gf_LinearAlgebra
33 
34 #include "pxr/pxr.h"
35 #include "pxr/base/gf/api.h"
36 #include "pxr/base/gf/declare.h"
37 #include "pxr/base/gf/vec3f.h"
38 #include "pxr/base/gf/traits.h"
39 #include "pxr/base/tf/hash.h"
40 
41 #include <iosfwd>
42 
44 
45 template <>
46 struct GfIsGfQuat<class GfQuatf> { static const bool value = true; };
47 
48 
49 /// Return the dot (inner) product of two quaternions.
50 float GfDot(const GfQuatf& q1, const GfQuatf& q2);
51 
52 
53 /// \class GfQuatf
54 /// \ingroup group_gf_LinearAlgebra
55 ///
56 /// Basic type: a quaternion, a complex number with a real coefficient and
57 /// three imaginary coefficients, stored as a 3-vector.
58 ///
59 class GfQuatf
60 {
61  public:
62  typedef float ScalarType;
64 
65  /// Default constructor leaves the quaternion undefined.
66  GfQuatf() {}
67 
68  /// Initialize the real coefficient to \p realVal and the imaginary
69  /// coefficients to zero.
70  ///
71  /// Since quaternions typically must be normalized, reasonable values for
72  /// \p realVal are -1, 0, or 1. Other values are legal but are likely to
73  /// be meaningless.
74  ///
75  explicit GfQuatf (float realVal) : _imaginary(0), _real(realVal) {}
76 
77  /// Initialize the real and imaginary coefficients.
78  GfQuatf(float real, float i, float j, float k)
79  : _imaginary(i, j, k), _real(real)
80  {
81  }
82 
83  /// Initialize the real and imaginary coefficients.
84  GfQuatf(float real, const GfVec3f &imaginary)
85  : _imaginary(imaginary), _real(real)
86  {
87  }
88 
89  /// Construct from GfQuatd.
90  GF_API
91  explicit GfQuatf(class GfQuatd const &other);
92  /// Implicitly convert from GfQuath.
93  GF_API
94  GfQuatf(class GfQuath const &other);
95 
96  /// Return the zero quaternion, with real coefficient 0 and an
97  /// imaginary coefficients all zero.
98  static GfQuatf GetZero() { return GfQuatf(0.0); }
99 
100  /// Return the identity quaternion, with real coefficient 1 and an
101  /// imaginary coefficients all zero.
102  static GfQuatf GetIdentity() { return GfQuatf(1.0); }
103 
104  /// Return the real coefficient.
105  float GetReal() const { return _real; }
106 
107  /// Set the real coefficient.
108  void SetReal(float real) { _real = real; }
109 
110  /// Return the imaginary coefficient.
111  const GfVec3f &GetImaginary() const { return _imaginary; }
112 
113  /// Set the imaginary coefficients.
114  void SetImaginary(const GfVec3f &imaginary) {
115  _imaginary = imaginary;
116  }
117 
118  /// Set the imaginary coefficients.
119  void SetImaginary(float i, float j, float k) {
120  _imaginary.Set(i, j, k);
121  }
122 
123  /// Return geometric length of this quaternion.
124  float GetLength() const { return GfSqrt(_GetLengthSquared()); }
125 
126  /// length of this quaternion is smaller than \p eps, return the identity
127  /// quaternion.
128  GfQuatf
129  GetNormalized(float eps = GF_MIN_VECTOR_LENGTH) const {
130  GfQuatf ret(*this);
131  ret.Normalize(eps);
132  return ret;
133  }
134 
135  /// Normalizes this quaternion in place to unit length, returning the
136  /// length before normalization. If the length of this quaternion is
137  /// smaller than \p eps, this sets the quaternion to identity.
138  GF_API
139  float Normalize(float eps = GF_MIN_VECTOR_LENGTH);
140 
141  /// Return this quaternion's conjugate, which is the quaternion with the
142  /// same real coefficient and negated imaginary coefficients.
144  return GfQuatf(GetReal(), -GetImaginary());
145  }
146 
147  /// Return this quaternion's inverse, or reciprocal. This is the
148  /// quaternion's conjugate divided by it's squared length.
149  GfQuatf GetInverse() const {
150  return GetConjugate() / _GetLengthSquared();
151  }
152 
153  /// Transform the GfVec3f point. If the quaternion is normalized,
154  /// the transformation is a rotation. Given a GfQuatf q, q.Transform(point)
155  /// is equivalent to:
156  ///
157  /// (q * GfQuatf(0, point) * q.GetInverse()).GetImaginary()
158  ///
159  /// but is more efficient.
160  GF_API
161  GfVec3f Transform(const GfVec3f& point) const;
162 
163  /// Hash.
164  friend inline size_t hash_value(const GfQuatf &q) {
165  return TfHash::Combine(q.GetReal(), q.GetImaginary());
166  }
167 
168  /// Component-wise negation.
169  GfQuatf operator-() const {
170  return GfQuatf(-GetReal(), -GetImaginary());
171  }
172 
173  /// Component-wise quaternion equality test. The real and imaginary parts
174  /// must match exactly for quaternions to be considered equal.
175  bool operator==(const GfQuatf &q) const {
176  return (GetReal() == q.GetReal() &&
177  GetImaginary() == q.GetImaginary());
178  }
179 
180  /// Component-wise quaternion inequality test. The real and imaginary
181  /// parts must match exactly for quaternions to be considered equal.
182  bool operator!=(const GfQuatf &q) const {
183  return !(*this == q);
184  }
185 
186  /// Post-multiply quaternion \p q into this quaternion.
187  GF_API
188  GfQuatf &operator *=(const GfQuatf &q);
189 
190  /// Multiply this quaternion's coefficients by \p s.
192  _real *= s;
193  _imaginary *= s;
194  return *this;
195  }
196 
197  /// Divide this quaternion's coefficients by \p s.
199  _real /= s;
200  _imaginary /= s;
201  return *this;
202  }
203 
204  /// Add quaternion \p q to this quaternion.
206  _real += q._real;
207  _imaginary += q._imaginary;
208  return *this;
209  }
210 
211  /// Component-wise unary difference operator.
213  _real -= q._real;
214  _imaginary -= q._imaginary;
215  return *this;
216  }
217 
218  /// Component-wise binary sum operator.
219  friend GfQuatf
220  operator +(const GfQuatf &q1, const GfQuatf &q2) {
221  return GfQuatf(q1) += q2;
222  }
223 
224  /// Component-wise binary difference operator.
225  friend GfQuatf
226  operator -(const GfQuatf &q1, const GfQuatf &q2) {
227  return GfQuatf(q1) -= q2;
228  }
229 
230  /// Returns the product of quaternions \p q1 and \p q2.
231  friend GfQuatf
232  operator *(const GfQuatf &q1, const GfQuatf &q2) {
233  return GfQuatf(q1) *= q2;
234  }
235 
236  /// Returns the product of quaternion \p q and scalar \p s.
237  friend GfQuatf
238  operator *(const GfQuatf &q, float s) {
239  return GfQuatf(q) *= s;
240  }
241 
242  /// Returns the product of quaternion \p q and scalar \p s.
243  friend GfQuatf
244  operator *(float s, const GfQuatf &q) {
245  return GfQuatf(q) *= s;
246  }
247 
248  /// Returns the product of quaternion \p q and scalar 1 / \p s.
249  friend GfQuatf
250  operator /(const GfQuatf &q, float s) {
251  return GfQuatf(q) /= s;
252  }
253 
254  private:
255  /// Imaginary part
256  GfVec3f _imaginary;
257 
258  /// Real part
259  float _real;
260 
261  /// Returns the square of the length
262  float
263  _GetLengthSquared() const {
264  return GfDot(*this, *this);
265  }
266 };
267 
268 /// Spherically linearly interpolate between \p q0 and \p q1.
269 ///
270 /// If the interpolant \p alpha is zero, then the result is \p q0, while
271 /// \p alpha of one yields \p q1.
273 GfSlerp(double alpha, const GfQuatf& q0, const GfQuatf& q1);
274 
276 GfSlerp(const GfQuatf& q0, const GfQuatf& q1, double alpha);
277 
278 inline float
279 GfDot(GfQuatf const &q1, GfQuatf const &q2) {
280  return GfDot(q1.GetImaginary(), q2.GetImaginary()) +
281  q1.GetReal()*q2.GetReal();
282 }
283 
284 /// Output a GfQuatd using the format (re, i, j, k)
285 /// \ingroup group_gf_DebuggingOutput
286 GF_API std::ostream& operator<<(std::ostream &, GfQuatf const &);
287 
289 
290 #endif // PXR_BASE_GF_QUATF_H
Definition: quath.h:60
GfQuatf operator-() const
Component-wise negation.
Definition: quatf.h:169
GfQuatf()
Default constructor leaves the quaternion undefined.
Definition: quatf.h:66
static GfQuatf GetIdentity()
Definition: quatf.h:102
GfQuatf(float real, const GfVec3f &imaginary)
Initialize the real and imaginary coefficients.
Definition: quatf.h:84
float GetLength() const
Return geometric length of this quaternion.
Definition: quatf.h:124
double GfSqrt(double f)
Definition: math.h:80
*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:623
Definition: vec3f.h:62
GLdouble s
Definition: glad.h:3009
GfQuatf(float realVal)
Definition: quatf.h:75
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:59
GfQuatf(float real, float i, float j, float k)
Initialize the real and imaginary coefficients.
Definition: quatf.h:78
float GetReal() const
Return the real coefficient.
Definition: quatf.h:105
friend GfQuatf operator*(const GfQuatf &q1, const GfQuatf &q2)
Returns the product of quaternions q1 and q2.
Definition: quatf.h:232
GfQuatf & operator/=(float s)
Divide this quaternion's coefficients by s.
Definition: quatf.h:198
GF_API std::ostream & operator<<(std::ostream &, GfQuatf const &)
bool operator!=(const GfQuatf &q) const
Definition: quatf.h:182
void SetImaginary(const GfVec3f &imaginary)
Set the imaginary coefficients.
Definition: quatf.h:114
void SetReal(float real)
Set the real coefficient.
Definition: quatf.h:108
GfVec3f & Set(float s0, float s1, float s2)
Set all elements with passed arguments.
Definition: vec3f.h:129
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:279
friend size_t hash_value(const GfQuatf &q)
Hash.
Definition: quatf.h:164
GfQuatf GetInverse() const
Definition: quatf.h:149
GF_API GfVec3f Transform(const GfVec3f &point) const
float ScalarType
Definition: quatf.h:62
GLint j
Definition: glad.h:2733
GfVec3f ImaginaryType
Definition: quatf.h:63
GfQuatf GetConjugate() const
Definition: quatf.h:143
static size_t Combine(Args &&...args)
Produce a hash code by combining the hash codes of several objects.
Definition: hash.h:492
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
friend GfQuatf operator+(const GfQuatf &q1, const GfQuatf &q2)
Component-wise binary sum operator.
Definition: quatf.h:220
bool operator==(const GfQuatf &q) const
Definition: quatf.h:175
GfQuatf & operator-=(const GfQuatf &q)
Component-wise unary difference operator.
Definition: quatf.h:212
Definition: core.h:1131
GfQuatf GetNormalized(float eps=GF_MIN_VECTOR_LENGTH) const
Definition: quatf.h:129
Definition: quatd.h:59
void SetImaginary(float i, float j, float k)
Set the imaginary coefficients.
Definition: quatf.h:119
static GfQuatf GetZero()
Definition: quatf.h:98
const GfVec3f & GetImaginary() const
Return the imaginary coefficient.
Definition: quatf.h:111
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:250
GfQuatf & operator+=(const GfQuatf &q)
Add quaternion q to this quaternion.
Definition: quatf.h:205
#define GF_MIN_VECTOR_LENGTH
Definition: limits.h:34
#define GF_API
Definition: api.h:40