Blender V5.0
Public Attributes | List of all members
blender::ed::sculpt_paint::PaintStroke Struct Reference

Public Attributes

std::unique_ptr< PaintModeData > mode_data
void * stroke_cursor
wmTimer * timer
std::optional< RandomNumberGenerator > rng
ViewContext vc
Paint * paint
Brush * brush
UnifiedPaintSettings * ups
PaintSample samples [PAINT_MAX_INPUT_SAMPLES]
int num_samples
int cur_sample
int tot_samples
float2 last_mouse_position
float3 last_world_space_position
float3 last_scene_spacing_delta
bool stroke_over_mesh
float stroke_distance
bool stroke_started
bool rake_started
int event_type
bool stroke_init
bool input_init
float2 initial_mouse
float cached_size_pressure
float last_pressure
int stroke_mode
float last_tablet_event_pressure
float zoom_2d
bool pen_flip
float2 tilt
bool constrain_line
float2 constrained_pos
StrokeGetLocation get_location
StrokeTestStart test_start
StrokeUpdateStep update_step
StrokeRedraw redraw
StrokeDone done
bool original

Detailed Description

Common structure for various paint operators (e.g. Sculpt, Grease Pencil, Curves Sculpt)

Callback functions defined and stored on this struct (e.g. StrokeGetLocation) allow each of these modes to customize specific behavior while still sharing other common handing.

See paint_stroke_modal for the majority of the paint operator logic.

Definition at line 75 of file paint_stroke.cc.

Member Data Documentation

◆ brush

Brush* blender::ed::sculpt_paint::PaintStroke::brush

Definition at line 84 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_line_strokes_spacing(), blender::ed::sculpt_paint::paint_smooth_stroke(), blender::ed::sculpt_paint::paint_space_stroke(), blender::ed::sculpt_paint::paint_space_stroke_spacing(), blender::ed::sculpt_paint::paint_space_stroke_spacing_variable(), blender::ed::sculpt_paint::paint_stroke_curve_end(), blender::ed::sculpt_paint::paint_stroke_exec(), blender::ed::sculpt_paint::paint_stroke_line_end(), blender::ed::sculpt_paint::paint_stroke_modal(), blender::ed::sculpt_paint::paint_stroke_new(), and blender::ed::sculpt_paint::stroke_done().

◆ cached_size_pressure

float blender::ed::sculpt_paint::PaintStroke::cached_size_pressure

Definition at line 115 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_update().

◆ constrain_line

bool blender::ed::sculpt_paint::PaintStroke::constrain_line

Definition at line 129 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_draw_line_cursor(), blender::ed::sculpt_paint::paint_stroke_line_constrain(), and blender::ed::sculpt_paint::paint_stroke_modal().

◆ constrained_pos

float2 blender::ed::sculpt_paint::PaintStroke::constrained_pos

Definition at line 130 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_draw_line_cursor(), and blender::ed::sculpt_paint::paint_stroke_line_constrain().

◆ cur_sample

int blender::ed::sculpt_paint::PaintStroke::cur_sample

Definition at line 91 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_stroke_add_sample().

◆ done

StrokeDone blender::ed::sculpt_paint::PaintStroke::done

Definition at line 136 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_stroke_new(), and blender::ed::sculpt_paint::stroke_done().

◆ event_type

int blender::ed::sculpt_paint::PaintStroke::event_type

Definition at line 109 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_stroke_modal(), and blender::ed::sculpt_paint::paint_stroke_new().

◆ get_location

StrokeGetLocation blender::ed::sculpt_paint::PaintStroke::get_location

Definition at line 132 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_update(), blender::ed::sculpt_paint::paint_stroke_exec(), and blender::ed::sculpt_paint::paint_stroke_new().

◆ initial_mouse

float2 blender::ed::sculpt_paint::PaintStroke::initial_mouse

Definition at line 114 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_update().

◆ input_init

bool blender::ed::sculpt_paint::PaintStroke::input_init

Definition at line 113 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_update().

◆ last_mouse_position

float2 blender::ed::sculpt_paint::PaintStroke::last_mouse_position

Definition at line 94 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_stroke_add_step(), blender::ed::sculpt_paint::paint_draw_line_cursor(), blender::ed::sculpt_paint::paint_draw_smooth_cursor(), blender::ed::sculpt_paint::paint_line_strokes_spacing(), blender::ed::sculpt_paint::paint_smooth_stroke(), blender::ed::sculpt_paint::paint_space_stroke(), blender::ed::sculpt_paint::paint_stroke_curve_end(), blender::ed::sculpt_paint::paint_stroke_line_constrain(), blender::ed::sculpt_paint::paint_stroke_line_end(), and blender::ed::sculpt_paint::paint_stroke_modal().

◆ last_pressure

float blender::ed::sculpt_paint::PaintStroke::last_pressure

Definition at line 117 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_stroke_add_step(), blender::ed::sculpt_paint::paint_smooth_stroke(), blender::ed::sculpt_paint::paint_space_stroke(), blender::ed::sculpt_paint::paint_space_stroke_spacing_variable(), blender::ed::sculpt_paint::paint_stroke_curve_end(), and blender::ed::sculpt_paint::paint_stroke_modal().

◆ last_scene_spacing_delta

float3 blender::ed::sculpt_paint::PaintStroke::last_scene_spacing_delta

Definition at line 96 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_stroke_add_step(), and blender::ed::sculpt_paint::paint_space_stroke().

◆ last_tablet_event_pressure

float blender::ed::sculpt_paint::PaintStroke::last_tablet_event_pressure

Definition at line 120 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_stroke_modal().

◆ last_world_space_position

float3 blender::ed::sculpt_paint::PaintStroke::last_world_space_position

Definition at line 95 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_stroke_add_step(), blender::ed::sculpt_paint::paint_line_strokes_spacing(), blender::ed::sculpt_paint::paint_space_stroke(), blender::ed::sculpt_paint::paint_space_stroke_spacing(), blender::ed::sculpt_paint::paint_stroke_curve_end(), and blender::ed::sculpt_paint::paint_stroke_modal().

◆ mode_data

std::unique_ptr<PaintModeData> blender::ed::sculpt_paint::PaintStroke::mode_data

Definition at line 76 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_stroke_mode_data(), and blender::ed::sculpt_paint::paint_stroke_set_mode_data().

◆ num_samples

int blender::ed::sculpt_paint::PaintStroke::num_samples

Definition at line 90 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_stroke_add_sample(), and blender::ed::sculpt_paint::paint_stroke_sample_average().

◆ original

bool blender::ed::sculpt_paint::PaintStroke::original

Definition at line 138 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_stroke_add_step(), blender::ed::sculpt_paint::paint_brush_update(), blender::ed::sculpt_paint::paint_line_strokes_spacing(), blender::ed::sculpt_paint::paint_space_stroke(), blender::ed::sculpt_paint::paint_stroke_curve_end(), blender::ed::sculpt_paint::paint_stroke_modal(), and blender::ed::sculpt_paint::paint_stroke_new().

◆ paint

Paint* blender::ed::sculpt_paint::PaintStroke::paint

Definition at line 83 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_stroke_add_step(), blender::ed::sculpt_paint::paint_line_strokes_spacing(), blender::ed::sculpt_paint::paint_space_stroke(), blender::ed::sculpt_paint::paint_space_stroke_spacing(), blender::ed::sculpt_paint::paint_stroke_curve_end(), blender::ed::sculpt_paint::paint_stroke_free(), blender::ed::sculpt_paint::paint_stroke_jitter_pos(), blender::ed::sculpt_paint::paint_stroke_line_end(), blender::ed::sculpt_paint::paint_stroke_modal(), blender::ed::sculpt_paint::paint_stroke_new(), and blender::ed::sculpt_paint::stroke_done().

◆ pen_flip

bool blender::ed::sculpt_paint::PaintStroke::pen_flip

Definition at line 123 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_stroke_flipped(), and blender::ed::sculpt_paint::paint_stroke_modal().

◆ rake_started

bool blender::ed::sculpt_paint::PaintStroke::rake_started

Definition at line 107 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_update().

◆ redraw

StrokeRedraw blender::ed::sculpt_paint::PaintStroke::redraw

Definition at line 135 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_stroke_modal(), blender::ed::sculpt_paint::paint_stroke_new(), and blender::ed::sculpt_paint::stroke_done().

◆ rng

std::optional<RandomNumberGenerator> blender::ed::sculpt_paint::PaintStroke::rng

Definition at line 79 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_update().

◆ samples

PaintSample blender::ed::sculpt_paint::PaintStroke::samples[PAINT_MAX_INPUT_SAMPLES]

Definition at line 89 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_stroke_add_sample(), and blender::ed::sculpt_paint::paint_stroke_sample_average().

◆ stroke_cursor

void* blender::ed::sculpt_paint::PaintStroke::stroke_cursor

Definition at line 77 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_stroke_free(), and blender::ed::sculpt_paint::paint_stroke_modal().

◆ stroke_distance

float blender::ed::sculpt_paint::PaintStroke::stroke_distance

Definition at line 100 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_update(), blender::ed::sculpt_paint::paint_line_strokes_spacing(), blender::ed::sculpt_paint::paint_space_stroke(), blender::ed::sculpt_paint::paint_stroke_distance_get(), and blender::ed::sculpt_paint::paint_stroke_modal().

◆ stroke_init

bool blender::ed::sculpt_paint::PaintStroke::stroke_init

Definition at line 111 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_stroke_modal().

◆ stroke_mode

int blender::ed::sculpt_paint::PaintStroke::stroke_mode

Definition at line 118 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_stroke_inverted(), blender::ed::sculpt_paint::paint_stroke_jitter_pos(), blender::ed::sculpt_paint::paint_stroke_modal(), blender::ed::sculpt_paint::paint_stroke_new(), and blender::ed::sculpt_paint::paint_supports_smooth_stroke().

◆ stroke_over_mesh

bool blender::ed::sculpt_paint::PaintStroke::stroke_over_mesh

Definition at line 98 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_line_strokes_spacing(), blender::ed::sculpt_paint::paint_space_stroke(), blender::ed::sculpt_paint::paint_stroke_curve_end(), and blender::ed::sculpt_paint::paint_stroke_modal().

◆ stroke_started

bool blender::ed::sculpt_paint::PaintStroke::stroke_started

Definition at line 105 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_stroke_curve_end(), blender::ed::sculpt_paint::paint_stroke_exec(), blender::ed::sculpt_paint::paint_stroke_line_end(), blender::ed::sculpt_paint::paint_stroke_modal(), blender::ed::sculpt_paint::paint_stroke_started(), and blender::ed::sculpt_paint::stroke_done().

◆ test_start

StrokeTestStart blender::ed::sculpt_paint::PaintStroke::test_start

Definition at line 133 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_stroke_curve_end(), blender::ed::sculpt_paint::paint_stroke_exec(), blender::ed::sculpt_paint::paint_stroke_modal(), and blender::ed::sculpt_paint::paint_stroke_new().

◆ tilt

float2 blender::ed::sculpt_paint::PaintStroke::tilt

Definition at line 126 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_stroke_add_step(), and blender::ed::sculpt_paint::paint_stroke_modal().

◆ timer

wmTimer* blender::ed::sculpt_paint::PaintStroke::timer

Definition at line 78 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_stroke_free(), and blender::ed::sculpt_paint::paint_stroke_modal().

◆ tot_samples

int blender::ed::sculpt_paint::PaintStroke::tot_samples

Definition at line 92 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_stroke_add_step().

◆ update_step

StrokeUpdateStep blender::ed::sculpt_paint::PaintStroke::update_step

Definition at line 134 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_stroke_add_step(), blender::ed::sculpt_paint::paint_stroke_exec(), and blender::ed::sculpt_paint::paint_stroke_new().

◆ ups

UnifiedPaintSettings* blender::ed::sculpt_paint::PaintStroke::ups

Definition at line 85 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_stroke_new().

◆ vc

ViewContext blender::ed::sculpt_paint::PaintStroke::vc

Definition at line 82 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_stroke_add_step(), blender::ed::sculpt_paint::paint_draw_line_cursor(), blender::ed::sculpt_paint::paint_draw_smooth_cursor(), blender::ed::sculpt_paint::paint_line_strokes_spacing(), blender::ed::sculpt_paint::paint_space_stroke(), blender::ed::sculpt_paint::paint_space_stroke_spacing(), blender::ed::sculpt_paint::paint_stroke_curve_end(), blender::ed::sculpt_paint::paint_stroke_modal(), blender::ed::sculpt_paint::paint_stroke_new(), and blender::ed::sculpt_paint::paint_stroke_view_context().

◆ zoom_2d

float blender::ed::sculpt_paint::PaintStroke::zoom_2d

Definition at line 122 of file paint_stroke.cc.

Referenced by blender::ed::sculpt_paint::paint_brush_update(), blender::ed::sculpt_paint::paint_line_strokes_spacing(), blender::ed::sculpt_paint::paint_smooth_stroke(), blender::ed::sculpt_paint::paint_space_stroke(), blender::ed::sculpt_paint::paint_space_stroke_spacing(), blender::ed::sculpt_paint::paint_stroke_jitter_pos(), and blender::ed::sculpt_paint::paint_stroke_new().

The documentation for this struct was generated from the following file:
Generated on for Blender by  doxygen 1.16.1