#include "MEM_guardedalloc.h"
#include "BLI_ghash.h"
#include "BLI_listbase.h"
#include "BLI_math_vector.h"
#include "BLI_mempool.h"
#include "BLI_utildefines.h"
#include "BKE_customdata.hh"
#include "bmesh.hh"
#include "bmesh_log.hh"
#include "range_tree.h"
#include "BLI_strict_flags.h"

Classes
struct	BMLogEntry

struct	BMLog

struct	BMLogVert

struct	BMLogFace

Macros
#define	logkey_hash BLI_ghashutil_inthash_p_simple

#define	logkey_cmp BLI_ghashutil_intcmp

Functions
static uint	bm_log_vert_id_get (BMLog log, BMVert v)

static void	bm_log_vert_id_set (BMLog log, BMVert v, uint id)

static BMVert *	bm_log_vert_from_id (BMLog *log, uint id)

static uint	bm_log_face_id_get (BMLog log, BMFace f)

static void	bm_log_face_id_set (BMLog log, BMFace f, uint id)

static BMFace *	bm_log_face_from_id (BMLog *log, uint id)

static float	vert_mask_get (BMVert *v, const int cd_vert_mask_offset)

static void	vert_mask_set (BMVert *v, const float new_mask, const int cd_vert_mask_offset)

static void	bm_log_vert_bmvert_copy (BMLogVert lv, BMVert v, const int cd_vert_mask_offset)

static BMLogVert *	bm_log_vert_alloc (BMLog log, BMVert v, const int cd_vert_mask_offset)

static BMLogFace *	bm_log_face_alloc (BMLog log, BMFace f)

static void	bm_log_verts_unmake (BMesh bm, BMLog log, GHash *verts)

static void	bm_log_faces_unmake (BMesh bm, BMLog log, GHash *faces)

static void	bm_log_verts_restore (BMesh bm, BMLog log, GHash *verts)

static void	bm_log_faces_restore (BMesh bm, BMLog log, GHash *faces)

static void	bm_log_vert_values_swap (BMesh bm, BMLog log, GHash *verts)

static void	bm_log_face_values_swap (BMLog log, GHash faces)

static void	bm_log_assign_ids (BMesh bm, BMLog log)

static BMLogEntry *	bm_log_entry_create ()

static void	bm_log_entry_free (BMLogEntry *entry)

static void	bm_log_id_ghash_retake (RangeTreeUInt unused_ids, GHash id_ghash)

static int	uint_compare (const void a_v, const void b_v)

static GHash *	bm_log_compress_ids_to_indices (uint *ids, uint totid)

static void	bm_log_id_ghash_release (BMLog log, GHash id_ghash)

BMLog *	BM_log_create (BMesh *bm)

void	BM_log_cleanup_entry (BMLogEntry *entry)

BMLog *	BM_log_from_existing_entries_create (BMesh bm, BMLogEntry entry)

void	BM_log_free (BMLog *log)

int	BM_log_length (const BMLog *log)

void	BM_log_mesh_elems_reorder (BMesh bm, BMLog log)

BMLogEntry *	BM_log_entry_add (BMLog *log)

void	BM_log_entry_drop (BMLogEntry *entry)

void	BM_log_undo (BMesh bm, BMLog log)

void	BM_log_redo (BMesh bm, BMLog log)

void	BM_log_vert_before_modified (BMLog log, BMVert v, const int cd_vert_mask_offset)

void	BM_log_vert_added (BMLog log, BMVert v, const int cd_vert_mask_offset)

void	BM_log_face_modified (BMLog log, BMFace f)

void	BM_log_face_added (BMLog log, BMFace f)

void	BM_log_vert_removed (BMLog log, BMVert v, const int cd_vert_mask_offset)

void	BM_log_face_removed (BMLog log, BMFace f)

void	BM_log_all_added (BMesh bm, BMLog log)

void	BM_log_before_all_removed (BMesh bm, BMLog log)

const float *	BM_log_find_original_vert_co (BMLog log, BMVert v)

const float *	BM_log_find_original_vert_mask (BMLog log, BMVert v)

const float *	BM_log_original_vert_co (BMLog log, BMVert v)

const float *	BM_log_original_vert_no (BMLog log, BMVert v)

float	BM_log_original_mask (BMLog log, BMVert v)

void	BM_log_original_vert_data (BMLog log, BMVert v, const float r_co, const float r_no)

BMLogEntry *	BM_log_current_entry (BMLog *log)

RangeTreeUInt *	BM_log_unused_ids (BMLog *log)

void	BM_log_print_entry (BMesh bm, BMLogEntry entry)

Detailed Description

The BMLog is an interface for storing undo/redo steps as a BMesh is modified. It only stores changes to the BMesh, not full copies.

Currently it supports the following types of changes:

Adding and removing vertices
Adding and removing faces
Moving vertices
Setting vertex paint-mask values
Setting vertex hflags

Definition in file bmesh_log.cc.

Macro Definition Documentation

◆ logkey_cmp

#define logkey_cmp BLI_ghashutil_intcmp

Definition at line 114 of file bmesh_log.cc.

Referenced by BM_log_create(), and bm_log_entry_create().

◆ logkey_hash

#define logkey_hash BLI_ghashutil_inthash_p_simple

Definition at line 113 of file bmesh_log.cc.

Referenced by BM_log_create(), and bm_log_entry_create().

Function Documentation

◆ BM_log_all_added()

void BM_log_all_added	(	BMesh *	bm,
		BMLog *	log )

Log all vertices/faces in the BMesh as added.

Definition at line 874 of file bmesh_log.cc.

References BLI_ghash_len(), BLI_ghash_reserve(), bm, BM_FACES_OF_MESH, BM_ITER_MESH, BM_log_face_added(), BM_log_vert_added(), BM_VERTS_OF_MESH, CD_PROP_FLOAT, CustomData_get_offset_named(), log(), BMesh::totface, BMesh::totvert, v, and BMesh::vdata.

Referenced by blender::ed::sculpt_paint::undo::bmesh_push(), and blender::ed::sculpt_paint::symmetrize_exec().

◆ bm_log_assign_ids()

static void bm_log_assign_ids	(	BMesh *	bm,
		BMLog *	log )

static

Definition at line 357 of file bmesh_log.cc.

References bm, BM_FACES_OF_MESH, BM_ITER_MESH, bm_log_face_id_set(), bm_log_vert_id_set(), BM_VERTS_OF_MESH, log(), and v.

Referenced by BM_log_create().

◆ BM_log_before_all_removed()

void BM_log_before_all_removed	(	BMesh *	bm,
		BMLog *	log )

Log all vertices/faces in the BMesh as removed.

Definition at line 902 of file bmesh_log.cc.

References bm, BM_FACES_OF_MESH, BM_ITER_MESH, BM_log_face_removed(), BM_log_vert_removed(), BM_VERTS_OF_MESH, CD_PROP_FLOAT, CustomData_get_offset_named(), log(), v, and BMesh::vdata.

Referenced by blender::ed::sculpt_paint::undo::bmesh_push(), and blender::ed::sculpt_paint::symmetrize_exec().

◆ BM_log_cleanup_entry()

void BM_log_cleanup_entry ( BMLogEntry * entry )

Mark all used ids as unused for this node

Definition at line 482 of file bmesh_log.cc.

References BMLogEntry::added_faces, BMLogEntry::added_verts, BLI_ghash_clear(), bm_log_id_ghash_retake(), BMLogEntry::deleted_faces, BMLogEntry::deleted_verts, BMLogEntry::log, log(), BMLogEntry::modified_faces, and BMLogEntry::modified_verts.

◆ bm_log_compress_ids_to_indices()

static GHash * bm_log_compress_ids_to_indices	(	uint *	ids,
		uint	totid )

static

Definition at line 437 of file bmesh_log.cc.

References BLI_ghash_insert(), BLI_ghash_int_new_ex(), POINTER_FROM_UINT, and uint_compare().

Referenced by BM_log_mesh_elems_reorder().

◆ BM_log_create()

BMLog * BM_log_create ( BMesh * bm )

Allocate, initialize, and assign a new BMLog.

Definition at line 467 of file bmesh_log.cc.

References BLI_ghash_new_ex(), BLI_ghash_ptr_new_ex(), bm, bm_log_assign_ids(), log(), logkey_cmp, logkey_hash, MEM_callocN, BMesh::totface, and BMesh::totvert.

Referenced by BM_log_from_existing_entries_create(), and blender::ed::sculpt_paint::dyntopo::enable_ex().

◆ BM_log_current_entry()

BMLogEntry * BM_log_current_entry ( BMLog * log )

For internal use only (unit testing).

Definition at line 1006 of file bmesh_log.cc.

References log().

◆ BM_log_entry_add()

BMLogEntry * BM_log_entry_add ( BMLog * log )

Start a new log entry and update the log entry list.

If the log entry list is empty, or if the current log entry is the last entry, the new entry is simply appended to the end.

Otherwise, the new entry is added after the current entry and all following entries are deleted.

In either case, the new entry is set as the current log entry.

Definition at line 624 of file bmesh_log.cc.

References BLI_addtail(), BLI_freelinkN(), bm_log_entry_create(), bm_log_entry_free(), BMLogEntry::log, log(), BMLogEntry::next, and next.

Referenced by blender::ed::sculpt_paint::undo::bmesh_push().

◆ bm_log_entry_create()

static BMLogEntry * bm_log_entry_create ( )

static

Definition at line 377 of file bmesh_log.cc.

References BMLogEntry::added_faces, BMLogEntry::added_verts, BLI_ghash_new(), BLI_mempool_create(), BLI_MEMPOOL_NOP, BMLogEntry::deleted_faces, BMLogEntry::deleted_verts, logkey_cmp, logkey_hash, MEM_callocN, BMLogEntry::modified_faces, BMLogEntry::modified_verts, BMLogEntry::pool_faces, and BMLogEntry::pool_verts.

Referenced by BM_log_entry_add().

◆ BM_log_entry_drop()

void BM_log_entry_drop ( BMLogEntry * entry )

Remove an entry from the log.

Uses entry->log as the log. If the log is NULL, the entry will be freed but not removed from any list, nor shall its IDs be released.

This operation is only valid on the first and last entries in the log. Deleting from the middle will assert.

Definition at line 651 of file bmesh_log.cc.

References BMLogEntry::added_faces, BMLogEntry::added_verts, BLI_assert, BLI_assert_msg, BLI_freelinkN(), bm_log_entry_free(), bm_log_id_ghash_release(), BMLogEntry::log, log(), MEM_freeN(), BMLogEntry::next, and BMLogEntry::prev.

Referenced by blender::ed::sculpt_paint::undo::free_step_data().

◆ bm_log_entry_free()

static void bm_log_entry_free ( BMLogEntry * entry )

static

Definition at line 397 of file bmesh_log.cc.

References BMLogEntry::added_faces, BMLogEntry::added_verts, BLI_ghash_free(), BLI_mempool_destroy(), BMLogEntry::deleted_faces, BMLogEntry::deleted_verts, BMLogEntry::modified_faces, BMLogEntry::modified_verts, BMLogEntry::pool_faces, and BMLogEntry::pool_verts.

Referenced by BM_log_entry_add(), and BM_log_entry_drop().

◆ BM_log_face_added()

void BM_log_face_added	(	BMLog *	log,
		BMFace *	f )

Log a new face as added to the BMesh.

The new face gets a unique ID assigned. It is then added to a map of added faces, with the key being its ID and the value containing everything needed to reconstruct that face.

Definition at line 811 of file bmesh_log.cc.

References BLI_assert, BLI_ghash_insert(), bm_log_face_alloc(), bm_log_face_id_set(), BMFace::len, log(), and POINTER_FROM_UINT.

Referenced by BM_log_all_added(), and blender::bke::pbvh::pbvh_bmesh_face_create().

◆ bm_log_face_alloc()

static BMLogFace * bm_log_face_alloc	(	BMLog *	log,
		BMFace *	f )

static

Definition at line 208 of file bmesh_log.cc.

References BLI_assert, BLI_mempool_alloc(), BM_face_as_array_vert_tri(), bm_log_vert_id_get(), BMFace::head, BMHeader::hflag, BMLogFace::hflag, BMFace::len, log(), BMLogEntry::pool_faces, v, and BMLogFace::v_ids.

Referenced by BM_log_face_added(), BM_log_face_modified(), and BM_log_face_removed().

◆ bm_log_face_from_id()

static BMFace * bm_log_face_from_id	(	BMLog *	log,
		uint	id )

static

Definition at line 157 of file bmesh_log.cc.

References BLI_assert, BLI_ghash_haskey(), BLI_ghash_lookup(), log(), and POINTER_FROM_UINT.

Referenced by bm_log_face_values_swap(), and bm_log_faces_unmake().

◆ bm_log_face_id_get()

static uint bm_log_face_id_get	(	BMLog *	log,
		BMFace *	f )

static

Definition at line 141 of file bmesh_log.cc.

References BLI_assert, BLI_ghash_haskey(), BLI_ghash_lookup(), log(), and POINTER_AS_UINT.

Referenced by BM_log_face_modified(), BM_log_face_removed(), and BM_log_mesh_elems_reorder().

◆ bm_log_face_id_set()

static void bm_log_face_id_set	(	BMLog *	log,
		BMFace *	f,
		uint	id )

static

Definition at line 148 of file bmesh_log.cc.

References BLI_ghash_reinsert(), log(), and POINTER_FROM_UINT.

Referenced by bm_log_assign_ids(), BM_log_face_added(), and bm_log_faces_restore().

◆ BM_log_face_modified()

void BM_log_face_modified	(	BMLog *	log,
		BMFace *	f )

Log a face before it is modified.

This is intended to handle only header flags and we always assume face has been added before.

Definition at line 801 of file bmesh_log.cc.

References BLI_ghash_insert(), bm_log_face_alloc(), bm_log_face_id_get(), log(), and POINTER_FROM_UINT.

Referenced by blender::ed::sculpt_paint::undo::bmesh_push().

◆ BM_log_face_removed()

void BM_log_face_removed	(	BMLog *	log,
		BMFace *	f )

Log a face as removed from the BMesh.

A couple things can happen here:

If the face was added as part of the current log entry, then it's deleted and forgotten about entirely. Its unique ID is returned to the unused pool.

If the face was already part of the BMesh before the current log entry, it is added to a map of deleted faces, with the key being its ID and the value containing everything needed to reconstruct that face.

Definition at line 853 of file bmesh_log.cc.

References BMLogEntry::added_faces, BLI_assert, BLI_ghash_haskey(), BLI_ghash_insert(), BLI_ghash_lookup(), BLI_ghash_remove(), bm_log_face_alloc(), bm_log_face_id_get(), BMLogEntry::deleted_faces, log(), and POINTER_FROM_UINT.

Referenced by BM_log_before_all_removed(), and blender::bke::pbvh::pbvh_bmesh_face_remove().

◆ bm_log_face_values_swap()

static void bm_log_face_values_swap	(	BMLog *	log,
		GHash *	faces )

static

Definition at line 341 of file bmesh_log.cc.

References BLI_ghashIterator_getKey(), BLI_ghashIterator_getValue(), bm_log_face_from_id(), GHASH_ITER, BMFace::head, BMHeader::hflag, BMLogFace::hflag, log(), and POINTER_AS_UINT.

Referenced by BM_log_redo(), and BM_log_undo().

◆ bm_log_faces_restore()

static void bm_log_faces_restore	(	BMesh *	bm,
		BMLog *	log,
		GHash *	faces )

static

Definition at line 292 of file bmesh_log.cc.

References BLI_ghashIterator_getKey(), BLI_ghashIterator_getValue(), bm, BM_CREATE_NOP, BM_ELEM_CD_SET_INT, BM_face_create_verts(), bm_log_face_id_set(), bm_log_vert_from_id(), CD_PROP_INT32, CustomData_get_offset_named(), GHASH_ITER, BMFace::head, BMHeader::hflag, BMLogFace::hflag, log(), BMesh::pdata, POINTER_AS_UINT, v, and BMLogFace::v_ids.

Referenced by BM_log_redo(), and BM_log_undo().

◆ bm_log_faces_unmake()

static void bm_log_faces_unmake	(	BMesh *	bm,
		BMLog *	log,
		GHash *	faces )

static

Definition at line 249 of file bmesh_log.cc.

References BLI_ghashIterator_getKey(), bm, BM_edge_is_wire(), BM_edge_kill(), BM_FACE_FIRST_LOOP, BM_face_kill(), bm_log_face_from_id(), BMLoop::e, GHASH_ITER, log(), BMLoop::next, and POINTER_AS_UINT.

Referenced by BM_log_redo(), and BM_log_undo().

◆ BM_log_find_original_vert_co()

const float * BM_log_find_original_vert_co	(	BMLog *	log,
		BMVert *	v )

Search the log for the original vertex coordinates.

Does not modify the log or the vertex.

Returns: the pointer or nullptr if the vertex isn't found.

Definition at line 921 of file bmesh_log.cc.

References BLI_ghash_lookup(), bm_log_vert_id_get(), BMLogVert::co, log(), BMLogEntry::modified_verts, POINTER_FROM_UINT, and v.

Referenced by blender::bke::pbvh::copy_original_vert(), and blender::ed::sculpt_paint::undo::restore_position_from_undo_step().

◆ BM_log_find_original_vert_mask()

const float * BM_log_find_original_vert_mask	(	BMLog *	log,
		BMVert *	v )

Search the log for the original vertex mask.

Does not modify the log or the vertex.

Returns: the pointer or nullptr if the vertex isn't found.

Definition at line 932 of file bmesh_log.cc.

References BLI_ghash_lookup(), bm_log_vert_id_get(), log(), BMLogVert::mask, BMLogEntry::modified_verts, POINTER_FROM_UINT, and v.

Referenced by blender::ed::sculpt_paint::undo::restore_mask_from_undo_step().

◆ BM_log_free()

void BM_log_free ( BMLog * log )

Free all the data in a BMLog including the log itself.

Definition at line 545 of file bmesh_log.cc.

References BLI_ghash_free(), LISTBASE_FOREACH, log(), and MEM_freeN().

Referenced by blender::ed::sculpt_paint::dyntopo::disable(), and SculptSession::~SculptSession().

◆ BM_log_from_existing_entries_create()

BMLog * BM_log_from_existing_entries_create	(	BMesh *	bm,
		BMLogEntry *	entry )

Allocate and initialize a new BMLog using existing #BMLogEntries

The 'entry' should be the last entry in the BMLog. Its prev pointer will be followed back to find the first entry.

The unused IDs field of the log will be initialized by taking all keys from all GHashes in the log entry.

Definition at line 504 of file bmesh_log.cc.

References BMLogEntry::added_faces, BMLogEntry::added_verts, bm, BM_log_create(), bm_log_id_ghash_retake(), BMLogEntry::deleted_faces, BMLogEntry::deleted_verts, BMLogEntry::log, log(), BMLogEntry::modified_faces, BMLogEntry::modified_verts, BMLogEntry::next, and BMLogEntry::prev.

Referenced by blender::ed::sculpt_paint::undo::bmesh_enable().

◆ bm_log_id_ghash_release()

static void bm_log_id_ghash_release	(	BMLog *	log,
		GHash *	id_ghash )

static

Definition at line 454 of file bmesh_log.cc.

References BLI_ghashIterator_getKey(), GHASH_ITER, log(), and POINTER_AS_UINT.

Referenced by BM_log_entry_drop().

◆ bm_log_id_ghash_retake()

static void bm_log_id_ghash_retake	(	RangeTreeUInt *	unused_ids,
		GHash *	id_ghash )

static

Definition at line 410 of file bmesh_log.cc.

References BLI_ghashIterator_getKey(), GHASH_ITER, and POINTER_AS_UINT.

Referenced by BM_log_cleanup_entry(), and BM_log_from_existing_entries_create().

◆ BM_log_length()

int BM_log_length ( const BMLog * log )

Get the number of log entries.

Definition at line 568 of file bmesh_log.cc.

References BLI_listbase_count(), and log().

◆ BM_log_mesh_elems_reorder()

void BM_log_mesh_elems_reorder	(	BMesh *	bm,
		BMLog *	log )

Apply a consistent ordering to BMesh vertices and faces.

Definition at line 573 of file bmesh_log.cc.

References BLI_ghash_free(), BLI_ghash_lookup(), bm, BM_FACES_OF_MESH, BM_ITER_MESH_INDEX, bm_log_compress_ids_to_indices(), bm_log_face_id_get(), bm_log_vert_id_get(), BM_mesh_remap(), BM_VERTS_OF_MESH, log(), MEM_freeN(), MEM_mallocN, POINTER_AS_UINT, POINTER_FROM_UINT, BMesh::totface, BMesh::totvert, and v.

Referenced by sculptsession_bm_to_me_update_data_only().

◆ BM_log_original_mask()

float BM_log_original_mask	(	BMLog *	log,
		BMVert *	v )

Get the logged mask of a vertex

Does not modify the log or the vertex.

Definition at line 973 of file bmesh_log.cc.

References BLI_assert, BLI_ghash_haskey(), BLI_ghash_lookup(), bm_log_vert_id_get(), log(), BMLogVert::mask, BMLogEntry::modified_verts, POINTER_FROM_UINT, and v.

◆ BM_log_original_vert_co()

const float * BM_log_original_vert_co	(	BMLog *	log,
		BMVert *	v )

Get the logged coordinates of a vertex.

Does not modify the log or the vertex.

Definition at line 943 of file bmesh_log.cc.

References BLI_assert, BLI_ghash_haskey(), BLI_ghash_lookup(), bm_log_vert_id_get(), BMLogVert::co, log(), BMLogEntry::modified_verts, POINTER_FROM_UINT, and v.

◆ BM_log_original_vert_data()

void BM_log_original_vert_data	(	BMLog *	log,
		BMVert *	v,
		const float **	r_co,
		const float **	r_no )

Get the logged data of a vertex (avoid multiple lookups).

Definition at line 988 of file bmesh_log.cc.

References BLI_assert, BLI_ghash_haskey(), BLI_ghash_lookup(), bm_log_vert_id_get(), BMLogVert::co, log(), BMLogEntry::modified_verts, BMLogVert::no, POINTER_FROM_UINT, and v.

Referenced by blender::ed::sculpt_paint::orig_position_data_gather_bmesh().

◆ BM_log_original_vert_no()

const float * BM_log_original_vert_no	(	BMLog *	log,
		BMVert *	v )

Get the logged normal of a vertex

Does not modify the log or the vertex.

Definition at line 958 of file bmesh_log.cc.

References BLI_assert, BLI_ghash_haskey(), BLI_ghash_lookup(), bm_log_vert_id_get(), log(), BMLogEntry::modified_verts, BMLogVert::no, POINTER_FROM_UINT, and v.

◆ BM_log_print_entry()

void BM_log_print_entry	(	BMesh *	bm,
		BMLogEntry *	entry )

Definition at line 1034 of file bmesh_log.cc.

References BMLogEntry::added_faces, BMLogEntry::added_verts, BLI_ghash_len(), bm, BMLogEntry::deleted_faces, BMLogEntry::deleted_verts, BMLogEntry::modified_faces, BMLogEntry::modified_verts, printf, BMesh::totedge, BMesh::totface, BMesh::totloop, and BMesh::totvert.

◆ BM_log_redo()

void BM_log_redo	(	BMesh *	bm,
		BMLog *	log )

Redo one BMLogEntry.

Has no effect if there's nothing left to redo.

Definition at line 738 of file bmesh_log.cc.

References BMLogEntry::added_faces, BMLogEntry::added_verts, bm, bm_log_face_values_swap(), bm_log_faces_restore(), bm_log_faces_unmake(), bm_log_vert_values_swap(), bm_log_verts_restore(), bm_log_verts_unmake(), BMLogEntry::deleted_faces, BMLogEntry::deleted_verts, log(), BMLogEntry::modified_faces, BMLogEntry::modified_verts, and BMLogEntry::next.

Referenced by blender::ed::sculpt_paint::undo::bmesh_restore_begin(), and blender::ed::sculpt_paint::undo::bmesh_restore_generic().

◆ BM_log_undo()

void BM_log_undo	(	BMesh *	bm,
		BMLog *	log )

Undo one BMLogEntry.

Has no effect if there's nothing left to undo.

Definition at line 717 of file bmesh_log.cc.

References BMLogEntry::added_faces, BMLogEntry::added_verts, bm, bm_log_face_values_swap(), bm_log_faces_restore(), bm_log_faces_unmake(), bm_log_vert_values_swap(), bm_log_verts_restore(), bm_log_verts_unmake(), BMLogEntry::deleted_faces, BMLogEntry::deleted_verts, log(), BMLogEntry::modified_faces, BMLogEntry::modified_verts, and BMLogEntry::prev.

Referenced by blender::ed::sculpt_paint::undo::bmesh_restore_end(), and blender::ed::sculpt_paint::undo::bmesh_restore_generic().

◆ BM_log_unused_ids()

RangeTreeUInt * BM_log_unused_ids ( BMLog * log )

For internal use only (unit testing)

Definition at line 1011 of file bmesh_log.cc.

References log().

◆ BM_log_vert_added()

void BM_log_vert_added	(	BMLog *	log,
		BMVert *	v,
		int	cd_vert_mask_offset )

Log a new vertex as added to the BMesh.

The new vertex gets a unique ID assigned. It is then added to a map of added vertices, with the key being its ID and the value containing everything needed to reconstruct that vertex.

Definition at line 790 of file bmesh_log.cc.

References BLI_ghash_insert(), bm_log_vert_alloc(), bm_log_vert_id_set(), log(), POINTER_FROM_UINT, and v.

Referenced by BM_log_all_added(), and blender::bke::pbvh::pbvh_bmesh_vert_create().

◆ bm_log_vert_alloc()

static BMLogVert * bm_log_vert_alloc	(	BMLog *	log,
		BMVert *	v,
		const int	cd_vert_mask_offset )

static

Definition at line 197 of file bmesh_log.cc.

References BLI_mempool_alloc(), bm_log_vert_bmvert_copy(), log(), BMLogEntry::pool_verts, and v.

Referenced by BM_log_vert_added(), BM_log_vert_before_modified(), and BM_log_vert_removed().

◆ BM_log_vert_before_modified()

void BM_log_vert_before_modified	(	BMLog *	log,
		BMVert *	v,
		int	cd_vert_mask_offset )

Log a vertex before it is modified.

Before modifying vertex coordinates, masks, or hflags, call this function to log its current values. This is better than logging after the coordinates have been modified, because only those vertices that are modified need to have their original values stored.

Handles two separate cases:

If the vertex was added in the current log entry, update the vertex in the map of added vertices.

If the vertex already existed prior to the current log entry, a separate key/value map of modified vertices is used (using the vertex's ID as the key). The values stored in that case are the vertex's original state so that an undo can restore the previous state.

On undo, the current vertex state will be swapped with the stored state so that a subsequent redo operation will restore the newer vertex state.

Definition at line 772 of file bmesh_log.cc.

References BMLogEntry::added_verts, BLI_ghash_ensure_p(), BLI_ghash_lookup(), bm_log_vert_alloc(), bm_log_vert_bmvert_copy(), bm_log_vert_id_get(), log(), BMLogEntry::modified_verts, POINTER_FROM_UINT, and v.

Referenced by blender::ed::sculpt_paint::undo::bmesh_push(), and blender::bke::pbvh::pbvh_bmesh_collapse_edge().

◆ bm_log_vert_bmvert_copy()

static void bm_log_vert_bmvert_copy	(	BMLogVert *	lv,
		BMVert *	v,
		const int	cd_vert_mask_offset )

static

Definition at line 188 of file bmesh_log.cc.

References BMLogVert::co, BMVert::co, copy_v3_v3(), BMVert::head, BMHeader::hflag, BMLogVert::hflag, BMLogVert::mask, BMLogVert::no, BMVert::no, v, and vert_mask_get().

Referenced by bm_log_vert_alloc(), BM_log_vert_before_modified(), and bm_log_verts_unmake().

◆ bm_log_vert_from_id()

static BMVert * bm_log_vert_from_id	(	BMLog *	log,
		uint	id )

static

Definition at line 133 of file bmesh_log.cc.

References BLI_assert, BLI_ghash_haskey(), BLI_ghash_lookup(), log(), and POINTER_FROM_UINT.

Referenced by bm_log_faces_restore(), bm_log_vert_values_swap(), and bm_log_verts_unmake().

◆ bm_log_vert_id_get()

static uint bm_log_vert_id_get	(	BMLog *	log,
		BMVert *	v )

static

Definition at line 117 of file bmesh_log.cc.

References BLI_assert, BLI_ghash_haskey(), BLI_ghash_lookup(), log(), POINTER_AS_UINT, and v.

Referenced by bm_log_face_alloc(), BM_log_find_original_vert_co(), BM_log_find_original_vert_mask(), BM_log_mesh_elems_reorder(), BM_log_original_mask(), BM_log_original_vert_co(), BM_log_original_vert_data(), BM_log_original_vert_no(), BM_log_vert_before_modified(), and BM_log_vert_removed().

◆ bm_log_vert_id_set()

static void bm_log_vert_id_set	(	BMLog *	log,
		BMVert *	v,
		uint	id )

static

Definition at line 124 of file bmesh_log.cc.

References BLI_ghash_reinsert(), log(), POINTER_FROM_UINT, and v.

Referenced by bm_log_assign_ids(), BM_log_vert_added(), and bm_log_verts_restore().

◆ BM_log_vert_removed()

void BM_log_vert_removed	(	BMLog *	log,
		BMVert *	v,
		int	cd_vert_mask_offset )

Log a vertex as removed from the BMesh.

A couple things can happen here:

If the vertex was added as part of the current log entry, then it's deleted and forgotten about entirely. Its unique ID is returned to the unused pool.

If the vertex was already part of the BMesh before the current log entry, it is added to a map of deleted vertices, with the key being its ID and the value containing everything needed to reconstruct that vertex.

If there's a move record for the vertex, that's used as the vertices original location, then the move record is deleted.

Definition at line 825 of file bmesh_log.cc.

References BMLogEntry::added_verts, BLI_assert, BLI_ghash_haskey(), BLI_ghash_insert(), BLI_ghash_lookup(), BLI_ghash_remove(), bm_log_vert_alloc(), bm_log_vert_id_get(), BMLogEntry::deleted_verts, log(), BMLogEntry::modified_verts, POINTER_FROM_UINT, and v.

Referenced by BM_log_before_all_removed(), and blender::bke::pbvh::pbvh_bmesh_collapse_edge().

◆ bm_log_vert_values_swap()

static void bm_log_vert_values_swap	(	BMesh *	bm,
		BMLog *	log,
		GHash *	verts )

static

Definition at line 319 of file bmesh_log.cc.

References BLI_ghashIterator_getKey(), BLI_ghashIterator_getValue(), bm, bm_log_vert_from_id(), CD_PROP_FLOAT, BMLogVert::co, BMVert::co, CustomData_get_offset_named(), GHASH_ITER, BMVert::head, BMHeader::hflag, BMLogVert::hflag, log(), BMLogVert::mask, mask(), BMLogVert::no, BMVert::no, POINTER_AS_UINT, swap_v3_v3(), v, BMesh::vdata, vert_mask_get(), vert_mask_set(), and verts.

Referenced by BM_log_redo(), and BM_log_undo().

◆ bm_log_verts_restore()

static void bm_log_verts_restore	(	BMesh *	bm,
		BMLog *	log,
		GHash *	verts )

static

Definition at line 275 of file bmesh_log.cc.

References BLI_ghashIterator_getKey(), BLI_ghashIterator_getValue(), bm, BM_CREATE_NOP, bm_log_vert_id_set(), BM_vert_create(), CD_PROP_FLOAT, BMLogVert::co, copy_v3_v3(), CustomData_get_offset_named(), GHASH_ITER, BMVert::head, BMHeader::hflag, BMLogVert::hflag, log(), BMLogVert::mask, BMLogVert::no, BMVert::no, POINTER_AS_UINT, v, BMesh::vdata, vert_mask_set(), and verts.

Referenced by BM_log_redo(), and BM_log_undo().

◆ bm_log_verts_unmake()

static void bm_log_verts_unmake	(	BMesh *	bm,
		BMLog *	log,
		GHash *	verts )

static

Definition at line 229 of file bmesh_log.cc.

References BLI_ghashIterator_getKey(), BLI_ghashIterator_getValue(), bm, bm_log_vert_bmvert_copy(), bm_log_vert_from_id(), BM_vert_kill(), CD_PROP_FLOAT, CustomData_get_offset_named(), GHASH_ITER, log(), POINTER_AS_UINT, v, BMesh::vdata, and verts.

Referenced by BM_log_redo(), and BM_log_undo().

◆ uint_compare()

static int uint_compare	(	const void *	a_v,
		const void *	b_v )

static

Definition at line 422 of file bmesh_log.cc.

References b.

Referenced by bm_log_compress_ids_to_indices().

◆ vert_mask_get()

static float vert_mask_get	(	BMVert *	v,
		const int	cd_vert_mask_offset )

static

Definition at line 169 of file bmesh_log.cc.

References BM_ELEM_CD_GET_FLOAT, and v.

Referenced by bm_log_vert_bmvert_copy(), and bm_log_vert_values_swap().

◆ vert_mask_set()

static void vert_mask_set	(	BMVert *	v,
		const float	new_mask,
		const int	cd_vert_mask_offset )

static

Definition at line 180 of file bmesh_log.cc.

References BM_ELEM_CD_SET_FLOAT, and v.

Referenced by bm_log_vert_values_swap(), and bm_log_verts_restore().

Classes

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ logkey_cmp

◆ logkey_hash

Function Documentation

◆ BM_log_all_added()

◆ bm_log_assign_ids()

◆ BM_log_before_all_removed()

◆ BM_log_cleanup_entry()

◆ bm_log_compress_ids_to_indices()

◆ BM_log_create()

◆ BM_log_current_entry()

◆ BM_log_entry_add()

◆ bm_log_entry_create()

◆ BM_log_entry_drop()

◆ bm_log_entry_free()

◆ BM_log_face_added()

◆ bm_log_face_alloc()

◆ bm_log_face_from_id()

◆ bm_log_face_id_get()

◆ bm_log_face_id_set()

◆ BM_log_face_modified()

◆ BM_log_face_removed()

◆ bm_log_face_values_swap()

◆ bm_log_faces_restore()

◆ bm_log_faces_unmake()

◆ BM_log_find_original_vert_co()

◆ BM_log_find_original_vert_mask()

◆ BM_log_free()

◆ BM_log_from_existing_entries_create()

◆ bm_log_id_ghash_release()

◆ bm_log_id_ghash_retake()

◆ BM_log_length()

◆ BM_log_mesh_elems_reorder()

◆ BM_log_original_mask()

◆ BM_log_original_vert_co()

◆ BM_log_original_vert_data()

◆ BM_log_original_vert_no()

◆ BM_log_print_entry()

◆ BM_log_redo()

◆ BM_log_undo()

◆ BM_log_unused_ids()

◆ BM_log_vert_added()

◆ bm_log_vert_alloc()

◆ BM_log_vert_before_modified()

◆ bm_log_vert_bmvert_copy()

◆ bm_log_vert_from_id()

◆ bm_log_vert_id_get()

◆ bm_log_vert_id_set()

◆ BM_log_vert_removed()

◆ bm_log_vert_values_swap()

◆ bm_log_verts_restore()

◆ bm_log_verts_unmake()

◆ uint_compare()

◆ vert_mask_get()

◆ vert_mask_set()