Quiet annoying warning:
[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
57 #ifdef __cplusplus
58 extern "C" {
59 #endif
60
61 struct BMesh *BKE_mesh_to_bmesh(struct Mesh *me, struct Object *ob);
62
63 /*
64   this function recreates a tesselation.
65   returns number of tesselation faces.
66
67   use_poly_origindex sets whether or not the tesselation faces' origindex
68   layer should point to original poly indices or real poly indices.
69
70   use_face_origindex sets the tesselation faces' origindex layer
71   to point to the tesselation faces themselves, not the polys.
72
73   if both of the above are 0, it'll use the indices of the mpolys of the MPoly
74   data in pdata, and ignore the origindex layer altogether.
75  */
76 int mesh_recalcTesselation(struct CustomData *fdata, struct CustomData *ldata, 
77         struct CustomData *pdata, struct MVert *mvert, int totface, 
78         int totloop, int totpoly);
79
80 /*calculates a face normal.*/
81 void mesh_calc_poly_normal(struct MPoly *mpoly, struct MLoop *loopstart, 
82                            struct MVert *mvarray, float no[3]);
83
84 void mesh_calc_poly_center(struct MPoly *mpoly, struct MLoop *loopstart,
85                            struct MVert *mvarray, float cent[3]);
86
87 float mesh_calc_poly_area(struct MPoly *mpoly, struct MLoop *loopstart,
88                           struct MVert *mvarray, float polynormal[3]);
89
90 void unlink_mesh(struct Mesh *me);
91 void free_mesh(struct Mesh *me, int unlink);
92 struct Mesh *add_mesh(const char *name);
93 struct Mesh *copy_mesh(struct Mesh *me);
94 void mesh_update_customdata_pointers(struct Mesh *me, const short do_ensure_tess_cd);
95
96 void make_local_mesh(struct Mesh *me);
97 void boundbox_mesh(struct Mesh *me, float *loc, float *size);
98 void tex_space_mesh(struct Mesh *me);
99 float *get_mesh_orco_verts(struct Object *ob);
100 void transform_mesh_orco_verts(struct Mesh *me, float (*orco)[3], int totvert, int invert);
101 int test_index_face(struct MFace *mface, struct CustomData *mfdata, int mfindex, int nr);
102 struct Mesh *get_mesh(struct Object *ob);
103 void set_mesh(struct Object *ob, struct Mesh *me);
104 void mball_to_mesh(struct ListBase *lb, struct Mesh *me);
105 int nurbs_to_mdata(struct Object *ob, 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 int nurbs_to_mdata_customdb(struct Object *ob, struct ListBase *dispbase, struct MVert **allvert, int *_totvert,
109         struct MEdge **alledge, int *_totedge, struct MFace **allface, struct MLoop **allloop, struct MPoly **allpoly, 
110         int *_totface, int *_totloop, int *_totpoly);
111 void nurbs_to_mesh(struct Object *ob);
112 void mesh_to_curve(struct Scene *scene, struct Object *ob);
113 void free_dverts(struct MDeformVert *dvert, int totvert);
114 void copy_dverts(struct MDeformVert *dst, struct MDeformVert *src, int totvert); /* __NLA */
115 void mesh_delete_material_index(struct Mesh *me, short index);
116 void mesh_set_smooth_flag(struct Object *meshOb, int enableSmooth);
117 void convert_mfaces_to_mpolys(struct Mesh *mesh);
118 void mesh_calc_tessface_normals(struct MVert *mverts, int numVerts,struct  MFace *mfaces, int numFaces, float (*faceNors_r)[3]);
119
120 /*used for unit testing; compares two meshes, checking only
121   differences we care about.  should be usable with leaf's
122   testing framework I get RNA work done, will use hackish
123   testing code for now.*/
124 const char *mesh_cmp(struct Mesh *me1, struct Mesh *me2, float thresh);
125
126 struct BoundBox *mesh_get_bb(struct Object *ob);
127 void mesh_get_texspace(struct Mesh *me, float *loc_r, float *rot_r, float *size_r);
128
129 /* if old, it converts mface->edcode to edge drawflags */
130 void make_edges(struct Mesh *me, int old);
131
132 void mesh_strip_loose_faces(struct Mesh *me);
133 void mesh_strip_loose_edges(struct Mesh *me);
134
135         /* Calculate vertex and face normals, face normals are returned in *faceNors_r if non-NULL
136          * and vertex normals are stored in actual mverts.
137          */
138 void mesh_calc_normals(struct MVert *mverts, int numVerts, struct MLoop *mloop, 
139         struct MPoly *mpolys, int numLoops, int numPolys, float (*polyNors_r)[3], 
140         struct MFace *mfaces, int numFaces, int *origIndexFace, float (*faceNors_r)[3]);
141
142         /* Return a newly MEM_malloc'd array of all the mesh vertex locations
143          * (_numVerts_r_ may be NULL) */
144 float (*mesh_getVertexCos(struct Mesh *me, int *numVerts_r))[3];
145
146 /* map from uv vertex to face (for select linked, stitch, uv suburf) */
147
148 /* UvVertMap */
149
150 #define STD_UV_CONNECT_LIMIT    0.0001f
151
152 typedef struct UvVertMap {
153         struct UvMapVert **vert;
154         struct UvMapVert *buf;
155 } UvVertMap;
156
157 typedef struct UvMapVert {
158         struct UvMapVert *next;
159         unsigned int f;
160         unsigned char tfindex, separate, flag;
161 } UvMapVert;
162
163 UvVertMap *make_uv_vert_map(struct MPoly *mpoly, struct MLoop *mloop, struct MLoopUV *mloopuv, unsigned int totpoly, unsigned int totvert, int selected, float *limit);
164 UvMapVert *get_uv_map_vert(UvVertMap *vmap, unsigned int v);
165 void free_uv_vert_map(UvVertMap *vmap);
166
167 /* Connectivity data */
168 typedef struct IndexNode {
169         struct IndexNode *next, *prev;
170         int index;
171 } IndexNode;
172 void create_vert_face_map(ListBase **map, IndexNode **mem, const struct MFace *mface,
173                           const int totvert, const int totface);
174 void create_vert_edge_map(ListBase **map, IndexNode **mem, const struct MEdge *medge,
175                           const int totvert, const int totedge);
176
177 /* functions for making menu's from customdata layers */
178 int mesh_layers_menu_charlen(struct CustomData *data, int type); /* use this to work out how many chars to allocate */
179 void mesh_layers_menu_concat(struct CustomData *data, int type, char *str);
180 int mesh_layers_menu(struct CustomData *data, int type);
181
182 /* vertex level transformations & checks (no derived mesh) */
183
184 int minmax_mesh(struct Mesh *me, float min[3], float max[3]);
185 int mesh_center_median(struct Mesh *me, float cent[3]);
186 int mesh_center_bounds(struct Mesh *me, float cent[3]);
187 void mesh_translate(struct Mesh *me, float offset[3], int do_keys);
188
189 /* mesh_validate.c */
190 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);
191 int BKE_mesh_validate(struct Mesh *me, int do_verbose);
192 int BKE_mesh_validate_dm(struct DerivedMesh *dm);
193
194 void BKE_mesh_calc_edges(struct Mesh *mesh, int update);
195
196 void BKE_mesh_ensure_navmesh(struct Mesh *me);
197
198 /*convert a triangle of loop facedata to mface facedata*/
199 void mesh_loops_to_tri_corners(struct CustomData *fdata, struct CustomData *ldata, 
200                            struct CustomData *pdata, int lindex[3], int findex, 
201                            int polyindex);
202
203 #ifdef __cplusplus
204 }
205 #endif
206
207 #endif /* BKE_MESH_H */