0.9.7
type_vec3.hpp
Go to the documentation of this file.
1 
33 #pragma once
34 
35 #include "type_vec.hpp"
36 #ifdef GLM_SWIZZLE
37 # if GLM_HAS_ANONYMOUS_UNION
38 # include "_swizzle.hpp"
39 # else
40 # include "_swizzle_func.hpp"
41 # endif
42 #endif //GLM_SWIZZLE
43 #include <cstddef>
44 
45 namespace glm
46 {
47  template <typename T, precision P = defaultp>
48  struct tvec3
49  {
50  // -- Implementation detail --
51 
52  typedef tvec3<T, P> type;
53  typedef tvec3<bool, P> bool_type;
54  typedef T value_type;
55 
56 # ifdef GLM_META_PROG_HELPERS
57  static GLM_RELAXED_CONSTEXPR length_t components = 3;
58  static GLM_RELAXED_CONSTEXPR precision prec = P;
59 # endif//GLM_META_PROG_HELPERS
60 
61  // -- Data --
62 
63 # if GLM_HAS_ANONYMOUS_UNION
64  union
65  {
66  struct{ T x, y, z; };
67  struct{ T r, g, b; };
68  struct{ T s, t, p; };
69 
70 # ifdef GLM_SWIZZLE
71  _GLM_SWIZZLE3_2_MEMBERS(T, P, tvec2, x, y, z)
72  _GLM_SWIZZLE3_2_MEMBERS(T, P, tvec2, r, g, b)
73  _GLM_SWIZZLE3_2_MEMBERS(T, P, tvec2, s, t, p)
74  _GLM_SWIZZLE3_3_MEMBERS(T, P, tvec3, x, y, z)
75  _GLM_SWIZZLE3_3_MEMBERS(T, P, tvec3, r, g, b)
76  _GLM_SWIZZLE3_3_MEMBERS(T, P, tvec3, s, t, p)
77  _GLM_SWIZZLE3_4_MEMBERS(T, P, tvec4, x, y, z)
78  _GLM_SWIZZLE3_4_MEMBERS(T, P, tvec4, r, g, b)
79  _GLM_SWIZZLE3_4_MEMBERS(T, P, tvec4, s, t, p)
80 # endif//GLM_SWIZZLE
81  };
82 # else
83  union { T x, r, s; };
84  union { T y, g, t; };
85  union { T z, b, p; };
86 
87 # ifdef GLM_SWIZZLE
88  GLM_SWIZZLE_GEN_VEC_FROM_VEC3(T, P, tvec3, tvec2, tvec3, tvec4)
89 # endif//GLM_SWIZZLE
90 # endif//GLM_LANG
91 
92  // -- Component accesses --
93 
94 # ifdef GLM_FORCE_SIZE_FUNC
95  typedef size_t size_type;
97  GLM_FUNC_DECL GLM_CONSTEXPR size_type size() const;
98 
99  GLM_FUNC_DECL T & operator[](size_type i);
100  GLM_FUNC_DECL T const & operator[](size_type i) const;
101 # else
102  typedef length_t length_type;
104  GLM_FUNC_DECL GLM_CONSTEXPR length_type length() const;
105 
106  GLM_FUNC_DECL T & operator[](length_type i);
107  GLM_FUNC_DECL T const & operator[](length_type i) const;
108 # endif//GLM_FORCE_SIZE_FUNC
109 
110  // -- Implicit basic constructors --
111 
112  GLM_FUNC_DECL tvec3() GLM_DEFAULT_CTOR;
113  GLM_FUNC_DECL tvec3(tvec3<T, P> const & v) GLM_DEFAULT;
114  template <precision Q>
115  GLM_FUNC_DECL tvec3(tvec3<T, Q> const & v);
116 
117  // -- Explicit basic constructors --
118 
119  GLM_FUNC_DECL explicit tvec3(ctor);
120  GLM_FUNC_DECL explicit tvec3(T const & s);
121  GLM_FUNC_DECL tvec3(T const & a, T const & b, T const & c);
122 
123  // -- Conversion scalar constructors --
124 
126  template <typename A, typename B, typename C>
127  GLM_FUNC_DECL tvec3(A const & a, B const & b, C const & c);
128  template <typename A, typename B, typename C>
129  GLM_FUNC_DECL tvec3(tvec1<A, P> const & a, tvec1<B, P> const & b, tvec1<C, P> const & c);
130 
131  // -- Conversion vector constructors --
132 
134  template <typename A, typename B, precision Q>
135  GLM_FUNC_DECL explicit tvec3(tvec2<A, Q> const & a, B const & b);
137  template <typename A, typename B, precision Q>
138  GLM_FUNC_DECL explicit tvec3(tvec2<A, Q> const & a, tvec1<B, Q> const & b);
140  template <typename A, typename B, precision Q>
141  GLM_FUNC_DECL explicit tvec3(A const & a, tvec2<B, Q> const & b);
143  template <typename A, typename B, precision Q>
144  GLM_FUNC_DECL explicit tvec3(tvec1<A, Q> const & a, tvec2<B, Q> const & b);
146  template <typename U, precision Q>
147  GLM_FUNC_DECL explicit tvec3(tvec4<U, Q> const & v);
148 
150  template <typename U, precision Q>
151  GLM_FUNC_DECL GLM_EXPLICIT tvec3(tvec3<U, Q> const & v);
152 
153  // -- Swizzle constructors --
154 
155 # if GLM_HAS_ANONYMOUS_UNION && defined(GLM_SWIZZLE)
156  template <int E0, int E1, int E2>
157  GLM_FUNC_DECL tvec3(detail::_swizzle<3, T, P, tvec3<T, P>, E0, E1, E2, -1> const & that)
158  {
159  *this = that();
160  }
161 
162  template <int E0, int E1>
163  GLM_FUNC_DECL tvec3(detail::_swizzle<2, T, P, tvec2<T, P>, E0, E1, -1, -2> const & v, T const & s)
164  {
165  *this = tvec3<T, P>(v(), s);
166  }
167 
168  template <int E0, int E1>
169  GLM_FUNC_DECL tvec3(T const & s, detail::_swizzle<2, T, P, tvec2<T, P>, E0, E1, -1, -2> const & v)
170  {
171  *this = tvec3<T, P>(s, v());
172  }
173 # endif// GLM_HAS_ANONYMOUS_UNION && defined(GLM_SWIZZLE)
174 
175  // -- Unary arithmetic operators --
176 
177  GLM_FUNC_DECL tvec3<T, P> & operator=(tvec3<T, P> const & v) GLM_DEFAULT;
178 
179  template <typename U>
180  GLM_FUNC_DECL tvec3<T, P> & operator=(tvec3<U, P> const & v);
181  template <typename U>
182  GLM_FUNC_DECL tvec3<T, P> & operator+=(U s);
183  template <typename U>
184  GLM_FUNC_DECL tvec3<T, P> & operator+=(tvec1<U, P> const & v);
185  template <typename U>
186  GLM_FUNC_DECL tvec3<T, P> & operator+=(tvec3<U, P> const & v);
187  template <typename U>
188  GLM_FUNC_DECL tvec3<T, P> & operator-=(U s);
189  template <typename U>
190  GLM_FUNC_DECL tvec3<T, P> & operator-=(tvec1<U, P> const & v);
191  template <typename U>
192  GLM_FUNC_DECL tvec3<T, P> & operator-=(tvec3<U, P> const & v);
193  template <typename U>
194  GLM_FUNC_DECL tvec3<T, P> & operator*=(U s);
195  template <typename U>
196  GLM_FUNC_DECL tvec3<T, P> & operator*=(tvec1<U, P> const & v);
197  template <typename U>
198  GLM_FUNC_DECL tvec3<T, P> & operator*=(tvec3<U, P> const & v);
199  template <typename U>
200  GLM_FUNC_DECL tvec3<T, P> & operator/=(U s);
201  template <typename U>
202  GLM_FUNC_DECL tvec3<T, P> & operator/=(tvec1<U, P> const & v);
203  template <typename U>
204  GLM_FUNC_DECL tvec3<T, P> & operator/=(tvec3<U, P> const & v);
205 
206  // -- Increment and decrement operators --
207 
208  GLM_FUNC_DECL tvec3<T, P> & operator++();
209  GLM_FUNC_DECL tvec3<T, P> & operator--();
210  GLM_FUNC_DECL tvec3<T, P> operator++(int);
211  GLM_FUNC_DECL tvec3<T, P> operator--(int);
212 
213  // -- Unary bit operators --
214 
215  template <typename U>
216  GLM_FUNC_DECL tvec3<T, P> & operator%=(U s);
217  template <typename U>
218  GLM_FUNC_DECL tvec3<T, P> & operator%=(tvec1<U, P> const & v);
219  template <typename U>
220  GLM_FUNC_DECL tvec3<T, P> & operator%=(tvec3<U, P> const & v);
221  template <typename U>
222  GLM_FUNC_DECL tvec3<T, P> & operator&=(U s);
223  template <typename U>
224  GLM_FUNC_DECL tvec3<T, P> & operator&=(tvec1<U, P> const & v);
225  template <typename U>
226  GLM_FUNC_DECL tvec3<T, P> & operator&=(tvec3<U, P> const & v);
227  template <typename U>
228  GLM_FUNC_DECL tvec3<T, P> & operator|=(U s);
229  template <typename U>
230  GLM_FUNC_DECL tvec3<T, P> & operator|=(tvec1<U, P> const & v);
231  template <typename U>
232  GLM_FUNC_DECL tvec3<T, P> & operator|=(tvec3<U, P> const & v);
233  template <typename U>
234  GLM_FUNC_DECL tvec3<T, P> & operator^=(U s);
235  template <typename U>
236  GLM_FUNC_DECL tvec3<T, P> & operator^=(tvec1<U, P> const & v);
237  template <typename U>
238  GLM_FUNC_DECL tvec3<T, P> & operator^=(tvec3<U, P> const & v);
239  template <typename U>
240  GLM_FUNC_DECL tvec3<T, P> & operator<<=(U s);
241  template <typename U>
242  GLM_FUNC_DECL tvec3<T, P> & operator<<=(tvec1<U, P> const & v);
243  template <typename U>
244  GLM_FUNC_DECL tvec3<T, P> & operator<<=(tvec3<U, P> const & v);
245  template <typename U>
246  GLM_FUNC_DECL tvec3<T, P> & operator>>=(U s);
247  template <typename U>
248  GLM_FUNC_DECL tvec3<T, P> & operator>>=(tvec1<U, P> const & v);
249  template <typename U>
250  GLM_FUNC_DECL tvec3<T, P> & operator>>=(tvec3<U, P> const & v);
251  };
252 
253  // -- Unary operators --
254 
255  template <typename T, precision P>
256  GLM_FUNC_DECL tvec3<T, P> operator-(tvec3<T, P> const & v);
257 
258  // -- Binary operators --
259 
260  template <typename T, precision P>
261  GLM_FUNC_DECL tvec3<T, P> operator+(tvec3<T, P> const & v, T const & s);
262 
263  template <typename T, precision P>
264  GLM_FUNC_DECL tvec3<T, P> operator+(tvec3<T, P> const & v, tvec1<T, P> const & s);
265 
266  template <typename T, precision P>
267  GLM_FUNC_DECL tvec3<T, P> operator+(T const & s, tvec3<T, P> const & v);
268 
269  template <typename T, precision P>
270  GLM_FUNC_DECL tvec3<T, P> operator+(tvec1<T, P> const & s, tvec3<T, P> const & v);
271 
272  template <typename T, precision P>
273  GLM_FUNC_DECL tvec3<T, P> operator+(tvec3<T, P> const & v1, tvec3<T, P> const & v2);
274 
275  template <typename T, precision P>
276  GLM_FUNC_DECL tvec3<T, P> operator-(tvec3<T, P> const & v, T const & s);
277 
278  template <typename T, precision P>
279  GLM_FUNC_DECL tvec3<T, P> operator-(tvec3<T, P> const & v, tvec1<T, P> const & s);
280 
281  template <typename T, precision P>
282  GLM_FUNC_DECL tvec3<T, P> operator-(T const & s, tvec3<T, P> const & v);
283 
284  template <typename T, precision P>
285  GLM_FUNC_DECL tvec3<T, P> operator-(tvec1<T, P> const & s, tvec3<T, P> const & v);
286 
287  template <typename T, precision P>
288  GLM_FUNC_DECL tvec3<T, P> operator-(tvec3<T, P> const & v1, tvec3<T, P> const & v2);
289 
290  template <typename T, precision P>
291  GLM_FUNC_DECL tvec3<T, P> operator*(tvec3<T, P> const & v, T const & s);
292 
293  template <typename T, precision P>
294  GLM_FUNC_DECL tvec3<T, P> operator*(tvec3<T, P> const & v, tvec1<T, P> const & s);
295 
296  template <typename T, precision P>
297  GLM_FUNC_DECL tvec3<T, P> operator*(T const & s, tvec3<T, P> const & v);
298 
299  template <typename T, precision P>
300  GLM_FUNC_DECL tvec3<T, P> operator*(tvec1<T, P> const & s, tvec3<T, P> const & v);
301 
302  template <typename T, precision P>
303  GLM_FUNC_DECL tvec3<T, P> operator*(tvec3<T, P> const & v1, tvec3<T, P> const & v2);
304 
305  template <typename T, precision P>
306  GLM_FUNC_DECL tvec3<T, P> operator/(tvec3<T, P> const & v, T const & s);
307 
308  template <typename T, precision P>
309  GLM_FUNC_DECL tvec3<T, P> operator/(tvec3<T, P> const & v, tvec1<T, P> const & s);
310 
311  template <typename T, precision P>
312  GLM_FUNC_DECL tvec3<T, P> operator/(T const & s, tvec3<T, P> const & v);
313 
314  template <typename T, precision P>
315  GLM_FUNC_DECL tvec3<T, P> operator/(tvec1<T, P> const & s, tvec3<T, P> const & v);
316 
317  template <typename T, precision P>
318  GLM_FUNC_DECL tvec3<T, P> operator/(tvec3<T, P> const & v1, tvec3<T, P> const & v2);
319 
320  template <typename T, precision P>
321  GLM_FUNC_DECL tvec3<T, P> operator%(tvec3<T, P> const & v, T const & s);
322 
323  template <typename T, precision P>
324  GLM_FUNC_DECL tvec3<T, P> operator%(tvec3<T, P> const & v, tvec1<T, P> const & s);
325 
326  template <typename T, precision P>
327  GLM_FUNC_DECL tvec3<T, P> operator%(T const & s, tvec3<T, P> const & v);
328 
329  template <typename T, precision P>
330  GLM_FUNC_DECL tvec3<T, P> operator%(tvec1<T, P> const & s, tvec3<T, P> const & v);
331 
332  template <typename T, precision P>
333  GLM_FUNC_DECL tvec3<T, P> operator%(tvec3<T, P> const & v1, tvec3<T, P> const & v2);
334 
335  template <typename T, precision P>
336  GLM_FUNC_DECL tvec3<T, P> operator&(tvec3<T, P> const & v, T const & s);
337 
338  template <typename T, precision P>
339  GLM_FUNC_DECL tvec3<T, P> operator&(tvec3<T, P> const & v, tvec1<T, P> const & s);
340 
341  template <typename T, precision P>
342  GLM_FUNC_DECL tvec3<T, P> operator&(T const & s, tvec3<T, P> const & v);
343 
344  template <typename T, precision P>
345  GLM_FUNC_DECL tvec3<T, P> operator&(tvec1<T, P> const & s, tvec3<T, P> const & v);
346 
347  template <typename T, precision P>
348  GLM_FUNC_DECL tvec3<T, P> operator&(tvec3<T, P> const & v1, tvec3<T, P> const & v2);
349 
350  template <typename T, precision P>
351  GLM_FUNC_DECL tvec3<T, P> operator|(tvec3<T, P> const & v, T const & s);
352 
353  template <typename T, precision P>
354  GLM_FUNC_DECL tvec3<T, P> operator|(tvec3<T, P> const & v, tvec1<T, P> const & s);
355 
356  template <typename T, precision P>
357  GLM_FUNC_DECL tvec3<T, P> operator|(T const & s, tvec3<T, P> const & v);
358 
359  template <typename T, precision P>
360  GLM_FUNC_DECL tvec3<T, P> operator|(tvec1<T, P> const & s, tvec3<T, P> const & v);
361 
362  template <typename T, precision P>
363  GLM_FUNC_DECL tvec3<T, P> operator|(tvec3<T, P> const & v1, tvec3<T, P> const & v2);
364 
365  template <typename T, precision P>
366  GLM_FUNC_DECL tvec3<T, P> operator^(tvec3<T, P> const & v, T const & s);
367 
368  template <typename T, precision P>
369  GLM_FUNC_DECL tvec3<T, P> operator^(tvec3<T, P> const & v, tvec1<T, P> const & s);
370 
371  template <typename T, precision P>
372  GLM_FUNC_DECL tvec3<T, P> operator^(T const & s, tvec3<T, P> const & v);
373 
374  template <typename T, precision P>
375  GLM_FUNC_DECL tvec3<T, P> operator^(tvec1<T, P> const & s, tvec3<T, P> const & v);
376 
377  template <typename T, precision P>
378  GLM_FUNC_DECL tvec3<T, P> operator^(tvec3<T, P> const & v1, tvec3<T, P> const & v2);
379 
380  template <typename T, precision P>
381  GLM_FUNC_DECL tvec3<T, P> operator<<(tvec3<T, P> const & v, T const & s);
382 
383  template <typename T, precision P>
384  GLM_FUNC_DECL tvec3<T, P> operator<<(tvec3<T, P> const & v, tvec1<T, P> const & s);
385 
386  template <typename T, precision P>
387  GLM_FUNC_DECL tvec3<T, P> operator<<(T const & s, tvec3<T, P> const & v);
388 
389  template <typename T, precision P>
390  GLM_FUNC_DECL tvec3<T, P> operator<<(tvec1<T, P> const & s, tvec3<T, P> const & v);
391 
392  template <typename T, precision P>
393  GLM_FUNC_DECL tvec3<T, P> operator<<(tvec3<T, P> const & v1, tvec3<T, P> const & v2);
394 
395  template <typename T, precision P>
396  GLM_FUNC_DECL tvec3<T, P> operator>>(tvec3<T, P> const & v, T const & s);
397 
398  template <typename T, precision P>
399  GLM_FUNC_DECL tvec3<T, P> operator>>(tvec3<T, P> const & v, tvec1<T, P> const & s);
400 
401  template <typename T, precision P>
402  GLM_FUNC_DECL tvec3<T, P> operator>>(T const & s, tvec3<T, P> const & v);
403 
404  template <typename T, precision P>
405  GLM_FUNC_DECL tvec3<T, P> operator>>(tvec1<T, P> const & s, tvec3<T, P> const & v);
406 
407  template <typename T, precision P>
408  GLM_FUNC_DECL tvec3<T, P> operator>>(tvec3<T, P> const & v1, tvec3<T, P> const & v2);
409 
410  template <typename T, precision P>
411  GLM_FUNC_DECL tvec3<T, P> operator~(tvec3<T, P> const & v);
412 
413  // -- Boolean operators --
414 
415  template <typename T, precision P>
416  GLM_FUNC_DECL bool operator==(tvec3<T, P> const & v1, tvec3<T, P> const & v2);
417 
418  template <typename T, precision P>
419  GLM_FUNC_DECL bool operator!=(tvec3<T, P> const & v1, tvec3<T, P> const & v2);
420 }//namespace glm
421 
422 #ifndef GLM_EXTERNAL_TEMPLATE
423 #include "type_vec3.inl"
424 #endif//GLM_EXTERNAL_TEMPLATE
GLM_FUNC_DECL T length(vecType< T, P > const &x)
Returns the length of x, i.e., sqrt(x * x).
Definition: _noise.hpp:40
OpenGL Mathematics (glm.g-truc.net)
OpenGL Mathematics (glm.g-truc.net)
OpenGL Mathematics (glm.g-truc.net)