doxygen: editor entry
[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], float a[3], float b[3], float c[3]);
48 void cent_quad_v3(float r[3], float a[3], float b[3], float c[3], 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], float normal[3]);
58
59 /********************************* Distance **********************************/
60
61 float dist_to_line_v2(float p[2], float l1[2], float l2[2]);
62 float dist_to_line_segment_v2(float p[2], float l1[2], float l2[2]);
63
64 float dist_to_line_segment_v3(float p[3], float l1[3], float l2[3]);
65 float closest_to_line_v3(float r[3], const float p[3], const float l1[3], const float l2[3]);
66 float closest_to_line_v2(float r[2], const float p[2], const float l1[2], const float l2[2]);
67 void closest_to_line_segment_v3(float r[3], float p[3], float l1[3], float l2[3]);
68
69 /******************************* Intersection ********************************/
70
71 /* TODO int return value consistency */
72
73 /* line-line */
74 #define ISECT_LINE_LINE_COLINEAR        -1
75 #define ISECT_LINE_LINE_NONE             0
76 #define ISECT_LINE_LINE_EXACT            1
77 #define ISECT_LINE_LINE_CROSS            2
78
79 int isect_line_line_v2(const float a1[2], const float a2[2], const float b1[2], const float b2[2]);
80 int isect_line_line_v2_short(const short a1[2], const short a2[2], const short b1[2], const short b2[2]);
81 int isect_seg_seg_v2_point(const float *v1, const float *v2, const float *v3, const float *v4, float vi[2]);
82
83 /* Returns the number of point of interests
84  * 0 - lines are colinear
85  * 1 - lines are coplanar, i1 is set to intersection
86  * 2 - i1 and i2 are the nearest points on line 1 (v1, v2) and line 2 (v3, v4) respectively 
87  * */
88
89 int isect_line_line_v3(float v1[3], float v2[3],
90         float v3[3], float v4[3], float i1[3], float i2[3]);
91 int isect_line_line_strict_v3(float v1[3], float v2[3],
92         float v3[3], float v4[3], float vi[3], float *lambda);
93
94 /* line/ray triangle */
95 int isect_line_tri_v3(float p1[3], float p2[3],
96         float v0[3], float v1[3], float v2[3], float *lambda, float *uv);
97 int isect_ray_tri_v3(float p1[3], float d[3],
98         float v0[3], float v1[3], float v2[3], float *lambda, float *uv);
99 int isect_ray_tri_threshold_v3(float p1[3], float d[3],
100         float v0[3], float v1[3], float v2[3], float *lambda, float *uv, float threshold);
101 int isect_ray_tri_epsilon_v3(float p1[3], float d[3],
102         float v0[3], float v1[3], float v2[3], float *lambda, float *uv, float epsilon);
103
104 /* point in polygon */
105 int isect_point_quad_v2(float p[2], float a[2], float b[2], float c[2], float d[2]);
106
107 int isect_point_tri_v2(float v1[2], float v2[2], float v3[2], float pt[2]);
108 int isect_point_tri_v2_int(int x1, int y1, int x2, int y2, int a, int b);
109 int isect_point_tri_prism_v3(float p[3], float v1[3], float v2[3], float v3[3]);
110
111 void isect_point_quad_uv_v2(float v0[2], float v1[2], float v2[2], float v3[2],
112         float pt[2], float *uv);
113 void isect_point_face_uv_v2(int isquad, float v0[2], float v1[2], float v2[2],
114         float v3[2], float pt[2], float *uv);
115
116 /* other */
117 int isect_sweeping_sphere_tri_v3(float p1[3], float p2[3], float radius,
118         float v0[3], float v1[3], float v2[3], float *lambda, float *ipoint);
119
120 int isect_axial_line_tri_v3(int axis, float co1[3], float co2[3],
121         float v0[3], float v1[3], float v2[3], float *lambda);
122
123 int isect_aabb_aabb_v3(float min1[3], float max1[3], float min2[3], float max2[3]);
124
125 int clip_line_plane(float clipco[3], float plane[4], float co[3]);
126
127 void plot_line_v2v2i(int p1[2], int p2[2], int (*callback)(int, int, void *), void *userData);
128
129 /****************************** Interpolation ********************************/
130
131 /* tri or quad, d can be NULL */
132 void interp_weights_face_v3(float w[4],
133         float a[3], float b[3], float c[3], float d[3], float p[3]);
134 void interp_weights_poly_v3(float w[], float v[][3], int n, float p[3]);
135
136 void interp_cubic_v3(float x[3], float v[3],
137         float x1[3], float v1[3], float x2[3], float v2[3], float t);
138
139 int interp_sparse_array(float *array, int list_size, float invalid);
140
141 void barycentric_transform(float pt_tar[3], float const pt_src[3],
142         const float tri_tar_p1[3], const float tri_tar_p2[3], const float tri_tar_p3[3],
143         const float tri_src_p1[3], const float tri_src_p2[3], const float tri_src_p3[3]);
144
145 void barycentric_weights_v2(const float v1[2], const float v2[2], const float v3[2],
146         const float co[2], float w[3]);
147
148 /***************************** View & Projection *****************************/
149
150 void lookat_m4(float mat[4][4], float vx, float vy, 
151         float vz, float px, float py, float pz, float twist);
152 void polarview_m4(float mat[4][4], float dist, float azimuth,
153         float incidence, float twist);
154
155 void perspective_m4(float mat[4][4], float left, float right,
156         float bottom, float top, float nearClip, float farClip);
157 void orthographic_m4(float mat[4][4], float left, float right,
158         float bottom, float top, float nearClip, float farClip);
159 void window_translate_m4(float winmat[][4], float perspmat[][4],
160         float x, float y);
161
162 int box_clip_bounds_m4(float boundbox[2][3],
163         float bounds[4], float winmat[4][4]);
164 void box_minmax_bounds_m4(float min[3], float max[3],
165         float boundbox[2][3], float mat[4][4]);
166
167 /********************************** Mapping **********************************/
168
169 void map_to_tube(float *u, float *v, float x, float y, float z);
170 void map_to_sphere(float *u, float *v, float x, float y, float z);
171
172 /********************************* Tangents **********************************/
173
174 typedef struct VertexTangent {
175         struct VertexTangent *next;
176         float tang[3], uv[2];
177 } VertexTangent;
178
179 float *find_vertex_tangent(VertexTangent *vtang, float *uv);
180 void sum_or_add_vertex_tangent(void *arena, VertexTangent **vtang,
181         float *tang, float *uv);
182 void tangent_from_uv(float *uv1, float *uv2, float *uv3,
183         float *co1, float *co2, float *co3, float *n, float *tang);
184
185 /******************************** Vector Clouds ******************************/
186
187 void vcloud_estimate_transform(int list_size, float (*pos)[3], float *weight,
188         float (*rpos)[3], float *rweight,
189         float lloc[3],float rloc[3],float lrot[3][3],float lscale[3][3]);
190
191 /****************************** Spherical Harmonics *************************/
192
193 /* Uses 2nd order SH => 9 coefficients, stored in this order:
194    0 = (0,0),
195    1 = (1,-1), 2 = (1,0), 3 = (1,1),
196    4 = (2,-2), 5 = (2,-1), 6 = (2,0), 7 = (2,1), 8 = (2,2) */
197
198 MINLINE void zero_sh(float r[9]);
199 MINLINE void copy_sh_sh(float r[9], float a[9]);
200 MINLINE void mul_sh_fl(float r[9], float f);
201 MINLINE void add_sh_shsh(float r[9], float a[9], float b[9]);
202
203 MINLINE float eval_shv3(float r[9], float v[3]);
204 MINLINE float diffuse_shv3(float r[9], float v[3]);
205 MINLINE void vec_fac_to_sh(float r[9], float v[3], float f);
206 MINLINE void madd_sh_shfl(float r[9], float sh[3], float f);
207
208 /********************************* Form Factor *******************************/
209
210 float form_factor_hemi_poly(float p[3], float n[3],
211         float v1[3], float v2[3], float v3[3], float v4[3]);
212
213 #ifdef __cplusplus
214 }
215 #endif
216
217 #endif /* BLI_MATH_GEOM_H */
218