Add helper to validate (and fix) material indices of meshes' polygons, curves' spline...
[blender-staging.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 DispList;
37 struct EdgeHash;
38 struct ListBase;
39 struct BMEditMesh;
40 struct BMesh;
41 struct Main;
42 struct Mesh;
43 struct MPoly;
44 struct MLoop;
45 struct MFace;
46 struct MEdge;
47 struct MVert;
48 struct MDeformVert;
49 struct MCol;
50 struct Object;
51 struct MTFace;
52 struct VecNor;
53 struct CustomData;
54 struct DerivedMesh;
55 struct Scene;
56 struct MLoopUV;
57 struct UvVertMap;
58 struct UvMapVert;
59 struct UvElementMap;
60 struct UvElement;
61 struct ReportList;
62
63 #ifdef __cplusplus
64 extern "C" {
65 #endif
66
67 /* setting zero so we can catch bugs in OpenMP/BMesh */
68 #ifdef DEBUG
69 #  define BKE_MESH_OMP_LIMIT 0
70 #else
71 #  define BKE_MESH_OMP_LIMIT 10000
72 #endif
73
74 /* *** mesh.c *** */
75
76 struct BMesh *BKE_mesh_to_bmesh(struct Mesh *me, struct Object *ob);
77
78 int poly_find_loop_from_vert(const struct MPoly *poly,
79                              const struct MLoop *loopstart,
80                              unsigned vert);
81
82 int poly_get_adj_loops_from_vert(unsigned r_adj[3], const struct MPoly *poly,
83                                  const struct MLoop *mloop, unsigned vert);
84
85 int BKE_mesh_edge_other_vert(const struct MEdge *e, int v);
86
87 void BKE_mesh_unlink(struct Mesh *me);
88 void BKE_mesh_free(struct Mesh *me, int unlink);
89 struct Mesh *BKE_mesh_add(struct Main *bmain, const char *name);
90 struct Mesh *BKE_mesh_copy_ex(struct Main *bmain, struct Mesh *me);
91 struct Mesh *BKE_mesh_copy(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 Mesh *me);
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 Object *ob, struct Mesh *me);
103 void BKE_mesh_from_metaball(struct ListBase *lb, struct Mesh *me);
104 int  BKE_mesh_nurbs_to_mdata(struct Object *ob, struct MVert **allvert, int *totvert,
105                              struct MEdge **alledge, int *totedge, struct MLoop **allloop, struct MPoly **allpoly,
106                              int *totloop, int *totpoly);
107 int BKE_mesh_nurbs_displist_to_mdata(struct Object *ob, struct ListBase *dispbase, struct MVert **allvert, int *_totvert,
108                                      struct MEdge **alledge, int *_totedge, struct MLoop **allloop, struct MPoly **allpoly,
109                                      struct MLoopUV **alluv, int *_totloop, int *_totpoly);
110 void BKE_mesh_from_nurbs_displist(struct Object *ob, struct ListBase *dispbase, const bool use_orco_uv);
111 void BKE_mesh_from_nurbs(struct Object *ob);
112 void BKE_mesh_to_curve_nurblist(struct DerivedMesh *dm, struct ListBase *nurblist, const int edge_users_test);
113 void BKE_mesh_to_curve(struct Scene *scene, struct Object *ob);
114 void BKE_mesh_material_index_remove(struct Mesh *me, short index);
115 void BKE_mesh_material_index_clear(struct Mesh *me);
116 void BKE_mesh_smooth_flag_set(struct Object *meshOb, int enableSmooth);
117
118 const char *BKE_mesh_cmp(struct Mesh *me1, struct Mesh *me2, float thresh);
119
120 struct BoundBox *BKE_mesh_boundbox_get(struct Object *ob);
121 void BKE_mesh_texspace_get(struct Mesh *me, float r_loc[3], float r_rot[3], float r_size[3]);
122 void BKE_mesh_texspace_copy_from_object(struct Mesh *me, struct Object *ob);
123
124 bool BKE_mesh_uv_cdlayer_rename_index(struct Mesh *me, const int poly_index, const int loop_index, const int face_index,
125                                       const char *new_name, const bool do_tessface);
126 bool BKE_mesh_uv_cdlayer_rename(struct Mesh *me, const char *old_name, const char *new_name, bool do_tessface);
127
128 float (*BKE_mesh_vertexCos_get(struct Mesh *me, int *r_numVerts))[3];
129
130 struct Mesh *BKE_mesh_new_from_object(struct Main *bmain, struct Scene *sce, struct Object *ob,
131                                       int apply_modifiers, int settings, int calc_tessface, int calc_undeformed);
132
133 /* vertex level transformations & checks (no derived mesh) */
134
135 bool BKE_mesh_minmax(struct Mesh *me, float r_min[3], float r_max[3]);
136 void BKE_mesh_translate(struct Mesh *me, const float offset[3], const bool do_keys);
137
138 void BKE_mesh_ensure_navmesh(struct Mesh *me);
139
140 void BKE_mesh_tessface_calc(struct Mesh *mesh);
141 void BKE_mesh_tessface_ensure(struct Mesh *mesh);
142 void BKE_mesh_tessface_clear(struct Mesh *mesh);
143
144 void BKE_mesh_do_versions_cd_flag_init(struct Mesh *mesh);
145
146
147 void BKE_mesh_mselect_clear(struct Mesh *me);
148 void BKE_mesh_mselect_validate(struct Mesh *me);
149 int  BKE_mesh_mselect_find(struct Mesh *me, int index, int type);
150 int  BKE_mesh_mselect_active_get(struct Mesh *me, int type);
151 void BKE_mesh_mselect_active_set(struct Mesh *me, int index, int type);
152
153
154
155 /* *** mesh_evaluate.c *** */
156
157 void BKE_mesh_calc_normals_mapping(
158         struct MVert *mverts, int numVerts,
159         struct MLoop *mloop, struct MPoly *mpolys, int numLoops, int numPolys, float (*r_polyNors)[3],
160         struct MFace *mfaces, int numFaces, const int *origIndexFace, float (*r_faceNors)[3]);
161 void BKE_mesh_calc_normals_mapping_ex(
162         struct MVert *mverts, int numVerts,
163         struct MLoop *mloop, struct MPoly *mpolys, int numLoops, int numPolys, float (*r_polyNors)[3],
164         struct MFace *mfaces, int numFaces, const int *origIndexFace, float (*r_faceNors)[3],
165         const bool only_face_normals);
166 void BKE_mesh_calc_normals_poly(
167         struct MVert *mverts, int numVerts,
168         struct MLoop *mloop, struct MPoly *mpolys,
169         int numLoops, int numPolys, float (*r_polyNors)[3],
170         const bool only_face_normals);
171 void BKE_mesh_calc_normals(struct Mesh *me);
172 void BKE_mesh_calc_normals_tessface(
173         struct MVert *mverts, int numVerts,
174         struct MFace *mfaces, int numFaces,
175         float (*r_faceNors)[3]);
176 void BKE_mesh_normals_loop_split(
177         struct MVert *mverts, const int numVerts, struct MEdge *medges, const int numEdges,
178         struct MLoop *mloops, float (*r_loopnors)[3], const int numLoops,
179         struct MPoly *mpolys, float (*polynors)[3], const int numPolys, float split_angle);
180 void BKE_mesh_loop_tangents_ex(
181         struct MVert *mverts, const int numVerts, struct MLoop *mloops, float (*r_looptangent)[4], float (*loopnors)[3],
182         struct MLoopUV *loopuv, const int numLoops, struct MPoly *mpolys, const int numPolys,
183         struct ReportList *reports);
184 void BKE_mesh_loop_tangents(
185         struct Mesh *mesh, const char *uvmap, float (*r_looptangents)[4], struct ReportList *reports);
186
187 void BKE_mesh_calc_poly_normal(
188         struct MPoly *mpoly, struct MLoop *loopstart,
189         struct MVert *mvarray, float no[3]);
190 void BKE_mesh_calc_poly_normal_coords(
191         struct MPoly *mpoly, struct MLoop *loopstart,
192         const float (*vertex_coords)[3], float no[3]);
193 void BKE_mesh_calc_poly_center(
194         struct MPoly *mpoly, struct MLoop *loopstart,
195         struct MVert *mvarray, float cent[3]);
196 float BKE_mesh_calc_poly_area(
197         struct MPoly *mpoly, struct MLoop *loopstart,
198         struct MVert *mvarray);
199 void BKE_mesh_calc_poly_angles(
200         struct MPoly *mpoly, struct MLoop *loopstart,
201         struct MVert *mvarray, float angles[]);
202
203 void BKE_mesh_poly_edgehash_insert(
204         struct EdgeHash *ehash,
205         const struct MPoly *mp, const struct MLoop *mloop);
206 void BKE_mesh_poly_edgebitmap_insert(
207         unsigned int *edge_bitmap,
208         const struct MPoly *mp, const struct MLoop *mloop);
209
210
211 bool BKE_mesh_center_median(struct Mesh *me, float cent[3]);
212 bool BKE_mesh_center_bounds(struct Mesh *me, float cent[3]);
213 bool BKE_mesh_center_centroid(struct Mesh *me, float cent[3]);
214
215 void BKE_mesh_calc_volume(struct MVert *mverts, int numVerts,
216                           struct MFace *mfaces, int numFaces,
217                           float *r_vol, float *r_com);
218
219 /* tessface */
220 void BKE_mesh_loops_to_mface_corners(
221         struct CustomData *fdata, struct CustomData *ldata,
222         struct CustomData *pdata, unsigned int lindex[4], int findex,
223         const int polyindex, const int mf_len,
224         const int numTex, const int numCol,
225         const bool hasPCol, const bool hasOrigSpace, const bool hasLNor);
226 void BKE_mesh_loops_to_tessdata(
227         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata, struct MFace *mface,
228         int *polyindices, unsigned int (*loopindices)[4], const int num_faces);
229 int BKE_mesh_recalc_tessellation(
230         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
231         struct MVert *mvert,
232         int totface, int totloop, int totpoly,
233         const bool do_face_normals);
234 int BKE_mesh_mpoly_to_mface(
235         struct CustomData *fdata, struct CustomData *ldata,
236         struct CustomData *pdata, int totface, int totloop, int totpoly);
237 void BKE_mesh_convert_mfaces_to_mpolys(struct Mesh *mesh);
238 void BKE_mesh_do_versions_convert_mfaces_to_mpolys(struct Mesh *mesh);
239 void BKE_mesh_convert_mfaces_to_mpolys_ex(
240         struct ID *id,
241         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
242         int totedge_i, int totface_i, int totloop_i, int totpoly_i,
243         struct MEdge *medge, struct MFace *mface,
244         int *r_totloop, int *r_totpoly,
245         struct MLoop **r_mloop, struct MPoly **r_mpoly);
246
247 /* flush flags */
248 void BKE_mesh_flush_hidden_from_verts_ex(
249         const struct MVert *mvert,
250         const struct MLoop *mloop,
251         struct MEdge *medge, const int totedge,
252         struct MPoly *mpoly, const int totpoly);
253 void BKE_mesh_flush_hidden_from_verts(struct Mesh *me);
254 void BKE_mesh_flush_hidden_from_polys_ex(
255         struct MVert *mvert,
256         const struct MLoop *mloop,
257         struct MEdge *medge, const int totedge,
258         const struct MPoly *mpoly, const int totpoly);
259 void BKE_mesh_flush_hidden_from_polys(struct Mesh *me);
260 void BKE_mesh_flush_select_from_polys_ex(
261         struct MVert *mvert,       const int totvert,
262         const struct MLoop *mloop,
263         struct MEdge *medge,       const int totedge,
264         const struct MPoly *mpoly, const int totpoly);
265 void BKE_mesh_flush_select_from_polys(struct Mesh *me);
266 void BKE_mesh_flush_select_from_verts_ex(
267         const struct MVert *mvert, const int totvert,
268         const struct MLoop *mloop,
269         struct MEdge *medge,       const int totedge,
270         struct MPoly *mpoly,       const int totpoly);
271 void BKE_mesh_flush_select_from_verts(struct Mesh *me);
272
273 /* spatial evaluation */
274 void BKE_mesh_calc_relative_deform(
275         const struct MPoly *mpoly, const int totpoly,
276         const struct MLoop *mloop, const int totvert,
277
278         const float (*vert_cos_src)[3],
279         const float (*vert_cos_dst)[3],
280
281         const float (*vert_cos_org)[3],
282               float (*vert_cos_new)[3]);
283
284
285
286 /* *** mesh_validate.c *** */
287
288 int BKE_mesh_validate(struct Mesh *me, const int do_verbose);
289 void BKE_mesh_cd_validate(struct Mesh *me);
290 int BKE_mesh_validate_material_indices(struct Mesh *me);
291
292 bool BKE_mesh_validate_arrays(
293         struct Mesh *me,
294         struct MVert *mverts, unsigned int totvert,
295         struct MEdge *medges, unsigned int totedge,
296         struct MFace *mfaces, unsigned int totface,
297         struct MLoop *mloops, unsigned int totloop,
298         struct MPoly *mpolys, unsigned int totpoly,
299         struct MDeformVert *dverts, /* assume totvert length */
300         const bool do_verbose, const bool do_fixes,
301         bool *r_change);
302
303 bool BKE_mesh_validate_all_customdata(
304         struct CustomData *vdata, struct CustomData *edata,
305         struct CustomData *ldata, struct CustomData *pdata,
306         const bool check_meshmask,
307         const bool do_verbose, const bool do_fixes,
308         bool *r_change);
309
310 void BKE_mesh_strip_loose_faces(struct Mesh *me);
311 void BKE_mesh_strip_loose_polysloops(struct Mesh *me);
312 void BKE_mesh_strip_loose_edges(struct Mesh *me);
313
314 void BKE_mesh_calc_edges_legacy(struct Mesh *me, const bool use_old);
315 void BKE_mesh_calc_edges(struct Mesh *mesh, bool update, const bool select);
316
317 #ifdef __cplusplus
318 }
319 #endif
320
321 #endif /* __BKE_MESH_H__ */