9d7866c280a3558e4d00e1198dfaf92be4605c2d
[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 struct MLoopNorSpaceArray;
32
33 void   BM_mesh_elem_toolflags_ensure(BMesh *bm);
34 void   BM_mesh_elem_toolflags_clear(BMesh *bm);
35
36 struct BMeshCreateParams {
37         uint use_toolflags : 1;
38 };
39
40 BMesh *BM_mesh_create(
41         const struct BMAllocTemplate *allocsize,
42         const struct BMeshCreateParams *params);
43
44 void   BM_mesh_free(BMesh *bm);
45 void   BM_mesh_data_free(BMesh *bm);
46 void   BM_mesh_clear(BMesh *bm);
47
48 void BM_mesh_normals_update(BMesh *bm);
49 void BM_verts_calc_normal_vcos(BMesh *bm, const float (*fnos)[3], const float (*vcos)[3], float (*vnos)[3]);
50 void BM_loops_calc_normal_vcos(
51         BMesh *bm, const float (*vcos)[3], const float (*vnos)[3], const float (*pnos)[3],
52         const bool use_split_normals, const float split_angle, float (*r_lnos)[3],
53         struct MLoopNorSpaceArray *r_lnors_spacearr, short (*clnors_data)[2], const int cd_loop_clnors_offset);
54
55 bool BM_loop_check_cyclic_smooth_fan(BMLoop *l_curr);
56
57
58 void BM_edges_sharp_from_angle_set(BMesh *bm, const float split_angle);
59
60 void bmesh_edit_begin(BMesh *bm, const BMOpTypeFlag type_flag);
61 void bmesh_edit_end(BMesh *bm, const BMOpTypeFlag type_flag);
62
63 void BM_mesh_elem_index_ensure(BMesh *bm, const char hflag);
64 void BM_mesh_elem_index_validate(
65         BMesh *bm, const char *location, const char *func,
66         const char *msg_a, const char *msg_b);
67
68 void BM_mesh_toolflags_set(BMesh *bm, bool use_toolflags);
69
70 #ifndef NDEBUG
71 bool BM_mesh_elem_table_check(BMesh *bm);
72 #endif
73
74 void           BM_mesh_elem_table_ensure(BMesh *bm, const char htype);
75 void           BM_mesh_elem_table_init(BMesh *bm, const char htype);
76 void           BM_mesh_elem_table_free(BMesh *bm, const char htype);
77
78 BLI_INLINE BMVert *BM_vert_at_index(BMesh *bm, const int index)
79 {
80         BLI_assert((index >= 0) && (index < bm->totvert));
81         BLI_assert((bm->elem_table_dirty & BM_VERT) == 0);
82         return bm->vtable[index];
83 }
84 BLI_INLINE BMEdge *BM_edge_at_index(BMesh *bm, const int index)
85 {
86         BLI_assert((index >= 0) && (index < bm->totedge));
87         BLI_assert((bm->elem_table_dirty & BM_EDGE) == 0);
88         return bm->etable[index];
89 }
90 BLI_INLINE BMFace *BM_face_at_index(BMesh *bm, const int index)
91 {
92         BLI_assert((index >= 0) && (index < bm->totface));
93         BLI_assert((bm->elem_table_dirty & BM_FACE) == 0);
94         return bm->ftable[index];
95 }
96
97 BMVert *BM_vert_at_index_find(BMesh *bm, const int index);
98 BMEdge *BM_edge_at_index_find(BMesh *bm, const int index);
99 BMFace *BM_face_at_index_find(BMesh *bm, const int index);
100
101 BMVert *BM_vert_at_index_find_or_table(BMesh *bm, const int index);
102 BMEdge *BM_edge_at_index_find_or_table(BMesh *bm, const int index);
103 BMFace *BM_face_at_index_find_or_table(BMesh *bm, const int index);
104
105 // XXX
106
107 int  BM_mesh_elem_count(BMesh *bm, const char htype);
108
109 void BM_mesh_remap(
110         BMesh *bm,
111         const uint *vert_idx,
112         const uint *edge_idx,
113         const uint *face_idx);
114
115 void BM_mesh_rebuild(
116         BMesh *bm, const struct BMeshCreateParams *params,
117         struct BLI_mempool *vpool, struct BLI_mempool *epool, struct BLI_mempool *lpool, struct BLI_mempool *fpool);
118
119 typedef struct BMAllocTemplate {
120         int totvert, totedge, totloop, totface;
121 } BMAllocTemplate;
122
123 extern const BMAllocTemplate bm_mesh_allocsize_default;
124 extern const BMAllocTemplate bm_mesh_chunksize_default;
125
126 #define BMALLOC_TEMPLATE_FROM_BM(bm) { (CHECK_TYPE_INLINE(bm, BMesh *), \
127         (bm)->totvert), (bm)->totedge, (bm)->totloop, (bm)->totface}
128 #define BMALLOC_TEMPLATE_FROM_ME(me) { (CHECK_TYPE_INLINE(me, Mesh *), \
129         (me)->totvert), (me)->totedge, (me)->totloop, (me)->totpoly}
130
131 #define _VA_BMALLOC_TEMPLATE_FROM_DM_1(dm) { \
132         (CHECK_TYPE_INLINE(dm, DerivedMesh *), \
133         (dm)->getNumVerts(dm)),         \
134         (dm)->getNumEdges(dm),          \
135         (dm)->getNumLoops(dm),          \
136         (dm)->getNumPolys(dm),          \
137 }
138 #define _VA_BMALLOC_TEMPLATE_FROM_DM_2(dm_a, dm_b) { \
139         (CHECK_TYPE_INLINE(dm_a, DerivedMesh *), \
140          CHECK_TYPE_INLINE(dm_b, DerivedMesh *), \
141         (dm_a)->getNumVerts(dm_a)) + (dm_b)->getNumVerts(dm_b), \
142         (dm_a)->getNumEdges(dm_a)  + (dm_b)->getNumEdges(dm_b), \
143         (dm_a)->getNumLoops(dm_a)  + (dm_b)->getNumLoops(dm_b), \
144         (dm_a)->getNumPolys(dm_a)  + (dm_b)->getNumPolys(dm_b), \
145 }
146
147 #define BMALLOC_TEMPLATE_FROM_DM(...) VA_NARGS_CALL_OVERLOAD(_VA_BMALLOC_TEMPLATE_FROM_DM_, __VA_ARGS__)
148
149 #endif /* __BMESH_MESH_H__ */