Patch [#33196] Warning Fixes 11-16-2012
[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 #if BLI_MATH_DO_INLINE
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 zero_v3_int(int r[3]);
71 MINLINE void copy_v2_v2_int(int r[2], const int a[2]);
72 MINLINE void copy_v3_v3_int(int r[3], const int a[3]);
73 MINLINE void copy_v4_v4_int(int r[4], const int a[4]);
74 /* double -> float */
75 MINLINE void copy_v2fl_v2db(float r[2], const double a[2]);
76 MINLINE void copy_v3fl_v3db(float r[3], const double a[3]);
77 MINLINE void copy_v4fl_v4db(float r[4], const double a[4]);
78 /* float -> double */
79 MINLINE void copy_v2db_v2fl(double r[2], const float a[2]);
80 MINLINE void copy_v3db_v3fl(double r[3], const float a[3]);
81 MINLINE void copy_v4db_v4fl(double r[4], const float a[4]);
82
83 /********************************* Arithmetic ********************************/
84
85 MINLINE void add_v2_fl(float r[2], float f);
86 MINLINE void add_v3_fl(float r[3], float f);
87 MINLINE void add_v4_fl(float r[4], float f);
88 MINLINE void add_v2_v2(float r[2], const float a[2]);
89 MINLINE void add_v2_v2v2(float r[2], const float a[2], const float b[2]);
90 MINLINE void add_v3_v3(float r[3], const float a[3]);
91 MINLINE void add_v3_v3v3(float r[3], const float a[3], const float b[3]);
92 MINLINE void add_v4_v4(float r[4], const float a[4]);
93 MINLINE void add_v4_v4v4(float r[4], const float a[4], const float b[4]);
94
95 MINLINE void sub_v2_v2(float r[2], const float a[2]);
96 MINLINE void sub_v2_v2v2(float r[2], const float a[2], const float b[2]);
97 MINLINE void sub_v3_v3(float r[3], const float a[3]);
98 MINLINE void sub_v3_v3v3(float r[3], const float a[3], const float b[3]);
99 MINLINE void sub_v4_v4(float r[4], const float a[4]);
100 MINLINE void sub_v4_v4v4(float r[4], const float a[4], const float b[4]);
101
102 MINLINE void mul_v2_fl(float r[2], float f);
103 MINLINE void mul_v2_v2fl(float r[2], const float a[2], float f);
104 MINLINE void mul_v3_fl(float r[3], float f);
105 MINLINE void mul_v3_v3fl(float r[3], const float a[3], float f);
106 MINLINE void mul_v2_v2(float r[2], const float a[2]);
107 MINLINE void mul_v3_v3(float r[3], const float a[3]);
108 MINLINE void mul_v3_v3v3(float r[3], const float a[3], const float b[3]);
109 MINLINE void mul_v4_fl(float r[4], float f);
110 MINLINE void mul_v4_v4fl(float r[3], const float a[3], float f);
111
112 MINLINE void madd_v3_v3fl(float r[3], const float a[3], float f);
113 MINLINE void madd_v3_v3v3(float r[3], const float a[3], const float b[3]);
114 MINLINE void madd_v2_v2v2fl(float r[2], const float a[2], const float b[2], float f);
115 MINLINE void madd_v3_v3v3fl(float r[3], const float a[3], const float b[3], float f);
116 MINLINE void madd_v3_v3v3v3(float r[3], const float a[3], const float b[3], const float c[3]);
117 MINLINE void madd_v4_v4fl(float r[4], const float a[4], float f);
118 MINLINE void madd_v4_v4v4(float r[4], const float a[4], const float b[4]);
119
120 MINLINE void negate_v2(float r[2]);
121 MINLINE void negate_v2_v2(float r[2], const float a[2]);
122 MINLINE void negate_v3(float r[3]);
123 MINLINE void negate_v3_v3(float r[3], const float a[3]);
124 MINLINE void negate_v4(float r[4]);
125 MINLINE void negate_v4_v4(float r[4], const float a[3]);
126
127 MINLINE void negate_v3_short(short r[3]);
128
129 MINLINE float dot_v2v2(const float a[2], const float b[2]);
130 MINLINE float dot_v3v3(const float a[3], const float b[3]);
131
132 MINLINE float cross_v2v2(const float a[2], const float b[2]);
133 MINLINE void cross_v3_v3v3(float r[3], const float a[3], const float b[3]);
134
135 MINLINE void add_newell_cross_v3_v3v3(float n[3], const float v_prev[3], const float v_curr[3]);
136
137 MINLINE void star_m3_v3(float rmat[3][3], float a[3]);
138
139 /*********************************** Length **********************************/
140
141 MINLINE float len_squared_v2(const float v[2]);
142 MINLINE float len_squared_v3(const float v[3]);
143 MINLINE float len_manhattan_v2(const float v[2]);
144 MINLINE float len_manhattan_v3(const float v[3]);
145 MINLINE float len_v2(const float a[2]);
146 MINLINE float len_v2v2(const float a[2], const float b[2]);
147 MINLINE float len_squared_v2v2(const float a[2], const float b[2]);
148 MINLINE float len_squared_v3v3(const float a[3], const float b[3]);
149 MINLINE float len_manhattan_v2v2(const float a[2], const float b[2]);
150 MINLINE float len_manhattan_v3v3(const float a[3], const float b[3]);
151 MINLINE float len_v3(const float a[3]);
152 MINLINE float len_v3v3(const float a[3], const float b[3]);
153
154 MINLINE float normalize_v2(float r[2]);
155 MINLINE float normalize_v2_v2(float r[2], const float a[2]);
156 MINLINE float normalize_v3(float r[3]);
157 MINLINE float normalize_v3_v3(float r[3], const float a[3]);
158
159 /******************************* Interpolation *******************************/
160
161 void interp_v2_v2v2(float r[2], const float a[2], const float b[2], const float t);
162 void interp_v2_v2v2v2(float r[2], const float a[2], const float b[2], const float c[3], const float t[3]);
163 void interp_v3_v3v3(float r[3], const float a[3], const float b[3], const float t);
164 void interp_v3_v3v3v3(float p[3], const float v1[3], const float v2[3], const float v3[3], const float w[3]);
165 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]);
166 void interp_v4_v4v4(float r[4], const float a[4], const float b[4], const float t);
167 void interp_v4_v4v4v4(float p[4], const float v1[4], const float v2[4], const float v3[4], const float w[3]);
168 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]);
169
170 void mid_v3_v3v3(float r[3], const float a[3], const float b[3]);
171 void mid_v2_v2v2(float r[2], const float a[2], const float b[2]);
172 void mid_v3_v3v3v3(float v[3], const float v1[3], const float v2[3], const float v3[3]);
173
174 /********************************* Comparison ********************************/
175
176 MINLINE int is_zero_v3(const float a[3]);
177 MINLINE int is_zero_v4(const float a[4]);
178 MINLINE int is_one_v3(const float a[3]);
179
180 MINLINE int equals_v2v2(const float v1[2], const float v2[2]);
181 MINLINE int equals_v3v3(const float a[3], const float b[3]);
182 MINLINE int compare_v2v2(const float a[3], const float b[3], const float limit);
183 MINLINE int compare_v3v3(const float a[3], const float b[3], const float limit);
184 MINLINE int compare_len_v3v3(const float a[3], const float b[3], const float limit);
185
186 MINLINE int compare_v4v4(const float a[4], const float b[4], const float limit);
187 MINLINE int equals_v4v4(const float a[4], const float b[4]);
188
189 MINLINE float line_point_side_v2(const float l1[2], const float l2[2], const float pt[2]);
190
191 /********************************** Angles ***********************************/
192 /* - angle with 2 arguments is angle between vector                          */
193 /* - angle with 3 arguments is angle between 3 points at the middle point    */
194 /* - angle_normalized_* is faster equivalent if vectors are normalized       */
195
196 float angle_v2v2(const float a[2], const float b[2]);
197 float angle_signed_v2v2(const float v1[2], const float v2[2]);
198 float angle_v2v2v2(const float a[2], const float b[2], const float c[2]);
199 float angle_normalized_v2v2(const float a[2], const float b[2]);
200 float angle_v3v3(const float a[3], const float b[3]);
201 float angle_v3v3v3(const float a[3], const float b[3], const float c[3]);
202 float cos_v3v3v3(const float p1[3], const float p2[3], const float p3[3]);
203 float angle_normalized_v3v3(const float v1[3], const float v2[3]);
204 float angle_on_axis_v3v3v3_v3(const float v1[3], const float v2[3], const float v3[3], const float axis[3]);
205 void angle_tri_v3(float angles[3], const float v1[3], const float v2[3], const float v3[3]);
206 void angle_quad_v3(float angles[4], const float v1[3], const float v2[3], const float v3[3], const float v4[3]);
207 void angle_poly_v3(float *angles, const float *verts[3], int len);
208
209 /********************************* Geometry **********************************/
210
211 void project_v2_v2v2(float c[2], const float v1[2], const float v2[2]);
212 void project_v3_v3v3(float r[3], const float p[3], const float n[3]);
213 void project_v3_plane(float v[3], const float n[3], const float p[3]);
214 void reflect_v3_v3v3(float r[3], const float v[3], const float n[3]);
215 void ortho_basis_v3v3_v3(float r1[3], float r2[3], const float a[3]);
216 void bisect_v3_v3v3v3(float r[3], const float a[3], const float b[3], const float c[3]);
217 void rotate_v3_v3v3fl(float v[3], const float p[3], const float axis[3], const float angle);
218 void rotate_normalized_v3_v3v3fl(float v[3], const float p[3], const float axis[3], const float angle);
219
220 /*********************************** Other ***********************************/
221
222 void print_v2(const char *str, const float a[2]);
223 void print_v3(const char *str, const float a[3]);
224 void print_v4(const char *str, const float a[4]);
225
226 MINLINE void normal_short_to_float_v3(float r[3], const short n[3]);
227 MINLINE void normal_float_to_short_v3(short r[3], const float n[3]);
228
229 void minmax_v3v3_v3(float min[3], float max[3], const float vec[3]);
230 void minmax_v2v2_v2(float min[2], float max[2], const float vec[2]);
231
232 void dist_ensure_v3_v3fl(float v1[3], const float v2[3], const float dist);
233 void dist_ensure_v2_v2fl(float v1[2], const float v2[2], const float dist);
234
235 /***************************** Array Functions *******************************/
236 /* attempted to follow fixed length vertex functions. names could be improved*/
237 double dot_vn_vn(const float *array_src_a, const float *array_src_b, const int size);
238 float normalize_vn_vn(float *array_tar, const float *array_src, const int size);
239 float normalize_vn(float *array_tar, const int size);
240 void range_vn_i(int *array_tar, const int size, const int start);
241 void range_vn_fl(float *array_tar, const int size, const float start, const float step);
242 void negate_vn(float *array_tar, const int size);
243 void negate_vn_vn(float *array_tar, const float *array_src, const int size);
244 void mul_vn_fl(float *array_tar, const int size, const float f);
245 void mul_vn_vn_fl(float *array_tar, const float *array_src, const int size, const float f);
246 void add_vn_vn(float *array_tar, const float *array_src, const int size);
247 void add_vn_vnvn(float *array_tar, const float *array_src_a, const float *array_src_b, const int size);
248 void madd_vn_vn(float *array_tar, const float *array_src, const float f, const int size);
249 void madd_vn_vnvn(float *array_tar, const float *array_src_a, const float *array_src_b, const float f, const int size);
250 void sub_vn_vn(float *array_tar, const float *array_src, const int size);
251 void sub_vn_vnvn(float *array_tar, const float *array_src_a, const float *array_src_b, const int size);
252 void msub_vn_vn(float *array_tar, const float *array_src, const float f, const int size);
253 void msub_vn_vnvn(float *array_tar, const float *array_src_a, const float *array_src_b, const float f, const int size);
254 void fill_vn_i(int *array_tar, const int size, const int val);
255 void fill_vn_ushort(unsigned short *array_tar, const int size, const unsigned short val);
256 void fill_vn_fl(float *array_tar, const int size, const float val);
257
258 #ifdef __cplusplus
259 }
260 #endif
261
262 #endif /* __BLI_MATH_VECTOR_H__ */