79d72206903a7e5b683d470b0619d9e9d17e7add
[blender.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 BMeshCreateParams;
36 struct BoundBox;
37 struct EdgeHash;
38 struct EvaluationContext;
39 struct ListBase;
40 struct LinkNode;
41 struct BLI_Stack;
42 struct MemArena;
43 struct BMesh;
44 struct MLoopTri;
45 struct Main;
46 struct Mesh;
47 struct MPoly;
48 struct MLoop;
49 struct MFace;
50 struct MEdge;
51 struct MVert;
52 struct MDeformVert;
53 struct MDisps;
54 struct Object;
55 struct CustomData;
56 struct DerivedMesh;
57 struct Scene;
58 struct MLoopUV;
59 struct ReportList;
60
61 #ifdef __cplusplus
62 extern "C" {
63 #endif
64
65 /* setting zero so we can catch bugs in OpenMP/BMesh */
66 #ifdef DEBUG
67 #  define BKE_MESH_OMP_LIMIT 0
68 #else
69 #  define BKE_MESH_OMP_LIMIT 10000
70 #endif
71
72 /* *** mesh.c *** */
73
74 struct BMesh *BKE_mesh_to_bmesh(
75         struct Mesh *me, struct Object *ob,
76         const bool add_key_index, const struct BMeshCreateParams *params);
77
78 int poly_find_loop_from_vert(
79         const struct MPoly *poly,
80         const struct MLoop *loopstart, unsigned vert);
81 int poly_get_adj_loops_from_vert(
82         const struct MPoly *poly,
83         const struct MLoop *mloop, unsigned int vert,
84         unsigned int r_adj[2]);
85
86 int BKE_mesh_edge_other_vert(const struct MEdge *e, int v);
87
88 void BKE_mesh_free(struct Mesh *me);
89 void BKE_mesh_init(struct Mesh *me);
90 struct Mesh *BKE_mesh_add(struct Main *bmain, const char *name);
91 void BKE_mesh_copy_data(struct Main *bmain, struct Mesh *me_dst, const struct Mesh *me_src, const int flag);
92 struct Mesh *BKE_mesh_copy(struct Main *bmain, const struct Mesh *me);
93 void BKE_mesh_update_customdata_pointers(struct Mesh *me, const bool do_ensure_tess_cd);
94 void BKE_mesh_ensure_skin_customdata(struct Mesh *me);
95
96 bool BKE_mesh_ensure_facemap_customdata(struct Mesh *me);
97 bool BKE_mesh_clear_facemap_customdata(struct Mesh *me);
98
99 void BKE_mesh_make_local(struct Main *bmain, struct Mesh *me, const bool lib_local);
100 void BKE_mesh_boundbox_calc(struct Mesh *me, float r_loc[3], float r_size[3]);
101 void BKE_mesh_texspace_calc(struct Mesh *me);
102 float (*BKE_mesh_orco_verts_get(struct Object *ob))[3];
103 void   BKE_mesh_orco_verts_transform(struct Mesh *me, float (*orco)[3], int totvert, int invert);
104 int test_index_face(struct MFace *mface, struct CustomData *mfdata, int mfindex, int nr);
105 struct Mesh *BKE_mesh_from_object(struct Object *ob);
106 void BKE_mesh_assign_object(struct Object *ob, struct Mesh *me);
107 void BKE_mesh_from_metaball(struct ListBase *lb, struct Mesh *me);
108 int  BKE_mesh_nurbs_to_mdata(
109         struct Object *ob, struct MVert **r_allvert, int *r_totvert,
110         struct MEdge **r_alledge, int *r_totedge, struct MLoop **r_allloop, struct MPoly **r_allpoly,
111         int *r_totloop, int *r_totpoly);
112 int BKE_mesh_nurbs_displist_to_mdata(
113         struct Object *ob, const struct ListBase *dispbase,
114         struct MVert **r_allvert, int *r_totvert,
115         struct MEdge **r_alledge, int *r_totedge,
116         struct MLoop **r_allloop, struct MPoly **r_allpoly,
117         struct MLoopUV **r_alluv, int *r_totloop, int *r_totpoly);
118 void BKE_mesh_from_nurbs_displist(
119         struct Object *ob, struct ListBase *dispbase, const bool use_orco_uv, const char *obdata_name);
120 void BKE_mesh_from_nurbs(struct Object *ob);
121 void BKE_mesh_to_curve_nurblist(struct DerivedMesh *dm, struct ListBase *nurblist, const int edge_users_test);
122 void BKE_mesh_to_curve(const struct EvaluationContext *eval_ctx, struct Scene *scene, struct Object *ob);
123 void BKE_mesh_material_index_remove(struct Mesh *me, short index);
124 void BKE_mesh_material_index_clear(struct Mesh *me);
125 void BKE_mesh_material_remap(struct Mesh *me, const unsigned int *remap, unsigned int remap_len);
126 void BKE_mesh_smooth_flag_set(struct Object *meshOb, int enableSmooth);
127
128 const char *BKE_mesh_cmp(struct Mesh *me1, struct Mesh *me2, float thresh);
129
130 struct BoundBox *BKE_mesh_boundbox_get(struct Object *ob);
131 void BKE_mesh_texspace_get(struct Mesh *me, float r_loc[3], float r_rot[3], float r_size[3]);
132 void BKE_mesh_texspace_get_reference(struct Mesh *me, short **r_texflag,  float **r_loc, float **r_rot, float **r_size);
133 void BKE_mesh_texspace_copy_from_object(struct Mesh *me, struct Object *ob);
134
135 bool BKE_mesh_uv_cdlayer_rename_index(struct Mesh *me, const int poly_index, const int loop_index, const int face_index,
136                                       const char *new_name, const bool do_tessface);
137 bool BKE_mesh_uv_cdlayer_rename(struct Mesh *me, const char *old_name, const char *new_name, bool do_tessface);
138
139 float (*BKE_mesh_vertexCos_get(const struct Mesh *me, int *r_numVerts))[3];
140
141 void BKE_mesh_split_faces(struct Mesh *mesh, bool free_loop_normals);
142
143 struct Mesh *BKE_mesh_new_from_object(const struct EvaluationContext *eval_ctx, struct Main *bmain, struct Scene *sce, struct Object *ob,
144                                       int apply_modifiers, int calc_tessface, int calc_undeformed);
145
146 /* vertex level transformations & checks (no derived mesh) */
147
148 bool BKE_mesh_minmax(const struct Mesh *me, float r_min[3], float r_max[3]);
149 void BKE_mesh_transform(struct Mesh *me, float mat[4][4], bool do_keys);
150 void BKE_mesh_translate(struct Mesh *me, const float offset[3], const bool do_keys);
151
152 void BKE_mesh_ensure_navmesh(struct Mesh *me);
153
154 void BKE_mesh_tessface_calc(struct Mesh *mesh);
155 void BKE_mesh_tessface_ensure(struct Mesh *mesh);
156 void BKE_mesh_tessface_clear(struct Mesh *mesh);
157
158 void BKE_mesh_do_versions_cd_flag_init(struct Mesh *mesh);
159
160
161 void BKE_mesh_mselect_clear(struct Mesh *me);
162 void BKE_mesh_mselect_validate(struct Mesh *me);
163 int  BKE_mesh_mselect_find(struct Mesh *me, int index, int type);
164 int  BKE_mesh_mselect_active_get(struct Mesh *me, int type);
165 void BKE_mesh_mselect_active_set(struct Mesh *me, int index, int type);
166
167
168
169 /* *** mesh_evaluate.c *** */
170
171 void BKE_mesh_calc_normals_mapping(
172         struct MVert *mverts, int numVerts,
173         const struct MLoop *mloop, const struct MPoly *mpolys, int numLoops, int numPolys, float (*r_polyNors)[3],
174         const struct MFace *mfaces, int numFaces, const int *origIndexFace, float (*r_faceNors)[3]);
175 void BKE_mesh_calc_normals_mapping_ex(
176         struct MVert *mverts, int numVerts,
177         const struct MLoop *mloop, const struct MPoly *mpolys,
178         int numLoops, int numPolys, float (*r_polyNors)[3],
179         const struct MFace *mfaces, int numFaces, const int *origIndexFace, float (*r_faceNors)[3],
180         const bool only_face_normals);
181 void BKE_mesh_calc_normals_poly(
182         struct MVert *mverts, float (*r_vertnors)[3], int numVerts,
183         const struct MLoop *mloop, const struct MPoly *mpolys,
184         int numLoops, int numPolys, float (*r_polyNors)[3],
185         const bool only_face_normals);
186 void BKE_mesh_calc_normals(struct Mesh *me);
187 void BKE_mesh_calc_normals_tessface(
188         struct MVert *mverts, int numVerts,
189         const struct MFace *mfaces, int numFaces,
190         float (*r_faceNors)[3]);
191 void BKE_mesh_calc_normals_looptri(
192         struct MVert *mverts, int numVerts,
193         const struct MLoop *mloop,
194         const struct MLoopTri *looptri, int looptri_num,
195         float (*r_tri_nors)[3]);
196 void BKE_mesh_loop_tangents_ex(
197         const struct MVert *mverts, const int numVerts, const struct MLoop *mloops,
198         float (*r_looptangent)[4], float (*loopnors)[3], const struct MLoopUV *loopuv,
199         const int numLoops, const struct MPoly *mpolys, const int numPolys,
200         struct ReportList *reports);
201 void BKE_mesh_loop_tangents(
202         struct Mesh *mesh, const char *uvmap, float (*r_looptangents)[4], struct ReportList *reports);
203 void BKE_mesh_loop_manifold_fan_around_vert_next(
204         const struct MLoop *mloops, const struct MPoly *mpolys,
205         const int *loop_to_poly, const int *e2lfan_curr, const uint mv_pivot_index,
206         const struct MLoop **r_mlfan_curr, int *r_mlfan_curr_index, int *r_mlfan_vert_index, int *r_mpfan_curr_index);
207
208 void BKE_edges_sharp_from_angle_set(
209         const struct MVert *mverts, const int numVerts,
210         struct MEdge *medges, const int numEdges,
211         struct MLoop *mloops, const int numLoops,
212         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
213         const float split_angle);
214
215 /**
216  * References a contiguous loop-fan with normal offset vars.
217  */
218 typedef struct MLoopNorSpace {
219         float vec_lnor[3];      /* Automatically computed loop normal. */
220         float vec_ref[3];       /* Reference vector, orthogonal to vec_lnor. */
221         float vec_ortho[3];     /* Third vector, orthogonal to vec_lnor and vec_ref. */
222         float ref_alpha;        /* Reference angle, around vec_ortho, in ]0, pi] range (0.0 marks that space as invalid). */
223         float ref_beta;         /* Reference angle, around vec_lnor, in ]0, 2pi] range (0.0 marks that space as invalid). */
224         /* All loops using this lnor space (i.e. smooth fan of loops),
225          * as (depending on owning MLoopNorSpaceArrary.data_type):
226          *     - Indices (uint_in_ptr), or
227          *     - BMLoop pointers. */
228         struct LinkNode *loops;
229         char flags;
230 } MLoopNorSpace;
231 /**
232  * MLoopNorSpace.flags
233  */
234 enum {
235         MLNOR_SPACE_IS_SINGLE = 1 << 0,
236 };
237
238 /**
239  * Collection of #MLoopNorSpace basic storage & pre-allocation.
240  */
241 typedef struct MLoopNorSpaceArray {
242         MLoopNorSpace **lspacearr;    /* MLoop aligned array */
243         struct LinkNode *loops_pool;  /* Allocated once, avoids to call BLI_linklist_prepend_arena() for each loop! */
244         char data_type;               /* Whether we store loop indices, or pointers to BMLoop. */
245         struct MemArena *mem;
246 } MLoopNorSpaceArray;
247 /**
248  * MLoopNorSpaceArray.data_type
249  */
250 enum {
251         MLNOR_SPACEARR_LOOP_INDEX = 0,
252         MLNOR_SPACEARR_BMLOOP_PTR = 1,
253 };
254
255 void BKE_lnor_spacearr_init(MLoopNorSpaceArray *lnors_spacearr, const int numLoops, const char data_type);
256 void BKE_lnor_spacearr_clear(MLoopNorSpaceArray *lnors_spacearr);
257 void BKE_lnor_spacearr_free(MLoopNorSpaceArray *lnors_spacearr);
258 MLoopNorSpace *BKE_lnor_space_create(MLoopNorSpaceArray *lnors_spacearr);
259 void BKE_lnor_space_define(
260         MLoopNorSpace *lnor_space, const float lnor[3], float vec_ref[3], float vec_other[3],
261         struct BLI_Stack *edge_vectors);
262 void BKE_lnor_space_add_loop(
263         MLoopNorSpaceArray *lnors_spacearr, MLoopNorSpace *lnor_space,
264         const int ml_index, void *bm_loop, const bool is_single);
265 void BKE_lnor_space_custom_data_to_normal(MLoopNorSpace *lnor_space, const short clnor_data[2], float r_custom_lnor[3]);
266 void BKE_lnor_space_custom_normal_to_data(MLoopNorSpace *lnor_space, const float custom_lnor[3], short r_clnor_data[2]);
267
268 bool BKE_mesh_has_custom_loop_normals(struct Mesh *me);
269
270 void BKE_mesh_calc_normals_split(struct Mesh *mesh);
271 void BKE_mesh_calc_normals_split_ex(struct Mesh *mesh, struct MLoopNorSpaceArray *r_lnors_spacearr);
272
273 void BKE_mesh_normals_loop_split(
274         const struct MVert *mverts, const int numVerts, struct MEdge *medges, const int numEdges,
275         struct MLoop *mloops, float (*r_loopnors)[3], const int numLoops,
276         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
277         const bool use_split_normals, const float split_angle,
278         MLoopNorSpaceArray *r_lnors_spacearr, short (*clnors_data)[2], int *r_loop_to_poly);
279
280 void BKE_mesh_normals_loop_custom_set(
281         const struct MVert *mverts, const int numVerts, struct MEdge *medges, const int numEdges,
282         struct MLoop *mloops, float (*r_custom_loopnors)[3], const int numLoops,
283         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
284         short (*r_clnors_data)[2]);
285 void BKE_mesh_normals_loop_custom_from_vertices_set(
286         const struct MVert *mverts, float (*r_custom_vertnors)[3], const int numVerts,
287         struct MEdge *medges, const int numEdges, struct MLoop *mloops, const int numLoops,
288         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
289         short (*r_clnors_data)[2]);
290
291 void BKE_mesh_normals_loop_to_vertex(
292         const int numVerts, const struct MLoop *mloops, const int numLoops,
293         const float (*clnors)[3], float (*r_vert_clnors)[3]);
294
295 void BKE_mesh_calc_poly_normal(
296         const struct MPoly *mpoly, const struct MLoop *loopstart,
297         const struct MVert *mvarray, float r_no[3]);
298 void BKE_mesh_calc_poly_normal_coords(
299         const struct MPoly *mpoly, const struct MLoop *loopstart,
300         const float (*vertex_coords)[3], float r_no[3]);
301 void BKE_mesh_calc_poly_center(
302         const struct MPoly *mpoly, const struct MLoop *loopstart,
303         const struct MVert *mvarray, float r_cent[3]);
304 float BKE_mesh_calc_poly_area(
305         const struct MPoly *mpoly, const struct MLoop *loopstart,
306         const struct MVert *mvarray);
307 void BKE_mesh_calc_poly_angles(
308         const struct MPoly *mpoly, const struct MLoop *loopstart,
309         const struct MVert *mvarray, float angles[]);
310
311 void BKE_mesh_poly_edgehash_insert(
312         struct EdgeHash *ehash,
313         const struct MPoly *mp, const struct MLoop *mloop);
314 void BKE_mesh_poly_edgebitmap_insert(
315         unsigned int *edge_bitmap,
316         const struct MPoly *mp, const struct MLoop *mloop);
317
318
319 bool BKE_mesh_center_median(const struct Mesh *me, float r_cent[3]);
320 bool BKE_mesh_center_bounds(const struct Mesh *me, float r_cent[3]);
321 bool BKE_mesh_center_of_surface(const struct Mesh *me, float r_cent[3]);
322 bool BKE_mesh_center_of_volume(const struct Mesh *me, float r_cent[3]);
323
324 void BKE_mesh_calc_volume(
325         const struct MVert *mverts, const int mverts_num,
326         const struct MLoopTri *mlooptri, const int looptri_num,
327         const struct MLoop *mloop,
328         float *r_volume, float r_center[3]);
329
330 /* tessface */
331 void BKE_mesh_loops_to_mface_corners(
332         struct CustomData *fdata, struct CustomData *ldata,
333         struct CustomData *pdata, unsigned int lindex[4], int findex,
334         const int polyindex, const int mf_len,
335         const int numTex, const int numCol,
336         const bool hasPCol, const bool hasOrigSpace, const bool hasLNor);
337 void BKE_mesh_loops_to_tessdata(
338         struct CustomData *fdata, struct CustomData *ldata, struct MFace *mface,
339         int *polyindices, unsigned int (*loopindices)[4], const int num_faces);
340 void BKE_mesh_tangent_loops_to_tessdata(
341         struct CustomData *fdata, struct CustomData *ldata, struct MFace *mface,
342         int *polyindices, unsigned int (*loopindices)[4], const int num_faces, const char *layer_name);
343 int BKE_mesh_recalc_tessellation(
344         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
345         struct MVert *mvert,
346         int totface, int totloop, int totpoly,
347         const bool do_face_nor_copy);
348 void BKE_mesh_recalc_looptri(
349         const struct MLoop *mloop, const struct MPoly *mpoly,
350         const struct MVert *mvert,
351         int totloop, int totpoly,
352         struct MLoopTri *mlooptri);
353 int BKE_mesh_mpoly_to_mface(
354         struct CustomData *fdata, struct CustomData *ldata,
355         struct CustomData *pdata, int totface, int totloop, int totpoly);
356 void BKE_mesh_convert_mfaces_to_mpolys(struct Mesh *mesh);
357 void BKE_mesh_do_versions_convert_mfaces_to_mpolys(struct Mesh *mesh);
358 void BKE_mesh_convert_mfaces_to_mpolys_ex(
359         struct ID *id,
360         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
361         int totedge_i, int totface_i, int totloop_i, int totpoly_i,
362         struct MEdge *medge, struct MFace *mface,
363         int *r_totloop, int *r_totpoly,
364         struct MLoop **r_mloop, struct MPoly **r_mpoly);
365
366 void BKE_mesh_mdisp_flip(struct MDisps *md, const bool use_loop_mdisp_flip);
367
368 void BKE_mesh_polygon_flip_ex(
369         struct MPoly *mpoly, struct MLoop *mloop, struct CustomData *ldata,
370         float (*lnors)[3], struct MDisps *mdisp, const bool use_loop_mdisp_flip);
371 void BKE_mesh_polygon_flip(struct MPoly *mpoly, struct MLoop *mloop, struct CustomData *ldata);
372 void BKE_mesh_polygons_flip(struct MPoly *mpoly, struct MLoop *mloop, struct CustomData *ldata, int totpoly);
373
374 /* flush flags */
375 void BKE_mesh_flush_hidden_from_verts_ex(
376         const struct MVert *mvert,
377         const struct MLoop *mloop,
378         struct MEdge *medge, const int totedge,
379         struct MPoly *mpoly, const int totpoly);
380 void BKE_mesh_flush_hidden_from_verts(struct Mesh *me);
381 void BKE_mesh_flush_hidden_from_polys_ex(
382         struct MVert *mvert,
383         const struct MLoop *mloop,
384         struct MEdge *medge, const int totedge,
385         const struct MPoly *mpoly, const int totpoly);
386 void BKE_mesh_flush_hidden_from_polys(struct Mesh *me);
387 void BKE_mesh_flush_select_from_polys_ex(
388         struct MVert *mvert,       const int totvert,
389         const struct MLoop *mloop,
390         struct MEdge *medge,       const int totedge,
391         const struct MPoly *mpoly, const int totpoly);
392 void BKE_mesh_flush_select_from_polys(struct Mesh *me);
393 void BKE_mesh_flush_select_from_verts_ex(
394         const struct MVert *mvert, const int totvert,
395         const struct MLoop *mloop,
396         struct MEdge *medge,       const int totedge,
397         struct MPoly *mpoly,       const int totpoly);
398 void BKE_mesh_flush_select_from_verts(struct Mesh *me);
399
400 /* spatial evaluation */
401 void BKE_mesh_calc_relative_deform(
402         const struct MPoly *mpoly, const int totpoly,
403         const struct MLoop *mloop, const int totvert,
404
405         const float (*vert_cos_src)[3],
406         const float (*vert_cos_dst)[3],
407
408         const float (*vert_cos_org)[3],
409               float (*vert_cos_new)[3]);
410
411
412
413 /* *** mesh_validate.c *** */
414
415 int BKE_mesh_validate(struct Mesh *me, const int do_verbose, const int cddata_check_mask);
416 int BKE_mesh_validate_material_indices(struct Mesh *me);
417
418 bool BKE_mesh_validate_arrays(
419         struct Mesh *me,
420         struct MVert *mverts, unsigned int totvert,
421         struct MEdge *medges, unsigned int totedge,
422         struct MFace *mfaces, unsigned int totface,
423         struct MLoop *mloops, unsigned int totloop,
424         struct MPoly *mpolys, unsigned int totpoly,
425         struct MDeformVert *dverts, /* assume totvert length */
426         const bool do_verbose, const bool do_fixes,
427         bool *r_change);
428
429 bool BKE_mesh_validate_all_customdata(
430         struct CustomData *vdata, struct CustomData *edata,
431         struct CustomData *ldata, struct CustomData *pdata,
432         const bool check_meshmask,
433         const bool do_verbose, const bool do_fixes,
434         bool *r_change);
435
436 void BKE_mesh_strip_loose_faces(struct Mesh *me);
437 void BKE_mesh_strip_loose_polysloops(struct Mesh *me);
438 void BKE_mesh_strip_loose_edges(struct Mesh *me);
439
440 void BKE_mesh_calc_edges_legacy(struct Mesh *me, const bool use_old);
441 void BKE_mesh_calc_edges(struct Mesh *mesh, bool update, const bool select);
442
443 /* **** Depsgraph evaluation **** */
444
445 void BKE_mesh_eval_geometry(const struct EvaluationContext *eval_ctx,
446                             struct Mesh *mesh);
447
448 /* Draw Cache */
449 enum {
450         BKE_MESH_BATCH_DIRTY_ALL = 0,
451         BKE_MESH_BATCH_DIRTY_MAYBE_ALL,
452         BKE_MESH_BATCH_DIRTY_SELECT,
453         BKE_MESH_BATCH_DIRTY_SHADING,
454         BKE_MESH_BATCH_DIRTY_SCULPT_COORDS,
455 };
456 void BKE_mesh_batch_cache_dirty(struct Mesh *me, int mode);
457 void BKE_mesh_batch_cache_free(struct Mesh *me);
458
459 #ifdef __cplusplus
460 }
461 #endif
462
463 #endif /* __BKE_MESH_H__ */