goat3d

view libs/vmath/vector.h @ 55:af1310ed212b

find changesets by author, revision, files, or words in the commit message
not done yet
author John Tsiombikas <nuclear@member.fsf.org>
date Sun, 19 Jan 2014 14:56:44 +0200
parents 4deb0b12fe14
children
line source
1 /*
2 libvmath - a vector math library
3 Copyright (C) 2004-2011 John Tsiombikas <nuclear@member.fsf.org>
4
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published
7 by the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
17 */
18
19 #ifndef VMATH_VECTOR_H_
20 #define VMATH_VECTOR_H_
21
22 #include <stdio.h>
23 #include "vmath_types.h"
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif /* __cplusplus */
28
29 /* C 2D vector functions */
30 static VMATH_INLINE vec2_t v2_cons(scalar_t x, scalar_t y);
31 static VMATH_INLINE void v2_print(FILE *fp, vec2_t v);
32
33 static VMATH_INLINE vec2_t v2_add(vec2_t v1, vec2_t v2);
34 static VMATH_INLINE vec2_t v2_sub(vec2_t v1, vec2_t v2);
35 static VMATH_INLINE vec2_t v2_scale(vec2_t v, scalar_t s);
36 static VMATH_INLINE scalar_t v2_dot(vec2_t v1, vec2_t v2);
37 static VMATH_INLINE scalar_t v2_length(vec2_t v);
38 static VMATH_INLINE scalar_t v2_length_sq(vec2_t v);
39 static VMATH_INLINE vec2_t v2_normalize(vec2_t v);
40
41 static VMATH_INLINE vec2_t v2_lerp(vec2_t v1, vec2_t v2, scalar_t t);
42
43 /* C 3D vector functions */
44 static VMATH_INLINE vec3_t v3_cons(scalar_t x, scalar_t y, scalar_t z);
45 static VMATH_INLINE void v3_print(FILE *fp, vec3_t v);
46
47 static VMATH_INLINE vec3_t v3_add(vec3_t v1, vec3_t v2);
48 static VMATH_INLINE vec3_t v3_sub(vec3_t v1, vec3_t v2);
49 static VMATH_INLINE vec3_t v3_neg(vec3_t v);
50 static VMATH_INLINE vec3_t v3_mul(vec3_t v1, vec3_t v2);
51 static VMATH_INLINE vec3_t v3_scale(vec3_t v1, scalar_t s);
52 static VMATH_INLINE scalar_t v3_dot(vec3_t v1, vec3_t v2);
53 static VMATH_INLINE vec3_t v3_cross(vec3_t v1, vec3_t v2);
54 static VMATH_INLINE scalar_t v3_length(vec3_t v);
55 static VMATH_INLINE scalar_t v3_length_sq(vec3_t v);
56 static VMATH_INLINE vec3_t v3_normalize(vec3_t v);
57 static VMATH_INLINE vec3_t v3_transform(vec3_t v, mat4_t m);
58
59 static VMATH_INLINE vec3_t v3_rotate(vec3_t v, scalar_t x, scalar_t y, scalar_t z);
60 static VMATH_INLINE vec3_t v3_rotate_axis(vec3_t v, scalar_t angle, scalar_t x, scalar_t y, scalar_t z);
61 static VMATH_INLINE vec3_t v3_rotate_quat(vec3_t v, quat_t q);
62
63 static VMATH_INLINE vec3_t v3_reflect(vec3_t v, vec3_t n);
64
65 static VMATH_INLINE vec3_t v3_lerp(vec3_t v1, vec3_t v2, scalar_t t);
66
67 /* C 4D vector functions */
68 static VMATH_INLINE vec4_t v4_cons(scalar_t x, scalar_t y, scalar_t z, scalar_t w);
69 static VMATH_INLINE void v4_print(FILE *fp, vec4_t v);
70
71 static VMATH_INLINE vec4_t v4_add(vec4_t v1, vec4_t v2);
72 static VMATH_INLINE vec4_t v4_sub(vec4_t v1, vec4_t v2);
73 static VMATH_INLINE vec4_t v4_neg(vec4_t v);
74 static VMATH_INLINE vec4_t v4_mul(vec4_t v1, vec4_t v2);
75 static VMATH_INLINE vec4_t v4_scale(vec4_t v, scalar_t s);
76 static VMATH_INLINE scalar_t v4_dot(vec4_t v1, vec4_t v2);
77 static VMATH_INLINE scalar_t v4_length(vec4_t v);
78 static VMATH_INLINE scalar_t v4_length_sq(vec4_t v);
79 static VMATH_INLINE vec4_t v4_normalize(vec4_t v);
80 static VMATH_INLINE vec4_t v4_transform(vec4_t v, mat4_t m);
81
82 #ifdef __cplusplus
83 } /* extern "C" */
84
85 /* when included from C++ source files, also define the vector classes */
86 #include <iostream>
87
88 /** 2D Vector */
89 class Vector2 {
90 public:
91 scalar_t x, y;
92
93 Vector2(scalar_t x = 0.0, scalar_t y = 0.0);
94 Vector2(const vec2_t &vec);
95 Vector2(const Vector3 &vec);
96 Vector2(const Vector4 &vec);
97
98 VMATH_INLINE scalar_t &operator [](int elem);
99 VMATH_INLINE const scalar_t &operator [](int elem) const;
100
101 VMATH_INLINE scalar_t length() const;
102 VMATH_INLINE scalar_t length_sq() const;
103 void normalize();
104 Vector2 normalized() const;
105
106 void transform(const Matrix3x3 &mat);
107 Vector2 transformed(const Matrix3x3 &mat) const;
108
109 void rotate(scalar_t angle);
110 Vector2 rotated(scalar_t angle) const;
111
112 Vector2 reflection(const Vector2 &normal) const;
113 Vector2 refraction(const Vector2 &normal, scalar_t src_ior, scalar_t dst_ior) const;
114 };
115
116 /* unary operations */
117 VMATH_INLINE Vector2 operator -(const Vector2 &vec);
118
119 /* binary vector (op) vector operations */
120 VMATH_INLINE scalar_t dot_product(const Vector2 &v1, const Vector2 &v2);
121
122 VMATH_INLINE Vector2 operator +(const Vector2 &v1, const Vector2 &v2);
123 VMATH_INLINE Vector2 operator -(const Vector2 &v1, const Vector2 &v2);
124 VMATH_INLINE Vector2 operator *(const Vector2 &v1, const Vector2 &v2);
125 VMATH_INLINE Vector2 operator /(const Vector2 &v1, const Vector2 &v2);
126 VMATH_INLINE bool operator ==(const Vector2 &v1, const Vector2 &v2);
127
128 VMATH_INLINE void operator +=(Vector2 &v1, const Vector2 &v2);
129 VMATH_INLINE void operator -=(Vector2 &v1, const Vector2 &v2);
130 VMATH_INLINE void operator *=(Vector2 &v1, const Vector2 &v2);
131 VMATH_INLINE void operator /=(Vector2 &v1, const Vector2 &v2);
132
133 /* binary vector (op) scalar and scalar (op) vector operations */
134 VMATH_INLINE Vector2 operator +(const Vector2 &vec, scalar_t scalar);
135 VMATH_INLINE Vector2 operator +(scalar_t scalar, const Vector2 &vec);
136 VMATH_INLINE Vector2 operator -(const Vector2 &vec, scalar_t scalar);
137 VMATH_INLINE Vector2 operator *(const Vector2 &vec, scalar_t scalar);
138 VMATH_INLINE Vector2 operator *(scalar_t scalar, const Vector2 &vec);
139 VMATH_INLINE Vector2 operator /(const Vector2 &vec, scalar_t scalar);
140
141 VMATH_INLINE void operator +=(Vector2 &vec, scalar_t scalar);
142 VMATH_INLINE void operator -=(Vector2 &vec, scalar_t scalar);
143 VMATH_INLINE void operator *=(Vector2 &vec, scalar_t scalar);
144 VMATH_INLINE void operator /=(Vector2 &vec, scalar_t scalar);
145
146 std::ostream &operator <<(std::ostream &out, const Vector2 &vec);
147
148 VMATH_INLINE Vector2 lerp(const Vector2 &a, const Vector2 &b, scalar_t t);
149 VMATH_INLINE Vector2 catmull_rom_spline(const Vector2 &v0, const Vector2 &v1,
150 const Vector2 &v2, const Vector2 &v3, scalar_t t);
151
152 /* 3D Vector */
153 class Vector3 {
154 public:
155 scalar_t x, y, z;
156
157 Vector3(scalar_t x = 0.0, scalar_t y = 0.0, scalar_t z = 0.0);
158 Vector3(const vec3_t &vec);
159 Vector3(const Vector2 &vec);
160 Vector3(const Vector4 &vec);
161 Vector3(const SphVector &sph);
162
163 Vector3 &operator =(const SphVector &sph);
164
165 VMATH_INLINE scalar_t &operator [](int elem);
166 VMATH_INLINE const scalar_t &operator [](int elem) const;
167
168 VMATH_INLINE scalar_t length() const;
169 VMATH_INLINE scalar_t length_sq() const;
170 void normalize();
171 Vector3 normalized() const;
172
173 void transform(const Matrix3x3 &mat);
174 Vector3 transformed(const Matrix3x3 &mat) const;
175 void transform(const Matrix4x4 &mat);
176 Vector3 transformed(const Matrix4x4 &mat) const;
177 void transform(const Quaternion &quat);
178 Vector3 transformed(const Quaternion &quat) const;
179
180 void rotate(const Vector3 &euler);
181 Vector3 rotated(const Vector3 &euler) const;
182
183 Vector3 reflection(const Vector3 &normal) const;
184 Vector3 refraction(const Vector3 &normal, scalar_t src_ior, scalar_t dst_ior) const;
185 Vector3 refraction(const Vector3 &normal, scalar_t ior) const;
186 };
187
188 /* unary operations */
189 VMATH_INLINE Vector3 operator -(const Vector3 &vec);
190
191 /* binary vector (op) vector operations */
192 VMATH_INLINE scalar_t dot_product(const Vector3 &v1, const Vector3 &v2);
193 VMATH_INLINE Vector3 cross_product(const Vector3 &v1, const Vector3 &v2);
194
195 VMATH_INLINE Vector3 operator +(const Vector3 &v1, const Vector3 &v2);
196 VMATH_INLINE Vector3 operator -(const Vector3 &v1, const Vector3 &v2);
197 VMATH_INLINE Vector3 operator *(const Vector3 &v1, const Vector3 &v2);
198 VMATH_INLINE Vector3 operator /(const Vector3 &v1, const Vector3 &v2);
199 VMATH_INLINE bool operator ==(const Vector3 &v1, const Vector3 &v2);
200
201 VMATH_INLINE void operator +=(Vector3 &v1, const Vector3 &v2);
202 VMATH_INLINE void operator -=(Vector3 &v1, const Vector3 &v2);
203 VMATH_INLINE void operator *=(Vector3 &v1, const Vector3 &v2);
204 VMATH_INLINE void operator /=(Vector3 &v1, const Vector3 &v2);
205
206 /* binary vector (op) scalar and scalar (op) vector operations */
207 VMATH_INLINE Vector3 operator +(const Vector3 &vec, scalar_t scalar);
208 VMATH_INLINE Vector3 operator +(scalar_t scalar, const Vector3 &vec);
209 VMATH_INLINE Vector3 operator -(const Vector3 &vec, scalar_t scalar);
210 VMATH_INLINE Vector3 operator *(const Vector3 &vec, scalar_t scalar);
211 VMATH_INLINE Vector3 operator *(scalar_t scalar, const Vector3 &vec);
212 VMATH_INLINE Vector3 operator /(const Vector3 &vec, scalar_t scalar);
213
214 VMATH_INLINE void operator +=(Vector3 &vec, scalar_t scalar);
215 VMATH_INLINE void operator -=(Vector3 &vec, scalar_t scalar);
216 VMATH_INLINE void operator *=(Vector3 &vec, scalar_t scalar);
217 VMATH_INLINE void operator /=(Vector3 &vec, scalar_t scalar);
218
219 std::ostream &operator <<(std::ostream &out, const Vector3 &vec);
220
221 VMATH_INLINE Vector3 lerp(const Vector3 &a, const Vector3 &b, scalar_t t);
222 VMATH_INLINE Vector3 catmull_rom_spline(const Vector3 &v0, const Vector3 &v1,
223 const Vector3 &v2, const Vector3 &v3, scalar_t t);
224
225 /* 4D Vector */
226 class Vector4 {
227 public:
228 scalar_t x, y, z, w;
229
230 Vector4(scalar_t x = 0.0, scalar_t y = 0.0, scalar_t z = 0.0, scalar_t w = 0.0);
231 Vector4(const vec4_t &vec);
232 Vector4(const Vector2 &vec);
233 Vector4(const Vector3 &vec);
234
235 VMATH_INLINE scalar_t &operator [](int elem);
236 VMATH_INLINE const scalar_t &operator [](int elem) const;
237
238 VMATH_INLINE scalar_t length() const;
239 VMATH_INLINE scalar_t length_sq() const;
240 void normalize();
241 Vector4 normalized() const;
242
243 void transform(const Matrix4x4 &mat);
244 Vector4 transformed(const Matrix4x4 &mat) const;
245
246 Vector4 reflection(const Vector4 &normal) const;
247 Vector4 refraction(const Vector4 &normal, scalar_t src_ior, scalar_t dst_ior) const;
248 };
249
250
251 /* unary operations */
252 VMATH_INLINE Vector4 operator -(const Vector4 &vec);
253
254 /* binary vector (op) vector operations */
255 VMATH_INLINE scalar_t dot_product(const Vector4 &v1, const Vector4 &v2);
256 VMATH_INLINE Vector4 cross_product(const Vector4 &v1, const Vector4 &v2, const Vector4 &v3);
257
258 VMATH_INLINE Vector4 operator +(const Vector4 &v1, const Vector4 &v2);
259 VMATH_INLINE Vector4 operator -(const Vector4 &v1, const Vector4 &v2);
260 VMATH_INLINE Vector4 operator *(const Vector4 &v1, const Vector4 &v2);
261 VMATH_INLINE Vector4 operator /(const Vector4 &v1, const Vector4 &v2);
262 VMATH_INLINE bool operator ==(const Vector4 &v1, const Vector4 &v2);
263
264 VMATH_INLINE void operator +=(Vector4 &v1, const Vector4 &v2);
265 VMATH_INLINE void operator -=(Vector4 &v1, const Vector4 &v2);
266 VMATH_INLINE void operator *=(Vector4 &v1, const Vector4 &v2);
267 VMATH_INLINE void operator /=(Vector4 &v1, const Vector4 &v2);
268
269 /* binary vector (op) scalar and scalar (op) vector operations */
270 VMATH_INLINE Vector4 operator +(const Vector4 &vec, scalar_t scalar);
271 VMATH_INLINE Vector4 operator +(scalar_t scalar, const Vector4 &vec);
272 VMATH_INLINE Vector4 operator -(const Vector4 &vec, scalar_t scalar);
273 VMATH_INLINE Vector4 operator *(const Vector4 &vec, scalar_t scalar);
274 VMATH_INLINE Vector4 operator *(scalar_t scalar, const Vector4 &vec);
275 VMATH_INLINE Vector4 operator /(const Vector4 &vec, scalar_t scalar);
276
277 VMATH_INLINE void operator +=(Vector4 &vec, scalar_t scalar);
278 VMATH_INLINE void operator -=(Vector4 &vec, scalar_t scalar);
279 VMATH_INLINE void operator *=(Vector4 &vec, scalar_t scalar);
280 VMATH_INLINE void operator /=(Vector4 &vec, scalar_t scalar);
281
282 std::ostream &operator <<(std::ostream &out, const Vector4 &vec);
283
284 VMATH_INLINE Vector4 lerp(const Vector4 &v0, const Vector4 &v1, scalar_t t);
285 VMATH_INLINE Vector4 catmull_rom_spline(const Vector4 &v0, const Vector4 &v1,
286 const Vector4 &v2, const Vector4 &v3, scalar_t t);
287
288 #endif /* __cplusplus */
289
290 #include "vector.inl"
291
292 #endif /* VMATH_VECTOR_H_ */