524 lines
16 KiB
C++
524 lines
16 KiB
C++
/* SPDX-FileCopyrightText: 2011 by Bastien Montagne. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup modifiers
|
|
*/
|
|
|
|
#include <cfloat>
|
|
|
|
#include "BLI_utildefines.h"
|
|
|
|
#include "BLI_listbase.h"
|
|
|
|
#include "BLT_translation.hh"
|
|
|
|
#include "DNA_defaults.h"
|
|
#include "DNA_mesh_types.h"
|
|
#include "DNA_meshdata_types.h"
|
|
#include "DNA_modifier_types.h"
|
|
#include "DNA_object_types.h"
|
|
#include "DNA_screen_types.h"
|
|
#include "DNA_texture_types.h"
|
|
|
|
#include "BKE_customdata.hh"
|
|
#include "BKE_deform.hh"
|
|
#include "BKE_lib_query.hh"
|
|
#include "BKE_mesh.hh"
|
|
#include "BKE_modifier.hh"
|
|
#include "BKE_texture.h" /* Texture masking. */
|
|
|
|
#include "UI_interface_layout.hh"
|
|
#include "UI_resources.hh"
|
|
|
|
#include "RNA_access.hh"
|
|
#include "RNA_prototypes.hh"
|
|
|
|
#include "DEG_depsgraph_build.hh"
|
|
#include "DEG_depsgraph_query.hh"
|
|
|
|
#include "MEM_guardedalloc.h"
|
|
|
|
#include "MOD_ui_common.hh"
|
|
#include "MOD_util.hh"
|
|
#include "MOD_weightvg_util.hh"
|
|
|
|
/**
|
|
* This mixes the old weight with the new weight factor.
|
|
*/
|
|
static float mix_weight(float weight, float weight2, char mix_mode)
|
|
{
|
|
#if 0
|
|
/*
|
|
* XXX Don't know why, but the switch version takes many CPU time,
|
|
* and produces lag in realtime playback...
|
|
*/
|
|
switch (mix_mode) {
|
|
case MOD_WVG_MIX_ADD:
|
|
return (weight + weight2);
|
|
case MOD_WVG_MIX_SUB:
|
|
return (weight - weight2);
|
|
case MOD_WVG_MIX_MUL:
|
|
return (weight * weight2);
|
|
case MOD_WVG_MIX_DIV:
|
|
/* Avoid dividing by zero (or really small values). */
|
|
if (0.0 <= weight2 < MOD_WVG_ZEROFLOOR) {
|
|
weight2 = MOD_WVG_ZEROFLOOR;
|
|
}
|
|
else if (-MOD_WVG_ZEROFLOOR < weight2) {
|
|
weight2 = -MOD_WVG_ZEROFLOOR;
|
|
}
|
|
return (weight / weight2);
|
|
case MOD_WVG_MIX_DIF:
|
|
return (weight < weight2 ? weight2 - weight : weight - weight2);
|
|
case MOD_WVG_MIX_AVG:
|
|
return (weight + weight2) / 2.0;
|
|
case MOD_WVG_MIX_SET:
|
|
default:
|
|
return weight2;
|
|
}
|
|
#endif
|
|
if (mix_mode == MOD_WVG_MIX_SET) {
|
|
return weight2;
|
|
}
|
|
if (mix_mode == MOD_WVG_MIX_ADD) {
|
|
return (weight + weight2);
|
|
}
|
|
if (mix_mode == MOD_WVG_MIX_SUB) {
|
|
return (weight - weight2);
|
|
}
|
|
if (mix_mode == MOD_WVG_MIX_MUL) {
|
|
return (weight * weight2);
|
|
}
|
|
if (mix_mode == MOD_WVG_MIX_DIV) {
|
|
/* Avoid dividing by zero (or really small values). */
|
|
if (weight2 < 0.0f && weight2 > -MOD_WVG_ZEROFLOOR) {
|
|
weight2 = -MOD_WVG_ZEROFLOOR;
|
|
}
|
|
else if (weight2 >= 0.0f && weight2 < MOD_WVG_ZEROFLOOR) {
|
|
weight2 = MOD_WVG_ZEROFLOOR;
|
|
}
|
|
return (weight / weight2);
|
|
}
|
|
if (mix_mode == MOD_WVG_MIX_DIF) {
|
|
return (weight < weight2 ? weight2 - weight : weight - weight2);
|
|
}
|
|
if (mix_mode == MOD_WVG_MIX_AVG) {
|
|
return (weight + weight2) * 0.5f;
|
|
}
|
|
if (mix_mode == MOD_WVG_MIX_MIN) {
|
|
return (weight < weight2 ? weight : weight2);
|
|
}
|
|
if (mix_mode == MOD_WVG_MIX_MAX) {
|
|
return (weight > weight2 ? weight : weight2);
|
|
}
|
|
|
|
return weight2;
|
|
}
|
|
|
|
/**************************************
|
|
* Modifiers functions. *
|
|
**************************************/
|
|
static void init_data(ModifierData *md)
|
|
{
|
|
WeightVGMixModifierData *wmd = (WeightVGMixModifierData *)md;
|
|
|
|
BLI_assert(MEMCMP_STRUCT_AFTER_IS_ZERO(wmd, modifier));
|
|
|
|
MEMCPY_STRUCT_AFTER(wmd, DNA_struct_default_get(WeightVGMixModifierData), modifier);
|
|
}
|
|
|
|
static void required_data_mask(ModifierData *md, CustomData_MeshMasks *r_cddata_masks)
|
|
{
|
|
WeightVGMixModifierData *wmd = (WeightVGMixModifierData *)md;
|
|
|
|
/* We need vertex groups! */
|
|
r_cddata_masks->vmask |= CD_MASK_MDEFORMVERT;
|
|
|
|
/* Ask for UV coordinates if we need them. */
|
|
if (wmd->mask_tex_mapping == MOD_DISP_MAP_UV) {
|
|
r_cddata_masks->fmask |= CD_MASK_MTFACE;
|
|
}
|
|
}
|
|
|
|
static bool depends_on_time(Scene * /*scene*/, ModifierData *md)
|
|
{
|
|
WeightVGMixModifierData *wmd = (WeightVGMixModifierData *)md;
|
|
|
|
if (wmd->mask_texture) {
|
|
return BKE_texture_dependsOnTime(wmd->mask_texture);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
|
|
{
|
|
WeightVGMixModifierData *wmd = (WeightVGMixModifierData *)md;
|
|
|
|
walk(user_data, ob, (ID **)&wmd->mask_texture, IDWALK_CB_USER);
|
|
walk(user_data, ob, (ID **)&wmd->mask_tex_map_obj, IDWALK_CB_NOP);
|
|
}
|
|
|
|
static void foreach_tex_link(ModifierData *md, Object *ob, TexWalkFunc walk, void *user_data)
|
|
{
|
|
PointerRNA ptr = RNA_pointer_create_discrete(&ob->id, &RNA_Modifier, md);
|
|
PropertyRNA *prop = RNA_struct_find_property(&ptr, "mask_texture");
|
|
walk(user_data, ob, md, &ptr, prop);
|
|
}
|
|
|
|
static void update_depsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
|
|
{
|
|
WeightVGMixModifierData *wmd = (WeightVGMixModifierData *)md;
|
|
bool need_transform_relation = false;
|
|
|
|
if (wmd->mask_texture != nullptr) {
|
|
DEG_add_generic_id_relation(ctx->node, &wmd->mask_texture->id, "WeightVGMix Modifier");
|
|
|
|
if (wmd->mask_tex_map_obj != nullptr && wmd->mask_tex_mapping == MOD_DISP_MAP_OBJECT) {
|
|
MOD_depsgraph_update_object_bone_relation(
|
|
ctx->node, wmd->mask_tex_map_obj, wmd->mask_tex_map_bone, "WeightVGMix Modifier");
|
|
need_transform_relation = true;
|
|
}
|
|
else if (wmd->mask_tex_mapping == MOD_DISP_MAP_GLOBAL) {
|
|
need_transform_relation = true;
|
|
}
|
|
}
|
|
|
|
if (need_transform_relation) {
|
|
DEG_add_depends_on_transform_relation(ctx->node, "WeightVGMix Modifier");
|
|
}
|
|
}
|
|
|
|
static bool is_disabled(const Scene * /*scene*/, ModifierData *md, bool /*use_render_params*/)
|
|
{
|
|
WeightVGMixModifierData *wmd = (WeightVGMixModifierData *)md;
|
|
/* If no vertex group, bypass. */
|
|
return (wmd->defgrp_name_a[0] == '\0');
|
|
}
|
|
|
|
static Mesh *modify_mesh(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh)
|
|
{
|
|
BLI_assert(mesh != nullptr);
|
|
|
|
WeightVGMixModifierData *wmd = (WeightVGMixModifierData *)md;
|
|
|
|
MDeformWeight **dw1, **tdw1, **dw2, **tdw2;
|
|
float *org_w;
|
|
float *new_w;
|
|
int *tidx, *indices = nullptr;
|
|
int index_num = 0;
|
|
int i;
|
|
const bool invert_vgroup_mask = (wmd->flag & MOD_WVG_MIX_INVERT_VGROUP_MASK) != 0;
|
|
const bool do_normalize = (wmd->flag & MOD_WVG_MIX_WEIGHTS_NORMALIZE) != 0;
|
|
|
|
/*
|
|
* Note that we only invert the weight values within provided vgroups, the selection based on
|
|
* which vertex is affected because it belongs or not to a group remains unchanged.
|
|
* In other words, vertices not belonging to a group won't be affected, even though their
|
|
* inverted 'virtual' weight would be 1.0f.
|
|
*/
|
|
const bool invert_vgroup_a = (wmd->flag & MOD_WVG_MIX_INVERT_VGROUP_A) != 0;
|
|
const bool invert_vgroup_b = (wmd->flag & MOD_WVG_MIX_INVERT_VGROUP_B) != 0;
|
|
|
|
/* Flags. */
|
|
#if 0
|
|
const bool do_prev = (wmd->modifier.mode & eModifierMode_DoWeightPreview) != 0;
|
|
#endif
|
|
|
|
/* Get number of verts. */
|
|
const int verts_num = mesh->verts_num;
|
|
|
|
/* Check if we can just return the original mesh.
|
|
* Must have verts and therefore verts assigned to vgroups to do anything useful!
|
|
*/
|
|
if ((verts_num == 0) || BLI_listbase_is_empty(&mesh->vertex_group_names)) {
|
|
return mesh;
|
|
}
|
|
|
|
/* Get vgroup idx from its name. */
|
|
const int defgrp_index = BKE_id_defgroup_name_index(&mesh->id, wmd->defgrp_name_a);
|
|
if (defgrp_index == -1) {
|
|
return mesh;
|
|
}
|
|
/* Get second vgroup idx from its name, if given. */
|
|
int defgrp_index_other = -1;
|
|
if (wmd->defgrp_name_b[0] != '\0') {
|
|
defgrp_index_other = BKE_id_defgroup_name_index(&mesh->id, wmd->defgrp_name_b);
|
|
if (defgrp_index_other == -1) {
|
|
return mesh;
|
|
}
|
|
}
|
|
|
|
const bool has_mdef = !mesh->deform_verts().is_empty();
|
|
/* If no vertices were ever added to an object's vgroup, dvert might be nullptr. */
|
|
if (!has_mdef) {
|
|
/* If not affecting all vertices, just return. */
|
|
if (wmd->mix_set != MOD_WVG_SET_ALL) {
|
|
return mesh;
|
|
}
|
|
}
|
|
|
|
MDeformVert *dvert = mesh->deform_verts_for_write().data();
|
|
|
|
/* Ultimate security check. */
|
|
if (!dvert) {
|
|
return mesh;
|
|
}
|
|
|
|
/* Find out which vertices to work on. */
|
|
tidx = MEM_malloc_arrayN<int>(size_t(verts_num), __func__);
|
|
tdw1 = MEM_malloc_arrayN<MDeformWeight *>(size_t(verts_num), __func__);
|
|
tdw2 = MEM_malloc_arrayN<MDeformWeight *>(size_t(verts_num), __func__);
|
|
switch (wmd->mix_set) {
|
|
case MOD_WVG_SET_A:
|
|
/* All vertices in first vgroup. */
|
|
for (i = 0; i < verts_num; i++) {
|
|
MDeformWeight *dw = BKE_defvert_find_index(&dvert[i], defgrp_index);
|
|
if (dw) {
|
|
tdw1[index_num] = dw;
|
|
tdw2[index_num] = (defgrp_index_other >= 0) ?
|
|
BKE_defvert_find_index(&dvert[i], defgrp_index_other) :
|
|
nullptr;
|
|
tidx[index_num++] = i;
|
|
}
|
|
}
|
|
break;
|
|
case MOD_WVG_SET_B:
|
|
/* All vertices in second vgroup. */
|
|
for (i = 0; i < verts_num; i++) {
|
|
MDeformWeight *dw = (defgrp_index_other >= 0) ?
|
|
BKE_defvert_find_index(&dvert[i], defgrp_index_other) :
|
|
nullptr;
|
|
if (dw) {
|
|
tdw1[index_num] = BKE_defvert_find_index(&dvert[i], defgrp_index);
|
|
tdw2[index_num] = dw;
|
|
tidx[index_num++] = i;
|
|
}
|
|
}
|
|
break;
|
|
case MOD_WVG_SET_OR:
|
|
/* All vertices in one vgroup or the other. */
|
|
for (i = 0; i < verts_num; i++) {
|
|
MDeformWeight *adw = BKE_defvert_find_index(&dvert[i], defgrp_index);
|
|
MDeformWeight *bdw = (defgrp_index_other >= 0) ?
|
|
BKE_defvert_find_index(&dvert[i], defgrp_index_other) :
|
|
nullptr;
|
|
if (adw || bdw) {
|
|
tdw1[index_num] = adw;
|
|
tdw2[index_num] = bdw;
|
|
tidx[index_num++] = i;
|
|
}
|
|
}
|
|
break;
|
|
case MOD_WVG_SET_AND:
|
|
/* All vertices in both vgroups. */
|
|
for (i = 0; i < verts_num; i++) {
|
|
MDeformWeight *adw = BKE_defvert_find_index(&dvert[i], defgrp_index);
|
|
MDeformWeight *bdw = (defgrp_index_other >= 0) ?
|
|
BKE_defvert_find_index(&dvert[i], defgrp_index_other) :
|
|
nullptr;
|
|
if (adw && bdw) {
|
|
tdw1[index_num] = adw;
|
|
tdw2[index_num] = bdw;
|
|
tidx[index_num++] = i;
|
|
}
|
|
}
|
|
break;
|
|
case MOD_WVG_SET_ALL:
|
|
default:
|
|
/* Use all vertices. */
|
|
for (i = 0; i < verts_num; i++) {
|
|
tdw1[i] = BKE_defvert_find_index(&dvert[i], defgrp_index);
|
|
tdw2[i] = (defgrp_index_other >= 0) ?
|
|
BKE_defvert_find_index(&dvert[i], defgrp_index_other) :
|
|
nullptr;
|
|
}
|
|
index_num = -1;
|
|
break;
|
|
}
|
|
if (index_num == 0) {
|
|
/* Use no vertices! Hence, return org data. */
|
|
MEM_freeN(tdw1);
|
|
MEM_freeN(tdw2);
|
|
MEM_freeN(tidx);
|
|
return mesh;
|
|
}
|
|
if (index_num != -1) {
|
|
indices = MEM_malloc_arrayN<int>(size_t(index_num), __func__);
|
|
memcpy(indices, tidx, sizeof(int) * index_num);
|
|
dw1 = MEM_malloc_arrayN<MDeformWeight *>(size_t(index_num), __func__);
|
|
memcpy(dw1, tdw1, sizeof(MDeformWeight *) * index_num);
|
|
MEM_freeN(tdw1);
|
|
dw2 = MEM_malloc_arrayN<MDeformWeight *>(size_t(index_num), __func__);
|
|
memcpy(dw2, tdw2, sizeof(MDeformWeight *) * index_num);
|
|
MEM_freeN(tdw2);
|
|
}
|
|
else {
|
|
/* Use all vertices. */
|
|
index_num = verts_num;
|
|
/* Just copy MDeformWeight pointers arrays, they will be freed at the end. */
|
|
dw1 = tdw1;
|
|
dw2 = tdw2;
|
|
}
|
|
MEM_freeN(tidx);
|
|
|
|
org_w = MEM_malloc_arrayN<float>(size_t(index_num), __func__);
|
|
new_w = MEM_malloc_arrayN<float>(size_t(index_num), __func__);
|
|
|
|
/* Mix weights. */
|
|
for (i = 0; i < index_num; i++) {
|
|
float weight2;
|
|
if (invert_vgroup_a) {
|
|
org_w[i] = 1.0f - (dw1[i] ? dw1[i]->weight : wmd->default_weight_a);
|
|
}
|
|
else {
|
|
org_w[i] = dw1[i] ? dw1[i]->weight : wmd->default_weight_a;
|
|
}
|
|
if (invert_vgroup_b) {
|
|
weight2 = 1.0f - (dw2[i] ? dw2[i]->weight : wmd->default_weight_b);
|
|
}
|
|
else {
|
|
weight2 = dw2[i] ? dw2[i]->weight : wmd->default_weight_b;
|
|
}
|
|
|
|
new_w[i] = mix_weight(org_w[i], weight2, wmd->mix_mode);
|
|
}
|
|
|
|
/* Do masking. */
|
|
Scene *scene = DEG_get_evaluated_scene(ctx->depsgraph);
|
|
weightvg_do_mask(ctx,
|
|
index_num,
|
|
indices,
|
|
org_w,
|
|
new_w,
|
|
ctx->object,
|
|
mesh,
|
|
wmd->mask_constant,
|
|
wmd->mask_defgrp_name,
|
|
scene,
|
|
wmd->mask_texture,
|
|
wmd->mask_tex_use_channel,
|
|
wmd->mask_tex_mapping,
|
|
wmd->mask_tex_map_obj,
|
|
wmd->mask_tex_map_bone,
|
|
wmd->mask_tex_uvlayer_name,
|
|
invert_vgroup_mask);
|
|
|
|
/* Update (add to) vgroup.
|
|
* XXX Depending on the MOD_WVG_SET_xxx option chosen, we might have to add vertices to vgroup.
|
|
*/
|
|
weightvg_update_vg(dvert,
|
|
defgrp_index,
|
|
dw1,
|
|
index_num,
|
|
indices,
|
|
org_w,
|
|
true,
|
|
-FLT_MAX,
|
|
false,
|
|
0.0f,
|
|
do_normalize);
|
|
|
|
/* If weight preview enabled... */
|
|
#if 0 /* XXX Currently done in mod stack :/ */
|
|
if (do_prev) {
|
|
DM_update_weight_mcol(ob, dm, 0, org_w, index_num, indices);
|
|
}
|
|
#endif
|
|
|
|
/* Freeing stuff. */
|
|
MEM_freeN(org_w);
|
|
MEM_freeN(new_w);
|
|
MEM_freeN(dw1);
|
|
MEM_freeN(dw2);
|
|
MEM_SAFE_FREE(indices);
|
|
|
|
mesh->runtime->is_original_bmesh = false;
|
|
|
|
/* Return the vgroup-modified mesh. */
|
|
return mesh;
|
|
}
|
|
|
|
static void panel_draw(const bContext * /*C*/, Panel *panel)
|
|
{
|
|
uiLayout *layout = panel->layout;
|
|
|
|
PointerRNA ob_ptr;
|
|
PointerRNA *ptr = modifier_panel_get_property_pointers(panel, &ob_ptr);
|
|
|
|
layout->use_property_split_set(true);
|
|
|
|
modifier_vgroup_ui(
|
|
layout, ptr, &ob_ptr, "vertex_group_a", "invert_vertex_group_a", std::nullopt);
|
|
modifier_vgroup_ui(layout, ptr, &ob_ptr, "vertex_group_b", "invert_vertex_group_b", IFACE_("B"));
|
|
|
|
layout->separator();
|
|
|
|
layout->prop(ptr, "default_weight_a", UI_ITEM_NONE, std::nullopt, ICON_NONE);
|
|
layout->prop(ptr, "default_weight_b", UI_ITEM_NONE, IFACE_("B"), ICON_NONE);
|
|
|
|
layout->separator();
|
|
|
|
layout->prop(ptr, "mix_set", UI_ITEM_NONE, std::nullopt, ICON_NONE);
|
|
layout->prop(ptr, "mix_mode", UI_ITEM_NONE, std::nullopt, ICON_NONE);
|
|
|
|
layout->prop(ptr, "normalize", UI_ITEM_NONE, std::nullopt, ICON_NONE);
|
|
|
|
modifier_error_message_draw(layout, ptr);
|
|
}
|
|
|
|
static void influence_panel_draw(const bContext *C, Panel *panel)
|
|
{
|
|
uiLayout *layout = panel->layout;
|
|
|
|
PointerRNA ob_ptr;
|
|
PointerRNA *ptr = modifier_panel_get_property_pointers(panel, &ob_ptr);
|
|
|
|
weightvg_ui_common(C, &ob_ptr, ptr, layout);
|
|
}
|
|
|
|
static void panel_register(ARegionType *region_type)
|
|
{
|
|
PanelType *panel_type = modifier_panel_register(
|
|
region_type, eModifierType_WeightVGMix, panel_draw);
|
|
modifier_subpanel_register(
|
|
region_type, "influence", "Influence", nullptr, influence_panel_draw, panel_type);
|
|
}
|
|
|
|
ModifierTypeInfo modifierType_WeightVGMix = {
|
|
/*idname*/ "VertexWeightMix",
|
|
/*name*/ N_("VertexWeightMix"),
|
|
/*struct_name*/ "WeightVGMixModifierData",
|
|
/*struct_size*/ sizeof(WeightVGMixModifierData),
|
|
/*srna*/ &RNA_VertexWeightMixModifier,
|
|
/*type*/ ModifierTypeType::NonGeometrical,
|
|
/*flags*/ eModifierTypeFlag_AcceptsMesh | eModifierTypeFlag_SupportsMapping |
|
|
eModifierTypeFlag_SupportsEditmode,
|
|
/*icon*/ ICON_MOD_VERTEX_WEIGHT,
|
|
|
|
/*copy_data*/ BKE_modifier_copydata_generic,
|
|
|
|
/*deform_verts*/ nullptr,
|
|
/*deform_matrices*/ nullptr,
|
|
/*deform_verts_EM*/ nullptr,
|
|
/*deform_matrices_EM*/ nullptr,
|
|
/*modify_mesh*/ modify_mesh,
|
|
/*modify_geometry_set*/ nullptr,
|
|
|
|
/*init_data*/ init_data,
|
|
/*required_data_mask*/ required_data_mask,
|
|
/*free_data*/ nullptr,
|
|
/*is_disabled*/ is_disabled,
|
|
/*update_depsgraph*/ update_depsgraph,
|
|
/*depends_on_time*/ depends_on_time,
|
|
/*depends_on_normals*/ nullptr,
|
|
/*foreach_ID_link*/ foreach_ID_link,
|
|
/*foreach_tex_link*/ foreach_tex_link,
|
|
/*free_runtime_data*/ nullptr,
|
|
/*panel_register*/ panel_register,
|
|
/*blend_write*/ nullptr,
|
|
/*blend_read*/ nullptr,
|
|
/*foreach_cache*/ nullptr,
|
|
};
|