Blender V5.3
MOD_grease_pencil_weight_proximity.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2005 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include "BLI_index_mask.hh"
10#include "BLI_math_matrix.hh"
11
12#include "BLT_translation.hh"
13
14#include "BLO_read_write.hh"
15
16#include "DNA_modifier_types.h"
17#include "DNA_object_types.h"
18#include "DNA_screen_types.h"
19
20#include "RNA_access.hh"
21
22#include "BKE_curves.hh"
23#include "BKE_deform.hh"
24#include "BKE_geometry_set.hh"
25#include "BKE_grease_pencil.hh"
27#include "BKE_lib_query.hh"
28#include "BKE_modifier.hh"
29
31#include "UI_resources.hh"
32
34#include "MOD_modifiertypes.hh"
35#include "MOD_ui_common.hh"
36
37#include "RNA_prototypes.hh"
38
39namespace blender {
40
41static void init_data(ModifierData *md)
42{
43 auto *gpmd = reinterpret_cast<GreasePencilWeightProximityModifierData *>(md);
45 modifier::greasepencil::init_influence_data(&gpmd->influence, false);
46}
47
48static void copy_data(const ModifierData *md, ModifierData *target, const int flag)
49{
50 const auto *gmd = reinterpret_cast<const GreasePencilWeightProximityModifierData *>(md);
51 auto *tgmd = reinterpret_cast<GreasePencilWeightProximityModifierData *>(target);
52
53 BKE_modifier_copydata_generic(md, target, flag);
54 modifier::greasepencil::copy_influence_data(&gmd->influence, &tgmd->influence, flag);
55}
56
57static void free_data(ModifierData *md)
58{
59 auto *mmd = reinterpret_cast<GreasePencilWeightProximityModifierData *>(md);
60
62}
63
64static bool is_disabled(const Scene * /*scene*/, ModifierData *md, bool /*use_render_params*/)
65{
66 auto *mmd = reinterpret_cast<GreasePencilWeightProximityModifierData *>(md);
67
68 return (mmd->target_vgname[0] == '\0' || mmd->object == nullptr);
69}
70
71static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
72{
74 reinterpret_cast<GreasePencilWeightProximityModifierData *>(md);
75
77
78 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->object), IDWALK_CB_NOP);
79}
80
82{
83 auto *mmd = reinterpret_cast<GreasePencilWeightProximityModifierData *>(md);
84 if (mmd->object != nullptr) {
86 ctx->node, mmd->object, DEG_OB_COMP_TRANSFORM, "Grease Pencil Proximity Modifier");
87 DEG_add_depends_on_transform_relation(ctx->node, "Grease Pencil Proximity Modifier");
88 }
89}
90
91static void blend_write(BlendWriter *writer, const ID * /*id_owner*/, const ModifierData *md)
92{
94 reinterpret_cast<const GreasePencilWeightProximityModifierData *>(md);
95
96 writer->write_struct(mmd);
98}
99
106
107static float get_distance_factor(float3 target_pos,
108 const float4x4 &obmat,
109 float3 pos,
110 const float dist_min,
111 const float dist_max)
112{
113 const float3 gvert = math::transform_point(obmat, pos);
114 const float dist = math::distance(target_pos, gvert);
115
116 if (dist_max > dist_min) {
117 if (dist > dist_max) {
118 return 1.0f;
119 }
120 if (dist <= dist_max && dist > dist_min) {
121 return 1.0f - ((dist_max - dist) / math::max((dist_max - dist_min), 0.0001f));
122 }
123 return 0.0f;
124 }
125 if (dist_max < dist_min) {
126 if (dist > dist_min) {
127 return 0.0f;
128 }
129 if (dist <= dist_min && dist > dist_max) {
130 return (dist_min - dist) / math::max((dist_min - dist_max), 0.0001f);
131 }
132 return 1.0f;
133 }
134
135 /* dist_max == dist_min, "stepped" behavior then. */
136 return (dist > dist_max) ? 0.0f : 1.0f;
137}
138
140 const ListBaseT<bDeformGroup> &vertex_group_names)
141{
142 const int def_nr = BKE_defgroup_name_index(&vertex_group_names, name);
143 if (def_nr < 0) {
144 return false;
145 }
146 return true;
147}
148
150 const Object &ob,
152{
153 const auto &mmd = reinterpret_cast<const GreasePencilWeightProximityModifierData &>(md);
155 if (curves.is_empty()) {
156 return;
157 }
158 IndexMaskMemory memory;
160 &ob, curves, mmd.influence, memory);
161 if (strokes.is_empty()) {
162 return;
163 }
164
165 /* Make sure that the target vertex group is added to this drawing so we can write to it. */
166 bke::greasepencil::ensure_vertex_group(mmd.target_vgname, curves.vertex_group_names);
167
168 bke::MutableAttributeAccessor attributes = curves.attributes_for_write();
169 bke::SpanAttributeWriter<float> dst_weights = attributes.lookup_for_write_span<float>(
170 mmd.target_vgname);
171
172 BLI_assert(!dst_weights.span.is_empty());
173
175 curves, mmd.influence);
176
177 const Span<float3> positions = curves.positions();
178 const float4x4 &obmat = ob.object_to_world();
179 const float3 target_pos = mmd.object->object_to_world().location();
180 const bool invert = (mmd.flag & MOD_GREASE_PENCIL_WEIGHT_PROXIMITY_INVERT_OUTPUT) != 0;
181 const bool do_multiply = (mmd.flag & MOD_GREASE_PENCIL_WEIGHT_PROXIMITY_MULTIPLY_DATA) != 0;
182
183 threading::parallel_for(positions.index_range(), 1024, [&](const IndexRange range) {
184 for (const int point_i : range) {
185 const float weight = vgroup_weights[point_i];
186 if (weight <= 0.0f) {
187 continue;
188 }
189
190 float dist_fac = get_distance_factor(
191 target_pos, obmat, positions[point_i], mmd.dist_start, mmd.dist_end);
192
193 if (invert) {
194 dist_fac = 1.0f - dist_fac;
195 }
196
197 dst_weights.span[point_i] = do_multiply ? dst_weights.span[point_i] * dist_fac : dist_fac;
198
199 dst_weights.span[point_i] = math::clamp(
200 dst_weights.span[point_i],
201 /* Weight==0 will remove the point from the group, assign a sufficiently small value
202 * there to prevent the visual disconnect, and keep the behavior same as the old
203 * modifier. */
204 math::max(mmd.min_weight, 1e-5f),
205 1.0f);
206 }
207 });
208
209 dst_weights.finish();
210}
211
213 const ModifierEvalContext *ctx,
214 bke::GeometrySet *geometry_set)
215{
217 reinterpret_cast<GreasePencilWeightProximityModifierData *>(md);
218
219 if (!geometry_set->has_grease_pencil()) {
220 return;
221 }
222
224
225 if (!target_vertex_group_available(mmd->target_vgname, grease_pencil.vertex_group_names)) {
226 return;
227 }
228
229 const int current_frame = grease_pencil.runtime->eval_frame;
230
231 IndexMaskMemory mask_memory;
233 grease_pencil, mmd->influence, mask_memory);
236
238 write_weights_for_drawing(*md, *ctx->object, *drawing);
239 });
240}
241
242static void panel_draw(const bContext *C, Panel *panel)
243{
244 ui::Layout &layout = *panel->layout;
245
246 PointerRNA ob_ptr;
248
249 layout.use_property_split_set(true);
250 ui::Layout &row = layout.row(true);
251 row.prop_search(ptr, "target_vertex_group", &ob_ptr, "vertex_groups", std::nullopt, ICON_NONE);
252 ui::Layout *sub = &row.row(true);
253 bool has_output = RNA_string_length(ptr, "target_vertex_group") != 0;
254 sub->use_property_decorate_set(false);
255 sub->active_set(has_output);
256 sub->prop(ptr, "use_invert_output", UI_ITEM_NONE, "", ICON_ARROW_LEFTRIGHT);
257
258 layout.prop(ptr, "object", UI_ITEM_NONE, std::nullopt, ICON_NONE);
259
260 sub = &layout.column(true);
261 sub->prop(ptr, "distance_start", UI_ITEM_NONE, std::nullopt, ICON_NONE);
262 sub->prop(ptr, "distance_end", UI_ITEM_NONE, std::nullopt, ICON_NONE);
263
264 layout.prop(ptr, "minimum_weight", UI_ITEM_NONE, std::nullopt, ICON_NONE);
265 layout.prop(ptr, "use_multiply", UI_ITEM_NONE, std::nullopt, ICON_NONE);
266
267 if (ui::Layout *influence_panel = layout.panel_prop(
268 C, ptr, "open_influence_panel", IFACE_("Influence")))
269 {
273 }
274
275 modifier_error_message_draw(layout, ptr);
276}
277
282
284 /*idname*/ "GreasePencilWeightProximityModifier",
285 /*name*/ N_("Weight Proximity"),
286 /*struct_name*/ "GreasePencilWeightProximityModifierData",
287 /*struct_size*/ sizeof(GreasePencilWeightProximityModifierData),
288 /*srna*/ &RNA_GreasePencilWeightProximityModifier,
290 /*flags*/
293 /*icon*/ ICON_MOD_VERTEX_WEIGHT,
294
295 /*copy_data*/ copy_data,
296
297 /*deform_verts*/ nullptr,
298 /*deform_matrices*/ nullptr,
299 /*deform_verts_EM*/ nullptr,
300 /*deform_matrices_EM*/ nullptr,
301 /*modify_mesh*/ nullptr,
302 /*modify_geometry_set*/ modify_geometry_set,
303
304 /*init_data*/ init_data,
305 /*required_data_mask*/ nullptr,
306 /*free_data*/ free_data,
307 /*is_disabled*/ is_disabled,
308 /*update_depsgraph*/ update_depsgraph,
309 /*depends_on_time*/ nullptr,
310 /*depends_on_normals*/ nullptr,
311 /*foreach_ID_link*/ foreach_ID_link,
312 /*foreach_tex_link*/ nullptr,
313 /*free_runtime_data*/ nullptr,
314 /*panel_register*/ panel_register,
315 /*blend_write*/ blend_write,
316 /*blend_read*/ blend_read,
317};
318
319} // namespace blender
Low-level operations for curves.
support for deformation groups and hooks.
Low-level operations for grease pencil.
Utility functions for vertex groups in grease pencil objects.
#define IFACE_(msgid)
Object is a sort of wrapper for general info.
#define C
Definition RandGen.cpp:29
#define UI_ITEM_NONE
#define INIT_DEFAULT_STRUCT_AFTER(struct_dst, member)
constexpr IndexRange index_range() const
Definition BLI_span.hh:405
GSpanAttributeWriter lookup_for_write_span(StringRef name)
bke::CurvesGeometry & strokes_for_write()
float2x2 invert(float2x2 mat)
int ensure_vertex_group(StringRef name, ListBaseT< bDeformGroup > &vertex_group_names)
T distance(const T &a, const T &b)
T max(const T &a, const T &b)
VecBase< T, 3 > transform_point(const CartesianBasis &basis, const VecBase< T, 3 > &v)
void read_influence_data(BlendDataReader *reader, GreasePencilModifierInfluenceData *influence_data)
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
void parallel_for(const IndexRange range, const int64_t grain_size, const Function &function, const TaskSizeHints &size_hints=detail::TaskSizeHints_Static(1))
Definition BLI_task.hh:69
BMesh Iterators.
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
static void copy_data(const ModifierData *md, ModifierData *target, const int flag)
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)
static void write_weights_for_drawing(const ModifierData &md, const Object &ob, bke::greasepencil::Drawing &drawing)
@ eModifierType_GreasePencilWeightProximity
static void init_data(ModifierData *md)
void(*)(void *user_data, Object *ob, ID **idpoin, LibraryForeachIDCallbackFlag cb_flag) IDWalkFunc
static void update_depsgraph(tGraphSliderOp *gso)
static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
void DEG_add_object_relation(DepsNodeHandle *node_handle, Object *object, eDepsObjectComponentType component, const char *description)
MatBase< float, 4, 4 > float4x4
static bool target_vertex_group_available(const StringRefNull name, const ListBaseT< bDeformGroup > &vertex_group_names)
void DEG_add_depends_on_transform_relation(DepsNodeHandle *node_handle, const char *description)
@ MOD_GREASE_PENCIL_WEIGHT_PROXIMITY_MULTIPLY_DATA
@ MOD_GREASE_PENCIL_WEIGHT_PROXIMITY_INVERT_OUTPUT
int BKE_defgroup_name_index(const ListBaseT< bDeformGroup > *defbase, StringRef name)
Definition deform.cc:544
static float get_distance_factor(float3 target_pos, const float4x4 &obmat, float3 pos, const float dist_min, const float dist_max)
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 free_data(ModifierData *md)
static void panel_register(ARegionType *region_type)
@ eModifierTypeFlag_SupportsMapping
@ eModifierTypeFlag_AcceptsGreasePencil
@ eModifierTypeFlag_EnableInEditmode
@ eModifierTypeFlag_SupportsEditmode
ModifierTypeInfo modifierType_GreasePencilWeightProximity
int RNA_string_length(PointerRNA *ptr, const char *name)
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)
VecBase< float, 3 > float3
static bool is_disabled(const Scene *, ModifierData *md, bool)
void BKE_modifier_copydata_generic(const ModifierData *md, ModifierData *md_dst, int flag)
void write_struct(const T *data, BlendStructWriterTypedFn< T > fn=nullptr)
ui::Layout * layout
GreasePencil * get_grease_pencil_for_write()
void prop_search(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop, PropertyRNA *item_searchpropname, std::optional< StringRefNull > name, int icon, bool results_are_suggestions)
void use_property_decorate_set(bool is_decorate)
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)
Layout & column(bool align)
PanelLayout panel_prop(const bContext *C, PointerRNA *open_prop_owner, StringRefNull open_prop_name)
Layout & row(bool align)
#define N_(msgid)