blender::ed::sculpt_paint::undo::StepData Struct Reference

Public Attributes
Type	type = Type::None
std::string	object_name
std::string	active_shape_key_name
int	mesh_verts_num
int	mesh_corners_num
int	mesh_grids_num
int	grid_size
float3	pivot_pos
float4	pivot_rot
bool	geometry_clear_pbvh
NodeGeometry	geometry_original
NodeGeometry	geometry_modified
BMLogEntry *	bm_entry
NodeGeometry	geometry_bmesh_enter
bool	applied
std::mutex	nodes_mutex
Map< const bke::pbvh::Node *, std::unique_ptr< Node > >	undo_nodes_by_pbvh_node
Vector< std::unique_ptr< Node > >	nodes
size_t	undo_size

Detailed Description

Definition at line 188 of file sculpt_undo.cc.

Member Data Documentation

active_shape_key_name

std::string blender::ed::sculpt_paint::undo::StepData::active_shape_key_name

Name of the object's active shape key when the undo step was created.

Definition at line 199 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::push_begin_ex(), and blender::ed::sculpt_paint::undo::restore_active_shape_key().

applied

bool blender::ed::sculpt_paint::undo::StepData::applied

Definition at line 230 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::bmesh_push(), blender::ed::sculpt_paint::undo::bmesh_restore_begin(), blender::ed::sculpt_paint::undo::bmesh_restore_end(), blender::ed::sculpt_paint::undo::bmesh_restore_generic(), blender::ed::sculpt_paint::undo::geometry_push(), and blender::ed::sculpt_paint::undo::restore_geometry().

bm_entry

BMLogEntry* blender::ed::sculpt_paint::undo::StepData::bm_entry

Definition at line 225 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::bmesh_enable(), blender::ed::sculpt_paint::undo::bmesh_push(), blender::ed::sculpt_paint::undo::free_step_data(), and blender::ed::sculpt_paint::undo::get_bmesh_log_entry().

geometry_bmesh_enter

NodeGeometry blender::ed::sculpt_paint::undo::StepData::geometry_bmesh_enter

Definition at line 228 of file sculpt_undo.cc.

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

geometry_clear_pbvh

bool blender::ed::sculpt_paint::undo::StepData::geometry_clear_pbvh

Definition at line 220 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::geometry_push(), blender::ed::sculpt_paint::undo::push_multires_mesh_begin(), blender::ed::sculpt_paint::undo::push_multires_mesh_end(), and blender::ed::sculpt_paint::undo::restore_geometry().

geometry_modified

NodeGeometry blender::ed::sculpt_paint::undo::StepData::geometry_modified

Definition at line 222 of file sculpt_undo.cc.

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

geometry_original

NodeGeometry blender::ed::sculpt_paint::undo::StepData::geometry_original

Definition at line 221 of file sculpt_undo.cc.

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

grid_size

int blender::ed::sculpt_paint::undo::StepData::grid_size

A copy of SubdivCCG::grid_size.

Definition at line 209 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::push_begin_ex(), and blender::ed::sculpt_paint::undo::topology_matches().

mesh_corners_num

int blender::ed::sculpt_paint::undo::StepData::mesh_corners_num

Definition at line 204 of file sculpt_undo.cc.

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

mesh_grids_num

int blender::ed::sculpt_paint::undo::StepData::mesh_grids_num

The number of grids in the entire mesh.

Definition at line 207 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::push_begin_ex(), blender::ed::sculpt_paint::undo::topology_matches(), and blender::ed::sculpt_paint::undo::use_multires_undo().

mesh_verts_num

int blender::ed::sculpt_paint::undo::StepData::mesh_verts_num

Definition at line 202 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::push_begin_ex(), and blender::ed::sculpt_paint::undo::topology_matches().

nodes

Vector<std::unique_ptr<Node> > blender::ed::sculpt_paint::undo::StepData::nodes

Storage of per-node undo data after creation of the undo step is finished.

Definition at line 246 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::bmesh_push(), blender::ed::sculpt_paint::undo::push_end_ex(), blender::ed::sculpt_paint::undo::restore_color(), blender::ed::sculpt_paint::undo::restore_list(), and blender::ed::sculpt_paint::undo::step_encode().

nodes_mutex

std::mutex blender::ed::sculpt_paint::undo::StepData::nodes_mutex

Definition at line 232 of file sculpt_undo.cc.

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

object_name

std::string blender::ed::sculpt_paint::undo::StepData::object_name

Name of the object associated with this undo data (object.id.name).

Definition at line 196 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::push_begin_ex(), and blender::ed::sculpt_paint::undo::restore_list().

pivot_pos

float3 blender::ed::sculpt_paint::undo::StepData::pivot_pos

Definition at line 211 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::push_begin_ex(), and blender::ed::sculpt_paint::undo::restore_list().

pivot_rot

float4 blender::ed::sculpt_paint::undo::StepData::pivot_rot

Definition at line 212 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::push_begin_ex(), and blender::ed::sculpt_paint::undo::restore_list().

type

Type blender::ed::sculpt_paint::undo::StepData::type = Type::None

The type of data stored in this undo step. For historical reasons this is often set when the first undo node is pushed.

Definition at line 193 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::bmesh_push(), blender::ed::sculpt_paint::undo::bmesh_restore(), blender::ed::sculpt_paint::undo::bmesh_restore_generic(), blender::ed::sculpt_paint::undo::geometry_push(), blender::ed::sculpt_paint::undo::get_node(), blender::ed::sculpt_paint::undo::push_node(), blender::ed::sculpt_paint::undo::push_nodes(), blender::ed::sculpt_paint::undo::restore_list(), and blender::ed::sculpt_paint::undo::step_encode().

undo_nodes_by_pbvh_node

Map<const bke::pbvh::Node *, std::unique_ptr<Node> > blender::ed::sculpt_paint::undo::StepData::undo_nodes_by_pbvh_node

#undo::Node is stored per #pbvh::Node to reduce data storage needed for changes only impacting small portions of the mesh. During undo step creation and brush evaluation we often need to look up the undo state for a specific node. That lookup must be protected by a lock since nodes are pushed from multiple threads. This map speeds up undo node access to reduce the amount of time we wait for the lock.

This is only accessible when building the undo step, in between push_begin and push_end.

Definition at line 243 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::ensure_node(), blender::ed::sculpt_paint::undo::get_node(), and blender::ed::sculpt_paint::undo::push_end_ex().

undo_size

size_t blender::ed::sculpt_paint::undo::StepData::undo_size

Definition at line 248 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::push_end_ex(), and blender::ed::sculpt_paint::undo::step_encode().

---

The documentation for this struct was generated from the following file:

• sculpt_undo.cc