switch arg order for BM_face_other_* funcs (make face come first), and add nice ascii...
[blender.git] / source / blender / bmesh / intern / bmesh_queries.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_QUERIES_H__
24 #define __BMESH_QUERIES_H__
25
26 /** \file blender/bmesh/intern/bmesh_queries.h
27  *  \ingroup bmesh
28  */
29
30 int     BM_mesh_elem_count(BMesh *bm, const char htype);
31
32 int     BM_vert_in_face(BMFace *f, BMVert *v);
33 int     BM_verts_in_face(BMesh *bm, BMFace *f, BMVert **varr, int len);
34
35 int     BM_edge_in_face(BMFace *f, BMEdge *e);
36
37 int     BM_vert_in_edge(BMEdge *e, BMVert *v);
38 int     BM_verts_in_edge(BMVert *v1, BMVert *v2, BMEdge *e);
39
40 int     BM_edge_face_pair(BMEdge *e, BMFace **r_fa, BMFace **r_fb);
41 BMVert *BM_edge_other_vert(BMEdge *e, BMVert *v);
42 BMLoop *BM_face_other_loop(BMFace *f, BMEdge *e, BMVert *v);
43 BMLoop *BM_face_other_vert_loop(BMFace *f, BMVert *v_prev, BMVert *v);
44
45 int     BM_vert_edge_count(BMVert *v);
46 int     BM_edge_face_count(BMEdge *e);
47 int     BM_vert_face_count(BMVert *v);
48
49 int     BM_vert_is_wire(BMesh *bm, BMVert *v);
50 int     BM_edge_is_wire(BMesh *bm, BMEdge *e);
51
52 int     BM_vert_is_manifold(BMesh *bm, BMVert *v);
53 int     BM_edge_is_manifold(BMesh *bm, BMEdge *e);
54 int     BM_edge_is_boundary(BMEdge *e);
55
56 float   BM_loop_face_angle(BMesh *bm, BMLoop *l);
57
58 float   BM_edge_face_angle(BMesh *bm, BMEdge *e);
59 float   BM_vert_edge_angle(BMesh *bm, BMVert *v);
60
61 BMEdge *BM_edge_exists(BMVert *v1, BMVert *v2);
62
63 int     BM_face_exists_overlap(BMesh *bm, BMVert **varr, int len, BMFace **r_existface);
64
65 int     BM_face_exists(BMesh *bm, BMVert **varr, int len, BMFace **r_existface);
66
67 int     BM_face_exists_multi(BMesh *bm, BMVert **varr, BMEdge **earr, int len);
68 int     BM_face_exists_multi_edge(BMesh *bm, BMEdge **earr, int len);
69
70 int     BM_face_share_edge_count(BMFace *f1, BMFace *f2);
71 int     BM_edge_share_face_count(BMEdge *e1, BMEdge *e2);
72 int     BM_edge_share_vert_count(BMEdge *e1, BMEdge *e2);
73
74 BMVert *BM_edge_share_vert(BMEdge *e1, BMEdge *e2);
75
76 void    BM_edge_ordered_verts(BMEdge *edge, BMVert **r_v1, BMVert **r_v2);
77
78 #endif /* __BMESH_QUERIES_H__ */