diff options
Diffstat (limited to 'source/blender/bmesh/intern/bmesh_queries.h')
| -rw-r--r-- | source/blender/bmesh/intern/bmesh_queries.h | 168 |
1 files changed, 85 insertions, 83 deletions
diff --git a/source/blender/bmesh/intern/bmesh_queries.h b/source/blender/bmesh/intern/bmesh_queries.h index 21d20976901..0d47633dc73 100644 --- a/source/blender/bmesh/intern/bmesh_queries.h +++ b/source/blender/bmesh/intern/bmesh_queries.h @@ -27,29 +27,31 @@ * \ingroup bmesh */ -bool BM_vert_in_face(BMFace *f, BMVert *v); -int BM_verts_in_face_count(BMFace *f, BMVert **varr, int len); -bool BM_verts_in_face(BMFace *f, BMVert **varr, int len); - -bool BM_edge_in_face(BMEdge *e, BMFace *f); -BLI_INLINE bool BM_edge_in_loop(const BMEdge *e, const BMLoop *l); - -BLI_INLINE bool BM_vert_in_edge(const BMEdge *e, const BMVert *v); -BLI_INLINE bool BM_verts_in_edge(const BMVert *v1, const BMVert *v2, const BMEdge *e); - -float BM_edge_calc_length(BMEdge *e); -float BM_edge_calc_length_squared(BMEdge *e); -bool BM_edge_face_pair(BMEdge *e, BMFace **r_fa, BMFace **r_fb); -bool BM_edge_loop_pair(BMEdge *e, BMLoop **r_la, BMLoop **r_lb); -BLI_INLINE BMVert *BM_edge_other_vert(BMEdge *e, const BMVert *v); -BMLoop *BM_edge_other_loop(BMEdge *e, BMLoop *l); -BMLoop *BM_face_other_edge_loop(BMFace *f, BMEdge *e, BMVert *v); -BMLoop *BM_loop_other_edge_loop(BMLoop *l, BMVert *v); -BMLoop *BM_face_other_vert_loop(BMFace *f, BMVert *v_prev, BMVert *v); -BMLoop *BM_loop_other_vert_loop(BMLoop *l, BMVert *v); -BMLoop *BM_vert_step_fan_loop(BMLoop *l, BMEdge **e_step); -BMLoop *BM_vert_find_first_loop(BMVert *v); - +bool BM_vert_in_face(BMFace *f, BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +int BM_verts_in_face_count(BMFace *f, BMVert **varr, int len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +bool BM_verts_in_face(BMFace *f, BMVert **varr, int len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); + +bool BM_edge_in_face(BMEdge *e, BMFace *f) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BLI_INLINE bool BM_edge_in_loop(const BMEdge *e, const BMLoop *l) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); + +BLI_INLINE bool BM_vert_in_edge(const BMEdge *e, const BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BLI_INLINE bool BM_verts_in_edge(const BMVert *v1, const BMVert *v2, const BMEdge *e) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); + +float BM_edge_calc_length(BMEdge *e) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +float BM_edge_calc_length_squared(BMEdge *e) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +bool BM_edge_face_pair(BMEdge *e, BMFace **r_fa, BMFace **r_fb) ATTR_NONNULL(); +bool BM_edge_loop_pair(BMEdge *e, BMLoop **r_la, BMLoop **r_lb) ATTR_NONNULL(); +BLI_INLINE BMVert *BM_edge_other_vert(BMEdge *e, const BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BMLoop *BM_edge_other_loop(BMEdge *e, BMLoop *l) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BMLoop *BM_face_other_edge_loop(BMFace *f, BMEdge *e, BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BMLoop *BM_loop_other_edge_loop(BMLoop *l, BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BMLoop *BM_face_other_vert_loop(BMFace *f, BMVert *v_prev, BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BMLoop *BM_loop_other_vert_loop(BMLoop *l, BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BMLoop *BM_vert_step_fan_loop(BMLoop *l, BMEdge **e_step) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BMLoop *BM_vert_find_first_loop(BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); + +bool BM_vert_pair_share_face_check( + BMVert *v_a, BMVert *v_b) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); BMFace *BM_vert_pair_share_face_by_len( BMVert *v_a, BMVert *v_b, BMLoop **r_l_a, BMLoop **r_l_b, @@ -59,95 +61,95 @@ BMFace *BM_vert_pair_share_face_by_angle( BMLoop **r_l_a, BMLoop **r_l_b, const bool allow_adjacent) ATTR_NONNULL(); -int BM_vert_edge_count_nonwire(BMVert *v); -int BM_vert_edge_count(BMVert *v); -int BM_edge_face_count(BMEdge *e); -int BM_vert_face_count(BMVert *v); -BMEdge *BM_vert_other_disk_edge(BMVert *v, BMEdge *e); +int BM_vert_edge_count_nonwire(BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +int BM_vert_edge_count(BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +int BM_edge_face_count(BMEdge *e) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +int BM_vert_face_count(BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BMEdge *BM_vert_other_disk_edge(BMVert *v, BMEdge *e) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); -bool BM_vert_is_edge_pair(BMVert *v); -bool BM_vert_is_wire(const BMVert *v); -BLI_INLINE bool BM_edge_is_wire(const BMEdge *e); +bool BM_vert_is_edge_pair(BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +bool BM_vert_is_wire(const BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BLI_INLINE bool BM_edge_is_wire(const BMEdge *e) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); -bool BM_vert_is_manifold(const BMVert *v); -BLI_INLINE bool BM_edge_is_manifold(const BMEdge *e); -bool BM_vert_is_boundary(const BMVert *v); -BLI_INLINE bool BM_edge_is_boundary(const BMEdge *e); -BLI_INLINE bool BM_edge_is_contiguous(const BMEdge *e); -bool BM_edge_is_convex(const BMEdge *e); +bool BM_vert_is_manifold(const BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BLI_INLINE bool BM_edge_is_manifold(const BMEdge *e) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +bool BM_vert_is_boundary(const BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BLI_INLINE bool BM_edge_is_boundary(const BMEdge *e) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BLI_INLINE bool BM_edge_is_contiguous(const BMEdge *e) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +bool BM_edge_is_convex(const BMEdge *e) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); -bool BM_loop_is_convex(const BMLoop *l); -BLI_INLINE bool BM_loop_is_adjacent(const BMLoop *l_a, const BMLoop *l_b); +bool BM_loop_is_convex(const BMLoop *l) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BLI_INLINE bool BM_loop_is_adjacent(const BMLoop *l_a, const BMLoop *l_b) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); -float BM_loop_calc_face_angle(BMLoop *l); -void BM_loop_calc_face_normal(BMLoop *l, float r_normal[3]); +float BM_loop_calc_face_angle(BMLoop *l) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +void BM_loop_calc_face_normal(BMLoop *l, float r_normal[3]) ATTR_NONNULL(); void BM_loop_calc_face_direction(BMLoop *l, float r_normal[3]); void BM_loop_calc_face_tangent(BMLoop *l, float r_tangent[3]); -float BM_edge_calc_face_angle_ex(const BMEdge *e, const float fallback); -float BM_edge_calc_face_angle(const BMEdge *e); -float BM_edge_calc_face_angle_signed_ex(const BMEdge *e, const float fallback); -float BM_edge_calc_face_angle_signed(const BMEdge *e); -void BM_edge_calc_face_tangent(const BMEdge *e, const BMLoop *e_loop, float r_tangent[3]); +float BM_edge_calc_face_angle_ex(const BMEdge *e, const float fallback) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +float BM_edge_calc_face_angle(const BMEdge *e) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +float BM_edge_calc_face_angle_signed_ex(const BMEdge *e, const float fallback) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +float BM_edge_calc_face_angle_signed(const BMEdge *e) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +void BM_edge_calc_face_tangent(const BMEdge *e, const BMLoop *e_loop, float r_tangent[3]) ATTR_NONNULL(); -float BM_vert_calc_edge_angle(BMVert *v); -float BM_vert_calc_shell_factor(BMVert *v); -float BM_vert_calc_shell_factor_ex(BMVert *v, const char hflag); -float BM_vert_calc_mean_tagged_edge_length(BMVert *v); +float BM_vert_calc_edge_angle(BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +float BM_vert_calc_shell_factor(BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +float BM_vert_calc_shell_factor_ex(BMVert *v, const char hflag) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +float BM_vert_calc_mean_tagged_edge_length(BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); -BMLoop *BM_face_find_shortest_loop(BMFace *f); -BMLoop *BM_face_find_longest_loop(BMFace *f); +BMLoop *BM_face_find_shortest_loop(BMFace *f) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BMLoop *BM_face_find_longest_loop(BMFace *f) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); -BMEdge *BM_edge_exists(BMVert *v1, BMVert *v2); -BMEdge *BM_edge_find_double(BMEdge *e); +BMEdge *BM_edge_exists(BMVert *v1, BMVert *v2) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BMEdge *BM_edge_find_double(BMEdge *e) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); -bool BM_face_exists(BMVert **varr, int len, BMFace **r_existface); +bool BM_face_exists(BMVert **varr, int len, BMFace **r_existface) ATTR_NONNULL(1); -bool BM_face_exists_multi(BMVert **varr, BMEdge **earr, int len); -bool BM_face_exists_multi_edge(BMEdge **earr, int len); +bool BM_face_exists_multi(BMVert **varr, BMEdge **earr, int len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +bool BM_face_exists_multi_edge(BMEdge **earr, int len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); -bool BM_face_exists_overlap(BMVert **varr, const int len, BMFace **r_f_overlap); -bool BM_face_exists_overlap_subset(BMVert **varr, const int len); +bool BM_face_exists_overlap(BMVert **varr, const int len, BMFace **r_f_overlap) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1); +bool BM_face_exists_overlap_subset(BMVert **varr, const int len) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); -int BM_face_share_face_count(BMFace *f_a, BMFace *f_b); -int BM_face_share_edge_count(BMFace *f1, BMFace *f2); +int BM_face_share_face_count(BMFace *f_a, BMFace *f_b) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +int BM_face_share_edge_count(BMFace *f1, BMFace *f2) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); -bool BM_face_share_face_check(BMFace *f1, BMFace *f2); -bool BM_face_share_edge_check(BMFace *f1, BMFace *f2); -bool BM_edge_share_face_check(BMEdge *e1, BMEdge *e2); -bool BM_edge_share_quad_check(BMEdge *e1, BMEdge *e2); -bool BM_edge_share_vert_check(BMEdge *e1, BMEdge *e2); +bool BM_face_share_face_check(BMFace *f1, BMFace *f2) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +bool BM_face_share_edge_check(BMFace *f1, BMFace *f2) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +bool BM_edge_share_face_check(BMEdge *e1, BMEdge *e2) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +bool BM_edge_share_quad_check(BMEdge *e1, BMEdge *e2) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +bool BM_edge_share_vert_check(BMEdge *e1, BMEdge *e2) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); -BMVert *BM_edge_share_vert(BMEdge *e1, BMEdge *e2); -BMLoop *BM_edge_vert_share_loop(BMLoop *l, BMVert *v); -BMLoop *BM_face_vert_share_loop(BMFace *f, BMVert *v); -BMLoop *BM_face_edge_share_loop(BMFace *f, BMEdge *e); +BMVert *BM_edge_share_vert(BMEdge *e1, BMEdge *e2) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BMLoop *BM_edge_vert_share_loop(BMLoop *l, BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BMLoop *BM_face_vert_share_loop(BMFace *f, BMVert *v) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +BMLoop *BM_face_edge_share_loop(BMFace *f, BMEdge *e) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); -void BM_edge_ordered_verts(const BMEdge *edge, BMVert **r_v1, BMVert **r_v2); +void BM_edge_ordered_verts(const BMEdge *edge, BMVert **r_v1, BMVert **r_v2) ATTR_NONNULL(); void BM_edge_ordered_verts_ex(const BMEdge *edge, BMVert **r_v1, BMVert **r_v2, - const BMLoop *edge_loop); + const BMLoop *edge_loop) ATTR_NONNULL(); -bool BM_vert_is_all_edge_flag_test(const BMVert *v, const char hflag, const bool respect_hide); -bool BM_vert_is_all_face_flag_test(const BMVert *v, const char hflag, const bool respect_hide); -bool BM_edge_is_all_face_flag_test(const BMEdge *e, const char hflag, const bool respect_hide); +bool BM_vert_is_all_edge_flag_test(const BMVert *v, const char hflag, const bool respect_hide) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +bool BM_vert_is_all_face_flag_test(const BMVert *v, const char hflag, const bool respect_hide) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +bool BM_edge_is_all_face_flag_test(const BMEdge *e, const char hflag, const bool respect_hide) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); -bool BM_edge_is_any_vert_flag_test(const BMEdge *e, const char hflag); -bool BM_face_is_any_vert_flag_test(const BMFace *f, const char hflag); -bool BM_face_is_any_edge_flag_test(const BMFace *f, const char hflag); +bool BM_edge_is_any_vert_flag_test(const BMEdge *e, const char hflag) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +bool BM_face_is_any_vert_flag_test(const BMFace *f, const char hflag) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); +bool BM_face_is_any_edge_flag_test(const BMFace *f, const char hflag) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); -bool BM_face_is_normal_valid(const BMFace *f); +bool BM_face_is_normal_valid(const BMFace *f) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); -float BM_mesh_calc_volume(BMesh *bm, bool is_signed); +float BM_mesh_calc_volume(BMesh *bm, bool is_signed) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(); int BM_mesh_calc_face_groups(BMesh *bm, int *r_groups_array, int (**r_group_index)[2], BMElemFilterFunc filter_fn, void *user_data, - const char hflag_test, const char htype_step); + const char hflag_test, const char htype_step) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2, 3); int BM_mesh_calc_edge_groups(BMesh *bm, int *r_groups_array, int (**r_group_index)[2], BMElemFilterFunc filter_fn, void *user_data, - const char hflag_test); + const char hflag_test) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2, 3); /* not really any good place to put this */ -float bmesh_subd_falloff_calc(const int falloff, float val); +float bmesh_subd_falloff_calc(const int falloff, float val) ATTR_WARN_UNUSED_RESULT; #include "bmesh_queries_inline.h" |