paint_weight.cc

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#include "MEM_guardedalloc.h"
 
#include "BLI_array_utils.h"
#include "BLI_color_mix.hh"
#include "BLI_enumerable_thread_specific.hh"
#include "BLI_listbase.h"
#include "BLI_math_base.hh"
#include "BLI_rect.h"
#include "BLI_task.hh"
#include "BLI_vector.hh"
 
#include "DNA_brush_types.h"
#include "DNA_mesh_types.h"
#include "DNA_meshdata_types.h"
#include "DNA_object_types.h"
#include "DNA_particle_types.h"
#include "DNA_scene_types.h"
 
#include "RNA_access.hh"
 
#include "BKE_attribute.hh"
#include "BKE_brush.hh"
#include "BKE_context.hh"
#include "BKE_deform.hh"
#include "BKE_editmesh.hh"
#include "BKE_lib_id.hh"
#include "BKE_mesh.hh"
#include "BKE_object.hh"
#include "BKE_object_deform.h"
#include "BKE_paint.hh"
#include "BKE_report.hh"
 
#include "DEG_depsgraph.hh"
 
#include "WM_api.hh"
#include "WM_message.hh"
#include "WM_toolsystem.hh"
#include "WM_types.hh"
 
#include "ED_image.hh"
#include "ED_mesh.hh"
#include "ED_object.hh"
#include "ED_paint.hh"
#include "ED_screen.hh"
#include "ED_view3d.hh"
 
/* For IMB_BlendMode only. */
#include "IMB_imbuf.hh"
 
#include "bmesh.hh"
 
#include "RNA_define.hh"
 
#include "mesh_brush_common.hh"
#include "paint_intern.hh" /* own include */
#include "sculpt_automask.hh"
#include "sculpt_intern.hh"
 
using namespace blender;
using namespace blender::ed::sculpt_paint;
using blender::ed::sculpt_paint::vwpaint::NormalAnglePrecalc;
 
struct WPaintAverageAccum {
  uint len;
  double value;
};

struct WeightPaintGroupData {
  int index;
  const bool *lock;
};
 
struct WPaintData : public PaintModeData {
  ViewContext vc;
  NormalAnglePrecalc normal_angle_precalc;
 
  WeightPaintGroupData active, mirror;
 
  /* variables for auto normalize */
  const bool *vgroup_validmap; /* stores if vgroups tie to deforming bones or not */
  const bool *lock_flags;
  const bool *vgroup_locked;   /* mask of locked defbones */
  const bool *vgroup_unlocked; /* mask of unlocked defbones */
 
  /* variables for multipaint */
  const bool *defbase_sel; /* set of selected groups */
  int defbase_tot_sel;     /* number of selected groups */
  bool do_multipaint;      /* true if multipaint enabled and multiple groups selected */
  bool do_lock_relative;
 
  int defbase_tot;
 
  /* original weight values for use in blur/smear */
  float *precomputed_weight;
  bool precomputed_weight_ready;
 
  ~WPaintData() override
  {
    MEM_SAFE_FREE(defbase_sel);
    MEM_SAFE_FREE(vgroup_validmap);
    MEM_SAFE_FREE(vgroup_locked);
    MEM_SAFE_FREE(vgroup_unlocked);
    MEM_SAFE_FREE(lock_flags);
    MEM_SAFE_FREE(active.lock);
    MEM_SAFE_FREE(mirror.lock);
    MEM_SAFE_FREE(precomputed_weight);
  }
};
 
/* struct to avoid passing many args each call to do_weight_paint_vertex()
 * this _could_ be made a part of the operators 'WPaintData' struct, or at
 * least a member, but for now keep its own struct, initialized on every
 * paint stroke update - campbell */
struct WeightPaintInfo {
 
  MutableSpan<MDeformVert> dvert;
 
  int defbase_tot;
 
  /* both must add up to 'defbase_tot' */
  int defbase_tot_sel;
  int defbase_tot_unsel;
 
  WeightPaintGroupData active, mirror;
 
  /* boolean array for locked bones,
   * length of defbase_tot */
  const bool *lock_flags;
  /* boolean array for selected bones,
   * length of defbase_tot, can't be const because of how it's passed */
  const bool *defbase_sel;
  /* same as WeightPaintData.vgroup_validmap,
   * only added here for convenience */
  const bool *vgroup_validmap;
  /* same as WeightPaintData.vgroup_locked/unlocked,
   * only added here for convenience */
  const bool *vgroup_locked;
  const bool *vgroup_unlocked;
 
  bool do_flip;
  bool do_multipaint;
  bool do_auto_normalize;
  bool do_lock_relative;
  bool is_normalized;
 
  float brush_alpha_value; /* result of BKE_brush_alpha_get() */
};
 
static MDeformVert *defweight_prev_init(MDeformVert *dvert_prev,
                                        MDeformVert *dvert_curr,
                                        int index)
{
  const MDeformVert *dv_curr = &dvert_curr[index];
  MDeformVert *dv_prev = &dvert_prev[index];
  if (dv_prev->flag == 1) {
    dv_prev->flag = 0;
    BKE_defvert_copy(dv_prev, dv_curr);
  }
  return dv_prev;
}
 
static float wpaint_blend(const VPaint &wp,
                          float weight,
                          const float alpha,
                          float paintval,
                          const float /*brush_alpha_value*/,
                          const bool do_flip)
{
  const Brush &brush = *BKE_paint_brush_for_read(&wp.paint);
  IMB_BlendMode blend = (IMB_BlendMode)brush.blend;
 
  if (do_flip) {
    switch (blend) {
      case IMB_BLEND_MIX:
        paintval = 1.0f - paintval;
        break;
      case IMB_BLEND_ADD:
        blend = IMB_BLEND_SUB;
        break;
      case IMB_BLEND_SUB:
        blend = IMB_BLEND_ADD;
        break;
      case IMB_BLEND_LIGHTEN:
        blend = IMB_BLEND_DARKEN;
        break;
      case IMB_BLEND_DARKEN:
        blend = IMB_BLEND_LIGHTEN;
        break;
      default:
        break;
    }
  }
 
  weight = ED_wpaint_blend_tool(blend, weight, paintval, alpha);
 
  CLAMP(weight, 0.0f, 1.0f);
  /* The following is a reasonable lower bound for values that a user may want for weight values,
   * without this rounding, attempting to paint to an exact value of 0.0 becomes tedious. */
  constexpr float threshold = 0.0001f;
  return weight < threshold ? 0.0f : weight;
}
 
static float wpaint_clamp_monotonic(float oldval, float curval, float newval)
{
  if (newval < oldval) {
    return std::min(newval, curval);
  }
  if (newval > oldval) {
    return std::max(newval, curval);
  }
  return newval;
}
 
static float wpaint_undo_lock_relative(
    float weight, float old_weight, float locked_weight, float free_weight, bool auto_normalize)
{
  /* In auto-normalize mode, or when there is no unlocked weight,
   * compute based on locked weight. */
  if (auto_normalize || free_weight <= 0.0f) {
    if (locked_weight < 1.0f - VERTEX_WEIGHT_LOCK_EPSILON) {
      weight *= (1.0f - locked_weight);
    }
    else {
      weight = 0;
    }
  }
  else {
    /* When dealing with full unlocked weight, don't paint, as it is always displayed as 1. */
    if (old_weight >= free_weight) {
      weight = old_weight;
    }
    /* Try to compute a weight value that would produce the desired effect if normalized. */
    else if (weight < 1.0f) {
      weight = weight * (free_weight - old_weight) / (1 - weight);
    }
    else {
      weight = 1.0f;
    }
  }
 
  return weight;
}
 
/* ----------------------------------------------------- */
 
static void do_weight_paint_normalize_all(MDeformVert *dvert,
                                          const int defbase_tot,
                                          const bool *vgroup_validmap)
{
  float sum = 0.0f, fac;
  uint i, tot = 0;
  MDeformWeight *dw;
 
  for (i = dvert->totweight, dw = dvert->dw; i != 0; i--, dw++) {
    if (dw->def_nr < defbase_tot && vgroup_validmap[dw->def_nr]) {
      tot++;
      sum += dw->weight;
    }
  }
 
  if ((tot == 0) || (sum == 1.0f)) {
    return;
  }
 
  if (sum != 0.0f) {
    fac = 1.0f / sum;
 
    for (i = dvert->totweight, dw = dvert->dw; i != 0; i--, dw++) {
      if (dw->def_nr < defbase_tot && vgroup_validmap[dw->def_nr]) {
        dw->weight *= fac;
      }
    }
  }
  else {
    /* hrmf, not a factor in this case */
    fac = 1.0f / tot;
 
    for (i = dvert->totweight, dw = dvert->dw; i != 0; i--, dw++) {
      if (dw->def_nr < defbase_tot && vgroup_validmap[dw->def_nr]) {
        dw->weight = fac;
      }
    }
  }
}

static bool do_weight_paint_normalize_all_locked(MDeformVert *dvert,
                                                 const int defbase_tot,
                                                 const bool *vgroup_validmap,
                                                 const bool *lock_flags)
{
  float sum = 0.0f, fac;
  float sum_unlock = 0.0f;
  float lock_weight = 0.0f;
  uint i, tot = 0;
  MDeformWeight *dw;
 
  if (lock_flags == nullptr) {
    do_weight_paint_normalize_all(dvert, defbase_tot, vgroup_validmap);
    return true;
  }
 
  for (i = dvert->totweight, dw = dvert->dw; i != 0; i--, dw++) {
    if (dw->def_nr < defbase_tot && vgroup_validmap[dw->def_nr]) {
      sum += dw->weight;
 
      if (lock_flags[dw->def_nr]) {
        lock_weight += dw->weight;
      }
      else {
        tot++;
        sum_unlock += dw->weight;
      }
    }
  }
 
  if (sum == 1.0f) {
    return true;
  }
 
  if (tot == 0) {
    return false;
  }
 
  if (lock_weight >= 1.0f - VERTEX_WEIGHT_LOCK_EPSILON) {
    /* locked groups make it impossible to fully normalize,
     * zero out what we can and return false */
    for (i = dvert->totweight, dw = dvert->dw; i != 0; i--, dw++) {
      if (dw->def_nr < defbase_tot && vgroup_validmap[dw->def_nr]) {
        if (lock_flags[dw->def_nr] == false) {
          dw->weight = 0.0f;
        }
      }
    }
 
    return (lock_weight == 1.0f);
  }
  if (sum_unlock != 0.0f) {
    fac = (1.0f - lock_weight) / sum_unlock;
 
    for (i = dvert->totweight, dw = dvert->dw; i != 0; i--, dw++) {
      if (dw->def_nr < defbase_tot && vgroup_validmap[dw->def_nr]) {
        if (lock_flags[dw->def_nr] == false) {
          dw->weight *= fac;
          /* paranoid but possibly with float error */
          CLAMP(dw->weight, 0.0f, 1.0f);
        }
      }
    }
  }
  else {
    /* hrmf, not a factor in this case */
    fac = (1.0f - lock_weight) / tot;
    /* paranoid but possibly with float error */
    CLAMP(fac, 0.0f, 1.0f);
 
    for (i = dvert->totweight, dw = dvert->dw; i != 0; i--, dw++) {
      if (dw->def_nr < defbase_tot && vgroup_validmap[dw->def_nr]) {
        if (lock_flags[dw->def_nr] == false) {
          dw->weight = fac;
        }
      }
    }
  }
 
  return true;
}

static void do_weight_paint_normalize_all_locked_try_active(MDeformVert *dvert,
                                                            const int defbase_tot,
                                                            const bool *vgroup_validmap,
                                                            const bool *lock_flags,
                                                            const bool *lock_with_active)
{
  /* first pass with both active and explicitly locked groups restricted from change */
 
  bool success = do_weight_paint_normalize_all_locked(
      dvert, defbase_tot, vgroup_validmap, lock_with_active);
 
  if (!success) {
    do_weight_paint_normalize_all_locked(dvert, defbase_tot, vgroup_validmap, lock_flags);
  }
}
 
#if 0 /* UNUSED */
static bool has_unselected_unlocked_bone_group(int defbase_tot,
                                               bool *defbase_sel,
                                               int selected,
                                               const bool *lock_flags,
                                               const bool *vgroup_validmap)
{
  int i;
  if (defbase_tot == selected) {
    return false;
  }
  for (i = 0; i < defbase_tot; i++) {
    if (vgroup_validmap[i] && !defbase_sel[i] && !lock_flags[i]) {
      return true;
    }
  }
  return false;
}
#endif
static void multipaint_clamp_change(MDeformVert *dvert,
                                    const int defbase_tot,
                                    const bool *defbase_sel,
                                    float *change_p)
{
  int i;
  MDeformWeight *dw;
  float val;
  float change = *change_p;
 
  /* verify that the change does not cause values exceeding 1 and clamp it */
  for (i = dvert->totweight, dw = dvert->dw; i != 0; i--, dw++) {
    if (dw->def_nr < defbase_tot && defbase_sel[dw->def_nr]) {
      if (dw->weight) {
        val = dw->weight * change;
        if (val > 1) {
          change = 1.0f / dw->weight;
        }
      }
    }
  }
 
  *change_p = change;
}
 
static bool multipaint_verify_change(MDeformVert *dvert,
                                     const int defbase_tot,
                                     float change,
                                     const bool *defbase_sel)
{
  int i;
  MDeformWeight *dw;
  float val;
 
  /* in case the change is reduced, you need to recheck
   * the earlier values to make sure they are not 0
   * (precision error) */
  for (i = dvert->totweight, dw = dvert->dw; i != 0; i--, dw++) {
    if (dw->def_nr < defbase_tot && defbase_sel[dw->def_nr]) {
      if (dw->weight) {
        val = dw->weight * change;
        /* the value should never reach zero while multi-painting if it
         * was nonzero beforehand */
        if (val <= 0) {
          return false;
        }
      }
    }
  }
 
  return true;
}
 
static void multipaint_apply_change(MDeformVert *dvert,
                                    const int defbase_tot,
                                    float change,
                                    const bool *defbase_sel)
{
  int i;
  MDeformWeight *dw;
 
  for (i = dvert->totweight, dw = dvert->dw; i != 0; i--, dw++) {
    if (dw->def_nr < defbase_tot && defbase_sel[dw->def_nr]) {
      if (dw->weight) {
        dw->weight = dw->weight * change;
        CLAMP(dw->weight, 0.0f, 1.0f);
      }
    }
  }
}
 
static void do_weight_paint_vertex_single(const VPaint &wp,
                                          Object &ob,
                                          const WeightPaintInfo &wpi,
                                          const uint index,
                                          float alpha,
                                          float paintweight)
{
  Mesh *mesh = (Mesh *)ob.data;
  MDeformVert *dv = &wpi.dvert[index];
  bool topology = (mesh->editflag & ME_EDIT_MIRROR_TOPO) != 0;
 
  MDeformWeight *dw;
  float weight_prev, weight_cur;
  float dw_rel_locked = 0.0f, dw_rel_free = 1.0f;
 
  int index_mirr;
  int vgroup_mirr;
 
  MDeformVert *dv_mirr;
  MDeformWeight *dw_mirr;
 
  /* Check if we should mirror vertex groups (X-axis). */
  if (ME_USING_MIRROR_X_VERTEX_GROUPS(mesh)) {
    index_mirr = mesh_get_x_mirror_vert(&ob, nullptr, index, topology);
    vgroup_mirr = wpi.mirror.index;
 
    /* another possible error - mirror group _and_ active group are the same (which is fine),
     * but we also are painting onto a center vertex - this would paint the same weight twice */
    if (index_mirr == index && vgroup_mirr == wpi.active.index) {
      index_mirr = vgroup_mirr = -1;
    }
  }
  else {
    index_mirr = vgroup_mirr = -1;
  }
 
  /* Check if painting should create new deform weight entries. */
  bool restrict_to_existing = (wp.flag & VP_FLAG_VGROUP_RESTRICT) != 0;
 
  if (wpi.do_lock_relative || wpi.do_auto_normalize) {
    /* Without do_lock_relative only dw_rel_locked is reliable, while dw_rel_free may be fake 0. */
    dw_rel_free = BKE_defvert_total_selected_weight(dv, wpi.defbase_tot, wpi.vgroup_unlocked);
    dw_rel_locked = BKE_defvert_total_selected_weight(dv, wpi.defbase_tot, wpi.vgroup_locked);
    CLAMP(dw_rel_locked, 0.0f, 1.0f);
 
    /* Do not create entries if there is not enough free weight to paint.
     * This logic is the same as in wpaint_undo_lock_relative and auto-normalize. */
    if (wpi.do_auto_normalize || dw_rel_free <= 0.0f) {
      if (dw_rel_locked >= 1.0f - VERTEX_WEIGHT_LOCK_EPSILON) {
        restrict_to_existing = true;
      }
    }
  }
 
  if (restrict_to_existing) {
    dw = BKE_defvert_find_index(dv, wpi.active.index);
  }
  else {
    dw = BKE_defvert_ensure_index(dv, wpi.active.index);
  }
 
  if (dw == nullptr) {
    return;
  }
 
  if (index_mirr != -1) {
    dv_mirr = &wpi.dvert[index_mirr];
    if (wp.flag & VP_FLAG_VGROUP_RESTRICT) {
      dw_mirr = BKE_defvert_find_index(dv_mirr, vgroup_mirr);
 
      if (dw_mirr == nullptr) {
        index_mirr = vgroup_mirr = -1;
        dv_mirr = nullptr;
      }
    }
    else {
      if (index != index_mirr) {
        dw_mirr = BKE_defvert_ensure_index(dv_mirr, vgroup_mirr);
      }
      else {
        /* dv and dv_mirr are the same */
        int totweight_prev = dv_mirr->totweight;
        int dw_offset = int(dw - dv_mirr->dw);
        dw_mirr = BKE_defvert_ensure_index(dv_mirr, vgroup_mirr);
 
        /* if we added another, get our old one back */
        if (totweight_prev != dv_mirr->totweight) {
          dw = &dv_mirr->dw[dw_offset];
        }
      }
    }
  }
  else {
    dv_mirr = nullptr;
    dw_mirr = nullptr;
  }
 
  weight_cur = dw->weight;
 
  /* Handle weight caught up in locked defgroups for Lock Relative. */
  if (wpi.do_lock_relative) {
    weight_cur = BKE_defvert_calc_lock_relative_weight(weight_cur, dw_rel_locked, dw_rel_free);
  }
 
  if (!vwpaint::brush_use_accumulate(wp)) {
    MDeformVert *dvert_prev = ob.sculpt->mode.wpaint.dvert_prev.data();
    MDeformVert *dv_prev = defweight_prev_init(dvert_prev, wpi.dvert.data(), index);
    if (index_mirr != -1) {
      defweight_prev_init(dvert_prev, wpi.dvert.data(), index_mirr);
    }
 
    weight_prev = BKE_defvert_find_weight(dv_prev, wpi.active.index);
 
    if (wpi.do_lock_relative) {
      weight_prev = BKE_defvert_lock_relative_weight(
          weight_prev, dv_prev, wpi.defbase_tot, wpi.vgroup_locked, wpi.vgroup_unlocked);
    }
  }
  else {
    weight_prev = weight_cur;
  }
 
  /* If there are no normalize-locks or multipaint,
   * then there is no need to run the more complicated checks */
 
  {
    float new_weight = wpaint_blend(
        wp, weight_prev, alpha, paintweight, wpi.brush_alpha_value, wpi.do_flip);
 
    float weight = wpaint_clamp_monotonic(weight_prev, weight_cur, new_weight);
 
    /* Undo the lock relative weight correction. */
    if (wpi.do_lock_relative) {
      if (index_mirr == index) {
        /* When painting a center vertex with X Mirror and L/R pair,
         * handle both groups together. This avoids weird fighting
         * in the non-normalized weight mode. */
        float orig_weight = dw->weight + dw_mirr->weight;
        weight = 0.5f *
                 wpaint_undo_lock_relative(
                     weight * 2, orig_weight, dw_rel_locked, dw_rel_free, wpi.do_auto_normalize);
      }
      else {
        weight = wpaint_undo_lock_relative(
            weight, dw->weight, dw_rel_locked, dw_rel_free, wpi.do_auto_normalize);
      }
 
      CLAMP(weight, 0.0f, 1.0f);
    }
 
    dw->weight = weight;
 
    /* WATCH IT: take care of the ordering of applying mirror -> normalize,
     * can give wrong results #26193, least confusing if normalize is done last */
 
    if (index_mirr != -1) {
      dw_mirr->weight = dw->weight;
    }
 
    if (wpi.do_auto_normalize) {
      /* note on normalize - this used to be applied after painting and normalize all weights,
       * in some ways this is good because there is feedback where the more weights involved would
       * 'resist' so you couldn't instantly zero out other weights by painting 1.0 on the active.
       *
       * However this gave a problem since applying mirror, then normalize both verts
       * the resulting weight won't match on both sides.
       *
       * If this 'resisting', slower normalize is nicer, we could call
       * do_weight_paint_normalize_all() and only use...
       * do_weight_paint_normalize_all_active() when normalizing the mirror vertex.
       * - campbell
       */
      do_weight_paint_normalize_all_locked_try_active(
          dv, wpi.defbase_tot, wpi.vgroup_validmap, wpi.lock_flags, wpi.active.lock);
 
      if (index_mirr != -1) {
        /* only normalize if this is not a center vertex,
         * else we get a conflict, normalizing twice */
        if (index != index_mirr) {
          do_weight_paint_normalize_all_locked_try_active(
              dv_mirr, wpi.defbase_tot, wpi.vgroup_validmap, wpi.lock_flags, wpi.mirror.lock);
        }
        else {
          /* This case accounts for:
           * - Painting onto a center vertex of a mesh.
           * - X-mirror is enabled.
           * - Auto normalize is enabled.
           * - The group you are painting onto has a L / R version.
           *
           * We want L/R vgroups to have the same weight but this can't be if both are over 0.5,
           * We _could_ have special check for that, but this would need its own
           * normalize function which holds 2 groups from changing at once.
           *
           * So! just balance out the 2 weights, it keeps them equal and everything normalized.
           *
           * While it won't hit the desired weight immediately as the user waggles their mouse,
           * constant painting and re-normalizing will get there. this is also just simpler logic.
           * - campbell */
          dw_mirr->weight = dw->weight = (dw_mirr->weight + dw->weight) * 0.5f;
        }
      }
    }
  }
}
 
static void do_weight_paint_vertex_multi(const VPaint &wp,
                                         Object &ob,
                                         const WeightPaintInfo &wpi,
                                         const uint index,
                                         float alpha,
                                         float paintweight)
{
  Mesh *mesh = (Mesh *)ob.data;
  MDeformVert *dv = &wpi.dvert[index];
  bool topology = (mesh->editflag & ME_EDIT_MIRROR_TOPO) != 0;
 
  int index_mirr = -1;
  MDeformVert *dv_mirr = nullptr;
 
  float curw, curw_real, oldw, neww, change, curw_mirr, change_mirr;
  float dw_rel_free, dw_rel_locked;
 
  /* Check if we should mirror vertex groups (X-axis). */
  if (ME_USING_MIRROR_X_VERTEX_GROUPS(mesh)) {
    index_mirr = mesh_get_x_mirror_vert(&ob, nullptr, index, topology);
 
    if (!ELEM(index_mirr, -1, index)) {
      dv_mirr = &wpi.dvert[index_mirr];
    }
    else {
      index_mirr = -1;
    }
  }
 
  /* compute weight change by applying the brush to average or sum of group weights */
  curw = curw_real = BKE_defvert_multipaint_collective_weight(
      dv, wpi.defbase_tot, wpi.defbase_sel, wpi.defbase_tot_sel, wpi.is_normalized);
 
  if (curw == 0.0f) {
    /* NOTE: no weight to assign to this vertex, could add all groups? */
    return;
  }
 
  /* Handle weight caught up in locked defgroups for Lock Relative. */
  if (wpi.do_lock_relative) {
    dw_rel_free = BKE_defvert_total_selected_weight(dv, wpi.defbase_tot, wpi.vgroup_unlocked);
    dw_rel_locked = BKE_defvert_total_selected_weight(dv, wpi.defbase_tot, wpi.vgroup_locked);
    CLAMP(dw_rel_locked, 0.0f, 1.0f);
 
    curw = BKE_defvert_calc_lock_relative_weight(curw, dw_rel_locked, dw_rel_free);
  }
 
  if (!vwpaint::brush_use_accumulate(wp)) {
    MDeformVert *dvert_prev = ob.sculpt->mode.wpaint.dvert_prev.data();
    MDeformVert *dv_prev = defweight_prev_init(dvert_prev, wpi.dvert.data(), index);
    if (index_mirr != -1) {
      defweight_prev_init(dvert_prev, wpi.dvert.data(), index_mirr);
    }
 
    oldw = BKE_defvert_multipaint_collective_weight(
        dv_prev, wpi.defbase_tot, wpi.defbase_sel, wpi.defbase_tot_sel, wpi.is_normalized);
 
    if (wpi.do_lock_relative) {
      oldw = BKE_defvert_lock_relative_weight(
          oldw, dv_prev, wpi.defbase_tot, wpi.vgroup_locked, wpi.vgroup_unlocked);
    }
  }
  else {
    oldw = curw;
  }
 
  neww = wpaint_blend(wp, oldw, alpha, paintweight, wpi.brush_alpha_value, wpi.do_flip);
  neww = wpaint_clamp_monotonic(oldw, curw, neww);
 
  if (wpi.do_lock_relative) {
    neww = wpaint_undo_lock_relative(
        neww, curw_real, dw_rel_locked, dw_rel_free, wpi.do_auto_normalize);
  }
 
  change = neww / curw_real;
 
  /* verify for all groups that 0 < result <= 1 */
  multipaint_clamp_change(dv, wpi.defbase_tot, wpi.defbase_sel, &change);
 
  if (dv_mirr != nullptr) {
    curw_mirr = BKE_defvert_multipaint_collective_weight(
        dv_mirr, wpi.defbase_tot, wpi.defbase_sel, wpi.defbase_tot_sel, wpi.is_normalized);
 
    if (curw_mirr == 0.0f) {
      /* can't mirror into a zero weight vertex */
      dv_mirr = nullptr;
    }
    else {
      /* mirror is changed to achieve the same collective weight value */
      float orig = change_mirr = curw_real * change / curw_mirr;
 
      multipaint_clamp_change(dv_mirr, wpi.defbase_tot, wpi.defbase_sel, &change_mirr);
 
      if (!multipaint_verify_change(dv_mirr, wpi.defbase_tot, change_mirr, wpi.defbase_sel)) {
        return;
      }
 
      change *= change_mirr / orig;
    }
  }
 
  if (!multipaint_verify_change(dv, wpi.defbase_tot, change, wpi.defbase_sel)) {
    return;
  }
 
  /* apply validated change to vertex and mirror */
  multipaint_apply_change(dv, wpi.defbase_tot, change, wpi.defbase_sel);
 
  if (dv_mirr != nullptr) {
    multipaint_apply_change(dv_mirr, wpi.defbase_tot, change_mirr, wpi.defbase_sel);
  }
 
  if (wpi.do_auto_normalize) {
    do_weight_paint_normalize_all_locked_try_active(
        dv, wpi.defbase_tot, wpi.vgroup_validmap, wpi.lock_flags, wpi.active.lock);
 
    if (dv_mirr != nullptr) {
      do_weight_paint_normalize_all_locked_try_active(
          dv_mirr, wpi.defbase_tot, wpi.vgroup_validmap, wpi.lock_flags, wpi.active.lock);
    }
  }
}
 
static void do_weight_paint_vertex(const VPaint &wp,
                                   Object &ob,
                                   const WeightPaintInfo &wpi,
                                   const uint index,
                                   float alpha,
                                   float paintweight)
{
  if (wpi.do_multipaint) {
    do_weight_paint_vertex_multi(wp, ob, wpi, index, alpha, paintweight);
  }
  else {
    do_weight_paint_vertex_single(wp, ob, wpi, index, alpha, paintweight);
  }
}
 
static bool wpaint_stroke_test_start(bContext *C, wmOperator *op, const float mouse[2])
{
  Scene &scene = *CTX_data_scene(C);
  PaintStroke &stroke = *(PaintStroke *)op->customdata;
  ToolSettings &ts = *scene.toolsettings;
  Object &ob = *CTX_data_active_object(C);
  Mesh &mesh = *BKE_mesh_from_object(&ob);
  WPaintVGroupIndex vgroup_index;
  int defbase_tot, defbase_tot_sel;
  bool *defbase_sel;
  SculptSession &ss = *ob.sculpt;
  VPaint &vp = *CTX_data_tool_settings(C)->wpaint;
  Depsgraph &depsgraph = *CTX_data_ensure_evaluated_depsgraph(C);
 
  if (ED_wpaint_ensure_data(C, op->reports, WPAINT_ENSURE_MIRROR, &vgroup_index) == false) {
    return false;
  }
 
  {
    /* check if we are attempting to paint onto a locked vertex group,
     * and other options disallow it from doing anything useful */
    bDeformGroup *dg;
    dg = (bDeformGroup *)BLI_findlink(&mesh.vertex_group_names, vgroup_index.active);
    if (dg->flag & DG_LOCK_WEIGHT) {
      BKE_report(op->reports, RPT_WARNING, "Active group is locked, aborting");
      return false;
    }
    if (vgroup_index.mirror != -1) {
      dg = (bDeformGroup *)BLI_findlink(&mesh.vertex_group_names, vgroup_index.mirror);
      if (dg->flag & DG_LOCK_WEIGHT) {
        BKE_report(op->reports, RPT_WARNING, "Mirror group is locked, aborting");
        return false;
      }
    }
  }
 
  /* check that multipaint groups are unlocked */
  defbase_tot = BLI_listbase_count(&mesh.vertex_group_names);
  defbase_sel = BKE_object_defgroup_selected_get(&ob, defbase_tot, &defbase_tot_sel);
 
  if (ts.multipaint && defbase_tot_sel > 1) {
    int i;
    bDeformGroup *dg;
 
    if (ME_USING_MIRROR_X_VERTEX_GROUPS(&mesh)) {
      BKE_object_defgroup_mirror_selection(
          &ob, defbase_tot, defbase_sel, defbase_sel, &defbase_tot_sel);
    }
 
    for (i = 0; i < defbase_tot; i++) {
      if (defbase_sel[i]) {
        dg = (bDeformGroup *)BLI_findlink(&mesh.vertex_group_names, i);
        if (dg->flag & DG_LOCK_WEIGHT) {
          BKE_report(op->reports, RPT_WARNING, "Multipaint group is locked, aborting");
          MEM_freeN(defbase_sel);
          return false;
        }
      }
    }
  }
 
  std::unique_ptr<WPaintData> wpd = std::make_unique<WPaintData>();
  wpd->vc = ED_view3d_viewcontext_init(C, &depsgraph);
 
  const Brush *brush = BKE_paint_brush_for_read(&vp.paint);
  vwpaint::view_angle_limits_init(&wpd->normal_angle_precalc,
                                  brush->falloff_angle,
                                  (brush->flag & BRUSH_FRONTFACE_FALLOFF) != 0);
 
  wpd->active.index = vgroup_index.active;
  wpd->mirror.index = vgroup_index.mirror;
 
  /* multipaint */
  wpd->defbase_tot = defbase_tot;
  wpd->defbase_sel = defbase_sel;
  wpd->defbase_tot_sel = defbase_tot_sel > 1 ? defbase_tot_sel : 1;
  wpd->do_multipaint = (ts.multipaint && defbase_tot_sel > 1);
 
  /* set up auto-normalize, and generate map for detecting which
   * vgroups affect deform bones */
  wpd->lock_flags = BKE_object_defgroup_lock_flags_get(&ob, wpd->defbase_tot);
  if (ts.auto_normalize || ts.multipaint || wpd->lock_flags != nullptr || ts.wpaint_lock_relative)
  {
    wpd->vgroup_validmap = BKE_object_defgroup_validmap_get(&ob, wpd->defbase_tot);
  }
 
  /* Compute the set of all locked deform groups when Lock Relative is active. */
  if (ts.wpaint_lock_relative &&
      BKE_object_defgroup_check_lock_relative(
          wpd->lock_flags, wpd->vgroup_validmap, wpd->active.index) &&
      (!wpd->do_multipaint || BKE_object_defgroup_check_lock_relative_multi(
                                  defbase_tot, wpd->lock_flags, defbase_sel, defbase_tot_sel)))
  {
    wpd->do_lock_relative = true;
  }
 
  if (wpd->do_lock_relative || (ts.auto_normalize && wpd->lock_flags && !wpd->do_multipaint)) {
    bool *unlocked = (bool *)MEM_dupallocN(wpd->vgroup_validmap);
 
    if (wpd->lock_flags) {
      bool *locked = MEM_malloc_arrayN<bool>(wpd->defbase_tot, __func__);
      BKE_object_defgroup_split_locked_validmap(
          wpd->defbase_tot, wpd->lock_flags, wpd->vgroup_validmap, locked, unlocked);
      wpd->vgroup_locked = locked;
    }
 
    wpd->vgroup_unlocked = unlocked;
  }
 
  if (wpd->do_multipaint && ts.auto_normalize) {
    bool *tmpflags;
    tmpflags = MEM_malloc_arrayN<bool>(defbase_tot, __func__);
    if (wpd->lock_flags) {
      BLI_array_binary_or(tmpflags, wpd->defbase_sel, wpd->lock_flags, wpd->defbase_tot);
    }
    else {
      memcpy(tmpflags, wpd->defbase_sel, sizeof(*tmpflags) * wpd->defbase_tot);
    }
    wpd->active.lock = tmpflags;
  }
  else if (ts.auto_normalize) {
    bool *tmpflags;
 
    tmpflags = wpd->lock_flags ? (bool *)MEM_dupallocN(wpd->lock_flags) :
                                 MEM_calloc_arrayN<bool>(defbase_tot, __func__);
    tmpflags[wpd->active.index] = true;
    wpd->active.lock = tmpflags;
 
    tmpflags = wpd->lock_flags ? (bool *)MEM_dupallocN(wpd->lock_flags) :
                                 MEM_calloc_arrayN<bool>(defbase_tot, __func__);
    tmpflags[(wpd->mirror.index != -1) ? wpd->mirror.index : wpd->active.index] = true;
    wpd->mirror.lock = tmpflags;
  }
 
  /* If not previously created, create vertex/weight paint mode session data */
  vwpaint::init_stroke(depsgraph, ob);
  vwpaint::update_cache_invariants(C, vp, ss, op, mouse);
  vwpaint::init_session_data(ts, ob);
 
  /* Brush may have changed after initialization. */
  brush = BKE_paint_brush(&vp.paint);
  if (ELEM(brush->weight_brush_type, WPAINT_BRUSH_TYPE_SMEAR, WPAINT_BRUSH_TYPE_BLUR)) {
    wpd->precomputed_weight = MEM_malloc_arrayN<float>(mesh.verts_num, __func__);
  }
 
  if (!ob.sculpt->mode.wpaint.dvert_prev.is_empty()) {
    MDeformVert *dv = ob.sculpt->mode.wpaint.dvert_prev.data();
    for (int i = 0; i < mesh.verts_num; i++, dv++) {
      /* Use to show this isn't initialized, never apply to the mesh data. */
      dv->flag = 1;
    }
  }
 
  paint_stroke_set_mode_data(&stroke, std::move(wpd));
 
  return true;
}
 
static float wpaint_get_active_weight(const MDeformVert &dv, const WeightPaintInfo &wpi)
{
  float weight;
 
  if (wpi.do_multipaint) {
    weight = BKE_defvert_multipaint_collective_weight(
        &dv, wpi.defbase_tot, wpi.defbase_sel, wpi.defbase_tot_sel, wpi.is_normalized);
  }
  else {
    weight = BKE_defvert_find_weight(&dv, wpi.active.index);
  }
 
  if (wpi.do_lock_relative) {
    weight = BKE_defvert_lock_relative_weight(
        weight, &dv, wpi.defbase_tot, wpi.vgroup_locked, wpi.vgroup_unlocked);
  }
 
  CLAMP(weight, 0.0f, 1.0f);
  return weight;
}
 
static void precompute_weight_values(
    Object &ob, const Brush &brush, WPaintData &wpd, WeightPaintInfo &wpi, Mesh &mesh)
{
  using namespace blender;
  if (wpd.precomputed_weight_ready &&
      !vwpaint::brush_use_accumulate_ex(brush, eObjectMode(ob.mode)))
  {
    return;
  }
 
  threading::parallel_for(IndexRange(mesh.verts_num), 512, [&](const IndexRange range) {
    for (const int i : range) {
      const MDeformVert &dv = wpi.dvert[i];
      wpd.precomputed_weight[i] = wpaint_get_active_weight(dv, wpi);
    }
  });
 
  wpd.precomputed_weight_ready = true;
}
 
/* -------------------------------------------------------------------- */
 
static void parallel_nodes_loop_with_mirror_check(const Mesh &mesh,
                                                  const IndexMask &node_mask,
                                                  FunctionRef<void(IndexRange)> fn)
{
  /* NOTE: current mirroring code cannot be run in parallel */
  if (ME_USING_MIRROR_X_VERTEX_GROUPS(&mesh)) {
    fn(node_mask.index_range());
  }
  else {
    threading::parallel_for(
        node_mask.index_range(), 1, [&](const IndexRange range) { fn(range); });
  }
}
 
static void filter_factors_with_selection(const Span<bool> select_vert,
                                          const Span<int> verts,
                                          const MutableSpan<float> factors)
{
  BLI_assert(verts.size() == factors.size());
 
  for (const int i : verts.index_range()) {
    if (!select_vert[verts[i]]) {
      factors[i] = 0.0f;
    }
  }
}
 
static void do_wpaint_brush_blur(const Depsgraph &depsgraph,
                                 const Scene &scene,
                                 Object &ob,
                                 const Brush &brush,
                                 VPaint &vp,
                                 WPaintData &wpd,
                                 const WeightPaintInfo &wpi,
                                 Mesh &mesh,
                                 const IndexMask &node_mask)
{
  using namespace blender;
  SculptSession &ss = *ob.sculpt;
  MutableSpan<bke::pbvh::MeshNode> nodes = bke::object::pbvh_get(ob)->nodes<bke::pbvh::MeshNode>();
  const StrokeCache &cache = *ss.cache;
  const GroupedSpan<int> vert_to_face = mesh.vert_to_face_map();
 
  float brush_size_pressure, brush_alpha_value, brush_alpha_pressure;
  vwpaint::get_brush_alpha_data(
      scene, ss, brush, &brush_size_pressure, &brush_alpha_value, &brush_alpha_pressure);
  const bool use_normal = vwpaint::use_normal(vp);
  const bool use_face_sel = (mesh.editflag & ME_EDIT_PAINT_FACE_SEL) != 0;
  const bool use_vert_sel = (mesh.editflag & ME_EDIT_PAINT_VERT_SEL) != 0;
 
  const float *sculpt_normal_frontface = SCULPT_brush_frontface_normal_from_falloff_shape(
      ss, brush.falloff_shape);
 
  const Span<float3> vert_positions = bke::pbvh::vert_positions_eval(depsgraph, ob);
  const OffsetIndices faces = mesh.faces();
  const Span<int> corner_verts = mesh.corner_verts();
  const Span<float3> vert_normals = bke::pbvh::vert_normals_eval(depsgraph, ob);
  const bke::AttributeAccessor attributes = mesh.attributes();
  const VArraySpan hide_vert = *attributes.lookup<bool>(".hide_vert", bke::AttrDomain::Point);
  VArraySpan<bool> select_vert;
  if (use_vert_sel || use_face_sel) {
    select_vert = *attributes.lookup<bool>(".select_vert", bke::AttrDomain::Point);
  }
 
  struct LocalData {
    Vector<float> factors;
    Vector<float> distances;
  };
  threading::EnumerableThreadSpecific<LocalData> all_tls;
  parallel_nodes_loop_with_mirror_check(mesh, node_mask, [&](const IndexRange range) {
    LocalData &tls = all_tls.local();
    node_mask.slice(range).foreach_index([&](const int i) {
      const Span<int> verts = nodes[i].verts();
      tls.factors.resize(verts.size());
      const MutableSpan<float> factors = tls.factors;
      fill_factor_from_hide(hide_vert, verts, factors);
      filter_region_clip_factors(ss, vert_positions, verts, factors);
      if (!select_vert.is_empty()) {
        filter_factors_with_selection(select_vert, verts, factors);
      }
 
      tls.distances.resize(verts.size());
      const MutableSpan<float> distances = tls.distances;
      calc_brush_distances(
          ss, vert_positions, verts, eBrushFalloffShape(brush.falloff_shape), distances);
      filter_distances_with_radius(cache.radius, distances, factors);
      calc_brush_strength_factors(cache, brush, distances, factors);
 
      for (const int i : verts.index_range()) {
        const int vert = verts[i];
        if (factors[i] == 0.0f) {
          continue;
        }
 
        /* Get the average face weight */
        int total_hit_loops = 0;
        float weight_final = 0.0f;
        for (const int face : vert_to_face[vert]) {
          total_hit_loops += faces[face].size();
          for (const int vert : corner_verts.slice(faces[face])) {
            weight_final += wpd.precomputed_weight[vert];
          }
        }
 
        if (total_hit_loops == 0) {
          continue;
        }
 
        float brush_strength = cache.bstrength;
        const float angle_cos = use_normal ?
                                    dot_v3v3(sculpt_normal_frontface, vert_normals[vert]) :
                                    1.0f;
        if (!vwpaint::test_brush_angle_falloff(
                brush, wpd.normal_angle_precalc, angle_cos, &brush_strength))
        {
          continue;
        }
 
        const float final_alpha = factors[i] * brush_strength * brush_alpha_pressure;
 
        if ((brush.flag & BRUSH_ACCUMULATE) == 0) {
          if (ss.mode.wpaint.alpha_weight[vert] < final_alpha) {
            ss.mode.wpaint.alpha_weight[vert] = final_alpha;
          }
          else {
            continue;
          }
        }
 
        weight_final /= total_hit_loops;
        do_weight_paint_vertex(vp, ob, wpi, vert, final_alpha, weight_final);
      }
    });
  });
}
 
static void do_wpaint_brush_smear(const Depsgraph &depsgraph,
                                  const Scene &scene,
                                  Object &ob,
                                  const Brush &brush,
                                  VPaint &vp,
                                  WPaintData &wpd,
                                  const WeightPaintInfo &wpi,
                                  Mesh &mesh,
                                  const IndexMask &node_mask)
{
  using namespace blender;
  SculptSession &ss = *ob.sculpt;
  MutableSpan<bke::pbvh::MeshNode> nodes = bke::object::pbvh_get(ob)->nodes<bke::pbvh::MeshNode>();
  const GroupedSpan<int> vert_to_face = mesh.vert_to_face_map();
  const StrokeCache &cache = *ss.cache;
  if (!cache.is_last_valid) {
    return;
  }
 
  float brush_size_pressure, brush_alpha_value, brush_alpha_pressure;
  vwpaint::get_brush_alpha_data(
      scene, ss, brush, &brush_size_pressure, &brush_alpha_value, &brush_alpha_pressure);
  const bool use_normal = vwpaint::use_normal(vp);
  const bool use_face_sel = (mesh.editflag & ME_EDIT_PAINT_FACE_SEL) != 0;
  const bool use_vert_sel = (mesh.editflag & ME_EDIT_PAINT_VERT_SEL) != 0;
  float brush_dir[3];
 
  sub_v3_v3v3(brush_dir, cache.location_symm, cache.last_location_symm);
  project_plane_v3_v3v3(brush_dir, brush_dir, cache.view_normal_symm);
  if (normalize_v3(brush_dir) == 0.0f) {
    return;
  }
 
  const Span<float3> vert_positions = bke::pbvh::vert_positions_eval(depsgraph, ob);
  const OffsetIndices faces = mesh.faces();
  const Span<int> corner_verts = mesh.corner_verts();
  const Span<float3> vert_normals = bke::pbvh::vert_normals_eval(depsgraph, ob);
  const bke::AttributeAccessor attributes = mesh.attributes();
  const VArraySpan hide_vert = *attributes.lookup<bool>(".hide_vert", bke::AttrDomain::Point);
  VArraySpan<bool> select_vert;
  if (use_vert_sel || use_face_sel) {
    select_vert = *attributes.lookup<bool>(".select_vert", bke::AttrDomain::Point);
  }
 
  const float *sculpt_normal_frontface = SCULPT_brush_frontface_normal_from_falloff_shape(
      ss, brush.falloff_shape);
 
  struct LocalData {
    Vector<float> factors;
    Vector<float> distances;
  };
  threading::EnumerableThreadSpecific<LocalData> all_tls;
  parallel_nodes_loop_with_mirror_check(mesh, node_mask, [&](const IndexRange range) {
    LocalData &tls = all_tls.local();
    node_mask.slice(range).foreach_index([&](const int i) {
      const Span<int> verts = nodes[i].verts();
      tls.factors.resize(verts.size());
      const MutableSpan<float> factors = tls.factors;
      fill_factor_from_hide(hide_vert, verts, factors);
      filter_region_clip_factors(ss, vert_positions, verts, factors);
      if (!select_vert.is_empty()) {
        filter_factors_with_selection(select_vert, verts, factors);
      }
 
      tls.distances.resize(verts.size());
      const MutableSpan<float> distances = tls.distances;
      calc_brush_distances(
          ss, vert_positions, verts, eBrushFalloffShape(brush.falloff_shape), distances);
      filter_distances_with_radius(cache.radius, distances, factors);
      calc_brush_strength_factors(cache, brush, distances, factors);
 
      for (const int i : verts.index_range()) {
        const int vert = verts[i];
        if (factors[i] == 0.0f) {
          continue;
        }
 
        float brush_strength = cache.bstrength;
        const float angle_cos = use_normal ?
                                    dot_v3v3(sculpt_normal_frontface, vert_normals[vert]) :
                                    1.0f;
        if (!vwpaint::test_brush_angle_falloff(
                brush, wpd.normal_angle_precalc, angle_cos, &brush_strength))
        {
          continue;
        }
 
        bool do_color = false;
        /* Minimum dot product between brush direction and current
         * to neighbor direction is 0.0, meaning orthogonal. */
        float stroke_dot_max = 0.0f;
 
        /* Get the color of the loop in the opposite direction of the brush movement
         * (this callback is specifically for smear.) */
        float weight_final = 0.0;
        for (const int face : vert_to_face[vert]) {
          for (const int vert_other : corner_verts.slice(faces[face])) {
            if (vert_other == vert) {
              continue;
            }
 
            /* Get the direction from the selected vert to the neighbor. */
            float other_dir[3];
            sub_v3_v3v3(other_dir, vert_positions[vert], vert_positions[vert_other]);
            project_plane_v3_v3v3(other_dir, other_dir, cache.view_normal_symm);
 
            normalize_v3(other_dir);
 
            const float stroke_dot = dot_v3v3(other_dir, brush_dir);
 
            if (stroke_dot > stroke_dot_max) {
              stroke_dot_max = stroke_dot;
              weight_final = wpd.precomputed_weight[vert_other];
              do_color = true;
            }
          }
          if (!do_color) {
            continue;
          }
          const float final_alpha = factors[i] * brush_strength * brush_alpha_pressure;
          do_weight_paint_vertex(vp, ob, wpi, vert, final_alpha, weight_final);
        }
      }
    });
  });
}
 
static void do_wpaint_brush_draw(const Depsgraph &depsgraph,
                                 const Scene &scene,
                                 Object &ob,
                                 const Brush &brush,
                                 VPaint &vp,
                                 WPaintData &wpd,
                                 const WeightPaintInfo &wpi,
                                 Mesh &mesh,
                                 const float strength,
                                 const IndexMask &node_mask)
{
  using namespace blender;
  SculptSession &ss = *ob.sculpt;
  MutableSpan<bke::pbvh::MeshNode> nodes = bke::object::pbvh_get(ob)->nodes<bke::pbvh::MeshNode>();
 
  const StrokeCache &cache = *ss.cache;
  /* NOTE: normally `BKE_brush_weight_get(scene, brush)` is used,
   * however in this case we calculate a new weight each time. */
  const float paintweight = strength;
  float brush_size_pressure, brush_alpha_value, brush_alpha_pressure;
  vwpaint::get_brush_alpha_data(
      scene, ss, brush, &brush_size_pressure, &brush_alpha_value, &brush_alpha_pressure);
  const bool use_normal = vwpaint::use_normal(vp);
  const bool use_face_sel = (mesh.editflag & ME_EDIT_PAINT_FACE_SEL) != 0;
  const bool use_vert_sel = (mesh.editflag & ME_EDIT_PAINT_VERT_SEL) != 0;
 
  const float *sculpt_normal_frontface = SCULPT_brush_frontface_normal_from_falloff_shape(
      ss, brush.falloff_shape);
 
  const Span<float3> vert_positions = bke::pbvh::vert_positions_eval(depsgraph, ob);
  const Span<float3> vert_normals = bke::pbvh::vert_normals_eval(depsgraph, ob);
  const bke::AttributeAccessor attributes = mesh.attributes();
  const VArraySpan hide_vert = *attributes.lookup<bool>(".hide_vert", bke::AttrDomain::Point);
  VArraySpan<bool> select_vert;
  if (use_vert_sel || use_face_sel) {
    select_vert = *attributes.lookup<bool>(".select_vert", bke::AttrDomain::Point);
  }
 
  struct LocalData {
    Vector<float> factors;
    Vector<float> distances;
  };
  threading::EnumerableThreadSpecific<LocalData> all_tls;
  parallel_nodes_loop_with_mirror_check(mesh, node_mask, [&](const IndexRange range) {
    LocalData &tls = all_tls.local();
    node_mask.slice(range).foreach_index([&](const int i) {
      const Span<int> verts = nodes[i].verts();
      tls.factors.resize(verts.size());
      const MutableSpan<float> factors = tls.factors;
      fill_factor_from_hide(hide_vert, verts, factors);
      filter_region_clip_factors(ss, vert_positions, verts, factors);
      if (!select_vert.is_empty()) {
        filter_factors_with_selection(select_vert, verts, factors);
      }
 
      tls.distances.resize(verts.size());
      const MutableSpan<float> distances = tls.distances;
      calc_brush_distances(
          ss, vert_positions, verts, eBrushFalloffShape(brush.falloff_shape), distances);
      filter_distances_with_radius(cache.radius, distances, factors);
      calc_brush_strength_factors(cache, brush, distances, factors);
 
      for (const int i : verts.index_range()) {
        const int vert = verts[i];
        if (factors[i] == 0.0f) {
          continue;
        }
        float brush_strength = cache.bstrength;
        const float angle_cos = use_normal ?
                                    dot_v3v3(sculpt_normal_frontface, vert_normals[vert]) :
                                    1.0f;
        if (!vwpaint::test_brush_angle_falloff(
                brush, wpd.normal_angle_precalc, angle_cos, &brush_strength))
        {
          continue;
        }
        const float final_alpha = factors[i] * brush_strength * brush_alpha_pressure;
 
        if ((brush.flag & BRUSH_ACCUMULATE) == 0) {
          if (ss.mode.wpaint.alpha_weight[vert] < final_alpha) {
            ss.mode.wpaint.alpha_weight[vert] = final_alpha;
          }
          else {
            continue;
          }
        }
 
        do_weight_paint_vertex(vp, ob, wpi, vert, final_alpha, paintweight);
      }
    });
  });
}
 
static float calculate_average_weight(const Depsgraph &depsgraph,
                                      Object &ob,
                                      const Mesh &mesh,
                                      const Brush &brush,
                                      const VPaint &vp,
                                      WeightPaintInfo &wpi,
                                      const IndexMask &node_mask)
{
  using namespace blender;
  SculptSession &ss = *ob.sculpt;
  MutableSpan<bke::pbvh::MeshNode> nodes = bke::object::pbvh_get(ob)->nodes<bke::pbvh::MeshNode>();
  const StrokeCache &cache = *ss.cache;
 
  const bool use_normal = vwpaint::use_normal(vp);
  const bool use_face_sel = (mesh.editflag & ME_EDIT_PAINT_FACE_SEL) != 0;
  const bool use_vert_sel = (mesh.editflag & ME_EDIT_PAINT_VERT_SEL) != 0;
 
  const float *sculpt_normal_frontface = SCULPT_brush_frontface_normal_from_falloff_shape(
      ss, brush.falloff_shape);
 
  const Span<float3> vert_positions = bke::pbvh::vert_positions_eval(depsgraph, ob);
  const Span<float3> vert_normals = bke::pbvh::vert_normals_eval(depsgraph, ob);
  const bke::AttributeAccessor attributes = mesh.attributes();
  const VArraySpan hide_vert = *attributes.lookup<bool>(".hide_vert", bke::AttrDomain::Point);
  VArraySpan<bool> select_vert;
  if (use_vert_sel || use_face_sel) {
    select_vert = *attributes.lookup<bool>(".select_vert", bke::AttrDomain::Point);
  }
 
  struct LocalData {
    Vector<float> factors;
    Vector<float> distances;
  };
  threading::EnumerableThreadSpecific<LocalData> all_tls;
  const WPaintAverageAccum value = threading::parallel_reduce(
      node_mask.index_range(),
      1,
      WPaintAverageAccum{},
      [&](const IndexRange range, WPaintAverageAccum accum) {
        LocalData &tls = all_tls.local();
        node_mask.slice(range).foreach_index([&](const int i) {
          const Span<int> verts = nodes[i].verts();
          tls.factors.resize(verts.size());
          const MutableSpan<float> factors = tls.factors;
          fill_factor_from_hide(hide_vert, verts, factors);
          filter_region_clip_factors(ss, vert_positions, verts, factors);
          if (!select_vert.is_empty()) {
            filter_factors_with_selection(select_vert, verts, factors);
          }
 
          tls.distances.resize(verts.size());
          const MutableSpan<float> distances = tls.distances;
          calc_brush_distances(
              ss, vert_positions, verts, eBrushFalloffShape(brush.falloff_shape), distances);
          filter_distances_with_radius(cache.radius, distances, factors);
          calc_brush_strength_factors(cache, brush, distances, factors);
 
          for (const int i : verts.index_range()) {
            const int vert = verts[i];
            if (factors[i] == 0.0f) {
              continue;
            }
            const float angle_cos = use_normal ?
                                        dot_v3v3(sculpt_normal_frontface, vert_normals[vert]) :
                                        1.0f;
            if (angle_cos <= 0.0f) {
              continue;
            }
            const MDeformVert &dv = wpi.dvert[vert];
            accum.len++;
            accum.value += wpaint_get_active_weight(dv, wpi);
          }
        });
        return accum;
      },
      [](const WPaintAverageAccum &a, const WPaintAverageAccum &b) {
        return WPaintAverageAccum{a.len + b.len, a.value + b.value};
      });
  return math::safe_divide(value.value, double(value.len));
}
 
static void wpaint_paint_leaves(bContext *C,
                                Object &ob,
                                VPaint &vp,
                                WPaintData &wpd,
                                WeightPaintInfo &wpi,
                                Mesh &mesh,
                                const IndexMask &node_mask)
{
  const Scene &scene = *CTX_data_scene(C);
  const Brush &brush = *ob.sculpt->cache->brush;
  const Depsgraph &depsgraph = *CTX_data_depsgraph_pointer(C);
 
  switch ((eBrushWeightPaintType)brush.weight_brush_type) {
    case WPAINT_BRUSH_TYPE_AVERAGE: {
      do_wpaint_brush_draw(
          depsgraph,
          scene,
          ob,
          brush,
          vp,
          wpd,
          wpi,
          mesh,
          calculate_average_weight(depsgraph, ob, mesh, brush, vp, wpi, node_mask),
          node_mask);
      break;
    }
    case WPAINT_BRUSH_TYPE_SMEAR:
      do_wpaint_brush_smear(depsgraph, scene, ob, brush, vp, wpd, wpi, mesh, node_mask);
      break;
    case WPAINT_BRUSH_TYPE_BLUR:
      do_wpaint_brush_blur(depsgraph, scene, ob, brush, vp, wpd, wpi, mesh, node_mask);
      break;
    case WPAINT_BRUSH_TYPE_DRAW:
      do_wpaint_brush_draw(depsgraph,
                           scene,
                           ob,
                           brush,
                           vp,
                           wpd,
                           wpi,
                           mesh,
                           BKE_brush_weight_get(&scene, &brush),
                           node_mask);
      break;
  }
}

 
/* -------------------------------------------------------------------- */
 
void ED_object_wpaintmode_enter_ex(Main &bmain, Depsgraph &depsgraph, Scene &scene, Object &ob)
{
  vwpaint::mode_enter_generic(bmain, depsgraph, scene, ob, OB_MODE_WEIGHT_PAINT);
}
void ED_object_wpaintmode_enter(bContext *C, Depsgraph &depsgraph)
{
  Main &bmain = *CTX_data_main(C);
  Scene &scene = *CTX_data_scene(C);
  Object &ob = *CTX_data_active_object(C);
  ED_object_wpaintmode_enter_ex(bmain, depsgraph, scene, ob);
}

 
/* -------------------------------------------------------------------- */
 
void ED_object_wpaintmode_exit_ex(Object &ob)
{
  vwpaint::mode_exit_generic(ob, OB_MODE_WEIGHT_PAINT);
}
void ED_object_wpaintmode_exit(bContext *C)
{
  Object *ob = CTX_data_active_object(C);
  ED_object_wpaintmode_exit_ex(*ob);
}

 
/* -------------------------------------------------------------------- */
 
bool weight_paint_mode_poll(bContext *C)
{
  const Object *ob = CTX_data_active_object(C);
 
  return ob && ob->mode == OB_MODE_WEIGHT_PAINT && ((const Mesh *)ob->data)->faces_num;
}
 
bool weight_paint_mode_region_view3d_poll(bContext *C)
{
  return weight_paint_mode_poll(C) && ED_operator_region_view3d_active(C);
}
 
static bool weight_paint_poll_ex(bContext *C, bool check_tool)
{
  const Object *ob = CTX_data_active_object(C);
  const ScrArea *area;
 
  if ((ob != nullptr) && (ob->mode & OB_MODE_WEIGHT_PAINT) &&
      (BKE_paint_brush(&CTX_data_tool_settings(C)->wpaint->paint) != nullptr) &&
      (area = CTX_wm_area(C)) && (area->spacetype == SPACE_VIEW3D))
  {
    const ARegion *region = CTX_wm_region(C);
    if (region && ELEM(region->regiontype, RGN_TYPE_WINDOW, RGN_TYPE_HUD)) {
      if (!check_tool || WM_toolsystem_active_tool_is_brush(C)) {
        return true;
      }
    }
  }
  return false;
}
 
bool weight_paint_poll(bContext *C)
{
  return weight_paint_poll_ex(C, true);
}
 
bool weight_paint_poll_ignore_tool(bContext *C)
{
  return weight_paint_poll_ex(C, false);
}

static wmOperatorStatus wpaint_mode_toggle_exec(bContext *C, wmOperator *op)
{
  Main &bmain = *CTX_data_main(C);
  wmMsgBus *mbus = CTX_wm_message_bus(C);
  Object &ob = *CTX_data_active_object(C);
  const int mode_flag = OB_MODE_WEIGHT_PAINT;
  const bool is_mode_set = (ob.mode & mode_flag) != 0;
  Scene &scene = *CTX_data_scene(C);
  ToolSettings &ts = *scene.toolsettings;
 
  if (!is_mode_set) {
    if (!blender::ed::object::mode_compat_set(C, &ob, (eObjectMode)mode_flag, op->reports)) {
      return OPERATOR_CANCELLED;
    }
  }
 
  Mesh *mesh = BKE_mesh_from_object(&ob);
 
  if (is_mode_set) {
    ED_object_wpaintmode_exit_ex(ob);
  }
  else {
    Depsgraph *depsgraph = CTX_data_depsgraph_on_load(C);
    if (depsgraph) {
      depsgraph = CTX_data_ensure_evaluated_depsgraph(C);
    }
    ED_object_wpaintmode_enter_ex(bmain, *depsgraph, scene, ob);
    BKE_paint_brushes_validate(&bmain, &ts.wpaint->paint);
  }
 
  blender::ed::object::posemode_set_for_weight_paint(C, &bmain, &ob, is_mode_set);
 
  /* Weight-paint works by overriding colors in mesh,
   * so need to make sure we recalculate on enter and
   * exit (exit needs doing regardless because we
   * should re-deform).
   */
  DEG_id_tag_update(&mesh->id, 0);
 
  WM_event_add_notifier(C, NC_SCENE | ND_MODE, &scene);
 
  WM_msg_publish_rna_prop(mbus, &ob.id, &ob, Object, mode);
 
  WM_toolsystem_update_from_context_view3d(C);
 
  return OPERATOR_FINISHED;
}
 
void PAINT_OT_weight_paint_toggle(wmOperatorType *ot)
{
  ot->name = "Weight Paint Mode";
  ot->idname = "PAINT_OT_weight_paint_toggle";
  ot->description = "Toggle weight paint mode in 3D view";
 
  ot->exec = wpaint_mode_toggle_exec;
  ot->poll = vwpaint::mode_toggle_poll_test;
 
  ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
}


 
static void wpaint_do_paint(bContext *C,
                            Object &ob,
                            VPaint &wp,
                            WPaintData &wpd,
                            WeightPaintInfo &wpi,
                            Mesh &mesh,
                            Brush &brush,
                            const ePaintSymmetryFlags symm,
                            const int axis,
                            const int i,
                            const float angle)
{
  const Depsgraph &depsgraph = *CTX_data_depsgraph_pointer(C);
  SculptSession &ss = *ob.sculpt;
  ss.cache->radial_symmetry_pass = i;
  SCULPT_cache_calc_brushdata_symm(*ss.cache, symm, axis, angle);
 
  IndexMaskMemory memory;
  const IndexMask node_mask = vwpaint::pbvh_gather_generic(depsgraph, ob, wp, brush, memory);
 
  wpaint_paint_leaves(C, ob, wp, wpd, wpi, mesh, node_mask);
}
 
static void wpaint_do_radial_symmetry(bContext *C,
                                      Object &ob,
                                      VPaint &wp,
                                      WPaintData &wpd,
                                      WeightPaintInfo &wpi,
                                      Mesh &mesh,
                                      Brush &brush,
                                      const ePaintSymmetryFlags symm,
                                      const int axis)
{
  for (int i = 1; i < wp.radial_symm[axis - 'X']; i++) {
    const float angle = (2.0 * M_PI) * i / wp.radial_symm[axis - 'X'];
    wpaint_do_paint(C, ob, wp, wpd, wpi, mesh, brush, symm, axis, i, angle);
  }
}
 
/* near duplicate of: sculpt.cc's,
 * 'do_symmetrical_brush_actions' and 'vpaint_do_symmetrical_brush_actions'. */
static void wpaint_do_symmetrical_brush_actions(
    bContext *C, Object &ob, VPaint &wp, WPaintData &wpd, WeightPaintInfo &wpi)
{
  Brush &brush = *BKE_paint_brush(&wp.paint);
  Mesh &mesh = *(Mesh *)ob.data;
  SculptSession &ss = *ob.sculpt;
  StrokeCache &cache = *ss.cache;
  const char symm = SCULPT_mesh_symmetry_xyz_get(ob);
  int i = 0;
 
  /* initial stroke */
  cache.mirror_symmetry_pass = ePaintSymmetryFlags(0);
  wpaint_do_paint(C, ob, wp, wpd, wpi, mesh, brush, ePaintSymmetryFlags(0), 'X', 0, 0);
  wpaint_do_radial_symmetry(C, ob, wp, wpd, wpi, mesh, brush, ePaintSymmetryFlags(0), 'X');
  wpaint_do_radial_symmetry(C, ob, wp, wpd, wpi, mesh, brush, ePaintSymmetryFlags(0), 'Y');
  wpaint_do_radial_symmetry(C, ob, wp, wpd, wpi, mesh, brush, ePaintSymmetryFlags(0), 'Z');
 
  cache.symmetry = symm;
 
  if (mesh.editflag & ME_EDIT_MIRROR_VERTEX_GROUPS) {
    /* We don't do any symmetry strokes when mirroring vertex groups. */
    copy_v3_v3(cache.last_location, cache.location);
    cache.is_last_valid = true;
    return;
  }
 
  for (i = 1; i <= symm; i++) {
    if (is_symmetry_iteration_valid(i, symm)) {
      const ePaintSymmetryFlags symm = ePaintSymmetryFlags(i);
      cache.mirror_symmetry_pass = symm;
      cache.radial_symmetry_pass = 0;
      SCULPT_cache_calc_brushdata_symm(cache, symm, 0, 0);
 
      if (i & (1 << 0)) {
        wpaint_do_paint(C, ob, wp, wpd, wpi, mesh, brush, symm, 'X', 0, 0);
        wpaint_do_radial_symmetry(C, ob, wp, wpd, wpi, mesh, brush, symm, 'X');
      }
      if (i & (1 << 1)) {
        wpaint_do_paint(C, ob, wp, wpd, wpi, mesh, brush, symm, 'Y', 0, 0);
        wpaint_do_radial_symmetry(C, ob, wp, wpd, wpi, mesh, brush, symm, 'Y');
      }
      if (i & (1 << 2)) {
        wpaint_do_paint(C, ob, wp, wpd, wpi, mesh, brush, symm, 'Z', 0, 0);
        wpaint_do_radial_symmetry(C, ob, wp, wpd, wpi, mesh, brush, symm, 'Z');
      }
    }
  }
  copy_v3_v3(cache.last_location, cache.location);
  cache.is_last_valid = true;
}
 
static void wpaint_stroke_update_step(bContext *C,
                                      wmOperator *op,
                                      PaintStroke *stroke,
                                      PointerRNA *itemptr)
{
  Scene &scene = *CTX_data_scene(C);
  ToolSettings &ts = *CTX_data_tool_settings(C);
  VPaint &wp = *ts.wpaint;
  const Brush &brush = *BKE_paint_brush(&wp.paint);
  WPaintData *wpd = (WPaintData *)paint_stroke_mode_data(stroke);
  ViewContext *vc;
  Object *ob = CTX_data_active_object(C);
 
  SculptSession &ss = *ob->sculpt;
 
  vwpaint::update_cache_variants(C, wp, *ob, itemptr);
 
  float mat[4][4];
 
  const float brush_alpha_value = BKE_brush_alpha_get(&scene, &brush);
 
  /* intentionally don't initialize as nullptr, make sure we initialize all members below */
  WeightPaintInfo wpi;
 
  if (wpd == nullptr) {
    /* XXX: force a redraw here, since even though we can't paint,
     * at least view won't freeze until stroke ends */
    ED_region_tag_redraw(CTX_wm_region(C));
    return;
  }
 
  vc = &wpd->vc;
  ob = vc->obact;
 
  view3d_operator_needs_gpu(C);
  ED_view3d_init_mats_rv3d(ob, vc->rv3d);
 
  mul_m4_m4m4(mat, vc->rv3d->persmat, ob->object_to_world().ptr());
 
  Mesh &mesh = *static_cast<Mesh *>(ob->data);
 
  /* *** setup WeightPaintInfo - pass onto do_weight_paint_vertex *** */
  wpi.dvert = mesh.deform_verts_for_write();
 
  wpi.defbase_tot = wpd->defbase_tot;
  wpi.defbase_sel = wpd->defbase_sel;
  wpi.defbase_tot_sel = wpd->defbase_tot_sel;
 
  wpi.defbase_tot_unsel = wpi.defbase_tot - wpi.defbase_tot_sel;
  wpi.active = wpd->active;
  wpi.mirror = wpd->mirror;
  wpi.lock_flags = wpd->lock_flags;
  wpi.vgroup_validmap = wpd->vgroup_validmap;
  wpi.vgroup_locked = wpd->vgroup_locked;
  wpi.vgroup_unlocked = wpd->vgroup_unlocked;
  wpi.do_flip = RNA_boolean_get(op->ptr, "pen_flip") || ss.cache->invert;
  wpi.do_multipaint = wpd->do_multipaint;
  wpi.do_auto_normalize = ((ts.auto_normalize != 0) && (wpi.vgroup_validmap != nullptr) &&
                           (wpi.do_multipaint || wpi.vgroup_validmap[wpi.active.index]));
  wpi.do_lock_relative = wpd->do_lock_relative;
  wpi.is_normalized = wpi.do_auto_normalize || wpi.do_lock_relative;
  wpi.brush_alpha_value = brush_alpha_value;
 
  if (wpd->precomputed_weight) {
    precompute_weight_values(*ob, brush, *wpd, wpi, mesh);
  }
 
  wpaint_do_symmetrical_brush_actions(C, *ob, wp, *wpd, wpi);
 
  swap_m4m4(vc->rv3d->persmat, mat);
 
  /* Calculate pivot for rotation around selection if needed.
   * also needed for "Frame Selected" on last stroke. */
  float loc_world[3];
  mul_v3_m4v3(loc_world, ob->object_to_world().ptr(), ss.cache->location);
  vwpaint::last_stroke_update(scene, loc_world);
 
  BKE_mesh_batch_cache_dirty_tag(&mesh, BKE_MESH_BATCH_DIRTY_ALL);
 
  DEG_id_tag_update(&mesh.id, 0);
  WM_event_add_notifier(C, NC_OBJECT | ND_DRAW, ob);
  swap_m4m4(wpd->vc.rv3d->persmat, mat);
 
  ED_region_tag_redraw(vc->region);
}
 
static void wpaint_stroke_done(const bContext *C, PaintStroke * /*stroke*/)
{
  Object &ob = *CTX_data_active_object(C);
 
  SculptSession &ss = *ob.sculpt;
 
  if (ss.cache->alt_smooth) {
    ToolSettings &ts = *CTX_data_tool_settings(C);
    VPaint &vp = *ts.wpaint;
    vwpaint::smooth_brush_toggle_off(C, &vp.paint, ss.cache);
  }
 
  if (ob.particlesystem.first) {
    LISTBASE_FOREACH (ParticleSystem *, psys, &ob.particlesystem) {
      for (int i = 0; i < PSYS_TOT_VG; i++) {
        if (psys->vgroup[i] == BKE_object_defgroup_active_index_get(&ob)) {
          psys->recalc |= ID_RECALC_PSYS_RESET;
          break;
        }
      }
    }
  }
 
  DEG_id_tag_update((ID *)ob.data, 0);
 
  WM_event_add_notifier(C, NC_OBJECT | ND_DRAW, &ob);
 
  MEM_delete(ob.sculpt->cache);
  ob.sculpt->cache = nullptr;
}
 
static wmOperatorStatus wpaint_invoke(bContext *C, wmOperator *op, const wmEvent *event)
{
  op->customdata = paint_stroke_new(C,
                                    op,
                                    stroke_get_location_bvh,
                                    wpaint_stroke_test_start,
                                    wpaint_stroke_update_step,
                                    nullptr,
                                    wpaint_stroke_done,
                                    event->type);
 
  const wmOperatorStatus retval = op->type->modal(C, op, event);
  OPERATOR_RETVAL_CHECK(retval);
 
  if (retval == OPERATOR_FINISHED) {
    paint_stroke_free(C, op, (PaintStroke *)op->customdata);
    return OPERATOR_FINISHED;
  }
  WM_event_add_modal_handler(C, op);
 
  BLI_assert(retval == OPERATOR_RUNNING_MODAL);
 
  return OPERATOR_RUNNING_MODAL;
}
 
static wmOperatorStatus wpaint_exec(bContext *C, wmOperator *op)
{
  op->customdata = paint_stroke_new(C,
                                    op,
                                    stroke_get_location_bvh,
                                    wpaint_stroke_test_start,
                                    wpaint_stroke_update_step,
                                    nullptr,
                                    wpaint_stroke_done,
                                    0);
 
  paint_stroke_exec(C, op, (PaintStroke *)op->customdata);
 
  return OPERATOR_FINISHED;
}
 
static void wpaint_cancel(bContext *C, wmOperator *op)
{
  Object &ob = *CTX_data_active_object(C);
  MEM_delete(ob.sculpt->cache);
  ob.sculpt->cache = nullptr;
 
  paint_stroke_cancel(C, op, (PaintStroke *)op->customdata);
}
 
static wmOperatorStatus wpaint_modal(bContext *C, wmOperator *op, const wmEvent *event)
{
  return paint_stroke_modal(C, op, event, (PaintStroke **)&op->customdata);
}
 
void PAINT_OT_weight_paint(wmOperatorType *ot)
{
  ot->name = "Weight Paint";
  ot->idname = "PAINT_OT_weight_paint";
  ot->description = "Paint a stroke in the current vertex group's weights";
 
  ot->invoke = wpaint_invoke;
  ot->modal = wpaint_modal;
  ot->exec = wpaint_exec;
  ot->poll = weight_paint_poll;
  ot->cancel = wpaint_cancel;
 
  ot->flag = OPTYPE_UNDO | OPTYPE_BLOCKING;
 
  paint_stroke_operator_properties(ot);
  PropertyRNA *prop = RNA_def_boolean(
      ot->srna,
      "override_location",
      false,
      "Override Location",
      "Override the given `location` array by recalculating object space positions from the "
      "provided `mouse_event` positions");
  RNA_def_property_flag(prop, PROP_HIDDEN | PROP_SKIP_SAVE);
}