Functions
BMLog *	BM_log_create (BMesh *bm)
BMLog *	BM_log_from_existing_entries_create (BMesh bm, BMLogEntry entry)
void	BM_log_free (BMLog *log)
BMLogEntry *	BM_log_entry_add (BMLog *log)
void	BM_log_cleanup_entry (BMLogEntry *entry)
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, int cd_vert_mask_offset)
void	BM_log_vert_added (BMLog log, BMVert v, 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, 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)
struct 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)

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

References 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, and v.

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

◆ 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 765 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, and v.

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

References BMLogEntry::added_faces, BMLogEntry::added_verts, 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.

◆ BM_log_create()

BMLog * BM_log_create ( BMesh * bm )

Allocate, initialize, and assign a new BMLog.

Definition at line 392 of file bmesh_log.cc.

References bm, bm_log_assign_ids(), and log.

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

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

Definition at line 512 of file bmesh_log.cc.

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

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

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

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

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

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

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

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

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

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

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 720 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(), 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(), and blender::bke::pbvh::pbvh_bmesh_face_remove().

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

References bm_log_vert_id_get(), log, Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_try(), BMLogEntry::modified_verts, 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 795 of file bmesh_log.cc.

References bm_log_vert_id_get(), log, Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_try(), BMLogEntry::modified_verts, 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 497 of file bmesh_log.cc.

References LISTBASE_FOREACH, and log.

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

References BMLogEntry::added_faces, BMLogEntry::added_verts, bm, BM_log_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 blender::ed::sculpt_paint::undo::bmesh_enable().

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

References BLI_assert, 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 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 836 of file bmesh_log.cc.

References i, log, BMLogEntry::next, and printf.

◆ BM_log_print_entry()

void BM_log_print_entry	(	BMesh *	bm,
		BMLogEntry *	entry )

Definition at line 851 of file bmesh_log.cc.

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

◆ 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 618 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_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 597 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_handle_dyntopo_end(), and blender::ed::sculpt_paint::undo::bmesh_restore_generic().

◆ BM_log_unused_ids()

struct RangeTreeUInt * BM_log_unused_ids ( BMLog * log )

For internal use only (unit testing)

Definition at line 828 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 667 of file bmesh_log.cc.

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

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

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

References BMLogEntry::added_verts, bm_log_vert_alloc(), 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 blender::ed::sculpt_paint::undo::bmesh_push(), and blender::bke::pbvh::pbvh_bmesh_collapse_edge().

◆ 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 696 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(), 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(), and blender::bke::pbvh::pbvh_bmesh_collapse_edge().

Functions

Function Documentation

◆ BM_log_all_added()

◆ BM_log_before_all_removed()

◆ BM_log_cleanup_entry()

◆ BM_log_create()

◆ BM_log_current_entry()

◆ BM_log_entry_add()

◆ BM_log_entry_drop()

◆ BM_log_face_added()

◆ BM_log_face_modified()

◆ BM_log_face_removed()

◆ BM_log_find_original_vert_co()

◆ BM_log_find_original_vert_mask()

◆ BM_log_free()

◆ BM_log_from_existing_entries_create()

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

◆ BM_log_vert_removed()