blender::ed::sculpt_paint::auto_mask::Cache Struct Reference

#include <sculpt_automask.hh>

Public Types
enum class	OcclusionValue : int8_t { Unknown = 0 , Visible = 1 , Occluded = 2 }

Public Attributes
Settings	settings
Array< float >	factor
Array< OcclusionValue >	occlusion
Array< float >	cavity_factor
bool	can_reuse_mask
uchar	current_stroke_id

Detailed Description

Definition at line 51 of file sculpt_automask.hh.

Member Enumeration Documentation

OcclusionValue

enum class blender::ed::sculpt_paint::auto_mask::Cache::OcclusionValue : int8_t

strong

Enumerator
Unknown
Visible
Occluded

Definition at line 57 of file sculpt_automask.hh.

Member Data Documentation

can_reuse_mask

bool blender::ed::sculpt_paint::auto_mask::Cache::can_reuse_mask

Definition at line 80 of file sculpt_automask.hh.

cavity_factor

Array<float> blender::ed::sculpt_paint::auto_mask::Cache::cavity_factor

Cached cavity factor values for each vertex.

Note

-1 means the vertex value still needs to be calculated.

Definition at line 78 of file sculpt_automask.hh.

Referenced by blender::ed::sculpt_paint::auto_mask::calc_cavity_factor_bmesh(), blender::ed::sculpt_paint::auto_mask::calc_cavity_factor_grids(), and blender::ed::sculpt_paint::auto_mask::calc_cavity_factor_mesh().

current_stroke_id

uchar blender::ed::sculpt_paint::auto_mask::Cache::current_stroke_id

Definition at line 81 of file sculpt_automask.hh.

factor

Array<float> blender::ed::sculpt_paint::auto_mask::Cache::factor

Cached factor for auto-masking modes that are implemented to process the entire mesh.

Definition at line 55 of file sculpt_automask.hh.

Referenced by blender::ed::sculpt_paint::auto_mask::calc_face_factors(), blender::ed::sculpt_paint::auto_mask::calc_grids_factors(), blender::ed::sculpt_paint::auto_mask::calc_vert_factors(), and blender::ed::sculpt_paint::auto_mask::calc_vert_factors().

occlusion

Array<OcclusionValue> blender::ed::sculpt_paint::auto_mask::Cache::occlusion

Cached occlusion values for each vertex. Since calculating the occlusion is so expensive, it's only calculated at the beginning of a stroke and stored for later.

Todo

Ideally the "unknown" state would be stored per node rather than per vertex, with a lock-protected Map<const bke::pbvh::Node , BitVector<>> for example. Currently complications with face domain auto-masking prevent this though. This array can't be a bitmap because it's written to from multiple threads at the same time.

Definition at line 71 of file sculpt_automask.hh.

Referenced by blender::ed::sculpt_paint::auto_mask::calc_view_occlusion_factor().

settings

Settings blender::ed::sculpt_paint::auto_mask::Cache::settings

Definition at line 52 of file sculpt_automask.hh.

Referenced by blender::ed::sculpt_paint::auto_mask::cache_settings_update(), blender::ed::sculpt_paint::auto_mask::calc_brush_normal_factor(), blender::ed::sculpt_paint::auto_mask::calc_cavity_factor(), blender::ed::sculpt_paint::auto_mask::calc_cavity_factor_bmesh(), blender::ed::sculpt_paint::auto_mask::calc_cavity_factor_grids(), blender::ed::sculpt_paint::auto_mask::calc_cavity_factor_mesh(), blender::ed::sculpt_paint::auto_mask::calc_face_factors(), blender::ed::sculpt_paint::auto_mask::calc_grids_factors(), blender::ed::sculpt_paint::auto_mask::calc_vert_factors(), blender::ed::sculpt_paint::auto_mask::calc_vert_factors(), blender::ed::sculpt_paint::auto_mask::calc_view_normal_factor(), and blender::ed::sculpt_paint::auto_mask::process_cavity_factor().

---

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

• sculpt_automask.hh