MOD_weightvg_util.c

Go to the documentation of this file.

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * 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) 2011 by Bastien Montagne.
 * All rights reserved.
 *
 * Contributor(s): None yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 *
 */

#include "BLI_math.h"
#include "BLI_rand.h"
#include "BLI_string.h"
#include "BLI_utildefines.h"

#include "DNA_color_types.h"      /* CurveMapping. */
#include "DNA_mesh_types.h"
#include "DNA_meshdata_types.h"
#include "DNA_modifier_types.h"
#include "DNA_object_types.h"

#include "BKE_cdderivedmesh.h"
#include "BKE_colortools.h"       /* CurveMapping. */
#include "BKE_deform.h"
#include "BKE_mesh.h"
#include "BKE_modifier.h"
#include "BKE_texture.h"          /* Texture masking. */

#include "depsgraph_private.h"
#include "MEM_guardedalloc.h"
#include "MOD_util.h"
#include "MOD_weightvg_util.h"
#include "RE_shader_ext.h"        /* Texture masking. */

/* Maps new_w weights in place, using either one of the predifined functions, or a custom curve.
 * Return values are in new_w.
 * If indices is not NULL, it must be a table of same length as org_w and new_w, mapping to the real
 * vertex index (in case the weight tables do not cover the whole vertices...).
 * cmap might be NULL, in which case curve mapping mode will return unmodified data.
 */
void weightvg_do_map(int num, float *new_w, short falloff_type, CurveMapping *cmap)
{
    int i;

    /* Return immediately, if we have nothing to do! */
    /* Also security checks... */
    if(((falloff_type == MOD_WVG_MAPPING_CURVE) && (cmap == NULL))
            || !ELEM7(falloff_type, MOD_WVG_MAPPING_CURVE, MOD_WVG_MAPPING_SHARP, MOD_WVG_MAPPING_SMOOTH,
                      MOD_WVG_MAPPING_ROOT, MOD_WVG_MAPPING_SPHERE, MOD_WVG_MAPPING_RANDOM,
                      MOD_WVG_MAPPING_STEP))
        return;

    /* Map each weight (vertex) to its new value, accordingly to the chosen mode. */
    for(i = 0; i < num; ++i) {
        float fac = new_w[i];

        /* Code borrowed from the warp modifier. */
        /* Closely matches PROP_SMOOTH and similar. */
        switch(falloff_type) {
        case MOD_WVG_MAPPING_CURVE:
            fac = curvemapping_evaluateF(cmap, 0, fac);
            break;
        case MOD_WVG_MAPPING_SHARP:
            fac = fac*fac;
            break;
        case MOD_WVG_MAPPING_SMOOTH:
            fac = 3.0f*fac*fac - 2.0f*fac*fac*fac;
            break;
        case MOD_WVG_MAPPING_ROOT:
            fac = (float)sqrt(fac);
            break;
        case MOD_WVG_MAPPING_SPHERE:
            fac = (float)sqrt(2*fac - fac * fac);
            break;
        case MOD_WVG_MAPPING_RANDOM:
            BLI_srand(BLI_rand()); /* random seed */
            fac = BLI_frand()*fac;
            break;
        case MOD_WVG_MAPPING_STEP:
            fac = (fac >= 0.5f)?1.0f:0.0f;
            break;
        }

        new_w[i] = fac;
    }
}

/* Applies new_w weights to org_w ones, using either a texture, vgroup or constant value as factor.
 * Return values are in org_w.
 * If indices is not NULL, it must be a table of same length as org_w and new_w, mapping to the real
 * vertex index (in case the weight tables do not cover the whole vertices...).
 * XXX The standard “factor” value is assumed in [0.0, 1.0] range. Else, weird results might appear.
 */
void weightvg_do_mask(int num, const int *indices, float *org_w, const float *new_w,
                      Object *ob, DerivedMesh *dm, float fact, const char defgrp_name[MAX_VGROUP_NAME],
                      Tex *texture, int tex_use_channel, int tex_mapping,
                      Object *tex_map_object, const char *tex_uvlayer_name)
{
    int ref_didx;
    int i;

    /* If influence factor is null, nothing to do! */
    if (fact == 0.0f) return;

    /* If we want to mask vgroup weights from a texture. */
    if (texture) {
        /* The texture coordinates. */
        float (*tex_co)[3];
        /* See mapping note below... */
        MappingInfoModifierData t_map;
        float (*v_co)[3];

        /* Use new generic get_texture_coords, but do not modify our DNA struct for it...
         * XXX Why use a ModifierData stuff here ? Why not a simple, generic struct for parameters ?
         *     What e.g. if a modifier wants to use several textures ?
         *     Why use only v_co, and not MVert (or both) ?
         */
        t_map.texture = texture;
        t_map.map_object = tex_map_object;
        BLI_strncpy(t_map.uvlayer_name, tex_uvlayer_name, sizeof(t_map.uvlayer_name));
        t_map.texmapping = tex_mapping;
        v_co = MEM_mallocN(sizeof(*v_co) * num, "WeightVG Modifier, TEX mode, v_co");
        dm->getVertCos(dm, v_co);
        tex_co = MEM_callocN(sizeof(*tex_co) * num, "WeightVG Modifier, TEX mode, tex_co");
        get_texture_coords(&t_map, ob, dm, v_co, tex_co, num);
        MEM_freeN(v_co);

        /* For each weight (vertex), make the mix between org and new weights. */
        for(i = 0; i < num; ++i) {
            int idx = indices ? indices[i] : i;
            TexResult texres;
            float h, s, v; /* For HSV color space. */

            texres.nor = NULL;
            get_texture_value(texture, tex_co[idx], &texres);
            /* Get the good channel value... */
            switch(tex_use_channel) {
            case MOD_WVG_MASK_TEX_USE_INT:
                org_w[i] = (new_w[i] * texres.tin * fact) + (org_w[i] * (1.0f - (texres.tin*fact)));
                break;
            case MOD_WVG_MASK_TEX_USE_RED:
                org_w[i] = (new_w[i] * texres.tr * fact) + (org_w[i] * (1.0f - (texres.tr*fact)));
                break;
            case MOD_WVG_MASK_TEX_USE_GREEN:
                org_w[i] = (new_w[i] * texres.tg * fact) + (org_w[i] * (1.0f - (texres.tg*fact)));
                break;
            case MOD_WVG_MASK_TEX_USE_BLUE:
                org_w[i] = (new_w[i] * texres.tb * fact) + (org_w[i] * (1.0f - (texres.tb*fact)));
                break;
            case MOD_WVG_MASK_TEX_USE_HUE:
                rgb_to_hsv(texres.tr, texres.tg, texres.tb, &h, &s, &v);
                org_w[i] = (new_w[i] * h * fact) + (org_w[i] * (1.0f - (h*fact)));
                break;
            case MOD_WVG_MASK_TEX_USE_SAT:
                rgb_to_hsv(texres.tr, texres.tg, texres.tb, &h, &s, &v);
                org_w[i] = (new_w[i] * s * fact) + (org_w[i] * (1.0f - (s*fact)));
                break;
            case MOD_WVG_MASK_TEX_USE_VAL:
                rgb_to_hsv(texres.tr, texres.tg, texres.tb, &h, &s, &v);
                org_w[i] = (new_w[i] * v * fact) + (org_w[i] * (1.0f - (v*fact)));
                break;
            case MOD_WVG_MASK_TEX_USE_ALPHA:
                org_w[i] = (new_w[i] * texres.ta * fact) + (org_w[i] * (1.0f - (texres.ta*fact)));
                break;
            default:
                org_w[i] = (new_w[i] * texres.tin * fact) + (org_w[i] * (1.0f - (texres.tin*fact)));
                break;
            }
        }

        MEM_freeN(tex_co);
    }
    else if ((ref_didx = defgroup_name_index(ob, defgrp_name)) != -1) {
        MDeformVert *dvert = NULL;

        /* Check whether we want to set vgroup weights from a constant weight factor or a vertex
         * group.
         */
        /* Get vgroup idx from its name. */

        /* Proceed only if vgroup is valid, else use constant factor. */
        /* Get actual dverts (ie vertex group data). */
        dvert = dm->getVertDataArray(dm, CD_MDEFORMVERT);
        /* Proceed only if vgroup is valid, else assume factor = O. */
        if (dvert == NULL) return;

        /* For each weight (vertex), make the mix between org and new weights. */
        for (i = 0; i < num; i++) {
            int idx = indices ? indices[i] : i;
            const float f = defvert_find_weight(&dvert[idx], ref_didx) * fact;
            org_w[i] = (new_w[i] * f) + (org_w[i] * (1.0f-f));
            /* If that vertex is not in ref vgroup, assume null factor, and hence do nothing! */
        }
    }
    else {
        /* Default "influence" behavior. */
        /* For each weight (vertex), make the mix between org and new weights. */
        const float ifact = 1.0f - fact;
        for (i = 0; i < num; i++) {
            org_w[i] = (new_w[i] * fact) + (org_w[i] * ifact);
        }
    }
}




/* Applies weights to given vgroup (defgroup), and optionnaly add/remove vertices from the group.
 * If dws is not NULL, it must be an array of MDeformWeight pointers of same length as weights (and
 * defgrp_idx can then have any value).
 * If indices is not NULL, it must be an array of same length as weights, mapping to the real
 * vertex index (in case the weight array does not cover the whole vertices...).
 */
void weightvg_update_vg(MDeformVert *dvert, int defgrp_idx, MDeformWeight **dws, int num,
                        const int *indices, const float *weights, int do_add,
                        float add_thresh, int do_rem, float rem_thresh)
{
    int i;

    for(i = 0; i < num; i++) {
        float w = weights[i];
        MDeformVert *dv = &dvert[indices ? indices[i] : i];
        MDeformWeight *dw = dws ? dws[i] : defvert_find_index(dv, defgrp_idx);

        /* Never allow weights out of [0.0, 1.0] range. */
        CLAMP(w, 0.0f, 1.0f);

        /* If the vertex is in this vgroup, remove it if needed, or just update it. */
        if(dw != NULL) {
            if(do_rem && w < rem_thresh) {
                defvert_remove_group(dv, dw);
            }
            else {
                dw->weight = w;
            }
        }
        /* Else, add it if needed! */
        else if(do_add && w > add_thresh) {
            defvert_add_index_notest(dv, defgrp_idx, w);
        }
    }
}