svn merge ^/trunk/blender -r41150:41175
[blender.git] / source / blender / blenlib / BLI_math_vector.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: some of this file.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  * */
27
28 #ifndef BLI_MATH_VECTOR_H
29 #define BLI_MATH_VECTOR_H
30
31 /** \file BLI_math_vector.h
32  *  \ingroup bli
33  */
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 #include "BLI_math_inline.h"
40
41 #ifdef BLI_MATH_INLINE_H
42 #include "intern/math_vector_inline.c"
43 #else
44 #define MINLINE
45 #endif
46
47 /************************************* Init ***********************************/
48
49 MINLINE void zero_v2(float r[2]);
50 MINLINE void zero_v3(float r[3]);
51 MINLINE void zero_v4(float r[4]);
52
53 MINLINE void copy_v2_v2(float r[2], const float a[2]);
54 MINLINE void copy_v3_v3(float r[3], const float a[3]);
55 MINLINE void copy_v4_v4(float r[4], const float a[4]);
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 /* 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
66
67 /********************************* Arithmetic ********************************/
68
69 MINLINE void add_v3_fl(float r[3], float f);
70 MINLINE void add_v4_fl(float r[4], float f);
71 MINLINE void add_v2_v2(float r[2], const float a[2]);
72 MINLINE void add_v2_v2v2(float r[2], const float a[2], const float b[2]);
73 MINLINE void add_v3_v3(float r[3], const float a[3]);
74 MINLINE void add_v3_v3v3(float r[3], const float a[3], const float b[3]);
75
76 MINLINE void sub_v2_v2(float r[2], const float a[2]);
77 MINLINE void sub_v2_v2v2(float r[2], const float a[2], const float b[2]);
78 MINLINE void sub_v3_v3(float r[3], const float a[3]);
79 MINLINE void sub_v3_v3v3(float r[3], const float a[3], const float b[3]);
80 MINLINE void sub_v4_v4(float r[4], const float a[4]);
81 MINLINE void sub_v4_v4v4(float r[4], const float a[4], const float b[4]);
82
83 MINLINE void mul_v2_fl(float r[2], float f);
84 MINLINE void mul_v2_v2fl(float r[2], const float a[2], float f);
85 MINLINE void mul_v3_fl(float r[3], float f);
86 MINLINE void mul_v3_v3fl(float r[3], const float a[3], float f);
87 MINLINE void mul_v2_v2(float r[2], const float a[2]);
88 MINLINE void mul_v3_v3(float r[3], const float a[3]);
89 MINLINE void mul_v3_v3v3(float r[3], const float a[3], const float b[3]);
90 MINLINE void mul_v4_fl(float r[4], float f);
91
92 MINLINE void madd_v3_v3fl(float r[3], const float a[3], float f);
93 MINLINE void madd_v3_v3v3(float r[3], const float a[3], const float b[3]);
94 MINLINE void madd_v2_v2v2fl(float r[2], const float a[2], const float b[2], float f);
95 MINLINE void madd_v3_v3v3fl(float r[3], const float a[3], const float b[3], float f);
96 MINLINE void madd_v3_v3v3v3(float r[3], const float a[3], const float b[3], const float c[3]);
97 MINLINE void madd_v4_v4fl(float r[4], const float a[4], float f);
98
99 MINLINE void negate_v3(float r[3]);
100 MINLINE void negate_v3_v3(float r[3], const float a[3]);
101 MINLINE void negate_v4(float r[4]);
102 MINLINE void negate_v4_v4(float r[4], const float a[3]);
103
104 MINLINE float dot_v2v2(const float a[2], const float b[2]);
105 MINLINE float dot_v3v3(const float a[3], const float b[3]);
106
107 MINLINE float cross_v2v2(const float a[2], const float b[2]);
108 MINLINE void cross_v3_v3v3(float r[3], const float a[3], const float b[3]);
109
110 MINLINE void star_m3_v3(float rmat[3][3],float a[3]);
111
112 /*********************************** Length **********************************/
113
114 MINLINE float len_v2(const float a[2]);
115 MINLINE float len_v2v2(const float a[2], const float b[2]);
116 MINLINE float len_squared_v2v2(const float a[3], const float b[3]);
117 MINLINE float len_v3(const float a[3]);
118 MINLINE float len_v3v3(const float a[3], const float b[3]);
119 MINLINE float len_squared_v3v3(const float a[3], const float b[3]);
120
121 MINLINE float normalize_v2(float r[2]);
122 MINLINE float normalize_v2_v2(float r[2], const float a[2]);
123 MINLINE float normalize_v3(float r[3]);
124 MINLINE float normalize_v3_v3(float r[3], const float a[3]);
125
126 /******************************* Interpolation *******************************/
127
128 void interp_v2_v2v2(float r[2], const float a[2], const float b[2], const float t);
129 void interp_v2_v2v2v2(float r[2], const float a[2], const float b[2], const float c[3], const float t[3]);
130 void interp_v3_v3v3(float r[3], const float a[3], const float b[3], const float t);
131 void interp_v3_v3v3v3(float p[3], const float v1[3], const float v2[3], const float v3[3], const float w[3]);
132 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]);
133 void interp_v4_v4v4(float r[4], const float a[4], const float b[4], const float t);
134 void interp_v4_v4v4v4(float p[4], const float v1[4], const float v2[4], const float v3[4], const float w[3]);
135 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]);
136
137 void mid_v3_v3v3(float r[3], const float a[3], const float b[3]);
138
139 /********************************* Comparison ********************************/
140
141 MINLINE int is_zero_v3(const float a[3]);
142 MINLINE int is_zero_v4(const float a[4]);
143 MINLINE int is_one_v3(const float a[3]);
144
145 MINLINE int equals_v2v2(const float v1[2], const float v2[2]);
146 MINLINE int equals_v3v3(const float a[3], const float b[3]);
147 MINLINE int compare_v3v3(const float a[3], const float b[3], const float limit);
148 MINLINE int compare_len_v3v3(const float a[3], const float b[3], const float limit);
149
150 MINLINE int compare_v4v4(const float a[4], const float b[4], const float limit);
151 MINLINE int equals_v4v4(const float a[4], const float b[4]);
152
153 MINLINE float line_point_side_v2(const float l1[2], const float l2[2], const float pt[2]);
154
155 /********************************** Angles ***********************************/
156 /* - angle with 2 arguments is angle between vector                          */
157 /* - angle with 3 arguments is angle between 3 points at the middle point    */
158 /* - angle_normalized_* is faster equivalent if vectors are normalized       */
159
160 float angle_v2v2(const float a[2], const float b[2]);
161 float angle_v2v2v2(const float a[2], const float b[2], const float c[2]);
162 float angle_normalized_v2v2(const float a[2], const float b[2]);
163 float angle_v3v3(const float a[3], const float b[3]);
164 float angle_v3v3v3(const float a[3], const float b[3], const float c[3]);
165 float angle_normalized_v3v3(const float v1[3], const float v2[3]);
166 void angle_tri_v3(float angles[3], const float v1[3], const float v2[3], const float v3[3]);
167 void angle_quad_v3(float angles[4], const float v1[3], const float v2[3], const float v3[3], const float v4[3]);
168 void angle_poly_v3(float* angles, const float* verts[3], int len);
169
170 /********************************* Geometry **********************************/
171
172 void project_v2_v2v2(float c[2], const float v1[2], const float v2[2]);
173 void project_v3_v3v3(float r[3], const float p[3], const float n[3]);
174 void reflect_v3_v3v3(float r[3], const float v[3], const float n[3]);
175 void ortho_basis_v3v3_v3(float r1[3], float r2[3], const float a[3]);
176 void bisect_v3_v3v3v3(float r[3], const float a[3], const float b[3], const float c[3]);
177 void rotate_v3_v3v3fl(float v[3], const float p[3], const float axis[3], const float angle);
178 void rotate_normalized_v3_v3v3fl(float v[3], const float p[3], const float axis[3], const float angle);
179
180 /*********************************** Other ***********************************/
181
182 void print_v2(const char *str, const float a[2]);
183 void print_v3(const char *str, const float a[3]);
184 void print_v4(const char *str, const float a[4]);
185
186 MINLINE void normal_short_to_float_v3(float r[3], const short n[3]);
187 MINLINE void normal_float_to_short_v3(short r[3], const float n[3]);
188
189 void minmax_v3v3_v3(float min[3], float max[3], const float vec[3]);
190
191 /***************************** Array Functions *******************************/
192 /* attempted to follow fixed length vertex functions. names could be improved*/
193 void range_vni(int *array, const int size, const int start);
194 void negate_vn(float *array_tar, const int size);
195 void negate_vn_vn(float *array_tar, const float *array_src, const int size);
196 void mul_vn_fl(float *array, const int size, const float f);
197 void mul_vn_vn_fl(float *array_tar, const float *array_src, const int size, const float f);
198 void add_vn_vn(float *array_tar, const float *array_src, const int size);
199 void add_vn_vnvn(float *array_tar, const float *array_src_a, const float *array_src_b, const int size);
200 void sub_vn_vn(float *array_tar, const float *array_src, const int size);
201 void sub_vn_vnvn(float *array_tar, const float *array_src_a, const float *array_src_b, const int size);
202 void fill_vni(int *array_tar, const int size, const int val);
203 void fill_vn(float *array_tar, const int size, const float val);
204
205 #ifdef __cplusplus
206 }
207 #endif
208
209 #endif /* BLI_MATH_VECTOR_H */
210