improved method of getting the tangent axis from a bmesh triangle,
[blender-staging.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_math_inline.h"
38
39 #if BLI_MATH_DO_INLINE
40 #include "intern/math_vector_inline.c"
41 #endif
42
43 /************************************* Init ***********************************/
44
45 #ifdef BLI_MATH_GCC_WARN_PRAGMA
46 #  pragma GCC diagnostic push
47 #  pragma GCC diagnostic ignored "-Wredundant-decls"
48 #endif
49
50 MINLINE void zero_v2(float r[2]);
51 MINLINE void zero_v3(float r[3]);
52 MINLINE void zero_v4(float r[4]);
53
54 MINLINE void copy_v2_v2(float r[2], const float a[2]);
55 MINLINE void copy_v3_v3(float r[3], const float a[3]);
56 MINLINE void copy_v4_v4(float r[4], const float a[4]);
57
58 MINLINE void copy_v2_fl(float r[2], float f);
59 MINLINE void copy_v3_fl(float r[3], float f);
60 MINLINE void copy_v4_fl(float r[4], float f);
61
62 MINLINE void swap_v2_v2(float a[2], float b[2]);
63 MINLINE void swap_v3_v3(float a[3], float b[3]);
64 MINLINE void swap_v4_v4(float a[4], float b[4]);
65
66 /* char */
67 MINLINE void copy_v2_v2_char(char r[2], const char a[2]);
68 MINLINE void copy_v3_v3_char(char r[3], const char a[3]);
69 MINLINE void copy_v4_v4_char(char r[4], const char a[4]);
70 /* short */
71 MINLINE void copy_v2_v2_short(short r[2], const short a[2]);
72 MINLINE void copy_v3_v3_short(short r[3], const short a[3]);
73 MINLINE void copy_v4_v4_short(short r[4], const short a[4]);
74 /* int */
75 MINLINE void zero_v3_int(int r[3]);
76 MINLINE void copy_v2_v2_int(int r[2], const int a[2]);
77 MINLINE void copy_v3_v3_int(int r[3], const int a[3]);
78 MINLINE void copy_v4_v4_int(int r[4], const int a[4]);
79 /* double -> float */
80 MINLINE void copy_v2fl_v2db(float r[2], const double a[2]);
81 MINLINE void copy_v3fl_v3db(float r[3], const double a[3]);
82 MINLINE void copy_v4fl_v4db(float r[4], const double a[4]);
83 /* float -> double */
84 MINLINE void copy_v2db_v2fl(double r[2], const float a[2]);
85 MINLINE void copy_v3db_v3fl(double r[3], const float a[3]);
86 MINLINE void copy_v4db_v4fl(double r[4], const float a[4]);
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]);
119
120 MINLINE void madd_v3_v3fl(float r[3], const float a[3], float f);
121 MINLINE void madd_v3_v3v3(float r[3], const float a[3], const float b[3]);
122 MINLINE void madd_v2_v2v2fl(float r[2], const float a[2], const float b[2], float f);
123 MINLINE void madd_v3_v3v3fl(float r[3], const float a[3], const float b[3], float f);
124 MINLINE void madd_v3_v3v3v3(float r[3], const float a[3], const float b[3], const float c[3]);
125 MINLINE void madd_v4_v4fl(float r[4], const float a[4], float f);
126 MINLINE void madd_v4_v4v4(float r[4], const float a[4], const float b[4]);
127
128 MINLINE void negate_v2(float r[2]);
129 MINLINE void negate_v2_v2(float r[2], const float a[2]);
130 MINLINE void negate_v3(float r[3]);
131 MINLINE void negate_v3_v3(float r[3], const float a[3]);
132 MINLINE void negate_v4(float r[4]);
133 MINLINE void negate_v4_v4(float r[4], const float a[3]);
134
135 MINLINE void negate_v3_short(short r[3]);
136
137 MINLINE float dot_v2v2(const float a[2], const float b[2]);
138 MINLINE float dot_v3v3(const float a[3], const float b[3]);
139
140 MINLINE float cross_v2v2(const float a[2], const float b[2]);
141 MINLINE void cross_v3_v3v3(float r[3], const float a[3], const float b[3]);
142
143 MINLINE void add_newell_cross_v3_v3v3(float n[3], const float v_prev[3], const float v_curr[3]);
144
145 MINLINE void star_m3_v3(float rmat[3][3], float a[3]);
146
147 /*********************************** Length **********************************/
148
149 MINLINE float len_squared_v2(const float v[2]);
150 MINLINE float len_squared_v3(const float v[3]);
151 MINLINE float len_manhattan_v2(const float v[2]);
152 MINLINE float len_manhattan_v3(const float v[3]);
153 MINLINE float len_v2(const float a[2]);
154 MINLINE float len_v2v2(const float a[2], const float b[2]);
155 MINLINE float len_squared_v2v2(const float a[2], const float b[2]);
156 MINLINE float len_squared_v3v3(const float a[3], const float b[3]);
157 MINLINE float len_manhattan_v2v2(const float a[2], const float b[2]);
158 MINLINE float len_manhattan_v3v3(const float a[3], const float b[3]);
159 MINLINE float len_v3(const float a[3]);
160 MINLINE float len_v3v3(const float a[3], const float b[3]);
161
162 MINLINE float normalize_v2(float r[2]);
163 MINLINE float normalize_v2_v2(float r[2], const float a[2]);
164 MINLINE float normalize_v3(float r[3]);
165 MINLINE float normalize_v3_v3(float r[3], const float a[3]);
166
167 /******************************* Interpolation *******************************/
168
169 void interp_v2_v2v2(float r[2], const float a[2], const float b[2], const float t);
170 void interp_v2_v2v2v2(float r[2], const float a[2], const float b[2], const float c[3], const float t[3]);
171 void interp_v3_v3v3(float r[3], const float a[3], const float b[3], const float t);
172 void interp_v3_v3v3v3(float p[3], const float v1[3], const float v2[3], const float v3[3], const float w[3]);
173 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]);
174 void interp_v4_v4v4(float r[4], const float a[4], const float b[4], const float t);
175 void interp_v4_v4v4v4(float p[4], const float v1[4], const float v2[4], const float v3[4], const float w[3]);
176 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]);
177
178 void mid_v3_v3v3(float r[3], const float a[3], const float b[3]);
179 void mid_v2_v2v2(float r[2], const float a[2], const float b[2]);
180 void mid_v3_v3v3v3(float v[3], const float v1[3], const float v2[3], const float v3[3]);
181
182 void flip_v4_v4v4(float v[4], const float v1[4], const float v2[4]);
183 void flip_v3_v3v3(float v[3], const float v1[3], const float v2[3]);
184 void flip_v2_v2v2(float v[2], const float v1[2], const float v2[2]);
185
186 /********************************* Comparison ********************************/
187
188 MINLINE int is_zero_v3(const float a[3]);
189 MINLINE int is_zero_v4(const float a[4]);
190 MINLINE int is_one_v3(const float a[3]);
191
192 MINLINE int equals_v2v2(const float v1[2], const float v2[2]);
193 MINLINE int equals_v3v3(const float a[3], const float b[3]);
194 MINLINE int compare_v2v2(const float a[3], const float b[3], const float limit);
195 MINLINE int compare_v3v3(const float a[3], const float b[3], const float limit);
196 MINLINE int compare_len_v3v3(const float a[3], const float b[3], const float limit);
197
198 MINLINE int compare_v4v4(const float a[4], const float b[4], const float limit);
199 MINLINE int equals_v4v4(const float a[4], const float b[4]);
200
201 MINLINE float line_point_side_v2(const float l1[2], const float l2[2], const float pt[2]);
202
203 /********************************** Angles ***********************************/
204 /* - angle with 2 arguments is angle between vector                          */
205 /* - angle with 3 arguments is angle between 3 points at the middle point    */
206 /* - angle_normalized_* is faster equivalent if vectors are normalized       */
207
208 float angle_v2v2(const float a[2], const float b[2]);
209 float angle_signed_v2v2(const float v1[2], const float v2[2]);
210 float angle_v2v2v2(const float a[2], const float b[2], const float c[2]);
211 float angle_normalized_v2v2(const float a[2], const float b[2]);
212 float angle_v3v3(const float a[3], const float b[3]);
213 float angle_v3v3v3(const float a[3], const float b[3], const float c[3]);
214 float cos_v3v3v3(const float p1[3], const float p2[3], const float p3[3]);
215 float angle_normalized_v3v3(const float v1[3], const float v2[3]);
216 float angle_on_axis_v3v3v3_v3(const float v1[3], const float v2[3], const float v3[3], const float axis[3]);
217 void angle_tri_v3(float angles[3], const float v1[3], const float v2[3], const float v3[3]);
218 void angle_quad_v3(float angles[4], const float v1[3], const float v2[3], const float v3[3], const float v4[3]);
219 void angle_poly_v3(float *angles, const float *verts[3], int len);
220
221 /********************************* Geometry **********************************/
222
223 void project_v2_v2v2(float c[2], const float v1[2], const float v2[2]);
224 void project_v3_v3v3(float r[3], const float p[3], const float n[3]);
225 void project_v3_plane(float v[3], const float n[3], const float p[3]);
226 void reflect_v3_v3v3(float r[3], const float v[3], const float n[3]);
227 void ortho_basis_v3v3_v3(float r1[3], float r2[3], const float a[3]);
228 void bisect_v3_v3v3v3(float r[3], const float a[3], const float b[3], const float c[3]);
229 void rotate_v3_v3v3fl(float v[3], const float p[3], const float axis[3], const float angle);
230 void rotate_normalized_v3_v3v3fl(float v[3], const float p[3], const float axis[3], const float angle);
231
232 /*********************************** Other ***********************************/
233
234 void print_v2(const char *str, const float a[2]);
235 void print_v3(const char *str, const float a[3]);
236 void print_v4(const char *str, const float a[4]);
237
238 MINLINE void normal_short_to_float_v3(float r[3], const short n[3]);
239 MINLINE void normal_float_to_short_v3(short r[3], const float n[3]);
240
241 void minmax_v3v3_v3(float min[3], float max[3], const float vec[3]);
242 void minmax_v2v2_v2(float min[2], float max[2], const float vec[2]);
243
244 void dist_ensure_v3_v3fl(float v1[3], const float v2[3], const float dist);
245 void dist_ensure_v2_v2fl(float v1[2], const float v2[2], const float dist);
246
247 void axis_sort_v3(const float axis_values[3], int r_axis_order[3]);
248
249 /***************************** Array Functions *******************************/
250 /* attempted to follow fixed length vertex functions. names could be improved*/
251 double dot_vn_vn(const float *array_src_a, const float *array_src_b, const int size);
252 float normalize_vn_vn(float *array_tar, const float *array_src, const int size);
253 float normalize_vn(float *array_tar, const int size);
254 void range_vn_i(int *array_tar, const int size, const int start);
255 void range_vn_fl(float *array_tar, const int size, const float start, const float step);
256 void negate_vn(float *array_tar, const int size);
257 void negate_vn_vn(float *array_tar, const float *array_src, const int size);
258 void mul_vn_fl(float *array_tar, const int size, const float f);
259 void mul_vn_vn_fl(float *array_tar, const float *array_src, const int size, const float f);
260 void add_vn_vn(float *array_tar, const float *array_src, const int size);
261 void add_vn_vnvn(float *array_tar, const float *array_src_a, const float *array_src_b, const int size);
262 void madd_vn_vn(float *array_tar, const float *array_src, const float f, const int size);
263 void madd_vn_vnvn(float *array_tar, const float *array_src_a, const float *array_src_b, const float f, const int size);
264 void sub_vn_vn(float *array_tar, const float *array_src, const int size);
265 void sub_vn_vnvn(float *array_tar, const float *array_src_a, const float *array_src_b, const int size);
266 void msub_vn_vn(float *array_tar, const float *array_src, const float f, const int size);
267 void msub_vn_vnvn(float *array_tar, const float *array_src_a, const float *array_src_b, const float f, const int size);
268 void interp_vn_vn(float *array_tar, const float *array_src, const float t, const int size);
269 void fill_vn_i(int *array_tar, const int size, const int val);
270 void fill_vn_ushort(unsigned short *array_tar, const int size, const unsigned short val);
271 void fill_vn_fl(float *array_tar, const int size, const float val);
272
273 #ifdef BLI_MATH_GCC_WARN_PRAGMA
274 #  pragma GCC diagnostic pop
275 #endif
276
277 #ifdef __cplusplus
278 }
279 #endif
280
281 #endif /* __BLI_MATH_VECTOR_H__ */