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