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