1d5dc29c119dbe47571b144f0472e1ed2e7d461f
[blender.git] / source / blender / modifiers / intern / MOD_mask.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software  Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2005 by the Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Daniel Dunbar
22  *                 Ton Roosendaal,
23  *                 Ben Batt,
24  *                 Brecht Van Lommel,
25  *                 Campbell Barton
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  *
29  */
30
31 /** \file blender/modifiers/intern/MOD_mask.c
32  *  \ingroup modifiers
33  */
34
35
36 #include "MEM_guardedalloc.h"
37
38 #include "BLI_utildefines.h"
39 #include "BLI_listbase.h"
40 #include "BLI_string.h"
41 #include "BLI_ghash.h"
42
43 #include "DNA_armature_types.h"
44 #include "DNA_meshdata_types.h"
45 #include "DNA_modifier_types.h"
46 #include "DNA_object_types.h"
47
48 #include "BKE_action.h" /* BKE_pose_channel_find_name */
49 #include "BKE_cdderivedmesh.h"
50 #include "BKE_mesh.h"
51 #include "BKE_modifier.h"
52 #include "BKE_deform.h"
53
54 #include "depsgraph_private.h"
55
56 #include "MOD_util.h"
57
58 static void copyData(ModifierData *md, ModifierData *target)
59 {
60 #if 0
61         MaskModifierData *mmd = (MaskModifierData *) md;
62         MaskModifierData *tmmd = (MaskModifierData *) target;
63 #endif
64         modifier_copyData_generic(md, target);
65 }
66
67 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *UNUSED(md))
68 {
69         return CD_MASK_MDEFORMVERT;
70 }
71
72 static void foreachObjectLink(
73         ModifierData *md, Object *ob,
74         void (*walk)(void *userData, Object *ob, Object **obpoin),
75         void *userData)
76 {
77         MaskModifierData *mmd = (MaskModifierData *)md;
78         walk(userData, ob, &mmd->ob_arm);
79 }
80
81 static void updateDepgraph(ModifierData *md, DagForest *forest,
82                            struct Scene *UNUSED(scene),
83                            Object *UNUSED(ob),
84                            DagNode *obNode)
85 {
86         MaskModifierData *mmd = (MaskModifierData *)md;
87
88         if (mmd->ob_arm) {
89                 bArmature *arm = (bArmature *)mmd->ob_arm->data;
90                 DagNode *armNode = dag_get_node(forest, mmd->ob_arm);
91                 
92                 /* tag relationship in depsgraph, but also on the armature */
93                 dag_add_relation(forest, armNode, obNode, DAG_RL_DATA_DATA | DAG_RL_OB_DATA, "Mask Modifier");
94                 arm->flag |= ARM_HAS_VIZ_DEPS;
95         }
96 }
97
98 static DerivedMesh *applyModifier(ModifierData *md, Object *ob,
99                                   DerivedMesh *dm,
100                                   ModifierApplyFlag UNUSED(flag))
101 {
102         MaskModifierData *mmd = (MaskModifierData *)md;
103         const bool found_test = (mmd->flag & MOD_MASK_INV) == 0;
104         DerivedMesh *result = NULL;
105         GHash *vertHash = NULL, *edgeHash, *polyHash;
106         GHashIterator *hashIter;
107         MDeformVert *dvert, *dv;
108         int numPolys = 0, numLoops = 0, numEdges = 0, numVerts = 0;
109         int maxVerts, maxEdges, maxPolys;
110         int i;
111
112         MPoly *mpoly;
113         MLoop *mloop;
114
115         MPoly *mpoly_new;
116         MLoop *mloop_new;
117         MEdge *medge_new;
118         MVert *mvert_new;
119
120
121         int *loop_mapping;
122
123         dvert = dm->getVertDataArray(dm, CD_MDEFORMVERT);
124         if (dvert == NULL) {
125                 return found_test ? CDDM_from_template(dm, 0, 0, 0, 0, 0) : dm;
126         }
127
128         /* Overview of Method:
129          *      1. Get the vertices that are in the vertexgroup of interest 
130          *      2. Filter out unwanted geometry (i.e. not in vertexgroup), by populating mappings with new vs old indices
131          *      3. Make a new mesh containing only the mapping data
132          */
133         
134         /* get original number of verts, edges, and faces */
135         maxVerts = dm->getNumVerts(dm);
136         maxEdges = dm->getNumEdges(dm);
137         maxPolys = dm->getNumPolys(dm);
138         
139         /* check if we can just return the original mesh 
140          *      - must have verts and therefore verts assigned to vgroups to do anything useful
141          */
142         if (!(ELEM(mmd->mode, MOD_MASK_MODE_ARM, MOD_MASK_MODE_VGROUP)) ||
143             (maxVerts == 0) || (ob->defbase.first == NULL) )
144         {
145                 return dm;
146         }
147         
148         /* if mode is to use selected armature bones, aggregate the bone groups */
149         if (mmd->mode == MOD_MASK_MODE_ARM) { /* --- using selected bones --- */
150                 Object *oba = mmd->ob_arm;
151                 bPoseChannel *pchan;
152                 bDeformGroup *def;
153                 char *bone_select_array;
154                 int bone_select_tot = 0;
155                 const int defbase_tot = BLI_countlist(&ob->defbase);
156                 
157                 /* check that there is armature object with bones to use, otherwise return original mesh */
158                 if (ELEM3(NULL, oba, oba->pose, ob->defbase.first))
159                         return dm;
160                 
161                 /* determine whether each vertexgroup is associated with a selected bone or not 
162                  * - each cell is a boolean saying whether bone corresponding to the ith group is selected
163                  * - groups that don't match a bone are treated as not existing (along with the corresponding ungrouped verts)
164                  */
165                 bone_select_array = MEM_mallocN(defbase_tot * sizeof(char), "mask array");
166                 
167                 for (i = 0, def = ob->defbase.first; def; def = def->next, i++) {
168                         pchan = BKE_pose_channel_find_name(oba->pose, def->name);
169                         if (pchan && pchan->bone && (pchan->bone->flag & BONE_SELECTED)) {
170                                 bone_select_array[i] = TRUE;
171                                 bone_select_tot++;
172                         }
173                         else {
174                                 bone_select_array[i] = FALSE;
175                         }
176                 }
177
178                 /* verthash gives mapping from original vertex indices to the new indices (including selected matches only)
179                  * key = oldindex, value = newindex
180                  */
181                 vertHash = BLI_ghash_int_new("mask vert gh");
182                 
183                 /* add vertices which exist in vertexgroups into vertHash for filtering 
184                  * - dv = for each vertex, what vertexgroups does it belong to
185                  * - dw = weight that vertex was assigned to a vertexgroup it belongs to
186                  */
187                 for (i = 0, dv = dvert; i < maxVerts; i++, dv++) {
188                         MDeformWeight *dw = dv->dw;
189                         bool found = false;
190                         int j;
191                         
192                         /* check the groups that vertex is assigned to, and see if it was any use */
193                         for (j = 0; j < dv->totweight; j++, dw++) {
194                                 if (dw->def_nr < defbase_tot) {
195                                         if (bone_select_array[dw->def_nr]) {
196                                                 if (dw->weight != 0.0f) {
197                                                         found = TRUE;
198                                                         break;
199                                                 }
200                                         }
201                                 }
202                         }
203                         
204                         if (found_test != found) {
205                                 continue;
206                         }
207                         
208                         /* add to ghash for verts (numVerts acts as counter for mapping) */
209                         BLI_ghash_insert(vertHash, SET_INT_IN_POINTER(i), SET_INT_IN_POINTER(numVerts));
210                         numVerts++;
211                 }
212                 
213                 /* free temp hashes */
214                 MEM_freeN(bone_select_array);
215         }
216         else {  /* --- Using Nominated VertexGroup only --- */
217                 int defgrp_index = defgroup_name_index(ob, mmd->vgroup);
218
219                 /* if no vgroup (i.e. dverts) found, return the initial mesh */
220                 if (defgrp_index == -1)
221                         return dm;
222                         
223                 /* hashes for quickly providing a mapping from old to new - use key=oldindex, value=newindex */
224                 vertHash = BLI_ghash_int_new("mask vert2 bh");
225                 
226                 /* add vertices which exist in vertexgroup into ghash for filtering */
227                 for (i = 0, dv = dvert; i < maxVerts; i++, dv++) {
228                         const bool found = defvert_find_weight(dv, defgrp_index) != 0.0f;
229                         if (found_test != found) {
230                                 continue;
231                         }
232
233                         /* add to ghash for verts (numVerts acts as counter for mapping) */
234                         BLI_ghash_insert(vertHash, SET_INT_IN_POINTER(i), SET_INT_IN_POINTER(numVerts));
235                         numVerts++;
236                 }
237         }
238
239         /* hashes for quickly providing a mapping from old to new - use key=oldindex, value=newindex */
240         edgeHash = BLI_ghash_int_new("mask ed2 gh");
241         polyHash = BLI_ghash_int_new("mask fa2 gh");
242         
243         mpoly = dm->getPolyArray(dm);
244         mloop = dm->getLoopArray(dm);
245
246         loop_mapping = MEM_callocN(sizeof(int) * maxPolys, "mask loopmap"); /* overalloc, assume all polys are seen */
247
248         /* loop over edges and faces, and do the same thing to 
249          * ensure that they only reference existing verts 
250          */
251         for (i = 0; i < maxEdges; i++) {
252                 MEdge me;
253                 dm->getEdge(dm, i, &me);
254                 
255                 /* only add if both verts will be in new mesh */
256                 if (BLI_ghash_haskey(vertHash, SET_INT_IN_POINTER(me.v1)) &&
257                     BLI_ghash_haskey(vertHash, SET_INT_IN_POINTER(me.v2)))
258                 {
259                         BLI_ghash_insert(edgeHash, SET_INT_IN_POINTER(i), SET_INT_IN_POINTER(numEdges));
260                         numEdges++;
261                 }
262         }
263         for (i = 0; i < maxPolys; i++) {
264                 MPoly *mp = &mpoly[i];
265                 MLoop *ml = mloop + mp->loopstart;
266                 int ok = TRUE;
267                 int j;
268                 
269                 for (j = 0; j < mp->totloop; j++, ml++) {
270                         if (!BLI_ghash_haskey(vertHash, SET_INT_IN_POINTER(ml->v))) {
271                                 ok = FALSE;
272                                 break;
273                         }
274                 }
275                 
276                 /* all verts must be available */
277                 if (ok) {
278                         BLI_ghash_insert(polyHash, SET_INT_IN_POINTER(i), SET_INT_IN_POINTER(numPolys));
279                         loop_mapping[numPolys] = numLoops;
280                         numPolys++;
281                         numLoops += mp->totloop;
282                 }
283         }
284         
285         
286         /* now we know the number of verts, edges and faces, 
287          * we can create the new (reduced) mesh
288          */
289         result = CDDM_from_template(dm, numVerts, numEdges, 0, numLoops, numPolys);
290         
291         mpoly_new = CDDM_get_polys(result);
292         mloop_new = CDDM_get_loops(result);
293         medge_new = CDDM_get_edges(result);
294         mvert_new = CDDM_get_verts(result);
295         
296         /* using ghash-iterators, map data into new mesh */
297         /* vertices */
298         for (hashIter = BLI_ghashIterator_new(vertHash);
299              BLI_ghashIterator_done(hashIter) == false;
300              BLI_ghashIterator_step(hashIter) )
301         {
302                 MVert source;
303                 MVert *dest;
304                 int oldIndex = GET_INT_FROM_POINTER(BLI_ghashIterator_getKey(hashIter));
305                 int newIndex = GET_INT_FROM_POINTER(BLI_ghashIterator_getValue(hashIter));
306                 
307                 dm->getVert(dm, oldIndex, &source);
308                 dest = &mvert_new[newIndex];
309                 
310                 DM_copy_vert_data(dm, result, oldIndex, newIndex, 1);
311                 *dest = source;
312         }
313         BLI_ghashIterator_free(hashIter);
314                 
315         /* edges */
316         for (hashIter = BLI_ghashIterator_new(edgeHash);
317              BLI_ghashIterator_done(hashIter) == false;
318              BLI_ghashIterator_step(hashIter))
319         {
320                 MEdge source;
321                 MEdge *dest;
322                 int oldIndex = GET_INT_FROM_POINTER(BLI_ghashIterator_getKey(hashIter));
323                 int newIndex = GET_INT_FROM_POINTER(BLI_ghashIterator_getValue(hashIter));
324                 
325                 dm->getEdge(dm, oldIndex, &source);
326                 dest = &medge_new[newIndex];
327                 
328                 source.v1 = GET_INT_FROM_POINTER(BLI_ghash_lookup(vertHash, SET_INT_IN_POINTER(source.v1)));
329                 source.v2 = GET_INT_FROM_POINTER(BLI_ghash_lookup(vertHash, SET_INT_IN_POINTER(source.v2)));
330                 
331                 DM_copy_edge_data(dm, result, oldIndex, newIndex, 1);
332                 *dest = source;
333         }
334         BLI_ghashIterator_free(hashIter);
335         
336         /* faces */
337         for (hashIter = BLI_ghashIterator_new(polyHash);
338              BLI_ghashIterator_done(hashIter) == false;
339              BLI_ghashIterator_step(hashIter) )
340         {
341                 int oldIndex = GET_INT_FROM_POINTER(BLI_ghashIterator_getKey(hashIter));
342                 int newIndex = GET_INT_FROM_POINTER(BLI_ghashIterator_getValue(hashIter));
343                 MPoly *source = &mpoly[oldIndex];
344                 MPoly *dest = &mpoly_new[newIndex];
345                 int oldLoopIndex = source->loopstart;
346                 int newLoopIndex = loop_mapping[newIndex];
347                 MLoop *source_loop = &mloop[oldLoopIndex];
348                 MLoop *dest_loop = &mloop_new[newLoopIndex];
349                 
350                 DM_copy_poly_data(dm, result, oldIndex, newIndex, 1);
351                 DM_copy_loop_data(dm, result, oldLoopIndex, newLoopIndex, source->totloop);
352
353                 *dest = *source;
354                 dest->loopstart = newLoopIndex;
355                 for (i = 0; i < source->totloop; i++) {
356                         dest_loop[i].v = GET_INT_FROM_POINTER(BLI_ghash_lookup(vertHash, SET_INT_IN_POINTER(source_loop[i].v)));
357                         dest_loop[i].e = GET_INT_FROM_POINTER(BLI_ghash_lookup(edgeHash, SET_INT_IN_POINTER(source_loop[i].e)));
358                 }
359         }
360
361         BLI_ghashIterator_free(hashIter);
362
363         MEM_freeN(loop_mapping);
364
365         /* why is this needed? - campbell */
366         /* recalculate normals */
367         result->dirty |= DM_DIRTY_NORMALS;
368         
369         /* free hashes */
370         BLI_ghash_free(vertHash, NULL, NULL);
371         BLI_ghash_free(edgeHash, NULL, NULL);
372         BLI_ghash_free(polyHash, NULL, NULL);
373
374         /* return the new mesh */
375         return result;
376 }
377
378
379 ModifierTypeInfo modifierType_Mask = {
380         /* name */              "Mask",
381         /* structName */        "MaskModifierData",
382         /* structSize */        sizeof(MaskModifierData),
383         /* type */              eModifierTypeType_Nonconstructive,
384         /* flags */             eModifierTypeFlag_AcceptsMesh |
385                                 eModifierTypeFlag_SupportsMapping |
386                                 eModifierTypeFlag_SupportsEditmode,
387
388         /* copyData */          copyData,
389         /* deformVerts */       NULL,
390         /* deformMatrices */    NULL,
391         /* deformVertsEM */     NULL,
392         /* deformMatricesEM */  NULL,
393         /* applyModifier */     applyModifier,
394         /* applyModifierEM */   NULL,
395         /* initData */          NULL,
396         /* requiredDataMask */  requiredDataMask,
397         /* freeData */          NULL,
398         /* isDisabled */        NULL,
399         /* updateDepgraph */    updateDepgraph,
400         /* dependsOnTime */     NULL,
401         /* dependsOnNormals */  NULL,
402         /* foreachObjectLink */ foreachObjectLink,
403         /* foreachIDLink */     NULL,
404         /* foreachTexLink */    NULL,
405 };