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