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