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