Update Eigen to 3.3.7
[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 void BKE_mesh_clear_geometry(struct Mesh *me);
109 struct Mesh *BKE_mesh_add(struct Main *bmain, const char *name);
110 void BKE_mesh_copy_data(struct Main *bmain,
111                         struct Mesh *me_dst,
112                         const struct Mesh *me_src,
113                         const int flag);
114 struct Mesh *BKE_mesh_copy(struct Main *bmain, const struct Mesh *me);
115 void BKE_mesh_update_customdata_pointers(struct Mesh *me, const bool do_ensure_tess_cd);
116 void BKE_mesh_ensure_skin_customdata(struct Mesh *me);
117
118 struct Mesh *BKE_mesh_new_nomain(
119     int verts_len, int edges_len, int tessface_len, int loops_len, int polys_len);
120 struct Mesh *BKE_mesh_new_nomain_from_template(const struct Mesh *me_src,
121                                                int verts_len,
122                                                int edges_len,
123                                                int tessface_len,
124                                                int loops_len,
125                                                int polys_len);
126
127 void BKE_mesh_eval_delete(struct Mesh *me_eval);
128
129 /* Performs copy for use during evaluation,
130  * optional referencing original arrays to reduce memory. */
131 struct Mesh *BKE_mesh_copy_for_eval(struct Mesh *source, bool reference);
132
133 /* These functions construct a new Mesh,
134  * contrary to BKE_mesh_from_nurbs which modifies ob itself. */
135 struct Mesh *BKE_mesh_new_nomain_from_curve(struct Object *ob);
136 struct Mesh *BKE_mesh_new_nomain_from_curve_displist(struct Object *ob, struct ListBase *dispbase);
137
138 bool BKE_mesh_ensure_facemap_customdata(struct Mesh *me);
139 bool BKE_mesh_clear_facemap_customdata(struct Mesh *me);
140
141 void BKE_mesh_make_local(struct Main *bmain, struct Mesh *me, const bool lib_local);
142 void BKE_mesh_boundbox_calc(struct Mesh *me, float r_loc[3], float r_size[3]);
143 void BKE_mesh_texspace_calc(struct Mesh *me);
144 float (*BKE_mesh_orco_verts_get(struct Object *ob))[3];
145 void BKE_mesh_orco_verts_transform(struct Mesh *me, float (*orco)[3], int totvert, int invert);
146 int test_index_face(struct MFace *mface, struct CustomData *mfdata, int mfindex, int nr);
147 struct Mesh *BKE_mesh_from_object(struct Object *ob);
148 void BKE_mesh_assign_object(struct Main *bmain, struct Object *ob, struct Mesh *me);
149 void BKE_mesh_from_metaball(struct ListBase *lb, struct Mesh *me);
150 int BKE_mesh_nurbs_to_mdata(struct Object *ob,
151                             struct MVert **r_allvert,
152                             int *r_totvert,
153                             struct MEdge **r_alledge,
154                             int *r_totedge,
155                             struct MLoop **r_allloop,
156                             struct MPoly **r_allpoly,
157                             int *r_totloop,
158                             int *r_totpoly);
159 int BKE_mesh_nurbs_displist_to_mdata(struct Object *ob,
160                                      const struct ListBase *dispbase,
161                                      struct MVert **r_allvert,
162                                      int *r_totvert,
163                                      struct MEdge **r_alledge,
164                                      int *r_totedge,
165                                      struct MLoop **r_allloop,
166                                      struct MPoly **r_allpoly,
167                                      struct MLoopUV **r_alluv,
168                                      int *r_totloop,
169                                      int *r_totpoly);
170 void BKE_mesh_from_nurbs_displist(struct Main *bmain,
171                                   struct Object *ob,
172                                   struct ListBase *dispbase,
173                                   const bool use_orco_uv,
174                                   const char *obdata_name,
175                                   bool temporary);
176 void BKE_mesh_from_nurbs(struct Main *bmain, struct Object *ob);
177 void BKE_mesh_to_curve_nurblist(const struct Mesh *me,
178                                 struct ListBase *nurblist,
179                                 const int edge_users_test);
180 void BKE_mesh_to_curve(struct Main *bmain,
181                        struct Depsgraph *depsgraph,
182                        struct Scene *scene,
183                        struct Object *ob);
184 void BKE_mesh_material_index_remove(struct Mesh *me, short index);
185 bool BKE_mesh_material_index_used(struct Mesh *me, short index);
186 void BKE_mesh_material_index_clear(struct Mesh *me);
187 void BKE_mesh_material_remap(struct Mesh *me, const unsigned int *remap, unsigned int remap_len);
188 void BKE_mesh_smooth_flag_set(struct Object *meshOb, int enableSmooth);
189
190 const char *BKE_mesh_cmp(struct Mesh *me1, struct Mesh *me2, float thresh);
191
192 struct BoundBox *BKE_mesh_boundbox_get(struct Object *ob);
193 struct BoundBox *BKE_mesh_texspace_get(struct Mesh *me,
194                                        float r_loc[3],
195                                        float r_rot[3],
196                                        float r_size[3]);
197 void BKE_mesh_texspace_get_reference(
198     struct Mesh *me, short **r_texflag, float **r_loc, float **r_rot, float **r_size);
199 void BKE_mesh_texspace_copy_from_object(struct Mesh *me, struct Object *ob);
200
201 bool BKE_mesh_uv_cdlayer_rename_index(struct Mesh *me,
202                                       const int loop_index,
203                                       const int face_index,
204                                       const char *new_name,
205                                       const bool do_tessface);
206 bool BKE_mesh_uv_cdlayer_rename(struct Mesh *me,
207                                 const char *old_name,
208                                 const char *new_name,
209                                 bool do_tessface);
210
211 float (*BKE_mesh_vertexCos_get(const struct Mesh *me, int *r_numVerts))[3];
212
213 void BKE_mesh_split_faces(struct Mesh *mesh, bool free_loop_normals);
214
215 /* Create new mesh from the given object at its current state.
216  * The owner of this mesh is unknown, it is up to the caller to decide.
217  *
218  * If preserve_all_data_layers is truth then the modifier stack is re-evaluated to ensure it
219  * preserves all possible custom data layers.
220  *
221  * NOTE: Dependency graph argument is required when preserve_all_data_layers is truth, and is
222  * ignored otherwise. */
223 struct Mesh *BKE_mesh_new_from_object(struct Depsgraph *depsgraph,
224                                       struct Object *object,
225                                       bool preserve_all_data_layers);
226
227 /* This is a version of BKE_mesh_new_from_object() which stores mesh in the given main database.
228  * However, that function enforces object type to be a geometry one, and ensures a mesh is always
229  * generated, be it empty. */
230 struct Mesh *BKE_mesh_new_from_object_to_bmain(struct Main *bmain,
231                                                struct Depsgraph *depsgraph,
232                                                struct Object *object,
233                                                bool preserve_all_data_layers);
234
235 struct Mesh *BKE_mesh_create_derived_for_modifier(struct Depsgraph *depsgraph,
236                                                   struct Scene *scene,
237                                                   struct Object *ob_eval,
238                                                   struct ModifierData *md_eval,
239                                                   int build_shapekey_layers);
240
241 /* Copies a nomain-Mesh into an existing Mesh. */
242 void BKE_mesh_nomain_to_mesh(struct Mesh *mesh_src,
243                              struct Mesh *mesh_dst,
244                              struct Object *ob,
245                              const struct CustomData_MeshMasks *mask,
246                              bool take_ownership);
247 void BKE_mesh_nomain_to_meshkey(struct Mesh *mesh_src, struct Mesh *mesh_dst, struct KeyBlock *kb);
248
249 /* vertex level transformations & checks (no derived mesh) */
250
251 bool BKE_mesh_minmax(const struct Mesh *me, float r_min[3], float r_max[3]);
252 void BKE_mesh_transform(struct Mesh *me, float mat[4][4], bool do_keys);
253 void BKE_mesh_translate(struct Mesh *me, const float offset[3], const bool do_keys);
254
255 void BKE_mesh_ensure_navmesh(struct Mesh *me);
256
257 void BKE_mesh_tessface_calc(struct Mesh *mesh);
258 void BKE_mesh_tessface_ensure(struct Mesh *mesh);
259 void BKE_mesh_tessface_clear(struct Mesh *mesh);
260
261 void BKE_mesh_do_versions_cd_flag_init(struct Mesh *mesh);
262
263 void BKE_mesh_mselect_clear(struct Mesh *me);
264 void BKE_mesh_mselect_validate(struct Mesh *me);
265 int BKE_mesh_mselect_find(struct Mesh *me, int index, int type);
266 int BKE_mesh_mselect_active_get(struct Mesh *me, int type);
267 void BKE_mesh_mselect_active_set(struct Mesh *me, int index, int type);
268
269 void BKE_mesh_count_selected_items(const struct Mesh *mesh, int r_count[3]);
270
271 void BKE_mesh_apply_vert_coords(struct Mesh *mesh, const float (*vertCoords)[3]);
272 void BKE_mesh_apply_vert_normals(struct Mesh *mesh, const short (*vertNormals)[3]);
273
274 /* *** mesh_evaluate.c *** */
275
276 void BKE_mesh_calc_normals_mapping_simple(struct Mesh *me);
277 void BKE_mesh_calc_normals_mapping(struct MVert *mverts,
278                                    int numVerts,
279                                    const struct MLoop *mloop,
280                                    const struct MPoly *mpolys,
281                                    int numLoops,
282                                    int numPolys,
283                                    float (*r_polyNors)[3],
284                                    const struct MFace *mfaces,
285                                    int numFaces,
286                                    const int *origIndexFace,
287                                    float (*r_faceNors)[3]);
288 void BKE_mesh_calc_normals_mapping_ex(struct MVert *mverts,
289                                       int numVerts,
290                                       const struct MLoop *mloop,
291                                       const struct MPoly *mpolys,
292                                       int numLoops,
293                                       int numPolys,
294                                       float (*r_polyNors)[3],
295                                       const struct MFace *mfaces,
296                                       int numFaces,
297                                       const int *origIndexFace,
298                                       float (*r_faceNors)[3],
299                                       const bool only_face_normals);
300 void BKE_mesh_calc_normals_poly(struct MVert *mverts,
301                                 float (*r_vertnors)[3],
302                                 int numVerts,
303                                 const struct MLoop *mloop,
304                                 const struct MPoly *mpolys,
305                                 int numLoops,
306                                 int numPolys,
307                                 float (*r_polyNors)[3],
308                                 const bool only_face_normals);
309 void BKE_mesh_calc_normals(struct Mesh *me);
310 void BKE_mesh_ensure_normals(struct Mesh *me);
311 void BKE_mesh_ensure_normals_for_display(struct Mesh *mesh);
312 void BKE_mesh_calc_normals_tessface(struct MVert *mverts,
313                                     int numVerts,
314                                     const struct MFace *mfaces,
315                                     int numFaces,
316                                     float (*r_faceNors)[3]);
317 void BKE_mesh_calc_normals_looptri(struct MVert *mverts,
318                                    int numVerts,
319                                    const struct MLoop *mloop,
320                                    const struct MLoopTri *looptri,
321                                    int looptri_num,
322                                    float (*r_tri_nors)[3]);
323 void BKE_mesh_loop_manifold_fan_around_vert_next(const struct MLoop *mloops,
324                                                  const struct MPoly *mpolys,
325                                                  const int *loop_to_poly,
326                                                  const int *e2lfan_curr,
327                                                  const uint mv_pivot_index,
328                                                  const struct MLoop **r_mlfan_curr,
329                                                  int *r_mlfan_curr_index,
330                                                  int *r_mlfan_vert_index,
331                                                  int *r_mpfan_curr_index);
332
333 void BKE_edges_sharp_from_angle_set(const struct MVert *mverts,
334                                     const int numVerts,
335                                     struct MEdge *medges,
336                                     const int numEdges,
337                                     struct MLoop *mloops,
338                                     const int numLoops,
339                                     struct MPoly *mpolys,
340                                     const float (*polynors)[3],
341                                     const int numPolys,
342                                     const float split_angle);
343
344 /**
345  * References a contiguous loop-fan with normal offset vars.
346  */
347 typedef struct MLoopNorSpace {
348   /** Automatically computed loop normal. */
349   float vec_lnor[3];
350   /** Reference vector, orthogonal to vec_lnor. */
351   float vec_ref[3];
352   /** Third vector, orthogonal to vec_lnor and vec_ref. */
353   float vec_ortho[3];
354   /** Reference angle, around vec_ortho, in ]0, pi] range (0.0 marks that space as invalid). */
355   float ref_alpha;
356   /** Reference angle, around vec_lnor, in ]0, 2pi] range (0.0 marks that space as invalid). */
357   float ref_beta;
358   /** All loops using this lnor space (i.e. smooth fan of loops),
359    * as (depending on owning MLoopNorSpaceArrary.data_type):
360    *     - Indices (uint_in_ptr), or
361    *     - BMLoop pointers. */
362   struct LinkNode *loops;
363   char flags;
364
365   /** To be used for extended processing related to loop normal spaces (aka smooth fans). */
366   void *user_data;
367 } MLoopNorSpace;
368 /**
369  * MLoopNorSpace.flags
370  */
371 enum {
372   MLNOR_SPACE_IS_SINGLE = 1 << 0,
373 };
374
375 /**
376  * Collection of #MLoopNorSpace basic storage & pre-allocation.
377  */
378 typedef struct MLoopNorSpaceArray {
379   MLoopNorSpace **lspacearr; /* MLoop aligned array */
380   struct LinkNode
381       *loops_pool; /* Allocated once, avoids to call BLI_linklist_prepend_arena() for each loop! */
382   char data_type;  /* Whether we store loop indices, or pointers to BMLoop. */
383   int num_spaces;  /* Number of clnors spaces defined in this array. */
384   struct MemArena *mem;
385 } MLoopNorSpaceArray;
386 /**
387  * MLoopNorSpaceArray.data_type
388  */
389 enum {
390   MLNOR_SPACEARR_LOOP_INDEX = 0,
391   MLNOR_SPACEARR_BMLOOP_PTR = 1,
392 };
393
394 /* Low-level custom normals functions. */
395 void BKE_lnor_spacearr_init(MLoopNorSpaceArray *lnors_spacearr,
396                             const int numLoops,
397                             const char data_type);
398 void BKE_lnor_spacearr_clear(MLoopNorSpaceArray *lnors_spacearr);
399 void BKE_lnor_spacearr_free(MLoopNorSpaceArray *lnors_spacearr);
400 MLoopNorSpace *BKE_lnor_space_create(MLoopNorSpaceArray *lnors_spacearr);
401 void BKE_lnor_space_define(MLoopNorSpace *lnor_space,
402                            const float lnor[3],
403                            float vec_ref[3],
404                            float vec_other[3],
405                            struct BLI_Stack *edge_vectors);
406 void BKE_lnor_space_add_loop(MLoopNorSpaceArray *lnors_spacearr,
407                              MLoopNorSpace *lnor_space,
408                              const int ml_index,
409                              void *bm_loop,
410                              const bool is_single);
411 void BKE_lnor_space_custom_data_to_normal(MLoopNorSpace *lnor_space,
412                                           const short clnor_data[2],
413                                           float r_custom_lnor[3]);
414 void BKE_lnor_space_custom_normal_to_data(MLoopNorSpace *lnor_space,
415                                           const float custom_lnor[3],
416                                           short r_clnor_data[2]);
417
418 /* Medium-level custom normals functions. */
419 void BKE_mesh_normals_loop_split(const struct MVert *mverts,
420                                  const int numVerts,
421                                  struct MEdge *medges,
422                                  const int numEdges,
423                                  struct MLoop *mloops,
424                                  float (*r_loopnors)[3],
425                                  const int numLoops,
426                                  struct MPoly *mpolys,
427                                  const float (*polynors)[3],
428                                  const int numPolys,
429                                  const bool use_split_normals,
430                                  const float split_angle,
431                                  MLoopNorSpaceArray *r_lnors_spacearr,
432                                  short (*clnors_data)[2],
433                                  int *r_loop_to_poly);
434
435 void BKE_mesh_normals_loop_custom_set(const struct MVert *mverts,
436                                       const int numVerts,
437                                       struct MEdge *medges,
438                                       const int numEdges,
439                                       struct MLoop *mloops,
440                                       float (*r_custom_loopnors)[3],
441                                       const int numLoops,
442                                       struct MPoly *mpolys,
443                                       const float (*polynors)[3],
444                                       const int numPolys,
445                                       short (*r_clnors_data)[2]);
446 void BKE_mesh_normals_loop_custom_from_vertices_set(const struct MVert *mverts,
447                                                     float (*r_custom_vertnors)[3],
448                                                     const int numVerts,
449                                                     struct MEdge *medges,
450                                                     const int numEdges,
451                                                     struct MLoop *mloops,
452                                                     const int numLoops,
453                                                     struct MPoly *mpolys,
454                                                     const float (*polynors)[3],
455                                                     const int numPolys,
456                                                     short (*r_clnors_data)[2]);
457
458 void BKE_mesh_normals_loop_to_vertex(const int numVerts,
459                                      const struct MLoop *mloops,
460                                      const int numLoops,
461                                      const float (*clnors)[3],
462                                      float (*r_vert_clnors)[3]);
463
464 /* High-level custom normals functions. */
465 bool BKE_mesh_has_custom_loop_normals(struct Mesh *me);
466
467 void BKE_mesh_calc_normals_split(struct Mesh *mesh);
468 void BKE_mesh_calc_normals_split_ex(struct Mesh *mesh,
469                                     struct MLoopNorSpaceArray *r_lnors_spacearr);
470
471 void BKE_mesh_set_custom_normals(struct Mesh *mesh, float (*r_custom_loopnors)[3]);
472 void BKE_mesh_set_custom_normals_from_vertices(struct Mesh *mesh, float (*r_custom_vertnors)[3]);
473
474 void BKE_mesh_calc_poly_normal(const struct MPoly *mpoly,
475                                const struct MLoop *loopstart,
476                                const struct MVert *mvarray,
477                                float r_no[3]);
478 void BKE_mesh_calc_poly_normal_coords(const struct MPoly *mpoly,
479                                       const struct MLoop *loopstart,
480                                       const float (*vertex_coords)[3],
481                                       float r_no[3]);
482 void BKE_mesh_calc_poly_center(const struct MPoly *mpoly,
483                                const struct MLoop *loopstart,
484                                const struct MVert *mvarray,
485                                float r_cent[3]);
486 float BKE_mesh_calc_poly_area(const struct MPoly *mpoly,
487                               const struct MLoop *loopstart,
488                               const struct MVert *mvarray);
489 float BKE_mesh_calc_poly_uv_area(const struct MPoly *mpoly, const struct MLoopUV *uv_array);
490 void BKE_mesh_calc_poly_angles(const struct MPoly *mpoly,
491                                const struct MLoop *loopstart,
492                                const struct MVert *mvarray,
493                                float angles[]);
494
495 void BKE_mesh_poly_edgehash_insert(struct EdgeHash *ehash,
496                                    const struct MPoly *mp,
497                                    const struct MLoop *mloop);
498 void BKE_mesh_poly_edgebitmap_insert(unsigned int *edge_bitmap,
499                                      const struct MPoly *mp,
500                                      const struct MLoop *mloop);
501
502 bool BKE_mesh_center_median(const struct Mesh *me, float r_cent[3]);
503 bool BKE_mesh_center_bounds(const struct Mesh *me, float r_cent[3]);
504 bool BKE_mesh_center_of_surface(const struct Mesh *me, float r_cent[3]);
505 bool BKE_mesh_center_of_volume(const struct Mesh *me, float r_cent[3]);
506
507 void BKE_mesh_calc_volume(const struct MVert *mverts,
508                           const int mverts_num,
509                           const struct MLoopTri *mlooptri,
510                           const int looptri_num,
511                           const struct MLoop *mloop,
512                           float *r_volume,
513                           float r_center[3]);
514
515 /* tessface */
516 void BKE_mesh_loops_to_mface_corners(struct CustomData *fdata,
517                                      struct CustomData *ldata,
518                                      struct CustomData *pdata,
519                                      unsigned int lindex[4],
520                                      int findex,
521                                      const int polyindex,
522                                      const int mf_len,
523                                      const int numTex,
524                                      const int numCol,
525                                      const bool hasPCol,
526                                      const bool hasOrigSpace,
527                                      const bool hasLNor);
528 void BKE_mesh_loops_to_tessdata(struct CustomData *fdata,
529                                 struct CustomData *ldata,
530                                 struct MFace *mface,
531                                 int *polyindices,
532                                 unsigned int (*loopindices)[4],
533                                 const int num_faces);
534 void BKE_mesh_tangent_loops_to_tessdata(struct CustomData *fdata,
535                                         struct CustomData *ldata,
536                                         struct MFace *mface,
537                                         int *polyindices,
538                                         unsigned int (*loopindices)[4],
539                                         const int num_faces,
540                                         const char *layer_name);
541 int BKE_mesh_recalc_tessellation(struct CustomData *fdata,
542                                  struct CustomData *ldata,
543                                  struct CustomData *pdata,
544                                  struct MVert *mvert,
545                                  int totface,
546                                  int totloop,
547                                  int totpoly,
548                                  const bool do_face_nor_copy);
549 void BKE_mesh_recalc_looptri(const struct MLoop *mloop,
550                              const struct MPoly *mpoly,
551                              const struct MVert *mvert,
552                              int totloop,
553                              int totpoly,
554                              struct MLoopTri *mlooptri);
555 void BKE_mesh_convert_mfaces_to_mpolys(struct Mesh *mesh);
556 void BKE_mesh_do_versions_convert_mfaces_to_mpolys(struct Mesh *mesh);
557 void BKE_mesh_convert_mfaces_to_mpolys_ex(struct ID *id,
558                                           struct CustomData *fdata,
559                                           struct CustomData *ldata,
560                                           struct CustomData *pdata,
561                                           int totedge_i,
562                                           int totface_i,
563                                           int totloop_i,
564                                           int totpoly_i,
565                                           struct MEdge *medge,
566                                           struct MFace *mface,
567                                           int *r_totloop,
568                                           int *r_totpoly,
569                                           struct MLoop **r_mloop,
570                                           struct MPoly **r_mpoly);
571
572 void BKE_mesh_mdisp_flip(struct MDisps *md, const bool use_loop_mdisp_flip);
573
574 void BKE_mesh_polygon_flip_ex(struct MPoly *mpoly,
575                               struct MLoop *mloop,
576                               struct CustomData *ldata,
577                               float (*lnors)[3],
578                               struct MDisps *mdisp,
579                               const bool use_loop_mdisp_flip);
580 void BKE_mesh_polygon_flip(struct MPoly *mpoly, struct MLoop *mloop, struct CustomData *ldata);
581 void BKE_mesh_polygons_flip(struct MPoly *mpoly,
582                             struct MLoop *mloop,
583                             struct CustomData *ldata,
584                             int totpoly);
585
586 /* merge verts  */
587 /* Enum for merge_mode of CDDM_merge_verts.
588  * Refer to mesh.c for details. */
589 enum {
590   MESH_MERGE_VERTS_DUMP_IF_MAPPED,
591   MESH_MERGE_VERTS_DUMP_IF_EQUAL,
592 };
593 struct Mesh *BKE_mesh_merge_verts(struct Mesh *mesh,
594                                   const int *vtargetmap,
595                                   const int tot_vtargetmap,
596                                   const int merge_mode);
597
598 /* flush flags */
599 void BKE_mesh_flush_hidden_from_verts_ex(const struct MVert *mvert,
600                                          const struct MLoop *mloop,
601                                          struct MEdge *medge,
602                                          const int totedge,
603                                          struct MPoly *mpoly,
604                                          const int totpoly);
605 void BKE_mesh_flush_hidden_from_verts(struct Mesh *me);
606 void BKE_mesh_flush_hidden_from_polys_ex(struct MVert *mvert,
607                                          const struct MLoop *mloop,
608                                          struct MEdge *medge,
609                                          const int totedge,
610                                          const struct MPoly *mpoly,
611                                          const int totpoly);
612 void BKE_mesh_flush_hidden_from_polys(struct Mesh *me);
613 void BKE_mesh_flush_select_from_polys_ex(struct MVert *mvert,
614                                          const int totvert,
615                                          const struct MLoop *mloop,
616                                          struct MEdge *medge,
617                                          const int totedge,
618                                          const struct MPoly *mpoly,
619                                          const int totpoly);
620 void BKE_mesh_flush_select_from_polys(struct Mesh *me);
621 void BKE_mesh_flush_select_from_verts_ex(const struct MVert *mvert,
622                                          const int totvert,
623                                          const struct MLoop *mloop,
624                                          struct MEdge *medge,
625                                          const int totedge,
626                                          struct MPoly *mpoly,
627                                          const int totpoly);
628 void BKE_mesh_flush_select_from_verts(struct Mesh *me);
629
630 /* spatial evaluation */
631 void BKE_mesh_calc_relative_deform(const struct MPoly *mpoly,
632                                    const int totpoly,
633                                    const struct MLoop *mloop,
634                                    const int totvert,
635
636                                    const float (*vert_cos_src)[3],
637                                    const float (*vert_cos_dst)[3],
638
639                                    const float (*vert_cos_org)[3],
640                                    float (*vert_cos_new)[3]);
641
642 /* *** mesh_validate.c *** */
643
644 bool BKE_mesh_validate(struct Mesh *me, const bool do_verbose, const bool cddata_check_mask);
645 bool BKE_mesh_is_valid(struct Mesh *me);
646 bool BKE_mesh_validate_material_indices(struct Mesh *me);
647
648 bool BKE_mesh_validate_arrays(struct Mesh *me,
649                               struct MVert *mverts,
650                               unsigned int totvert,
651                               struct MEdge *medges,
652                               unsigned int totedge,
653                               struct MFace *mfaces,
654                               unsigned int totface,
655                               struct MLoop *mloops,
656                               unsigned int totloop,
657                               struct MPoly *mpolys,
658                               unsigned int totpoly,
659                               struct MDeformVert *dverts, /* assume totvert length */
660                               const bool do_verbose,
661                               const bool do_fixes,
662                               bool *r_change);
663
664 bool BKE_mesh_validate_all_customdata(struct CustomData *vdata,
665                                       const uint totvert,
666                                       struct CustomData *edata,
667                                       const uint totedge,
668                                       struct CustomData *ldata,
669                                       const uint totloop,
670                                       struct CustomData *pdata,
671                                       const uint totpoly,
672                                       const bool check_meshmask,
673                                       const bool do_verbose,
674                                       const bool do_fixes,
675                                       bool *r_change);
676
677 void BKE_mesh_strip_loose_faces(struct Mesh *me);
678 void BKE_mesh_strip_loose_polysloops(struct Mesh *me);
679 void BKE_mesh_strip_loose_edges(struct Mesh *me);
680
681 void BKE_mesh_calc_edges_legacy(struct Mesh *me, const bool use_old);
682 void BKE_mesh_calc_edges_loose(struct Mesh *mesh);
683 void BKE_mesh_calc_edges(struct Mesh *mesh, bool update, const bool select);
684 void BKE_mesh_calc_edges_tessface(struct Mesh *mesh);
685
686 /* **** Depsgraph evaluation **** */
687
688 void BKE_mesh_eval_geometry(struct Depsgraph *depsgraph, struct Mesh *mesh);
689
690 /* Draw Cache */
691 enum {
692   BKE_MESH_BATCH_DIRTY_ALL = 0,
693   BKE_MESH_BATCH_DIRTY_SELECT,
694   BKE_MESH_BATCH_DIRTY_SELECT_PAINT,
695   BKE_MESH_BATCH_DIRTY_SHADING,
696   BKE_MESH_BATCH_DIRTY_UVEDIT_ALL,
697   BKE_MESH_BATCH_DIRTY_UVEDIT_SELECT,
698 };
699 void BKE_mesh_batch_cache_dirty_tag(struct Mesh *me, int mode);
700 void BKE_mesh_batch_cache_free(struct Mesh *me);
701
702 extern void (*BKE_mesh_batch_cache_dirty_tag_cb)(struct Mesh *me, int mode);
703 extern void (*BKE_mesh_batch_cache_free_cb)(struct Mesh *me);
704
705 /* Inlines */
706
707 /* Instead of -1 that function uses ORIGINDEX_NONE as defined in BKE_customdata.h,
708  * but I don't want to force every user of BKE_mesh.h to also include that file.
709  * ~~ Sybren */
710 BLI_INLINE int BKE_mesh_origindex_mface_mpoly(const int *index_mf_to_mpoly,
711                                               const int *index_mp_to_orig,
712                                               const int i)
713 {
714   const int j = index_mf_to_mpoly[i];
715   return (j != -1) ? (index_mp_to_orig ? index_mp_to_orig[j] : j) : -1;
716 }
717
718 #ifdef __cplusplus
719 }
720 #endif
721
722 #endif /* __BKE_MESH_H__ */