#include <sculpt_intern.hh>

Public Member Functions
	StrokeCache ()
	~StrokeCache ()

Public Attributes
float	initial_radius = 0.0f
float3	scale = float3(0)
struct {
uint8_t flag = 0
float3 tolerance = float3(0)
float4x4 mat = float4x4::identity()
float4x4 mat_inv = float4x4::identity()
}	mirror_modifier_clip
float2	initial_mouse = float2(0)
bool	initial_direction_flipped = false
float	radius = 0.0f
float	radius_squared = 0.0f
float3	location = float3(0)
float3	last_location = float3(0)
float3	location_symm = float3(0)
float3	last_location_symm = float3(0)
float	stroke_distance = 0.0f
int	iteration_count = 0
float	dyntopo_pixel_radius = 0.0f
bool	is_last_valid = false
bool	pen_flip = false
bool	invert = false
float	pressure = 0.0f
float	hardness = 0.0f
float	bstrength = 0.0f
float	normal_weight = 0.0f
float2	tilt = float2(0)
float2	mouse = float2(0)
float2	mouse_event = float2(0)
struct {
Array< float3 > prev_displacement
Array< float3 > limit_surface_co
}	displacement_smear
std::optional< blender::float3 >	initial_hsv_jitter
bool	first_time = false
float4x4	projection_mat = float4x4::identity()
ViewContext *	vc = nullptr
const Brush *	brush = nullptr
const Paint *	paint = nullptr
float	special_rotation = 0.0f
float3	grab_delta = float3(0)
float3	grab_delta_symm = float3(0)
float3	old_grab_location = float3(0)
float3	orig_grab_location = float3(0)
std::optional< math::Quaternion >	rake_rotation
std::optional< math::Quaternion >	rake_rotation_symm
SculptRakeData	rake_data
int	paint_face_set = SCULPT_FACE_SET_NONE
int	symmetry = 0
ePaintSymmetryFlags	mirror_symmetry_pass = ePaintSymmetryFlags(0)
float3	view_normal = float3(0)
float3	view_normal_symm = float3(0)
float3	sculpt_normal = float3(0)
float3	sculpt_normal_symm = float3(0)
float4x4	brush_local_mat = float4x4::identity()
float4x4	brush_local_mat_inv = float4x4::identity()
float3	plane_offset = float3(0)
int	tile_pass = 0
float3	last_center = float3(0)
int	radial_symmetry_pass = 0
float4x4	symm_rot_mat = float4x4::identity()
float4x4	symm_rot_mat_inv = float4x4::identity()
bool	accum = false
struct {
float flow = 0.0f
float4 wet_mix_prev_color = float4(0)
float wet_mix = 0.0f
float wet_persistence = 0.0f
std::optional< float > density_seed
float density = 0.0f
Array< float4 > mix_colors
Array< float4 > prev_colors
}	paint_brush
std::unique_ptr< pose::IKChain >	pose_ik_chain
Array< float3 >	detail_directions
struct {
float front_angle = 0.0f
std::array< float, 10 > pressure_stabilizer
int stabilizer_index = 0
}	clay_thumb_brush
struct {
std::optional< float3 > last_normal
std::optional< float3 > last_center
Array< float3 > normals
Array< float3 > centers
int normal_index = 0
int center_index = 0
bool first_time = false
}	plane_brush
std::unique_ptr< cloth::SimulationData >	cloth_sim
float3	initial_location_symm = float3(0)
float3	initial_location = float3(0)
float3	initial_normal_symm = float3(0)
float3	initial_normal = float3(0)
std::array< std::unique_ptr< boundary::SculptBoundary >, PAINT_SYMM_AREAS >	boundaries
Array< float3 >	surface_smooth_laplacian_disp
Array< float >	layer_displacement_factor
float	vertex_rotation = 0.0f
Dial *	dial = nullptr
Brush *	saved_active_brush = nullptr
char	saved_mask_brush_tool = 0
int	saved_smooth_size = 0
bool	alt_smooth = false
float	plane_trim_squared = 0.0f
bool	supports_gravity = false
float3	gravity_direction = float3(0)
float3	gravity_direction_symm = float3(0)
std::unique_ptr< auto_mask::Cache >	automasking
float4x4	stroke_local_mat = float4x4::identity()
float	multiplane_scrape_angle = 0.0f

Detailed Description

This structure contains all the temporary data needed for individual brush strokes.

Definition at line 156 of file sculpt_intern.hh.

Constructor & Destructor Documentation

◆ StrokeCache()

blender::ed::sculpt_paint::StrokeCache::StrokeCache ( )

default

◆ ~StrokeCache()

blender::ed::sculpt_paint::StrokeCache::~StrokeCache ( )

Definition at line 3814 of file sculpt.cc.

References BLI_dial_free(), and dial.

Member Data Documentation

◆ accum

bool blender::ed::sculpt_paint::StrokeCache::accum = false

Accumulate mode.

Note: inverted for SCULPT_BRUSH_TYPE_DRAW_SHARP.

Definition at line 308 of file sculpt_intern.hh.

◆ alt_smooth

bool blender::ed::sculpt_paint::StrokeCache::alt_smooth = false

Whether the modifier key that controls smoothing is active currently. Generally signals a change in behavior for different brushes.

See also: BrushStrokeMode::BRUSH_STROKE_SMOOTH.

Definition at line 397 of file sculpt_intern.hh.

◆ automasking

std::unique_ptr<auto_mask::Cache> blender::ed::sculpt_paint::StrokeCache::automasking

Definition at line 405 of file sculpt_intern.hh.

◆ boundaries

std::array<std::unique_ptr<boundary::SculptBoundary>, PAINT_SYMM_AREAS> blender::ed::sculpt_paint::StrokeCache::boundaries

Definition at line 373 of file sculpt_intern.hh.

Referenced by blender::ed::sculpt_paint::boundary::do_boundary_brush(), blender::ed::sculpt_paint::boundary::get_mesh_strength(), blender::ed::sculpt_paint::boundary::init_boundary_bmesh(), blender::ed::sculpt_paint::boundary::init_boundary_grids(), and blender::ed::sculpt_paint::boundary::init_boundary_mesh().

◆ brush

const Brush* blender::ed::sculpt_paint::StrokeCache::brush = nullptr

Definition at line 244 of file sculpt_intern.hh.

◆ brush_local_mat

float4x4 blender::ed::sculpt_paint::StrokeCache::brush_local_mat = float4x4::identity()

Used for area texture mode, local_mat gets calculated by calc_brush_local_mat() and used in sculpt_apply_texture(). Transforms from model-space coords to local area coords.

Definition at line 288 of file sculpt_intern.hh.

Referenced by sculpt_apply_texture(), and update_brush_local_mat().

◆ brush_local_mat_inv

float4x4 blender::ed::sculpt_paint::StrokeCache::brush_local_mat_inv = float4x4::identity()

The matrix from local area coords to model-space coords is used to calculate the vector displacement in area plane mode.

Definition at line 293 of file sculpt_intern.hh.

Referenced by SCULPT_calc_vertex_displacement(), and update_brush_local_mat().

◆ bstrength

float blender::ed::sculpt_paint::StrokeCache::bstrength = 0.0f

Depending on the mode, can either be the raw brush strength, or a scaled (possibly negative) value.

See also: brush_strength for Sculpt Mode.

Definition at line 214 of file sculpt_intern.hh.

◆ center_index

int blender::ed::sculpt_paint::StrokeCache::center_index = 0

Definition at line 352 of file sculpt_intern.hh.

◆ centers

Array<float3> blender::ed::sculpt_paint::StrokeCache::centers

Definition at line 350 of file sculpt_intern.hh.

◆ [struct]

struct { ... } blender::ed::sculpt_paint::StrokeCache::clay_thumb_brush

Referenced by blender::ed::sculpt_paint::brushes::clay_thumb_get_stabilized_pressure(), blender::ed::sculpt_paint::brushes::do_clay_thumb_brush(), and blender::ed::sculpt_paint::sculpt_update_cache_variants().

◆ cloth_sim

std::unique_ptr<cloth::SimulationData> blender::ed::sculpt_paint::StrokeCache::cloth_sim

Definition at line 366 of file sculpt_intern.hh.

◆ density

float blender::ed::sculpt_paint::StrokeCache::density = 0.0f

Definition at line 319 of file sculpt_intern.hh.

Referenced by blender::ed::sculpt_paint::cache_paint_invariants_update(), and blender::ed::sculpt_paint::color::do_paint_brush_task().

◆ density_seed

std::optional<float> blender::ed::sculpt_paint::StrokeCache::density_seed

Definition at line 318 of file sculpt_intern.hh.

Referenced by blender::ed::sculpt_paint::color::do_paint_brush(), and blender::ed::sculpt_paint::color::do_paint_brush_task().

◆ detail_directions

Array<float3> blender::ed::sculpt_paint::StrokeCache::detail_directions

Definition at line 333 of file sculpt_intern.hh.

Referenced by blender::ed::sculpt_paint::brushes::do_enhance_details_brush().

◆ dial

Dial* blender::ed::sculpt_paint::StrokeCache::dial = nullptr

Definition at line 384 of file sculpt_intern.hh.

Referenced by blender::ed::sculpt_paint::sculpt_update_cache_invariants(), blender::ed::sculpt_paint::sculpt_update_cache_variants(), and ~StrokeCache().

◆ [struct]

struct { ... } blender::ed::sculpt_paint::StrokeCache::displacement_smear

Referenced by blender::ed::sculpt_paint::brushes::do_displacement_smear_brush().

◆ dyntopo_pixel_radius

float blender::ed::sculpt_paint::StrokeCache::dyntopo_pixel_radius = 0.0f

Definition at line 193 of file sculpt_intern.hh.

Referenced by blender::ed::sculpt_paint::dynamic_topology_update(), and blender::ed::sculpt_paint::sculpt_update_cache_variants().

◆ first_time

bool blender::ed::sculpt_paint::StrokeCache::first_time = false

True if the current step is the first time the Plane brush is being evaluated.

We cannot use the generic first_time variable used by other brushes because the Plane brush uses grab_delta to compute its local matrix. Since grab_delta requires at least two stroke steps, the first step (and successive steps if the user does not move the cursor) of the Plane brush is always skipped.

Definition at line 237 of file sculpt_intern.hh.

Referenced by blender::ed::sculpt_paint::color::do_paint_brush(), SCULPT_stroke_is_first_brush_step(), SCULPT_stroke_is_first_brush_step_of_symmetry_pass(), blender::ed::sculpt_paint::sculpt_update_cache_invariants(), blender::ed::sculpt_paint::sculpt_update_cache_variants(), blender::ed::sculpt_paint::stroke_update_step(), blender::ed::sculpt_paint::vwpaint::update_cache_invariants(), and blender::ed::sculpt_paint::vwpaint::update_cache_variants().

◆ flag

uint8_t blender::ed::sculpt_paint::StrokeCache::flag = 0

Definition at line 161 of file sculpt_intern.hh.

Referenced by blender::ed::sculpt_paint::clip_and_lock_translations(), blender::ed::sculpt_paint::clip_and_lock_translations(), blender::ed::sculpt_paint::sculpt_init_mirror_clipping(), and blender::ed::sculpt_paint::sculpt_update_cache_invariants().

◆ flow

float blender::ed::sculpt_paint::StrokeCache::flow = 0.0f

Definition at line 312 of file sculpt_intern.hh.

Referenced by blender::ed::sculpt_paint::cache_paint_invariants_update(), and blender::ed::sculpt_paint::color::do_paint_brush_task().

◆ front_angle

float blender::ed::sculpt_paint::StrokeCache::front_angle = 0.0f

Definition at line 338 of file sculpt_intern.hh.

Referenced by blender::ed::sculpt_paint::brushes::do_clay_thumb_brush().

◆ grab_delta

float3 blender::ed::sculpt_paint::StrokeCache::grab_delta = float3(0)

Definition at line 248 of file sculpt_intern.hh.

Referenced by blender::ed::sculpt_paint::brush_delta_update(), blender::ed::sculpt_paint::pose::calc_rotate_deform(), blender::ed::sculpt_paint::pose::calc_scale_deform(), blender::ed::sculpt_paint::pose::calc_squash_stretch_deform(), blender::ed::sculpt_paint::cloth::plane_falloff_preview_draw(), SCULPT_cache_calc_brushdata_symm(), and blender::ed::sculpt_paint::pose::sculpt_pose_do_translate_deform().

◆ grab_delta_symm

float3 blender::ed::sculpt_paint::StrokeCache::grab_delta_symm = float3(0)

Definition at line 249 of file sculpt_intern.hh.

◆ gravity_direction

float3 blender::ed::sculpt_paint::StrokeCache::gravity_direction = float3(0)

Definition at line 402 of file sculpt_intern.hh.

Referenced by SCULPT_cache_calc_brushdata_symm(), and blender::ed::sculpt_paint::sculpt_update_cache_invariants().

◆ gravity_direction_symm

float3 blender::ed::sculpt_paint::StrokeCache::gravity_direction_symm = float3(0)

Definition at line 403 of file sculpt_intern.hh.

Referenced by blender::ed::sculpt_paint::cloth::cloth_brush_apply_brush_forces(), blender::ed::sculpt_paint::brushes::do_gravity_brush(), and SCULPT_cache_calc_brushdata_symm().

◆ hardness

float blender::ed::sculpt_paint::StrokeCache::hardness = 0.0f

Definition at line 207 of file sculpt_intern.hh.

Referenced by blender::ed::sculpt_paint::apply_hardness_to_distances(), blender::ed::sculpt_paint::cache_paint_invariants_update(), blender::ed::sculpt_paint::color::do_paint_brush_task(), blender::ed::sculpt_paint::brushes::sample_node_surface_bmesh(), blender::ed::sculpt_paint::brushes::sample_node_surface_grids(), and blender::ed::sculpt_paint::brushes::sample_node_surface_mesh().

◆ initial_direction_flipped

bool blender::ed::sculpt_paint::StrokeCache::initial_direction_flipped = false

Some brushes change behavior drastically depending on the directional value (i.e. the smooth and enhance details functionality being bound to the Smooth brush).

Storing the initial direction allows discerning the behavior without checking the sign of the brush direction at every step, which would have ambiguity at 0.

Definition at line 175 of file sculpt_intern.hh.

Referenced by blender::ed::sculpt_paint::do_brush_action(), blender::ed::sculpt_paint::brushes::do_plane_brush(), and blender::ed::sculpt_paint::sculpt_update_cache_invariants().