BMesh: add ability not to delete vertex when collapsing
[blender.git] / source / blender / bmesh / intern / bmesh_core.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): Joseph Eagar.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #ifndef __BMESH_CORE_H__
24 #define __BMESH_CORE_H__
25
26 /** \file blender/bmesh/intern/bmesh_core.h
27  *  \ingroup bmesh
28  */
29
30 BMFace *BM_face_copy(BMesh *bm_dst, BMesh *bm_src, BMFace *f,
31                      const bool copy_verts, const bool copy_edges);
32
33 typedef enum eBMCreateFlag {
34         BM_CREATE_NOP = 0,
35         /* faces and edges only */
36         BM_CREATE_NO_DOUBLE = (1 << 1),
37         /* Skip CustomData - for all element types data,
38          * use if we immediately write customdata into the element so this skips copying from 'example'
39          * args or setting defaults, speeds up conversion when data is converted all at once. */
40         BM_CREATE_SKIP_CD   = (1 << 2),
41 } eBMCreateFlag;
42
43 BMVert *BM_vert_create(BMesh *bm, const float co[3],
44                        const BMVert *v_example, const eBMCreateFlag create_flag);
45 BMEdge *BM_edge_create(BMesh *bm, BMVert *v1, BMVert *v2,
46                        const BMEdge *e_example, const eBMCreateFlag create_flag);
47 BMFace *BM_face_create(BMesh *bm, BMVert **verts, BMEdge **edges, const int len,
48                        const BMFace *f_example, const eBMCreateFlag create_flag);
49 BMFace *BM_face_create_verts(BMesh *bm, BMVert **verts, const int len,
50                              const BMFace *f_example, const eBMCreateFlag create_flag,
51                              const bool create_edges);
52
53 void    BM_face_edges_kill(BMesh *bm, BMFace *f);
54 void    BM_face_verts_kill(BMesh *bm, BMFace *f);
55
56 void    BM_face_kill(BMesh *bm, BMFace *f);
57 void    BM_edge_kill(BMesh *bm, BMEdge *e);
58 void    BM_vert_kill(BMesh *bm, BMVert *v);
59
60 void    bmesh_edge_separate(BMesh *bm, BMEdge *e, BMLoop *l_sep,
61                             const bool copy_select);
62 bool    BM_edge_splice(BMesh *bm, BMEdge *e, BMEdge *e_target);
63 bool    BM_vert_splice(BMesh *bm, BMVert *v, BMVert *v_target);
64
65 void    bmesh_vert_separate(BMesh *bm, BMVert *v, BMVert ***r_vout, int *r_vout_len,
66                             const bool copy_select);
67
68 bool    bmesh_loop_reverse(BMesh *bm, BMFace *f);
69
70 BMFace *BM_faces_join(BMesh *bm, BMFace **faces, int totface, const bool do_del);
71 void    BM_vert_separate(BMesh *bm, BMVert *v, BMVert ***r_vout, int *r_vout_len,
72                          BMEdge **e_in, int e_in_len);
73
74 /* EULER API - For modifying structure */
75 BMFace *bmesh_sfme(BMesh *bm, BMFace *f,
76                    BMLoop *l1, BMLoop *l2,
77                    BMLoop **r_l,
78 #ifdef USE_BMESH_HOLES
79                    ListBase *holes,
80 #endif
81                    BMEdge *example,
82                    const bool no_double
83                    );
84
85 BMVert *bmesh_semv(BMesh *bm, BMVert *tv, BMEdge *e, BMEdge **r_e);
86 BMEdge *bmesh_jekv(BMesh *bm, BMEdge *e_kill, BMVert *v_kill,
87                    const bool do_del, const bool check_edge_splice);
88 BMFace *bmesh_jfke(BMesh *bm, BMFace *f1, BMFace *f2, BMEdge *e);
89 BMVert *bmesh_urmv(BMesh *bm, BMFace *f_sep, BMVert *v_sep);
90 BMVert *bmesh_urmv_loop(BMesh *bm, BMLoop *l_sep);
91
92 void    bmesh_face_swap_data(BMFace *f_a, BMFace *f_b);
93
94 #endif /* __BMESH_CORE_H__ */