7576fbe2b5451403aec04c37bb7d9f5300b91b2c
[blender.git] / source / blender / blenlib / BLI_math_vector.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: some of this file.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  * */
25
26 #ifndef __BLI_MATH_VECTOR_H__
27 #define __BLI_MATH_VECTOR_H__
28
29 /** \file BLI_math_vector.h
30  *  \ingroup bli
31  */
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 #include "BLI_compiler_attrs.h"
38 #include "BLI_math_inline.h"
39
40 /************************************* Init ***********************************/
41
42 #ifdef BLI_MATH_GCC_WARN_PRAGMA
43 #  pragma GCC diagnostic push
44 #  pragma GCC diagnostic ignored "-Wredundant-decls"
45 #endif
46
47
48 MINLINE void zero_v2(float r[2]);
49 MINLINE void zero_v3(float r[3]);
50 MINLINE void zero_v4(float r[4]);
51
52 MINLINE void copy_v2_v2(float r[2], const float a[2]);
53 MINLINE void copy_v3_v3(float r[3], const float a[3]);
54 MINLINE void copy_v4_v4(float r[4], const float a[4]);
55
56 MINLINE void copy_v2_fl(float r[2], float f);
57 MINLINE void copy_v3_fl(float r[3], float f);
58 MINLINE void copy_v4_fl(float r[4], float f);
59
60 MINLINE void swap_v2_v2(float a[2], float b[2]);
61 MINLINE void swap_v3_v3(float a[3], float b[3]);
62 MINLINE void swap_v4_v4(float a[4], float b[4]);
63
64 /* char */
65 MINLINE void copy_v2_v2_char(char r[2], const char a[2]);
66 MINLINE void copy_v3_v3_char(char r[3], const char a[3]);
67 MINLINE void copy_v4_v4_char(char r[4], const char a[4]);
68 /* short */
69 MINLINE void copy_v2_v2_short(short r[2], const short a[2]);
70 MINLINE void copy_v3_v3_short(short r[3], const short a[3]);
71 MINLINE void copy_v4_v4_short(short r[4], const short a[4]);
72 /* int */
73 MINLINE void zero_v3_int(int r[3]);
74 MINLINE void copy_v2_v2_int(int r[2], const int a[2]);
75 MINLINE void copy_v3_v3_int(int r[3], const int a[3]);
76 MINLINE void copy_v4_v4_int(int r[4], const int a[4]);
77 /* double -> float */
78 MINLINE void copy_v2fl_v2db(float r[2], const double a[2]);
79 MINLINE void copy_v3fl_v3db(float r[3], const double a[3]);
80 MINLINE void copy_v4fl_v4db(float r[4], const double a[4]);
81 /* float -> double */
82 MINLINE void copy_v2db_v2fl(double r[2], const float a[2]);
83 MINLINE void copy_v3db_v3fl(double r[3], const float a[3]);
84 MINLINE void copy_v4db_v4fl(double r[4], const float a[4]);
85 /* 3 float -> vec */
86 MINLINE void copy_v3_fl3(float v[3], float x, float y, float z);
87
88 /********************************* Arithmetic ********************************/
89
90 MINLINE void add_v2_fl(float r[2], float f);
91 MINLINE void add_v3_fl(float r[3], float f);
92 MINLINE void add_v4_fl(float r[4], float f);
93 MINLINE void add_v2_v2(float r[2], const float a[2]);
94 MINLINE void add_v2_v2v2(float r[2], const float a[2], const float b[2]);
95 MINLINE void add_v2_v2v2_int(int r[2], const int a[2], const int b[2]);
96 MINLINE void add_v3_v3(float r[3], const float a[3]);
97 MINLINE void add_v3_v3v3(float r[3], const float a[3], const float b[3]);
98 MINLINE void add_v4_v4(float r[4], const float a[4]);
99 MINLINE void add_v4_v4v4(float r[4], const float a[4], const float b[4]);
100
101 MINLINE void sub_v2_v2(float r[2], const float a[2]);
102 MINLINE void sub_v2_v2v2(float r[2], const float a[2], const float b[2]);
103 MINLINE void sub_v2_v2v2_int(int r[2], const int a[2], const int b[2]);
104 MINLINE void sub_v3_v3(float r[3], const float a[3]);
105 MINLINE void sub_v3_v3v3(float r[3], const float a[3], const float b[3]);
106 MINLINE void sub_v4_v4(float r[4], const float a[4]);
107 MINLINE void sub_v4_v4v4(float r[4], const float a[4], const float b[4]);
108
109 MINLINE void mul_v2_fl(float r[2], float f);
110 MINLINE void mul_v2_v2fl(float r[2], const float a[2], float f);
111 MINLINE void mul_v3_fl(float r[3], float f);
112 MINLINE void mul_v3_v3fl(float r[3], const float a[3], float f);
113 MINLINE void mul_v2_v2(float r[2], const float a[2]);
114 MINLINE void mul_v3_v3(float r[3], const float a[3]);
115 MINLINE void mul_v3_v3v3(float r[3], const float a[3], const float b[3]);
116 MINLINE void mul_v4_fl(float r[4], float f);
117 MINLINE void mul_v4_v4fl(float r[3], const float a[3], float f);
118 MINLINE float mul_project_m4_v3_zfac(float mat[4][4], const float co[3]) ATTR_WARN_UNUSED_RESULT;
119 MINLINE float dot_m3_v3_row_x(float M[3][3], const float a[3]) ATTR_WARN_UNUSED_RESULT;
120 MINLINE float dot_m3_v3_row_y(float M[3][3], const float a[3]) ATTR_WARN_UNUSED_RESULT;
121 MINLINE float dot_m3_v3_row_z(float M[3][3], const float a[3]) ATTR_WARN_UNUSED_RESULT;
122
123 MINLINE void madd_v3_v3fl(float r[3], const float a[3], float f);
124 MINLINE void madd_v3_v3v3(float r[3], const float a[3], const float b[3]);
125 MINLINE void madd_v2_v2v2fl(float r[2], const float a[2], const float b[2], float f);
126 MINLINE void madd_v3_v3v3fl(float r[3], const float a[3], const float b[3], float f);
127 MINLINE void madd_v3_v3v3v3(float r[3], const float a[3], const float b[3], const float c[3]);
128 MINLINE void madd_v4_v4fl(float r[4], const float a[4], float f);
129 MINLINE void madd_v4_v4v4(float r[4], const float a[4], const float b[4]);
130
131 MINLINE void negate_v2(float r[2]);
132 MINLINE void negate_v2_v2(float r[2], const float a[2]);
133 MINLINE void negate_v3(float r[3]);
134 MINLINE void negate_v3_v3(float r[3], const float a[3]);
135 MINLINE void negate_v4(float r[4]);
136 MINLINE void negate_v4_v4(float r[4], const float a[3]);
137
138 MINLINE void negate_v3_short(short r[3]);
139
140 MINLINE float dot_v2v2(const float a[2], const float b[2]) ATTR_WARN_UNUSED_RESULT;
141 MINLINE float dot_v3v3(const float a[3], const float b[3]) ATTR_WARN_UNUSED_RESULT;
142
143 MINLINE float cross_v2v2(const float a[2], const float b[2]) ATTR_WARN_UNUSED_RESULT;
144 MINLINE void cross_v3_v3v3(float r[3], const float a[3], const float b[3]);
145
146 MINLINE void add_newell_cross_v3_v3v3(float n[3], const float v_prev[3], const float v_curr[3]);
147
148 MINLINE void star_m3_v3(float rmat[3][3], float a[3]);
149
150 /*********************************** Length **********************************/
151
152 MINLINE float len_squared_v2(const float v[2]) ATTR_WARN_UNUSED_RESULT;
153 MINLINE float len_squared_v3(const float v[3]) ATTR_WARN_UNUSED_RESULT;
154 MINLINE float len_manhattan_v2(const float v[2]) ATTR_WARN_UNUSED_RESULT;
155 MINLINE int   len_manhattan_v2_int(const int v[2]) ATTR_WARN_UNUSED_RESULT;
156 MINLINE float len_manhattan_v3(const float v[3]) ATTR_WARN_UNUSED_RESULT;
157 MINLINE float len_v2(const float a[2]) ATTR_WARN_UNUSED_RESULT;
158 MINLINE float len_v2v2(const float a[2], const float b[2]) ATTR_WARN_UNUSED_RESULT;
159 MINLINE float len_squared_v2v2(const float a[2], const float b[2]) ATTR_WARN_UNUSED_RESULT;
160 MINLINE float len_squared_v3v3(const float a[3], const float b[3]) ATTR_WARN_UNUSED_RESULT;
161 MINLINE float len_manhattan_v2v2(const float a[2], const float b[2]) ATTR_WARN_UNUSED_RESULT;
162 MINLINE int   len_manhattan_v2v2_int(const int a[2], const int b[2]) ATTR_WARN_UNUSED_RESULT;
163 MINLINE float len_manhattan_v3v3(const float a[3], const float b[3]) ATTR_WARN_UNUSED_RESULT;
164 MINLINE float len_v3(const float a[3]) ATTR_WARN_UNUSED_RESULT;
165 MINLINE float len_v3v3(const float a[3], const float b[3]) ATTR_WARN_UNUSED_RESULT;
166
167 MINLINE float normalize_v2(float r[2]);
168 MINLINE float normalize_v2_v2(float r[2], const float a[2]);
169 MINLINE float normalize_v3(float r[3]);
170 MINLINE float normalize_v3_v3(float r[3], const float a[3]);
171
172 /******************************* Interpolation *******************************/
173
174 void interp_v2_v2v2(float r[2], const float a[2], const float b[2], const float t);
175 void interp_v2_v2v2v2(float r[2], const float a[2], const float b[2], const float c[2], const float t[3]);
176 void interp_v3_v3v3(float r[3], const float a[3], const float b[3], const float t);
177 void interp_v3_v3v3v3(float p[3], const float v1[3], const float v2[3], const float v3[3], const float w[3]);
178 void interp_v3_v3v3v3v3(float p[3], const float v1[3], const float v2[3], const float v3[3], const float v4[3], const float w[4]);
179 void interp_v4_v4v4(float r[4], const float a[4], const float b[4], const float t);
180 void interp_v4_v4v4v4(float p[4], const float v1[4], const float v2[4], const float v3[4], const float w[3]);
181 void interp_v4_v4v4v4v4(float p[4], const float v1[4], const float v2[4], const float v3[4], const float v4[4], const float w[4]);
182 void interp_v3_v3v3v3_uv(float p[3], const float v1[3], const float v2[3], const float v3[3], const float uv[2]);
183
184 void mid_v3_v3v3(float r[3], const float a[3], const float b[3]);
185 void mid_v2_v2v2(float r[2], const float a[2], const float b[2]);
186 void mid_v3_v3v3v3(float v[3], const float v1[3], const float v2[3], const float v3[3]);
187
188 void mid_v3_v3v3_angle_weighted(float r[3], const float a[3], const float b[3]);
189 void mid_v3_angle_weighted(float r[3]);
190
191 void flip_v4_v4v4(float v[4], const float v1[4], const float v2[4]);
192 void flip_v3_v3v3(float v[3], const float v1[3], const float v2[3]);
193 void flip_v2_v2v2(float v[2], const float v1[2], const float v2[2]);
194
195 /********************************* Comparison ********************************/
196
197 MINLINE bool is_zero_v2(const float a[3])  ATTR_WARN_UNUSED_RESULT;
198 MINLINE bool is_zero_v3(const float a[3])  ATTR_WARN_UNUSED_RESULT;
199 MINLINE bool is_zero_v4(const float a[4])  ATTR_WARN_UNUSED_RESULT;
200
201 MINLINE bool is_finite_v2(const float a[3])  ATTR_WARN_UNUSED_RESULT;
202 MINLINE bool is_finite_v3(const float a[3])  ATTR_WARN_UNUSED_RESULT;
203 MINLINE bool is_finite_v4(const float a[4])  ATTR_WARN_UNUSED_RESULT;
204
205 MINLINE bool is_one_v3(const float a[3])  ATTR_WARN_UNUSED_RESULT;
206
207 MINLINE bool equals_v2v2(const float v1[2], const float v2[2])  ATTR_WARN_UNUSED_RESULT;
208 MINLINE bool equals_v3v3(const float a[3], const float b[3])  ATTR_WARN_UNUSED_RESULT;
209 MINLINE bool compare_v2v2(const float a[2], const float b[2], const float limit)  ATTR_WARN_UNUSED_RESULT;
210 MINLINE bool compare_v3v3(const float a[3], const float b[3], const float limit)  ATTR_WARN_UNUSED_RESULT;
211 MINLINE bool compare_len_v3v3(const float a[3], const float b[3], const float limit)  ATTR_WARN_UNUSED_RESULT;
212
213 MINLINE bool compare_v4v4(const float a[4], const float b[4], const float limit)  ATTR_WARN_UNUSED_RESULT;
214 MINLINE bool equals_v4v4(const float a[4], const float b[4])  ATTR_WARN_UNUSED_RESULT;
215
216 MINLINE float line_point_side_v2(const float l1[2], const float l2[2], const float pt[2]) ATTR_WARN_UNUSED_RESULT;
217
218 /********************************** Angles ***********************************/
219 /* - angle with 2 arguments is angle between vector                          */
220 /* - angle with 3 arguments is angle between 3 points at the middle point    */
221 /* - angle_normalized_* is faster equivalent if vectors are normalized       */
222
223 float angle_v2v2(const float a[2], const float b[2]) ATTR_WARN_UNUSED_RESULT;
224 float angle_signed_v2v2(const float v1[2], const float v2[2]) ATTR_WARN_UNUSED_RESULT;
225 float angle_v2v2v2(const float a[2], const float b[2], const float c[2]) ATTR_WARN_UNUSED_RESULT;
226 float angle_normalized_v2v2(const float a[2], const float b[2]) ATTR_WARN_UNUSED_RESULT;
227 float angle_v3v3(const float a[3], const float b[3]) ATTR_WARN_UNUSED_RESULT;
228 float angle_v3v3v3(const float a[3], const float b[3], const float c[3]) ATTR_WARN_UNUSED_RESULT;
229 float cos_v3v3v3(const float p1[3], const float p2[3], const float p3[3]) ATTR_WARN_UNUSED_RESULT;
230 float angle_normalized_v3v3(const float v1[3], const float v2[3]) ATTR_WARN_UNUSED_RESULT;
231 float angle_on_axis_v3v3v3_v3(const float v1[3], const float v2[3], const float v3[3], const float axis[3]) ATTR_WARN_UNUSED_RESULT;
232 void angle_tri_v3(float angles[3], const float v1[3], const float v2[3], const float v3[3]);
233 void angle_quad_v3(float angles[4], const float v1[3], const float v2[3], const float v3[3], const float v4[3]);
234 void angle_poly_v3(float *angles, const float *verts[3], int len);
235
236 /********************************* Geometry **********************************/
237
238 void project_v2_v2v2(float c[2], const float v1[2], const float v2[2]);
239 void project_v3_v3v3(float r[3], const float p[3], const float n[3]);
240 void project_v3_plane(float v[3], const float n[3], const float p[3]);
241 void reflect_v3_v3v3(float r[3], const float v[3], const float n[3]);
242 void ortho_basis_v3v3_v3(float r1[3], float r2[3], const float a[3]);
243 void bisect_v3_v3v3v3(float r[3], const float a[3], const float b[3], const float c[3]);
244 void rotate_v3_v3v3fl(float v[3], const float p[3], const float axis[3], const float angle);
245 void rotate_normalized_v3_v3v3fl(float v[3], const float p[3], const float axis[3], const float angle);
246
247 /*********************************** Other ***********************************/
248
249 void print_v2(const char *str, const float a[2]);
250 void print_v3(const char *str, const float a[3]);
251 void print_v4(const char *str, const float a[4]);
252 void print_vn(const char *str, const float v[], const int n);
253
254 MINLINE void normal_short_to_float_v3(float r[3], const short n[3]);
255 MINLINE void normal_float_to_short_v3(short r[3], const float n[3]);
256
257 void minmax_v3v3_v3(float min[3], float max[3], const float vec[3]);
258 void minmax_v2v2_v2(float min[2], float max[2], const float vec[2]);
259
260 void dist_ensure_v3_v3fl(float v1[3], const float v2[3], const float dist);
261 void dist_ensure_v2_v2fl(float v1[2], const float v2[2], const float dist);
262
263 void axis_sort_v3(const float axis_values[3], int r_axis_order[3]);
264
265 /***************************** Array Functions *******************************/
266 /* attempted to follow fixed length vertex functions. names could be improved*/
267 double dot_vn_vn(const float *array_src_a, const float *array_src_b, const int size) ATTR_WARN_UNUSED_RESULT;
268 float normalize_vn_vn(float *array_tar, const float *array_src, const int size);
269 float normalize_vn(float *array_tar, const int size);
270 void range_vn_i(int *array_tar, const int size, const int start);
271 void range_vn_fl(float *array_tar, const int size, const float start, const float step);
272 void negate_vn(float *array_tar, const int size);
273 void negate_vn_vn(float *array_tar, const float *array_src, const int size);
274 void mul_vn_fl(float *array_tar, const int size, const float f);
275 void mul_vn_vn_fl(float *array_tar, const float *array_src, const int size, const float f);
276 void add_vn_vn(float *array_tar, const float *array_src, const int size);
277 void add_vn_vnvn(float *array_tar, const float *array_src_a, const float *array_src_b, const int size);
278 void madd_vn_vn(float *array_tar, const float *array_src, const float f, const int size);
279 void madd_vn_vnvn(float *array_tar, const float *array_src_a, const float *array_src_b, const float f, const int size);
280 void sub_vn_vn(float *array_tar, const float *array_src, const int size);
281 void sub_vn_vnvn(float *array_tar, const float *array_src_a, const float *array_src_b, const int size);
282 void msub_vn_vn(float *array_tar, const float *array_src, const float f, const int size);
283 void msub_vn_vnvn(float *array_tar, const float *array_src_a, const float *array_src_b, const float f, const int size);
284 void interp_vn_vn(float *array_tar, const float *array_src, const float t, const int size);
285 void fill_vn_i(int *array_tar, const int size, const int val);
286 void fill_vn_ushort(unsigned short *array_tar, const int size, const unsigned short val);
287 void fill_vn_fl(float *array_tar, const int size, const float val);
288
289 /**************************** Inline Definitions ******************************/
290
291 #if BLI_MATH_DO_INLINE
292 #include "intern/math_vector_inline.c"
293 #endif
294
295 #ifdef BLI_MATH_GCC_WARN_PRAGMA
296 #  pragma GCC diagnostic pop
297 #endif
298
299 #ifdef __cplusplus
300 }
301 #endif
302
303 #endif /* __BLI_MATH_VECTOR_H__ */