39e1d9eaa7a1a26bac500e52dc7e17b8b07efce3
[blender-staging.git] / source / blender / bmesh / 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/bmesh_queries.h
27  *  \ingroup bmesh
28  */
29
30 #include <stdio.h>
31
32 /* Queries */
33
34 /* counts number of elements of type type are in the mesh. */
35 int BM_mesh_elem_count(struct BMesh *bm, const char htype);
36
37 /*returns true if v is in f*/
38 int BM_vert_in_face(struct BMFace *f, struct BMVert *v);
39
40 // int BM_verts_in_face(struct BMFace *f, struct BMVert **varr, int len);
41 int BM_verts_in_face(struct BMesh *bm, struct BMFace *f, struct BMVert **varr, int len);
42
43 int BM_edge_in_face(struct BMFace *f, struct BMEdge *e);
44
45 int BM_vert_in_edge(struct BMEdge *e, struct BMVert *v);
46
47 int BM_verts_in_edge(struct BMVert *v1, struct BMVert *v2, struct BMEdge *e);
48
49 /*get opposing vert from v in edge e.*/
50 struct BMVert *BM_edge_other_vert(struct BMEdge *e, struct BMVert *v);
51
52 /*finds other loop that shares v with e's loop in f.*/
53 struct BMLoop *BM_face_other_loop(BMEdge *e, BMFace *f, BMVert *v);
54
55 /*returns the edge existing between v1 and v2, or NULL if there isn't one.*/
56 struct BMEdge *BM_edge_exists(struct BMVert *v1, struct BMVert *v2);
57
58
59 /*returns number of edges aroudn a vert*/
60 int BM_vert_edge_count(struct BMVert *v);
61
62 /*returns number of faces around an edge*/
63 int BM_edge_face_count(struct BMEdge *e);
64
65 /*returns number of faces around a vert.*/
66 int BM_vert_face_count(struct BMVert *v);
67
68
69 /*returns true if v is a wire vert*/
70 int BM_vert_is_wire(struct BMesh *bm, struct BMVert *v);
71
72 /*returns true if e is a wire edge*/
73 int BM_edge_is_wire(struct BMesh *bm, struct BMEdge *e);
74
75 /* returns FALSE if v is part of a non-manifold edge in the mesh,
76  * I believe this includes if it's part of both a wire edge and
77  * a face.*/
78 int BM_vert_is_manifold(struct BMesh *bm, struct BMVert *v);
79
80 /* returns FALSE if e is shared by more then two faces. */
81 int BM_edge_is_manifold(struct BMesh *bm, struct BMEdge *e);
82
83 /* returns true if e is a boundary edge, e.g. has only 1 face bordering it. */
84 int BM_edge_is_boundry(struct BMEdge *e);
85
86 /* returns the face corner angle */
87 float BM_loop_face_angle(struct BMesh *bm, struct BMLoop *l);
88
89 /* returns angle of two faces surrounding an edge.  note there must be
90  * exactly two faces sharing the edge.*/
91 float BM_edge_face_angle(struct BMesh *bm, struct BMEdge *e);
92
93 /* returns angle of two faces surrounding edges.  note there must be
94  * exactly two edges sharing the vertex.*/
95 float BM_vert_edge_angle(struct BMesh *bm, struct BMVert *v);
96
97 /* checks overlapping of existing faces with the verts in varr. */
98 int BM_face_exists_overlap(struct BMesh *bm, struct BMVert **varr, int len, struct BMFace **existface);
99
100 /* checks if a face defined by varr already exists. */
101 int BM_face_exists(BMesh *bm, BMVert **varr, int len, BMFace **existface);
102
103
104 /* returns number of edges f1 and f2 share. */
105 int BM_face_share_edges(struct BMFace *f1, struct BMFace *f2);
106
107 /* returns number of faces e1 and e2 share. */
108 int BM_edge_share_faces(struct BMEdge *e1, struct BMEdge *e2);
109
110 /* returns bool 1/0 if the edges share a vertex */
111 int BM_edge_share_vert(struct BMEdge *e1, struct BMEdge *e2);
112
113 /* edge verts in winding order from face */
114 void BM_edge_ordered_verts(struct BMEdge *edge, struct BMVert **r_v1, struct BMVert **r_v2);
115
116 /* checks if a face is valid in the data structure */
117 int BM_face_validate(BMesh *bm, BMFace *face, FILE *err);
118
119 /* each pair of loops defines a new edge, a split.  this function goes
120  * through and sets pairs that are geometrically invalid to null.  a
121  * split is invalid, if it forms a concave angle or it intersects other
122  * edges in the face.*/
123 void BM_face_legal_splits(BMesh *bm, BMFace *f, BMLoop *(*loops)[2], int len);
124
125 #endif /* __BMESH_QUERIES_H__ */