code cleanup: better use of BLI_array_* (grow in larger steps where possible), includ...
[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_math_inline.h"
38
39 #ifdef __BLI_MATH_INLINE_H__
40 #include "intern/math_vector_inline.c"
41 #endif
42
43 /************************************* Init ***********************************/
44
45 MINLINE void zero_v2(float r[2]);
46 MINLINE void zero_v3(float r[3]);
47 MINLINE void zero_v4(float r[4]);
48
49 MINLINE void copy_v2_v2(float r[2], const float a[2]);
50 MINLINE void copy_v3_v3(float r[3], const float a[3]);
51 MINLINE void copy_v4_v4(float r[4], const float a[4]);
52
53 MINLINE void copy_v2_fl(float r[2], float f);
54 MINLINE void copy_v3_fl(float r[3], float f);
55 MINLINE void copy_v4_fl(float r[4], float f);
56
57 MINLINE void swap_v2_v2(float a[2], float b[2]);
58 MINLINE void swap_v3_v3(float a[3], float b[3]);
59 MINLINE void swap_v4_v4(float a[4], float b[4]);
60
61 /* char */
62 MINLINE void copy_v2_v2_char(char r[2], const char a[2]);
63 MINLINE void copy_v3_v3_char(char r[3], const char a[3]);
64 MINLINE void copy_v4_v4_char(char r[4], const char a[4]);
65 /* short */
66 MINLINE void copy_v2_v2_short(short r[2], const short a[2]);
67 MINLINE void copy_v3_v3_short(short r[3], const short a[3]);
68 MINLINE void copy_v4_v4_short(short r[4], const short a[4]);
69 /* int */
70 MINLINE void copy_v2_v2_int(int r[2], const int a[2]);
71 MINLINE void copy_v3_v3_int(int r[3], const int a[3]);
72 MINLINE void copy_v4_v4_int(int r[4], const int a[4]);
73 /* double -> float */
74 MINLINE void copy_v2fl_v2db(float r[2], const double a[2]);
75 MINLINE void copy_v3fl_v3db(float r[3], const double a[3]);
76 MINLINE void copy_v4fl_v4db(float r[4], const double a[4]);
77 /* float -> double */
78 MINLINE void copy_v2db_v2fl(double r[2], const float a[2]);
79 MINLINE void copy_v3db_v3fl(double r[3], const float a[3]);
80 MINLINE void copy_v4db_v4fl(double r[4], const float a[4]);
81
82 /********************************* Arithmetic ********************************/
83
84 MINLINE void add_v3_fl(float r[3], float f);
85 MINLINE void add_v4_fl(float r[4], float f);
86 MINLINE void add_v2_v2(float r[2], const float a[2]);
87 MINLINE void add_v2_v2v2(float r[2], const float a[2], const float b[2]);
88 MINLINE void add_v3_v3(float r[3], const float a[3]);
89 MINLINE void add_v3_v3v3(float r[3], const float a[3], const float b[3]);
90
91 MINLINE void sub_v2_v2(float r[2], const float a[2]);
92 MINLINE void sub_v2_v2v2(float r[2], const float a[2], const float b[2]);
93 MINLINE void sub_v3_v3(float r[3], const float a[3]);
94 MINLINE void sub_v3_v3v3(float r[3], const float a[3], const float b[3]);
95 MINLINE void sub_v4_v4(float r[4], const float a[4]);
96 MINLINE void sub_v4_v4v4(float r[4], const float a[4], const float b[4]);
97
98 MINLINE void mul_v2_fl(float r[2], float f);
99 MINLINE void mul_v2_v2fl(float r[2], const float a[2], float f);
100 MINLINE void mul_v3_fl(float r[3], float f);
101 MINLINE void mul_v3_v3fl(float r[3], const float a[3], float f);
102 MINLINE void mul_v2_v2(float r[2], const float a[2]);
103 MINLINE void mul_v3_v3(float r[3], const float a[3]);
104 MINLINE void mul_v3_v3v3(float r[3], const float a[3], const float b[3]);
105 MINLINE void mul_v4_fl(float r[4], float f);
106
107 MINLINE void madd_v3_v3fl(float r[3], const float a[3], float f);
108 MINLINE void madd_v3_v3v3(float r[3], const float a[3], const float b[3]);
109 MINLINE void madd_v2_v2v2fl(float r[2], const float a[2], const float b[2], float f);
110 MINLINE void madd_v3_v3v3fl(float r[3], const float a[3], const float b[3], float f);
111 MINLINE void madd_v3_v3v3v3(float r[3], const float a[3], const float b[3], const float c[3]);
112 MINLINE void madd_v4_v4fl(float r[4], const float a[4], float f);
113
114 MINLINE void negate_v2(float r[2]);
115 MINLINE void negate_v2_v2(float r[2], const float a[2]);
116 MINLINE void negate_v3(float r[3]);
117 MINLINE void negate_v3_v3(float r[3], const float a[3]);
118 MINLINE void negate_v4(float r[4]);
119 MINLINE void negate_v4_v4(float r[4], const float a[3]);
120
121 MINLINE float dot_v2v2(const float a[2], const float b[2]);
122 MINLINE float dot_v3v3(const float a[3], const float b[3]);
123
124 MINLINE float cross_v2v2(const float a[2], const float b[2]);
125 MINLINE void cross_v3_v3v3(float r[3], const float a[3], const float b[3]);
126
127 MINLINE void add_newell_cross_v3_v3v3(float n[3], const float v_prev[3], const float v_curr[3]);
128
129 MINLINE void star_m3_v3(float rmat[3][3],float a[3]);
130
131 /*********************************** Length **********************************/
132
133 MINLINE float len_squared_v2(const float v[2]);
134 MINLINE float len_squared_v3(const float v[3]);
135 MINLINE float len_v2(const float a[2]);
136 MINLINE float len_v2v2(const float a[2], const float b[2]);
137 MINLINE float len_squared_v2v2(const float a[2], const float b[2]);
138 MINLINE float len_v3(const float a[3]);
139 MINLINE float len_v3v3(const float a[3], const float b[3]);
140 MINLINE float len_squared_v3v3(const float a[3], const float b[3]);
141
142 MINLINE float normalize_v2(float r[2]);
143 MINLINE float normalize_v2_v2(float r[2], const float a[2]);
144 MINLINE float normalize_v3(float r[3]);
145 MINLINE float normalize_v3_v3(float r[3], const float a[3]);
146
147 /******************************* Interpolation *******************************/
148
149 void interp_v2_v2v2(float r[2], const float a[2], const float b[2], const float t);
150 void interp_v2_v2v2v2(float r[2], const float a[2], const float b[2], const float c[3], const float t[3]);
151 void interp_v3_v3v3(float r[3], const float a[3], const float b[3], const float t);
152 void interp_v3_v3v3v3(float p[3], const float v1[3], const float v2[3], const float v3[3], const float w[3]);
153 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]);
154 void interp_v4_v4v4(float r[4], const float a[4], const float b[4], const float t);
155 void interp_v4_v4v4v4(float p[4], const float v1[4], const float v2[4], const float v3[4], const float w[3]);
156 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]);
157
158 void mid_v3_v3v3(float r[3], const float a[3], const float b[3]);
159 void mid_v2_v2v2(float r[2], const float a[2], const float b[2]);
160
161 /********************************* Comparison ********************************/
162
163 MINLINE int is_zero_v3(const float a[3]);
164 MINLINE int is_zero_v4(const float a[4]);
165 MINLINE int is_one_v3(const float a[3]);
166
167 MINLINE int equals_v2v2(const float v1[2], const float v2[2]);
168 MINLINE int equals_v3v3(const float a[3], const float b[3]);
169 MINLINE int compare_v3v3(const float a[3], const float b[3], const float limit);
170 MINLINE int compare_len_v3v3(const float a[3], const float b[3], const float limit);
171
172 MINLINE int compare_v4v4(const float a[4], const float b[4], const float limit);
173 MINLINE int equals_v4v4(const float a[4], const float b[4]);
174
175 MINLINE float line_point_side_v2(const float l1[2], const float l2[2], const float pt[2]);
176
177 /********************************** Angles ***********************************/
178 /* - angle with 2 arguments is angle between vector                          */
179 /* - angle with 3 arguments is angle between 3 points at the middle point    */
180 /* - angle_normalized_* is faster equivalent if vectors are normalized       */
181
182 float angle_v2v2(const float a[2], const float b[2]);
183 float angle_signed_v2v2(const float v1[2], const float v2[2]);
184 float angle_v2v2v2(const float a[2], const float b[2], const float c[2]);
185 float angle_normalized_v2v2(const float a[2], const float b[2]);
186 float angle_v3v3(const float a[3], const float b[3]);
187 float angle_v3v3v3(const float a[3], const float b[3], const float c[3]);
188 float angle_normalized_v3v3(const float v1[3], const float v2[3]);
189 void angle_tri_v3(float angles[3], const float v1[3], const float v2[3], const float v3[3]);
190 void angle_quad_v3(float angles[4], const float v1[3], const float v2[3], const float v3[3], const float v4[3]);
191 void angle_poly_v3(float* angles, const float* verts[3], int len);
192
193 /********************************* Geometry **********************************/
194
195 void project_v2_v2v2(float c[2], const float v1[2], const float v2[2]);
196 void project_v3_v3v3(float r[3], const float p[3], const float n[3]);
197 void project_v3_plane(float v[3], const float n[3], const float p[3]);
198 void reflect_v3_v3v3(float r[3], const float v[3], const float n[3]);
199 void ortho_basis_v3v3_v3(float r1[3], float r2[3], const float a[3]);
200 void bisect_v3_v3v3v3(float r[3], const float a[3], const float b[3], const float c[3]);
201 void rotate_v3_v3v3fl(float v[3], const float p[3], const float axis[3], const float angle);
202 void rotate_normalized_v3_v3v3fl(float v[3], const float p[3], const float axis[3], const float angle);
203
204 /*********************************** Other ***********************************/
205
206 void print_v2(const char *str, const float a[2]);
207 void print_v3(const char *str, const float a[3]);
208 void print_v4(const char *str, const float a[4]);
209
210 MINLINE void normal_short_to_float_v3(float r[3], const short n[3]);
211 MINLINE void normal_float_to_short_v3(short r[3], const float n[3]);
212
213 void minmax_v3v3_v3(float min[3], float max[3], const float vec[3]);
214
215 /***************************** Array Functions *******************************/
216 /* attempted to follow fixed length vertex functions. names could be improved*/
217 double dot_vn_vn(const float *array_src_a, const float *array_src_b, const int size);
218 float normalize_vn_vn(float *array_tar, const float *array_src, const int size);
219 float normalize_vn(float *array_tar, const int size);
220 void range_vn_i(int *array_tar, const int size, const int start);
221 void range_vn_fl(float *array_tar, const int size, const float start, const float step);
222 void negate_vn(float *array_tar, const int size);
223 void negate_vn_vn(float *array_tar, const float *array_src, const int size);
224 void mul_vn_fl(float *array_tar, const int size, const float f);
225 void mul_vn_vn_fl(float *array_tar, const float *array_src, const int size, const float f);
226 void add_vn_vn(float *array_tar, const float *array_src, const int size);
227 void add_vn_vnvn(float *array_tar, const float *array_src_a, const float *array_src_b, const int size);
228 void sub_vn_vn(float *array_tar, const float *array_src, const int size);
229 void sub_vn_vnvn(float *array_tar, const float *array_src_a, const float *array_src_b, const int size);
230 void fill_vn_i(int *array_tar, const int size, const int val);
231 void fill_vn_fl(float *array_tar, const int size, const float val);
232
233 #ifdef __cplusplus
234 }
235 #endif
236
237 #endif /* __BLI_MATH_VECTOR_H__ */
238