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