Split Normals I (2/5): Add basic BMesh support of split normals.
[blender.git] / source / blender / bmesh / intern / bmesh_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  * Contributor(s): Geoffrey Bantle, Levi Schooley.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #ifndef __BMESH_MESH_H__
24 #define __BMESH_MESH_H__
25
26 /** \file blender/bmesh/intern/bmesh_mesh.h
27  *  \ingroup bmesh
28  */
29
30 struct BMAllocTemplate;
31
32 void   BM_mesh_elem_toolflags_ensure(BMesh *bm);
33 void   BM_mesh_elem_toolflags_clear(BMesh *bm);
34 BMesh *BM_mesh_create(const struct BMAllocTemplate *allocsize);
35
36 void   BM_mesh_free(BMesh *bm);
37 void   BM_mesh_data_free(BMesh *bm);
38 void   BM_mesh_clear(BMesh *bm);
39
40 void BM_mesh_normals_update(BMesh *bm);
41 void BM_verts_calc_normal_vcos(BMesh *bm, const float (*fnos)[3], const float (*vcos)[3], float (*vnos)[3]);
42 void BM_loops_calc_normal_vcos(BMesh *bm, const float (*vcos)[3], const float (*vnos)[3], const float (*pnos)[3],
43                                const float split_angle, float (*r_lnos)[3]);
44
45 void bmesh_edit_begin(BMesh *bm, const BMOpTypeFlag type_flag);
46 void bmesh_edit_end(BMesh *bm, const BMOpTypeFlag type_flag);
47
48 void BM_mesh_elem_index_ensure(BMesh *bm, const char hflag);
49 void BM_mesh_elem_index_validate(BMesh *bm, const char *location, const char *func,
50                                  const char *msg_a, const char *msg_b);
51
52 #ifndef NDEBUG
53 bool BM_mesh_elem_table_check(BMesh *em);
54 #endif
55
56 void           BM_mesh_elem_table_ensure(BMesh *bm, const char htype);
57 void           BM_mesh_elem_table_init(BMesh *bm, const char htype);
58 void           BM_mesh_elem_table_free(BMesh *bm, const char htype);
59
60 BMVert *BM_vert_at_index(BMesh *bm, const int index);
61 BMEdge *BM_edge_at_index(BMesh *bm, const int index);
62 BMFace *BM_face_at_index(BMesh *bm, const int index);
63
64 BMVert *BM_vert_at_index_find(BMesh *bm, const int index);
65 BMEdge *BM_edge_at_index_find(BMesh *bm, const int index);
66 BMFace *BM_face_at_index_find(BMesh *bm, const int index);
67
68 // XXX
69
70 int  BM_mesh_elem_count(BMesh *bm, const char htype);
71
72 void BM_mesh_remap(BMesh *bm, unsigned int *vert_idx, unsigned int *edge_idx, unsigned int *face_idx);
73
74 typedef struct BMAllocTemplate {
75         int totvert, totedge, totloop, totface;
76 } BMAllocTemplate;
77
78 extern const BMAllocTemplate bm_mesh_allocsize_default;
79 extern const BMAllocTemplate bm_mesh_chunksize_default;
80
81 #define BMALLOC_TEMPLATE_FROM_BM(bm) { (CHECK_TYPE_INLINE(bm, BMesh *), \
82         (bm)->totvert), (bm)->totedge, (bm)->totloop, (bm)->totface}
83 #define BMALLOC_TEMPLATE_FROM_ME(me) { (CHECK_TYPE_INLINE(me, Mesh *), \
84         (me)->totvert), (me)->totedge, (me)->totloop, (me)->totpoly}
85 #define BMALLOC_TEMPLATE_FROM_DM(dm) { (CHECK_TYPE_INLINE(dm, DerivedMesh *), \
86         (dm)->getNumVerts(dm)), (dm)->getNumEdges(dm), (dm)->getNumLoops(dm), (dm)->getNumPolys(dm)}
87
88 enum {
89         BM_MESH_CREATE_USE_TOOLFLAGS = (1 << 0)
90 };
91
92 #endif /* __BMESH_MESH_H__ */