code cleanup: lots of calls to BKE_mesh_calc_normals_mapping were not using the mappi...
[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 /***/
35
36 struct ID;
37 struct BoundBox;
38 struct DispList;
39 struct EdgeHash;
40 struct ListBase;
41 struct BMEditMesh;
42 struct BMesh;
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 MCol;
52 struct Object;
53 struct MTFace;
54 struct VecNor;
55 struct CustomData;
56 struct DerivedMesh;
57 struct Scene;
58 struct MLoopUV;
59 struct UvVertMap;
60 struct UvMapVert;
61 struct UvElementMap;
62 struct UvElement;
63 #ifdef __cplusplus
64 extern "C" {
65 #endif
66
67 struct BMesh *BKE_mesh_to_bmesh(struct Mesh *me, struct Object *ob);
68
69 /*
70  * this function recreates a tessellation.
71  * returns number of tessellation faces.
72  *
73  * use_poly_origindex sets whether or not the tessellation faces' origindex
74  * layer should point to original poly indices or real poly indices.
75  *
76  * use_face_origindex sets the tessellation faces' origindex layer
77  * to point to the tessellation faces themselves, not the polys.
78  *
79  * if both of the above are 0, it'll use the indices of the mpolys of the MPoly
80  * data in pdata, and ignore the origindex layer altogether.
81  */
82 int BKE_mesh_recalc_tessellation(struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
83                                  struct MVert *mvert,
84                                  int totface, int totloop, int totpoly,
85                                  const bool do_face_normals);
86
87 /* for forwards compat only quad->tri polys to mface, skip ngons.
88  */
89 int BKE_mesh_mpoly_to_mface(struct CustomData *fdata, struct CustomData *ldata,
90                             struct CustomData *pdata, int totface, int totloop, int totpoly);
91
92 /*calculates a face normal.*/
93 void BKE_mesh_calc_poly_normal(struct MPoly *mpoly, struct MLoop *loopstart,
94                                struct MVert *mvarray, float no[3]);
95
96 void BKE_mesh_calc_poly_normal_coords(struct MPoly *mpoly, struct MLoop *loopstart,
97                                       const float (*vertex_coords)[3], float no[3]);
98
99 void BKE_mesh_calc_poly_center(struct MPoly *mpoly, struct MLoop *loopstart,
100                                struct MVert *mvarray, float cent[3]);
101
102 float BKE_mesh_calc_poly_area(struct MPoly *mpoly, struct MLoop *loopstart,
103                               struct MVert *mvarray, const float polynormal[3]);
104
105 void BKE_mesh_calc_poly_angles(struct MPoly *mpoly, struct MLoop *loopstart,
106                                struct MVert *mvarray, float angles[]);
107
108 void BKE_mesh_calc_relative_deform(
109         const struct MPoly *mpoly, const int totpoly,
110         const struct MLoop *mloop, const int totvert,
111
112         const float (*vert_cos_src)[3],
113         const float (*vert_cos_dst)[3],
114
115         const float (*vert_cos_org)[3],
116               float (*vert_cos_new)[3]);
117
118 /* Find the index of the loop in 'poly' which references vertex,
119  * returns -1 if not found */
120 int poly_find_loop_from_vert(const struct MPoly *poly,
121                              const struct MLoop *loopstart,
122                              unsigned vert);
123
124 /* Fill 'adj_r' with the loop indices in 'poly' adjacent to the
125  * vertex. Returns the index of the loop matching vertex, or -1 if the
126  * vertex is not in 'poly' */
127 int poly_get_adj_loops_from_vert(unsigned adj_r[3], const struct MPoly *poly,
128                                  const struct MLoop *mloop, unsigned vert);
129
130 /* Return the index of the edge vert that is not equal to 'v'. If
131  * neither edge vertex is equal to 'v', returns -1. */
132 int BKE_mesh_edge_other_vert(const struct MEdge *e, int v);
133
134 /* update the hide flag for edges and polys from the corresponding
135  * flag in verts */
136 void BKE_mesh_flush_hidden_from_verts(const struct MVert *mvert,
137                                       const struct MLoop *mloop,
138                                       struct MEdge *medge, int totedge,
139                                       struct MPoly *mpoly, int totpoly);
140
141 void BKE_mesh_flush_select_from_polys_ex(struct MVert *mvert,       const int totvert,
142                                          struct MLoop *mloop,
143                                          struct MEdge *medge,       const int totedge,
144                                          const struct MPoly *mpoly, const int totpoly);
145 void BKE_mesh_flush_select_from_polys(struct Mesh *me);
146 void BKE_mesh_flush_select_from_verts_ex(const struct MVert *mvert, const int totvert,
147                                          struct MLoop *mloop,
148                                          struct MEdge *medge,       const int totedge,
149                                          struct MPoly *mpoly,       const int totpoly);
150 void BKE_mesh_flush_select_from_verts(struct Mesh *me);
151
152 void BKE_mesh_unlink(struct Mesh *me);
153 void BKE_mesh_free(struct Mesh *me, int unlink);
154 struct Mesh *BKE_mesh_add(struct Main *bmain, const char *name);
155 struct Mesh *BKE_mesh_copy_ex(struct Main *bmain, struct Mesh *me);
156 struct Mesh *BKE_mesh_copy(struct Mesh *me);
157 void BKE_mesh_update_customdata_pointers(struct Mesh *me, const bool do_ensure_tess_cd);
158
159 void BKE_mesh_make_local(struct Mesh *me);
160 void BKE_mesh_boundbox_calc(struct Mesh *me, float r_loc[3], float r_size[3]);
161 void BKE_mesh_texspace_calc(struct Mesh *me);
162 float (*BKE_mesh_orco_verts_get(struct Object *ob))[3];
163 void   BKE_mesh_orco_verts_transform(struct Mesh *me, float (*orco)[3], int totvert, int invert);
164 int test_index_face(struct MFace *mface, struct CustomData *mfdata, int mfindex, int nr);
165 struct Mesh *BKE_mesh_from_object(struct Object *ob);
166 void BKE_mesh_assign_object(struct Object *ob, struct Mesh *me);
167 void BKE_mesh_from_metaball(struct ListBase *lb, struct Mesh *me);
168 int  BKE_mesh_nurbs_to_mdata(struct Object *ob, struct MVert **allvert, int *totvert,
169                              struct MEdge **alledge, int *totedge, struct MLoop **allloop, struct MPoly **allpoly,
170                              int *totloop, int *totpoly);
171 int BKE_mesh_nurbs_displist_to_mdata(struct Object *ob, struct ListBase *dispbase, struct MVert **allvert, int *_totvert,
172                                      struct MEdge **alledge, int *_totedge, struct MLoop **allloop, struct MPoly **allpoly,
173                                      struct MLoopUV **alluv, int *_totloop, int *_totpoly);
174 void BKE_mesh_from_nurbs_displist(struct Object *ob, struct ListBase *dispbase, const bool use_orco_uv);
175 void BKE_mesh_from_nurbs(struct Object *ob);
176 void BKE_mesh_to_curve_nurblist(struct DerivedMesh *dm, struct ListBase *nurblist, const int edge_users_test);
177 void BKE_mesh_to_curve(struct Scene *scene, struct Object *ob);
178 void BKE_mesh_delete_material_index(struct Mesh *me, short index);
179 void BKE_mesh_smooth_flag_set(struct Object *meshOb, int enableSmooth);
180 void BKE_mesh_convert_mfaces_to_mpolys(struct Mesh *mesh);
181 void BKE_mesh_do_versions_convert_mfaces_to_mpolys(struct Mesh *mesh);
182 void BKE_mesh_convert_mfaces_to_mpolys_ex(struct ID *id,
183                                           struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
184                                           int totedge_i, int totface_i, int totloop_i, int totpoly_i,
185                                           struct MEdge *medge, struct MFace *mface,
186                                           int *totloop_r, int *totpoly_r,
187                                           struct MLoop **mloop_r, struct MPoly **mpoly_r);
188
189 void BKE_mesh_calc_normals_tessface(struct MVert *mverts, int numVerts, struct MFace *mfaces, int numFaces, float (*faceNors_r)[3]);
190
191 /* used for unit testing; compares two meshes, checking only
192  * differences we care about.  should be usable with leaf's
193  * testing framework I get RNA work done, will use hackish
194  * testing code for now.*/
195 const char *BKE_mesh_cmp(struct Mesh *me1, struct Mesh *me2, float thresh);
196
197 struct BoundBox *BKE_mesh_boundbox_get(struct Object *ob);
198 void BKE_mesh_texspace_get(struct Mesh *me, float r_loc[3], float r_rot[3], float r_size[3]);
199
200 /* if old, it converts mface->edcode to edge drawflags */
201 void BKE_mesh_make_edges(struct Mesh *me, int old);
202
203 void BKE_mesh_strip_loose_faces(struct Mesh *me); /* Needed for compatibility (some old read code). */
204 void BKE_mesh_strip_loose_polysloops(struct Mesh *me);
205 void BKE_mesh_strip_loose_edges(struct Mesh *me);
206
207 /* Calculate vertex and face normals, face normals are returned in *faceNors_r if non-NULL
208  * and vertex normals are stored in actual mverts.
209  */
210 void BKE_mesh_calc_normals_mapping(
211         struct MVert *mverts, int numVerts,
212         struct MLoop *mloop, struct MPoly *mpolys, int numLoops, int numPolys, float (*polyNors_r)[3],
213         struct MFace *mfaces, int numFaces, int *origIndexFace, float (*faceNors_r)[3]);
214 /* extended version of 'BKE_mesh_calc_normals_poly' with option not to calc vertex normals */
215 void BKE_mesh_calc_normals_mapping_ex(
216         struct MVert *mverts, int numVerts,
217         struct MLoop *mloop, struct MPoly *mpolys, int numLoops, int numPolys, float (*polyNors_r)[3],
218         struct MFace *mfaces, int numFaces, int *origIndexFace, float (*faceNors_r)[3],
219         const bool only_face_normals);
220
221 void BKE_mesh_calc_normals_poly(
222         struct MVert *mverts, int numVerts,
223         struct MLoop *mloop, struct MPoly *mpolys,
224         int numLoops, int numPolys, float (*polyNors_r)[3]);
225
226 void BKE_mesh_calc_normals(struct Mesh *me);
227
228 /* Return a newly MEM_malloc'd array of all the mesh vertex locations
229  * (_numVerts_r_ may be NULL) */
230 float (*BKE_mesh_vertexCos_get(struct Mesh *me, int *r_numVerts))[3];
231
232 /* map from uv vertex to face (for select linked, stitch, uv suburf) */
233
234 /* UvVertMap */
235
236 #define STD_UV_CONNECT_LIMIT  0.0001f
237
238 typedef struct UvVertMap {
239         struct UvMapVert **vert;
240         struct UvMapVert *buf;
241 } UvVertMap;
242
243 typedef struct UvMapVert {
244         struct UvMapVert *next;
245         unsigned int f;
246         unsigned char tfindex, separate, flag;
247 } UvMapVert;
248
249 /* UvElement stores per uv information so that we can quickly access information for a uv.
250  * it is actually an improved UvMapVert, including an island and a direct pointer to the face
251  * to avoid initializing face arrays */
252 typedef struct UvElement {
253         /* Next UvElement corresponding to same vertex */
254         struct UvElement *next;
255         /* Face the element belongs to */
256         struct BMLoop *l;
257         /* index in loop. */
258         unsigned short tfindex;
259         /* Whether this element is the first of coincident elements */
260         unsigned char separate;
261         /* general use flag */
262         unsigned char flag;
263         /* If generating element map with island sorting, this stores the island index */
264         unsigned short island;
265 } UvElement;
266
267
268 /* UvElementMap is a container for UvElements of a mesh. It stores some UvElements belonging to the
269  * same uv island in sequence and the number of uvs per island so it is possible to access all uvs
270  * belonging to an island directly by iterating through the buffer.
271  */
272 typedef struct UvElementMap {
273         /* address UvElements by their vertex */
274         struct UvElement **vert;
275         /* UvElement Store */
276         struct UvElement *buf;
277         /* Total number of UVs in the layer. Useful to know */
278         int totalUVs;
279         /* Number of Islands in the mesh */
280         int totalIslands;
281         /* Stores the starting index in buf where each island begins */
282         int *islandIndices;
283 } UvElementMap;
284
285 /* invalid island index is max short. If any one has the patience
286  * to make that many islands, he can bite me :p */
287 #define INVALID_ISLAND 0xFFFF
288
289 UvVertMap *BKE_mesh_uv_vert_map_create(struct MPoly *mpoly, struct MLoop *mloop, struct MLoopUV *mloopuv,
290                                      unsigned int totpoly, unsigned int totvert, int selected, float *limit);
291 UvMapVert *BKE_mesh_uv_vert_map_get_vert(UvVertMap *vmap, unsigned int v);
292 void       BKE_mesh_uv_vert_map_free(UvVertMap *vmap);
293
294 /* Connectivity data */
295 typedef struct MeshElemMap {
296         int *indices;
297         int count;
298 } MeshElemMap;
299         
300 typedef struct IndexNode {
301         struct IndexNode *next, *prev;
302         int index;
303 } IndexNode;
304
305 void BKE_mesh_vert_poly_map_create(MeshElemMap **map, int **mem,
306                                    const struct MPoly *mface, const struct MLoop *mloop,
307                                    int totvert, int totface, int totloop);
308
309 void BKE_mesh_vert_edge_map_create(MeshElemMap **map, int **mem,
310                                    const struct MEdge *medge, int totvert, int totedge);
311
312 /* vertex level transformations & checks (no derived mesh) */
313
314 int BKE_mesh_minmax(struct Mesh *me, float r_min[3], float r_max[3]);
315 int BKE_mesh_center_median(struct Mesh *me, float cent[3]);
316 int BKE_mesh_center_bounds(struct Mesh *me, float cent[3]);
317 int BKE_mesh_center_centroid(struct Mesh *me, float cent[3]);
318 void BKE_mesh_translate(struct Mesh *me, const float offset[3], const bool do_keys);
319
320 /* mesh_validate.c */
321 /* XXX Loop v/e are unsigned, so using max uint_32 value as invalid marker... */
322 #define INVALID_LOOP_EDGE_MARKER 4294967295u
323 int BKE_mesh_validate_arrays(
324         struct Mesh *me,
325         struct MVert *mverts, unsigned int totvert,
326         struct MEdge *medges, unsigned int totedge,
327         struct MFace *mfaces, unsigned int totface,
328         struct MLoop *mloops, unsigned int totloop,
329         struct MPoly *mpolys, unsigned int totpoly,
330         struct MDeformVert *dverts, /* assume totvert length */
331         const bool do_verbose, const bool do_fixes);
332 int BKE_mesh_validate(struct Mesh *me, const int do_verbose);
333 int BKE_mesh_validate_dm(struct DerivedMesh *dm);
334
335 void BKE_mesh_calc_edges(struct Mesh *mesh, bool update, const bool select);
336
337 void BKE_mesh_ensure_navmesh(struct Mesh *me);
338
339 void BKE_mesh_tessface_calc(struct Mesh *mesh);
340 void BKE_mesh_tessface_ensure(struct Mesh *mesh);
341 void BKE_mesh_tessface_clear(struct Mesh *mesh);
342
343 /* Convert a triangle or quadrangle of loop/poly data to tessface data */
344 void BKE_mesh_loops_to_mface_corners(struct CustomData *fdata, struct CustomData *ldata,
345                                      struct CustomData *pdata, int lindex[4], int findex,
346                                      const int polyindex, const int mf_len,
347                                      const int numTex, const int numCol, const int hasPCol, const int hasOrigSpace);
348
349 void BKE_mesh_poly_edgehash_insert(struct EdgeHash *ehash, const struct MPoly *mp, const struct MLoop *mloop);
350
351 void BKE_mesh_do_versions_cd_flag_init(struct Mesh *mesh);
352
353 #ifdef __cplusplus
354 }
355 #endif
356
357 #endif /* __BKE_MESH_H__ */