Merge branch 'master' into blender2.8
[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(
31         BMesh *bm_dst, BMesh *bm_src, BMFace *f,
32         const bool copy_verts, const bool copy_edges);
33
34 typedef enum eBMCreateFlag {
35         BM_CREATE_NOP = 0,
36         /* faces and edges only */
37         BM_CREATE_NO_DOUBLE = (1 << 1),
38         /* Skip CustomData - for all element types data,
39          * use if we immediately write customdata into the element so this skips copying from 'example'
40          * args or setting defaults, speeds up conversion when data is converted all at once. */
41         BM_CREATE_SKIP_CD   = (1 << 2),
42 } eBMCreateFlag;
43
44 BMVert *BM_vert_create(
45         BMesh *bm, const float co[3],
46         const BMVert *v_example, const eBMCreateFlag create_flag);
47 BMEdge *BM_edge_create(
48         BMesh *bm, BMVert *v1, BMVert *v2,
49         const BMEdge *e_example, const eBMCreateFlag create_flag);
50 BMFace *BM_face_create(
51         BMesh *bm, BMVert **verts, BMEdge **edges, const int len,
52         const BMFace *f_example, const eBMCreateFlag create_flag);
53 BMFace *BM_face_create_verts(
54         BMesh *bm, BMVert **verts, const int len,
55         const BMFace *f_example, const eBMCreateFlag create_flag,
56         const bool create_edges);
57
58 void    BM_face_edges_kill(BMesh *bm, BMFace *f);
59 void    BM_face_verts_kill(BMesh *bm, BMFace *f);
60
61 void    BM_face_kill_loose(BMesh *bm, BMFace *f);
62
63 void    BM_face_kill(BMesh *bm, BMFace *f);
64 void    BM_edge_kill(BMesh *bm, BMEdge *e);
65 void    BM_vert_kill(BMesh *bm, BMVert *v);
66
67 bool    BM_edge_splice(BMesh *bm, BMEdge *e_dst, BMEdge *e_src);
68 bool    BM_vert_splice(BMesh *bm, BMVert *v_dst, BMVert *v_src);
69 bool    BM_vert_splice_check_double(BMVert *v_a, BMVert *v_b);
70
71 void    bmesh_kernel_loop_reverse(
72         BMesh *bm, BMFace *f,
73         const int cd_loop_mdisp_offset, const bool use_loop_mdisp_flip);
74
75 void    bmesh_face_swap_data(BMFace *f_a, BMFace *f_b);
76
77 BMFace *BM_faces_join(BMesh *bm, BMFace **faces, int totface, const bool do_del);
78 void    BM_vert_separate(
79         BMesh *bm, BMVert *v, BMEdge **e_in, int e_in_len, const bool copy_select,
80         BMVert ***r_vout, int *r_vout_len);
81 void BM_vert_separate_hflag(
82         BMesh *bm, BMVert *v, const char hflag, const bool copy_select,
83         BMVert ***r_vout, int *r_vout_len);
84 void BM_vert_separate_tested_edges(
85         BMesh *bm, BMVert *v_dst, BMVert *v_src,
86         bool (*testfn)(BMEdge *, void *arg), void *arg);
87
88 /**
89  * BMesh Kernel: For modifying structure.
90  *
91  * Names are on the verbose side but these are only for low-level access.
92  */
93 void    bmesh_kernel_vert_separate(
94         BMesh *bm, BMVert *v, BMVert ***r_vout, int *r_vout_len,
95         const bool copy_select);
96 void    bmesh_kernel_edge_separate(
97         BMesh *bm, BMEdge *e, BMLoop *l_sep,
98         const bool copy_select);
99
100 BMFace *bmesh_kernel_split_face_make_edge(
101         BMesh *bm, BMFace *f,
102         BMLoop *l1, BMLoop *l2,
103         BMLoop **r_l,
104 #ifdef USE_BMESH_HOLES
105         ListBase *holes,
106 #endif
107         BMEdge *example,
108         const bool no_double
109         );
110
111 BMVert *bmesh_kernel_split_edge_make_vert(
112         BMesh *bm, BMVert *tv, BMEdge *e, BMEdge **r_e);
113 BMEdge *bmesh_kernel_join_edge_kill_vert(
114         BMesh *bm, BMEdge *e_kill, BMVert *v_kill,
115         const bool do_del, const bool check_edge_splice,
116         const bool kill_degenerate_faces);
117 BMVert *bmesh_kernel_join_vert_kill_edge(
118         BMesh *bm, BMEdge *e_kill, BMVert *v_kill,
119         const bool do_del, const bool check_edge_double,
120         const bool kill_degenerate_faces);
121 BMFace *bmesh_kernel_join_face_kill_edge(BMesh *bm, BMFace *f1, BMFace *f2, BMEdge *e);
122
123 BMVert *bmesh_kernel_unglue_region_make_vert(BMesh *bm, BMLoop *l_sep);
124 BMVert *bmesh_kernel_unglue_region_make_vert_multi(BMesh *bm, BMLoop **larr, int larr_len);
125 BMVert *bmesh_kernel_unglue_region_make_vert_multi_isolated(BMesh *bm, BMLoop *l_sep);
126
127 #endif /* __BMESH_CORE_H__ */