Blender V5.3
brushes.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2024 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include "BLI_index_mask.hh"
14
15#include <optional>
16
17namespace blender {
18
19struct Brush;
20struct Depsgraph;
21struct Scene;
22struct Sculpt;
23namespace ed::sculpt_paint {
24struct StrokeCache;
25};
26struct SculptSession;
27struct Object;
28namespace bke::pbvh {
29class Node;
30}
31
33
37
38 /* For planar brushes, the plane center and normal are calculated based on the original cursor
39 * position and needed for further calculations when performing brush strokes.
40 */
41 std::optional<float3> plane_center;
42 std::optional<float3> plane_normal;
43};
44
45void do_clay_brush(const Depsgraph &depsgraph,
46 const Sculpt &sd,
47 Object &ob,
48 const IndexMask &node_mask);
56void do_clay_strips_brush(const Depsgraph &depsgraph,
57 const Sculpt &sd,
58 Object &ob,
59 const IndexMask &node_mask,
60 const float3 &plane_normal,
61 const float3 &plane_center);
62namespace clay_strips {
64 const StrokeCache &cache,
65 const float3 &plane_normal,
66 const float3 &plane_center,
67 const bool flip);
68CursorSampleResult calc_node_mask(const Depsgraph &depsgraph,
69 Object &ob,
70 const Brush &brush,
71 IndexMaskMemory &memory);
72} // namespace clay_strips
73void do_clay_thumb_brush(const Depsgraph &depsgraph,
74 const Sculpt &sd,
75 Object &ob,
76 const IndexMask &node_mask);
78
79void do_crease_brush(const Depsgraph &depsgraph,
80 const Sculpt &sd,
81 Object &ob,
82 const IndexMask &node_mask);
83void do_blob_brush(const Depsgraph &depsgraph,
84 const Sculpt &sd,
85 Object &ob,
86 const IndexMask &node_mask);
87void do_bmesh_topology_rake_brush(const Depsgraph &depsgraph,
88 const Sculpt &sd,
89 Object &ob,
90 const IndexMask &node_mask,
91 float strength);
92void do_displacement_eraser_brush(const Depsgraph &depsgraph,
93 const Sculpt &sd,
94 Object &ob,
95 const IndexMask &node_mask);
96void do_displacement_smear_brush(const Depsgraph &depsgraph,
97 const Sculpt &sd,
98 Object &ob,
99 const IndexMask &node_mask);
100void do_draw_face_sets_brush(const Depsgraph &depsgraph,
101 const Sculpt &sd,
102 Object &object,
103 const IndexMask &node_mask);
105void do_draw_brush(const Depsgraph &depsgraph,
106 const Sculpt &sd,
107 Object &object,
108 const IndexMask &node_mask);
110void do_draw_vector_displacement_brush(const Depsgraph &depsgraph,
111 const Sculpt &sd,
112 Object &object,
113 const IndexMask &node_mask);
114void do_draw_sharp_brush(const Depsgraph &depsgraph,
115 const Sculpt &sd,
116 Object &object,
117 const IndexMask &node_mask);
118void do_elastic_deform_brush(const Depsgraph &depsgraph,
119 const Sculpt &sd,
120 Object &object,
121 const IndexMask &node_mask);
122void do_enhance_details_brush(const Depsgraph &depsgraph,
123 const Sculpt &sd,
124 Object &object,
125 const IndexMask &node_mask);
126void do_plane_brush(const Depsgraph &depsgraph,
127 const Sculpt &sd,
128 Object &object,
129 const IndexMask &node_mask,
130 const float3 &plane_normal,
131 const float3 &plane_center);
132
133namespace plane {
134CursorSampleResult calc_node_mask(const Depsgraph &depsgraph,
135 Object &ob,
136 const Brush &brush,
137 IndexMaskMemory &memory);
138}
139
140void do_grab_brush(const Depsgraph &depsgraph,
141 const Sculpt &sd,
142 Object &ob,
143 const IndexMask &node_mask);
144void do_gravity_brush(const Depsgraph &depsgraph,
145 const Sculpt &sd,
146 Object &ob,
147 const IndexMask &node_mask);
148void do_inflate_brush(const Depsgraph &depsgraph,
149 const Sculpt &sd,
150 Object &ob,
151 const IndexMask &node_mask);
152void do_layer_brush(const Depsgraph &depsgraph,
153 const Sculpt &sd,
154 Object &object,
155 const IndexMask &node_mask);
157void do_mask_brush(const Depsgraph &depsgraph,
158 const Sculpt &sd,
159 Object &object,
160 const IndexMask &node_mask);
161void do_multiplane_scrape_brush(const Depsgraph &depsgraph,
162 const Sculpt &sd,
163 Object &object,
164 const IndexMask &node_mask);
166 const Brush &brush,
167 const SculptSession &ss,
168 const float outline_col[3],
169 float outline_alpha);
170
171void do_pinch_brush(const Depsgraph &depsgraph,
172 const Sculpt &sd,
173 Object &object,
174 const IndexMask &node_mask);
175void do_nudge_brush(const Depsgraph &depsgraph,
176 const Sculpt &sd,
177 Object &object,
178 const IndexMask &node_mask);
179void do_relax_face_sets_brush(const Depsgraph &depsgraph,
180 const Sculpt &sd,
181 Object &object,
182 const IndexMask &node_mask);
183void do_rotate_brush(const Depsgraph &depsgraph,
184 const Sculpt &sd,
185 Object &object,
186 const IndexMask &node_mask);
187void do_scene_project_brush(const Depsgraph &depsgraph,
188 const Sculpt &sd,
189 Object &object,
190 const IndexMask &node_mask);
192void do_smooth_brush(const Depsgraph &depsgraph,
193 const Sculpt &sd,
194 Object &object,
195 const IndexMask &node_mask,
196 float brush_strength);
198void do_smooth_mask_brush(const Depsgraph &depsgraph,
199 const Sculpt &sd,
200 Object &object,
201 const IndexMask &node_mask,
202 float brush_strength);
203void do_snake_hook_brush(const Depsgraph &depsgraph,
204 const Sculpt &sd,
205 Object &object,
206 const IndexMask &node_mask);
207void do_surface_smooth_brush(const Depsgraph &depsgraph,
208 const Sculpt &sd,
209 Object &object,
210 const IndexMask &node_mask);
211void do_thumb_brush(const Depsgraph &depsgraph,
212 const Sculpt &sd,
213 Object &object,
214 const IndexMask &node_mask);
215void do_topology_slide_brush(const Depsgraph &depsgraph,
216 const Sculpt &sd,
217 Object &object,
218 const IndexMask &node_mask);
219void do_topology_relax_brush(const Depsgraph &depsgraph,
220 const Sculpt &sd,
221 Object &object,
222 const IndexMask &node_mask);
223
224} // namespace ed::sculpt_paint::brushes
225
226} // namespace blender
float4x4 calc_local_matrix(const Brush &brush, const StrokeCache &cache, const float3 &plane_normal, const float3 &plane_center, const bool flip)
CursorSampleResult calc_node_mask(const Depsgraph &depsgraph, Object &ob, const Brush &brush, IndexMaskMemory &memory)
CursorSampleResult calc_node_mask(const Depsgraph &depsgraph, Object &ob, const Brush &brush, IndexMaskMemory &memory)
Definition plane.cc:483
void do_snake_hook_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
void do_smooth_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask, float brush_strength)
Definition smooth.cc:243
void do_mask_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
void do_draw_face_sets_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
void do_blob_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &ob, const IndexMask &node_mask)
Definition crease.cc:288
void do_draw_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
Definition draw.cc:187
void do_displacement_eraser_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &ob, const IndexMask &node_mask)
void do_elastic_deform_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
void multiplane_scrape_preview_draw(uint gpuattr, const Brush &brush, const SculptSession &ss, const float outline_col[3], float outline_alpha)
void do_draw_vector_displacement_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
void do_crease_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &ob, const IndexMask &node_mask)
Definition crease.cc:279
void do_topology_relax_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
Definition relax.cc:840
void do_thumb_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
Definition thumb.cc:138
void do_clay_thumb_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &ob, const IndexMask &node_mask)
void do_rotate_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
void do_topology_slide_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
void do_displacement_smear_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &ob, const IndexMask &node_mask)
void do_clay_strips_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &ob, const IndexMask &node_mask, const float3 &plane_normal, const float3 &plane_center)
void do_surface_smooth_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
void do_plane_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask, const float3 &plane_normal, const float3 &plane_center)
Definition plane.cc:366
void do_enhance_details_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
void do_bmesh_topology_rake_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask, const float input_strength)
void do_layer_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
void do_nudge_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
Definition draw.cc:204
void do_inflate_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &ob, const IndexMask &node_mask)
Definition inflate.cc:138
void do_relax_face_sets_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
Definition relax.cc:805
void do_draw_sharp_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
void do_multiplane_scrape_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
void do_pinch_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
Definition pinch.cc:172
void do_smooth_mask_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask, float brush_strength)
void do_gravity_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &ob, const IndexMask &node_mask)
Definition draw.cc:219
float clay_thumb_get_stabilized_pressure(const StrokeCache &cache)
void do_clay_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &ob, const IndexMask &node_mask)
Definition clay.cc:159
void do_scene_project_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &object, const IndexMask &node_mask)
void do_grab_brush(const Depsgraph &depsgraph, const Sculpt &sd, Object &ob, const IndexMask &node_mask)
Definition grab.cc:172
BMesh Iterators.
unsigned int uint
Definition BKE_text.h:55
MatBase< float, 4, 4 > float4x4
VecBase< float, 3 > float3