Blender V5.3
MOD_grease_pencil_opacity.cc
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
10
11#include "BKE_colortools.hh"
12#include "BKE_curves.hh"
13#include "BKE_geometry_set.hh"
14#include "BKE_grease_pencil.hh"
15#include "BKE_modifier.hh"
16
17#include "BLO_read_write.hh"
18
20#include "UI_resources.hh"
21
22#include "BLT_translation.hh"
23
24#include "WM_types.hh"
25
26#include "RNA_access.hh"
27#include "RNA_prototypes.hh"
28
30#include "MOD_ui_common.hh"
31
32namespace blender {
33
37
38static void init_data(ModifierData *md)
39{
40 auto *omd = reinterpret_cast<GreasePencilOpacityModifierData *>(md);
43}
44
45static void copy_data(const ModifierData *md, ModifierData *target, const int flag)
46{
47 const auto *omd = reinterpret_cast<const GreasePencilOpacityModifierData *>(md);
48 auto *tomd = reinterpret_cast<GreasePencilOpacityModifierData *>(target);
49
51
52 BKE_modifier_copydata_generic(md, target, flag);
53 modifier::greasepencil::copy_influence_data(&omd->influence, &tomd->influence, flag);
54}
55
56static void free_data(ModifierData *md)
57{
58 auto *omd = reinterpret_cast<GreasePencilOpacityModifierData *>(md);
60}
61
62static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
63{
64 auto *omd = reinterpret_cast<GreasePencilOpacityModifierData *>(md);
65 modifier::greasepencil::foreach_influence_ID_link(&omd->influence, ob, walk, user_data);
66}
67
70 const IndexMask &curves_mask)
71{
72 const bool use_uniform_opacity = (omd.flag & MOD_GREASE_PENCIL_OPACITY_USE_UNIFORM_OPACITY);
73 const bool use_weight_as_factor = (omd.flag & MOD_GREASE_PENCIL_OPACITY_USE_WEIGHT_AS_FACTOR);
74 const bool use_curve = (omd.influence.flag & GREASE_PENCIL_INFLUENCE_USE_CUSTOM_CURVE);
75 const OffsetIndices<int> points_by_curve = curves.points_by_curve();
76
77 bke::MutableAttributeAccessor attributes = curves.attributes_for_write();
79 "opacity", bke::AttrDomain::Point);
80 if (!opacities) {
81 return;
82 }
84 curves, omd.influence);
85
86 curves_mask.foreach_index(
87 [&](const int64_t curve_i) {
88 const IndexRange points = points_by_curve[curve_i];
89 for (const int64_t point_i : points) {
90 const float vgroup_weight = vgroup_weights[point_i];
91 if (vgroup_weight <= 0.0f) {
92 continue;
93 }
94
95 const float curve_input = points.size() >= 2 ? (float(point_i - points.first()) /
96 float(points.size() - 1)) :
97 0.0f;
98 const float curve_factor = use_curve ? BKE_curvemapping_evaluateF(
99 omd.influence.custom_curve, 0, curve_input) :
100 1.0f;
101
102 if (use_uniform_opacity) {
103 opacities.span[point_i] = std::clamp(omd.color_factor * curve_factor, 0.0f, 1.0f);
104 }
105 else if (use_weight_as_factor) {
106 /* Use vertex group weights as opacity factors. */
107 opacities.span[point_i] = std::clamp(curve_factor * vgroup_weight, 0.0f, 1.0f);
108 }
109 else {
110 /* Use vertex group weights as influence factors. */
111 opacities.span[point_i] = std::clamp(
112 opacities.span[point_i] + (omd.color_factor * curve_factor - 1.0f) * vgroup_weight,
113 0.0f,
114 1.0f);
115 }
116 }
117 },
119
120 opacities.finish();
121}
122
125 const IndexMask &curves_mask)
126{
127 const bool use_vgroup_opacity = (omd.flag & MOD_GREASE_PENCIL_OPACITY_USE_WEIGHT_AS_FACTOR);
128 const OffsetIndices<int> points_by_curve = curves.points_by_curve();
129
130 bke::MutableAttributeAccessor attributes = curves.attributes_for_write();
131 /* Fill color opacity per stroke. */
132 bke::SpanAttributeWriter<float> fill_opacities = attributes.convert_or_add_for_write_span<float>(
133 "fill_opacity", bke::AttrDomain::Curve, bke::AttributeInitValue(1.0f));
135 curves, omd.influence);
136
137 curves_mask.foreach_index(
138 [&](int64_t curve_i) {
139 /* Use the first stroke point as vertex weight. */
140 const IndexRange points = points_by_curve[curve_i];
141 const float vgroup_weight_first = vgroup_weights[points.first()];
142 float stroke_weight = vgroup_weight_first;
143 if (use_vgroup_opacity) {
144 if (points.is_empty() || (stroke_weight <= 0.0f)) {
145 stroke_weight = 1.0f;
146 }
147 fill_opacities.span[curve_i] = std::clamp(stroke_weight, 0.0f, 1.0f);
148 }
149 else {
150 if (!points.is_empty() && (stroke_weight > 0.0f)) {
151 fill_opacities.span[curve_i] = std::clamp(
152 omd.color_factor * stroke_weight, 0.0f, 1.0f);
153 }
154 }
155 },
157
158 fill_opacities.finish();
159}
160
163 const IndexMask &curves_mask)
164{
165 bke::MutableAttributeAccessor attributes = curves.attributes_for_write();
167 "softness", bke::AttrDomain::Curve);
168
169 curves_mask.foreach_index_optimized<int64_t>(
170 [&](int64_t curve_i) {
171 softness.span[curve_i] =
172 1.0f - std::clamp((1.0f - softness.span[curve_i]) * omd.hardness_factor, 0.0f, 1.0f);
173 },
175
176 softness.finish();
177}
178
180 const ModifierEvalContext *ctx,
182{
183 const auto *omd = reinterpret_cast<GreasePencilOpacityModifierData *>(md);
184
185 IndexMaskMemory mask_memory;
187 ctx->object, curves, omd->influence, mask_memory);
188
189 if (curves_mask.is_empty()) {
190 return;
191 }
192
193 switch (omd->color_mode) {
195 modify_stroke_color(*omd, curves, curves_mask);
196 break;
198 modify_fill_color(*omd, curves, curves_mask);
199 break;
201 modify_stroke_color(*omd, curves, curves_mask);
202 modify_fill_color(*omd, curves, curves_mask);
203 break;
205 modify_softness(*omd, curves, curves_mask);
206 break;
207 }
208}
209
211 const ModifierEvalContext *ctx,
212 bke::GeometrySet *geometry_set)
213{
214 const auto *omd = reinterpret_cast<GreasePencilOpacityModifierData *>(md);
215
217 if (grease_pencil == nullptr) {
218 return;
219 }
220
221 IndexMaskMemory mask_memory;
223 *grease_pencil, omd->influence, mask_memory);
224 const int frame = grease_pencil->runtime->eval_frame;
226 *grease_pencil, layer_mask, frame);
228 drawings, [&](Drawing *drawing) { modify_curves(md, ctx, drawing->strokes_for_write()); });
229}
230
231static void panel_draw(const bContext *C, Panel *panel)
232{
233 ui::Layout &layout = *panel->layout;
234
235 PointerRNA ob_ptr;
237
238 layout.use_property_split_set(true);
239
241 RNA_enum_get(ptr, "color_mode"));
242
243 layout.prop(ptr, "color_mode", UI_ITEM_NONE, std::nullopt, ICON_NONE);
244
245 if (color_mode == MOD_GREASE_PENCIL_COLOR_HARDNESS) {
246 layout.prop(ptr, "hardness_factor", UI_ITEM_NONE, std::nullopt, ICON_NONE);
247 }
248 else {
249 const bool use_uniform_opacity = RNA_boolean_get(ptr, "use_uniform_opacity");
250 const bool use_weight_as_factor = RNA_boolean_get(ptr, "use_weight_as_factor");
251
252 layout.prop(ptr, "use_uniform_opacity", UI_ITEM_NONE, std::nullopt, ICON_NONE);
253 const char *text = (use_uniform_opacity) ? IFACE_("Opacity") : IFACE_("Opacity Factor");
254
255 ui::Layout &row = layout.row(true);
256 row.active_set(!use_weight_as_factor || use_uniform_opacity);
257 row.prop(ptr, "color_factor", UI_ITEM_NONE, text, ICON_NONE);
258 if (!use_uniform_opacity) {
259 ui::Layout &sub = row.row(true);
260 sub.active_set(true);
261 row.prop(ptr, "use_weight_as_factor", UI_ITEM_NONE, "", ICON_MOD_VERTEX_WEIGHT);
262 }
263 }
264
265 if (ui::Layout *influence_panel = layout.panel_prop(
266 C, ptr, "open_influence_panel", IFACE_("Influence")))
267 {
272 }
273
274 modifier_error_message_draw(layout, ptr);
275}
276
281
282static void blend_write(BlendWriter *writer, const ID * /*id_owner*/, const ModifierData *md)
283{
284 const auto *omd = reinterpret_cast<const GreasePencilOpacityModifierData *>(md);
285
286 writer->write_struct(omd);
287 modifier::greasepencil::write_influence_data(writer, &omd->influence);
288}
289
290static void blend_read(BlendDataReader *reader, ModifierData *md)
291{
292 auto *omd = reinterpret_cast<GreasePencilOpacityModifierData *>(md);
293
294 modifier::greasepencil::read_influence_data(reader, &omd->influence);
295}
296
298 /*idname*/ "GreasePencilOpacity",
299 /*name*/ N_("Opacity"),
300 /*struct_name*/ "GreasePencilOpacityModifierData",
301 /*struct_size*/ sizeof(GreasePencilOpacityModifierData),
302 /*srna*/ &RNA_GreasePencilOpacityModifier,
306 /*icon*/ ICON_MOD_OPACITY,
307
308 /*copy_data*/ copy_data,
309
310 /*deform_verts*/ nullptr,
311 /*deform_matrices*/ nullptr,
312 /*deform_verts_EM*/ nullptr,
313 /*deform_matrices_EM*/ nullptr,
314 /*modify_mesh*/ nullptr,
315 /*modify_geometry_set*/ modify_geometry_set,
316
317 /*init_data*/ init_data,
318 /*required_data_mask*/ nullptr,
319 /*free_data*/ free_data,
320 /*is_disabled*/ nullptr,
321 /*update_depsgraph*/ nullptr,
322 /*depends_on_time*/ nullptr,
323 /*depends_on_normals*/ nullptr,
324 /*foreach_ID_link*/ foreach_ID_link,
325 /*foreach_tex_link*/ nullptr,
326 /*free_runtime_data*/ nullptr,
327 /*panel_register*/ panel_register,
328 /*blend_write*/ blend_write,
329 /*blend_read*/ blend_read,
330 /*foreach_cache*/ nullptr,
331 /*foreach_working_space_color*/ nullptr,
332};
333
334} // namespace blender
Low-level operations for curves.
Low-level operations for grease pencil.
#define IFACE_(msgid)
#define C
Definition RandGen.cpp:29
#define UI_ITEM_NONE
#define INIT_DEFAULT_STRUCT_AFTER(struct_dst, member)
constexpr int64_t first() const
constexpr int64_t size() const
constexpr bool is_empty() const
GSpanAttributeWriter lookup_or_add_for_write_span(StringRef name, AttrDomain domain, AttrType data_type, const AttributeInit &initializer=AttributeInitDefaultValue())
GSpanAttributeWriter convert_or_add_for_write_span(StringRef name, AttrDomain domain, AttrType data_type, const AttributeInit &initializer=AttributeInitDefaultValue())
bke::CurvesGeometry & strokes_for_write()
void foreach_index_optimized(Fn &&fn, Mode mode=exec_mode::serial) const
void foreach_index(Fn &&fn, Mode mode=exec_mode::serial) const
constexpr ParallelGrainSize grain_size(int grain_size)
void read_influence_data(BlendDataReader *reader, GreasePencilModifierInfluenceData *influence_data)
void draw_custom_curve_settings(const bContext *, ui::Layout &layout, PointerRNA *ptr)
void draw_material_filter_settings(const bContext *, ui::Layout &layout, PointerRNA *ptr)
void init_influence_data(GreasePencilModifierInfluenceData *influence_data, const bool has_custom_curve)
void write_influence_data(BlendWriter *writer, const GreasePencilModifierInfluenceData *influence_data)
void draw_layer_filter_settings(const bContext *, ui::Layout &layout, PointerRNA *ptr)
IndexMask get_filtered_layer_mask(const GreasePencil &grease_pencil, const GreasePencilModifierInfluenceData &influence_data, IndexMaskMemory &memory)
VArray< float > get_influence_vertex_weights(const bke::CurvesGeometry &curves, const GreasePencilModifierInfluenceData &influence_data)
Vector< bke::greasepencil::Drawing * > get_drawings_for_write(GreasePencil &grease_pencil, const IndexMask &layer_mask, const int frame)
IndexMask get_filtered_stroke_mask(const Object *ob, const bke::CurvesGeometry &curves, const GreasePencilModifierInfluenceData &influence_data, IndexMaskMemory &memory)
void draw_vertex_group_settings(const bContext *, ui::Layout &layout, PointerRNA *ptr)
void free_influence_data(GreasePencilModifierInfluenceData *influence_data)
void foreach_influence_ID_link(GreasePencilModifierInfluenceData *influence_data, Object *ob, IDWalkFunc walk, void *user_data)
void copy_influence_data(const GreasePencilModifierInfluenceData *influence_data_src, GreasePencilModifierInfluenceData *influence_data_dst, const int)
void parallel_for_each(Range &&range, const Function &function)
Definition BLI_task.hh:31
BMesh Iterators.
static void copy_data(const ModifierData *md, ModifierData *target, const int flag)
__int64 int64_t
Definition BKE_text.h:90
int RNA_enum_get(PointerRNA *ptr, const char *name)
static void blend_write(BlendWriter *writer, const ID *, const ModifierData *md)
Definition MOD_bevel.cc:454
PointerRNA * modifier_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
@ MOD_GREASE_PENCIL_OPACITY_USE_UNIFORM_OPACITY
@ MOD_GREASE_PENCIL_OPACITY_USE_WEIGHT_AS_FACTOR
static void modify_curves(ModifierData &md, const ModifierEvalContext &ctx, Drawing &drawing, bke::GreasePencilDrawingEditHints *edit_hints)
static void modify_softness(const GreasePencilOpacityModifierData &omd, bke::CurvesGeometry &curves, const IndexMask &curves_mask)
@ eModifierType_GreasePencilOpacity
static void init_data(ModifierData *md)
void(*)(void *user_data, Object *ob, ID **idpoin, LibraryForeachIDCallbackFlag cb_flag) IDWalkFunc
static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
@ GREASE_PENCIL_INFLUENCE_USE_CUSTOM_CURVE
static void modify_geometry_set(ModifierData *md, const ModifierEvalContext *ctx, bke::GeometrySet *geometry_set)
void modifier_error_message_draw(ui::Layout &layout, PointerRNA *ptr)
static void modify_fill_color(Object &ob, const GreasePencilColorModifierData &cmd, Drawing &drawing, const IndexMask &curves_mask)
static void free_data(ModifierData *md)
static void panel_register(ARegionType *region_type)
bool RNA_boolean_get(PointerRNA *ptr, const char *name)
@ eModifierTypeFlag_SupportsMapping
@ eModifierTypeFlag_AcceptsGreasePencil
@ eModifierTypeFlag_EnableInEditmode
@ eModifierTypeFlag_SupportsEditmode
static void modify_stroke_color(Object &ob, const GreasePencilColorModifierData &cmd, bke::CurvesGeometry &curves, const IndexMask &curves_mask, const MutableSpan< ColorGeometry4f > vertex_colors)
static void blend_read(BlendDataReader *, ModifierData *md)
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
static void panel_draw(const bContext *, Panel *panel)
ModifierTypeInfo modifierType_GreasePencilOpacity
float BKE_curvemapping_evaluateF(const CurveMapping *cumap, int cur, float value)
@ MOD_GREASE_PENCIL_COLOR_HARDNESS
@ MOD_GREASE_PENCIL_COLOR_STROKE
void BKE_modifier_copydata_generic(const ModifierData *md, ModifierData *md_dst, int flag)
KERNEL_FEATURE_LIGHT_PASSES KERNEL_FEATURE_PATH_GUIDING float
void write_struct(const T *data, BlendStructWriterTypedFn< T > fn=nullptr)
GreasePencilModifierInfluenceFlag flag
GreasePencilModifierInfluenceData influence
ui::Layout * layout
GreasePencil * get_grease_pencil_for_write()
void use_property_split_set(bool is_sep)
void prop(PointerRNA *ptr, PropertyRNA *prop, int index, int value, eUI_Item_Flag flag, std::optional< StringRef > name_opt, int icon, std::optional< StringRef > placeholder=std::nullopt)
void active_set(bool active)
PanelLayout panel_prop(const bContext *C, PointerRNA *open_prop_owner, StringRefNull open_prop_name)
Layout & row(bool align)
#define N_(msgid)