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