Blender V5.3
grease_pencil_intern.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
7#include <functional>
8
9#include "BLI_index_mask.hh"
10#include "BLI_task.hh"
11
12#include "DNA_scene_types.h"
13
14#include "ED_grease_pencil.hh"
15
16#include "../paint_intern.hh"
17
18namespace blender {
19
20namespace bke::greasepencil {
21class Drawing;
22class Layer;
23} // namespace bke::greasepencil
24namespace bke::crazyspace {
26}
27
28namespace ed::sculpt_paint {
29
36 std::function<float3(const float3 position, const float2 &screen_delta)>;
37
42
44 public:
45 virtual void on_stroke_begin(const bContext &C, const InputSample &start_sample) = 0;
46 virtual void on_stroke_extended(const bContext &C, const InputSample &extension_sample) = 0;
47 virtual void on_stroke_done(const bContext &C) = 0;
48};
49
50namespace greasepencil {
51
52/* Get list of drawings the tool should be operating on. */
55 const bContext &C);
56/* Get the brush radius accounting for pen pressure. */
57float brush_radius(const Paint &paint, const Brush &brush, float pressure);
58
59/* Make sure the brush has all necessary grease pencil settings. */
61
62/* Index mask of all points within the brush radius. */
64 const Brush &brush,
65 const float2 &mouse_position,
66 float pressure,
67 float multi_frame_falloff,
68 const IndexMask &selection,
69 Span<float2> view_positions,
70 Vector<float> &influences,
71 IndexMaskMemory &memory);
72
73/* Influence value at point co for the brush. */
75 const Brush &brush,
76 const float2 &co,
77 const InputSample &sample,
78 float multi_frame_falloff);
84float closest_distance_to_surface_2d(const float2 pt, const Span<float2> verts);
85/* Influence value for an entire fill. */
87 const Brush &brush,
88 Span<float2> fill_positions,
89 const InputSample &sample,
90 float multi_frame_falloff);
91
92/* Based on pinning status, decide whether to use vertex color or material mode for brush. */
93bool brush_using_vertex_color(const GpPaint *gp_paint, const Brush *brush);
94
95/* True if influence of the brush should be inverted. */
96bool is_brush_inverted(const Brush &brush, BrushStrokeMode stroke_mode);
97
98/* Common parameters for stroke callbacks that can be passed to utility functions. */
103 const Scene &scene;
111
112 /* NOTE: accessing region in worker threads will return null,
113 * this has to be done on the main thread and passed explicitly. */
115 Depsgraph &depsgraph,
118 Object &object,
119 int layer_index,
120 int frame_number,
123};
124
125/* Point index mask for a drawing based on selection tool settings. */
127 bool use_selection_masking,
128 IndexMaskMemory &memory);
130 bool use_selection_masking,
131 IndexMaskMemory &memory);
133 bool use_selection_masking,
134 IndexMaskMemory &memory);
135
137 const GreasePencilStrokeParams &params);
138
139/* Set the screen space position to a impossibly far coordinate for all the points
140 * that are outside near/far clipping planes, this is to prevent accidental
141 * interactions with points not visibly present in the camera. */
142constexpr float invalid_screen_position = -1e10f;
143
144/* Project points from layer space into 2D view space. */
146 const IndexMask &point_mask);
148 const IndexMask &selection);
150 const IndexMask &selection);
152 const IndexMask &curve_mask);
154 const IndexMask &selection);
155
156/* Get an appropriate projection function from screen space to layer space.
157 * This is an alternative to using the DrawingPlacement. */
159 const Object &object,
161
169 const bke::crazyspace::GeometryDeformation &deformation,
170 int index,
171 const float2 &screen_delta);
172
174bool do_vertex_color_fill(const Brush &brush);
175
176/* Stroke operation base class that performs various common initializations. */
178 public:
181
183
188
189 /* When auto-masking is used, this contains the index mask of the elements that are affected. */
195
200
201 bool is_inverted(const Brush &brush) const;
202 float2 mouse_delta(const InputSample &input_sample) const;
203
204 void init_stroke(const bContext &C, const InputSample &start_sample);
205 void init_auto_masking(const bContext &C, const InputSample &start_sample);
206 void stroke_extended(const InputSample &extension_sample);
207
209 const bContext &C,
210 FunctionRef<bool(const GreasePencilStrokeParams &params, const IndexMask &points)> fn) const;
212 const bContext &C,
213 FunctionRef<bool(const GreasePencilStrokeParams &params,
214 const IndexMask &points,
215 const DeltaProjectionFunc &projection_fn)> fn) const;
216
218 const bContext &C,
219 FunctionRef<bool(const GreasePencilStrokeParams &params,
220 const DeltaProjectionFunc &projection_fn)> fn) const;
221
224 FunctionRef<bool(const GreasePencilStrokeParams &params)> fn,
225 const exec_mode::Mode &mode = exec_mode::serial) const;
226};
227
228/* Operations */
229
230std::unique_ptr<GreasePencilStrokeOperation> new_paint_operation(bool do_fill_guides = false);
231std::unique_ptr<GreasePencilStrokeOperation> new_erase_operation(bool temp_eraser = false);
232std::unique_ptr<GreasePencilStrokeOperation> new_tint_operation(bool temp_eraser = false);
233std::unique_ptr<GreasePencilStrokeOperation> new_weight_paint_draw_operation(
234 const BrushStrokeMode &stroke_mode);
235std::unique_ptr<GreasePencilStrokeOperation> new_weight_paint_blur_operation();
236std::unique_ptr<GreasePencilStrokeOperation> new_weight_paint_average_operation();
237std::unique_ptr<GreasePencilStrokeOperation> new_weight_paint_smear_operation();
238std::unique_ptr<GreasePencilStrokeOperation> new_smooth_operation(BrushStrokeMode stroke_mode,
239 bool temp_smooth = false);
240std::unique_ptr<GreasePencilStrokeOperation> new_thickness_operation(BrushStrokeMode stroke_mode);
241std::unique_ptr<GreasePencilStrokeOperation> new_strength_operation(BrushStrokeMode stroke_mode);
242std::unique_ptr<GreasePencilStrokeOperation> new_randomize_operation(BrushStrokeMode stroke_mode);
243std::unique_ptr<GreasePencilStrokeOperation> new_grab_operation(BrushStrokeMode stroke_mode);
244std::unique_ptr<GreasePencilStrokeOperation> new_push_operation(BrushStrokeMode stroke_mode);
245std::unique_ptr<GreasePencilStrokeOperation> new_pinch_operation(BrushStrokeMode stroke_mode);
246std::unique_ptr<GreasePencilStrokeOperation> new_twist_operation(BrushStrokeMode stroke_mode);
247std::unique_ptr<GreasePencilStrokeOperation> new_clone_operation(BrushStrokeMode stroke_mode);
248std::unique_ptr<GreasePencilStrokeOperation> new_vertex_average_operation();
249std::unique_ptr<GreasePencilStrokeOperation> new_vertex_blur_operation();
250std::unique_ptr<GreasePencilStrokeOperation> new_vertex_paint_operation(
251 BrushStrokeMode stroke_mode);
252std::unique_ptr<GreasePencilStrokeOperation> new_vertex_replace_operation();
253std::unique_ptr<GreasePencilStrokeOperation> new_vertex_smear_operation();
254
255} // namespace greasepencil
256
257} // namespace ed::sculpt_paint
258
259} // namespace blender
#define C
Definition RandGen.cpp:29
virtual void on_stroke_extended(const bContext &C, const InputSample &extension_sample)=0
virtual void on_stroke_begin(const bContext &C, const InputSample &start_sample)=0
virtual void on_stroke_done(const bContext &C)=0
void foreach_editable_drawing_with_automask(const bContext &C, FunctionRef< bool(const GreasePencilStrokeParams &params, const IndexMask &points)> fn) const
void init_stroke(const bContext &C, const InputSample &start_sample)
void init_auto_masking(const bContext &C, const InputSample &start_sample)
void foreach_editable_drawing(const bContext &C, FunctionRef< bool(const GreasePencilStrokeParams &params, const DeltaProjectionFunc &projection_fn)> fn) const
void foreach_editable_drawing_with_automask(const bContext &C, FunctionRef< bool(const GreasePencilStrokeParams &params, const IndexMask &points, const DeltaProjectionFunc &projection_fn)> fn) const
#define position
#define layer
IndexMask curve_mask_for_stroke_operation(const GreasePencilStrokeParams &params, bool use_selection_masking, IndexMaskMemory &memory)
std::unique_ptr< GreasePencilStrokeOperation > new_vertex_replace_operation()
Vector< ed::greasepencil::MutableDrawingInfo > get_drawings_for_stroke_operation(const bContext &C)
Array< float2 > view_positions_left_from_point_mask(const GreasePencilStrokeParams &params, const IndexMask &selection)
std::unique_ptr< GreasePencilStrokeOperation > new_erase_operation(const bool temp_eraser)
Definition erase.cc:1189
bool is_brush_inverted(const Brush &brush, BrushStrokeMode stroke_mode)
std::unique_ptr< GreasePencilStrokeOperation > new_weight_paint_average_operation()
float closest_distance_to_surface_2d(const float2 pt, const Span< float2 > verts)
std::unique_ptr< GreasePencilStrokeOperation > new_strength_operation(BrushStrokeMode stroke_mode)
Array< float2 > view_positions_right_from_point_mask(const GreasePencilStrokeParams &params, const IndexMask &selection)
IndexMask fill_mask_for_stroke_operation(const GreasePencilStrokeParams &params, bool use_selection_masking, IndexMaskMemory &memory)
std::unique_ptr< GreasePencilStrokeOperation > new_grab_operation(BrushStrokeMode stroke_mode)
std::unique_ptr< GreasePencilStrokeOperation > new_weight_paint_blur_operation()
bool do_vertex_color_fill(const Brush &brush)
std::unique_ptr< GreasePencilStrokeOperation > new_tint_operation(bool temp_eraser=false)
Definition tint.cc:344
Array< float2 > view_positions_from_curve_mask(const GreasePencilStrokeParams &params, const IndexMask &curve_mask)
std::unique_ptr< GreasePencilStrokeOperation > new_vertex_paint_operation(BrushStrokeMode stroke_mode)
IndexMask point_mask_for_stroke_operation(const GreasePencilStrokeParams &params, bool use_selection_masking, IndexMaskMemory &memory)
std::unique_ptr< GreasePencilStrokeOperation > new_paint_operation(bool do_fill_guides=false)
IndexMask brush_point_influence_mask(const Paint &paint, const Brush &brush, const float2 &mouse_position, float pressure, float multi_frame_falloff, const IndexMask &selection, Span< float2 > view_positions, Vector< float > &influences, IndexMaskMemory &memory)
float brush_point_influence(const Paint &paint, const Brush &brush, const float2 &co, const InputSample &sample, float multi_frame_falloff)
std::unique_ptr< GreasePencilStrokeOperation > new_clone_operation(BrushStrokeMode stroke_mode)
std::unique_ptr< GreasePencilStrokeOperation > new_randomize_operation(BrushStrokeMode stroke_mode)
Array< float2 > view_positions_from_point_mask(const GreasePencilStrokeParams &params, const IndexMask &point_mask)
std::unique_ptr< GreasePencilStrokeOperation > new_vertex_blur_operation()
bool brush_using_vertex_color(const GpPaint *gp_paint, const Brush *brush)
std::unique_ptr< GreasePencilStrokeOperation > new_weight_paint_draw_operation(const BrushStrokeMode &stroke_mode)
Vector< ed::greasepencil::MutableDrawingInfo > get_drawings_with_masking_for_stroke_operation(const bContext &C)
std::unique_ptr< GreasePencilStrokeOperation > new_thickness_operation(BrushStrokeMode stroke_mode)
std::unique_ptr< GreasePencilStrokeOperation > new_pinch_operation(BrushStrokeMode stroke_mode)
std::unique_ptr< GreasePencilStrokeOperation > new_push_operation(BrushStrokeMode stroke_mode)
float brush_fill_influence(const Paint &paint, const Brush &brush, Span< float2 > fill_positions, const InputSample &sample, float multi_frame_falloff)
bke::crazyspace::GeometryDeformation get_drawing_deformation(const GreasePencilStrokeParams &params)
Array< float > view_radii_from_point_selection(const GreasePencilStrokeParams &params, const IndexMask &selection)
std::unique_ptr< GreasePencilStrokeOperation > new_weight_paint_smear_operation()
DeltaProjectionFunc get_screen_projection_fn(const GreasePencilStrokeParams &params, const Object &object, const bke::greasepencil::Layer &layer)
std::unique_ptr< GreasePencilStrokeOperation > new_vertex_average_operation()
std::unique_ptr< GreasePencilStrokeOperation > new_twist_operation(BrushStrokeMode stroke_mode)
bool do_vertex_color_points(const Brush &brush)
std::unique_ptr< GreasePencilStrokeOperation > new_smooth_operation(BrushStrokeMode stroke_mode, bool temp_smooth=false)
float3 compute_orig_delta(const DeltaProjectionFunc &projection_fn, const bke::crazyspace::GeometryDeformation &deformation, int index, const float2 &screen_delta)
std::unique_ptr< GreasePencilStrokeOperation > new_vertex_smear_operation()
float brush_radius(const Paint &paint, const Brush &brush, float pressure)
std::function< float3(const float3 position, const float2 &screen_delta)> DeltaProjectionFunc
constexpr Serial serial
BMesh Iterators.
VecBase< float, 2 > float2
VecBase< float, 3 > float3
static GreasePencilStrokeParams from_context(const Scene &scene, Depsgraph &depsgraph, ARegion &region, RegionView3D &rv3d, Object &object, int layer_index, int frame_number, float multi_frame_falloff, bke::greasepencil::Drawing &drawing)