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

Classes
struct	[struct].mesh
struct	[struct].grids
struct	[struct].bmesh

Public Member Functions
bool	needs_undo () const
void	tag_needs_undo ()
void	tag_needs_redo ()

Public Attributes
Type	type = Type::None
std::string	object_name
std::string	active_shape_key_name
struct	mesh
struct	grids
struct	bmesh
float3	pivot_pos
float4	pivot_rot
NodeGeometry	geometry_original
NodeGeometry	geometry_modified
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 185 of file sculpt_undo.cc.

Member Function Documentation

needs_undo()

bool blender::ed::sculpt_paint::undo::StepData::needs_undo ( ) const

inline

Whether processing code needs to handle the current data as an undo step.

Definition at line 263 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::bmesh_handle_dyntopo_begin(), blender::ed::sculpt_paint::undo::bmesh_handle_dyntopo_end(), blender::ed::sculpt_paint::undo::bmesh_restore_generic(), and blender::ed::sculpt_paint::undo::restore_geometry().

tag_needs_redo()

void blender::ed::sculpt_paint::undo::StepData::tag_needs_redo ( )

inline

Definition at line 273 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::bmesh_handle_dyntopo_begin(), blender::ed::sculpt_paint::undo::bmesh_handle_dyntopo_end(), blender::ed::sculpt_paint::undo::bmesh_restore_generic(), and blender::ed::sculpt_paint::undo::restore_geometry().

tag_needs_undo()

void blender::ed::sculpt_paint::undo::StepData::tag_needs_undo ( )

inline

Definition at line 268 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::bmesh_handle_dyntopo_begin(), blender::ed::sculpt_paint::undo::bmesh_handle_dyntopo_end(), blender::ed::sculpt_paint::undo::bmesh_restore_generic(), and blender::ed::sculpt_paint::undo::restore_geometry().

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 200 of file sculpt_undo.cc.

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

bmesh

struct blender::ed::sculpt_paint::undo::StepData::[struct].bmesh blender::ed::sculpt_paint::undo::StepData::bmesh

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

geometry_modified

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

Definition at line 242 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::estimate_geometry_step_size(), 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 240 of file sculpt_undo.cc.

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

grids

struct blender::ed::sculpt_paint::undo::StepData::[struct].grids blender::ed::sculpt_paint::undo::StepData::grids

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

struct blender::ed::sculpt_paint::undo::StepData::[struct].mesh blender::ed::sculpt_paint::undo::StepData::mesh

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 258 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(), and blender::ed::sculpt_paint::undo::restore_list().

nodes_mutex

Mutex blender::ed::sculpt_paint::undo::StepData::nodes_mutex

Definition at line 244 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 197 of file sculpt_undo.cc.

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

pivot_pos

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

Definition at line 235 of file sculpt_undo.cc.

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

pivot_rot

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

Definition at line 236 of file sculpt_undo.cc.

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

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 194 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 255 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 260 of file sculpt_undo.cc.

Referenced by blender::ed::sculpt_paint::undo::geometry_end(), 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