Pass EvaluationContext argument everywhere
[blender.git] / source / blender / modifiers / intern / MOD_mirror.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_mirror.c
32  *  \ingroup modifiers
33  */
34
35
36 #include "DNA_meshdata_types.h"
37 #include "DNA_object_types.h"
38
39 #include "BLI_math.h"
40
41 #include "BKE_cdderivedmesh.h"
42 #include "BKE_library_query.h"
43 #include "BKE_modifier.h"
44 #include "BKE_deform.h"
45
46 #include "MEM_guardedalloc.h"
47
48 #include "DEG_depsgraph_build.h"
49
50 static void initData(ModifierData *md)
51 {
52         MirrorModifierData *mmd = (MirrorModifierData *) md;
53
54         mmd->flag |= (MOD_MIR_AXIS_X | MOD_MIR_VGROUP);
55         mmd->tolerance = 0.001;
56         mmd->mirror_ob = NULL;
57 }
58
59 static void copyData(ModifierData *md, ModifierData *target)
60 {
61 #if 0
62         MirrorModifierData *mmd = (MirrorModifierData *) md;
63         MirrorModifierData *tmmd = (MirrorModifierData *) target;
64 #endif
65         modifier_copyData_generic(md, target);
66 }
67
68 static void foreachObjectLink(
69         ModifierData *md, Object *ob,
70         ObjectWalkFunc walk, void *userData)
71 {
72         MirrorModifierData *mmd = (MirrorModifierData *) md;
73
74         walk(userData, ob, &mmd->mirror_ob, IDWALK_CB_NOP);
75 }
76
77 static void updateDepsgraph(ModifierData *md,
78                             struct Main *UNUSED(bmain),
79                             struct Scene *UNUSED(scene),
80                             Object *ob,
81                             struct DepsNodeHandle *node)
82 {
83         MirrorModifierData *mmd = (MirrorModifierData *)md;
84         if (mmd->mirror_ob != NULL) {
85                 DEG_add_object_relation(node, mmd->mirror_ob, DEG_OB_COMP_TRANSFORM, "Mirror Modifier");
86         }
87         DEG_add_object_relation(node, ob, DEG_OB_COMP_TRANSFORM, "Mirror Modifier");
88 }
89
90 static DerivedMesh *doMirrorOnAxis(MirrorModifierData *mmd,
91                                    Object *ob,
92                                    DerivedMesh *dm,
93                                    int axis)
94 {
95         const float tolerance_sq = mmd->tolerance * mmd->tolerance;
96         const bool do_vtargetmap = (mmd->flag & MOD_MIR_NO_MERGE) == 0;
97         int tot_vtargetmap = 0;  /* total merge vertices */
98
99         DerivedMesh *result;
100         const int maxVerts = dm->getNumVerts(dm);
101         const int maxEdges = dm->getNumEdges(dm);
102         const int maxLoops = dm->getNumLoops(dm);
103         const int maxPolys = dm->getNumPolys(dm);
104         MVert *mv, *mv_prev;
105         MEdge *me;
106         MLoop *ml;
107         MPoly *mp;
108         float mtx[4][4];
109         int i;
110         int a, totshape;
111         int *vtargetmap = NULL, *vtmap_a = NULL, *vtmap_b = NULL;
112
113         /* mtx is the mirror transformation */
114         unit_m4(mtx);
115         mtx[axis][axis] = -1.0f;
116
117         if (mmd->mirror_ob) {
118                 float tmp[4][4];
119                 float itmp[4][4];
120
121                 /* tmp is a transform from coords relative to the object's own origin,
122                  * to coords relative to the mirror object origin */
123                 invert_m4_m4(tmp, mmd->mirror_ob->obmat);
124                 mul_m4_m4m4(tmp, tmp, ob->obmat);
125
126                 /* itmp is the reverse transform back to origin-relative coordinates */
127                 invert_m4_m4(itmp, tmp);
128
129                 /* combine matrices to get a single matrix that translates coordinates into
130                  * mirror-object-relative space, does the mirror, and translates back to
131                  * origin-relative space */
132                 mul_m4_m4m4(mtx, mtx, tmp);
133                 mul_m4_m4m4(mtx, itmp, mtx);
134         }
135
136         result = CDDM_from_template(dm, maxVerts * 2, maxEdges * 2, 0, maxLoops * 2, maxPolys * 2);
137
138         /*copy customdata to original geometry*/
139         DM_copy_vert_data(dm, result, 0, 0, maxVerts);
140         DM_copy_edge_data(dm, result, 0, 0, maxEdges);
141         DM_copy_loop_data(dm, result, 0, 0, maxLoops);
142         DM_copy_poly_data(dm, result, 0, 0, maxPolys);
143
144
145         /* subsurf for eg wont have mesh data in the */
146         /* now add mvert/medge/mface layers */
147
148         if (!CustomData_has_layer(&dm->vertData, CD_MVERT)) {
149                 dm->copyVertArray(dm, CDDM_get_verts(result));
150         }
151         if (!CustomData_has_layer(&dm->edgeData, CD_MEDGE)) {
152                 dm->copyEdgeArray(dm, CDDM_get_edges(result));
153         }
154         if (!CustomData_has_layer(&dm->polyData, CD_MPOLY)) {
155                 dm->copyLoopArray(dm, CDDM_get_loops(result));
156                 dm->copyPolyArray(dm, CDDM_get_polys(result));
157         }
158
159         /* copy customdata to new geometry,
160          * copy from its self because this data may have been created in the checks above */
161         DM_copy_vert_data(result, result, 0, maxVerts, maxVerts);
162         DM_copy_edge_data(result, result, 0, maxEdges, maxEdges);
163         /* loops are copied later */
164         DM_copy_poly_data(result, result, 0, maxPolys, maxPolys);
165
166         if (do_vtargetmap) {
167                 /* second half is filled with -1 */
168                 vtargetmap = MEM_mallocN(sizeof(int) * maxVerts * 2, "MOD_mirror tarmap");
169
170                 vtmap_a = vtargetmap;
171                 vtmap_b = vtargetmap + maxVerts;
172         }
173
174         /* mirror vertex coordinates */
175         mv_prev = CDDM_get_verts(result);
176         mv = mv_prev + maxVerts;
177         for (i = 0; i < maxVerts; i++, mv++, mv_prev++) {
178                 mul_m4_v3(mtx, mv->co);
179
180                 if (do_vtargetmap) {
181                         /* compare location of the original and mirrored vertex, to see if they
182                          * should be mapped for merging */
183                         if (UNLIKELY(len_squared_v3v3(mv_prev->co, mv->co) < tolerance_sq)) {
184                                 *vtmap_a = maxVerts + i;
185                                 tot_vtargetmap++;
186
187                                 /* average location */
188                                 mid_v3_v3v3(mv->co, mv_prev->co, mv->co);
189                                 copy_v3_v3(mv_prev->co, mv->co);
190                         }
191                         else {
192                                 *vtmap_a = -1;
193                         }
194
195                         *vtmap_b = -1; /* fill here to avoid 2x loops */
196
197                         vtmap_a++;
198                         vtmap_b++;
199                 }
200         }
201         
202         /* handle shape keys */
203         totshape = CustomData_number_of_layers(&result->vertData, CD_SHAPEKEY);
204         for (a = 0; a < totshape; a++) {
205                 float (*cos)[3] = CustomData_get_layer_n(&result->vertData, CD_SHAPEKEY, a);
206                 for (i = maxVerts; i < result->numVertData; i++) {
207                         mul_m4_v3(mtx, cos[i]);
208                 }
209         }
210         
211         /* adjust mirrored edge vertex indices */
212         me = CDDM_get_edges(result) + maxEdges;
213         for (i = 0; i < maxEdges; i++, me++) {
214                 me->v1 += maxVerts;
215                 me->v2 += maxVerts;
216         }
217         
218         /* adjust mirrored poly loopstart indices, and reverse loop order (normals) */
219         mp = CDDM_get_polys(result) + maxPolys;
220         ml = CDDM_get_loops(result);
221         for (i = 0; i < maxPolys; i++, mp++) {
222                 MLoop *ml2;
223                 int j, e;
224
225                 /* reverse the loop, but we keep the first vertex in the face the same,
226                  * to ensure that quads are split the same way as on the other side */
227                 DM_copy_loop_data(result, result, mp->loopstart, mp->loopstart + maxLoops, 1);
228                 for (j = 1; j < mp->totloop; j++)
229                         DM_copy_loop_data(result, result, mp->loopstart + j, mp->loopstart + maxLoops + mp->totloop - j, 1);
230
231                 ml2 = ml + mp->loopstart + maxLoops;
232                 e = ml2[0].e;
233                 for (j = 0; j < mp->totloop - 1; j++) {
234                         ml2[j].e = ml2[j + 1].e;
235                 }
236                 ml2[mp->totloop - 1].e = e;
237                 
238                 mp->loopstart += maxLoops;
239         }
240
241         /* adjust mirrored loop vertex and edge indices */
242         ml = CDDM_get_loops(result) + maxLoops;
243         for (i = 0; i < maxLoops; i++, ml++) {
244                 ml->v += maxVerts;
245                 ml->e += maxEdges;
246         }
247
248         /* handle uvs,
249          * let tessface recalc handle updating the MTFace data */
250         if (mmd->flag & (MOD_MIR_MIRROR_U | MOD_MIR_MIRROR_V)) {
251                 const bool do_mirr_u = (mmd->flag & MOD_MIR_MIRROR_U) != 0;
252                 const bool do_mirr_v = (mmd->flag & MOD_MIR_MIRROR_V) != 0;
253
254                 const int totuv = CustomData_number_of_layers(&result->loopData, CD_MLOOPUV);
255
256                 for (a = 0; a < totuv; a++) {
257                         MLoopUV *dmloopuv = CustomData_get_layer_n(&result->loopData, CD_MLOOPUV, a);
258                         int j = maxLoops;
259                         dmloopuv += j; /* second set of loops only */
260                         for (; j-- > 0; dmloopuv++) {
261                                 if (do_mirr_u) dmloopuv->uv[0] = 1.0f - dmloopuv->uv[0] + mmd->uv_offset[0];
262                                 if (do_mirr_v) dmloopuv->uv[1] = 1.0f - dmloopuv->uv[1] + mmd->uv_offset[1];
263                         }
264                 }
265         }
266
267         /* handle vgroup stuff */
268         if ((mmd->flag & MOD_MIR_VGROUP) && CustomData_has_layer(&result->vertData, CD_MDEFORMVERT)) {
269                 MDeformVert *dvert = (MDeformVert *) CustomData_get_layer(&result->vertData, CD_MDEFORMVERT) + maxVerts;
270                 int *flip_map = NULL, flip_map_len = 0;
271
272                 flip_map = defgroup_flip_map(ob, &flip_map_len, false);
273                 
274                 if (flip_map) {
275                         for (i = 0; i < maxVerts; dvert++, i++) {
276                                 /* merged vertices get both groups, others get flipped */
277                                 if (do_vtargetmap && (vtargetmap[i] != -1))
278                                         defvert_flip_merged(dvert, flip_map, flip_map_len);
279                                 else
280                                         defvert_flip(dvert, flip_map, flip_map_len);
281                         }
282
283                         MEM_freeN(flip_map);
284                 }
285         }
286
287         if (do_vtargetmap) {
288                 /* slow - so only call if one or more merge verts are found,
289                  * users may leave this on and not realize there is nothing to merge - campbell */
290                 if (tot_vtargetmap) {
291                         result = CDDM_merge_verts(result, vtargetmap, tot_vtargetmap, CDDM_MERGE_VERTS_DUMP_IF_MAPPED);
292                 }
293                 MEM_freeN(vtargetmap);
294         }
295
296         return result;
297 }
298
299 static DerivedMesh *mirrorModifier__doMirror(MirrorModifierData *mmd,
300                                              Object *ob, DerivedMesh *dm)
301 {
302         DerivedMesh *result = dm;
303
304         /* check which axes have been toggled and mirror accordingly */
305         if (mmd->flag & MOD_MIR_AXIS_X) {
306                 result = doMirrorOnAxis(mmd, ob, result, 0);
307         }
308         if (mmd->flag & MOD_MIR_AXIS_Y) {
309                 DerivedMesh *tmp = result;
310                 result = doMirrorOnAxis(mmd, ob, result, 1);
311                 if (tmp != dm) tmp->release(tmp);  /* free intermediate results */
312         }
313         if (mmd->flag & MOD_MIR_AXIS_Z) {
314                 DerivedMesh *tmp = result;
315                 result = doMirrorOnAxis(mmd, ob, result, 2);
316                 if (tmp != dm) tmp->release(tmp);  /* free intermediate results */
317         }
318
319         return result;
320 }
321
322 static DerivedMesh *applyModifier(ModifierData *md, struct EvaluationContext *UNUSED(eval_ctx),
323                                   Object *ob, DerivedMesh *derivedData,
324                                   ModifierApplyFlag UNUSED(flag))
325 {
326         DerivedMesh *result;
327         MirrorModifierData *mmd = (MirrorModifierData *) md;
328
329         result = mirrorModifier__doMirror(mmd, ob, derivedData);
330
331         if (result != derivedData)
332                 result->dirty |= DM_DIRTY_NORMALS;
333         
334         return result;
335 }
336
337
338 ModifierTypeInfo modifierType_Mirror = {
339         /* name */              "Mirror",
340         /* structName */        "MirrorModifierData",
341         /* structSize */        sizeof(MirrorModifierData),
342         /* type */              eModifierTypeType_Constructive,
343         /* flags */             eModifierTypeFlag_AcceptsMesh |
344                                 eModifierTypeFlag_SupportsMapping |
345                                 eModifierTypeFlag_SupportsEditmode |
346                                 eModifierTypeFlag_EnableInEditmode |
347                                 eModifierTypeFlag_AcceptsCVs |
348                                 /* this is only the case when 'MOD_MIR_VGROUP' is used */
349                                 eModifierTypeFlag_UsesPreview,
350
351         /* copyData */          copyData,
352         /* deformVerts */       NULL,
353         /* deformMatrices */    NULL,
354         /* deformVertsEM */     NULL,
355         /* deformMatricesEM */  NULL,
356         /* applyModifier */     applyModifier,
357         /* applyModifierEM */   NULL,
358         /* initData */          initData,
359         /* requiredDataMask */  NULL,
360         /* freeData */          NULL,
361         /* isDisabled */        NULL,
362         /* updateDepsgraph */   updateDepsgraph,
363         /* dependsOnTime */     NULL,
364         /* dependsOnNormals */  NULL,
365         /* foreachObjectLink */ foreachObjectLink,
366         /* foreachIDLink */     NULL,
367         /* foreachTexLink */    NULL,
368 };