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