Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / bmesh / intern / bmesh_polygon.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_POLYGON_H__
18 #define __BMESH_POLYGON_H__
19
20 /** \file \ingroup bmesh
21  */
22
23 struct Heap;
24
25 #include "BLI_compiler_attrs.h"
26
27 void  BM_mesh_calc_tessellation(BMesh *bm, BMLoop *(*looptris)[3], int *r_looptris_tot);
28 void  BM_mesh_calc_tessellation_beauty(BMesh *bm, BMLoop *(*looptris)[3], int *r_looptris_tot);
29
30 void  BM_face_calc_tessellation(
31         const BMFace *f, const bool use_fixed_quad,
32         BMLoop **r_loops, uint (*r_index)[3]);
33 void  BM_face_calc_point_in_face(const BMFace *f, float r_co[3]);
34 float BM_face_calc_normal(const BMFace *f, float r_no[3]) ATTR_NONNULL();
35 float BM_face_calc_normal_vcos(
36         const BMesh *bm, const BMFace *f, float r_no[3],
37         float const (*vertexCos)[3]) ATTR_NONNULL();
38 float BM_face_calc_normal_subset(const BMLoop *l_first, const BMLoop *l_last, float r_no[3]) ATTR_NONNULL();
39 float BM_face_calc_area(const BMFace *f) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
40 float BM_face_calc_area_with_mat3(const BMFace *f, const float mat3[3][3]) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
41 float BM_face_calc_area_uv(const BMFace *f, int cd_loop_uv_offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
42 float BM_face_calc_perimeter(const BMFace *f) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
43 float BM_face_calc_perimeter_with_mat3(const BMFace *f, const float mat3[3][3]) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
44 void  BM_face_calc_tangent_edge(const BMFace *f, float r_plane[3]) ATTR_NONNULL();
45 void  BM_face_calc_tangent_edge_pair(const BMFace *f, float r_plane[3]) ATTR_NONNULL();
46 void  BM_face_calc_tangent_edge_diagonal(const BMFace *f, float r_plane[3]) ATTR_NONNULL();
47 void  BM_face_calc_tangent_vert_diagonal(const BMFace *f, float r_plane[3]) ATTR_NONNULL();
48 void  BM_face_calc_tangent_auto(const BMFace *f, float r_plane[3]) ATTR_NONNULL();
49 void  BM_face_calc_center_bounds(const BMFace *f, float center[3]) ATTR_NONNULL();
50 void  BM_face_calc_center_median(const BMFace *f, float center[3]) ATTR_NONNULL();
51 void  BM_face_calc_center_median_vcos(
52         const BMesh *bm, const BMFace *f, float r_cent[3],
53         float const (*vertexCos)[3]) ATTR_NONNULL();
54 void  BM_face_calc_center_median_weighted(const BMFace *f, float center[3]) ATTR_NONNULL();
55
56 void BM_face_calc_bounds_expand(const BMFace *f, float min[3], float max[3]);
57
58 void  BM_face_normal_update(BMFace *f) ATTR_NONNULL();
59
60 void  BM_edge_normals_update(BMEdge *e) ATTR_NONNULL();
61
62 bool  BM_vert_calc_normal_ex(const BMVert *v, const char hflag, float r_no[3]);
63 bool  BM_vert_calc_normal(const BMVert *v, float r_no[3]);
64 void  BM_vert_normal_update(BMVert *v) ATTR_NONNULL();
65 void  BM_vert_normal_update_all(BMVert *v) ATTR_NONNULL();
66
67 void  BM_face_normal_flip_ex(
68         BMesh *bm, BMFace *f,
69         const int cd_loop_mdisp_offset, const bool use_loop_mdisp_flip) ATTR_NONNULL();
70 void  BM_face_normal_flip(BMesh *bm, BMFace *f) ATTR_NONNULL();
71 bool  BM_face_point_inside_test(const BMFace *f, const float co[3]) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
72
73 void  BM_face_triangulate(
74         BMesh *bm, BMFace *f,
75         BMFace **r_faces_new,
76         int     *r_faces_new_tot,
77         BMEdge **r_edges_new,
78         int     *r_edges_new_tot,
79         struct LinkNode **r_faces_double,
80         const int quad_method, const int ngon_method,
81         const bool use_tag,
82         struct MemArena *pf_arena,
83         struct Heap *pf_heap
84         ) ATTR_NONNULL(1, 2);
85
86 void  BM_face_splits_check_legal(BMesh *bm, BMFace *f, BMLoop *(*loops)[2], int len) ATTR_NONNULL();
87 void  BM_face_splits_check_optimal(BMFace *f, BMLoop *(*loops)[2], int len) ATTR_NONNULL();
88
89 void BM_face_as_array_vert_tri(BMFace *f, BMVert *r_verts[3]) ATTR_NONNULL();
90 void BM_face_as_array_vert_quad(BMFace *f, BMVert *r_verts[4]) ATTR_NONNULL();
91
92 void BM_face_as_array_loop_tri(BMFace *f, BMLoop *r_loops[3]) ATTR_NONNULL();
93 void BM_face_as_array_loop_quad(BMFace *f, BMLoop *r_loops[4]) ATTR_NONNULL();
94
95 void BM_vert_tri_calc_tangent_edge(BMVert *verts[3], float r_tangent[3]);
96 void BM_vert_tri_calc_tangent_edge_pair(BMVert *verts[3], float r_tangent[3]);
97
98 #endif /* __BMESH_POLYGON_H__ */