Blender V5.3
MOD_weightvgedit.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2011 by Bastien Montagne. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <cstring>
10
11#include "BLI_utildefines.hh"
12
13#include "BLI_ghash.hh"
14#include "BLI_listbase.hh"
15#include "BLI_rand_c.hh"
16
17#include "BLT_translation.hh"
18
19#include "DNA_color_types.h" /* CurveMapping. */
20#include "DNA_mesh_types.h"
21#include "DNA_meshdata_types.h"
22#include "DNA_modifier_types.h"
23#include "DNA_object_types.h"
24#include "DNA_screen_types.h"
25#include "DNA_texture_types.h"
26
27#include "BKE_colortools.hh" /* CurveMapping. */
28#include "BKE_customdata.hh"
29#include "BKE_deform.hh"
30#include "BKE_lib_query.hh"
31#include "BKE_mesh.hh"
32#include "BKE_modifier.hh"
33#include "BKE_texture.h" /* Texture masking. */
34
35#include "UI_interface.hh"
37#include "UI_resources.hh"
38
39#include "BLO_read_write.hh"
40
41#include "RNA_access.hh"
42#include "RNA_prototypes.hh"
43
46
47#include "MEM_guardedalloc.h"
48
49#include "MOD_ui_common.hh"
50#include "MOD_util.hh"
51#include "MOD_weightvg_util.hh"
52
53namespace blender {
54
55/* -------------------------------------------------------------------- */
58
59static void init_data(ModifierData *md)
60{
61 WeightVGEditModifierData *wmd = reinterpret_cast<WeightVGEditModifierData *>(md);
63
64 wmd->cmap_curve = BKE_curvemapping_add(1, 0.0, 0.0, 1.0, 1.0);
66}
67
68static void free_data(ModifierData *md)
69{
70 WeightVGEditModifierData *wmd = reinterpret_cast<WeightVGEditModifierData *>(md);
72}
73
74static void copy_data(const ModifierData *md, ModifierData *target, const int flag)
75{
76 const WeightVGEditModifierData *wmd = reinterpret_cast<const WeightVGEditModifierData *>(md);
77 WeightVGEditModifierData *twmd = reinterpret_cast<WeightVGEditModifierData *>(target);
78
79 BKE_modifier_copydata_generic(md, target, flag);
80
82}
83
84static void required_data_mask(ModifierData *md, CustomData_MeshMasks *r_cddata_masks)
85{
86 WeightVGEditModifierData *wmd = reinterpret_cast<WeightVGEditModifierData *>(md);
87
88 /* We need vertex groups! */
89 r_cddata_masks->vmask |= CD_MASK_MDEFORMVERT;
90
91 /* Ask for UV coordinates if we need them. */
93 r_cddata_masks->fmask |= CD_MASK_MTFACE;
94 }
95}
96
97static bool depends_on_time(Scene * /*scene*/, ModifierData *md)
98{
99 WeightVGEditModifierData *wmd = reinterpret_cast<WeightVGEditModifierData *>(md);
100
101 if (wmd->mask_texture) {
103 }
104 return false;
105}
106
107static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
108{
109 WeightVGEditModifierData *wmd = reinterpret_cast<WeightVGEditModifierData *>(md);
110
111 walk(user_data, ob, reinterpret_cast<ID **>(&wmd->mask_texture), IDWALK_CB_USER);
112 walk(user_data, ob, reinterpret_cast<ID **>(&wmd->mask_tex_map_obj), IDWALK_CB_NOP);
113}
114
115static void foreach_tex_link(ModifierData *md, Object *ob, TexWalkFunc walk, void *user_data)
116{
117 PointerRNA ptr = RNA_pointer_create_discrete(&ob->id, RNA_Modifier, md);
118 PropertyRNA *prop = RNA_struct_find_property(&ptr, "mask_texture");
119 walk(user_data, ob, md, &ptr, prop);
120}
121
123{
124 WeightVGEditModifierData *wmd = reinterpret_cast<WeightVGEditModifierData *>(md);
125 bool need_transform_relation = false;
126
127 if (wmd->mask_texture != nullptr) {
128 DEG_add_generic_id_relation(ctx->node, &wmd->mask_texture->id, "WeightVGEdit Modifier");
129
130 if (wmd->mask_tex_map_obj != nullptr && wmd->mask_tex_mapping == MOD_DISP_MAP_OBJECT) {
132 ctx->node, wmd->mask_tex_map_obj, wmd->mask_tex_map_bone, "WeightVGEdit Modifier");
133 need_transform_relation = true;
134 }
135 else if (wmd->mask_tex_mapping == MOD_DISP_MAP_GLOBAL) {
136 need_transform_relation = true;
137 }
138 }
139
140 if (need_transform_relation) {
141 DEG_add_depends_on_transform_relation(ctx->node, "WeightVGEdit Modifier");
142 }
143}
144
145static bool is_disabled(const Scene * /*scene*/, ModifierData *md, bool /*use_render_params*/)
146{
147 WeightVGEditModifierData *wmd = reinterpret_cast<WeightVGEditModifierData *>(md);
148 /* If no vertex group, bypass. */
149 return (wmd->defgrp_name[0] == '\0');
150}
151
153{
154 BLI_assert(mesh != nullptr);
155
156 WeightVGEditModifierData *wmd = reinterpret_cast<WeightVGEditModifierData *>(md);
157
158 MDeformWeight **dw = nullptr;
159 float *org_w; /* Array original weights. */
160 float *new_w; /* Array new weights. */
161 int i;
162 const bool invert_vgroup_mask = (wmd->edit_flags & MOD_WVG_EDIT_INVERT_VGROUP_MASK) != 0;
163
164 /* Flags. */
165 const bool do_add = (wmd->edit_flags & MOD_WVG_EDIT_ADD2VG) != 0;
166 const bool do_rem = (wmd->edit_flags & MOD_WVG_EDIT_REMFVG) != 0;
167 /* Only do weight-preview in Object, Sculpt and Pose modes! */
168#if 0
169 const bool do_prev = (wmd->modifier.mode & eModifierMode_DoWeightPreview);
170#endif
171
172 /* Get number of verts. */
173 const int verts_num = mesh->verts_num;
174
175 /* Check if we can just return the original mesh.
176 * Must have verts and therefore verts assigned to vgroups to do anything useful!
177 */
178 if ((verts_num == 0) || mesh->vertex_group_names.is_empty()) {
179 return mesh;
180 }
181
182 /* Get vgroup idx from its name. */
183 const int defgrp_index = BKE_id_defgroup_name_index(&mesh->id, wmd->defgrp_name);
184 if (defgrp_index == -1) {
185 return mesh;
186 }
187
188 const bool has_mdef = !mesh->deform_verts().is_empty();
189 /* If no vertices were ever added to an object's vgroup, dvert might be nullptr. */
190 if (!has_mdef) {
191 /* If this modifier is not allowed to add vertices, just return. */
192 if (!do_add) {
193 return mesh;
194 }
195 }
196
197 MDeformVert *dvert = mesh->deform_verts_for_write().data();
198
199 /* Ultimate security check. */
200 if (!dvert) {
201 return mesh;
202 }
203
204 /* Get org weights, assuming 0.0 for vertices not in given vgroup. */
205 org_w = MEM_new_array_uninitialized<float>(size_t(verts_num), __func__);
206 new_w = MEM_new_array_uninitialized<float>(size_t(verts_num), __func__);
207 dw = MEM_new_array_uninitialized<MDeformWeight *>(size_t(verts_num), __func__);
208 for (i = 0; i < verts_num; i++) {
209 dw[i] = BKE_defvert_find_index(&dvert[i], defgrp_index);
210 if (dw[i]) {
211 org_w[i] = new_w[i] = dw[i]->weight;
212 }
213 else {
214 org_w[i] = new_w[i] = wmd->default_weight;
215 }
216 }
217
218 /* Do mapping. */
219 const bool do_invert_mapping = (wmd->edit_flags & MOD_WVG_INVERT_FALLOFF) != 0;
220 const bool do_normalize = (wmd->edit_flags & MOD_WVG_EDIT_WEIGHTS_NORMALIZE) != 0;
221 if (do_invert_mapping || wmd->falloff_type != MOD_WVG_MAPPING_NONE) {
222 RNG *rng = nullptr;
223
226 }
227
228 weightvg_do_map(verts_num, new_w, wmd->falloff_type, do_invert_mapping, wmd->cmap_curve, rng);
229
230 if (rng) {
231 BLI_rng_free(rng);
232 }
233 }
234
235 /* Do masking. */
238 verts_num,
239 nullptr,
240 org_w,
241 new_w,
242 ctx->object,
243 mesh,
244 wmd->mask_constant,
245 wmd->mask_defgrp_name,
246 scene,
247 wmd->mask_texture,
249 wmd->mask_tex_mapping,
250 wmd->mask_tex_map_obj,
253 invert_vgroup_mask);
254
255 /* Update/add/remove from vgroup. */
256 weightvg_update_vg(dvert,
257 defgrp_index,
258 dw,
259 verts_num,
260 nullptr,
261 org_w,
262 do_add,
263 wmd->add_threshold,
264 do_rem,
265 wmd->rem_threshold,
266 do_normalize);
267
268 /* If weight preview enabled... */
269#if 0 /* XXX Currently done in mod stack :/ */
270 if (do_prev) {
271 DM_update_weight_mcol(ob, dm, 0, org_w, 0, nullptr);
272 }
273#endif
274
275 /* Freeing stuff. */
276 MEM_delete(org_w);
277 MEM_delete(new_w);
278 MEM_delete(dw);
279
280 mesh->runtime->is_original_bmesh = false;
281
282 /* Return the vgroup-modified mesh. */
283 return mesh;
284}
285
286static void panel_draw(const bContext * /*C*/, Panel *panel)
287{
288 ui::Layout *sub, *col, *row;
289 ui::Layout &layout = *panel->layout;
290
291 PointerRNA ob_ptr;
293
294 layout.use_property_split_set(true);
295
296 col = &layout.column(true);
297 col->prop_search(ptr, "vertex_group", &ob_ptr, "vertex_groups", std::nullopt, ICON_GROUP_VERTEX);
298
299 layout.prop(ptr, "default_weight", ui::ITEM_R_SLIDER, std::nullopt, ICON_NONE);
300
301 col = &layout.column(false, IFACE_("Group Add"));
302 row = &col->row(true);
303 row->use_property_decorate_set(false);
304 sub = &row->row(true);
305 sub->prop(ptr, "use_add", UI_ITEM_NONE, "", ICON_NONE);
306 sub = &sub->row(true);
307 sub->active_set(RNA_boolean_get(ptr, "use_add"));
308 sub->use_property_split_set(false);
309 sub->prop(ptr, "add_threshold", ui::ITEM_R_SLIDER, IFACE_("Threshold"), ICON_NONE);
310 row->decorator(ptr, "add_threshold", 0);
311
312 col = &layout.column(false, IFACE_("Group Remove"));
313 row = &col->row(true);
314 row->use_property_decorate_set(false);
315 sub = &row->row(true);
316 sub->prop(ptr, "use_remove", UI_ITEM_NONE, "", ICON_NONE);
317 sub = &sub->row(true);
318 sub->active_set(RNA_boolean_get(ptr, "use_remove"));
319 sub->use_property_split_set(false);
320 sub->prop(ptr, "remove_threshold", ui::ITEM_R_SLIDER, IFACE_("Threshold"), ICON_NONE);
321 row->decorator(ptr, "remove_threshold", 0);
322
323 layout.prop(ptr, "normalize", UI_ITEM_NONE, std::nullopt, ICON_NONE);
324
325 modifier_error_message_draw(layout, ptr);
326}
327
328static void falloff_panel_draw(const bContext * /*C*/, Panel *panel)
329{
330 ui::Layout &layout = *panel->layout;
331
332 PointerRNA ob_ptr;
334
335 layout.use_property_split_set(true);
336
337 ui::Layout &row = layout.row(true);
338 row.prop(ptr, "falloff_type", UI_ITEM_NONE, IFACE_("Type"), ICON_NONE);
339 ui::Layout &sub = row.row(true);
340 sub.use_property_split_set(false);
341 row.prop(ptr, "invert_falloff", UI_ITEM_NONE, "", ICON_ARROW_LEFTRIGHT);
342 if (RNA_enum_get(ptr, "falloff_type") == MOD_WVG_MAPPING_CURVE) {
343 template_curve_mapping(&layout, ptr, "map_curve", 0, false, false, false, false, false);
344 }
345}
346
347static void influence_panel_draw(const bContext *C, Panel *panel)
348{
349 ui::Layout &layout = *panel->layout;
350
351 PointerRNA ob_ptr;
353
354 weightvg_ui_common(C, &ob_ptr, ptr, layout);
355}
356
357static void panel_register(ARegionType *region_type)
358{
362 region_type, "falloff", "Falloff", nullptr, falloff_panel_draw, panel_type);
364 region_type, "influence", "Influence", nullptr, influence_panel_draw, panel_type);
365}
366
367static void blend_write(BlendWriter *writer, const ID * /*id_owner*/, const ModifierData *md)
368{
369 const WeightVGEditModifierData *wmd = reinterpret_cast<const WeightVGEditModifierData *>(md);
370
371 writer->write_struct(wmd);
372
373 if (wmd->cmap_curve) {
375 }
376}
377
378static void blend_read(BlendDataReader *reader, ModifierData *md)
379{
380 WeightVGEditModifierData *wmd = reinterpret_cast<WeightVGEditModifierData *>(md);
381
383 if (wmd->cmap_curve) {
385 }
386}
387
389
391 /*idname*/ "VertexWeightEdit",
392 /*name*/ N_("VertexWeightEdit"),
393 /*struct_name*/ "WeightVGEditModifierData",
394 /*struct_size*/ sizeof(WeightVGEditModifierData),
395 /*srna*/ &RNA_VertexWeightEditModifier,
399 /*icon*/ ICON_MOD_VERTEX_WEIGHT,
400
401 /*copy_data*/ copy_data,
402
403 /*deform_verts*/ nullptr,
404 /*deform_matrices*/ nullptr,
405 /*deform_verts_EM*/ nullptr,
406 /*deform_matrices_EM*/ nullptr,
407 /*modify_mesh*/ modify_mesh,
408 /*modify_geometry_set*/ nullptr,
409
410 /*init_data*/ init_data,
411 /*required_data_mask*/ required_data_mask,
412 /*free_data*/ free_data,
413 /*is_disabled*/ is_disabled,
414 /*update_depsgraph*/ update_depsgraph,
415 /*depends_on_time*/ depends_on_time,
416 /*depends_on_normals*/ nullptr,
417 /*foreach_ID_link*/ foreach_ID_link,
418 /*foreach_tex_link*/ foreach_tex_link,
419 /*free_runtime_data*/ nullptr,
420 /*panel_register*/ panel_register,
421 /*blend_write*/ blend_write,
422 /*blend_read*/ blend_read,
423 /*foreach_cache*/ nullptr,
424 /*foreach_working_space_color*/ nullptr,
425};
426
427} // namespace blender
CustomData interface, see also DNA_customdata_types.h.
support for deformation groups and hooks.
#define BLI_ghashutil_strhash(key)
Definition BLI_ghash.hh:573
Random number functions.
#define BLO_read_struct(reader, struct_name, ptr_p)
#define IFACE_(msgid)
Object is a sort of wrapper for general info.
Read Blender memory allocation and freeing.
#define C
Definition RandGen.cpp:29
#define UI_ITEM_NONE
#define INIT_DEFAULT_STRUCT_AFTER(struct_dst, member)
#define CD_MASK_MDEFORMVERT
#define CD_MASK_MTFACE
BMesh Iterators.
CurveMapping * BKE_curvemapping_add(int tot, float minx, float miny, float maxx, float maxy)
Definition colortools.cc:99
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
static void copy_data(const ModifierData *md, ModifierData *target, const int flag)
CurveMapping * BKE_curvemapping_copy(const CurveMapping *cumap)
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)
PropertyRNA * RNA_struct_find_property(PointerRNA *ptr, const char *identifier)
void DEG_add_generic_id_relation(DepsNodeHandle *node_handle, ID *id, const char *description)
void * MEM_new_array_uninitialized(size_t len, size_t size, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1
static bool depends_on_time(Scene *, ModifierData *)
Definition MOD_build.cc:46
struct RNG * BLI_rng_new_srandom(unsigned int seed)
Definition rand.cc:48
@ eModifierType_WeightVGEdit
static void init_data(ModifierData *md)
void(*)(void *user_data, Object *ob, ID **idpoin, LibraryForeachIDCallbackFlag cb_flag) IDWalkFunc
static void update_depsgraph(tGraphSliderOp *gso)
void BKE_curvemapping_blend_write(BlendWriter *writer, const CurveMapping *cumap)
static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
void BKE_curvemapping_free(CurveMapping *cumap)
void DEG_add_depends_on_transform_relation(DepsNodeHandle *node_handle, const char *description)
int BKE_id_defgroup_name_index(const ID *id, StringRef name)
Definition deform.cc:557
static void required_data_mask(ModifierData *, CustomData_MeshMasks *r_cddata_masks)
void modifier_error_message_draw(ui::Layout &layout, PointerRNA *ptr)
void BKE_curvemapping_init(CurveMapping *cumap)
void BKE_curvemapping_blend_read(BlendDataReader *reader, CurveMapping *cumap)
void MOD_depsgraph_update_object_bone_relation(DepsNodeHandle *node, Object *object, const char *bonename, const char *description)
Definition MOD_util.cc:188
static void free_data(ModifierData *md)
static void panel_register(ARegionType *region_type)
PointerRNA RNA_pointer_create_discrete(ID *id, StructRNA *type, void *data)
void BLI_rng_free(struct RNG *rng) ATTR_NONNULL(1)
Definition rand.cc:55
@ MOD_WVG_EDIT_INVERT_VGROUP_MASK
@ MOD_WVG_EDIT_WEIGHTS_NORMALIZE
bool RNA_boolean_get(PointerRNA *ptr, const char *name)
static void influence_panel_draw(const bContext *C, Panel *panel)
static Mesh * modify_mesh(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh)
Definition MOD_array.cc:873
@ eModifierTypeFlag_SupportsMapping
@ eModifierTypeFlag_SupportsEditmode
@ eModifierTypeFlag_AcceptsMesh
static void foreach_tex_link(ModifierData *md, Object *ob, TexWalkFunc walk, void *user_data)
void weightvg_ui_common(const bContext *C, PointerRNA *ob_ptr, PointerRNA *ptr, ui::Layout &layout)
static void blend_read(BlendDataReader *, ModifierData *md)
ModifierTypeInfo modifierType_WeightVGEdit
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
static void panel_draw(const bContext *, Panel *panel)
PanelType * modifier_subpanel_register(ARegionType *region_type, const char *name, const char *label, PanelDrawFn draw_header, PanelDrawFn draw, PanelType *parent)
void weightvg_update_vg(MDeformVert *dvert, int defgrp_idx, MDeformWeight **dws, int num, const int *indices, const float *weights, const bool do_add, const float add_thresh, const bool do_rem, const float rem_thresh, const bool do_normalize)
void weightvg_do_mask(const ModifierEvalContext *ctx, const int num, const int *indices, float *org_w, const float *new_w, Object *ob, Mesh *mesh, const float fact, const char defgrp_name[MAX_VGROUP_NAME], Scene *, Tex *texture, const int tex_use_channel, const int tex_mapping, Object *tex_map_object, const char *text_map_bone, const char *tex_uvlayer_name, const bool invert_vgroup_mask)
static bool is_disabled(const Scene *, ModifierData *md, bool)
bool BKE_texture_dependsOnTime(const struct Tex *texture)
Scene * DEG_get_evaluated_scene(const Depsgraph *graph)
void weightvg_do_map(int num, float *new_w, short falloff_type, const bool do_invert, CurveMapping *cmap, RNG *rng)
static void falloff_panel_draw(const bContext *, Panel *panel)
Definition MOD_hook.cc:481
void(*)(void *user_data, Object *ob, ModifierData *md, const PointerRNA *ptr, PropertyRNA *texture_prop) TexWalkFunc
MDeformWeight * BKE_defvert_find_index(const MDeformVert *dv, int defgroup)
Definition deform.cc:811
void BKE_modifier_copydata_generic(const ModifierData *md, ModifierData *md_dst, int flag)
void write_struct(const T *data, BlendStructWriterTypedFn< T > fn=nullptr)
char name[258]
Definition DNA_ID.h:433
ui::Layout * layout
WeigthVGEditModifierEditFlags edit_flags
WeightVGProximityModifierMaskTexChannel mask_tex_use_channel
DisplaceModifierTexMapping mask_tex_mapping
WeightVGProximityFalloff falloff_type
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 decorator(PointerRNA *ptr, PropertyRNA *prop, int index)
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)
Layout & row(bool align)
#define N_(msgid)