Merge with trunk r37849
[blender.git] / source / blender / blenlib / BLI_math_geom.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_GEOM_H
29 #define BLI_MATH_GEOM_H
30
31 /** \file BLI_math_geom.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_geom_inline.c"
43 #endif
44
45 /********************************** Polygons *********************************/
46
47 void cent_tri_v3(float r[3], const float a[3], const float b[3], const float c[3]);
48 void cent_quad_v3(float r[3], const float a[3], const float b[3], const float c[3], const float d[3]);
49
50 float normal_tri_v3(float r[3], const float a[3], const float b[3], const float c[3]);
51 float normal_quad_v3(float r[3], const float a[3], const float b[3], const float c[3], const float d[3]);
52
53 float area_tri_v2(const float a[2], const float b[2], const float c[2]);
54 float area_tri_signed_v2(const float v1[2], const float v2[2], const float v3[2]);
55 float area_tri_v3(const float a[3], const float b[3], const float c[3]);
56 float area_quad_v3(const float a[3], const float b[3], const float c[3], const float d[3]);
57 float area_poly_v3(int nr, float verts[][3], const float normal[3]);
58
59 /********************************* Distance **********************************/
60
61 float dist_to_line_v2(const float p[2], const float l1[2], const float l2[2]);
62 float dist_to_line_segment_v2(const float p[2], const float l1[2], const float l2[2]);
63 void closest_to_line_segment_v2(float *closest, float p[2], float l1[2], float l2[2]);
64
65 float dist_to_line_segment_v3(const float p[3], const float l1[3], const float l2[3]);
66 float closest_to_line_v3(float r[3], const float p[3], const float l1[3], const float l2[3]);
67 float closest_to_line_v2(float r[2], const float p[2], const float l1[2], const float l2[2]);
68 void closest_to_line_segment_v3(float r[3], const float p[3], const float l1[3], const float l2[3]);
69
70 float line_point_factor_v3(const float p[3], const float l1[3], const float l2[3]);
71 float line_point_factor_v2(const float p[2], const float l1[2], const float l2[2]);
72
73 /******************************* Intersection ********************************/
74
75 /* TODO int return value consistency */
76
77 /* line-line */
78 #define ISECT_LINE_LINE_COLINEAR        -1
79 #define ISECT_LINE_LINE_NONE             0
80 #define ISECT_LINE_LINE_EXACT            1
81 #define ISECT_LINE_LINE_CROSS            2
82
83 int isect_line_line_v2(const float a1[2], const float a2[2], const float b1[2], const float b2[2]);
84 int isect_line_line_v2_int(const int a1[2], const int a2[2], const int b1[2], const int b2[2]);
85 int isect_line_sphere_v3(const float l1[3], const float l2[3], const float sp[3], const float r, float r_p1[3], float r_p2[3]);
86 int isect_line_sphere_v2(const float l1[2], const float l2[2], const float sp[2], const float r, float r_p1[2], float r_p2[2]);
87 int isect_seg_seg_v2_point(const float v1[2], const float v2[2], const float v3[2], const float v4[2], float vi[2]);
88
89 /* Returns the number of point of interests
90  * 0 - lines are colinear
91  * 1 - lines are coplanar, i1 is set to intersection
92  * 2 - i1 and i2 are the nearest points on line 1 (v1, v2) and line 2 (v3, v4) respectively 
93  * */
94
95 int isect_line_line_v3(const float v1[3], const float v2[3],
96         const float v3[3], const float v4[3], float i1[3], float i2[3]);
97 int isect_line_line_strict_v3(const float v1[3], const float v2[3],
98         const float v3[3], const float v4[3], float vi[3], float *lambda);
99
100 /*if clip is nonzero, will only return true if lambda is >= 0.0
101   (i.e. intersection point is along positive d)*/
102 int isect_ray_plane_v3(float p1[3], float d[3], float v0[3], 
103                                            float v1[3], float v2[3], float *lambda, int clip);
104
105 /**
106  * Intersect line/plane, optionally treat line as directional (like a ray) with the no_flip argument.
107  * @param out The intersection point.
108  * @param l1 The first point of the line.
109  * @param l2 The second point of the line.
110  * @param plane_co A point on the plane to intersect with.
111  * @param plane_no The direction of the plane (does not need to be normalized).
112  * @param no_flip When true, the intersection point will always be from l1 to l2, even if this is not on the plane.
113  */
114 int isect_line_plane_v3(float out[3], const float l1[3], const float l2[3],
115                         const float plane_co[3], const float plane_no[3], const short no_flip);
116
117 /* line/ray triangle */
118 int isect_line_tri_v3(const float p1[3], const float p2[3],
119         const float v0[3], const float v1[3], const float v2[3], float *lambda, float uv[2]);
120 int isect_ray_tri_v3(const float p1[3], const float d[3],
121         const float v0[3], const float v1[3], const float v2[3], float *lambda, float uv[2]);
122 int isect_ray_tri_threshold_v3(const float p1[3], const float d[3],
123         const float v0[3], const float v1[3], const float v2[3], float *lambda, float uv[2], const float threshold);
124 int isect_ray_tri_epsilon_v3(const float p1[3], const float d[3],
125         const float v0[3], const float v1[3], const float v2[3], float *lambda, float uv[2], const float epsilon);
126
127 /* point in polygon */
128 int isect_point_quad_v2(const float p[2], const float a[2], const float b[2], const float c[2], const float d[2]);
129
130 int isect_point_tri_v2(const float v1[2], const float v2[2], const float v3[2], const float pt[2]);
131 int isect_point_tri_v2_int(const int x1, const int y1, const int x2, const int y2, const int a, const int b);
132 int isect_point_tri_prism_v3(const float p[3], const float v1[3], const float v2[3], const float v3[3]);
133
134 void isect_point_quad_uv_v2(const float v0[2], const float v1[2], const float v2[2], const float v3[2],
135         const float pt[2], float *uv);
136 void isect_point_face_uv_v2(const int isquad, const float v0[2], const float v1[2], const float v2[2],
137         const float v3[2], const float pt[2], float *uv);
138
139 /* other */
140 int isect_sweeping_sphere_tri_v3(const float p1[3], const float p2[3], const float radius,
141         const float v0[3], const float v1[3], const float v2[3], float *lambda, float ipoint[3]);
142
143 int isect_axial_line_tri_v3(const int axis, const float co1[3], const float co2[3],
144         const float v0[3], const float v1[3], const float v2[3], float *lambda);
145
146 int isect_aabb_aabb_v3(const float min1[3], const float max1[3], const float min2[3], const float max2[3]);
147
148 int clip_line_plane(float p1[3], float p2[3], const float plane[4]);
149
150 void plot_line_v2v2i(const int p1[2], const int p2[2], int (*callback)(int, int, void *), void *userData);
151
152 /****************************** Interpolation ********************************/
153
154 /* tri or quad, d can be NULL */
155 void interp_weights_face_v3(float w[4],
156         const float a[3], const float b[3], const float c[3], const float d[3], const float p[3]);
157 void interp_weights_poly_v3(float w[], float v[][3], const int n, const float p[3]);
158
159 void interp_cubic_v3(float x[3], float v[3],
160         const float x1[3], const float v1[3], const float x2[3], const float v2[3], const float t);
161
162 int interp_sparse_array(float *array, const int list_size, const float invalid);
163
164 void barycentric_transform(float pt_tar[3], float const pt_src[3],
165         const float tri_tar_p1[3], const float tri_tar_p2[3], const float tri_tar_p3[3],
166         const float tri_src_p1[3], const float tri_src_p2[3], const float tri_src_p3[3]);
167
168 void barycentric_weights_v2(const float v1[2], const float v2[2], const float v3[2],
169         const float co[2], float w[3]);
170
171 void resolve_tri_uv(float uv[2], const float st[2], const float st0[2], const float st1[2], const float st2[2]);
172 void resolve_quad_uv(float uv[2], const float st[2], const float st0[2], const float st1[2], const float st2[2], const float st3[2]);
173
174 /***************************** View & Projection *****************************/
175
176 void lookat_m4(float mat[4][4], float vx, float vy, 
177         float vz, float px, float py, float pz, float twist);
178 void polarview_m4(float mat[4][4], float dist, float azimuth,
179         float incidence, float twist);
180
181 void perspective_m4(float mat[4][4], const float left, const float right,
182         const float bottom, const float top, const float nearClip, const float farClip);
183 void orthographic_m4(float mat[4][4], const float left, const float right,
184         const float bottom, const float top, const float nearClip, const float farClip);
185 void window_translate_m4(float winmat[][4], float perspmat[][4],
186         const float x, const float y);
187
188 int box_clip_bounds_m4(float boundbox[2][3],
189         const float bounds[4], float winmat[4][4]);
190 void box_minmax_bounds_m4(float min[3], float max[3],
191         float boundbox[2][3], float mat[4][4]);
192
193 /********************************** Mapping **********************************/
194
195 void map_to_tube(float *u, float *v, const float x, const float y, const float z);
196 void map_to_sphere(float *u, float *v, const float x, const float y, const float z);
197
198 /********************************** Normals **********************************/
199
200 void accumulate_vertex_normals(float n1[3], float n2[3], float n3[3],
201         float n4[3], const float f_no[3], const float co1[3], const float co2[3],
202         const float co3[3], const float co4[3]);
203
204 /********************************* Tangents **********************************/
205
206 typedef struct VertexTangent {
207         struct VertexTangent *next;
208         float tang[3], uv[2];
209 } VertexTangent;
210
211 float *find_vertex_tangent(VertexTangent *vtang, const float uv[2]);
212 void sum_or_add_vertex_tangent(void *arena, VertexTangent **vtang,
213         const float tang[3], const float uv[2]);
214 void tangent_from_uv(float uv1[2], float uv2[2], float uv3[2],
215         float co1[3], float co2[3], float co3[3], float n[3], float tang[3]);
216
217 /******************************** Vector Clouds ******************************/
218
219 void vcloud_estimate_transform(int list_size, float (*pos)[3], float *weight,
220         float (*rpos)[3], float *rweight,
221         float lloc[3],float rloc[3],float lrot[3][3],float lscale[3][3]);
222
223 /****************************** Spherical Harmonics *************************/
224
225 /* Uses 2nd order SH => 9 coefficients, stored in this order:
226    0 = (0,0),
227    1 = (1,-1), 2 = (1,0), 3 = (1,1),
228    4 = (2,-2), 5 = (2,-1), 6 = (2,0), 7 = (2,1), 8 = (2,2) */
229
230 MINLINE void zero_sh(float r[9]);
231 MINLINE void copy_sh_sh(float r[9], const float a[9]);
232 MINLINE void mul_sh_fl(float r[9], const float f);
233 MINLINE void add_sh_shsh(float r[9], const float a[9], const float b[9]);
234
235 MINLINE float eval_shv3(float r[9], const float v[3]);
236 MINLINE float diffuse_shv3(float r[9], const float v[3]);
237 MINLINE void vec_fac_to_sh(float r[9], const float v[3], const float f);
238 MINLINE void madd_sh_shfl(float r[9], const float sh[3], const float f);
239
240 /********************************* Form Factor *******************************/
241
242 float form_factor_hemi_poly(float p[3], float n[3],
243         float v1[3], float v2[3], float v3[3], float v4[3]);
244
245 #ifdef __cplusplus
246 }
247 #endif
248
249 #endif /* BLI_MATH_GEOM_H */
250