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