=bmesh= merge from trunk at r36529
[blender.git] / source / blender / blenkernel / BKE_mesh.h
1 /*
2  * blenlib/BKE_mesh.h (mar-2001 nzc)
3  *      
4  * $Id$ 
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31 #ifndef BKE_MESH_H
32 #define BKE_MESH_H
33
34 /** \file BKE_mesh.h
35  *  \ingroup bke
36  */
37
38 /***/
39
40 struct BoundBox;
41 struct DispList;
42 struct ListBase;
43 struct BMEditMesh;
44 struct BMesh;
45 struct Mesh;
46 struct MPoly;
47 struct MLoop;
48 struct MFace;
49 struct MEdge;
50 struct MVert;
51 struct MDeformVert;
52 struct MCol;
53 struct Object;
54 struct MTFace;
55 struct VecNor;
56 struct CustomData;
57 struct DerivedMesh;
58 struct Scene;
59
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 tesselation.
68   returns number of tesselation faces.
69
70   use_poly_origindex sets whether or not the tesselation faces' origindex
71   layer should point to original poly indices or real poly indices.
72
73   use_face_origindex sets the tesselation faces' origindex layer
74   to point to the tesselation 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 mesh_recalcTesselation(struct CustomData *fdata, struct CustomData *ldata, 
80         struct CustomData *pdata, struct MVert *mvert, int totface, 
81         int totloop, int totpoly, int use_poly_origindex, int use_face_origindex);
82
83 /*calculates a face normal.*/
84 void mesh_calc_poly_normal(struct MPoly *mpoly, struct MLoop *loopstart, 
85                            struct MVert *mvarray, float *no);
86
87 void unlink_mesh(struct Mesh *me);
88 void free_mesh(struct Mesh *me, int unlink);
89 struct Mesh *add_mesh(const char *name);
90 struct Mesh *copy_mesh(struct Mesh *me);
91 void mesh_update_customdata_pointers(struct Mesh *me);
92
93 void make_local_mesh(struct Mesh *me);
94 void boundbox_mesh(struct Mesh *me, float *loc, float *size);
95 void tex_space_mesh(struct Mesh *me);
96 float *get_mesh_orco_verts(struct Object *ob);
97 void transform_mesh_orco_verts(struct Mesh *me, float (*orco)[3], int totvert, int invert);
98 int test_index_face(struct MFace *mface, struct CustomData *mfdata, int mfindex, int nr);
99 struct Mesh *get_mesh(struct Object *ob);
100 void set_mesh(struct Object *ob, struct Mesh *me);
101 void mball_to_mesh(struct ListBase *lb, struct Mesh *me);
102 int nurbs_to_mdata(struct Object *ob, struct MVert **allvert, int *totvert,
103         struct MEdge **alledge, int *totedge, struct MFace **allface, struct MLoop **allloop, struct MPoly **allpoly, 
104         int *totface, int *totloop, int *totpoly);
105 int nurbs_to_mdata_customdb(struct Object *ob, struct ListBase *dispbase, struct MVert **allvert, int *_totvert,
106         struct MEdge **alledge, int *_totedge, struct MFace **allface, struct MLoop **allloop, struct MPoly **allpoly, 
107         int *_totface, int *_totloop, int *_totpoly);
108 void nurbs_to_mesh(struct Object *ob);
109 void mesh_to_curve(struct Scene *scene, struct Object *ob);
110 void free_dverts(struct MDeformVert *dvert, int totvert);
111 void copy_dverts(struct MDeformVert *dst, struct MDeformVert *src, int totvert); /* __NLA */
112 void mesh_delete_material_index(struct Mesh *me, int index);
113 void mesh_set_smooth_flag(struct Object *meshOb, int enableSmooth);
114 void convert_mfaces_to_mpolys(struct Mesh *mesh);
115 void mesh_calc_tessface_normals(struct MVert *mverts, int numVerts,struct  MFace *mfaces, int numFaces, float (*faceNors_r)[3]);
116
117 /*used for unit testing; compares two meshes, checking only
118   differences we care about.  should be usable with leaf's
119   testing framework I get RNA work done, will use hackish
120   testing code for now.*/
121 char *mesh_cmp(struct Mesh *me1, struct Mesh *me2, float thresh);
122
123 struct BoundBox *mesh_get_bb(struct Object *ob);
124 void mesh_get_texspace(struct Mesh *me, float *loc_r, float *rot_r, float *size_r);
125
126 /* if old, it converts mface->edcode to edge drawflags */
127 void make_edges(struct Mesh *me, int old);
128
129 void mesh_strip_loose_faces(struct Mesh *me);
130 void mesh_strip_loose_edges(struct Mesh *me);
131
132         /* Calculate vertex and face normals, face normals are returned in *faceNors_r if non-NULL
133          * and vertex normals are stored in actual mverts.
134          */
135 void mesh_calc_normals(struct MVert *mverts, int numVerts, struct MLoop *mloop, 
136         struct MPoly *mpolys, int numLoops, int numPolys, float (*polyNors_r)[3], 
137         struct MFace *mfaces, int numFaces, int *origIndexFace, float (*faceNors_r)[3]);
138
139         /* Return a newly MEM_malloc'd array of all the mesh vertex locations
140          * (_numVerts_r_ may be NULL) */
141 float (*mesh_getVertexCos(struct Mesh *me, int *numVerts_r))[3];
142
143 /* map from uv vertex to face (for select linked, stitch, uv suburf) */
144
145 /* UvVertMap */
146
147 #define STD_UV_CONNECT_LIMIT    0.0001f
148
149 typedef struct UvVertMap {
150         struct UvMapVert **vert;
151         struct UvMapVert *buf;
152 } UvVertMap;
153
154 typedef struct UvMapVert {
155         struct UvMapVert *next;
156         unsigned int f;
157         unsigned char tfindex, separate, flag;
158 } UvMapVert;
159
160 UvVertMap *make_uv_vert_map(struct MFace *mface, struct MTFace *tface, unsigned int totface, unsigned int totvert, int selected, float *limit);
161 UvMapVert *get_uv_map_vert(UvVertMap *vmap, unsigned int v);
162 void free_uv_vert_map(UvVertMap *vmap);
163
164 /* Connectivity data */
165 typedef struct IndexNode {
166         struct IndexNode *next, *prev;
167         int index;
168 } IndexNode;
169 void create_vert_face_map(ListBase **map, IndexNode **mem, const struct MFace *mface,
170                           const int totvert, const int totface);
171 void create_vert_edge_map(ListBase **map, IndexNode **mem, const struct MEdge *medge,
172                           const int totvert, const int totedge);
173
174 /* Partial Mesh Visibility */
175 struct PartialVisibility *mesh_pmv_copy(struct PartialVisibility *);
176 void mesh_pmv_free(struct PartialVisibility *);
177 void mesh_pmv_revert(struct Mesh *me);
178 void mesh_pmv_off(struct Mesh *me);
179
180 /* functions for making menu's from customdata layers */
181 int mesh_layers_menu_charlen(struct CustomData *data, int type); /* use this to work out how many chars to allocate */
182 void mesh_layers_menu_concat(struct CustomData *data, int type, char *str);
183 int mesh_layers_menu(struct CustomData *data, int type);
184
185 /* vertex level transformations & checks (no derived mesh) */
186
187 int minmax_mesh(struct Mesh *me, float min[3], float max[3]);
188 int mesh_center_median(struct Mesh *me, float cent[3]);
189 int mesh_center_bounds(struct Mesh *me, float cent[3]);
190 void mesh_translate(struct Mesh *me, float offset[3], int do_keys);
191
192 /* mesh_validate.c */
193 int BKE_mesh_validate_arrays(struct Mesh *me, struct MVert *mverts, unsigned int totvert, struct MEdge *medges, unsigned int totedge, struct MFace *mfaces, unsigned int totface, const short do_verbose, const short do_fixes);
194 int BKE_mesh_validate(struct Mesh *me, int do_verbose);
195 int BKE_mesh_validate_dm(struct DerivedMesh *dm);
196
197 void BKE_mesh_calc_edges(struct Mesh *mesh, int update);
198
199 /*convert a triangle of loop facedata to mface facedata*/
200 void mesh_loops_to_tri_corners(struct CustomData *fdata, struct CustomData *ldata, 
201                            struct CustomData *pdata, int lindex[3], int findex, 
202                            int polyindex);
203
204 #ifdef __cplusplus
205 }
206 #endif
207
208 #endif /* BKE_MESH_H */