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