GPencil: Split Weight modifier in two to make more consistent

The old modifier had two modes, but it is better to keep separated as meshes.

The UI has changed to be more consistent, including a new column type of modifiers.

Note: The logic has not changed with the previous version of the modifier, just is a split on two modifiers..

Reviewed By: mendio, pablovazquez

Differential Revision: https://developer.blender.org/D12586

1 files changed, 275 insertions, 0 deletions

diff --git a/source/blender/gpencil_modifiers/intern/MOD_gpencilweight_proximity.c b/source/blender/gpencil_modifiers/intern/MOD_gpencilweight_proximity.c
new file mode 100644
index 00000000000..0885828a3a0
--- /dev/null
+++ b/source/blender/gpencil_modifiers/intern/MOD_gpencilweight_proximity.c
@@ -0,0 +1,275 @@
+/*
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * The Original Code is Copyright (C) 2021, Blender Foundation
+ * This is a new part of Blender
+ */
+
+/** \file
+ * \ingroup modifiers
+ */
+
+#include <stdio.h>
+
+#include "BLI_listbase.h"
+#include "BLI_math.h"
+#include "BLI_utildefines.h"
+
+#include "DNA_defaults.h"
+#include "DNA_gpencil_modifier_types.h"
+#include "DNA_gpencil_types.h"
+#include "DNA_meshdata_types.h"
+#include "DNA_object_types.h"
+#include "DNA_screen_types.h"
+
+#include "BKE_colortools.h"
+#include "BKE_context.h"
+#include "BKE_deform.h"
+#include "BKE_gpencil.h"
+#include "BKE_gpencil_modifier.h"
+#include "BKE_lib_query.h"
+#include "BKE_modifier.h"
+#include "BKE_screen.h"
+
+#include "DEG_depsgraph.h"
+#include "DEG_depsgraph_build.h"
+#include "DEG_depsgraph_query.h"
+
+#include "UI_interface.h"
+#include "UI_resources.h"
+
+#include "RNA_access.h"
+
+#include "MOD_gpencil_modifiertypes.h"
+#include "MOD_gpencil_ui_common.h"
+#include "MOD_gpencil_util.h"
+
+static void initData(GpencilModifierData *md)
+{
+  WeightProxGpencilModifierData *gpmd = (WeightProxGpencilModifierData *)md;
+
+  BLI_assert(MEMCMP_STRUCT_AFTER_IS_ZERO(gpmd, modifier));
+
+  MEMCPY_STRUCT_AFTER(gpmd, DNA_struct_default_get(WeightProxGpencilModifierData), modifier);
+}
+
+static void copyData(const GpencilModifierData *md, GpencilModifierData *target)
+{
+  BKE_gpencil_modifier_copydata_generic(md, target);
+}
+
+/* Calc distance between point and target object. */
+static float calc_point_weight_by_distance(Object *ob,
+                                           WeightProxGpencilModifierData *mmd,
+                                           const float dist_max,
+                                           const float dist_min,
+                                           bGPDspoint *pt)
+{
+  float weight;
+  float gvert[3];
+  mul_v3_m4v3(gvert, ob->obmat, &pt->x);
+  float dist = len_v3v3(mmd->object->obmat[3], gvert);
+
+  if (dist > dist_max) {
+    weight = 0.0f;
+  }
+  else if (dist <= dist_max && dist > dist_min) {
+    weight = (dist_max - dist) / max_ff((dist_max - dist_min), 0.0001f);
+  }
+  else {
+    weight = 1.0f;
+  }
+
+  return weight;
+}
+
+/* change stroke thickness */
+static void deformStroke(GpencilModifierData *md,
+                         Depsgraph *UNUSED(depsgraph),
+                         Object *ob,
+                         bGPDlayer *gpl,
+                         bGPDframe *UNUSED(gpf),
+                         bGPDstroke *gps)
+{
+  WeightProxGpencilModifierData *mmd = (WeightProxGpencilModifierData *)md;
+  const int def_nr = BKE_object_defgroup_name_index(ob, mmd->vgname);
+
+  if (!is_stroke_affected_by_modifier(ob,
+                                      mmd->layername,
+                                      mmd->material,
+                                      mmd->pass_index,
+                                      mmd->layer_pass,
+                                      1,
+                                      gpl,
+                                      gps,
+                                      mmd->flag & GP_WEIGHT_INVERT_LAYER,
+                                      mmd->flag & GP_WEIGHT_INVERT_PASS,
+                                      mmd->flag & GP_WEIGHT_INVERT_LAYERPASS,
+                                      mmd->flag & GP_WEIGHT_INVERT_MATERIAL)) {
+    return;
+  }
+
+  const float dist_max = MAX2(mmd->dist_start, mmd->dist_end);
+  const float dist_min = MIN2(mmd->dist_start, mmd->dist_end);
+  const int target_def_nr = BKE_object_defgroup_name_index(ob, mmd->target_vgname);
+
+  if (target_def_nr == -1) {
+    return;
+  }
+
+  /* Ensure there is a vertex group. */
+  BKE_gpencil_dvert_ensure(gps);
+
+  float weight_pt = 1.0f;
+  for (int i = 0; i < gps->totpoints; i++) {
+    MDeformVert *dvert = gps->dvert != NULL ? &gps->dvert[i] : NULL;
+    /* Verify point is part of vertex group. */
+    float weight = get_modifier_point_weight(
+        dvert, (mmd->flag & GP_WEIGHT_INVERT_VGROUP) != 0, def_nr);
+    if (weight < 0.0f) {
+      continue;
+    }
+
+    if (mmd->object) {
+      bGPDspoint *pt = &gps->points[i];
+      weight_pt = calc_point_weight_by_distance(ob, mmd, dist_max, dist_min, pt);
+    }
+
+    /* Invert weight if required. */
+    if (mmd->flag & GP_WEIGHT_INVERT_OUTPUT) {
+      weight_pt = 1.0f - weight_pt;
+    }
+    /* Assign weight. */
+    dvert = gps->dvert != NULL ? &gps->dvert[i] : NULL;
+    if (dvert != NULL) {
+      MDeformWeight *dw = BKE_defvert_ensure_index(dvert, target_def_nr);
+      if (dw) {
+        dw->weight = (mmd->flag & GP_WEIGHT_MULTIPLY_DATA) ? dw->weight * weight_pt : weight_pt;
+        CLAMP(dw->weight, mmd->min_weight, 1.0f);
+      }
+    }
+  }
+}
+
+static void bakeModifier(struct Main *UNUSED(bmain),
+                         Depsgraph *depsgraph,
+                         GpencilModifierData *md,
+                         Object *ob)
+{
+  bGPdata *gpd = ob->data;
+
+  LISTBASE_FOREACH (bGPDlayer *, gpl, &gpd->layers) {
+    LISTBASE_FOREACH (bGPDframe *, gpf, &gpl->frames) {
+      LISTBASE_FOREACH (bGPDstroke *, gps, &gpf->strokes) {
+        deformStroke(md, depsgraph, ob, gpl, gpf, gps);
+      }
+    }
+  }
+}
+
+static void foreachIDLink(GpencilModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
+{
+  WeightProxGpencilModifierData *mmd = (WeightProxGpencilModifierData *)md;
+
+  walk(userData, ob, (ID **)&mmd->material, IDWALK_CB_USER);
+  walk(userData, ob, (ID **)&mmd->object, IDWALK_CB_NOP);
+}
+
+static void updateDepsgraph(GpencilModifierData *md,
+                            const ModifierUpdateDepsgraphContext *ctx,
+                            const int UNUSED(mode))
+{
+  WeightProxGpencilModifierData *mmd = (WeightProxGpencilModifierData *)md;
+  if (mmd->object != NULL) {
+    DEG_add_object_relation(
+        ctx->node, mmd->object, DEG_OB_COMP_TRANSFORM, "GPencil Weight Modifier");
+  }
+  DEG_add_object_relation(
+      ctx->node, ctx->object, DEG_OB_COMP_TRANSFORM, "GPencil Weight Modifier");
+}
+
+static bool isDisabled(GpencilModifierData *md, int UNUSED(userRenderParams))
+{
+  WeightProxGpencilModifierData *mmd = (WeightProxGpencilModifierData *)md;
+
+  return ((mmd->target_vgname[0] == '\0') || (mmd->object == NULL));
+}
+
+static void panel_draw(const bContext *UNUSED(C), Panel *panel)
+{
+  uiLayout *row, *sub;
+  uiLayout *layout = panel->layout;
+
+  PointerRNA ob_ptr;
+  PointerRNA *ptr = gpencil_modifier_panel_get_property_pointers(panel, &ob_ptr);
+
+  uiLayoutSetPropSep(layout, true);
+  row = uiLayoutRow(layout, true);
+  uiItemPointerR(row, ptr, "target_vertex_group", &ob_ptr, "vertex_groups", NULL, ICON_NONE);
+  sub = uiLayoutRow(row, true);
+  bool has_output = RNA_string_length(ptr, "target_vertex_group") != 0;
+  uiLayoutSetPropDecorate(sub, false);
+  uiLayoutSetActive(sub, has_output);
+  uiItemR(sub, ptr, "use_invert_output", 0, "", ICON_ARROW_LEFTRIGHT);
+
+  uiItemR(layout, ptr, "object", 0, NULL, ICON_NONE);
+
+  sub = uiLayoutColumn(layout, true);
+  uiItemR(sub, ptr, "distance_start", 0, NULL, ICON_NONE);
+  uiItemR(sub, ptr, "distance_end", 0, NULL, ICON_NONE);
+
+  uiItemR(layout, ptr, "minimum_weight", 0, NULL, ICON_NONE);
+  uiItemR(layout, ptr, "use_multiply", 0, NULL, ICON_NONE);
+
+  gpencil_modifier_panel_end(layout, ptr);
+}
+
+static void mask_panel_draw(const bContext *UNUSED(C), Panel *panel)
+{
+  gpencil_modifier_masking_panel_draw(panel, true, true);
+}
+
+static void panelRegister(ARegionType *region_type)
+{
+  PanelType *panel_type = gpencil_modifier_panel_register(
+      region_type, eGpencilModifierType_WeightProximity, panel_draw);
+
+  gpencil_modifier_subpanel_register(
+      region_type, "mask", "Influence", NULL, mask_panel_draw, panel_type);
+}
+
+GpencilModifierTypeInfo modifierType_Gpencil_WeightProximity = {
+    /* name */ "Vertex Weight Proximity",
+    /* structName */ "WeightProxGpencilModifierData",
+    /* structSize */ sizeof(WeightProxGpencilModifierData),
+    /* type */ eGpencilModifierTypeType_Gpencil,
+    /* flags */ 0,
+
+    /* copyData */ copyData,
+
+    /* deformStroke */ deformStroke,
+    /* generateStrokes */ NULL,
+    /* bakeModifier */ bakeModifier,
+    /* remapTime */ NULL,
+
+    /* initData */ initData,
+    /* freeData */ NULL,
+    /* isDisabled */ isDisabled,
+    /* updateDepsgraph */ updateDepsgraph,
+    /* dependsOnTime */ NULL,
+    /* foreachIDLink */ foreachIDLink,
+    /* foreachTexLink */ NULL,
+    /* panelRegister */ panelRegister,
+};