bmesh_core.hh File Reference

#include "BKE_customdata.hh"
#include "bmesh_class.hh"

Go to the source code of this file.

Enumerations
enum	eBMCreateFlag { BM_CREATE_NOP = 0 , BM_CREATE_NO_DOUBLE = (1 << 1) , BM_CREATE_SKIP_CD = (1 << 2) }

Functions
BMFace *	BM_face_copy (BMesh *bm, const BMCustomDataCopyMap &cd_face_map, const BMCustomDataCopyMap &cd_loop_map, BMFace *f, bool copy_verts, bool copy_edges)
BMFace *	BM_face_copy (BMesh *bm, BMFace *f, bool copy_verts, bool copy_edges)
BMVert *	BM_vert_create (BMesh *bm, const float co[3], const BMVert *v_example, eBMCreateFlag create_flag)
	Main function for creating a new vertex.
BMEdge *	BM_edge_create (BMesh *bm, BMVert *v1, BMVert *v2, const BMEdge *e_example, eBMCreateFlag create_flag)
	Main function for creating a new edge.
BMFace *	BM_face_create (BMesh *bm, BMVert *const *verts, BMEdge *const *edges, int len, const BMFace *f_example, eBMCreateFlag create_flag)
BMFace *	BM_face_create_verts (BMesh *bm, BMVert **vert_arr, int len, const BMFace *f_example, eBMCreateFlag create_flag, bool create_edges)
void	BM_face_edges_kill (BMesh *bm, BMFace *f)
void	BM_face_verts_kill (BMesh *bm, BMFace *f)
void	BM_face_kill_loose (BMesh *bm, BMFace *f)
void	BM_face_kill (BMesh *bm, BMFace *f)
void	BM_edge_kill (BMesh *bm, BMEdge *e)
void	BM_vert_kill (BMesh *bm, BMVert *v)
bool	BM_edge_splice (BMesh *bm, BMEdge *e_dst, BMEdge *e_src)
	Splice Edge.
bool	BM_vert_splice (BMesh *bm, BMVert *v_dst, BMVert *v_src)
	Splice Vert.
bool	BM_vert_splice_check_double (BMVert *v_a, BMVert *v_b)
void	bmesh_kernel_loop_reverse (BMesh *bm, BMFace *f, int cd_loop_mdisp_offset, bool use_loop_mdisp_flip)
	Loop Reverse.
void	bmesh_face_swap_data (BMFace *f_a, BMFace *f_b)
BMFace *	BM_faces_join (BMesh *bm, BMFace **faces, int totface, bool do_del, BMFace **r_double)
	Join Connected Faces.
void	BM_vert_separate (BMesh *bm, BMVert *v, BMEdge **e_in, int e_in_len, bool copy_select, BMVert ***r_vout, int *r_vout_len)
void	BM_vert_separate_hflag (BMesh *bm, BMVert *v, char hflag, bool copy_select, BMVert ***r_vout, int *r_vout_len)
void	BM_vert_separate_tested_edges (BMesh *bm, BMVert *v_dst, BMVert *v_src, bool(*testfn)(BMEdge *, void *arg), void *arg)
void	bmesh_kernel_vert_separate (BMesh *bm, BMVert *v, BMVert ***r_vout, int *r_vout_len, bool copy_select)
	Separate Vert.
void	bmesh_kernel_edge_separate (BMesh *bm, BMEdge *e, BMLoop *l_sep, bool copy_select)
	Separate Edge.
BMFace *	bmesh_kernel_split_face_make_edge (BMesh *bm, BMFace *f, BMLoop *l_v1, BMLoop *l_v2, BMLoop **r_l, BMEdge *example, bool no_double)
	Split Face Make Edge (SFME).
BMVert *	bmesh_kernel_split_edge_make_vert (BMesh *bm, BMVert *tv, BMEdge *e, BMEdge **r_e)
	Split Edge Make Vert (SEMV).
BMEdge *	bmesh_kernel_join_edge_kill_vert (BMesh *bm, BMEdge *e_kill, BMVert *v_kill, bool do_del, bool check_edge_exists, bool kill_degenerate_faces, bool kill_duplicate_faces)
	Join Edge Kill Vert (JEKV).
BMVert *	bmesh_kernel_join_vert_kill_edge (BMesh *bm, BMEdge *e_kill, BMVert *v_kill, bool do_del, bool check_edge_exists, bool kill_degenerate_faces)
	Join Vert Kill Edge (JVKE).
BMFace *	bmesh_kernel_join_face_kill_edge (BMesh *bm, BMFace *f1, BMFace *f2, BMEdge *e)
	Join Face Kill Edge (JFKE).
BMVert *	bmesh_kernel_unglue_region_make_vert (BMesh *bm, BMLoop *l_sep)
	Un-glue Region Make Vert (URMV).
BMVert *	bmesh_kernel_unglue_region_make_vert_multi (BMesh *bm, BMLoop **larr, int larr_len)
BMVert *	bmesh_kernel_unglue_region_make_vert_multi_isolated (BMesh *bm, BMLoop *l_sep)

Enumeration Type Documentation

eBMCreateFlag

enum eBMCreateFlag

Enumerator
BM_CREATE_NOP
BM_CREATE_NO_DOUBLE	Faces and edges only.
BM_CREATE_SKIP_CD	Skip custom-data - for all element types data, use if we immediately write custom-data into the element so this skips copying from 'example' arguments or setting defaults, speeds up conversion when data is converted all at once.

Definition at line 27 of file bmesh_core.hh.

Function Documentation

BM_edge_create()

BMEdge * BM_edge_create	(	BMesh *	bm,
		BMVert *	v1,
		BMVert *	v2,
		const BMEdge *	e_example,
		eBMCreateFlag	create_flag )

Main function for creating a new edge.

Note

Duplicate edges are supported by the API however users should never see them. so unless you need a unique edge or know the edge won't exist, you should call with no_double = true.

Definition at line 124 of file bmesh_core.cc.

References BLI_assert, BLI_mempool_alloc(), BLI_mempool_calloc(), bm, BM_CHECK_ELEMENT, BM_CREATE_NO_DOUBLE, BM_CREATE_SKIP_CD, BM_EDGE, BM_edge_exists(), BM_elem_attrs_copy(), BM_elem_index_set, BM_ELEM_SMOOTH, BM_SPACEARR_DIRTY_ALL, BM_VERT, bmesh_disk_edge_append(), CustomData_bmesh_set_default(), e, BMEdge::head, BMVert::head, BMHeader::htype, and v2.

Referenced by bevel_reattach_wires(), bevel_vert_two_edges(), BKE_mesh_remesh_voxel_fix_poles(), bm_edge_copy_with_arrays(), BM_edge_rotate(), blender::bke::pbvh::bm_edges_from_tri(), BM_edges_from_verts_ensure(), bm_face_copy_impl(), BM_face_create_ngon_verts(), BM_face_split_edgenet_connect_islands(), bm_isect_tri_tri(), BM_mesh_bm_from_me(), BM_mesh_copy(), BM_mesh_intersect_edges(), bm_vert_connect_select_history(), bmesh_kernel_edge_separate(), bmesh_kernel_split_edge_make_vert(), bmesh_kernel_split_face_make_edge(), bmesh_kernel_unglue_region_make_vert_multi(), bmo_contextual_create_exec(), bmo_create_circle_exec(), bmo_create_uvsphere_exec(), bmo_edge_copy(), bmo_edgenet_prepare_exec(), bmo_extrude_face_region_exec(), bmo_extrude_vert_indiv_exec(), bmo_face_inset_individual(), bmo_inset_region_exec(), bmo_weld_verts_exec(), bpy_bmedgeseq_new(), edbm_polybuild_face_at_cursor_invoke(), edbm_rip_invoke__vert(), knife_make_face_cuts(), and blender::bke::pbvh::pbvh_bmesh_split_edge().

BM_edge_kill()

void BM_edge_kill	(	BMesh *	bm,
		BMEdge *	e )

Kills e and all faces that use it.

Definition at line 965 of file bmesh_core.cc.

References bm, BM_face_kill(), bm_kill_only_edge(), bmesh_disk_edge_remove(), and e.

Referenced by bm_decim_triangulate_end(), bm_edge_collapse(), BM_edge_splice(), BM_face_edges_kill(), bm_face_split(), BM_face_split_edgenet_connect_islands(), BM_faces_join(), bm_log_faces_unmake(), BM_mesh_decimate_dissolve_ex(), BM_mesh_intersect(), bm_remove_tagged_edges(), BM_vert_kill(), bmesh_kernel_join_vert_kill_edge(), bmo_dissolve_edges_exec(), bmo_dissolve_verts_exec(), bmo_extrude_face_region_exec(), bmo_remove_tagged_edges(), bmo_triangle_fill_exec(), bpy_bmedgeseq_remove(), knife_make_face_cuts(), blender::bke::pbvh::pbvh_bmesh_collapse_edge(), and blender::bke::pbvh::pbvh_bmesh_split_edge().

BM_edge_splice()

bool BM_edge_splice	(	BMesh *	bm,
		BMEdge *	e_dst,
		BMEdge *	e_src )

Splice Edge.

Splice two unique edges which share the same two vertices into one edge. (e_src into e_dst, removing e_src).

Returns

Success

Note

Edges must already have the same vertices.

Definition at line 2396 of file bmesh_core.cc.

References BLI_assert, bm, BM_CHECK_ELEMENT, BM_edge_kill(), BM_vert_in_edge(), bmesh_radial_length(), bmesh_radial_loop_append(), bmesh_radial_loop_remove(), BMEdge::l, l, BMEdge::v1, and BMEdge::v2.

Referenced by bm_edge_collapse(), bmesh_kernel_join_edge_kill_vert(), bmesh_kernel_join_vert_kill_edge(), bmesh_kernel_vert_separate__cleanup(), and bmo_spin_exec().

BM_face_copy() [1/2]

BMFace * BM_face_copy	(	BMesh *	bm,
		BMFace *	f,
		bool	copy_verts,
		bool	copy_edges )

Definition at line 355 of file bmesh_core.cc.

References BM_elem_attrs_copy(), bm_face_copy_impl(), BM_FACE_FIRST_LOOP, and BMLoop::next.

BM_face_copy() [2/2]

BMFace * BM_face_copy	(	BMesh *	bm,
		const BMCustomDataCopyMap &	cd_face_map,
		const BMCustomDataCopyMap &	cd_loop_map,
		BMFace *	f,
		bool	copy_verts,
		bool	copy_edges )

When copying between different BMesh objects, copy_verts & copy_edges should always be true.

Definition at line 333 of file bmesh_core.cc.

References BM_elem_attrs_copy(), bm_face_copy_impl(), BM_FACE_FIRST_LOOP, and BMLoop::next.

Referenced by BM_edge_split(), BM_face_split(), BM_face_split_n(), bmo_extrude_discrete_faces_exec(), bpy_bmface_copy(), blender::ed::transform::mesh_customdatacorrect_face_substitute_set(), and blender::ed::transform::mesh_customdatacorrect_init_vert().

BM_face_create()

BMFace * BM_face_create	(	BMesh *	bm,
		BMVert *const *	verts,
		BMEdge *const *	edges,
		int	len,
		const BMFace *	f_example,
		eBMCreateFlag	create_flag )

Main face creation function

Parameters

bm	The mesh
verts	A sorted array of verts size of len
edges	A sorted array of edges size of len
len	Length of the face
create_flag	Options for creating the face

Definition at line 427 of file bmesh_core.cc.

References BLI_assert, bm, BM_CHECK_ELEMENT, BM_CREATE_NO_DOUBLE, BM_CREATE_SKIP_CD, BM_elem_attrs_copy(), BM_FACE, bm_face_boundary_add(), bm_face_create__internal(), BM_face_exists(), bm_loop_create(), bmesh_radial_loop_append(), copy_v3_v3(), CustomData_bmesh_set_default(), BMHeader::data, BMFace::head, BMHeader::htype, i, l, BMFace::len, len, BMLoop::next, BMFace::no, BMLoop::prev, verts, and zero_v3().

Referenced by bm_edgenet_face_from_path(), bm_face_copy_impl(), bm_face_copy_with_arrays(), bm_face_create_from_mpoly(), BM_face_create_ngon(), BM_face_create_verts(), bm_mesh_copy_new_face(), bmo_extrude_face_region_exec(), bmo_face_copy(), blender::bke::pbvh::pbvh_bmesh_face_create(), and remdoubles_createface().

BM_face_create_verts()

BMFace * BM_face_create_verts	(	BMesh *	bm,
		BMVert **	vert_arr,
		int	len,
		const BMFace *	f_example,
		eBMCreateFlag	create_flag,
		bool	create_edges )

Wrapper for BM_face_create when you don't have an edge array

Definition at line 496 of file bmesh_core.cc.

References BLI_array_alloca, bm, BM_edges_from_verts(), BM_edges_from_verts_ensure(), BM_face_create(), and len.

Referenced by add_poly(), bev_create_ngon(), BM_face_create_quad_tri(), BM_face_split_edgenet(), BM_face_triangulate(), bm_log_faces_restore(), bmo_create_cube_exec(), bmo_create_grid_exec(), bmo_extrude_edge_only_exec(), bmo_extrude_face_region_exec(), bmo_inset_region_exec(), bpy_bmfaceseq_new(), bridge_loop_pair(), edbm_polybuild_face_at_cursor_invoke(), and edbm_tagged_loop_pairs_do_fill_faces().

BM_face_edges_kill()

void BM_face_edges_kill	(	BMesh *	bm,
		BMFace *	f )

Kills all edges associated with f, along with any other faces containing those edges.

Definition at line 832 of file bmesh_core.cc.

References BLI_array_alloca, bm, BM_edge_kill(), BM_FACE_FIRST_LOOP, BMLoop::e, i, BMFace::len, and BMLoop::next.

BM_face_kill()

void BM_face_kill	(	BMesh *	bm,
		BMFace *	f )

Kills f and its loops.

Definition at line 866 of file bmesh_core.cc.

References BLI_mempool_free(), bm, BM_CHECK_ELEMENT, bm_kill_only_face(), bm_kill_only_loop(), bmesh_radial_loop_remove(), BMLoop::e, BMFace::l_first, BMFace::len, and BMLoop::next.

Referenced by BKE_mesh_remesh_voxel_fix_poles(), bm_decim_triangulate_begin(), BM_edge_kill(), bm_face_connect_verts(), BM_face_split(), bm_face_split_by_concave(), BM_face_split_edgenet(), BM_face_triangulate(), BM_faces_join(), bm_log_faces_unmake(), BM_mesh_bevel(), BM_mesh_triangulate(), bm_remove_tagged_faces(), bmesh_kernel_join_edge_kill_vert(), bmesh_kernel_join_vert_kill_edge(), bmo_dissolve_faces_exec(), bmo_holes_fill_exec(), bmo_poke_exec(), bmo_remove_tagged_faces(), bmo_spin_exec(), bmo_weld_verts_exec(), bpy_bmfaceseq_remove(), edbm_quads_convert_to_tris_exec(), blender::bke::pbvh::pbvh_bmesh_collapse_edge(), blender::bke::pbvh::pbvh_bmesh_split_edge(), and skin_fix_hole_no_good_verts().

BM_face_kill_loose()

void BM_face_kill_loose	(	BMesh *	bm,
		BMFace *	f )

A version of BM_face_kill which removes edges and verts which have no remaining connected geometry.

Definition at line 910 of file bmesh_core.cc.

References BLI_mempool_free(), bm, BM_CHECK_ELEMENT, bm_kill_only_edge(), bm_kill_only_face(), bm_kill_only_loop(), bm_kill_only_vert(), bmesh_disk_edge_remove(), bmesh_radial_loop_remove(), BMLoop::e, BMVert::e, e, BMFace::l_first, BMLoop::next, and v2.

Referenced by BM_mesh_intersect().

BM_face_verts_kill()

void BM_face_verts_kill	(	BMesh *	bm,
		BMFace *	f )

kills all verts associated with f, along with any other faces containing those vertices

Definition at line 849 of file bmesh_core.cc.

References BLI_array_alloca, bm, BM_FACE_FIRST_LOOP, BM_vert_kill(), i, BMFace::len, BMLoop::next, BMLoop::v, and verts.

Referenced by BM_edge_split(), and BM_face_split_n().

BM_faces_join()

BMFace * BM_faces_join	(	BMesh *	bm,
		BMFace **	faces,
		int	totface,
		bool	do_del,
		BMFace **	r_double )

Join Connected Faces.

Joins a collected group of faces into one. Only restriction on the input data is that the faces must be connected to each other.

Returns

The newly created combine BMFace.

Note

If a pair of faces share multiple edges, the pair of faces will be joined at every edge.

Parameters

bm	The bmesh.
faces	An array of faces to join.
totfaces	The length of the face array to join.
do_del	if true, remove the original faces, internal edges, and internal verts such that they are replaced by the new face.
r_double	A pointer to a BMFace* that is controls processing of doubled faces. When r_double is nullptr: If a new face would be made which would double an existing face, then instead of creating a new face, the existing face will be reused and returned instead. The calling function must not make ANY assumption about whether the returned BMFace* is new, or a reused face that may already have set header flags, contain custom data, etc. When r_double is a pointer to a BMFace*: If the new join face is not a double of an existing face, then r_double is set to nullptr. If the new join face doubles an existing face, then r_double is set to the existing face, and the return value is the newly created face. The double will NOT be removed, meaning the BMesh is in an invalid state, and the calling function must fix that inconsistency. If an error occurs and nullptr is returned, r_double will be set to nullptr as well.

Note

this is a generic, flexible join faces function, almost everything uses this, including BM_faces_join_pair

On callers asserting when *r_double != nullptr. For some callers the existing algorithm does not check for or handle double faces. This can result in invalid meshes being returned. The returned value in r_double should be examined and if found, the algorithm should be adjusted. Until this is changed, at least warn. This comment can be removed when all callers handle this case.

Definition at line 1161 of file bmesh_core.cc.

References _FLAG_JF, blender::Vector< T, InlineBufferCapacity, Allocator >::append(), BLI_addtail(), BLI_array_alloca, BLI_assert, BLI_movelisttolist(), BLI_remlink(), bm, BM_CHECK_ELEMENT, BM_CREATE_NOP, BM_edge_face_count_is_over, BM_edge_kill(), BM_edge_other_vert(), BM_ELEM_API_FLAG_DISABLE, BM_ELEM_API_FLAG_ENABLE, BM_ELEM_API_FLAG_TEST, BM_elem_attrs_copy(), bm_elements_systag_disable(), bm_elements_systag_enable(), BM_face_calc_center_median(), BM_face_create_ngon(), BM_face_find_double(), BM_FACE_FIRST_LOOP, BM_face_kill(), BM_loop_interp_multires_ex(), bm_loop_systag_count_radial(), bm_vert_is_manifold_flagged(), BM_vert_kill(), BMESH_ASSERT, CD_MDISPS, CustomData_get_offset(), blender::Vector< T, InlineBufferCapacity, Allocator >::data(), BMLoop::e, BMLoop::f, faces, float, i, blender::Vector< T, InlineBufferCapacity, Allocator >::is_empty(), LIKELY, BMLoop::next, BMLoop::radial_next, blender::Vector< T, InlineBufferCapacity, Allocator >::size(), UNLIKELY, BMLoop::v, BMEdge::v1, BMEdge::v2, and v2.

Referenced by bm_decim_triangulate_end(), bm_face_split_by_concave(), bm_face_split_by_edges_island_connect(), BM_faces_join_pair(), BM_vert_collapse_faces(), bmo_dissolve_faces_exec(), and bpy_bm_utils_face_join().

BM_vert_create()

BMVert * BM_vert_create	(	BMesh *	bm,
		const float	co[3],
		const BMVert *	v_example,
		eBMCreateFlag	create_flag )

Main function for creating a new vertex.

Definition at line 41 of file bmesh_core.cc.

References BLI_assert, BLI_mempool_alloc(), BLI_mempool_calloc(), bm, BM_CHECK_ELEMENT, BM_CREATE_NO_DOUBLE, BM_CREATE_SKIP_CD, BM_elem_attrs_copy(), BM_elem_index_set, BM_SPACEARR_DIRTY_ALL, BM_VERT, CD_SHAPE_KEYINDEX, copy_v3_v3(), CustomData_bmesh_get(), CustomData_bmesh_set_default(), BMVert::head, BMHeader::htype, BMVert::no, ORIGINDEX_NONE, v, and zero_v3().

Referenced by bm_face_copy_impl(), bm_face_split_edgenet_partial_connect(), bm_grid_fill_array(), bm_isect_edge_tri(), bm_log_verts_restore(), BM_mesh_bm_from_me(), BM_mesh_copy(), BM_mesh_wireframe(), bm_vert_copy(), bmesh_kernel_split_edge_make_vert(), bmesh_kernel_unglue_region_make_vert(), bmesh_kernel_unglue_region_make_vert_multi(), bmesh_kernel_unglue_region_make_vert_multi_isolated(), bmesh_kernel_vert_separate(), bmo_create_circle_exec(), bmo_create_cone_exec(), bmo_create_cube_exec(), bmo_create_grid_exec(), bmo_create_icosphere_exec(), bmo_create_monkey_exec(), bmo_create_uvsphere_exec(), bmo_create_vert_exec(), bmo_extrude_vert_indiv_exec(), bmo_face_inset_individual(), bmo_inset_region_exec(), bmo_poke_exec(), bmo_vert_copy(), bpy_bmvertseq_new(), create_mesh_bmvert(), edbm_polybuild_face_at_cursor_invoke(), knife_make_face_cuts(), output_frames(), blender::bke::pbvh::pbvh_bmesh_vert_create(), skin_hole_detach_partially_attached_frame(), and TEST().

BM_vert_kill()

void BM_vert_kill	(	BMesh *	bm,
		BMVert *	v )

Kills v and all edges that use it.

Definition at line 977 of file bmesh_core.cc.

References bm, BM_edge_kill(), bm_kill_only_vert(), and v.

Referenced by BKE_mesh_mirror_bisect_on_mirror_plane_for_modifier(), bm_face_split_edgenet_partial_connect(), BM_face_verts_kill(), BM_faces_join(), bm_log_verts_unmake(), BM_mesh_bevel(), BM_mesh_decimate_dissolve_ex(), BM_mesh_intersect(), BM_mesh_wireframe(), bm_remove_tagged_verts(), bm_remove_tagged_verts_loose(), BM_vert_dissolve(), BM_vert_splice(), bmo_bisect_plane_exec(), bmo_create_cone_exec(), bmo_dissolve_edges_exec(), bmo_dissolve_verts_exec(), bmo_extrude_face_region_exec(), bmo_remove_tagged_verts(), bmo_remove_tagged_verts_loose(), bpy_bmvertseq_remove(), mesh_separate_arrays(), and blender::bke::pbvh::pbvh_bmesh_collapse_edge().

BM_vert_separate()

void BM_vert_separate	(	BMesh *	bm,
		BMVert *	v,
		BMEdge **	e_in,
		int	e_in_len,
		bool	copy_select,
		BMVert ***	r_vout,
		int *	r_vout_len )

High level function which wraps both bmesh_kernel_vert_separate and bmesh_kernel_edge_separate

Definition at line 2301 of file bmesh_core.cc.

References BLI_assert, BLI_linklist_prepend_alloca, bm, bm_edge_supports_separate(), bmesh_kernel_edge_separate(), bmesh_kernel_vert_separate(), bmesh_kernel_vert_separate__cleanup(), BMLoop::e, e, i, and v.

Referenced by bpy_bm_utils_vert_separate(), and edbm_edge_split_selected_verts().

BM_vert_separate_hflag()

void BM_vert_separate_hflag	(	BMesh *	bm,
		BMVert *	v,
		char	hflag,
		bool	copy_select,
		BMVert ***	r_vout,
		int *	r_vout_len )

A version of BM_vert_separate which takes a flag.

Definition at line 2334 of file bmesh_core.cc.

References BLI_assert, BLI_linklist_prepend_alloca, bm, BM_DISK_EDGE_NEXT, bm_edge_supports_separate(), BM_elem_flag_test, bmesh_kernel_edge_separate(), bmesh_kernel_vert_separate(), bmesh_kernel_vert_separate__cleanup(), BMLoop::e, e, and v.

Referenced by BM_mesh_edgesplit().

BM_vert_separate_tested_edges()

void BM_vert_separate_tested_edges	(	BMesh *	bm,
		BMVert *	v_dst,
		BMVert *	v_src,
		bool(*	testfn )(BMEdge *, void *arg),
		void *	arg )

Definition at line 2373 of file bmesh_core.cc.

References BLI_linklist_prepend_alloca, BM_DISK_EDGE_NEXT, bmesh_disk_vert_replace(), BMVert::e, LinkNode::link, and LinkNode::next.

Referenced by bm_face_split_edgenet_partial_connect().

BM_vert_splice()

bool BM_vert_splice	(	BMesh *	bm,
		BMVert *	v_dst,
		BMVert *	v_src )

Splice Vert.

Merges two verts into one (v_src into v_dst, removing v_src).

Returns

Success

Warning

This doesn't work for collapsing edges, where v and vtarget are connected by an edge (assert checks for this case).

Definition at line 2113 of file bmesh_core.cc.

References BLI_assert, bm, BM_CHECK_ELEMENT, BM_vert_kill(), BM_vert_pair_share_face_check(), bmesh_edge_vert_swap(), BMVert::e, and e.

Referenced by bm_edge_collapse(), BM_face_split_edgenet_connect_islands(), BM_mesh_intersect(), bmo_inset_region_exec(), bmo_spin_exec(), bpy_bm_utils_vert_splice(), edbm_face_split_by_edges_exec(), and edbm_rip_invoke__vert().

BM_vert_splice_check_double()

bool BM_vert_splice_check_double	(	BMVert *	v_a,
		BMVert *	v_b )

Check if splicing vertices would create any double edges.

Note

assume caller will handle case where verts share an edge.

Definition at line 2070 of file bmesh_core.cc.

References BLI_assert, BM_DISK_EDGE_NEXT, BM_edge_exists(), BM_edge_other_vert(), BM_ELEM_API_FLAG_DISABLE, BM_ELEM_API_FLAG_ENABLE, BM_ELEM_API_FLAG_TEST, BMVert::e, e, and VERT_VISIT.

Referenced by BM_mesh_intersect().

bmesh_face_swap_data()

void bmesh_face_swap_data	(	BMFace *	f_a,
		BMFace *	f_b )

Avoid calling this where possible, low level function so both face pointers remain intact but point to swapped data.

Note

must be from the same bmesh.

Definition at line 2715 of file bmesh_core.cc.

References BLI_assert, BM_FACE_FIRST_LOOP, BMHeader::data, BMLoop::f, BMFace::head, BMHeader::index, and BMLoop::next.

Referenced by BM_face_split_edgenet(), BM_face_triangulate(), and bmo_weld_verts_exec().

bmesh_kernel_edge_separate()

void bmesh_kernel_edge_separate	(	BMesh *	bm,
		BMEdge *	e,
		BMLoop *	l_sep,
		bool	copy_select )

Separate Edge.

Separates a single edge into two edge: the original edge and a new edge that has only l_sep in its radial.

Returns

Success

Note

Does nothing if l_sep is already the only loop in the edge radial.

Definition at line 2429 of file bmesh_core.cc.

References BLI_assert, bm, BM_CHECK_ELEMENT, BM_CREATE_NOP, BM_edge_create(), BM_edge_is_boundary(), BM_elem_select_copy(), bmesh_radial_length(), bmesh_radial_loop_append(), bmesh_radial_loop_remove(), BMLoop::e, e, BMEdge::l, and BMLoop::radial_next.

Referenced by BM_vert_separate(), BM_vert_separate_hflag(), bmesh_kernel_unglue_region_make_vert(), and bmo_inset_region_exec().

bmesh_kernel_join_edge_kill_vert()

BMEdge * bmesh_kernel_join_edge_kill_vert	(	BMesh *	bm,
		BMEdge *	e_kill,
		BMVert *	v_kill,
		bool	do_del,
		bool	check_edge_exists,
		bool	kill_degenerate_faces,
		bool	kill_duplicate_faces )

Join Edge Kill Vert (JEKV).

Takes an edge e_kill and pointer to one of its vertices v_kill and collapses the edge on that vertex.

Examples:

    Before:    e_old  e_kill
             +-------+-------+
             |       |       |
             v_old   v_kill  v_target

    After:           e_old
             +---------------+
             |               |
             v_old           v_target

Restrictions:

KV is a vertex that must have a valance of exactly two. Furthermore both edges in KV's disk cycle (OE and KE) must be unique (no double edges).

Returns

The resulting edge, NULL for failure.

Note

This euler has the possibility of creating faces with just 2 edges. It is up to the caller to decide what to do with these faces.

Definition at line 1697 of file bmesh_core.cc.

References BLI_assert, BLI_SMALLSTACK_DECLARE, BLI_SMALLSTACK_POP, BLI_SMALLSTACK_PUSH, bm, BM_CHECK_ELEMENT, BM_edge_exists(), BM_edge_other_vert(), BM_edge_splice(), BM_face_find_double(), BM_FACE_FIRST_LOOP, BM_face_kill(), bm_kill_only_edge(), bm_kill_only_loop(), bm_kill_only_vert(), BM_vert_in_edge(), BM_verts_in_edge(), BMESH_ASSERT, bmesh_disk_count(), bmesh_disk_count_at_most(), bmesh_disk_edge_next(), bmesh_disk_edge_remove(), bmesh_disk_validate(), bmesh_disk_vert_replace(), bmesh_loop_validate(), bmesh_radial_length(), bmesh_radial_validate(), BMVert::e, BMLoop::f, i, BMEdge::l, l, BMFace::len, BMLoop::next, BMLoop::prev, BMLoop::radial_next, and BMLoop::v.

Referenced by BM_vert_collapse_edge(), BM_vert_collapse_faces(), and bmo_offset_edgeloops_exec().

bmesh_kernel_join_face_kill_edge()

BMFace * bmesh_kernel_join_face_kill_edge	(	BMesh *	bm,
		BMFace *	f1,
		BMFace *	f2,
		BMEdge *	e )

Join Face Kill Edge (JFKE).

Takes two faces joined by a single 2-manifold edge and fuses them together. The edge shared by the faces must not be connected to any other edges which have Both faces in its radial cycle

Examples:

          A                   B
     +--------+           +--------+
     |        |           |        |
     |   f1   |           |   f1   |
    v1========v2 = Ok!    v1==V2==v3 == Wrong!
     |   f2   |           |   f2   |
     |        |           |        |
     +--------+           +--------+

In the example A, faces f1 and f2 are joined by a single edge, and the euler can safely be used. In example B however, f1 and f2 are joined by multiple edges and will produce an error. The caller in this case should call bmesh_kernel_join_edge_kill_vert on the extra edges before attempting to fuse f1 and f2.

Note

The order of arguments decides whether or not certain per-face attributes are present in the resultant face. For instance vertex winding, material index, smooth flags, etc are inherited from f1, not f2.

Returns

A BMFace pointer

Definition at line 1947 of file bmesh_core.cc.

References BLI_mempool_free(), bm, BM_CHECK_ELEMENT, BM_EDGE, BM_edge_in_face(), BM_edge_is_manifold(), BM_elem_flag_disable, BM_elem_flag_set, BM_elem_flag_test, BM_ELEM_INTERNAL_TAG, BM_FACE, BM_face_edge_share_loop(), BM_FACE_FIRST_LOOP, BM_face_share_edge_count(), BM_LOOP, BMESH_ASSERT, bmesh_disk_edge_remove(), bmesh_loop_validate(), BMLoop::e, e, BMLoop::f, i, BMFace::len, BMLoop::next, BMLoop::prev, BMLoop::v, BMEdge::v1, and BMEdge::v2.

Referenced by bmo_extrude_face_region_exec().

bmesh_kernel_join_vert_kill_edge()

BMVert * bmesh_kernel_join_vert_kill_edge	(	BMesh *	bm,
		BMEdge *	e_kill,
		BMVert *	v_kill,
		bool	do_del,
		bool	check_edge_exists,
		bool	kill_degenerate_faces )

Join Vert Kill Edge (JVKE).

Collapse an edge, merging surrounding data.

Unlike BM_vert_collapse_edge & bmesh_kernel_join_edge_kill_vert which only handle 2 valence verts, this can handle any number of connected edges/faces.

Before: -> After:
+-+-+-+    +-+-+-+
| | | |    | \ / |
+-+-+-+    +--+--+
| | | |    | / \ |
+-+-+-+    +-+-+-+

Definition at line 1864 of file bmesh_core.cc.

References BLI_assert, BLI_SMALLSTACK_DECLARE, BLI_SMALLSTACK_POP, BLI_SMALLSTACK_PUSH, bm, BM_CHECK_ELEMENT, BM_edge_exists(), BM_edge_kill(), BM_edge_other_vert(), BM_edge_splice(), BM_FACE_FIRST_LOOP, BM_face_kill(), bm_kill_only_loop(), bm_kill_only_vert(), BM_vert_in_edge(), bmesh_edge_vert_swap(), BMVert::e, e, BMLoop::f, BMEdge::l, BMFace::len, BMLoop::next, BMLoop::prev, BMLoop::radial_next, and BMLoop::v.

Referenced by BM_edge_collapse().

bmesh_kernel_loop_reverse()

void bmesh_kernel_loop_reverse	(	BMesh *	bm,
		BMFace *	f,
		int	cd_loop_mdisp_offset,
		bool	use_loop_mdisp_flip )

Loop Reverse.

Changes the winding order of a face from CW to CCW or vice versa.

Parameters

cd_loop_mdisp_offset	Cached result of CustomData_get_offset(&bm->ldata, CD_MDISPS).
use_loop_mdisp_flip	When set, flip the Z-depth of the mdisp, (use when flipping normals, disable when mirroring, eg: symmetrize).

Definition at line 1003 of file bmesh_core.cc.

References BKE_mesh_mdisp_flip(), bm, BM_CHECK_ELEMENT, BM_ELEM_CD_GET_VOID_P, BM_LOOP, bmesh_radial_loop_append(), bmesh_radial_loop_remove(), BMLoop::e, BMLoop::f, i, BMEdge::l, BMFace::l_first, BMFace::len, BMLoop::next, BMLoop::prev, BMLoop::radial_next, BMLoop::radial_prev, and BMLoop::v.

Referenced by BM_face_normal_flip_ex(), and BM_faces_join_pair().

bmesh_kernel_split_edge_make_vert()

BMVert * bmesh_kernel_split_edge_make_vert	(	BMesh *	bm,
		BMVert *	tv,
		BMEdge *	e,
		BMEdge **	r_e )

Split Edge Make Vert (SEMV).

Takes e edge and splits it into two, creating a new vert. tv should be one end of e : the newly created edge will be attached to that end and is returned in r_e.

Examples:

                    E
    Before: OV-------------TV
                E       RE
    After:  OV------NV-----TV

Returns

The newly created BMVert pointer.

Definition at line 1544 of file bmesh_core.cc.

References BLI_assert, bm, BM_CHECK_ELEMENT, BM_CREATE_NOP, BM_edge_create(), BM_edge_other_vert(), bm_loop_create(), BM_vert_create(), BM_vert_in_edge(), BM_verts_in_edge(), BMESH_ASSERT, bmesh_disk_count(), bmesh_disk_edge_append(), bmesh_disk_edge_remove(), bmesh_disk_validate(), bmesh_disk_vert_replace(), bmesh_radial_length(), bmesh_radial_loop_append(), bmesh_radial_loop_unlink(), bmesh_radial_validate(), BMVert::co, BMLoop::e, BMVert::e, e, i, BMEdge::l, l, BMLoop::next, BMLoop::prev, BMLoop::radial_next, and BMLoop::v.

Referenced by BM_edge_split(), and BM_face_split_n().

bmesh_kernel_split_face_make_edge()

BMFace * bmesh_kernel_split_face_make_edge	(	BMesh *	bm,
		BMFace *	f,
		BMLoop *	l_v1,
		BMLoop *	l_v2,
		BMLoop **	r_l,
		BMEdge *	example,
		bool	no_double )

Split Face Make Edge (SFME).

Warning

this is a low level function, most likely you want to use BM_face_split()

Takes as input two vertices in a single face. An edge is created which divides the original face into two distinct regions. One of the regions is assigned to the original face and it is closed off. The second region has a new face assigned to it.

Examples:

    Before:               After:
     +--------+           +--------+
     |        |           |        |
     |        |           |   f1   |
    v1   f1   v2          v1======v2
     |        |           |   f2   |
     |        |           |        |
     +--------+           +--------+

Note

the input vertices can be part of the same edge. This will result in a two edged face. This is desirable for advanced construction tools and particularly essential for edge bevel. Because of this it is up to the caller to decide what to do with the extra edge.

If holes is NULL, then both faces will lose all holes from the original face. Also, you cannot split between a hole vert and a boundary vert; that case is handled by higher- level wrapping functions (when holes are fully implemented, anyway).

that holes represents which holes goes to the new face, and of course this requires removing them from the existing face first, since you cannot have linked list links inside multiple lists.

Returns

A BMFace pointer

Definition at line 1405 of file bmesh_core.cc.

References BLI_assert, BLI_mempool_free(), BLI_movelisttolist(), bm, BM_CHECK_ELEMENT, BM_CREATE_NO_DOUBLE, BM_CREATE_NOP, BM_edge_create(), bm_face_create__sfme(), BM_FACE_FIRST_LOOP, bm_loop_create(), bmesh_radial_loop_append(), e, BMLoop::f, BMFace::l_first, BMFace::len, BMLoop::next, BMLoop::prev, BMLoop::v, and v2.

Referenced by BM_face_split(), and BM_face_split_n().

bmesh_kernel_unglue_region_make_vert()

BMVert * bmesh_kernel_unglue_region_make_vert	(	BMesh *	bm,
		BMLoop *	l_sep )

Un-glue Region Make Vert (URMV).

Disconnects a face from its vertex fan at loop l_sep

Returns

The newly created BMVert

Note

Will be a no-op and return original vertex if only two edges at that vertex.

Definition at line 2464 of file bmesh_core.cc.

References ARRAY_SIZE, BLI_assert, bm, BM_CHECK_ELEMENT, BM_CREATE_NOP, BM_edge_is_boundary(), BM_vert_create(), BM_vert_edge_count_is_equal, bmesh_disk_edge_next(), bmesh_edge_vert_swap(), bmesh_kernel_edge_separate(), BMVert::co, BMLoop::e, BMVert::e, e, ELEM, i, BMLoop::prev, and BMLoop::v.

Referenced by BM_face_loop_separate().

bmesh_kernel_unglue_region_make_vert_multi()

BMVert * bmesh_kernel_unglue_region_make_vert_multi	(	BMesh *	bm,
		BMLoop **	larr,
		int	larr_len )

A version of bmesh_kernel_unglue_region_make_vert that disconnects multiple loops at once. The loops must all share the same vertex, can be in any order and are all moved to use a single new vertex - which is returned.

This function handles the details of finding fans boundaries.

Definition at line 2526 of file bmesh_core.cc.

References ARRAY_SIZE, BLI_array_alloca, BLI_assert, bm, BM_CREATE_NOP, BM_edge_create(), BM_ELEM_API_FLAG_DISABLE, BM_ELEM_API_FLAG_ENABLE, BM_ELEM_API_FLAG_TEST, BM_vert_create(), bmesh_disk_edge_next(), bmesh_disk_vert_replace(), bmesh_radial_loop_append(), bmesh_radial_loop_remove(), BMVert::co, BMLoop::e, BMVert::e, e, EDGE_VISIT, i, BMEdge::l, LOOP_VISIT, BMLoop::next, BMLoop::prev, BMLoop::radial_next, STACK_DECLARE, STACK_INIT, STACK_PUSH, STACK_SIZE, UNPACK2, and BMLoop::v.

Referenced by BM_face_loop_separate_multi().

bmesh_kernel_unglue_region_make_vert_multi_isolated()

BMVert * bmesh_kernel_unglue_region_make_vert_multi_isolated	(	BMesh *	bm,
		BMLoop *	l_sep )

This function assumes l_sep is a part of a larger fan which has already been isolated by calling bmesh_kernel_edge_separate to segregate it radially.

Definition at line 2706 of file bmesh_core.cc.

References BLI_assert, bm, BM_CREATE_NOP, BM_vert_create(), bmesh_edge_vert_swap__recursive(), BMVert::co, BMLoop::e, and BMLoop::v.

Referenced by BM_face_loop_separate_multi_isolated().

bmesh_kernel_vert_separate()

void bmesh_kernel_vert_separate	(	BMesh *	bm,
		BMVert *	v,
		BMVert ***	r_vout,
		int *	r_vout_len,
		bool	copy_select )

Separate Vert.

BMesh Kernel: For modifying structure.

Names are on the verbose side but these are only for low-level access.

Separates all disjoint fans that meet at a vertex, making a unique vertex for each region. returns an array of all resulting vertices.

Note

this is a low level function, bm_edge_separate needs to run on edges first or, the faces sharing verts must not be sharing edges for them to split at least.

Returns

Success

Definition at line 2149 of file bmesh_core.cc.

References BLI_assert, BLI_SMALLSTACK_AS_TABLE, BLI_SMALLSTACK_DECLARE, BLI_SMALLSTACK_POP, BLI_SMALLSTACK_PUSH, bm, BM_CREATE_NOP, BM_ELEM_API_FLAG_DISABLE, BM_ELEM_API_FLAG_ENABLE, BM_ELEM_API_FLAG_TEST, BM_elem_select_copy(), BM_vert_create(), BM_vert_in_edge(), bmesh_disk_edge_next(), bmesh_edge_vert_swap(), BMLoop::e, e, EDGE_VISIT, MEM_malloc_arrayN(), BMLoop::next, BMLoop::prev, BMLoop::radial_next, BMLoop::v, v, and verts.

Referenced by BM_vert_separate(), BM_vert_separate_hflag(), bmo_inset_region_exec(), and edbm_rip_invoke__vert().