#include <variant>
#include "MEM_guardedalloc.h"
#include "CLG_log.h"
#include "DNA_key_types.h"
#include "DNA_layer_types.h"
#include "DNA_mesh_types.h"
#include "DNA_meshdata_types.h"
#include "DNA_object_types.h"
#include "DNA_scene_types.h"
#include "BLI_array_utils.h"
#include "BLI_implicit_sharing.hh"
#include "BLI_listbase.h"
#include "BLI_string.h"
#include "BLI_task.hh"
#include "BLI_vector.hh"
#include "BKE_context.hh"
#include "BKE_customdata.hh"
#include "BKE_editmesh.hh"
#include "BKE_key.hh"
#include "BKE_layer.hh"
#include "BKE_lib_id.hh"
#include "BKE_main.hh"
#include "BKE_mesh.hh"
#include "BKE_object.hh"
#include "BKE_undo_system.hh"
#include "DEG_depsgraph.hh"
#include "ED_mesh.hh"
#include "ED_object.hh"
#include "ED_undo.hh"
#include "ED_util.hh"
#include "WM_api.hh"
#include "WM_types.hh"
#include "BLI_array_store.h"
#include "BLI_array_store_utils.h"
#include "BLI_task.h"

Classes
struct	BArrayCustomData

struct	UndoMesh

struct	UMArrayData

struct	MeshUndoStep_Elem

struct	MeshUndoStep

Macros
#define	USE_ARRAY_STORE

#define	ARRAY_CHUNK_SIZE_IN_BYTES 65536

#define	ARRAY_CHUNK_NUM_MIN 256

#define	USE_ARRAY_STORE_THREAD

Functions
static void *	undomesh_from_editmesh (UndoMesh um, BMEditMesh em, Key key, UndoMesh um_ref)

static void	undomesh_to_editmesh (UndoMesh um, Object ob, BMEditMesh *em)

static void	undomesh_free_data (UndoMesh *um)

static Object *	editmesh_object_from_context (bContext *C)

Undo Conversion
static size_t	array_chunk_size_calc (const size_t stride)

Array Store Utilities
static UndoMesh **	mesh_undostep_reference_elems_from_objects (Object **object, int object_len)

Implements ED Undo System
Note This is similar for all edit-mode types.
static bool	mesh_undosys_poll (bContext *C)

static bool	mesh_undosys_step_encode (bContext C, Main bmain, UndoStep *us_p)

static void	mesh_undosys_step_decode (bContext C, Main bmain, UndoStep *us_p, const eUndoStepDir, bool)

static void	mesh_undosys_step_free (UndoStep *us_p)

static void	mesh_undosys_foreach_ID_ref (UndoStep us_p, UndoTypeForEachIDRefFn foreach_ID_ref_fn, void user_data)

void	ED_mesh_undosys_type (UndoType *ut)

Variables
static CLG_LogRef	LOG = {"ed.undo.mesh"}

Array Store
#define	ARRAY_STORE_INDEX_NUM (ARRAY_STORE_INDEX_MSEL + 1)

enum	{ ARRAY_STORE_INDEX_VERT = 0 , ARRAY_STORE_INDEX_EDGE , ARRAY_STORE_INDEX_LOOP , ARRAY_STORE_INDEX_POLY , ARRAY_STORE_INDEX_POLY_OFFSETS , ARRAY_STORE_INDEX_SHAPE , ARRAY_STORE_INDEX_MSEL }

struct {

BArrayStore_AtSize bs_stride [ARRAY_STORE_INDEX_NUM]

int users

ListBase local_links

TaskPool * task_pool

}	um_arraystore = {{{nullptr}}}

static void	um_arraystore_cd_compact (CustomData cdata, const size_t data_len, const bool create, const int bs_index, const BArrayCustomData bcd_reference, BArrayCustomData **r_bcd_first)

static void	um_arraystore_cd_expand (const BArrayCustomData bcd, CustomData cdata, const size_t data_len)

static void	um_arraystore_cd_free (BArrayCustomData *bcd, const int bs_index)

static void	um_arraystore_compact_ex (UndoMesh um, const UndoMesh um_ref, bool create)

static void	um_arraystore_compact (UndoMesh um, const UndoMesh um_ref)

static void	um_arraystore_compact_with_info (UndoMesh um, const UndoMesh um_ref)

static void	um_arraystore_compact_cb (TaskPool __restrict, void taskdata)

static void	um_arraystore_expand_clear (UndoMesh *um)

static void	um_arraystore_expand (UndoMesh *um)

static void	um_arraystore_free (UndoMesh *um)

Macro Definition Documentation

◆ ARRAY_CHUNK_NUM_MIN

#define ARRAY_CHUNK_NUM_MIN 256

Definition at line 69 of file editmesh_undo.cc.

Referenced by array_chunk_size_calc().

◆ ARRAY_CHUNK_SIZE_IN_BYTES

#define ARRAY_CHUNK_SIZE_IN_BYTES 65536

This used to be much smaller (256), but this caused too much overhead when selection moved to boolean arrays. Especially with high-poly meshes where managing a large number of small chunks could be slow, blocking user interactivity. Use a larger value (in bytes) which calculates the chunk size using array_chunk_size_calc. See: #105046 & #105205.

Definition at line 68 of file editmesh_undo.cc.

Referenced by array_chunk_size_calc().

◆ ARRAY_STORE_INDEX_NUM

#define ARRAY_STORE_INDEX_NUM (ARRAY_STORE_INDEX_MSEL + 1)

Definition at line 160 of file editmesh_undo.cc.

Referenced by um_arraystore_compact_with_info(), and um_arraystore_free().

◆ USE_ARRAY_STORE

#define USE_ARRAY_STORE

Definition at line 50 of file editmesh_undo.cc.

◆ USE_ARRAY_STORE_THREAD

#define USE_ARRAY_STORE_THREAD

Definition at line 71 of file editmesh_undo.cc.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Store separate BArrayStore_AtSize so multiple threads can access array stores without locking.

Enumerator
ARRAY_STORE_INDEX_VERT
ARRAY_STORE_INDEX_EDGE
ARRAY_STORE_INDEX_LOOP
ARRAY_STORE_INDEX_POLY
ARRAY_STORE_INDEX_POLY_OFFSETS
ARRAY_STORE_INDEX_SHAPE
ARRAY_STORE_INDEX_MSEL

Definition at line 151 of file editmesh_undo.cc.

Function Documentation

◆ array_chunk_size_calc()

static size_t array_chunk_size_calc ( const size_t stride )

static

Definition at line 87 of file editmesh_undo.cc.

References ARRAY_CHUNK_NUM_MIN, ARRAY_CHUNK_SIZE_IN_BYTES, and power_of_2_max_i().

Referenced by um_arraystore_cd_compact().

◆ ED_mesh_undosys_type()

void ED_mesh_undosys_type ( UndoType * ut )

Export for ED_undo_sys.

Definition at line 1062 of file editmesh_undo.cc.

References UndoType::flags, mesh_undosys_foreach_ID_ref(), mesh_undosys_poll(), mesh_undosys_step_decode(), mesh_undosys_step_encode(), mesh_undosys_step_free(), UndoType::name, UndoType::poll, UndoType::step_decode, UndoType::step_encode, UndoType::step_foreach_ID_ref, UndoType::step_free, UndoType::step_size, and UNDOTYPE_FLAG_NEED_CONTEXT_FOR_ENCODE.

Referenced by ED_undosys_type_init().

◆ editmesh_object_from_context()

static Object * editmesh_object_from_context ( bContext * C )

static

Definition at line 901 of file editmesh_undo.cc.

References BKE_view_layer_edit_object_get(), BKE_view_layer_synced_ensure(), CTX_data_scene(), CTX_data_view_layer(), Object::data, OB_MESH, and Object::type.

Referenced by mesh_undosys_poll().

◆ mesh_undostep_reference_elems_from_objects()

static UndoMesh ** mesh_undostep_reference_elems_from_objects	(	Object **	object,
		int	object_len )

static

Create an array of UndoMesh from objects.

where each element in the resulting array is the most recently created undo-mesh for the object's mesh. When no undo-mesh can be found that array index is nullptr.

This is used for de-duplicating memory between undo steps, failure to find the undo step will store a full duplicate in memory. define DEBUG_PRINT to check memory is de-duplicating as expected.

Definition at line 701 of file editmesh_undo.cc.

References BLI_assert, BLI_ghash_free(), BLI_ghash_insert(), BLI_ghash_len(), BLI_ghash_popkey(), BLI_ghash_ptr_new_ex(), Mesh::id, UndoMesh::local_prev, MEM_callocN, MEM_freeN(), UndoMesh::mesh, POINTER_FROM_INT, ID::session_uid, and um_arraystore.

Referenced by mesh_undosys_step_encode().

◆ mesh_undosys_foreach_ID_ref()

static void mesh_undosys_foreach_ID_ref	(	UndoStep *	us_p,
		UndoTypeForEachIDRefFn	foreach_ID_ref_fn,
		void *	user_data )

static

Definition at line 1049 of file editmesh_undo.cc.

References MeshUndoStep::elems, MeshUndoStep::elems_len, MeshUndoStep_Elem::obedit_ref, and MeshUndoStep::scene_ref.

Referenced by ED_mesh_undosys_type().

◆ mesh_undosys_poll()

static bool mesh_undosys_poll ( bContext * C )

static

Definition at line 937 of file editmesh_undo.cc.

References editmesh_object_from_context().

Referenced by ED_mesh_undosys_type(), and mesh_undosys_step_decode().

◆ mesh_undosys_step_decode()

static void mesh_undosys_step_decode	(	bContext *	C,
		Main *	bmain,
		UndoStep *	us_p,
		const eUndoStepDir	,
		bool	)

static

◆ mesh_undosys_step_encode()

static bool mesh_undosys_step_encode	(	bContext *	C,
		Main *	bmain,
		UndoStep *	us_p )

static

As this is only data storage it is safe to set the session ID here.

Definition at line 942 of file editmesh_undo.cc.

References CTX_data_scene(), CTX_data_view_layer(), MeshUndoStep_Elem::data, UndoStep::data_size, ED_undo_editmode_objects_from_view_layer(), MeshUndoStep::elems, MeshUndoStep::elems_len, Mesh::id, Main::is_memfile_undo_flush_needed, MEM_callocN, MEM_freeN(), UndoMesh::mesh, mesh_undostep_reference_elems_from_objects(), BMEditMesh::needs_flush_to_id, MeshUndoStep_Elem::obedit_ref, scene, MeshUndoStep::scene_ref, ID::session_uid, MeshUndoStep::step, UndoMesh::undo_size, undomesh_from_editmesh(), ToolSettings::uv_selectmode, and UndoMesh::uv_selectmode.

Referenced by ED_mesh_undosys_type().

◆ mesh_undosys_step_free()

static void mesh_undosys_step_free ( UndoStep * us_p )

static

Definition at line 1038 of file editmesh_undo.cc.

References MeshUndoStep_Elem::data, MeshUndoStep::elems, MeshUndoStep::elems_len, MEM_freeN(), and undomesh_free_data().

Referenced by ED_mesh_undosys_type().

◆ um_arraystore_cd_compact()

static void um_arraystore_cd_compact	(	CustomData *	cdata,
		const size_t	data_len,
		const bool	create,
		const int	bs_index,
		const BArrayCustomData *	bcd_reference,
		BArrayCustomData **	r_bcd_first )

static

Definition at line 178 of file editmesh_undo.cc.

References blender::ImplicitSharingInfo::add_user(), array_chunk_size_calc(), BLI_array_store_at_size_ensure(), BLI_array_store_state_add(), CustomData_layertype_is_dynamic(), CustomData_sizeof(), blender::Array< T, InlineBufferCapacity, Allocator >::data(), CustomData::layers, MEM_SAFE_FREE, BArrayCustomData::next, blender::Array< T, InlineBufferCapacity, Allocator >::reinitialize(), BArrayCustomData::states, CustomData::totlayer, BArrayCustomData::type, CustomDataLayer::type, and um_arraystore.

◆ um_arraystore_cd_expand()

static void um_arraystore_cd_expand	(	const BArrayCustomData *	bcd,
		CustomData *	cdata,
		const size_t	data_len )

static

Note: There is no room for data going out of sync here. The layers and the states are stored together so this can be kept working.

Definition at line 320 of file editmesh_undo.cc.

References BLI_array_store_state_data_get_alloc(), BLI_assert, CustomData_sizeof(), CustomData::layers, BArrayCustomData::next, blender::Array< T, InlineBufferCapacity, Allocator >::size(), state, BArrayCustomData::states, BArrayCustomData::type, and UNUSED_VARS_NDEBUG.

Referenced by um_arraystore_expand().

◆ um_arraystore_cd_free()

static void um_arraystore_cd_free	(	BArrayCustomData *	bcd,
		const int	bs_index )

static

Definition at line 354 of file editmesh_undo.cc.

References BLI_array_store_at_size_get(), BLI_array_store_state_remove(), CustomData_sizeof(), BArrayCustomData::next, blender::Array< T, InlineBufferCapacity, Allocator >::size(), state, BArrayCustomData::states, BArrayCustomData::type, and um_arraystore.

Referenced by um_arraystore_free().

◆ um_arraystore_compact()

static void um_arraystore_compact	(	UndoMesh *	um,
		const UndoMesh *	um_ref )

static

Move data from allocated arrays to de-duplicated states and clear arrays.

Definition at line 505 of file editmesh_undo.cc.

References um_arraystore_compact_ex().

Referenced by um_arraystore_compact_with_info().

◆ um_arraystore_compact_cb()

static void um_arraystore_compact_cb	(	TaskPool *	__restrict,
		void *	taskdata )

static

Definition at line 569 of file editmesh_undo.cc.

References UMArrayData::um, um_arraystore_compact_with_info(), and UMArrayData::um_ref.

Referenced by undomesh_from_editmesh().

◆ um_arraystore_compact_ex()

static void um_arraystore_compact_ex	(	UndoMesh *	um,
		const UndoMesh *	um_ref,
		bool	create )

static

Parameters

create When false, only free the arrays. This is done since when reading from an undo state, they must be temporarily expanded. then discarded afterwards, having this argument avoids having 2x code paths.

Definition at line 382 of file editmesh_undo.cc.

References UndoMesh::mesh, and blender::threading::parallel_invoke().

Referenced by um_arraystore_compact(), and um_arraystore_expand_clear().

◆ um_arraystore_compact_with_info()

static void um_arraystore_compact_with_info	(	UndoMesh *	um,
		const UndoMesh *	um_ref )

static

Definition at line 510 of file editmesh_undo.cc.

References ARRAY_STORE_INDEX_NUM, BLI_array_store_at_size_calc_memory_usage(), double(), printf, TIMEIT_END, TIMEIT_START, um_arraystore, and um_arraystore_compact().

Referenced by um_arraystore_compact_cb(), and undomesh_from_editmesh().

◆ um_arraystore_expand()

static void um_arraystore_expand ( UndoMesh * um )

static

Definition at line 585 of file editmesh_undo.cc.

References BLI_array_store_state_data_get_alloc(), BLI_assert, KeyBlock::data, UndoMesh::edata, UndoMesh::face_offset_indices, blender::implicit_sharing::info_for_mem_free(), UndoMesh::keyblocks, UndoMesh::ldata, UndoMesh::mesh, UndoMesh::mselect, KeyBlock::next, UndoMesh::pdata, state, UndoMesh::store, KeyBlock::totelem, um_arraystore_cd_expand(), UNUSED_VARS_NDEBUG, and UndoMesh::vdata.

Referenced by undomesh_free_data(), and undomesh_to_editmesh().

◆ um_arraystore_expand_clear()

static void um_arraystore_expand_clear ( UndoMesh * um )

static

Remove data we only expanded for temporary use.

Definition at line 580 of file editmesh_undo.cc.

References um_arraystore_compact_ex().

Referenced by undomesh_to_editmesh().

◆ um_arraystore_free()

static void um_arraystore_free ( UndoMesh * um )

static

◆ undomesh_free_data()

static void undomesh_free_data ( UndoMesh * um )

static

Definition at line 873 of file editmesh_undo.cc.

References BKE_key_free_data(), BKE_mesh_free_data_for_undo(), BLI_assert, BLI_findindex(), BLI_remlink(), BLI_task_pool_work_and_wait(), MEM_freeN(), UndoMesh::mesh, um_arraystore, um_arraystore_expand(), and um_arraystore_free().

Referenced by mesh_undosys_step_free().

◆ undomesh_from_editmesh()

static void * undomesh_from_editmesh	(	UndoMesh *	um,
		BMEditMesh *	em,
		Key *	key,
		UndoMesh *	um_ref )

static

Parameters

um_ref The reference to use for de-duplicating memory between undo-steps.

Definition at line 745 of file editmesh_undo.cc.

References BKE_id_copy_ex(), BLI_addtail(), BLI_array_is_zeroed, BLI_assert, BLI_task_pool_create_background(), BLI_task_pool_push(), BLI_task_pool_work_and_wait(), BMEditMesh::bm, BM_mesh_bm_to_me(), CD_MASK_SHAPE_KEYINDEX, Key::id, Mesh::id, Mesh::key, LIB_ID_COPY_LOCALIZE, LIB_ID_COPY_NO_ANIMDATA, MEM_mallocN, UndoMesh::mesh, ID::name, params, Mesh::runtime, BMEditMesh::selectmode, UndoMesh::selectmode, BMesh::shapenr, UndoMesh::shapenr, STRNCPY, TASK_PRIORITY_LOW, UMArrayData::um, um_arraystore, um_arraystore_compact_cb(), um_arraystore_compact_with_info(), UMArrayData::um_ref, UNUSED_VARS, and CustomData_MeshMasks::vmask.

Referenced by mesh_undosys_step_encode().

◆ undomesh_to_editmesh()

static void undomesh_to_editmesh	(	UndoMesh *	um,
		Object *	ob,
		BMEditMesh *	em )

static

Variable Documentation

◆ bs_stride

BArrayStore_AtSize bs_stride[ARRAY_STORE_INDEX_NUM]

Definition at line 163 of file editmesh_undo.cc.

◆ local_links

ListBase local_links

A list of UndoMesh items ordered from oldest to newest used to access previous undo data for a mesh.

Definition at line 170 of file editmesh_undo.cc.

◆ LOG

CLG_LogRef LOG = {"ed.undo.mesh"}

static

We only need this locally.

Definition at line 79 of file editmesh_undo.cc.

Referenced by mesh_undosys_step_decode().

◆ task_pool

◆ [struct]

struct { ... } um_arraystore

Referenced by mesh_undostep_reference_elems_from_objects(), um_arraystore_cd_compact(), um_arraystore_cd_free(), um_arraystore_compact_with_info(), um_arraystore_free(), undomesh_free_data(), undomesh_from_editmesh(), and undomesh_to_editmesh().

◆ users

int users

Definition at line 164 of file editmesh_undo.cc.

Classes

Macros

Functions

Variables

Array Store

Macro Definition Documentation

◆ ARRAY_CHUNK_NUM_MIN

◆ ARRAY_CHUNK_SIZE_IN_BYTES

◆ ARRAY_STORE_INDEX_NUM

◆ USE_ARRAY_STORE

◆ USE_ARRAY_STORE_THREAD

Enumeration Type Documentation

◆ anonymous enum

Function Documentation

◆ array_chunk_size_calc()

◆ ED_mesh_undosys_type()

◆ editmesh_object_from_context()

◆ mesh_undostep_reference_elems_from_objects()

◆ mesh_undosys_foreach_ID_ref()

◆ mesh_undosys_poll()

◆ mesh_undosys_step_decode()

◆ mesh_undosys_step_encode()

◆ mesh_undosys_step_free()

◆ um_arraystore_cd_compact()

◆ um_arraystore_cd_expand()

◆ um_arraystore_cd_free()

◆ um_arraystore_compact()

◆ um_arraystore_compact_cb()

◆ um_arraystore_compact_ex()

◆ um_arraystore_compact_with_info()

◆ um_arraystore_expand()

◆ um_arraystore_expand_clear()

◆ um_arraystore_free()

◆ undomesh_free_data()

◆ undomesh_from_editmesh()

◆ undomesh_to_editmesh()

Variable Documentation

◆ bs_stride

◆ local_links

◆ LOG

◆ task_pool

◆ [struct]

◆ users