Blender V5.3
MOD_grease_pencil_color.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#include "DNA_modifier_types.h"
11
12#include "BLI_math_color_c.hh"
13
14#include "BKE_colortools.hh"
15#include "BKE_curves.hh"
16#include "BKE_geometry_set.hh"
17#include "BKE_grease_pencil.hh"
18#include "BKE_material.hh"
19#include "BKE_modifier.hh"
20#include "BKE_screen.hh"
21
22#include "BLO_read_write.hh"
23
25
27#include "UI_resources.hh"
28
29#include "BLT_translation.hh"
30
31#include "WM_types.hh"
32
33#include "RNA_access.hh"
34#include "RNA_enum_types.hh"
35#include "RNA_prototypes.hh"
36
38#include "MOD_modifiertypes.hh"
39#include "MOD_ui_common.hh"
40
41namespace blender {
42
44
45static void init_data(ModifierData *md)
46{
47 auto *cmd = reinterpret_cast<GreasePencilColorModifierData *>(md);
50}
51
52static void copy_data(const ModifierData *md, ModifierData *target, const int flag)
53{
54 const auto *cmd = reinterpret_cast<const GreasePencilColorModifierData *>(md);
55 auto *tcmd = reinterpret_cast<GreasePencilColorModifierData *>(target);
56
58
59 BKE_modifier_copydata_generic(md, target, flag);
60 modifier::greasepencil::copy_influence_data(&cmd->influence, &tcmd->influence, flag);
61}
62
63static void free_data(ModifierData *md)
64{
65 auto *cmd = reinterpret_cast<GreasePencilColorModifierData *>(md);
67}
68
69static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
70{
71 auto *cmd = reinterpret_cast<GreasePencilColorModifierData *>(md);
72 modifier::greasepencil::foreach_influence_ID_link(&cmd->influence, ob, walk, user_data);
73}
74
76 const ColorGeometry4f &material_color,
77 const float3 factor)
78{
79 float3 hsv;
80 /* When input alpha is zero, replace with material color. */
81 if (color.a == 0.0f && material_color.a > 0.0f) {
82 color.a = 1.0f;
83 rgb_to_hsv_v(material_color, hsv);
84 }
85 else {
86 rgb_to_hsv_v(color, hsv);
87 }
88 hsv[0] = fractf(hsv[0] + factor[0] + 0.5f);
89 hsv[1] = clamp_f(hsv[1] * factor[1], 0.0f, 1.0f);
90 hsv[2] = hsv[2] * factor[2];
91 hsv_to_rgb_v(hsv, color);
92}
93
97 const IndexMask &curves_mask,
98 const MutableSpan<ColorGeometry4f> vertex_colors)
99{
100 const bool use_curve = (cmd.influence.flag & GREASE_PENCIL_INFLUENCE_USE_CUSTOM_CURVE);
101 const OffsetIndices<int> points_by_curve = curves.points_by_curve();
102
103 bke::AttributeAccessor attributes = curves.attributes();
104 const VArray<int> stroke_materials = *attributes.lookup_or_default<int>(
105 "material_index", bke::AttrDomain::Curve, 0);
106
107 curves_mask.foreach_index(
108 [&](const int64_t curve_i) {
109 const Material *ma = BKE_object_material_get(&ob, stroke_materials[curve_i] + 1);
110 const MaterialGPencilStyle *gp_style = ma ? ma->gp_style : nullptr;
111 const ColorGeometry4f material_color = (gp_style ?
112 ColorGeometry4f(gp_style->stroke_rgba) :
113 ColorGeometry4f(0.0f, 0.0f, 0.0f, 0.0f));
114
115 const IndexRange points = points_by_curve[curve_i];
116 for (const int64_t i : points.index_range()) {
117 const int64_t point_i = points[i];
118 float3 factor = cmd.hsv;
119 if (use_curve) {
120 const float curve_input = points.size() >= 2 ? (float(i) / float(points.size() - 1)) :
121 0.0f;
122 const float curve_factor = BKE_curvemapping_evaluateF(
123 cmd.influence.custom_curve, 0, curve_input);
124 factor *= curve_factor;
125 }
126
127 apply_color_factor(vertex_colors[point_i], material_color, factor);
128 }
129 },
131}
132
133static void modify_fill_color(Object &ob,
135 Drawing &drawing,
136 const IndexMask &curves_mask)
137{
138 const bke::CurvesGeometry &curves = drawing.strokes();
139 const bke::AttributeAccessor attributes = curves.attributes();
140 /* Fill color per stroke. */
142 const VArray<int> stroke_materials = *attributes.lookup_or_default<int>(
143 "material_index", bke::AttrDomain::Curve, 0);
144
145 curves_mask.foreach_index(
146 [&](int64_t curve_i) {
147 const Material *ma = BKE_object_material_get(&ob, stroke_materials[curve_i] + 1);
148 const MaterialGPencilStyle *gp_style = ma ? ma->gp_style : nullptr;
149 const ColorGeometry4f material_color = (gp_style ?
150 ColorGeometry4f(gp_style->fill_rgba) :
151 ColorGeometry4f(0.0f, 0.0f, 0.0f, 0.0f));
152
153 apply_color_factor(fill_colors[curve_i], material_color, cmd.hsv);
154 },
156}
157
158static void modify_drawing(ModifierData &md, const ModifierEvalContext &ctx, Drawing &drawing)
159{
160 auto &cmd = reinterpret_cast<GreasePencilColorModifierData &>(md);
161
163 IndexMaskMemory mask_memory;
165 ctx.object, curves, cmd.influence, mask_memory);
166
167 switch (cmd.color_mode) {
170 *ctx.object, cmd, curves, curves_mask, drawing.vertex_colors_for_write());
171 break;
173 modify_fill_color(*ctx.object, cmd, drawing, curves_mask);
174 break;
177 *ctx.object, cmd, curves, curves_mask, drawing.vertex_colors_for_write());
178 modify_fill_color(*ctx.object, cmd, drawing, curves_mask);
179 break;
182 break;
183 }
184}
185
187 const ModifierEvalContext *ctx,
188 bke::GeometrySet *geometry_set)
189{
190 auto *cmd = reinterpret_cast<GreasePencilColorModifierData *>(md);
191
192 if (!geometry_set->has_grease_pencil()) {
193 return;
194 }
196 const int frame = grease_pencil.runtime->eval_frame;
197
198 IndexMaskMemory mask_memory;
200 grease_pencil, cmd->influence, mask_memory);
202 grease_pencil, layer_mask, frame);
204 [&](Drawing *drawing) { modify_drawing(*md, *ctx, *drawing); });
205}
206
207static void panel_draw(const bContext *C, Panel *panel)
208{
209 ui::Layout &layout = *panel->layout;
210
211 PointerRNA ob_ptr;
213
214 layout.use_property_split_set(true);
215
216 layout.prop(ptr, "color_mode", UI_ITEM_NONE, std::nullopt, ICON_NONE);
217
218 layout.prop(ptr, "hue", ui::ITEM_R_SLIDER, std::nullopt, ICON_NONE);
219 layout.prop(ptr, "saturation", ui::ITEM_R_SLIDER, std::nullopt, ICON_NONE);
220 layout.prop(ptr, "value", ui::ITEM_R_SLIDER, std::nullopt, ICON_NONE);
221
222 if (ui::Layout *influence_panel = layout.panel_prop(
223 C, ptr, "open_influence_panel", IFACE_("Influence")))
224 {
228 }
229
230 modifier_error_message_draw(layout, ptr);
231}
232
237
238static void blend_write(BlendWriter *writer, const ID * /*id_owner*/, const ModifierData *md)
239{
240 const auto *cmd = reinterpret_cast<const GreasePencilColorModifierData *>(md);
241
243 modifier::greasepencil::write_influence_data(writer, &cmd->influence);
244}
245
246static void blend_read(BlendDataReader *reader, ModifierData *md)
247{
248 auto *cmd = reinterpret_cast<GreasePencilColorModifierData *>(md);
249
250 modifier::greasepencil::read_influence_data(reader, &cmd->influence);
251}
252
254 /*idname*/ "GreasePencilColor",
255 /*name*/ N_("Color"),
256 /*struct_name*/ "GreasePencilColorModifierData",
257 /*struct_size*/ sizeof(GreasePencilColorModifierData),
258 /*srna*/ &RNA_GreasePencilColorModifier,
262 /*icon*/ ICON_MOD_HUE_SATURATION,
263
264 /*copy_data*/ copy_data,
265
266 /*deform_verts*/ nullptr,
267 /*deform_matrices*/ nullptr,
268 /*deform_verts_EM*/ nullptr,
269 /*deform_matrices_EM*/ nullptr,
270 /*modify_mesh*/ nullptr,
271 /*modify_geometry_set*/ modify_geometry_set,
272
273 /*init_data*/ init_data,
274 /*required_data_mask*/ nullptr,
275 /*free_data*/ free_data,
276 /*is_disabled*/ nullptr,
277 /*update_depsgraph*/ nullptr,
278 /*depends_on_time*/ nullptr,
279 /*depends_on_normals*/ nullptr,
280 /*foreach_ID_link*/ foreach_ID_link,
281 /*foreach_tex_link*/ nullptr,
282 /*free_runtime_data*/ nullptr,
283 /*panel_register*/ panel_register,
284 /*blend_write*/ blend_write,
285 /*blend_read*/ blend_read,
286};
287
288} // namespace blender
Low-level operations for curves.
Low-level operations for grease pencil.
General operations, lookup, etc. for materials.
#define IFACE_(msgid)
#define C
Definition RandGen.cpp:29
#define UI_ITEM_NONE
#define BLI_assert_unreachable()
#define INIT_DEFAULT_STRUCT_AFTER(struct_dst, member)
ChannelStorageType a
constexpr int64_t size() const
constexpr IndexRange index_range() const
GAttributeReader lookup_or_default(StringRef name, AttrDomain domain, AttrType data_type, const void *default_value=nullptr) const
bke::CurvesGeometry & strokes_for_write()
const bke::CurvesGeometry & strokes() const
MutableSpan< ColorGeometry4f > fill_colors_for_write()
MutableSpan< ColorGeometry4f > vertex_colors_for_write()
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)
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 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
static void apply_color_factor(ColorGeometry4f &color, const ColorGeometry4f &material_color, const float3 factor)
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)
Material * BKE_object_material_get(Object *ob, short act)
void rgb_to_hsv_v(const float rgb[3], float r_hsv[3])
@ eModifierType_GreasePencilColor
static void init_data(ModifierData *md)
void(*)(void *user_data, Object *ob, ID **idpoin, LibraryForeachIDCallbackFlag cb_flag) IDWalkFunc
MINLINE float fractf(float a)
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)
void hsv_to_rgb_v(const float hsv[3], float r_rgb[3])
Definition math_color.cc:61
static void free_data(ModifierData *md)
ModifierTypeInfo modifierType_GreasePencilColor
static void panel_register(ARegionType *region_type)
@ eModifierTypeFlag_SupportsMapping
@ eModifierTypeFlag_AcceptsGreasePencil
@ eModifierTypeFlag_EnableInEditmode
@ eModifierTypeFlag_SupportsEditmode
static void modify_drawing(const GreasePencilArrayModifierData &mmd, const ModifierEvalContext &ctx, bke::greasepencil::Drawing &drawing)
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)
ColorSceneLinear4f< eAlpha::Premultiplied > ColorGeometry4f
VecBase< float, 3 > float3
float BKE_curvemapping_evaluateF(const CurveMapping *cumap, int cur, float value)
@ MOD_GREASE_PENCIL_COLOR_HARDNESS
@ MOD_GREASE_PENCIL_COLOR_STROKE
MINLINE float clamp_f(float value, float min, float max)
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)
GreasePencilModifierInfluenceData influence
GreasePencilModifierInfluenceFlag flag
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)
PanelLayout panel_prop(const bContext *C, PointerRNA *open_prop_owner, StringRefNull open_prop_name)
#define N_(msgid)