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