| 0.9.9 API documenation

- Main Page
- Modules
- Files

- File List

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