Corrective Smooth Modifier (aka delta-mush)
[blender-staging.git] / source / blender / blenkernel / BKE_mesh.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: all of this file.
22  *
23  * Contributor(s): (mar-2001 nzc)
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_MESH_H__
28 #define __BKE_MESH_H__
29
30 /** \file BKE_mesh.h
31  *  \ingroup bke
32  */
33
34 struct ID;
35 struct BoundBox;
36 struct EdgeHash;
37 struct ListBase;
38 struct LinkNode;
39 struct BLI_Stack;
40 struct MemArena;
41 struct BMesh;
42 struct Main;
43 struct Mesh;
44 struct MPoly;
45 struct MLoop;
46 struct MFace;
47 struct MEdge;
48 struct MVert;
49 struct MDeformVert;
50 struct Object;
51 struct CustomData;
52 struct DerivedMesh;
53 struct Scene;
54 struct MLoopUV;
55 struct ReportList;
56
57 #ifdef __cplusplus
58 extern "C" {
59 #endif
60
61 /* setting zero so we can catch bugs in OpenMP/BMesh */
62 #ifdef DEBUG
63 #  define BKE_MESH_OMP_LIMIT 0
64 #else
65 #  define BKE_MESH_OMP_LIMIT 10000
66 #endif
67
68 /* *** mesh.c *** */
69
70 struct BMesh *BKE_mesh_to_bmesh(struct Mesh *me, struct Object *ob);
71
72 int poly_find_loop_from_vert(const struct MPoly *poly,
73                              const struct MLoop *loopstart,
74                              unsigned vert);
75
76 int poly_get_adj_loops_from_vert(unsigned r_adj[3], const struct MPoly *poly,
77                                  const struct MLoop *mloop, unsigned vert);
78
79 int BKE_mesh_edge_other_vert(const struct MEdge *e, int v);
80
81 void BKE_mesh_unlink(struct Mesh *me);
82 void BKE_mesh_free(struct Mesh *me, int unlink);
83 struct Mesh *BKE_mesh_add(struct Main *bmain, const char *name);
84 struct Mesh *BKE_mesh_copy_ex(struct Main *bmain, struct Mesh *me);
85 struct Mesh *BKE_mesh_copy(struct Mesh *me);
86 void BKE_mesh_update_customdata_pointers(struct Mesh *me, const bool do_ensure_tess_cd);
87 void BKE_mesh_ensure_skin_customdata(struct Mesh *me);
88
89 void BKE_mesh_make_local(struct Mesh *me);
90 void BKE_mesh_boundbox_calc(struct Mesh *me, float r_loc[3], float r_size[3]);
91 void BKE_mesh_texspace_calc(struct Mesh *me);
92 float (*BKE_mesh_orco_verts_get(struct Object *ob))[3];
93 void   BKE_mesh_orco_verts_transform(struct Mesh *me, float (*orco)[3], int totvert, int invert);
94 int test_index_face(struct MFace *mface, struct CustomData *mfdata, int mfindex, int nr);
95 struct Mesh *BKE_mesh_from_object(struct Object *ob);
96 void BKE_mesh_assign_object(struct Object *ob, struct Mesh *me);
97 void BKE_mesh_from_metaball(struct ListBase *lb, struct Mesh *me);
98 int  BKE_mesh_nurbs_to_mdata(struct Object *ob, struct MVert **allvert, int *totvert,
99                              struct MEdge **alledge, int *totedge, struct MLoop **allloop, struct MPoly **allpoly,
100                              int *totloop, int *totpoly);
101 int BKE_mesh_nurbs_displist_to_mdata(struct Object *ob, struct ListBase *dispbase, struct MVert **allvert, int *_totvert,
102                                      struct MEdge **alledge, int *_totedge, struct MLoop **allloop, struct MPoly **allpoly,
103                                      struct MLoopUV **alluv, int *_totloop, int *_totpoly);
104 void BKE_mesh_from_nurbs_displist(struct Object *ob, struct ListBase *dispbase, const bool use_orco_uv);
105 void BKE_mesh_from_nurbs(struct Object *ob);
106 void BKE_mesh_to_curve_nurblist(struct DerivedMesh *dm, struct ListBase *nurblist, const int edge_users_test);
107 void BKE_mesh_to_curve(struct Scene *scene, struct Object *ob);
108 void BKE_mesh_material_index_remove(struct Mesh *me, short index);
109 void BKE_mesh_material_index_clear(struct Mesh *me);
110 void BKE_mesh_smooth_flag_set(struct Object *meshOb, int enableSmooth);
111
112 const char *BKE_mesh_cmp(struct Mesh *me1, struct Mesh *me2, float thresh);
113
114 struct BoundBox *BKE_mesh_boundbox_get(struct Object *ob);
115 void BKE_mesh_texspace_get(struct Mesh *me, float r_loc[3], float r_rot[3], float r_size[3]);
116 void BKE_mesh_texspace_copy_from_object(struct Mesh *me, struct Object *ob);
117
118 bool BKE_mesh_uv_cdlayer_rename_index(struct Mesh *me, const int poly_index, const int loop_index, const int face_index,
119                                       const char *new_name, const bool do_tessface);
120 bool BKE_mesh_uv_cdlayer_rename(struct Mesh *me, const char *old_name, const char *new_name, bool do_tessface);
121
122 float (*BKE_mesh_vertexCos_get(const struct Mesh *me, int *r_numVerts))[3];
123
124 void BKE_mesh_calc_normals_split(struct Mesh *mesh);
125 void BKE_mesh_split_faces(struct Mesh *mesh);
126
127 struct Mesh *BKE_mesh_new_from_object(struct Main *bmain, struct Scene *sce, struct Object *ob,
128                                       int apply_modifiers, int settings, int calc_tessface, int calc_undeformed);
129
130 /* vertex level transformations & checks (no derived mesh) */
131
132 bool BKE_mesh_minmax(struct Mesh *me, float r_min[3], float r_max[3]);
133 void BKE_mesh_transform(struct Mesh *me, float mat[4][4], bool do_keys);
134 void BKE_mesh_translate(struct Mesh *me, const float offset[3], const bool do_keys);
135
136 void BKE_mesh_ensure_navmesh(struct Mesh *me);
137
138 void BKE_mesh_tessface_calc(struct Mesh *mesh);
139 void BKE_mesh_tessface_ensure(struct Mesh *mesh);
140 void BKE_mesh_tessface_clear(struct Mesh *mesh);
141
142 void BKE_mesh_do_versions_cd_flag_init(struct Mesh *mesh);
143
144
145 void BKE_mesh_mselect_clear(struct Mesh *me);
146 void BKE_mesh_mselect_validate(struct Mesh *me);
147 int  BKE_mesh_mselect_find(struct Mesh *me, int index, int type);
148 int  BKE_mesh_mselect_active_get(struct Mesh *me, int type);
149 void BKE_mesh_mselect_active_set(struct Mesh *me, int index, int type);
150
151
152
153 /* *** mesh_evaluate.c *** */
154
155 void BKE_mesh_calc_normals_mapping(
156         struct MVert *mverts, int numVerts,
157         struct MLoop *mloop, struct MPoly *mpolys, int numLoops, int numPolys, float (*r_polyNors)[3],
158         struct MFace *mfaces, int numFaces, const int *origIndexFace, float (*r_faceNors)[3]);
159 void BKE_mesh_calc_normals_mapping_ex(
160         struct MVert *mverts, int numVerts,
161         struct MLoop *mloop, struct MPoly *mpolys, int numLoops, int numPolys, float (*r_polyNors)[3],
162         struct MFace *mfaces, int numFaces, const int *origIndexFace, float (*r_faceNors)[3],
163         const bool only_face_normals);
164 void BKE_mesh_calc_normals_poly(
165         struct MVert *mverts, int numVerts,
166         struct MLoop *mloop, struct MPoly *mpolys,
167         int numLoops, int numPolys, float (*r_polyNors)[3],
168         const bool only_face_normals);
169 void BKE_mesh_calc_normals(struct Mesh *me);
170 void BKE_mesh_calc_normals_tessface(
171         struct MVert *mverts, int numVerts,
172         struct MFace *mfaces, int numFaces,
173         float (*r_faceNors)[3]);
174 void BKE_mesh_loop_tangents_ex(
175         struct MVert *mverts, const int numVerts, struct MLoop *mloops, float (*r_looptangent)[4], float (*loopnors)[3],
176         struct MLoopUV *loopuv, const int numLoops, struct MPoly *mpolys, const int numPolys,
177         struct ReportList *reports);
178 void BKE_mesh_loop_tangents(
179         struct Mesh *mesh, const char *uvmap, float (*r_looptangents)[4], struct ReportList *reports);
180
181 /**
182  * References a contiguous loop-fan with normal offset vars.
183  */
184 typedef struct MLoopNorSpace {
185         float vec_lnor[3];      /* Automatically computed loop normal. */
186         float vec_ref[3];       /* Reference vector, orthogonal to vec_lnor. */
187         float vec_ortho[3];     /* Third vector, orthogonal to vec_lnor and vec_ref. */
188         float ref_alpha;        /* Reference angle, around vec_ortho, in ]0, pi] range (0.0 marks that space as invalid). */
189         float ref_beta;         /* Reference angle, around vec_lnor, in ]0, 2pi] range (0.0 marks that space as invalid). */
190         struct LinkNode *loops; /* All indices (uint_in_ptr) of loops using this lnor space (i.e. smooth fan of loops). */
191 } MLoopNorSpace;
192 /**
193  * Collection of #MLoopNorSpace basic storage & pre-allocation.
194  */
195 typedef struct MLoopNorSpaceArray {
196         MLoopNorSpace **lspacearr;    /* MLoop aligned array */
197         struct LinkNode *loops_pool;  /* Allocated once, avoids to call BLI_linklist_prepend_arena() for each loop! */
198         struct MemArena *mem;
199 } MLoopNorSpaceArray;
200 void BKE_lnor_spacearr_init(MLoopNorSpaceArray *lnors_spacearr, const int numLoops);
201 void BKE_lnor_spacearr_clear(MLoopNorSpaceArray *lnors_spacearr);
202 void BKE_lnor_spacearr_free(MLoopNorSpaceArray *lnors_spacearr);
203 MLoopNorSpace *BKE_lnor_space_create(MLoopNorSpaceArray *lnors_spacearr);
204 void BKE_lnor_space_define(
205         MLoopNorSpace *lnor_space, const float lnor[3], float vec_ref[3], float vec_other[3],
206         struct BLI_Stack *edge_vectors);
207 void BKE_lnor_space_add_loop(
208         MLoopNorSpaceArray *lnors_spacearr, MLoopNorSpace *lnor_space, const int ml_index, const bool add_to_list);
209 void BKE_lnor_space_custom_data_to_normal(MLoopNorSpace *lnor_space, const short clnor_data[2], float r_custom_lnor[3]);
210 void BKE_lnor_space_custom_normal_to_data(MLoopNorSpace *lnor_space, const float custom_lnor[3], short r_clnor_data[2]);
211
212 bool BKE_mesh_has_custom_loop_normals(struct Mesh *me);
213
214 void BKE_mesh_normals_loop_split(struct MVert *mverts, const int numVerts, struct MEdge *medges, const int numEdges,
215         struct MLoop *mloops, float (*r_loopnors)[3], const int numLoops,
216         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
217         const bool use_split_normals, float split_angle,
218         MLoopNorSpaceArray *r_lnors_spacearr, short (*clnors_data)[2], int *r_loop_to_poly);
219
220 void BKE_mesh_normals_loop_custom_set(
221         struct MVert *mverts, const int numVerts, struct MEdge *medges, const int numEdges,
222         struct MLoop *mloops, float (*custom_loopnors)[3], const int numLoops,
223         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
224         short (*r_clnors_data)[2]);
225 void BKE_mesh_normals_loop_custom_from_vertices_set(
226         struct MVert *mverts, float (*custom_vertnors)[3], const int numVerts,
227         struct MEdge *medges, const int numEdges, struct MLoop *mloops, const int numLoops,
228         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
229         short (*r_clnors_data)[2]);
230
231 void BKE_mesh_calc_poly_normal(
232         struct MPoly *mpoly, struct MLoop *loopstart,
233         struct MVert *mvarray, float no[3]);
234 void BKE_mesh_calc_poly_normal_coords(
235         struct MPoly *mpoly, struct MLoop *loopstart,
236         const float (*vertex_coords)[3], float no[3]);
237 void BKE_mesh_calc_poly_center(
238         struct MPoly *mpoly, struct MLoop *loopstart,
239         struct MVert *mvarray, float cent[3]);
240 float BKE_mesh_calc_poly_area(
241         struct MPoly *mpoly, struct MLoop *loopstart,
242         struct MVert *mvarray);
243 void BKE_mesh_calc_poly_angles(
244         struct MPoly *mpoly, struct MLoop *loopstart,
245         struct MVert *mvarray, float angles[]);
246
247 void BKE_mesh_poly_edgehash_insert(
248         struct EdgeHash *ehash,
249         const struct MPoly *mp, const struct MLoop *mloop);
250 void BKE_mesh_poly_edgebitmap_insert(
251         unsigned int *edge_bitmap,
252         const struct MPoly *mp, const struct MLoop *mloop);
253
254
255 bool BKE_mesh_center_median(struct Mesh *me, float cent[3]);
256 bool BKE_mesh_center_bounds(struct Mesh *me, float cent[3]);
257 bool BKE_mesh_center_centroid(struct Mesh *me, float cent[3]);
258
259 void BKE_mesh_calc_volume(struct MVert *mverts, int numVerts,
260                           struct MFace *mfaces, int numFaces,
261                           float *r_vol, float *r_com);
262
263 /* tessface */
264 void BKE_mesh_loops_to_mface_corners(
265         struct CustomData *fdata, struct CustomData *ldata,
266         struct CustomData *pdata, unsigned int lindex[4], int findex,
267         const int polyindex, const int mf_len,
268         const int numTex, const int numCol,
269         const bool hasPCol, const bool hasOrigSpace, const bool hasLNor);
270 void BKE_mesh_loops_to_tessdata(
271         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata, struct MFace *mface,
272         int *polyindices, unsigned int (*loopindices)[4], const int num_faces);
273 int BKE_mesh_recalc_tessellation(
274         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
275         struct MVert *mvert,
276         int totface, int totloop, int totpoly,
277         const bool do_face_normals);
278 int BKE_mesh_mpoly_to_mface(
279         struct CustomData *fdata, struct CustomData *ldata,
280         struct CustomData *pdata, int totface, int totloop, int totpoly);
281 void BKE_mesh_convert_mfaces_to_mpolys(struct Mesh *mesh);
282 void BKE_mesh_do_versions_convert_mfaces_to_mpolys(struct Mesh *mesh);
283 void BKE_mesh_convert_mfaces_to_mpolys_ex(
284         struct ID *id,
285         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
286         int totedge_i, int totface_i, int totloop_i, int totpoly_i,
287         struct MEdge *medge, struct MFace *mface,
288         int *r_totloop, int *r_totpoly,
289         struct MLoop **r_mloop, struct MPoly **r_mpoly);
290
291 /* flush flags */
292 void BKE_mesh_flush_hidden_from_verts_ex(
293         const struct MVert *mvert,
294         const struct MLoop *mloop,
295         struct MEdge *medge, const int totedge,
296         struct MPoly *mpoly, const int totpoly);
297 void BKE_mesh_flush_hidden_from_verts(struct Mesh *me);
298 void BKE_mesh_flush_hidden_from_polys_ex(
299         struct MVert *mvert,
300         const struct MLoop *mloop,
301         struct MEdge *medge, const int totedge,
302         const struct MPoly *mpoly, const int totpoly);
303 void BKE_mesh_flush_hidden_from_polys(struct Mesh *me);
304 void BKE_mesh_flush_select_from_polys_ex(
305         struct MVert *mvert,       const int totvert,
306         const struct MLoop *mloop,
307         struct MEdge *medge,       const int totedge,
308         const struct MPoly *mpoly, const int totpoly);
309 void BKE_mesh_flush_select_from_polys(struct Mesh *me);
310 void BKE_mesh_flush_select_from_verts_ex(
311         const struct MVert *mvert, const int totvert,
312         const struct MLoop *mloop,
313         struct MEdge *medge,       const int totedge,
314         struct MPoly *mpoly,       const int totpoly);
315 void BKE_mesh_flush_select_from_verts(struct Mesh *me);
316
317 /* spatial evaluation */
318 void BKE_mesh_calc_relative_deform(
319         const struct MPoly *mpoly, const int totpoly,
320         const struct MLoop *mloop, const int totvert,
321
322         const float (*vert_cos_src)[3],
323         const float (*vert_cos_dst)[3],
324
325         const float (*vert_cos_org)[3],
326               float (*vert_cos_new)[3]);
327
328
329
330 /* *** mesh_validate.c *** */
331
332 int BKE_mesh_validate(struct Mesh *me, const int do_verbose, const int cddata_check_mask);
333 void BKE_mesh_cd_validate(struct Mesh *me);
334 int BKE_mesh_validate_material_indices(struct Mesh *me);
335
336 bool BKE_mesh_validate_arrays(
337         struct Mesh *me,
338         struct MVert *mverts, unsigned int totvert,
339         struct MEdge *medges, unsigned int totedge,
340         struct MFace *mfaces, unsigned int totface,
341         struct MLoop *mloops, unsigned int totloop,
342         struct MPoly *mpolys, unsigned int totpoly,
343         struct MDeformVert *dverts, /* assume totvert length */
344         const bool do_verbose, const bool do_fixes,
345         bool *r_change);
346
347 bool BKE_mesh_validate_all_customdata(
348         struct CustomData *vdata, struct CustomData *edata,
349         struct CustomData *ldata, struct CustomData *pdata,
350         const bool check_meshmask,
351         const bool do_verbose, const bool do_fixes,
352         bool *r_change);
353
354 void BKE_mesh_strip_loose_faces(struct Mesh *me);
355 void BKE_mesh_strip_loose_polysloops(struct Mesh *me);
356 void BKE_mesh_strip_loose_edges(struct Mesh *me);
357
358 void BKE_mesh_calc_edges_legacy(struct Mesh *me, const bool use_old);
359 void BKE_mesh_calc_edges(struct Mesh *mesh, bool update, const bool select);
360
361 #ifdef __cplusplus
362 }
363 #endif
364
365 #endif /* __BKE_MESH_H__ */