Blender V5.3
bmesh_walkers.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
10
11#include "bmesh_class.hh"
12
13#include "BLI_set.hh"
14
15namespace blender {
16
17/*
18 * NOTE: do NOT modify topology while walking a mesh!
19 */
20
21struct BMwGenericWalker;
22
27
28enum BMWFlag {
31};
32
44
45/*Walkers*/
46struct BMWalker {
47 char begin_htype; /* only for validating input */
48 void (*begin)(struct BMWalker *walker, void *start);
49 void *(*step)(struct BMWalker *walker);
50 void *(*yield)(struct BMWalker *walker);
55
56 /* runtime */
57 int layer;
58
61 ListBaseT<BMwGenericWalker> states;
62
63 /* these masks are to be tested against elements BMO_elem_flag_test(),
64 * should never be accessed directly only through BMW_init() and bmw_mask_check_*() functions */
65 short mask_vert;
66 short mask_edge;
67 short mask_face;
68
71
74 int depth;
75};
76
77/* define to make BMW_init more clear */
78#define BMW_MASK_NOP 0
79
86void BMW_init(struct BMWalker *walker,
87 BMesh *bm,
88 int type,
89 short mask_vert,
90 short mask_edge,
91 short mask_face,
92 BMWFlag flag,
93 int layer,
94 BMWDelimitFlag delimit);
95void *BMW_begin(BMWalker *walker, void *start);
99void *BMW_step(struct BMWalker *walker);
105void BMW_end(struct BMWalker *walker);
111int BMW_current_depth(BMWalker *walker);
112
113/* These are used by custom walkers. */
121void *BMW_current_state(BMWalker *walker);
131void *BMW_state_add(BMWalker *walker);
138void BMW_state_remove(BMWalker *walker);
144void *BMW_walk(BMWalker *walker);
151void BMW_reset(BMWalker *walker);
152
153#define BMW_ITER(ele, walker, data) \
154 for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BMW_begin(walker, (BM_CHECK_TYPE_ELEM(data), data)); ele; \
155 BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BMW_step(walker))
156
157/*
158 * example of usage, walking over an island of tool flagged faces:
159 *
160 * BMWalker walker;
161 * BMFace *f;
162 *
163 * BMW_init(&walker, bm, BMW_ISLAND, SOME_OP_FLAG);
164 *
165 * for (f = BMW_begin(&walker, some_start_face); f; f = BMW_step(&walker)) {
166 * // do something with f
167 * }
168 * BMW_end(&walker);
169 */
170
171enum {
181 /* BMW_RING, */
187 /* End of array index enum values. */
188
189 /* Do not initialize function pointers and struct size in #BMW_init. */
192};
193
194/* use with BMW_init, so as not to confuse with restrict flags */
195#define BMW_NIL_LAY 0
196
197} // namespace blender
#define ENUM_OPERATORS(_enum_type)
#define layer
BMesh Iterators.
@ BMW_FLAG_TEST_HIDDEN
void BMW_state_remove(BMWalker *walker)
Remove Current Walker State.
void * BMW_begin(BMWalker *walker, void *start)
@ BMW_CONNECTED_VERTEX
@ BMW_LOOP_SHELL_WIRE
@ BMW_LOOPDATA_ISLAND
@ BMW_EDGELOOP_NONMANIFOLD
@ BMW_ISLAND_MANIFOLD
void BMW_init(BMWalker *walker, BMesh *bm, int type, short mask_vert, short mask_edge, short mask_face, BMWFlag flag, int layer, BMWDelimitFlag delimit)
Initialize Walker.
@ BMW_BREADTH_FIRST
void * BMW_state_add(BMWalker *walker)
Add a new Walker State.
void * BMW_current_state(BMWalker *walker)
Current Walker State.
void BMW_end(BMWalker *walker)
End Walker.
int BMW_current_depth(BMWalker *walker)
Walker Current Depth.
void BMW_reset(BMWalker *walker)
Reset Walker.
void * BMW_step(BMWalker *walker)
Step Walker.
@ BMW_DELIMIT_EDGE_LOOP_OUTER_CORNERS
@ BMW_DELIMIT_EDGE_MARK_SHARP
@ BMW_DELIMIT_EDGE_LOOP_INNER_CORNERS
@ BMW_DELIMIT_EDGE_LOOP_NGONS
@ BMW_DELIMIT_FACE_MARK_MATERIAL
@ BMW_DELIMIT_EDGE_MARK_SEAM
@ BMW_DELIMIT_EDGE_RING_NGONS
void * BMW_walk(BMWalker *walker)
Main Walking Function.
void(*) begin(struct BMWalker *walker, void *start)
Set< const void * > * visit_set
BMWDelimitFlag delimit
ListBaseT< BMwGenericWalker > states
Set< const void * > * visit_set_alt
BLI_mempool * worklist
BMWDelimitFlag delimit_supported