gtc/quaternion.hpp
Go to the documentation of this file.
1 
2 
3 
4 
5 
6 
7 
8 
9 
10 
11 
12 
13 
14 
15 
16 
17 
18 
19 
20 
21 
22 
23 
24 
25 
26 
27 
28 
29 
30 
31 
32 
33 
34 
35 
36 
37 
38 
39 
40 #ifndef GLM_GTC_quaternion
41 #define GLM_GTC_quaternion GLM_VERSION
42 
43 // Dependency:
44 #include "../glm.hpp"
45 #include "../gtc/half_float.hpp"
46 #include "../gtc/constants.hpp"
47 
48 #if(defined(GLM_MESSAGES) && !defined(glm_ext))
49 # pragma message("GLM: GLM_GTC_quaternion extension included")
50 #endif
51 
52 namespace glm{
53 namespace detail
54 {
55  template <typename T>
56  struct tquat// : public genType<T, tquat>
57  {
58  enum ctor{null};
59 
60  typedef T value_type;
61  typedef std::size_t size_type;
62 
63  public:
64  value_type x, y, z, w;
65 
66  GLM_FUNC_DECL size_type length() const;
67 
68  // Constructors
69  tquat();
70  explicit tquat(
71  value_type const & s,
72  glm::detail::tvec3<T> const & v);
73  explicit tquat(
74  value_type const & w,
75  value_type const & x,
76  value_type const & y,
77  value_type const & z);
78 
79  // Convertions
80 
82  explicit tquat(
83  tvec3<T> const & eulerAngles);
84  explicit tquat(
85  tmat3x3<T> const & m);
86  explicit tquat(
87  tmat4x4<T> const & m);
88 
89  // Accesses
90  value_type & operator[](int i);
91  value_type const & operator[](int i) const;
92 
93  // Operators
94  tquat<T> & operator*=(value_type const & s);
95  tquat<T> & operator/=(value_type const & s);
96  };
97 
98  template <typename T>
99  detail::tquat<T> operator- (
100  detail::tquat<T> const & q);
101 
102  template <typename T>
103  detail::tquat<T> operator+ (
104  detail::tquat<T> const & q,
105  detail::tquat<T> const & p);
106 
107  template <typename T>
108  detail::tquat<T> operator* (
109  detail::tquat<T> const & q,
110  detail::tquat<T> const & p);
111 
112  template <typename T>
113  detail::tvec3<T> operator* (
114  detail::tquat<T> const & q,
115  detail::tvec3<T> const & v);
116 
117  template <typename T>
118  detail::tvec3<T> operator* (
119  detail::tvec3<T> const & v,
120  detail::tquat<T> const & q);
121 
122  template <typename T>
123  detail::tvec4<T> operator* (
124  detail::tquat<T> const & q,
125  detail::tvec4<T> const & v);
126 
127  template <typename T>
128  detail::tvec4<T> operator* (
129  detail::tvec4<T> const & v,
130  detail::tquat<T> const & q);
131 
132  template <typename T>
133  detail::tquat<T> operator* (
134  detail::tquat<T> const & q,
135  typename detail::tquat<T>::value_type const & s);
136 
137  template <typename T>
138  detail::tquat<T> operator* (
139  typename detail::tquat<T>::value_type const & s,
140  detail::tquat<T> const & q);
141 
142  template <typename T>
143  detail::tquat<T> operator/ (
144  detail::tquat<T> const & q,
145  typename detail::tquat<T>::value_type const & s);
146 
147 } //namespace detail
148 
151 
155  template <typename T>
156  T length(
157  detail::tquat<T> const & q);
158 
162  template <typename T>
163  detail::tquat<T> normalize(
164  detail::tquat<T> const & q);
165 
169  template <typename T>
170  T dot(
171  detail::tquat<T> const & q1,
172  detail::tquat<T> const & q2);
173 
184  template <typename T>
185  detail::tquat<T> mix(
186  detail::tquat<T> const & x,
187  detail::tquat<T> const & y,
188  T const & a);
189 
198  template <typename T>
199  detail::tquat<T> lerp(
200  detail::tquat<T> const & x,
201  detail::tquat<T> const & y,
202  T const & a);
203 
212  template <typename T>
213  detail::tquat<T> slerp(
214  detail::tquat<T> const & x,
215  detail::tquat<T> const & y,
216  T const & a);
217 
221  template <typename T>
222  detail::tquat<T> conjugate(
223  detail::tquat<T> const & q);
224 
228  template <typename T>
229  detail::tquat<T> inverse(
230  detail::tquat<T> const & q);
231 
239  template <typename T>
240  detail::tquat<T> rotate(
241  detail::tquat<T> const & q,
242  typename detail::tquat<T>::value_type const & angle,
243  detail::tvec3<T> const & axis);
244 
248  template <typename T>
249  detail::tvec3<T> eulerAngles(
250  detail::tquat<T> const & x);
251 
255  template <typename valType>
256  valType roll(
257  detail::tquat<valType> const & x);
258 
262  template <typename valType>
263  valType pitch(
264  detail::tquat<valType> const & x);
265 
269  template <typename valType>
270  valType yaw(
271  detail::tquat<valType> const & x);
272 
276  template <typename T>
277  detail::tmat3x3<T> mat3_cast(
278  detail::tquat<T> const & x);
279 
283  template <typename T>
284  detail::tmat4x4<T> mat4_cast(
285  detail::tquat<T> const & x);
286 
290  template <typename T>
291  detail::tquat<T> quat_cast(
292  detail::tmat3x3<T> const & x);
293 
297  template <typename T>
298  detail::tquat<T> quat_cast(
299  detail::tmat4x4<T> const & x);
300 
304  template <typename valType>
305  valType angle(
306  detail::tquat<valType> const & x);
307 
311  template <typename valType>
312  detail::tvec3<valType> axis(
313  detail::tquat<valType> const & x);
314 
323  template <typename valType>
324  detail::tquat<valType> angleAxis(
325  valType const & angle,
326  valType const & x,
327  valType const & y,
328  valType const & z);
329 
336  template <typename valType>
337  detail::tquat<valType> angleAxis(
338  valType const & angle,
339  detail::tvec3<valType> const & axis);
340 
344  typedef detail::tquat<float> quat;
345 
349  typedef detail::tquat<detail::half> hquat;
350 
354  typedef detail::tquat<float> fquat;
355 
359  typedef detail::tquat<double> dquat;
360 
364  typedef detail::tquat<lowp_float> lowp_quat;
365 
369  typedef detail::tquat<mediump_float> mediump_quat;
370 
374  typedef detail::tquat<highp_float> highp_quat;
375 
377 } //namespace glm
378 
379 #include "quaternion.inl"
380 
381 #endif//GLM_GTC_quaternion