#include "MEM_guardedalloc.h"
#include "BLI_listbase.h"
#include "BLI_map.hh"
#include "BLI_math_vector.h"
#include "BLI_pool.hh"
#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

Functions
static uint	bm_log_vert_id_get (BMLog log, BMVert v)
static void	bm_log_vert_id_set (BMLog log, BMVert v, const uint id)
static BMVert *	bm_log_vert_from_id (BMLog *log, const uint id)
static uint	bm_log_face_id_get (BMLog log, BMFace f)
static void	bm_log_face_id_set (BMLog log, BMFace f, const uint id)
static BMFace *	bm_log_face_from_id (BMLog *log, const 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, const blender::Map< uint, BMLogVert *, 0 > &verts)
static void	bm_log_faces_unmake (BMesh bm, BMLog log, const blender::Map< uint, BMLogFace *, 0 > &faces)
static void	bm_log_verts_restore (BMesh bm, BMLog log, const blender::Map< uint, BMLogVert *, 0 > &verts)
static void	bm_log_faces_restore (BMesh bm, BMLog log, const blender::Map< uint, BMLogFace *, 0 > &faces)
static void	bm_log_vert_values_swap (BMesh bm, BMLog log, const blender::Map< uint, BMLogVert *, 0 > &verts)
static void	bm_log_face_values_swap (BMLog log, const blender::Map< uint, BMLogFace , 0 > &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 int	uint_compare (const void a_v, const void b_v)
static blender::Map< uint, uint >	bm_log_compress_ids_to_indices (uint *ids, uint totid)
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)
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)
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 (const BMLog log, const char description)
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.

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 806 of file bmesh_log.cc.

References bm, BM_FACES_OF_MESH, BM_ITER_MESH, BM_log_all_added(), 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 BM_log_all_added(), blender::ed::sculpt_paint::undo::bmesh_push(), and blender::ed::sculpt_paint::symmetrize_exec().

◆ bm_log_assign_ids()

void bm_log_assign_ids	(	BMesh *	bm,
		BMLog *	log )

static

Definition at line 343 of file bmesh_log.cc.

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

Referenced by bm_log_assign_ids(), and 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 834 of file bmesh_log.cc.

References bm, BM_FACES_OF_MESH, BM_ITER_MESH, BM_log_before_all_removed(), 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 BM_log_before_all_removed(), 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 434 of file bmesh_log.cc.

References BMLogEntry::added_faces, BMLogEntry::added_verts, BM_log_cleanup_entry(), Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::clear(), BMLogEntry::deleted_faces, BMLogEntry::deleted_verts, Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::keys(), BMLogEntry::log, log, BMLogEntry::modified_faces, and BMLogEntry::modified_verts.

Referenced by BM_log_cleanup_entry().

◆ bm_log_compress_ids_to_indices()

blender::Map< uint, uint > bm_log_compress_ids_to_indices	(	uint *	ids,
		uint	totid )

static

Definition at line 405 of file bmesh_log.cc.

References bm_log_compress_ids_to_indices(), i, result, and uint_compare().

Referenced by bm_log_compress_ids_to_indices(), and BM_log_mesh_elems_reorder().

◆ BM_log_create()

BMLog * BM_log_create ( BMesh * bm )

Allocate, initialize, and assign a new BMLog.

Definition at line 419 of file bmesh_log.cc.

References bm, bm_log_assign_ids(), BM_log_create(), log, BMesh::totface, and BMesh::totvert.

Referenced by BM_log_create(), 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 892 of file bmesh_log.cc.

References BM_log_current_entry(), and log.

Referenced by BM_log_current_entry().

◆ 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.

Finally, the new entry is set as the current log entry.

Definition at line 581 of file bmesh_log.cc.

References BLI_addtail(), BM_log_entry_add(), bm_log_entry_create(), BMLogEntry::log, and log.

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

◆ bm_log_entry_create()

BMLogEntry * bm_log_entry_create ( )

static

Definition at line 363 of file bmesh_log.cc.

References bm_log_entry_create().

Referenced by BM_log_entry_add(), and bm_log_entry_create().

◆ 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.

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

Definition at line 595 of file bmesh_log.cc.

References BMLogEntry::added_faces, BMLogEntry::added_verts, BLI_assert, BLI_assert_msg, BLI_remlink(), BM_log_entry_drop(), bm_log_entry_free(), Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::keys(), BMLogEntry::log, log, BMLogEntry::next, and BMLogEntry::prev.

Referenced by BM_log_entry_drop(), and blender::ed::sculpt_paint::undo::free_step_data().

◆ bm_log_entry_free()

void bm_log_entry_free ( BMLogEntry * entry )

static

Definition at line 373 of file bmesh_log.cc.

References BMLogEntry::allocated_faces, BMLogEntry::allocated_verts, BLI_assert, bm_log_entry_free(), blender::Pool< T, ChunkLen >::destruct(), BMLogEntry::face_pool, blender::Pool< T, ChunkLen >::is_empty(), blender::Pool< T, ChunkLen >::size(), Vector< T, InlineBufferCapacity, Allocator >::size(), and BMLogEntry::vert_pool.

Referenced by BM_log_entry_drop(), and bm_log_entry_free().

◆ 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 753 of file bmesh_log.cc.

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

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

◆ bm_log_face_alloc()

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

static

Definition at line 203 of file bmesh_log.cc.

References BMLogEntry::allocated_faces, Vector< T, InlineBufferCapacity, Allocator >::append(), BLI_assert, BM_face_as_array_vert_tri(), bm_log_face_alloc(), bm_log_vert_id_get(), blender::Pool< T, ChunkLen >::construct(), BMLogEntry::face_pool, BMFace::head, BMHeader::hflag, BMFace::len, log, and v.

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

◆ bm_log_face_from_id()

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

static

Definition at line 153 of file bmesh_log.cc.

References bm_log_face_from_id(), and log.

Referenced by bm_log_face_from_id(), bm_log_face_values_swap(), and bm_log_faces_unmake().

◆ bm_log_face_id_get()

uint bm_log_face_id_get	(	BMLog *	log,
		BMFace *	f )

static

Definition at line 140 of file bmesh_log.cc.

References bm_log_face_id_get(), and log.

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

◆ bm_log_face_id_set()

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

static

Definition at line 146 of file bmesh_log.cc.

References bm_log_face_id_set(), and log.

Referenced by bm_log_assign_ids(), BM_log_face_added(), bm_log_face_id_set(), 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 745 of file bmesh_log.cc.

References bm_log_face_alloc(), bm_log_face_id_get(), BM_log_face_modified(), and log.

Referenced by BM_log_face_modified(), and 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 789 of file bmesh_log.cc.

References Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), BMLogEntry::added_faces, BLI_assert, bm_log_face_alloc(), bm_log_face_id_get(), BM_log_face_removed(), Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::contains(), BMLogEntry::deleted_faces, log, Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup(), and Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::remove().

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

◆ bm_log_face_values_swap()

void bm_log_face_values_swap	(	BMLog *	log,
		const blender::Map< uint, BMLogFace *, 0 > &	faces )

static

Definition at line 329 of file bmesh_log.cc.

References bm_log_face_from_id(), bm_log_face_values_swap(), BMFace::head, BMHeader::hflag, blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::items(), and log.

Referenced by bm_log_face_values_swap(), BM_log_redo(), and BM_log_undo().

◆ bm_log_faces_restore()

void bm_log_faces_restore	(	BMesh *	bm,
		BMLog *	log,
		const blender::Map< uint, BMLogFace *, 0 > &	faces )

static

Definition at line 283 of file bmesh_log.cc.

References bm, BM_CREATE_NOP, BM_ELEM_CD_SET_INT, BM_face_create_verts(), bm_log_face_id_set(), bm_log_faces_restore(), bm_log_vert_from_id(), CD_PROP_INT32, CustomData_get_offset_named(), BMFace::head, BMHeader::hflag, blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::items(), log, BMesh::pdata, and v.

Referenced by bm_log_faces_restore(), BM_log_redo(), and BM_log_undo().

◆ bm_log_faces_unmake()

void bm_log_faces_unmake	(	BMesh *	bm,
		BMLog *	log,
		const blender::Map< uint, BMLogFace *, 0 > &	faces )

static

Definition at line 243 of file bmesh_log.cc.

References bm, BM_edge_is_wire(), BM_edge_kill(), BM_FACE_FIRST_LOOP, BM_face_kill(), bm_log_face_from_id(), bm_log_faces_unmake(), BMLoop::e, i, blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::keys(), log, and BMLoop::next.

Referenced by bm_log_faces_unmake(), 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 853 of file bmesh_log.cc.

References BM_log_find_original_vert_co(), bm_log_vert_id_get(), log, Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_try(), BMLogEntry::modified_verts, and v.

Referenced by BM_log_find_original_vert_co(), 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 864 of file bmesh_log.cc.

References BM_log_find_original_vert_mask(), bm_log_vert_id_get(), log, Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_try(), BMLogEntry::modified_verts, and v.

Referenced by BM_log_find_original_vert_mask(), and 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 524 of file bmesh_log.cc.

References BM_log_free(), LISTBASE_FOREACH, and log.

Referenced by BM_log_free(), 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 unused IDs field of the log will be initialized by taking all keys from all Maps in the log entry.

Parameters

entry The last entry of the prior BMLog, its prev pointer will be followed back to reconstruct the log.

Definition at line 471 of file bmesh_log.cc.

References BMLogEntry::added_faces, BMLogEntry::added_verts, bm, BM_log_create(), BM_log_from_existing_entries_create(), BMLogEntry::deleted_faces, BMLogEntry::deleted_verts, Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::keys(), BMLogEntry::log, log, BMLogEntry::modified_faces, BMLogEntry::modified_verts, BMLogEntry::next, and BMLogEntry::prev.

Referenced by BM_log_from_existing_entries_create(), and blender::ed::sculpt_paint::undo::bmesh_enable().

◆ 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 539 of file bmesh_log.cc.

References bm, BM_FACES_OF_MESH, BM_ITER_MESH_INDEX, bm_log_compress_ids_to_indices(), bm_log_face_id_get(), BM_log_mesh_elems_reorder(), bm_log_vert_id_get(), BM_mesh_remap(), BM_VERTS_OF_MESH, i, log, blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup(), MEM_freeN(), MEM_malloc_arrayN(), BMesh::totface, BMesh::totvert, and v.

Referenced by BM_log_mesh_elems_reorder(), and sculptsession_bm_to_me_update_data_only().

◆ 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 875 of file bmesh_log.cc.

References BLI_assert, BM_log_original_vert_data(), bm_log_vert_id_get(), Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::contains(), log, Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup(), BMLogEntry::modified_verts, BMLogVert::normal, BMLogVert::position, and v.

Referenced by BM_log_original_vert_data(), and blender::ed::sculpt_paint::orig_position_data_gather_bmesh().

◆ BM_log_print()

void BM_log_print	(	const BMLog *	log,
		const char *	description )

Definition at line 905 of file bmesh_log.cc.

References BM_log_print(), i, log, BMLogEntry::next, and printf.

Referenced by BM_log_print().

◆ BM_log_print_entry()

void BM_log_print_entry	(	BMesh *	bm,
		BMLogEntry *	entry )

Definition at line 920 of file bmesh_log.cc.

References BMLogEntry::added_faces, BMLogEntry::added_verts, bm, BM_log_print_entry(), BMLogEntry::deleted_faces, BMLogEntry::deleted_verts, BMLogEntry::modified_faces, BMLogEntry::modified_verts, printf, Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::size(), BMesh::totedge, BMesh::totface, BMesh::totloop, and BMesh::totvert.

Referenced by BM_log_print_entry().

◆ 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 687 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_redo(), 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 BM_log_redo(), blender::ed::sculpt_paint::undo::bmesh_handle_dyntopo_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 666 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_undo(), 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 BM_log_undo(), blender::ed::sculpt_paint::undo::bmesh_handle_dyntopo_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 897 of file bmesh_log.cc.

References BM_log_unused_ids(), and log.

Referenced by BM_log_unused_ids().

◆ 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 736 of file bmesh_log.cc.

References BM_log_vert_added(), bm_log_vert_alloc(), bm_log_vert_id_set(), log, and v.

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

◆ bm_log_vert_alloc()

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

static

Definition at line 191 of file bmesh_log.cc.

References BMLogEntry::allocated_verts, Vector< T, InlineBufferCapacity, Allocator >::append(), bm_log_vert_alloc(), bm_log_vert_bmvert_copy(), blender::Pool< T, ChunkLen >::construct(), log, v, and BMLogEntry::vert_pool.

Referenced by BM_log_vert_added(), bm_log_vert_alloc(), 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 721 of file bmesh_log.cc.

References BMLogEntry::added_verts, bm_log_vert_alloc(), BM_log_vert_before_modified(), bm_log_vert_bmvert_copy(), bm_log_vert_id_get(), Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::contains(), log, Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup(), Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_or_add_cb(), BMLogEntry::modified_verts, and v.

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

◆ bm_log_vert_bmvert_copy()

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

static

Definition at line 182 of file bmesh_log.cc.

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

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

◆ bm_log_vert_from_id()

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

static

Definition at line 134 of file bmesh_log.cc.

References bm_log_vert_from_id(), and log.

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

◆ bm_log_vert_id_get()

uint bm_log_vert_id_get	(	BMLog *	log,
		BMVert *	v )

static

Definition at line 121 of file bmesh_log.cc.

References bm_log_vert_id_get(), log, 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_vert_data(), BM_log_vert_before_modified(), bm_log_vert_id_get(), and BM_log_vert_removed().

◆ bm_log_vert_id_set()

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

static

Definition at line 127 of file bmesh_log.cc.

References bm_log_vert_id_set(), log, and v.

Referenced by bm_log_assign_ids(), BM_log_vert_added(), bm_log_vert_id_set(), 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 765 of file bmesh_log.cc.

References Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), BMLogEntry::added_verts, BLI_assert, bm_log_vert_alloc(), bm_log_vert_id_get(), BM_log_vert_removed(), Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::contains(), BMLogEntry::deleted_verts, log, Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup(), Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_try(), BMLogEntry::modified_verts, Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::remove(), and v.

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

◆ bm_log_vert_values_swap()

void bm_log_vert_values_swap	(	BMesh *	bm,
		BMLog *	log,
		const blender::Map< uint, BMLogVert *, 0 > &	verts )

static

Definition at line 309 of file bmesh_log.cc.

References bm, bm_log_vert_from_id(), bm_log_vert_values_swap(), CD_PROP_FLOAT, BMVert::co, CustomData_get_offset_named(), BMVert::head, BMHeader::hflag, BMLogVert::hflag, blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::items(), log, BMLogVert::mask, mask(), BMVert::no, BMLogVert::normal, BMLogVert::position, swap_v3_v3(), v, BMesh::vdata, vert_mask_get(), and vert_mask_set().

Referenced by BM_log_redo(), BM_log_undo(), and bm_log_vert_values_swap().

◆ bm_log_verts_restore()

void bm_log_verts_restore	(	BMesh *	bm,
		BMLog *	log,
		const blender::Map< uint, BMLogVert *, 0 > &	verts )

static

Definition at line 266 of file bmesh_log.cc.

References bm, BM_CREATE_NOP, bm_log_vert_id_set(), bm_log_verts_restore(), BM_vert_create(), CD_PROP_FLOAT, copy_v3_v3(), CustomData_get_offset_named(), BMVert::head, BMHeader::hflag, BMLogVert::hflag, blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::items(), log, BMLogVert::mask, BMVert::no, BMLogVert::normal, BMLogVert::position, v, BMesh::vdata, and vert_mask_set().

Referenced by BM_log_redo(), BM_log_undo(), and bm_log_verts_restore().

◆ bm_log_verts_unmake()

void bm_log_verts_unmake	(	BMesh *	bm,
		BMLog *	log,
		const blender::Map< uint, BMLogVert *, 0 > &	verts )

static

Definition at line 225 of file bmesh_log.cc.

References bm, bm_log_vert_bmvert_copy(), bm_log_vert_from_id(), bm_log_verts_unmake(), BM_vert_kill(), CD_PROP_FLOAT, CustomData_get_offset_named(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::items(), log, v, and BMesh::vdata.

Referenced by BM_log_redo(), BM_log_undo(), and bm_log_verts_unmake().

◆ uint_compare()

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

static

Definition at line 390 of file bmesh_log.cc.

References b, and uint_compare().

Referenced by bm_log_compress_ids_to_indices(), and uint_compare().

◆ vert_mask_get()

float vert_mask_get	(	BMVert *	v,
		const int	cd_vert_mask_offset )

static

Definition at line 163 of file bmesh_log.cc.

References BM_ELEM_CD_GET_FLOAT, v, and vert_mask_get().

Referenced by bm_log_vert_bmvert_copy(), bm_log_vert_values_swap(), and vert_mask_get().

◆ vert_mask_set()

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

static

Definition at line 174 of file bmesh_log.cc.

References BM_ELEM_CD_SET_FLOAT, v, and vert_mask_set().

Referenced by bm_log_vert_values_swap(), bm_log_verts_restore(), and vert_mask_set().

Classes

Functions

Detailed Description

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_mesh_elems_reorder()

◆ BM_log_original_vert_data()

◆ BM_log_print()

◆ 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()