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