Merge branch 'blender-v2.81-release'
[blender.git] / source / blender / blenlib / BLI_math_vector.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  *
19  * The Original Code is: some of this file.
20  *
21  * */
22
23 #ifndef __BLI_MATH_VECTOR_H__
24 #define __BLI_MATH_VECTOR_H__
25
26 /** \file
27  * \ingroup bli
28  */
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 #include "BLI_compiler_attrs.h"
35 #include "BLI_math_inline.h"
36
37 /************************************* Init ***********************************/
38
39 #ifdef BLI_MATH_GCC_WARN_PRAGMA
40 #  pragma GCC diagnostic push
41 #  pragma GCC diagnostic ignored "-Wredundant-decls"
42 #endif
43
44 MINLINE void zero_v2(float r[2]);
45 MINLINE void zero_v3(float r[3]);
46 MINLINE void zero_v4(float r[4]);
47
48 MINLINE void copy_v2_v2(float r[2], const float a[2]);
49 MINLINE void copy_v3_v3(float r[3], const float a[3]);
50 MINLINE void copy_v4_v4(float r[4], const float a[4]);
51
52 MINLINE void copy_v2_fl(float r[2], float f);
53 MINLINE void copy_v3_fl(float r[3], float f);
54 MINLINE void copy_v4_fl(float r[4], float f);
55
56 MINLINE void swap_v2_v2(float a[2], float b[2]);
57 MINLINE void swap_v3_v3(float a[3], float b[3]);
58 MINLINE void swap_v4_v4(float a[4], float b[4]);
59
60 /* unsigned char */
61 MINLINE void copy_v2_v2_uchar(unsigned char r[2], const unsigned char a[2]);
62 MINLINE void copy_v3_v3_uchar(unsigned char r[3], const unsigned char a[3]);
63 MINLINE void copy_v4_v4_uchar(unsigned char r[4], const unsigned char a[4]);
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 */
78 MINLINE void zero_v3_db(double r[3]);
79 MINLINE void copy_v2_v2_db(double r[2], const double a[2]);
80 MINLINE void copy_v3_v3_db(double r[3], const double a[3]);
81 MINLINE void copy_v4_v4_db(double r[4], const double a[4]);
82 /* short -> float */
83 MINLINE void copy_v3fl_v3s(float r[3], const short a[3]);
84 /* int <-> float */
85 MINLINE void copy_v2fl_v2i(float r[2], const int a[2]);
86 MINLINE void round_v2i_v2fl(int r[2], const float a[2]);
87 /* double -> float */
88 MINLINE void copy_v2fl_v2db(float r[2], const double a[2]);
89 MINLINE void copy_v3fl_v3db(float r[3], const double a[3]);
90 MINLINE void copy_v4fl_v4db(float r[4], const double a[4]);
91 /* float -> double */
92 MINLINE void copy_v2db_v2fl(double r[2], const float a[2]);
93 MINLINE void copy_v3db_v3fl(double r[3], const float a[3]);
94 MINLINE void copy_v4db_v4fl(double r[4], const float a[4]);
95 /* float args -> vec */
96 MINLINE void copy_v2_fl2(float v[2], float x, float y);
97 MINLINE void copy_v3_fl3(float v[3], float x, float y, float z);
98 MINLINE void copy_v4_fl4(float v[4], float x, float y, float z, float w);
99
100 /********************************* Arithmetic ********************************/
101
102 MINLINE void add_v2_fl(float r[2], float f);
103 MINLINE void add_v3_fl(float r[3], float f);
104 MINLINE void add_v4_fl(float r[4], float f);
105 MINLINE void add_v2_v2(float r[2], const float a[2]);
106 MINLINE void add_v2_v2_db(double r[2], const double a[2]);
107 MINLINE void add_v2_v2v2(float r[2], const float a[2], const float b[2]);
108 MINLINE void add_v2_v2v2_int(int r[2], const int a[2], const int b[2]);
109 MINLINE void add_v3_v3(float r[3], const float a[3]);
110 MINLINE void add_v3_v3_db(double r[3], const double a[3]);
111 MINLINE void add_v3_v3v3(float r[3], const float a[3], const float b[3]);
112 MINLINE void add_v4_v4(float r[4], const float a[4]);
113 MINLINE void add_v4_v4v4(float r[4], const float a[4], const float b[4]);
114
115 MINLINE void add_v3fl_v3fl_v3i(float r[3], const float a[3], const int b[3]);
116 MINLINE void add_v3fl_v3fl_v3s(float r[3], const float a[3], const short b[3]);
117
118 MINLINE void sub_v2_v2(float r[2], const float a[2]);
119 MINLINE void sub_v2_v2v2(float r[2], const float a[2], const float b[2]);
120 MINLINE void sub_v2_v2v2_db(double r[2], const double a[2], const double b[2]);
121 MINLINE void sub_v2_v2v2_int(int r[2], const int a[2], const int b[2]);
122 MINLINE void sub_v3_v3(float r[3], const float a[3]);
123 MINLINE void sub_v3_v3v3(float r[3], const float a[3], const float b[3]);
124 MINLINE void sub_v3_v3v3_int(int r[3], const int a[3], const int b[3]);
125 MINLINE void sub_v3_v3v3_db(double r[3], const double a[3], const double b[3]);
126 MINLINE void sub_v4_v4(float r[4], const float a[4]);
127 MINLINE void sub_v4_v4v4(float r[4], const float a[4], const float b[4]);
128
129 MINLINE void sub_v3db_v3fl_v3fl(double r[3], const float a[3], const float b[3]);
130
131 MINLINE void mul_v2_fl(float r[2], float f);
132 MINLINE void mul_v2_v2fl(float r[2], const float a[2], float f);
133 MINLINE void mul_v3_fl(float r[3], float f);
134 MINLINE void mul_v3db_db(double r[3], double f);
135 MINLINE void mul_v3_v3fl(float r[3], const float a[3], float f);
136 MINLINE void mul_v2_v2(float r[2], const float a[2]);
137 MINLINE void mul_v2_v2v2(float r[2], const float a[2], const float b[2]);
138 MINLINE void mul_v3_v3(float r[3], const float a[3]);
139 MINLINE void mul_v3_v3v3(float r[3], const float a[3], const float b[3]);
140 MINLINE void mul_v4_fl(float r[4], float f);
141 MINLINE void mul_v4_v4(float r[4], const float a[4]);
142 MINLINE void mul_v4_v4fl(float r[3], const float a[3], float f);
143 MINLINE void mul_v2_v2_cw(float r[2], const float mat[2], const float vec[2]);
144 MINLINE void mul_v2_v2_ccw(float r[2], const float mat[2], const float vec[2]);
145 MINLINE float mul_project_m4_v3_zfac(const float mat[4][4],
146                                      const float co[3]) ATTR_WARN_UNUSED_RESULT;
147 MINLINE float dot_m3_v3_row_x(const float M[3][3], const float a[3]) ATTR_WARN_UNUSED_RESULT;
148 MINLINE float dot_m3_v3_row_y(const float M[3][3], const float a[3]) ATTR_WARN_UNUSED_RESULT;
149 MINLINE float dot_m3_v3_row_z(const float M[3][3], const float a[3]) ATTR_WARN_UNUSED_RESULT;
150 MINLINE float dot_m4_v3_row_x(const float M[4][4], const float a[3]) ATTR_WARN_UNUSED_RESULT;
151 MINLINE float dot_m4_v3_row_y(const float M[4][4], const float a[3]) ATTR_WARN_UNUSED_RESULT;
152 MINLINE float dot_m4_v3_row_z(const float M[4][4], const float a[3]) ATTR_WARN_UNUSED_RESULT;
153
154 MINLINE void madd_v2_v2fl(float r[2], const float a[2], float f);
155 MINLINE void madd_v3_v3fl(float r[3], const float a[3], float f);
156 MINLINE void madd_v3_v3v3(float r[3], const float a[3], const float b[3]);
157 MINLINE void madd_v2_v2v2fl(float r[2], const float a[2], const float b[2], float f);
158 MINLINE void madd_v3_v3v3fl(float r[3], const float a[3], const float b[3], float f);
159 MINLINE void madd_v3_v3v3v3(float r[3], const float a[3], const float b[3], const float c[3]);
160 MINLINE void madd_v4_v4fl(float r[4], const float a[4], float f);
161 MINLINE void madd_v4_v4v4(float r[4], const float a[4], const float b[4]);
162
163 MINLINE void madd_v3fl_v3fl_v3fl_v3i(float r[3],
164                                      const float a[3],
165                                      const float b[3],
166                                      const int c[3]);
167
168 MINLINE void negate_v2(float r[2]);
169 MINLINE void negate_v2_v2(float r[2], const float a[2]);
170 MINLINE void negate_v3(float r[3]);
171 MINLINE void negate_v3_v3(float r[3], const float a[3]);
172 MINLINE void negate_v4(float r[4]);
173 MINLINE void negate_v4_v4(float r[4], const float a[3]);
174
175 MINLINE void negate_v3_short(short r[3]);
176 MINLINE void negate_v3_db(double r[3]);
177
178 MINLINE void invert_v2(float r[2]);
179 MINLINE void invert_v3(float r[3]);
180
181 MINLINE void abs_v2(float r[2]);
182 MINLINE void abs_v2_v2(float r[2], const float a[2]);
183 MINLINE void abs_v3(float r[3]);
184 MINLINE void abs_v3_v3(float r[3], const float a[3]);
185 MINLINE void abs_v4(float r[4]);
186 MINLINE void abs_v4_v4(float r[4], const float a[4]);
187
188 MINLINE float dot_v2v2(const float a[2], const float b[2]) ATTR_WARN_UNUSED_RESULT;
189 MINLINE double dot_v2v2_db(const double a[2], const double b[2]) ATTR_WARN_UNUSED_RESULT;
190 MINLINE float dot_v3v3(const float a[3], const float b[3]) ATTR_WARN_UNUSED_RESULT;
191 MINLINE float dot_v3v3v3(const float p[3],
192                          const float a[3],
193                          const float b[3]) ATTR_WARN_UNUSED_RESULT;
194 MINLINE float dot_v4v4(const float a[4], const float b[4]) ATTR_WARN_UNUSED_RESULT;
195
196 MINLINE double dot_v3db_v3fl(const double a[3], const float b[3]) ATTR_WARN_UNUSED_RESULT;
197
198 MINLINE double dot_v3v3_db(const double a[3], const double b[3]) ATTR_WARN_UNUSED_RESULT;
199
200 MINLINE float cross_v2v2(const float a[2], const float b[2]) ATTR_WARN_UNUSED_RESULT;
201 MINLINE void cross_v3_v3v3(float r[3], const float a[3], const float b[3]);
202 MINLINE void cross_v3_v3v3_hi_prec(float r[3], const float a[3], const float b[3]);
203 MINLINE void cross_v3_v3v3_db(double r[3], const double a[3], const double b[3]);
204
205 MINLINE void add_newell_cross_v3_v3v3(float n[3], const float v_prev[3], const float v_curr[3]);
206
207 MINLINE void star_m3_v3(float rmat[3][3], float a[3]);
208
209 /*********************************** Length **********************************/
210
211 MINLINE float len_squared_v2(const float v[2]) ATTR_WARN_UNUSED_RESULT;
212 MINLINE float len_squared_v3(const float v[3]) ATTR_WARN_UNUSED_RESULT;
213 MINLINE float len_manhattan_v2(const float v[2]) ATTR_WARN_UNUSED_RESULT;
214 MINLINE int len_manhattan_v2_int(const int v[2]) ATTR_WARN_UNUSED_RESULT;
215 MINLINE float len_manhattan_v3(const float v[3]) ATTR_WARN_UNUSED_RESULT;
216 MINLINE float len_v2(const float a[2]) ATTR_WARN_UNUSED_RESULT;
217 MINLINE float len_v2v2(const float a[2], const float b[2]) ATTR_WARN_UNUSED_RESULT;
218 MINLINE double len_v2v2_db(const double a[2], const double b[2]) ATTR_WARN_UNUSED_RESULT;
219 MINLINE float len_v2v2_int(const int v1[2], const int v2[2]);
220 MINLINE float len_squared_v2v2(const float a[2], const float b[2]) ATTR_WARN_UNUSED_RESULT;
221 MINLINE double len_squared_v2v2_db(const double a[2], const double b[2]) ATTR_WARN_UNUSED_RESULT;
222 MINLINE float len_squared_v3v3(const float a[3], const float b[3]) ATTR_WARN_UNUSED_RESULT;
223 MINLINE float len_squared_v4v4(const float a[4], const float b[4]) ATTR_WARN_UNUSED_RESULT;
224 MINLINE float len_manhattan_v2v2(const float a[2], const float b[2]) ATTR_WARN_UNUSED_RESULT;
225 MINLINE int len_manhattan_v2v2_int(const int a[2], const int b[2]) ATTR_WARN_UNUSED_RESULT;
226 MINLINE float len_manhattan_v3v3(const float a[3], const float b[3]) ATTR_WARN_UNUSED_RESULT;
227 MINLINE float len_v3(const float a[3]) ATTR_WARN_UNUSED_RESULT;
228 MINLINE float len_v3v3(const float a[3], const float b[3]) ATTR_WARN_UNUSED_RESULT;
229
230 MINLINE float normalize_v2_length(float r[2], const float unit_scale);
231 MINLINE float normalize_v2_v2_length(float r[2], const float a[2], const float unit_scale);
232 MINLINE float normalize_v3_length(float r[3], const float unit_scale);
233 MINLINE float normalize_v3_v3_length(float r[3], const float a[3], const float unit_scale);
234 MINLINE double normalize_v3_length_d(double n[3], const double unit_scale);
235
236 MINLINE float normalize_v2(float r[2]);
237 MINLINE float normalize_v2_v2(float r[2], const float a[2]);
238 MINLINE float normalize_v3(float r[3]);
239 MINLINE float normalize_v3_v3(float r[3], const float a[3]);
240 MINLINE double normalize_v3_d(double n[3]);
241
242 /******************************* Interpolation *******************************/
243
244 void interp_v2_v2v2(float r[2], const float a[2], const float b[2], const float t);
245 void interp_v2_v2v2_db(double target[2], const double a[2], const double b[2], const double t);
246 void interp_v2_v2v2v2(
247     float r[2], const float a[2], const float b[2], const float c[2], const float t[3]);
248 void interp_v3_v3v3(float r[3], const float a[3], const float b[3], const float t);
249 void interp_v3_v3v3_db(double target[3], const double a[3], const double b[3], const double t);
250 void interp_v3_v3v3v3(
251     float p[3], const float v1[3], const float v2[3], const float v3[3], const float w[3]);
252 void interp_v3_v3v3v3v3(float p[3],
253                         const float v1[3],
254                         const float v2[3],
255                         const float v3[3],
256                         const float v4[3],
257                         const float w[4]);
258 void interp_v4_v4v4(float r[4], const float a[4], const float b[4], const float t);
259 void interp_v4_v4v4v4(
260     float p[4], const float v1[4], const float v2[4], const float v3[4], const float w[3]);
261 void interp_v4_v4v4v4v4(float p[4],
262                         const float v1[4],
263                         const float v2[4],
264                         const float v3[4],
265                         const float v4[4],
266                         const float w[4]);
267 void interp_v3_v3v3v3_uv(
268     float p[3], const float v1[3], const float v2[3], const float v3[3], const float uv[2]);
269
270 bool interp_v3_v3v3_slerp(float target[3], const float a[3], const float b[3], const float t)
271     ATTR_WARN_UNUSED_RESULT;
272 bool interp_v2_v2v2_slerp(float target[2], const float a[2], const float b[2], const float t)
273     ATTR_WARN_UNUSED_RESULT;
274
275 void interp_v3_v3v3_slerp_safe(float target[3], const float a[3], const float b[3], const float t);
276 void interp_v2_v2v2_slerp_safe(float target[2], const float a[2], const float b[2], const float t);
277
278 void interp_v2_v2v2v2v2_cubic(float p[2],
279                               const float v1[2],
280                               const float v2[2],
281                               const float v3[2],
282                               const float v4[2],
283                               const float u);
284
285 void interp_v3_v3v3_char(char target[3], const char a[3], const char b[3], const float t);
286 void interp_v3_v3v3_uchar(unsigned char target[3],
287                           const unsigned char a[3],
288                           const unsigned char b[3],
289                           const float t);
290 void interp_v4_v4v4_char(char target[4], const char a[4], const char b[4], const float t);
291 void interp_v4_v4v4_uchar(unsigned char target[4],
292                           const unsigned char a[4],
293                           const unsigned char b[4],
294                           const float t);
295
296 void mid_v3_v3v3(float r[3], const float a[3], const float b[3]);
297 void mid_v2_v2v2(float r[2], const float a[2], const float b[2]);
298 void mid_v3_v3v3v3(float v[3], const float v1[3], const float v2[3], const float v3[3]);
299 void mid_v3_v3v3v3v3(
300     float v[3], const float v1[3], const float v2[3], const float v3[3], const float v4[3]);
301 void mid_v3_v3_array(float r[3], const float (*vec_arr)[3], const unsigned int nbr);
302
303 void mid_v3_v3v3_angle_weighted(float r[3], const float a[3], const float b[3]);
304 void mid_v3_angle_weighted(float r[3]);
305
306 void flip_v4_v4v4(float v[4], const float v1[4], const float v2[4]);
307 void flip_v3_v3v3(float v[3], const float v1[3], const float v2[3]);
308 void flip_v2_v2v2(float v[2], const float v1[2], const float v2[2]);
309
310 /********************************* Comparison ********************************/
311
312 MINLINE bool is_zero_v2(const float a[3]) ATTR_WARN_UNUSED_RESULT;
313 MINLINE bool is_zero_v3(const float a[3]) ATTR_WARN_UNUSED_RESULT;
314 MINLINE bool is_zero_v4(const float a[4]) ATTR_WARN_UNUSED_RESULT;
315
316 bool is_finite_v2(const float a[3]) ATTR_WARN_UNUSED_RESULT;
317 bool is_finite_v3(const float a[3]) ATTR_WARN_UNUSED_RESULT;
318 bool is_finite_v4(const float a[4]) ATTR_WARN_UNUSED_RESULT;
319
320 MINLINE bool is_one_v3(const float a[3]) ATTR_WARN_UNUSED_RESULT;
321
322 MINLINE bool equals_v2v2(const float v1[2], const float v2[2]) ATTR_WARN_UNUSED_RESULT;
323 MINLINE bool equals_v3v3(const float a[3], const float b[3]) ATTR_WARN_UNUSED_RESULT;
324 MINLINE bool equals_v4v4(const float a[4], const float b[4]) ATTR_WARN_UNUSED_RESULT;
325
326 MINLINE bool compare_v2v2(const float a[2],
327                           const float b[2],
328                           const float limit) ATTR_WARN_UNUSED_RESULT;
329 MINLINE bool compare_v3v3(const float a[3],
330                           const float b[3],
331                           const float limit) ATTR_WARN_UNUSED_RESULT;
332 MINLINE bool compare_v4v4(const float a[4],
333                           const float b[4],
334                           const float limit) ATTR_WARN_UNUSED_RESULT;
335
336 MINLINE bool compare_v2v2_relative(const float a[2],
337                                    const float b[2],
338                                    const float limit,
339                                    const int max_ulps) ATTR_WARN_UNUSED_RESULT;
340 MINLINE bool compare_v3v3_relative(const float a[3],
341                                    const float b[3],
342                                    const float limit,
343                                    const int max_ulps) ATTR_WARN_UNUSED_RESULT;
344 MINLINE bool compare_v4v4_relative(const float a[4],
345                                    const float b[4],
346                                    const float limit,
347                                    const int max_ulps) ATTR_WARN_UNUSED_RESULT;
348
349 MINLINE bool compare_len_v3v3(const float a[3],
350                               const float b[3],
351                               const float limit) ATTR_WARN_UNUSED_RESULT;
352
353 MINLINE float line_point_side_v2(const float l1[2],
354                                  const float l2[2],
355                                  const float pt[2]) ATTR_WARN_UNUSED_RESULT;
356
357 /********************************** Angles ***********************************/
358 /* - angle with 2 arguments is angle between vector                          */
359 /* - angle with 3 arguments is angle between 3 points at the middle point    */
360 /* - angle_normalized_* is faster equivalent if vectors are normalized       */
361
362 float angle_v2v2(const float a[2], const float b[2]) ATTR_WARN_UNUSED_RESULT;
363 float angle_signed_v2v2(const float v1[2], const float v2[2]) ATTR_WARN_UNUSED_RESULT;
364 float angle_v2v2v2(const float a[2], const float b[2], const float c[2]) ATTR_WARN_UNUSED_RESULT;
365 float angle_normalized_v2v2(const float a[2], const float b[2]) ATTR_WARN_UNUSED_RESULT;
366 float angle_v3v3(const float a[3], const float b[3]) ATTR_WARN_UNUSED_RESULT;
367 float angle_v3v3v3(const float a[3], const float b[3], const float c[3]) ATTR_WARN_UNUSED_RESULT;
368 float cos_v3v3v3(const float p1[3], const float p2[3], const float p3[3]) ATTR_WARN_UNUSED_RESULT;
369 float cos_v2v2v2(const float p1[2], const float p2[2], const float p3[2]) ATTR_WARN_UNUSED_RESULT;
370 float angle_on_axis_v3v3_v3(const float v1[3],
371                             const float v2[3],
372                             const float axis[3]) ATTR_WARN_UNUSED_RESULT;
373 float angle_signed_on_axis_v3v3_v3(const float v1[3],
374                                    const float v2[3],
375                                    const float axis[3]) ATTR_WARN_UNUSED_RESULT;
376 float angle_normalized_v3v3(const float v1[3], const float v2[3]) ATTR_WARN_UNUSED_RESULT;
377 float angle_on_axis_v3v3v3_v3(const float v1[3],
378                               const float v2[3],
379                               const float v3[3],
380                               const float axis[3]) ATTR_WARN_UNUSED_RESULT;
381 float angle_signed_on_axis_v3v3v3_v3(const float v1[3],
382                                      const float v2[3],
383                                      const float v3[3],
384                                      const float axis[3]) ATTR_WARN_UNUSED_RESULT;
385 void angle_tri_v3(float angles[3], const float v1[3], const float v2[3], const float v3[3]);
386 void angle_quad_v3(
387     float angles[4], const float v1[3], const float v2[3], const float v3[3], const float v4[3]);
388 void angle_poly_v3(float *angles, const float *verts[3], int len);
389
390 /********************************* Geometry **********************************/
391
392 void project_v2_v2v2(float out[2], const float p[2], const float v_proj[2]);
393 void project_v3_v3v3(float out[3], const float p[3], const float v_proj[3]);
394 void project_v2_v2v2_normalized(float out[2], const float p[2], const float v_proj[2]);
395 void project_v3_v3v3_normalized(float out[3], const float p[3], const float v_proj[3]);
396 void project_plane_v3_v3v3(float out[3], const float p[3], const float v_plane[3]);
397 void project_plane_v2_v2v2(float out[2], const float p[2], const float v_plane[2]);
398 void project_plane_normalized_v3_v3v3(float out[3], const float p[3], const float v_plane[3]);
399 void project_plane_normalized_v2_v2v2(float out[2], const float p[2], const float v_plane[2]);
400 void project_v3_plane(float out[3], const float plane_no[3], const float plane_co[3]);
401 void reflect_v3_v3v3(float out[3], const float vec[3], const float normal[3]);
402 void ortho_basis_v3v3_v3(float r_n1[3], float r_n2[3], const float n[3]);
403 void ortho_v3_v3(float out[3], const float v[3]);
404 void ortho_v2_v2(float out[2], const float v[2]);
405 void bisect_v3_v3v3v3(float r[3], const float a[3], const float b[3], const float c[3]);
406 void rotate_v2_v2fl(float r[2], const float p[2], const float angle);
407 void rotate_v3_v3v3fl(float v[3], const float p[3], const float axis[3], const float angle);
408 void rotate_normalized_v3_v3v3fl(float out[3],
409                                  const float p[3],
410                                  const float axis[3],
411                                  const float angle);
412
413 /*********************************** Other ***********************************/
414
415 void print_v2(const char *str, const float a[2]);
416 void print_v3(const char *str, const float a[3]);
417 void print_v4(const char *str, const float a[4]);
418 void print_vn(const char *str, const float v[], const int n);
419
420 #define print_v2_id(v) print_v2(STRINGIFY(v), v)
421 #define print_v3_id(v) print_v3(STRINGIFY(v), v)
422 #define print_v4_id(v) print_v4(STRINGIFY(v), v)
423 #define print_vn_id(v, n) print_vn(STRINGIFY(v), v, n)
424
425 MINLINE void normal_float_to_short_v2(short r[2], const float n[2]);
426 MINLINE void normal_short_to_float_v3(float r[3], const short n[3]);
427 MINLINE void normal_float_to_short_v3(short r[3], const float n[3]);
428 MINLINE void normal_float_to_short_v4(short r[4], const float n[4]);
429
430 void minmax_v3v3_v3(float min[3], float max[3], const float vec[3]);
431 void minmax_v2v2_v2(float min[2], float max[2], const float vec[2]);
432
433 void minmax_v3v3_v3_array(float r_min[3], float r_max[3], const float (*vec_arr)[3], int nbr);
434
435 void dist_ensure_v3_v3fl(float v1[3], const float v2[3], const float dist);
436 void dist_ensure_v2_v2fl(float v1[2], const float v2[2], const float dist);
437
438 void axis_sort_v3(const float axis_values[3], int r_axis_order[3]);
439
440 /***************************** Array Functions *******************************/
441 /* follow fixed length vector function conventions. */
442 double dot_vn_vn(const float *array_src_a,
443                  const float *array_src_b,
444                  const int size) ATTR_WARN_UNUSED_RESULT;
445 double len_squared_vn(const float *array, const int size) ATTR_WARN_UNUSED_RESULT;
446 float normalize_vn_vn(float *array_tar, const float *array_src, const int size);
447 float normalize_vn(float *array_tar, const int size);
448 void range_vn_i(int *array_tar, const int size, const int start);
449 void range_vn_u(unsigned int *array_tar, const int size, const unsigned int start);
450 void range_vn_fl(float *array_tar, const int size, const float start, const float step);
451 void negate_vn(float *array_tar, const int size);
452 void negate_vn_vn(float *array_tar, const float *array_src, const int size);
453 void mul_vn_vn(float *array_tar, const float *array_src, const int size);
454 void mul_vn_vnvn(float *array_tar,
455                  const float *array_src_a,
456                  const float *array_src_b,
457                  const int size);
458 void mul_vn_fl(float *array_tar, const int size, const float f);
459 void mul_vn_vn_fl(float *array_tar, const float *array_src, const int size, const float f);
460 void add_vn_vn(float *array_tar, const float *array_src, const int size);
461 void add_vn_vnvn(float *array_tar,
462                  const float *array_src_a,
463                  const float *array_src_b,
464                  const int size);
465 void madd_vn_vn(float *array_tar, const float *array_src, const float f, const int size);
466 void madd_vn_vnvn(float *array_tar,
467                   const float *array_src_a,
468                   const float *array_src_b,
469                   const float f,
470                   const int size);
471 void sub_vn_vn(float *array_tar, const float *array_src, const int size);
472 void sub_vn_vnvn(float *array_tar,
473                  const float *array_src_a,
474                  const float *array_src_b,
475                  const int size);
476 void msub_vn_vn(float *array_tar, const float *array_src, const float f, const int size);
477 void msub_vn_vnvn(float *array_tar,
478                   const float *array_src_a,
479                   const float *array_src_b,
480                   const float f,
481                   const int size);
482 void interp_vn_vn(float *array_tar, const float *array_src, const float t, const int size);
483 void copy_vn_i(int *array_tar, const int size, const int val);
484 void copy_vn_short(short *array_tar, const int size, const short val);
485 void copy_vn_ushort(unsigned short *array_tar, const int size, const unsigned short val);
486 void copy_vn_uchar(unsigned char *array_tar, const int size, const unsigned char val);
487 void copy_vn_fl(float *array_tar, const int size, const float val);
488
489 void add_vn_vn_d(double *array_tar, const double *array_src, const int size);
490 void add_vn_vnvn_d(double *array_tar,
491                    const double *array_src_a,
492                    const double *array_src_b,
493                    const int size);
494 void mul_vn_db(double *array_tar, const int size, const double f);
495
496 /**************************** Inline Definitions ******************************/
497
498 #if BLI_MATH_DO_INLINE
499 #  include "intern/math_vector_inline.c"
500 #endif
501
502 #ifdef BLI_MATH_GCC_WARN_PRAGMA
503 #  pragma GCC diagnostic pop
504 #endif
505
506 #ifdef __cplusplus
507 }
508 #endif
509
510 #endif /* __BLI_MATH_VECTOR_H__ */