doxygen: add newline after \file
[blender.git] / source / blender / bmesh / tools / bmesh_path.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 #ifndef __BMESH_PATH_H__
18 #define __BMESH_PATH_H__
19
20 /** \file
21  * \ingroup bmesh
22  */
23
24 struct BMCalcPathParams {
25         uint use_topology_distance : 1;
26         uint use_step_face : 1;
27 };
28
29 struct LinkNode *BM_mesh_calc_path_vert(
30         BMesh *bm, BMVert *v_src, BMVert *v_dst, const struct BMCalcPathParams *params,
31         bool (*filter_fn)(BMVert *, void *), void *user_data)
32 ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2, 3, 5);
33
34 struct LinkNode *BM_mesh_calc_path_edge(
35         BMesh *bm, BMEdge *e_src, BMEdge *e_dst, const struct BMCalcPathParams *params,
36         bool (*filter_fn)(BMEdge *, void *), void *user_data)
37 ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2, 3, 5);
38
39 struct LinkNode *BM_mesh_calc_path_face(
40         BMesh *bm, BMFace *f_src, BMFace *f_dst, const struct BMCalcPathParams *params,
41         bool (*filter_fn)(BMFace *, void *), void *user_data)
42 ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2, 3, 5);
43
44 #endif /* __BMESH_PATH_H__ */