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