MOD_weightvgedit.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_utildefines.h"
#include "BLI_math.h"
#include "BLI_string.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"

/**************************************
 * Modifiers functions.               *
 **************************************/
static void initData(ModifierData *md)
{
    WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;
    wmd->edit_flags             = 0;
    wmd->falloff_type           = MOD_WVG_MAPPING_NONE;
    wmd->default_weight         = 0.0f;

    wmd->cmap_curve             = curvemapping_add(1, 0.0, 0.0, 1.0, 1.0);
    curvemapping_initialize(wmd->cmap_curve);

    wmd->rem_threshold          = 0.01f;
    wmd->add_threshold          = 0.01f;

    wmd->mask_constant          = 1.0f;
    wmd->mask_tex_use_channel   = MOD_WVG_MASK_TEX_USE_INT; /* Use intensity by default. */
    wmd->mask_tex_mapping       = MOD_DISP_MAP_LOCAL;
}

static void freeData(ModifierData *md)
{
    WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;
    curvemapping_free(wmd->cmap_curve);
}

static void copyData(ModifierData *md, ModifierData *target)
{
    WeightVGEditModifierData *wmd  = (WeightVGEditModifierData*) md;
    WeightVGEditModifierData *twmd = (WeightVGEditModifierData*) target;

    BLI_strncpy(twmd->defgrp_name, wmd->defgrp_name, sizeof(twmd->defgrp_name));

    twmd->edit_flags             = wmd->edit_flags;
    twmd->falloff_type           = wmd->falloff_type;
    twmd->default_weight         = wmd->default_weight;

    twmd->cmap_curve             = curvemapping_copy(wmd->cmap_curve);

    twmd->add_threshold          = wmd->add_threshold;
    twmd->rem_threshold          = wmd->rem_threshold;

    twmd->mask_constant          = wmd->mask_constant;
    BLI_strncpy(twmd->mask_defgrp_name, wmd->mask_defgrp_name, sizeof(twmd->mask_defgrp_name));
    twmd->mask_texture           = wmd->mask_texture;
    twmd->mask_tex_use_channel   = wmd->mask_tex_use_channel;
    twmd->mask_tex_mapping       = wmd->mask_tex_mapping;
    twmd->mask_tex_map_obj       = wmd->mask_tex_map_obj;
    BLI_strncpy(twmd->mask_tex_uvlayer_name, wmd->mask_tex_uvlayer_name, sizeof(twmd->mask_tex_uvlayer_name));
}

static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
{
    WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;
    CustomDataMask dataMask = 0;

    /* We need vertex groups! */
    dataMask |= CD_MASK_MDEFORMVERT;

    /* Ask for UV coordinates if we need them. */
    if(wmd->mask_tex_mapping == MOD_DISP_MAP_UV)
        dataMask |= CD_MASK_MTFACE;

    return dataMask;
}

static int dependsOnTime(ModifierData *md)
{
    WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;

    if(wmd->mask_texture)
        return BKE_texture_dependsOnTime(wmd->mask_texture);
    return 0;
}

static void foreachObjectLink(ModifierData *md, Object *ob,
                              void (*walk)(void *userData, Object *ob, Object **obpoin),
                              void *userData)
{
    WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;
    walk(userData, ob, &wmd->mask_tex_map_obj);
}

static void foreachIDLink(ModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
{
    WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;

    walk(userData, ob, (ID **)&wmd->mask_texture);

    foreachObjectLink(md, ob, (ObjectWalkFunc)walk, userData);
}

static void foreachTexLink(ModifierData *md, Object *ob, TexWalkFunc walk, void *userData)
{
    walk(userData, ob, md, "mask_texture");
}

static void updateDepgraph(ModifierData *md, DagForest *forest, struct Scene *UNUSED(scene),
                           Object *UNUSED(ob), DagNode *obNode)
{
    WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;
    DagNode *curNode;

    if(wmd->mask_tex_map_obj && wmd->mask_tex_mapping == MOD_DISP_MAP_OBJECT) {
        curNode = dag_get_node(forest, wmd->mask_tex_map_obj);

        dag_add_relation(forest, curNode, obNode, DAG_RL_DATA_DATA|DAG_RL_OB_DATA,
                         "WeightVGEdit Modifier");
    }

    if(wmd->mask_tex_mapping == MOD_DISP_MAP_GLOBAL)
        dag_add_relation(forest, obNode, obNode, DAG_RL_DATA_DATA|DAG_RL_OB_DATA,
                         "WeightVGEdit Modifier");
}

static int isDisabled(ModifierData *md, int UNUSED(useRenderParams))
{
    WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;
    /* If no vertex group, bypass. */
    return (wmd->defgrp_name[0] == '\0');
}

static DerivedMesh *applyModifier(ModifierData *md, Object *ob, DerivedMesh *derivedData,
                                  int UNUSED(useRenderParams), int UNUSED(isFinalCalc))
{
    WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;
    DerivedMesh *dm = derivedData;
    MDeformVert *dvert = NULL;
    MDeformWeight **dw = NULL;
    float *org_w; /* Array original weights. */
    float *new_w; /* Array new weights. */
    int numVerts;
    int defgrp_idx;
    int i;
    /* Flags. */
    int do_add = (wmd->edit_flags & MOD_WVG_EDIT_ADD2VG) != 0;
    int do_rem = (wmd->edit_flags & MOD_WVG_EDIT_REMFVG) != 0;

    /* Get number of verts. */
    numVerts = dm->getNumVerts(dm);

    /* Check if we can just return the original mesh.
     * Must have verts and therefore verts assigned to vgroups to do anything useful!
     */
    if ((numVerts == 0) || (ob->defbase.first == NULL))
        return dm;

    /* Get vgroup idx from its name. */
    defgrp_idx = defgroup_name_index(ob, wmd->defgrp_name);
    if (defgrp_idx < 0)
        return dm;

    dvert = CustomData_duplicate_referenced_layer(&dm->vertData, CD_MDEFORMVERT, numVerts);

    /* Get org weights, assuming 0.0 for vertices not in given vgroup. */
    org_w = MEM_mallocN(sizeof(float) * numVerts, "WeightVGEdit Modifier, org_w");
    new_w = MEM_mallocN(sizeof(float) * numVerts, "WeightVGEdit Modifier, new_w");
    dw = MEM_mallocN(sizeof(MDeformWeight*) * numVerts, "WeightVGEdit Modifier, dw");
    for (i = 0; i < numVerts; i++) {
        dw[i] = defvert_find_index(&dvert[i], defgrp_idx);
        if(dw[i]) {
            org_w[i] = new_w[i] = dw[i]->weight;
        }
        else {
            org_w[i] = new_w[i] = wmd->default_weight;
        }
    }

    /* Do mapping. */
    if (wmd->falloff_type != MOD_WVG_MAPPING_NONE) {
        weightvg_do_map(numVerts, new_w, wmd->falloff_type, wmd->cmap_curve);
    }

    /* Do masking. */
    weightvg_do_mask(numVerts, NULL, org_w, new_w, ob, dm, wmd->mask_constant,
                     wmd->mask_defgrp_name, wmd->mask_texture, wmd->mask_tex_use_channel,
                     wmd->mask_tex_mapping, wmd->mask_tex_map_obj, wmd->mask_tex_uvlayer_name);

    /* Update/add/remove from vgroup. */
    weightvg_update_vg(dvert, defgrp_idx, dw, numVerts, NULL, org_w, do_add, wmd->add_threshold,
                       do_rem, wmd->rem_threshold);

    /* Freeing stuff. */
    MEM_freeN(org_w);
    MEM_freeN(new_w);
    MEM_freeN(dw);

    /* Return the vgroup-modified mesh. */
    return dm;
}

static DerivedMesh *applyModifierEM(ModifierData *md, Object *ob,
                                    struct EditMesh *UNUSED(editData),
                                    DerivedMesh *derivedData)
{
    return applyModifier(md, ob, derivedData, 0, 1);
}


ModifierTypeInfo modifierType_WeightVGEdit = {
    /* name */              "VertexWeightEdit",
    /* structName */        "WeightVGEditModifierData",
    /* structSize */        sizeof(WeightVGEditModifierData),
    /* type */              eModifierTypeType_NonGeometrical,
    /* flags */             eModifierTypeFlag_AcceptsMesh
/*                         |eModifierTypeFlag_SupportsMapping*/
                           |eModifierTypeFlag_SupportsEditmode,

    /* copyData */          copyData,
    /* deformVerts */       NULL,
    /* deformMatrices */    NULL,
    /* deformVertsEM */     NULL,
    /* deformMatricesEM */  NULL,
    /* applyModifier */     applyModifier,
    /* applyModifierEM */   applyModifierEM,
    /* initData */          initData,
    /* requiredDataMask */  requiredDataMask,
    /* freeData */          freeData,
    /* isDisabled */        isDisabled,
    /* updateDepgraph */    updateDepgraph,
    /* dependsOnTime */     dependsOnTime,
    /* dependsOnNormals */  NULL,
    /* foreachObjectLink */ foreachObjectLink,
    /* foreachIDLink */     foreachIDLink,
    /* foreachTexLink */    foreachTexLink,
};