Merge branch 'master' into blender2.8
[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_ghash.h"
41
42 #include "DNA_armature_types.h"
43 #include "DNA_meshdata_types.h"
44 #include "DNA_modifier_types.h"
45 #include "DNA_object_types.h"
46
47 #include "BKE_action.h" /* BKE_pose_channel_find_name */
48 #include "BKE_cdderivedmesh.h"
49 #include "BKE_library_query.h"
50 #include "BKE_modifier.h"
51 #include "BKE_deform.h"
52
53 #include "DEG_depsgraph_build.h"
54
55 #include "BLI_strict_flags.h"
56
57 static void copyData(ModifierData *md, ModifierData *target)
58 {
59 #if 0
60         MaskModifierData *mmd = (MaskModifierData *) md;
61         MaskModifierData *tmmd = (MaskModifierData *) target;
62 #endif
63         modifier_copyData_generic(md, target);
64 }
65
66 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *UNUSED(md))
67 {
68         return CD_MASK_MDEFORMVERT;
69 }
70
71 static void foreachObjectLink(
72         ModifierData *md, Object *ob,
73         ObjectWalkFunc walk, void *userData)
74 {
75         MaskModifierData *mmd = (MaskModifierData *)md;
76         walk(userData, ob, &mmd->ob_arm, IDWALK_CB_NOP);
77 }
78
79 static void updateDepsgraph(ModifierData *md,
80                             struct Main *UNUSED(bmain),
81                             struct Scene *UNUSED(scene),
82                             Object *UNUSED(ob),
83                             struct DepsNodeHandle *node)
84 {
85         MaskModifierData *mmd = (MaskModifierData *)md;
86         if (mmd->ob_arm) {
87                 bArmature *arm = (bArmature *)mmd->ob_arm->data;
88                 /* Tag relationship in depsgraph, but also on the armature. */
89                 /* TODO(sergey): Is it a proper relation here? */
90                 DEG_add_object_relation(node, mmd->ob_arm, DEG_OB_COMP_TRANSFORM, "Mask Modifier");
91                 arm->flag |= ARM_HAS_VIZ_DEPS;
92         }
93 }
94
95 static DerivedMesh *applyModifier(ModifierData *md, Object *ob,
96                                   DerivedMesh *dm,
97                                   ModifierApplyFlag UNUSED(flag))
98 {
99         MaskModifierData *mmd = (MaskModifierData *)md;
100         const bool found_test = (mmd->flag & MOD_MASK_INV) == 0;
101         DerivedMesh *result = NULL;
102         GHash *vertHash = NULL, *edgeHash, *polyHash;
103         GHashIterator gh_iter;
104         MDeformVert *dvert, *dv;
105         int numPolys = 0, numLoops = 0, numEdges = 0, numVerts = 0;
106         int maxVerts, maxEdges, maxPolys;
107         int i;
108
109         const MVert *mvert_src;
110         const MEdge *medge_src;
111         const MPoly *mpoly_src;
112         const MLoop *mloop_src;
113
114         MPoly *mpoly_dst;
115         MLoop *mloop_dst;
116         MEdge *medge_dst;
117         MVert *mvert_dst;
118
119         int *loop_mapping;
120
121         dvert = dm->getVertDataArray(dm, CD_MDEFORMVERT);
122         if (dvert == NULL) {
123                 return found_test ? CDDM_from_template(dm, 0, 0, 0, 0, 0) : dm;
124         }
125
126         /* Overview of Method:
127          *      1. Get the vertices that are in the vertexgroup of interest 
128          *      2. Filter out unwanted geometry (i.e. not in vertexgroup), by populating mappings with new vs old indices
129          *      3. Make a new mesh containing only the mapping data
130          */
131         
132         /* get original number of verts, edges, and faces */
133         maxVerts = dm->getNumVerts(dm);
134         maxEdges = dm->getNumEdges(dm);
135         maxPolys = dm->getNumPolys(dm);
136         
137         /* check if we can just return the original mesh 
138          *      - must have verts and therefore verts assigned to vgroups to do anything useful
139          */
140         if (!(ELEM(mmd->mode, MOD_MASK_MODE_ARM, MOD_MASK_MODE_VGROUP)) ||
141             (maxVerts == 0) || BLI_listbase_is_empty(&ob->defbase))
142         {
143                 return dm;
144         }
145         
146         /* if mode is to use selected armature bones, aggregate the bone groups */
147         if (mmd->mode == MOD_MASK_MODE_ARM) { /* --- using selected bones --- */
148                 Object *oba = mmd->ob_arm;
149                 bPoseChannel *pchan;
150                 bDeformGroup *def;
151                 bool *bone_select_array;
152                 int bone_select_tot = 0;
153                 const int defbase_tot = BLI_listbase_count(&ob->defbase);
154                 
155                 /* check that there is armature object with bones to use, otherwise return original mesh */
156                 if (ELEM(NULL, oba, oba->pose, ob->defbase.first))
157                         return dm;
158                 
159                 /* determine whether each vertexgroup is associated with a selected bone or not 
160                  * - each cell is a boolean saying whether bone corresponding to the ith group is selected
161                  * - groups that don't match a bone are treated as not existing (along with the corresponding ungrouped verts)
162                  */
163                 bone_select_array = MEM_mallocN((size_t)defbase_tot * sizeof(char), "mask array");
164                 
165                 for (i = 0, def = ob->defbase.first; def; def = def->next, i++) {
166                         pchan = BKE_pose_channel_find_name(oba->pose, def->name);
167                         if (pchan && pchan->bone && (pchan->bone->flag & BONE_SELECTED)) {
168                                 bone_select_array[i] = true;
169                                 bone_select_tot++;
170                         }
171                         else {
172                                 bone_select_array[i] = false;
173                         }
174                 }
175
176                 /* verthash gives mapping from original vertex indices to the new indices (including selected matches only)
177                  * key = oldindex, value = newindex
178                  */
179                 vertHash = BLI_ghash_int_new_ex("mask vert gh", (unsigned int)maxVerts);
180                 
181                 /* add vertices which exist in vertexgroups into vertHash for filtering 
182                  * - dv = for each vertex, what vertexgroups does it belong to
183                  * - dw = weight that vertex was assigned to a vertexgroup it belongs to
184                  */
185                 for (i = 0, dv = dvert; i < maxVerts; i++, dv++) {
186                         MDeformWeight *dw = dv->dw;
187                         bool found = false;
188                         int j;
189                         
190                         /* check the groups that vertex is assigned to, and see if it was any use */
191                         for (j = 0; j < dv->totweight; j++, dw++) {
192                                 if (dw->def_nr < defbase_tot) {
193                                         if (bone_select_array[dw->def_nr]) {
194                                                 if (dw->weight != 0.0f) {
195                                                         found = true;
196                                                         break;
197                                                 }
198                                         }
199                                 }
200                         }
201                         
202                         if (found_test != found) {
203                                 continue;
204                         }
205                         
206                         /* add to ghash for verts (numVerts acts as counter for mapping) */
207                         BLI_ghash_insert(vertHash, SET_INT_IN_POINTER(i), SET_INT_IN_POINTER(numVerts));
208                         numVerts++;
209                 }
210                 
211                 /* free temp hashes */
212                 MEM_freeN(bone_select_array);
213         }
214         else {  /* --- Using Nominated VertexGroup only --- */
215                 int defgrp_index = defgroup_name_index(ob, mmd->vgroup);
216
217                 /* if no vgroup (i.e. dverts) found, return the initial mesh */
218                 if (defgrp_index == -1)
219                         return dm;
220                         
221                 /* hashes for quickly providing a mapping from old to new - use key=oldindex, value=newindex */
222                 vertHash = BLI_ghash_int_new_ex("mask vert2 bh", (unsigned int)maxVerts);
223                 
224                 /* add vertices which exist in vertexgroup into ghash for filtering */
225                 for (i = 0, dv = dvert; i < maxVerts; i++, dv++) {
226                         const bool found = defvert_find_weight(dv, defgrp_index) != 0.0f;
227                         if (found_test != found) {
228                                 continue;
229                         }
230
231                         /* add to ghash for verts (numVerts acts as counter for mapping) */
232                         BLI_ghash_insert(vertHash, SET_INT_IN_POINTER(i), SET_INT_IN_POINTER(numVerts));
233                         numVerts++;
234                 }
235         }
236
237         /* hashes for quickly providing a mapping from old to new - use key=oldindex, value=newindex */
238         edgeHash = BLI_ghash_int_new_ex("mask ed2 gh", (unsigned int)maxEdges);
239         polyHash = BLI_ghash_int_new_ex("mask fa2 gh", (unsigned int)maxPolys);
240
241         mvert_src = dm->getVertArray(dm);
242         medge_src = dm->getEdgeArray(dm);
243         mpoly_src = dm->getPolyArray(dm);
244         mloop_src = dm->getLoopArray(dm);
245
246         /* overalloc, assume all polys are seen */
247         loop_mapping = MEM_mallocN(sizeof(int) * (size_t)maxPolys, "mask loopmap");
248
249         /* loop over edges and faces, and do the same thing to 
250          * ensure that they only reference existing verts 
251          */
252         for (i = 0; i < maxEdges; i++) {
253                 const MEdge *me = &medge_src[i];
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                 const MPoly *mp_src = &mpoly_src[i];
265                 const MLoop *ml_src = &mloop_src[mp_src->loopstart];
266                 bool ok = true;
267                 int j;
268                 
269                 for (j = 0; j < mp_src->totloop; j++, ml_src++) {
270                         if (!BLI_ghash_haskey(vertHash, SET_INT_IN_POINTER(ml_src->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_src->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_dst = CDDM_get_polys(result);
292         mloop_dst = CDDM_get_loops(result);
293         medge_dst = CDDM_get_edges(result);
294         mvert_dst = CDDM_get_verts(result);
295
296         /* using ghash-iterators, map data into new mesh */
297         /* vertices */
298         GHASH_ITER (gh_iter, vertHash) {
299                 const MVert *v_src;
300                 MVert *v_dst;
301                 const int i_src = GET_INT_FROM_POINTER(BLI_ghashIterator_getKey(&gh_iter));
302                 const int i_dst = GET_INT_FROM_POINTER(BLI_ghashIterator_getValue(&gh_iter));
303                 
304                 v_src = &mvert_src[i_src];
305                 v_dst = &mvert_dst[i_dst];
306
307                 *v_dst = *v_src;
308                 DM_copy_vert_data(dm, result, i_src, i_dst, 1);
309         }
310                 
311         /* edges */
312         GHASH_ITER (gh_iter, edgeHash) {
313                 const MEdge *e_src;
314                 MEdge *e_dst;
315                 const int i_src = GET_INT_FROM_POINTER(BLI_ghashIterator_getKey(&gh_iter));
316                 const int i_dst = GET_INT_FROM_POINTER(BLI_ghashIterator_getValue(&gh_iter));
317                 
318                 e_src = &medge_src[i_src];
319                 e_dst = &medge_dst[i_dst];
320
321                 DM_copy_edge_data(dm, result, i_src, i_dst, 1);
322                 *e_dst = *e_src;
323                 e_dst->v1 = GET_UINT_FROM_POINTER(BLI_ghash_lookup(vertHash, SET_UINT_IN_POINTER(e_src->v1)));
324                 e_dst->v2 = GET_UINT_FROM_POINTER(BLI_ghash_lookup(vertHash, SET_UINT_IN_POINTER(e_src->v2)));
325         }
326         
327         /* faces */
328         GHASH_ITER (gh_iter, polyHash) {
329                 const int i_src = GET_INT_FROM_POINTER(BLI_ghashIterator_getKey(&gh_iter));
330                 const int i_dst = GET_INT_FROM_POINTER(BLI_ghashIterator_getValue(&gh_iter));
331                 const MPoly *mp_src = &mpoly_src[i_src];
332                 MPoly *mp_dst = &mpoly_dst[i_dst];
333                 const int i_ml_src = mp_src->loopstart;
334                 const int i_ml_dst = loop_mapping[i_dst];
335                 const MLoop *ml_src = &mloop_src[i_ml_src];
336                 MLoop *ml_dst = &mloop_dst[i_ml_dst];
337                 
338                 DM_copy_poly_data(dm, result, i_src, i_dst, 1);
339                 DM_copy_loop_data(dm, result, i_ml_src, i_ml_dst, mp_src->totloop);
340
341                 *mp_dst = *mp_src;
342                 mp_dst->loopstart = i_ml_dst;
343                 for (i = 0; i < mp_src->totloop; i++) {
344                         ml_dst[i].v = GET_UINT_FROM_POINTER(BLI_ghash_lookup(vertHash, SET_UINT_IN_POINTER(ml_src[i].v)));
345                         ml_dst[i].e = GET_UINT_FROM_POINTER(BLI_ghash_lookup(edgeHash, SET_UINT_IN_POINTER(ml_src[i].e)));
346                 }
347         }
348
349         MEM_freeN(loop_mapping);
350
351         /* why is this needed? - campbell */
352         /* recalculate normals */
353         result->dirty |= DM_DIRTY_NORMALS;
354         
355         /* free hashes */
356         BLI_ghash_free(vertHash, NULL, NULL);
357         BLI_ghash_free(edgeHash, NULL, NULL);
358         BLI_ghash_free(polyHash, NULL, NULL);
359
360         /* return the new mesh */
361         return result;
362 }
363
364
365 ModifierTypeInfo modifierType_Mask = {
366         /* name */              "Mask",
367         /* structName */        "MaskModifierData",
368         /* structSize */        sizeof(MaskModifierData),
369         /* type */              eModifierTypeType_Nonconstructive,
370         /* flags */             eModifierTypeFlag_AcceptsMesh |
371                                 eModifierTypeFlag_SupportsMapping |
372                                 eModifierTypeFlag_SupportsEditmode,
373
374         /* copyData */          copyData,
375         /* deformVerts */       NULL,
376         /* deformMatrices */    NULL,
377         /* deformVertsEM */     NULL,
378         /* deformMatricesEM */  NULL,
379         /* applyModifier */     applyModifier,
380         /* applyModifierEM */   NULL,
381         /* initData */          NULL,
382         /* requiredDataMask */  requiredDataMask,
383         /* freeData */          NULL,
384         /* isDisabled */        NULL,
385         /* updateDepsgraph */   updateDepsgraph,
386         /* dependsOnTime */     NULL,
387         /* dependsOnNormals */  NULL,
388         /* foreachObjectLink */ foreachObjectLink,
389         /* foreachIDLink */     NULL,
390         /* foreachTexLink */    NULL,
391 };