committing working copy
[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 /***/
35
36 struct BoundBox;
37 struct DispList;
38 struct ListBase;
39 struct EditMesh;
40 struct MDeformVert;
41 struct Mesh;
42 struct MFace;
43 struct MEdge;
44 struct MVert;
45 struct MCol;
46 struct BMesh;
47 struct Object;
48 struct MTFace;
49 struct VecNor;
50 struct CustomData;
51
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55
56 struct EditMesh *BKE_mesh_get_editmesh(struct Mesh *me);
57 void BKE_mesh_end_editmesh(struct Mesh *me, struct EditMesh *em);
58 struct BMesh *BKE_mesh_to_bmesh(struct Mesh *me, struct Object *ob);
59
60 /*
61   this function recreates a tesselation.
62   returns number of tesselation faces.
63
64   use_poly_origindex sets whether or not the tesselation faces' origindex
65   layer should point to original poly indices or real poly indices.
66
67   use_face_origindex sets the tesselation faces' origindex layer
68   to point to the tesselation faces themselves, not the polys.
69
70   if both of the above are 0, it'll use the indices of the mpolys of the MPoly
71   data in pdata, and ignore the origindex layer altogether.
72  */
73 int mesh_recalcTesselation(struct CustomData *fdata, struct CustomData *ldata, 
74         struct CustomData *pdata, struct MVert *mvert, int totface, 
75         int totloop, int totpoly, int use_poly_origindex, int use_face_origindex);
76
77 /*calculates a face normal.*/
78 void mesh_calc_poly_normal(struct MPoly *mpoly, struct MLoop *loopstart, 
79                            struct MVert *mvarray, float *no);
80
81 void unlink_mesh(struct Mesh *me);
82 void free_mesh(struct Mesh *me, int unlink);
83 struct Mesh *add_mesh(char *name);
84 struct Mesh *copy_mesh(struct Mesh *me);
85 void mesh_update_customdata_pointers(struct Mesh *me);
86
87 /*this ensures grouped customdata (e.g. mtexpoly and mloopuv and mtface, or
88   mloopcol and mcol) have the same relative active/render/clone/mask indices.*/
89 void mesh_update_linked_customdata(struct Mesh *me);
90
91 void make_local_tface(struct Mesh *me);
92 void make_local_mesh(struct Mesh *me);
93 void boundbox_mesh(struct Mesh *me, float *loc, float *size);
94 void tex_space_mesh(struct Mesh *me);
95 float *get_mesh_orco_verts(struct Object *ob);
96 void transform_mesh_orco_verts(struct Mesh *me, float (*orco)[3], int totvert, int invert);
97 int test_index_face(struct MFace *mface, struct CustomData *mfdata, int mfindex, int nr);
98 struct Mesh *get_mesh(struct Object *ob);
99 void set_mesh(struct Object *ob, struct Mesh *me);
100 void mball_to_mesh(struct ListBase *lb, struct Mesh *me);
101 int nurbs_to_mdata(struct Object *ob, struct MVert **allvert, int *_totvert,
102         struct MEdge **alledge, int *_totedge, struct MFace **allface, int *_totface);
103 int nurbs_to_mdata_customdb(struct Object *ob, struct ListBase *dispbase,
104         struct MVert **allvert, int *_totvert, struct MEdge **alledge, int *_totedge,
105         struct MFace **allface, int *_totface);
106 void nurbs_to_mesh(struct Object *ob);
107 void mesh_to_curve(struct Scene *scene, struct Object *ob);
108 void free_dverts(struct MDeformVert *dvert, int totvert);
109 void copy_dverts(struct MDeformVert *dst, struct MDeformVert *src, int totvert); /* __NLA */
110 void mesh_delete_material_index(struct Mesh *me, int index);
111 void mesh_set_smooth_flag(struct Object *meshOb, int enableSmooth);
112
113 struct BoundBox *mesh_get_bb(struct Object *ob);
114 void mesh_get_texspace(struct Mesh *me, float *loc_r, float *rot_r, float *size_r);
115
116 /* if old, it converts mface->edcode to edge drawflags */
117 void make_edges(struct Mesh *me, int old);
118 void mesh_strip_loose_faces(struct Mesh *me);
119
120         /* Calculate vertex and face normals, face normals are returned in *faceNors_r if non-NULL
121          * and vertex normals are stored in actual mverts.
122          */
123 void mesh_calc_normals(struct MVert *mverts, int numVerts, struct MFace *mfaces, int numFaces, float **faceNors_r);
124
125         /* Return a newly MEM_malloc'd array of all the mesh vertex locations
126          * (_numVerts_r_ may be NULL) */
127 float (*mesh_getVertexCos(struct Mesh *me, int *numVerts_r))[3];
128
129 /* map from uv vertex to face (for select linked, stitch, uv suburf) */
130
131 /* UvVertMap */
132
133 #define STD_UV_CONNECT_LIMIT    0.0001f
134
135 typedef struct UvVertMap {
136         struct UvMapVert **vert;
137         struct UvMapVert *buf;
138 } UvVertMap;
139
140 typedef struct UvMapVert {
141         struct UvMapVert *next;
142         unsigned int f;
143         unsigned char tfindex, separate, flag;
144 } UvMapVert;
145
146 UvVertMap *make_uv_vert_map(struct MFace *mface, struct MTFace *tface, unsigned int totface, unsigned int totvert, int selected, float *limit);
147 UvMapVert *get_uv_map_vert(UvVertMap *vmap, unsigned int v);
148 void free_uv_vert_map(UvVertMap *vmap);
149
150 /* Connectivity data */
151 typedef struct IndexNode {
152         struct IndexNode *next, *prev;
153         int index;
154 } IndexNode;
155 void create_vert_face_map(ListBase **map, IndexNode **mem, const struct MFace *mface,
156                           const int totvert, const int totface);
157 void create_vert_edge_map(ListBase **map, IndexNode **mem, const struct MEdge *medge,
158                           const int totvert, const int totedge);
159
160 /* Partial Mesh Visibility */
161 struct PartialVisibility *mesh_pmv_copy(struct PartialVisibility *);
162 void mesh_pmv_free(struct PartialVisibility *);
163 void mesh_pmv_revert(struct Object *ob, struct Mesh *me);
164 void mesh_pmv_off(struct Object *ob, struct Mesh *me);
165
166 /* functions for making menu's from customdata layers */
167 int mesh_layers_menu_charlen(struct CustomData *data, int type); /* use this to work out how many chars to allocate */
168 void mesh_layers_menu_concat(struct CustomData *data, int type, char *str);
169 int mesh_layers_menu(struct CustomData *data, int type);
170
171 #ifdef __cplusplus
172 }
173 #endif
174
175 #endif
176