d4ad0e771d31114b5c5979ddaded092915119b81
[blender.git] / source / blender / blenkernel / BKE_mesh.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19 #ifndef __BKE_MESH_H__
20 #define __BKE_MESH_H__
21
22 /** \file
23  * \ingroup bke
24  */
25
26 /* defines BLI_INLINE */
27 #include "BLI_compiler_compat.h"
28
29 /* defines CustomDataMask */
30 //#include "BKE_customdata.h"
31
32 struct BLI_Stack;
33 struct BMEditMesh;
34 struct BMesh;
35 struct BMeshCreateParams;
36 struct BMeshFromMeshParams;
37 struct BMeshToMeshParams;
38 struct BoundBox;
39 struct CustomData;
40 struct CustomData_MeshMasks;
41 struct Depsgraph;
42 struct EdgeHash;
43 struct ID;
44 struct KeyBlock;
45 struct LinkNode;
46 struct ListBase;
47 struct MDeformVert;
48 struct MDisps;
49 struct MEdge;
50 struct MFace;
51 struct MLoop;
52 struct MLoopTri;
53 struct MLoopUV;
54 struct MPoly;
55 struct MVert;
56 struct MVertTri;
57 struct Main;
58 struct MemArena;
59 struct Mesh;
60 struct ModifierData;
61 struct Object;
62 struct ReportList;
63 struct Scene;
64
65 #ifdef __cplusplus
66 extern "C" {
67 #endif
68
69 /* setting zero so we can catch bugs in OpenMP/BMesh */
70 #ifdef DEBUG
71 #  define BKE_MESH_OMP_LIMIT 0
72 #else
73 #  define BKE_MESH_OMP_LIMIT 10000
74 #endif
75
76 /* *** mesh.c *** */
77
78 struct BMesh *BKE_mesh_to_bmesh_ex(const struct Mesh *me,
79                                    const struct BMeshCreateParams *create_params,
80                                    const struct BMeshFromMeshParams *convert_params);
81 struct BMesh *BKE_mesh_to_bmesh(struct Mesh *me,
82                                 struct Object *ob,
83                                 const bool add_key_index,
84                                 const struct BMeshCreateParams *params);
85
86 struct Mesh *BKE_mesh_from_bmesh_nomain(struct BMesh *bm, const struct BMeshToMeshParams *params);
87 struct Mesh *BKE_mesh_from_bmesh_for_eval_nomain(struct BMesh *bm,
88                                                  const struct CustomData_MeshMasks *cd_mask_extra);
89
90 struct Mesh *BKE_mesh_from_editmesh_with_coords_thin_wrap(
91     struct BMEditMesh *em, const struct CustomData_MeshMasks *data_mask, float (*vertexCos)[3]);
92
93 int poly_find_loop_from_vert(const struct MPoly *poly,
94                              const struct MLoop *loopstart,
95                              unsigned vert);
96 int poly_get_adj_loops_from_vert(const struct MPoly *poly,
97                                  const struct MLoop *mloop,
98                                  unsigned int vert,
99                                  unsigned int r_adj[2]);
100
101 int BKE_mesh_edge_other_vert(const struct MEdge *e, int v);
102 void BKE_mesh_looptri_get_real_edges(const struct Mesh *mesh,
103                                      const struct MLoopTri *looptri,
104                                      int r_edges[3]);
105
106 void BKE_mesh_free(struct Mesh *me);
107 void BKE_mesh_init(struct Mesh *me);
108 struct Mesh *BKE_mesh_add(struct Main *bmain, const char *name);
109 void BKE_mesh_copy_data(struct Main *bmain,
110                         struct Mesh *me_dst,
111                         const struct Mesh *me_src,
112                         const int flag);
113 struct Mesh *BKE_mesh_copy(struct Main *bmain, const struct Mesh *me);
114 void BKE_mesh_update_customdata_pointers(struct Mesh *me, const bool do_ensure_tess_cd);
115 void BKE_mesh_ensure_skin_customdata(struct Mesh *me);
116
117 struct Mesh *BKE_mesh_new_nomain(
118     int verts_len, int edges_len, int tessface_len, int loops_len, int polys_len);
119 struct Mesh *BKE_mesh_new_nomain_from_template(const struct Mesh *me_src,
120                                                int verts_len,
121                                                int edges_len,
122                                                int tessface_len,
123                                                int loops_len,
124                                                int polys_len);
125
126 /* Performs copy for use during evaluation, optional referencing original arrays to reduce memory. */
127 struct Mesh *BKE_mesh_copy_for_eval(struct Mesh *source, bool reference);
128
129 /* These functions construct a new Mesh, contrary to BKE_mesh_from_nurbs which modifies ob itself. */
130 struct Mesh *BKE_mesh_new_nomain_from_curve(struct Object *ob);
131 struct Mesh *BKE_mesh_new_nomain_from_curve_displist(struct Object *ob, struct ListBase *dispbase);
132
133 bool BKE_mesh_ensure_facemap_customdata(struct Mesh *me);
134 bool BKE_mesh_clear_facemap_customdata(struct Mesh *me);
135
136 void BKE_mesh_make_local(struct Main *bmain, struct Mesh *me, const bool lib_local);
137 void BKE_mesh_boundbox_calc(struct Mesh *me, float r_loc[3], float r_size[3]);
138 void BKE_mesh_texspace_calc(struct Mesh *me);
139 float (*BKE_mesh_orco_verts_get(struct Object *ob))[3];
140 void BKE_mesh_orco_verts_transform(struct Mesh *me, float (*orco)[3], int totvert, int invert);
141 int test_index_face(struct MFace *mface, struct CustomData *mfdata, int mfindex, int nr);
142 struct Mesh *BKE_mesh_from_object(struct Object *ob);
143 void BKE_mesh_assign_object(struct Main *bmain, struct Object *ob, struct Mesh *me);
144 void BKE_mesh_from_metaball(struct ListBase *lb, struct Mesh *me);
145 int BKE_mesh_nurbs_to_mdata(struct Object *ob,
146                             struct MVert **r_allvert,
147                             int *r_totvert,
148                             struct MEdge **r_alledge,
149                             int *r_totedge,
150                             struct MLoop **r_allloop,
151                             struct MPoly **r_allpoly,
152                             int *r_totloop,
153                             int *r_totpoly);
154 int BKE_mesh_nurbs_displist_to_mdata(struct Object *ob,
155                                      const struct ListBase *dispbase,
156                                      struct MVert **r_allvert,
157                                      int *r_totvert,
158                                      struct MEdge **r_alledge,
159                                      int *r_totedge,
160                                      struct MLoop **r_allloop,
161                                      struct MPoly **r_allpoly,
162                                      struct MLoopUV **r_alluv,
163                                      int *r_totloop,
164                                      int *r_totpoly);
165 void BKE_mesh_from_nurbs_displist(struct Main *bmain,
166                                   struct Object *ob,
167                                   struct ListBase *dispbase,
168                                   const bool use_orco_uv,
169                                   const char *obdata_name,
170                                   bool temporary);
171 void BKE_mesh_from_nurbs(struct Main *bmain, struct Object *ob);
172 void BKE_mesh_to_curve_nurblist(const struct Mesh *me,
173                                 struct ListBase *nurblist,
174                                 const int edge_users_test);
175 void BKE_mesh_to_curve(struct Main *bmain,
176                        struct Depsgraph *depsgraph,
177                        struct Scene *scene,
178                        struct Object *ob);
179 void BKE_mesh_material_index_remove(struct Mesh *me, short index);
180 void BKE_mesh_material_index_clear(struct Mesh *me);
181 void BKE_mesh_material_remap(struct Mesh *me, const unsigned int *remap, unsigned int remap_len);
182 void BKE_mesh_smooth_flag_set(struct Object *meshOb, int enableSmooth);
183
184 const char *BKE_mesh_cmp(struct Mesh *me1, struct Mesh *me2, float thresh);
185
186 struct BoundBox *BKE_mesh_boundbox_get(struct Object *ob);
187 struct BoundBox *BKE_mesh_texspace_get(struct Mesh *me,
188                                        float r_loc[3],
189                                        float r_rot[3],
190                                        float r_size[3]);
191 void BKE_mesh_texspace_get_reference(
192     struct Mesh *me, short **r_texflag, float **r_loc, float **r_rot, float **r_size);
193 void BKE_mesh_texspace_copy_from_object(struct Mesh *me, struct Object *ob);
194
195 bool BKE_mesh_uv_cdlayer_rename_index(struct Mesh *me,
196                                       const int loop_index,
197                                       const int face_index,
198                                       const char *new_name,
199                                       const bool do_tessface);
200 bool BKE_mesh_uv_cdlayer_rename(struct Mesh *me,
201                                 const char *old_name,
202                                 const char *new_name,
203                                 bool do_tessface);
204
205 float (*BKE_mesh_vertexCos_get(const struct Mesh *me, int *r_numVerts))[3];
206
207 void BKE_mesh_split_faces(struct Mesh *mesh, bool free_loop_normals);
208
209 struct Mesh *BKE_mesh_new_from_object(struct Depsgraph *depsgraph,
210                                       struct Main *bmain,
211                                       struct Scene *sce,
212                                       struct Object *ob,
213                                       const bool apply_modifiers,
214                                       const bool calc_undeformed);
215 struct Mesh *BKE_mesh_create_derived_for_modifier(struct Depsgraph *depsgraph,
216                                                   struct Scene *scene,
217                                                   struct Object *ob,
218                                                   struct ModifierData *md,
219                                                   int build_shapekey_layers);
220
221 /* Copies a nomain-Mesh into an existing Mesh. */
222 void BKE_mesh_nomain_to_mesh(struct Mesh *mesh_src,
223                              struct Mesh *mesh_dst,
224                              struct Object *ob,
225                              const struct CustomData_MeshMasks *mask,
226                              bool take_ownership);
227 void BKE_mesh_nomain_to_meshkey(struct Mesh *mesh_src, struct Mesh *mesh_dst, struct KeyBlock *kb);
228
229 /* vertex level transformations & checks (no derived mesh) */
230
231 bool BKE_mesh_minmax(const struct Mesh *me, float r_min[3], float r_max[3]);
232 void BKE_mesh_transform(struct Mesh *me, float mat[4][4], bool do_keys);
233 void BKE_mesh_translate(struct Mesh *me, const float offset[3], const bool do_keys);
234
235 void BKE_mesh_ensure_navmesh(struct Mesh *me);
236
237 void BKE_mesh_tessface_calc(struct Mesh *mesh);
238 void BKE_mesh_tessface_ensure(struct Mesh *mesh);
239 void BKE_mesh_tessface_clear(struct Mesh *mesh);
240
241 void BKE_mesh_do_versions_cd_flag_init(struct Mesh *mesh);
242
243 void BKE_mesh_mselect_clear(struct Mesh *me);
244 void BKE_mesh_mselect_validate(struct Mesh *me);
245 int BKE_mesh_mselect_find(struct Mesh *me, int index, int type);
246 int BKE_mesh_mselect_active_get(struct Mesh *me, int type);
247 void BKE_mesh_mselect_active_set(struct Mesh *me, int index, int type);
248
249 void BKE_mesh_count_selected_items(const struct Mesh *mesh, int r_count[3]);
250
251 void BKE_mesh_apply_vert_coords(struct Mesh *mesh, float (*vertCoords)[3]);
252 void BKE_mesh_apply_vert_normals(struct Mesh *mesh, short (*vertNormals)[3]);
253
254 /* *** mesh_evaluate.c *** */
255
256 void BKE_mesh_calc_normals_mapping_simple(struct Mesh *me);
257 void BKE_mesh_calc_normals_mapping(struct MVert *mverts,
258                                    int numVerts,
259                                    const struct MLoop *mloop,
260                                    const struct MPoly *mpolys,
261                                    int numLoops,
262                                    int numPolys,
263                                    float (*r_polyNors)[3],
264                                    const struct MFace *mfaces,
265                                    int numFaces,
266                                    const int *origIndexFace,
267                                    float (*r_faceNors)[3]);
268 void BKE_mesh_calc_normals_mapping_ex(struct MVert *mverts,
269                                       int numVerts,
270                                       const struct MLoop *mloop,
271                                       const struct MPoly *mpolys,
272                                       int numLoops,
273                                       int numPolys,
274                                       float (*r_polyNors)[3],
275                                       const struct MFace *mfaces,
276                                       int numFaces,
277                                       const int *origIndexFace,
278                                       float (*r_faceNors)[3],
279                                       const bool only_face_normals);
280 void BKE_mesh_calc_normals_poly(struct MVert *mverts,
281                                 float (*r_vertnors)[3],
282                                 int numVerts,
283                                 const struct MLoop *mloop,
284                                 const struct MPoly *mpolys,
285                                 int numLoops,
286                                 int numPolys,
287                                 float (*r_polyNors)[3],
288                                 const bool only_face_normals);
289 void BKE_mesh_calc_normals(struct Mesh *me);
290 void BKE_mesh_ensure_normals(struct Mesh *me);
291 void BKE_mesh_ensure_normals_for_display(struct Mesh *mesh);
292 void BKE_mesh_calc_normals_tessface(struct MVert *mverts,
293                                     int numVerts,
294                                     const struct MFace *mfaces,
295                                     int numFaces,
296                                     float (*r_faceNors)[3]);
297 void BKE_mesh_calc_normals_looptri(struct MVert *mverts,
298                                    int numVerts,
299                                    const struct MLoop *mloop,
300                                    const struct MLoopTri *looptri,
301                                    int looptri_num,
302                                    float (*r_tri_nors)[3]);
303 void BKE_mesh_loop_manifold_fan_around_vert_next(const struct MLoop *mloops,
304                                                  const struct MPoly *mpolys,
305                                                  const int *loop_to_poly,
306                                                  const int *e2lfan_curr,
307                                                  const uint mv_pivot_index,
308                                                  const struct MLoop **r_mlfan_curr,
309                                                  int *r_mlfan_curr_index,
310                                                  int *r_mlfan_vert_index,
311                                                  int *r_mpfan_curr_index);
312
313 void BKE_edges_sharp_from_angle_set(const struct MVert *mverts,
314                                     const int numVerts,
315                                     struct MEdge *medges,
316                                     const int numEdges,
317                                     struct MLoop *mloops,
318                                     const int numLoops,
319                                     struct MPoly *mpolys,
320                                     const float (*polynors)[3],
321                                     const int numPolys,
322                                     const float split_angle);
323
324 /**
325  * References a contiguous loop-fan with normal offset vars.
326  */
327 typedef struct MLoopNorSpace {
328   /** Automatically computed loop normal. */
329   float vec_lnor[3];
330   /** Reference vector, orthogonal to vec_lnor. */
331   float vec_ref[3];
332   /** Third vector, orthogonal to vec_lnor and vec_ref. */
333   float vec_ortho[3];
334   /** Reference angle, around vec_ortho, in ]0, pi] range (0.0 marks that space as invalid). */
335   float ref_alpha;
336   /** Reference angle, around vec_lnor, in ]0, 2pi] range (0.0 marks that space as invalid). */
337   float ref_beta;
338   /** All loops using this lnor space (i.e. smooth fan of loops),
339    * as (depending on owning MLoopNorSpaceArrary.data_type):
340    *     - Indices (uint_in_ptr), or
341    *     - BMLoop pointers. */
342   struct LinkNode *loops;
343   char flags;
344
345   /** To be used for extended processing related to loop normal spaces (aka smooth fans). */
346   void *user_data;
347 } MLoopNorSpace;
348 /**
349  * MLoopNorSpace.flags
350  */
351 enum {
352   MLNOR_SPACE_IS_SINGLE = 1 << 0,
353 };
354
355 /**
356  * Collection of #MLoopNorSpace basic storage & pre-allocation.
357  */
358 typedef struct MLoopNorSpaceArray {
359   MLoopNorSpace **lspacearr; /* MLoop aligned array */
360   struct LinkNode
361       *loops_pool; /* Allocated once, avoids to call BLI_linklist_prepend_arena() for each loop! */
362   char data_type;  /* Whether we store loop indices, or pointers to BMLoop. */
363   int num_spaces;  /* Number of clnors spaces defined in this array. */
364   struct MemArena *mem;
365 } MLoopNorSpaceArray;
366 /**
367  * MLoopNorSpaceArray.data_type
368  */
369 enum {
370   MLNOR_SPACEARR_LOOP_INDEX = 0,
371   MLNOR_SPACEARR_BMLOOP_PTR = 1,
372 };
373
374 /* Low-level custom normals functions. */
375 void BKE_lnor_spacearr_init(MLoopNorSpaceArray *lnors_spacearr,
376                             const int numLoops,
377                             const char data_type);
378 void BKE_lnor_spacearr_clear(MLoopNorSpaceArray *lnors_spacearr);
379 void BKE_lnor_spacearr_free(MLoopNorSpaceArray *lnors_spacearr);
380 MLoopNorSpace *BKE_lnor_space_create(MLoopNorSpaceArray *lnors_spacearr);
381 void BKE_lnor_space_define(MLoopNorSpace *lnor_space,
382                            const float lnor[3],
383                            float vec_ref[3],
384                            float vec_other[3],
385                            struct BLI_Stack *edge_vectors);
386 void BKE_lnor_space_add_loop(MLoopNorSpaceArray *lnors_spacearr,
387                              MLoopNorSpace *lnor_space,
388                              const int ml_index,
389                              void *bm_loop,
390                              const bool is_single);
391 void BKE_lnor_space_custom_data_to_normal(MLoopNorSpace *lnor_space,
392                                           const short clnor_data[2],
393                                           float r_custom_lnor[3]);
394 void BKE_lnor_space_custom_normal_to_data(MLoopNorSpace *lnor_space,
395                                           const float custom_lnor[3],
396                                           short r_clnor_data[2]);
397
398 /* Medium-level custom normals functions. */
399 void BKE_mesh_normals_loop_split(const struct MVert *mverts,
400                                  const int numVerts,
401                                  struct MEdge *medges,
402                                  const int numEdges,
403                                  struct MLoop *mloops,
404                                  float (*r_loopnors)[3],
405                                  const int numLoops,
406                                  struct MPoly *mpolys,
407                                  const float (*polynors)[3],
408                                  const int numPolys,
409                                  const bool use_split_normals,
410                                  const float split_angle,
411                                  MLoopNorSpaceArray *r_lnors_spacearr,
412                                  short (*clnors_data)[2],
413                                  int *r_loop_to_poly);
414
415 void BKE_mesh_normals_loop_custom_set(const struct MVert *mverts,
416                                       const int numVerts,
417                                       struct MEdge *medges,
418                                       const int numEdges,
419                                       struct MLoop *mloops,
420                                       float (*r_custom_loopnors)[3],
421                                       const int numLoops,
422                                       struct MPoly *mpolys,
423                                       const float (*polynors)[3],
424                                       const int numPolys,
425                                       short (*r_clnors_data)[2]);
426 void BKE_mesh_normals_loop_custom_from_vertices_set(const struct MVert *mverts,
427                                                     float (*r_custom_vertnors)[3],
428                                                     const int numVerts,
429                                                     struct MEdge *medges,
430                                                     const int numEdges,
431                                                     struct MLoop *mloops,
432                                                     const int numLoops,
433                                                     struct MPoly *mpolys,
434                                                     const float (*polynors)[3],
435                                                     const int numPolys,
436                                                     short (*r_clnors_data)[2]);
437
438 void BKE_mesh_normals_loop_to_vertex(const int numVerts,
439                                      const struct MLoop *mloops,
440                                      const int numLoops,
441                                      const float (*clnors)[3],
442                                      float (*r_vert_clnors)[3]);
443
444 /* High-level custom normals functions. */
445 bool BKE_mesh_has_custom_loop_normals(struct Mesh *me);
446
447 void BKE_mesh_calc_normals_split(struct Mesh *mesh);
448 void BKE_mesh_calc_normals_split_ex(struct Mesh *mesh,
449                                     struct MLoopNorSpaceArray *r_lnors_spacearr);
450
451 void BKE_mesh_set_custom_normals(struct Mesh *mesh, float (*r_custom_loopnors)[3]);
452 void BKE_mesh_set_custom_normals_from_vertices(struct Mesh *mesh, float (*r_custom_vertnors)[3]);
453
454 void BKE_mesh_calc_poly_normal(const struct MPoly *mpoly,
455                                const struct MLoop *loopstart,
456                                const struct MVert *mvarray,
457                                float r_no[3]);
458 void BKE_mesh_calc_poly_normal_coords(const struct MPoly *mpoly,
459                                       const struct MLoop *loopstart,
460                                       const float (*vertex_coords)[3],
461                                       float r_no[3]);
462 void BKE_mesh_calc_poly_center(const struct MPoly *mpoly,
463                                const struct MLoop *loopstart,
464                                const struct MVert *mvarray,
465                                float r_cent[3]);
466 float BKE_mesh_calc_poly_area(const struct MPoly *mpoly,
467                               const struct MLoop *loopstart,
468                               const struct MVert *mvarray);
469 void BKE_mesh_calc_poly_angles(const struct MPoly *mpoly,
470                                const struct MLoop *loopstart,
471                                const struct MVert *mvarray,
472                                float angles[]);
473
474 void BKE_mesh_poly_edgehash_insert(struct EdgeHash *ehash,
475                                    const struct MPoly *mp,
476                                    const struct MLoop *mloop);
477 void BKE_mesh_poly_edgebitmap_insert(unsigned int *edge_bitmap,
478                                      const struct MPoly *mp,
479                                      const struct MLoop *mloop);
480
481 bool BKE_mesh_center_median(const struct Mesh *me, float r_cent[3]);
482 bool BKE_mesh_center_bounds(const struct Mesh *me, float r_cent[3]);
483 bool BKE_mesh_center_of_surface(const struct Mesh *me, float r_cent[3]);
484 bool BKE_mesh_center_of_volume(const struct Mesh *me, float r_cent[3]);
485
486 void BKE_mesh_calc_volume(const struct MVert *mverts,
487                           const int mverts_num,
488                           const struct MLoopTri *mlooptri,
489                           const int looptri_num,
490                           const struct MLoop *mloop,
491                           float *r_volume,
492                           float r_center[3]);
493
494 /* tessface */
495 void BKE_mesh_loops_to_mface_corners(struct CustomData *fdata,
496                                      struct CustomData *ldata,
497                                      struct CustomData *pdata,
498                                      unsigned int lindex[4],
499                                      int findex,
500                                      const int polyindex,
501                                      const int mf_len,
502                                      const int numTex,
503                                      const int numCol,
504                                      const bool hasPCol,
505                                      const bool hasOrigSpace,
506                                      const bool hasLNor);
507 void BKE_mesh_loops_to_tessdata(struct CustomData *fdata,
508                                 struct CustomData *ldata,
509                                 struct MFace *mface,
510                                 int *polyindices,
511                                 unsigned int (*loopindices)[4],
512                                 const int num_faces);
513 void BKE_mesh_tangent_loops_to_tessdata(struct CustomData *fdata,
514                                         struct CustomData *ldata,
515                                         struct MFace *mface,
516                                         int *polyindices,
517                                         unsigned int (*loopindices)[4],
518                                         const int num_faces,
519                                         const char *layer_name);
520 int BKE_mesh_recalc_tessellation(struct CustomData *fdata,
521                                  struct CustomData *ldata,
522                                  struct CustomData *pdata,
523                                  struct MVert *mvert,
524                                  int totface,
525                                  int totloop,
526                                  int totpoly,
527                                  const bool do_face_nor_copy);
528 void BKE_mesh_recalc_looptri(const struct MLoop *mloop,
529                              const struct MPoly *mpoly,
530                              const struct MVert *mvert,
531                              int totloop,
532                              int totpoly,
533                              struct MLoopTri *mlooptri);
534 void BKE_mesh_convert_mfaces_to_mpolys(struct Mesh *mesh);
535 void BKE_mesh_do_versions_convert_mfaces_to_mpolys(struct Mesh *mesh);
536 void BKE_mesh_convert_mfaces_to_mpolys_ex(struct ID *id,
537                                           struct CustomData *fdata,
538                                           struct CustomData *ldata,
539                                           struct CustomData *pdata,
540                                           int totedge_i,
541                                           int totface_i,
542                                           int totloop_i,
543                                           int totpoly_i,
544                                           struct MEdge *medge,
545                                           struct MFace *mface,
546                                           int *r_totloop,
547                                           int *r_totpoly,
548                                           struct MLoop **r_mloop,
549                                           struct MPoly **r_mpoly);
550
551 void BKE_mesh_mdisp_flip(struct MDisps *md, const bool use_loop_mdisp_flip);
552
553 void BKE_mesh_polygon_flip_ex(struct MPoly *mpoly,
554                               struct MLoop *mloop,
555                               struct CustomData *ldata,
556                               float (*lnors)[3],
557                               struct MDisps *mdisp,
558                               const bool use_loop_mdisp_flip);
559 void BKE_mesh_polygon_flip(struct MPoly *mpoly, struct MLoop *mloop, struct CustomData *ldata);
560 void BKE_mesh_polygons_flip(struct MPoly *mpoly,
561                             struct MLoop *mloop,
562                             struct CustomData *ldata,
563                             int totpoly);
564
565 /* merge verts  */
566 /* Enum for merge_mode of CDDM_merge_verts.
567  * Refer to mesh.c for details. */
568 enum {
569   MESH_MERGE_VERTS_DUMP_IF_MAPPED,
570   MESH_MERGE_VERTS_DUMP_IF_EQUAL,
571 };
572 struct Mesh *BKE_mesh_merge_verts(struct Mesh *mesh,
573                                   const int *vtargetmap,
574                                   const int tot_vtargetmap,
575                                   const int merge_mode);
576
577 /* flush flags */
578 void BKE_mesh_flush_hidden_from_verts_ex(const struct MVert *mvert,
579                                          const struct MLoop *mloop,
580                                          struct MEdge *medge,
581                                          const int totedge,
582                                          struct MPoly *mpoly,
583                                          const int totpoly);
584 void BKE_mesh_flush_hidden_from_verts(struct Mesh *me);
585 void BKE_mesh_flush_hidden_from_polys_ex(struct MVert *mvert,
586                                          const struct MLoop *mloop,
587                                          struct MEdge *medge,
588                                          const int totedge,
589                                          const struct MPoly *mpoly,
590                                          const int totpoly);
591 void BKE_mesh_flush_hidden_from_polys(struct Mesh *me);
592 void BKE_mesh_flush_select_from_polys_ex(struct MVert *mvert,
593                                          const int totvert,
594                                          const struct MLoop *mloop,
595                                          struct MEdge *medge,
596                                          const int totedge,
597                                          const struct MPoly *mpoly,
598                                          const int totpoly);
599 void BKE_mesh_flush_select_from_polys(struct Mesh *me);
600 void BKE_mesh_flush_select_from_verts_ex(const struct MVert *mvert,
601                                          const int totvert,
602                                          const struct MLoop *mloop,
603                                          struct MEdge *medge,
604                                          const int totedge,
605                                          struct MPoly *mpoly,
606                                          const int totpoly);
607 void BKE_mesh_flush_select_from_verts(struct Mesh *me);
608
609 /* spatial evaluation */
610 void BKE_mesh_calc_relative_deform(const struct MPoly *mpoly,
611                                    const int totpoly,
612                                    const struct MLoop *mloop,
613                                    const int totvert,
614
615                                    const float (*vert_cos_src)[3],
616                                    const float (*vert_cos_dst)[3],
617
618                                    const float (*vert_cos_org)[3],
619                                    float (*vert_cos_new)[3]);
620
621 /* *** mesh_validate.c *** */
622
623 bool BKE_mesh_validate(struct Mesh *me, const bool do_verbose, const bool cddata_check_mask);
624 bool BKE_mesh_is_valid(struct Mesh *me);
625 bool BKE_mesh_validate_material_indices(struct Mesh *me);
626
627 bool BKE_mesh_validate_arrays(struct Mesh *me,
628                               struct MVert *mverts,
629                               unsigned int totvert,
630                               struct MEdge *medges,
631                               unsigned int totedge,
632                               struct MFace *mfaces,
633                               unsigned int totface,
634                               struct MLoop *mloops,
635                               unsigned int totloop,
636                               struct MPoly *mpolys,
637                               unsigned int totpoly,
638                               struct MDeformVert *dverts, /* assume totvert length */
639                               const bool do_verbose,
640                               const bool do_fixes,
641                               bool *r_change);
642
643 bool BKE_mesh_validate_all_customdata(struct CustomData *vdata,
644                                       const uint totvert,
645                                       struct CustomData *edata,
646                                       const uint totedge,
647                                       struct CustomData *ldata,
648                                       const uint totloop,
649                                       struct CustomData *pdata,
650                                       const uint totpoly,
651                                       const bool check_meshmask,
652                                       const bool do_verbose,
653                                       const bool do_fixes,
654                                       bool *r_change);
655
656 void BKE_mesh_strip_loose_faces(struct Mesh *me);
657 void BKE_mesh_strip_loose_polysloops(struct Mesh *me);
658 void BKE_mesh_strip_loose_edges(struct Mesh *me);
659
660 void BKE_mesh_calc_edges_legacy(struct Mesh *me, const bool use_old);
661 void BKE_mesh_calc_edges_loose(struct Mesh *mesh);
662 void BKE_mesh_calc_edges(struct Mesh *mesh, bool update, const bool select);
663 void BKE_mesh_calc_edges_tessface(struct Mesh *mesh);
664
665 /* **** Depsgraph evaluation **** */
666
667 void BKE_mesh_eval_geometry(struct Depsgraph *depsgraph, struct Mesh *mesh);
668
669 /* Draw Cache */
670 enum {
671   BKE_MESH_BATCH_DIRTY_ALL = 0,
672   BKE_MESH_BATCH_DIRTY_MAYBE_ALL,
673   BKE_MESH_BATCH_DIRTY_SELECT,
674   BKE_MESH_BATCH_DIRTY_SHADING,
675   BKE_MESH_BATCH_DIRTY_SCULPT_COORDS,
676   BKE_MESH_BATCH_DIRTY_UVEDIT_ALL,
677   BKE_MESH_BATCH_DIRTY_UVEDIT_SELECT,
678 };
679 void BKE_mesh_batch_cache_dirty_tag(struct Mesh *me, int mode);
680 void BKE_mesh_batch_cache_free(struct Mesh *me);
681
682 extern void (*BKE_mesh_batch_cache_dirty_tag_cb)(struct Mesh *me, int mode);
683 extern void (*BKE_mesh_batch_cache_free_cb)(struct Mesh *me);
684
685 /* Inlines */
686
687 /* Instead of -1 that function uses ORIGINDEX_NONE as defined in BKE_customdata.h,
688  * but I don't want to force every user of BKE_mesh.h to also include that file.
689  * ~~ Sybren */
690 BLI_INLINE int BKE_mesh_origindex_mface_mpoly(const int *index_mf_to_mpoly,
691                                               const int *index_mp_to_orig,
692                                               const int i)
693 {
694   const int j = index_mf_to_mpoly[i];
695   return (j != -1) ? (index_mp_to_orig ? index_mp_to_orig[j] : j) : -1;
696 }
697
698 #ifdef __cplusplus
699 }
700 #endif
701
702 #endif /* __BKE_MESH_H__ */