Merged changes in the trunk up to revision 42116.
[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 EditMesh;
40 struct MDeformVert;
41 struct Mesh;
42 struct MFace;
43 struct MEdge;
44 struct MVert;
45 struct MCol;
46 struct Object;
47 struct MTFace;
48 struct VecNor;
49 struct CustomData;
50 struct DerivedMesh;
51 struct Scene;
52
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56
57 struct EditMesh *BKE_mesh_get_editmesh(struct Mesh *me);
58 void BKE_mesh_end_editmesh(struct Mesh *me, struct EditMesh *em);
59
60 void unlink_mesh(struct Mesh *me);
61 void free_mesh(struct Mesh *me);
62 struct Mesh *add_mesh(const char *name);
63 struct Mesh *copy_mesh(struct Mesh *me);
64 void mesh_update_customdata_pointers(struct Mesh *me);
65 void make_local_mesh(struct Mesh *me);
66 void boundbox_mesh(struct Mesh *me, float *loc, float *size);
67 void tex_space_mesh(struct Mesh *me);
68 float *get_mesh_orco_verts(struct Object *ob);
69 void transform_mesh_orco_verts(struct Mesh *me, float (*orco)[3], int totvert, int invert);
70 int test_index_face(struct MFace *mface, struct CustomData *mfdata, int mfindex, int nr);
71 struct Mesh *get_mesh(struct Object *ob);
72 void set_mesh(struct Object *ob, struct Mesh *me);
73 void mball_to_mesh(struct ListBase *lb, struct Mesh *me);
74 int nurbs_to_mdata(struct Object *ob, struct MVert **allvert, int *_totvert,
75         struct MEdge **alledge, int *_totedge, struct MFace **allface, int *_totface);
76 int nurbs_to_mdata_customdb(struct Object *ob, struct ListBase *dispbase,
77         struct MVert **allvert, int *_totvert, struct MEdge **alledge, int *_totedge,
78         struct MFace **allface, int *_totface);
79 void nurbs_to_mesh(struct Object *ob);
80 void mesh_to_curve(struct Scene *scene, struct Object *ob);
81 void free_dverts(struct MDeformVert *dvert, int totvert);
82 void copy_dverts(struct MDeformVert *dst, struct MDeformVert *src, int totvert); /* __NLA */
83 void mesh_delete_material_index(struct Mesh *me, short index);
84 void mesh_set_smooth_flag(struct Object *meshOb, int enableSmooth);
85
86 struct BoundBox *mesh_get_bb(struct Object *ob);
87 void mesh_get_texspace(struct Mesh *me, float *loc_r, float *rot_r, float *size_r);
88
89 /* if old, it converts mface->edcode to edge drawflags */
90 void make_edges(struct Mesh *me, int old);
91
92 void mesh_strip_loose_faces(struct Mesh *me);
93 void mesh_strip_loose_edges(struct Mesh *me);
94
95         /* Calculate vertex and face normals, face normals are returned in *faceNors_r if non-NULL
96          * and vertex normals are stored in actual mverts.
97          */
98 void mesh_calc_normals(struct MVert *mverts, int numVerts, struct MFace *mfaces, int numFaces, float (*faceNors_r)[3]);
99
100         /* Return a newly MEM_malloc'd array of all the mesh vertex locations
101          * (_numVerts_r_ may be NULL) */
102 float (*mesh_getVertexCos(struct Mesh *me, int *numVerts_r))[3];
103
104 /* map from uv vertex to face (for select linked, stitch, uv suburf) */
105
106 /* UvVertMap */
107
108 #define STD_UV_CONNECT_LIMIT    0.0001f
109
110 typedef struct UvVertMap {
111         struct UvMapVert **vert;
112         struct UvMapVert *buf;
113 } UvVertMap;
114
115 typedef struct UvMapVert {
116         struct UvMapVert *next;
117         unsigned int f;
118         unsigned char tfindex, separate, flag;
119 } UvMapVert;
120
121 UvVertMap *make_uv_vert_map(struct MFace *mface, struct MTFace *tface, unsigned int totface, unsigned int totvert, int selected, float *limit);
122 UvMapVert *get_uv_map_vert(UvVertMap *vmap, unsigned int v);
123 void free_uv_vert_map(UvVertMap *vmap);
124
125 /* Connectivity data */
126 typedef struct IndexNode {
127         struct IndexNode *next, *prev;
128         int index;
129 } IndexNode;
130 void create_vert_face_map(ListBase **map, IndexNode **mem, const struct MFace *mface,
131                           const int totvert, const int totface);
132 void create_vert_edge_map(ListBase **map, IndexNode **mem, const struct MEdge *medge,
133                           const int totvert, const int totedge);
134
135 /* Partial Mesh Visibility */
136 struct PartialVisibility *mesh_pmv_copy(struct PartialVisibility *);
137 void mesh_pmv_free(struct PartialVisibility *);
138 void mesh_pmv_revert(struct Mesh *me);
139 void mesh_pmv_off(struct Mesh *me);
140
141 /* functions for making menu's from customdata layers */
142 int mesh_layers_menu_charlen(struct CustomData *data, int type); /* use this to work out how many chars to allocate */
143 void mesh_layers_menu_concat(struct CustomData *data, int type, char *str);
144 int mesh_layers_menu(struct CustomData *data, int type);
145
146 /* vertex level transformations & checks (no derived mesh) */
147
148 int minmax_mesh(struct Mesh *me, float min[3], float max[3]);
149 int mesh_center_median(struct Mesh *me, float cent[3]);
150 int mesh_center_bounds(struct Mesh *me, float cent[3]);
151 void mesh_translate(struct Mesh *me, float offset[3], int do_keys);
152
153 /* mesh_validate.c */
154 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);
155 int BKE_mesh_validate(struct Mesh *me, int do_verbose);
156 int BKE_mesh_validate_dm(struct DerivedMesh *dm);
157
158 void BKE_mesh_calc_edges(struct Mesh *mesh, int update);
159
160 void BKE_mesh_ensure_navmesh(struct Mesh *me);
161
162 #ifdef __cplusplus
163 }
164 #endif
165
166 #endif /* BKE_MESH_H */