#include "MEM_guardedalloc.h"
#include "BLI_utildefines.h"
#include "bmesh.hh"
#include "intern/bmesh_private.hh"

Macros
#define	USE_IMMUTABLE_ASSERT

Functions
int	BM_iter_mesh_count (const char itype, BMesh *bm)

void *	BM_iter_at_index (BMesh bm, const char itype, void data, int index)

int	BM_iter_as_array (BMesh bm, const char itype, void data, void **array, const int len)
	Iterator as Array.

int	BMO_iter_as_array (BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char slot_name, const char restrictmask, void *array, const int len)
	Operator Iterator as Array.

void *	BM_iter_as_arrayN (BMesh bm, const char itype, void data, int r_len, void *stack_array, int stack_array_size)
	Iterator as Array.

void *	BMO_iter_as_arrayN (BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char slot_name, const char restrictmask, int r_len, void **stack_array, int stack_array_size)

int	BM_iter_mesh_bitmap_from_filter (const char itype, BMesh bm, blender::MutableBitSpan bitmap, bool(test_fn)(BMElem , void user_data), void *user_data)

int	BM_iter_mesh_bitmap_from_filter_tessface (BMesh bm, blender::MutableBitSpan bitmap, bool(test_fn)(BMFace , void user_data), void *user_data)

int	BM_iter_elem_count_flag (const char itype, void *data, const char hflag, const bool value)
	Elem Iter Flag Count.

int	BMO_iter_elem_count_flag (BMesh bm, const char itype, void data, const short oflag, const bool value)
	Elem Iter Tool Flag Count.

int	BM_iter_mesh_count_flag (const char itype, BMesh *bm, const char hflag, const bool value)
	Mesh Iter Flag Count.

void	bmiter__elem_of_mesh_begin (BMIter__elem_of_mesh *iter)

void *	bmiter__elem_of_mesh_step (BMIter__elem_of_mesh *iter)

void	bmiter__edge_of_vert_begin (BMIter__edge_of_vert *iter)

void *	bmiter__edge_of_vert_step (BMIter__edge_of_vert *iter)

void	bmiter__face_of_vert_begin (BMIter__face_of_vert *iter)

void *	bmiter__face_of_vert_step (BMIter__face_of_vert *iter)

void	bmiter__loop_of_vert_begin (BMIter__loop_of_vert *iter)

void *	bmiter__loop_of_vert_step (BMIter__loop_of_vert *iter)

void	bmiter__loop_of_edge_begin (BMIter__loop_of_edge *iter)

void *	bmiter__loop_of_edge_step (BMIter__loop_of_edge *iter)

void	bmiter__loop_of_loop_begin (BMIter__loop_of_loop *iter)

void *	bmiter__loop_of_loop_step (BMIter__loop_of_loop *iter)

void	bmiter__face_of_edge_begin (BMIter__face_of_edge *iter)

void *	bmiter__face_of_edge_step (BMIter__face_of_edge *iter)

void	bmiter__vert_of_edge_begin (BMIter__vert_of_edge *iter)

void *	bmiter__vert_of_edge_step (BMIter__vert_of_edge *iter)

void	bmiter__vert_of_face_begin (BMIter__vert_of_face *iter)

void *	bmiter__vert_of_face_step (BMIter__vert_of_face *iter)

void	bmiter__edge_of_face_begin (BMIter__edge_of_face *iter)

void *	bmiter__edge_of_face_step (BMIter__edge_of_face *iter)

void	bmiter__loop_of_face_begin (BMIter__loop_of_face *iter)

void *	bmiter__loop_of_face_step (BMIter__loop_of_face *iter)

Variables
const char	bm_iter_itype_htype_map [BM_ITYPE_MAX]

Detailed Description

Functions to abstract looping over bmesh data structures.

See: bmesh_iterators_inlin.c too, some functions are here for speed reasons.

Definition in file bmesh_iterators.cc.

Macro Definition Documentation

◆ USE_IMMUTABLE_ASSERT

#define USE_IMMUTABLE_ASSERT

Notes on iterator implementation:

Iterators keep track of the next element in a sequence. When a step() callback is invoked the current value of 'next' is stored to be returned later and the next variable is incremented.

When the end of a sequence is reached, next should always equal nullptr

The 'bmiter__' prefix is used because these are used in bmesh_iterators_inine.c but should otherwise be seen as private.

Definition at line 363 of file bmesh_iterators.cc.

Function Documentation

◆ BM_iter_as_array()

int BM_iter_as_array	(	BMesh *	bm,
		char	itype,
		void *	data,
		void **	array,
		int	len )

Iterator as Array.

Sometimes its convenient to get the iterator as an array to avoid multiple calls to BM_iter_at_index.

Definition at line 82 of file bmesh_iterators.cc.

References bm, BM_iter_new, itype, and len.

Referenced by BM_mesh_elem_table_ensure(), bm_vert_dissolve_fan(), edbm_rip_invoke__vert(), blender::bke::pbvh::pbvh_bmesh_edge_loops(), quad_from_tris(), and skin_fix_hole_no_good_verts().

◆ BM_iter_as_arrayN()

void * BM_iter_as_arrayN	(	BMesh *	bm,
		char	itype,
		void *	data,
		int *	r_len,
		void **	stack_array,
		int	stack_array_size )

Iterator as Array.

Allocates a new array, has the advantage that you don't need to know the size ahead of time.

Takes advantage of less common iterator usage to avoid counting twice, which you might end up doing when BM_iter_as_array is used.

Caller needs to free the array.

Definition at line 129 of file bmesh_iterators.cc.

References BLI_assert, bm, BM_EDGES_OF_MESH, BM_FACES_OF_MESH, BM_iter_init, BM_VERTS_OF_MESH, BMIter::count, itype, MEM_mallocN, BMesh::totedge, BMesh::totface, and BMesh::totvert.

Referenced by bevel_rebuild_existing_polygons(), and BM_mesh_decimate_dissolve().

◆ BM_iter_at_index()

void * BM_iter_at_index	(	BMesh *	bm,
		char	itype,
		void *	data,
		int	index )

Note: Use BM_vert_at_index / BM_edge_at_index / BM_face_at_index for mesh arrays.

Definition at line 60 of file bmesh_iterators.cc.

References bm, BM_iter_new, and itype.

Referenced by BM_uv_vert_map_create(), bm_vert_dissolve_fan(), bm_vert_loop_pair(), bpy_bmelemseq_subscript_int(), bridge_loop_pair(), mesh_separate_material(), stitch_init(), and uv_select_flush_from_tag_sticky_loc_internal().

◆ BM_iter_elem_count_flag()

int BM_iter_elem_count_flag	(	char	itype,
		void *	data,
		char	hflag,
		bool	value )

Elem Iter Flag Count.

Counts how many flagged / unflagged items are found in this element.

Definition at line 269 of file bmesh_iterators.cc.

References BM_elem_flag_test_bool, BM_ITER_ELEM, count, and itype.

Referenced by bm_vert_is_select_history_open(), and transform_mesh_edge_slide_data_create().

◆ BM_iter_mesh_bitmap_from_filter()

int BM_iter_mesh_bitmap_from_filter	(	const char	itype,
		BMesh *	bm,
		blender::MutableBitSpan	bitmap,
		bool(*	test_fn )(BMElem , void user_data),
		void *	user_data )

Definition at line 215 of file bmesh_iterators.cc.

References bm, BM_ITER_MESH_INDEX, and itype.

◆ BM_iter_mesh_bitmap_from_filter_tessface()

int BM_iter_mesh_bitmap_from_filter_tessface	(	BMesh *	bm,
		blender::MutableBitSpan	bitmap,
		bool(*	test_fn )(BMFace , void user_data),
		void *	user_data )

Needed when we want to check faces, but return a loop aligned array.

Definition at line 239 of file bmesh_iterators.cc.

References bm, BM_FACES_OF_MESH, BM_ITER_MESH_INDEX, and BMFace::len.

◆ BM_iter_mesh_count()

int BM_iter_mesh_count	(	char	itype,
		BMesh *	bm )

Utility function.

Definition at line 37 of file bmesh_iterators.cc.

References BLI_assert, bm, BM_EDGES_OF_MESH, BM_FACES_OF_MESH, BM_VERTS_OF_MESH, count, itype, BMesh::totedge, BMesh::totface, and BMesh::totvert.

◆ BM_iter_mesh_count_flag()

int BM_iter_mesh_count_flag	(	char	itype,
		BMesh *	bm,
		char	hflag,
		bool	value )

Mesh Iter Flag Count.

Counts how many flagged / unflagged items are found in this mesh.

Definition at line 325 of file bmesh_iterators.cc.

References bm, BM_elem_flag_test_bool, BM_ITER_MESH, count, and itype.

Referenced by bmo_collapse_uvs_exec(), and transform_convert_mesh_connectivity_distance().

◆ bmiter__edge_of_face_begin()

void bmiter__edge_of_face_begin ( BMIter__edge_of_face * iter )

Definition at line 619 of file bmesh_iterators.cc.

References BM_FACE_FIRST_LOOP, BMIter__edge_of_face::l_first, BMIter__edge_of_face::l_next, and BMIter__edge_of_face::pdata.

Referenced by BM_iter_init().

◆ bmiter__edge_of_face_step()

void * bmiter__edge_of_face_step ( BMIter__edge_of_face * iter )

Definition at line 624 of file bmesh_iterators.cc.

References BMLoop::e, BMIter__edge_of_face::l_first, BMIter__edge_of_face::l_next, and BMLoop::next.

Referenced by BM_iter_init().

◆ bmiter__edge_of_vert_begin()

void bmiter__edge_of_vert_begin ( BMIter__edge_of_vert * iter )

Definition at line 390 of file bmesh_iterators.cc.

References BMVert::e, BMIter__edge_of_vert::e_first, BMIter__edge_of_vert::e_next, and BMIter__edge_of_vert::vdata.

Referenced by BM_iter_init().

◆ bmiter__edge_of_vert_step()

void * bmiter__edge_of_vert_step ( BMIter__edge_of_vert * iter )

Definition at line 402 of file bmesh_iterators.cc.

References bmesh_disk_edge_next(), BMIter__edge_of_vert::e_first, BMIter__edge_of_vert::e_next, and BMIter__edge_of_vert::vdata.

Referenced by BM_iter_init().

◆ bmiter__elem_of_mesh_begin()

void bmiter__elem_of_mesh_begin ( BMIter__elem_of_mesh * iter )

Definition at line 366 of file bmesh_iterators.cc.

References BLI_mempool_iternew(), BLI_mempool_len(), BLI_mempool_iter::pool, and BMIter__elem_of_mesh::pooliter.

Referenced by BM_iter_init().

◆ bmiter__elem_of_mesh_step()

void * bmiter__elem_of_mesh_step ( BMIter__elem_of_mesh * iter )

Definition at line 374 of file bmesh_iterators.cc.

References BLI_assert, BLI_mempool_iterstep(), BLI_mempool_len(), count, BLI_mempool_iter::pool, and BMIter__elem_of_mesh::pooliter.

Referenced by BM_iter_init().

◆ bmiter__face_of_edge_begin()

void bmiter__face_of_edge_begin ( BMIter__face_of_edge * iter )

Definition at line 552 of file bmesh_iterators.cc.

References BMIter__face_of_edge::edata, BMEdge::l, BMIter__face_of_edge::l_first, and BMIter__face_of_edge::l_next.

Referenced by BM_iter_init().

◆ bmiter__face_of_edge_step()

void * bmiter__face_of_edge_step ( BMIter__face_of_edge * iter )

Definition at line 557 of file bmesh_iterators.cc.

References BMLoop::f, BMIter__face_of_edge::l_first, BMIter__face_of_edge::l_next, and BMLoop::radial_next.

Referenced by BM_iter_init().

◆ bmiter__face_of_vert_begin()

void bmiter__face_of_vert_begin ( BMIter__face_of_vert * iter )

Definition at line 420 of file bmesh_iterators.cc.

References bmesh_disk_faceloop_find_first(), bmesh_disk_facevert_count(), count, BMLoop::e, BMVert::e, BMIter__face_of_vert::e_first, BMIter__face_of_vert::e_next, BMIter__face_of_vert::l_first, BMIter__face_of_vert::l_next, and BMIter__face_of_vert::vdata.

Referenced by BM_iter_init().

◆ bmiter__face_of_vert_step()

void * bmiter__face_of_vert_step ( BMIter__face_of_vert * iter )

Definition at line 434 of file bmesh_iterators.cc.

References bmesh_disk_faceedge_find_next(), bmesh_radial_faceloop_find_first(), bmesh_radial_faceloop_find_next(), count, BMIter__face_of_vert::e_next, BMLoop::f, BMEdge::l, BMIter__face_of_vert::l_first, BMIter__face_of_vert::l_next, and BMIter__face_of_vert::vdata.

Referenced by BM_iter_init().

◆ bmiter__loop_of_edge_begin()

void bmiter__loop_of_edge_begin ( BMIter__loop_of_edge * iter )

Definition at line 499 of file bmesh_iterators.cc.

References BMIter__loop_of_edge::edata, BMEdge::l, BMIter__loop_of_edge::l_first, and BMIter__loop_of_edge::l_next.

Referenced by BM_iter_init().

◆ bmiter__loop_of_edge_step()

void * bmiter__loop_of_edge_step ( BMIter__loop_of_edge * iter )

Definition at line 504 of file bmesh_iterators.cc.

References BMIter__loop_of_edge::l_first, BMIter__loop_of_edge::l_next, and BMLoop::radial_next.

Referenced by BM_iter_init().

◆ bmiter__loop_of_face_begin()

void bmiter__loop_of_face_begin ( BMIter__loop_of_face * iter )

Definition at line 642 of file bmesh_iterators.cc.

References BM_FACE_FIRST_LOOP, BMIter__loop_of_face::l_first, BMIter__loop_of_face::l_next, and BMIter__loop_of_face::pdata.

Referenced by BM_iter_init().

◆ bmiter__loop_of_face_step()

void * bmiter__loop_of_face_step ( BMIter__loop_of_face * iter )

Definition at line 647 of file bmesh_iterators.cc.

References BMIter__loop_of_face::l_first, BMIter__loop_of_face::l_next, and BMLoop::next.

Referenced by BM_iter_init().

◆ bmiter__loop_of_loop_begin()

void bmiter__loop_of_loop_begin ( BMIter__loop_of_loop * iter )

Definition at line 523 of file bmesh_iterators.cc.

References BMIter__loop_of_loop::l_first, BMIter__loop_of_loop::l_next, BMIter__loop_of_loop::ldata, and BMLoop::radial_next.

Referenced by BM_iter_init().

◆ bmiter__loop_of_loop_step()

void * bmiter__loop_of_loop_step ( BMIter__loop_of_loop * iter )

Definition at line 533 of file bmesh_iterators.cc.

References BMIter__loop_of_loop::l_first, BMIter__loop_of_loop::l_next, and BMLoop::radial_next.

Referenced by BM_iter_init().

◆ bmiter__loop_of_vert_begin()

void bmiter__loop_of_vert_begin ( BMIter__loop_of_vert * iter )

Definition at line 459 of file bmesh_iterators.cc.

References bmesh_disk_faceloop_find_first(), bmesh_disk_facevert_count(), count, BMLoop::e, BMVert::e, BMIter__loop_of_vert::e_first, BMIter__loop_of_vert::e_next, BMIter__loop_of_vert::l_first, BMIter__loop_of_vert::l_next, and BMIter__loop_of_vert::vdata.

Referenced by BM_iter_init().

◆ bmiter__loop_of_vert_step()

void * bmiter__loop_of_vert_step ( BMIter__loop_of_vert * iter )

Definition at line 473 of file bmesh_iterators.cc.

References bmesh_disk_faceedge_find_next(), bmesh_radial_faceloop_find_first(), bmesh_radial_faceloop_find_next(), count, BMIter__loop_of_vert::e_next, BMEdge::l, BMIter__loop_of_vert::l_first, BMIter__loop_of_vert::l_next, and BMIter__loop_of_vert::vdata.

Referenced by BM_iter_init().

◆ bmiter__vert_of_edge_begin()

void bmiter__vert_of_edge_begin ( BMIter__vert_of_edge * iter )

Definition at line 575 of file bmesh_iterators.cc.

Referenced by BM_iter_init().

◆ bmiter__vert_of_edge_step()

void * bmiter__vert_of_edge_step ( BMIter__vert_of_edge * iter )

Definition at line 580 of file bmesh_iterators.cc.

References count, BMIter__vert_of_edge::edata, BMEdge::v1, and BMEdge::v2.

Referenced by BM_iter_init().

◆ bmiter__vert_of_face_begin()

void bmiter__vert_of_face_begin ( BMIter__vert_of_face * iter )

Definition at line 596 of file bmesh_iterators.cc.

References BM_FACE_FIRST_LOOP, BMIter__vert_of_face::l_first, BMIter__vert_of_face::l_next, and BMIter__vert_of_face::pdata.

Referenced by BM_iter_init().

◆ bmiter__vert_of_face_step()

void * bmiter__vert_of_face_step ( BMIter__vert_of_face * iter )

Definition at line 601 of file bmesh_iterators.cc.

References BMIter__vert_of_face::l_first, BMIter__vert_of_face::l_next, BMLoop::next, and BMLoop::v.

Referenced by BM_iter_init().

◆ BMO_iter_as_array()

int BMO_iter_as_array	(	BMOpSlot	slot_args[BMO_OP_MAX_SLOTS],
		const char *	slot_name,
		char	restrictmask,
		void **	array,
		int	len )

Operator Iterator as Array.

Sometimes its convenient to get the iterator as an array.

Definition at line 102 of file bmesh_iterators.cc.

References BMO_iter_new(), BMO_iter_step(), and len.

Referenced by bmo_contextual_create_exec().

◆ BMO_iter_as_arrayN()

void * BMO_iter_as_arrayN	(	BMOpSlot	slot_args[BMO_OP_MAX_SLOTS],
		const char *	slot_name,
		const char	restrictmask,
		int *	r_len,
		void **	stack_array,
		int	stack_array_size )

Definition at line 175 of file bmesh_iterators.cc.

References BLI_assert, BMO_iter_new(), BMO_iter_step(), BMO_slot_buffer_len(), MEM_mallocN, and MEM_reallocN.

◆ BMO_iter_elem_count_flag()

int BMO_iter_elem_count_flag	(	BMesh *	bm,
		char	itype,
		void *	data,
		short	oflag,
		bool	value )

Elem Iter Tool Flag Count.

Counts how many flagged / unflagged items are found in this element.

Definition at line 284 of file bmesh_iterators.cc.

References BLI_assert, bm, BM_EDGE, BM_FACE, BM_ITER_ELEM, bm_iter_itype_htype_map, BM_LOOP, BM_VERT, BMO_edge_flag_test_bool, BMO_face_flag_test_bool, BMO_vert_flag_test_bool, count, itype, and oflag.

Referenced by bmo_contextual_create_exec(), bmo_edgeloop_fill_exec(), and bmo_edgenet_prepare_exec().

Variable Documentation

◆ bm_iter_itype_htype_map

const char bm_iter_itype_htype_map[BM_ITYPE_MAX]

Initial value:

= {
    '\0',
    BM_VERT, 
    BM_EDGE, 
    BM_FACE, 
    BM_EDGE, 
    BM_FACE, 
    BM_LOOP, 
    BM_VERT, 
    BM_FACE, 
    BM_VERT, 
    BM_EDGE, 
    BM_LOOP, 
    BM_LOOP, 
    BM_LOOP, 
}

Definition at line 20 of file bmesh_iterators.cc.

Referenced by BMO_iter_elem_count_flag(), bpy_bmelemseq_ensure_lookup_table(), bpy_bmelemseq_index_update(), bpy_bmelemseq_sort(), bpy_bmelemseq_subscript_int(), and bpy_slot_from_py().

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ USE_IMMUTABLE_ASSERT

Function Documentation

◆ BM_iter_as_array()

◆ BM_iter_as_arrayN()

◆ BM_iter_at_index()

◆ BM_iter_elem_count_flag()

◆ BM_iter_mesh_bitmap_from_filter()

◆ BM_iter_mesh_bitmap_from_filter_tessface()

◆ BM_iter_mesh_count()

◆ BM_iter_mesh_count_flag()

◆ bmiter__edge_of_face_begin()

◆ bmiter__edge_of_face_step()

◆ bmiter__edge_of_vert_begin()

◆ bmiter__edge_of_vert_step()

◆ bmiter__elem_of_mesh_begin()

◆ bmiter__elem_of_mesh_step()

◆ bmiter__face_of_edge_begin()

◆ bmiter__face_of_edge_step()

◆ bmiter__face_of_vert_begin()

◆ bmiter__face_of_vert_step()

◆ bmiter__loop_of_edge_begin()

◆ bmiter__loop_of_edge_step()

◆ bmiter__loop_of_face_begin()

◆ bmiter__loop_of_face_step()

◆ bmiter__loop_of_loop_begin()

◆ bmiter__loop_of_loop_step()

◆ bmiter__loop_of_vert_begin()

◆ bmiter__loop_of_vert_step()

◆ bmiter__vert_of_edge_begin()

◆ bmiter__vert_of_edge_step()

◆ bmiter__vert_of_face_begin()

◆ bmiter__vert_of_face_step()

◆ BMO_iter_as_array()

◆ BMO_iter_as_arrayN()

◆ BMO_iter_elem_count_flag()

Variable Documentation

◆ bm_iter_itype_htype_map