ae3f28ab764cdb562a40af78c97c4ff717ff459c
[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_mesh_types.h"
37 #include "DNA_meshdata_types.h"
38 #include "DNA_object_types.h"
39
40 #include "BLI_math.h"
41
42 #include "BKE_library.h"
43 #include "BKE_library_query.h"
44 #include "BKE_mesh.h"
45 #include "BKE_modifier.h"
46 #include "BKE_deform.h"
47
48 #include "bmesh.h"
49 #include "bmesh_tools.h"
50
51 #include "MEM_guardedalloc.h"
52
53 #include "DEG_depsgraph_build.h"
54 #include "DEG_depsgraph_query.h"
55
56 #include "MOD_modifiertypes.h"
57
58 static void initData(ModifierData *md)
59 {
60         MirrorModifierData *mmd = (MirrorModifierData *) md;
61
62         mmd->flag |= (MOD_MIR_AXIS_X | MOD_MIR_VGROUP);
63         mmd->tolerance = 0.001;
64         mmd->mirror_ob = NULL;
65 }
66
67 static void foreachObjectLink(
68         ModifierData *md, Object *ob,
69         ObjectWalkFunc walk, void *userData)
70 {
71         MirrorModifierData *mmd = (MirrorModifierData *) md;
72
73         walk(userData, ob, &mmd->mirror_ob, IDWALK_CB_NOP);
74 }
75
76 static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
77 {
78         MirrorModifierData *mmd = (MirrorModifierData *)md;
79         if (mmd->mirror_ob != NULL) {
80                 DEG_add_object_relation(ctx->node, mmd->mirror_ob, DEG_OB_COMP_TRANSFORM, "Mirror Modifier");
81                 DEG_add_object_relation(ctx->node, ctx->object, DEG_OB_COMP_TRANSFORM, "Mirror Modifier");
82         }
83 }
84
85 static Mesh *doBiscetOnMirrorPlane(
86         MirrorModifierData *mmd,
87         Object *ob,
88         const Mesh *mesh,
89         Object *mirror_ob,
90         int axis,
91         float mirrormat[4][4])
92 {
93         bool do_bisect_flip_axis = (
94                 (axis == 0 && mmd->flag & MOD_MIR_BISECT_FLIP_AXIS_X) ||
95                 (axis == 1 && mmd->flag & MOD_MIR_BISECT_FLIP_AXIS_Y) ||
96                 (axis == 2 && mmd->flag & MOD_MIR_BISECT_FLIP_AXIS_Z));
97
98         const float bisect_distance = 0.001;
99
100         Mesh *result;
101         BMesh *bm;
102         BMIter viter;
103         BMVert *v, *v_next;
104
105         bm = BKE_mesh_to_bmesh_ex(
106                 mesh,
107                 &(struct BMeshCreateParams){0},
108                 &(struct BMeshFromMeshParams){
109                         .calc_face_normal = true,
110                         .cd_mask_extra = CD_MASK_ORIGINDEX,
111                 });
112
113         /* prepare data for bisecting */
114         float plane[4];
115         float plane_co[3] = {0, 0, 0};
116         float plane_no[3];
117         copy_v3_v3(plane_no, mirrormat[axis]);
118
119         if (mirror_ob != NULL) {
120                 float tmp[4][4];
121                 invert_m4_m4(tmp, ob->obmat);
122                 mul_m4_m4m4(tmp, tmp, mirror_ob->obmat);
123
124                 copy_v3_v3(plane_no, tmp[axis]);
125                 copy_v3_v3(plane_co, tmp[3]);
126         }
127
128         plane_from_point_normal_v3(plane, plane_co, plane_no);
129
130         BM_mesh_bisect_plane(bm, plane, false, false, 0, 0, bisect_distance);
131
132         /* Plane definitions for vert killing. */
133         float plane_offset[4];
134         copy_v3_v3(plane_offset, plane);
135         plane_offset[3] = plane[3] - bisect_distance;
136
137         if (do_bisect_flip_axis) {
138                 negate_v3(plane_offset);
139         }
140
141         /* Delete verts across the mirror plane. */
142         BM_ITER_MESH_MUTABLE(v, v_next, &viter, bm, BM_VERTS_OF_MESH) {
143                 if (plane_point_side_v3(plane_offset, v->co) > 0.0f) {
144                         BM_vert_kill(bm, v);
145                 }
146         }
147
148         result = BKE_mesh_from_bmesh_for_eval_nomain(bm, 0);
149         BM_mesh_free(bm);
150
151         return result;
152 }
153
154 static Mesh *doMirrorOnAxis(
155         MirrorModifierData *mmd,
156         const ModifierEvalContext *ctx,
157         Object *ob,
158         const Mesh *mesh,
159         int axis)
160 {
161         const float tolerance_sq = mmd->tolerance * mmd->tolerance;
162         const bool do_vtargetmap = (mmd->flag & MOD_MIR_NO_MERGE) == 0;
163         int tot_vtargetmap = 0;  /* total merge vertices */
164
165         const bool do_bisect = (
166                 (axis == 0 && mmd->flag & MOD_MIR_BISECT_AXIS_X) ||
167                 (axis == 1 && mmd->flag & MOD_MIR_BISECT_AXIS_Y) ||
168                 (axis == 2 && mmd->flag & MOD_MIR_BISECT_AXIS_Z));
169
170         Mesh *result;
171         MVert *mv, *mv_prev;
172         MEdge *me;
173         MLoop *ml;
174         MPoly *mp;
175         float mtx[4][4];
176         int i;
177         int a, totshape;
178         int *vtargetmap = NULL, *vtmap_a = NULL, *vtmap_b = NULL;
179
180         /* mtx is the mirror transformation */
181         unit_m4(mtx);
182         mtx[axis][axis] = -1.0f;
183
184         Object *mirror_ob = DEG_get_evaluated_object(ctx->depsgraph, mmd->mirror_ob);
185         if (mirror_ob != NULL) {
186                 float tmp[4][4];
187                 float itmp[4][4];
188
189                 /* tmp is a transform from coords relative to the object's own origin,
190                  * to coords relative to the mirror object origin */
191                 invert_m4_m4(tmp, mirror_ob->obmat);
192                 mul_m4_m4m4(tmp, tmp, ob->obmat);
193
194                 /* itmp is the reverse transform back to origin-relative coordinates */
195                 invert_m4_m4(itmp, tmp);
196
197                 /* combine matrices to get a single matrix that translates coordinates into
198                  * mirror-object-relative space, does the mirror, and translates back to
199                  * origin-relative space */
200                 mul_m4_m4m4(mtx, mtx, tmp);
201                 mul_m4_m4m4(mtx, itmp, mtx);
202         }
203
204
205         Mesh *mesh_bisect = NULL;
206         if (do_bisect) {
207                 mesh_bisect = doBiscetOnMirrorPlane(mmd, ob, mesh, mirror_ob, axis, mtx);
208                 mesh = mesh_bisect;
209         }
210
211         const int maxVerts = mesh->totvert;
212         const int maxEdges = mesh->totedge;
213         const int maxLoops = mesh->totloop;
214         const int maxPolys = mesh->totpoly;
215
216         result = BKE_mesh_new_nomain_from_template(
217                 mesh, maxVerts * 2, maxEdges * 2, 0, maxLoops * 2, maxPolys * 2);
218
219         /*copy customdata to original geometry*/
220         CustomData_copy_data(&mesh->vdata, &result->vdata, 0, 0, maxVerts);
221         CustomData_copy_data(&mesh->edata, &result->edata, 0, 0, maxEdges);
222         CustomData_copy_data(&mesh->ldata, &result->ldata, 0, 0, maxLoops);
223         CustomData_copy_data(&mesh->pdata, &result->pdata, 0, 0, maxPolys);
224
225         /* Subsurf for eg won't have mesh data in the custom data arrays.
226          * now add mvert/medge/mpoly layers. */
227         if (!CustomData_has_layer(&mesh->vdata, CD_MVERT)) {
228                 memcpy(result->mvert, mesh->mvert, sizeof(*result->mvert) * mesh->totvert);
229         }
230         if (!CustomData_has_layer(&mesh->edata, CD_MEDGE)) {
231                 memcpy(result->medge, mesh->medge, sizeof(*result->medge) * mesh->totedge);
232         }
233         if (!CustomData_has_layer(&mesh->pdata, CD_MPOLY)) {
234                 memcpy(result->mloop, mesh->mloop, sizeof(*result->mloop) * mesh->totloop);
235                 memcpy(result->mpoly, mesh->mpoly, sizeof(*result->mpoly) * mesh->totpoly);
236         }
237
238         /* copy customdata to new geometry,
239          * copy from its self because this data may have been created in the checks above */
240         CustomData_copy_data(&result->vdata, &result->vdata, 0, maxVerts, maxVerts);
241         CustomData_copy_data(&result->edata, &result->edata, 0, maxEdges, maxEdges);
242         /* loops are copied later */
243         CustomData_copy_data(&result->pdata, &result->pdata, 0, maxPolys, maxPolys);
244
245         if (do_vtargetmap) {
246                 /* second half is filled with -1 */
247                 vtargetmap = MEM_malloc_arrayN(maxVerts, 2 * sizeof(int), "MOD_mirror tarmap");
248
249                 vtmap_a = vtargetmap;
250                 vtmap_b = vtargetmap + maxVerts;
251         }
252
253         /* mirror vertex coordinates */
254         mv_prev = result->mvert;
255         mv = mv_prev + maxVerts;
256         for (i = 0; i < maxVerts; i++, mv++, mv_prev++) {
257                 mul_m4_v3(mtx, mv->co);
258
259                 if (do_vtargetmap) {
260                         /* compare location of the original and mirrored vertex, to see if they
261                          * should be mapped for merging */
262                         if (UNLIKELY(len_squared_v3v3(mv_prev->co, mv->co) < tolerance_sq)) {
263                                 *vtmap_a = maxVerts + i;
264                                 tot_vtargetmap++;
265
266                                 /* average location */
267                                 mid_v3_v3v3(mv->co, mv_prev->co, mv->co);
268                                 copy_v3_v3(mv_prev->co, mv->co);
269                         }
270                         else {
271                                 *vtmap_a = -1;
272                         }
273
274                         *vtmap_b = -1; /* fill here to avoid 2x loops */
275
276                         vtmap_a++;
277                         vtmap_b++;
278                 }
279         }
280
281         /* handle shape keys */
282         totshape = CustomData_number_of_layers(&result->vdata, CD_SHAPEKEY);
283         for (a = 0; a < totshape; a++) {
284                 float (*cos)[3] = CustomData_get_layer_n(&result->vdata, CD_SHAPEKEY, a);
285                 for (i = maxVerts; i < result->totvert; i++) {
286                         mul_m4_v3(mtx, cos[i]);
287                 }
288         }
289
290         /* adjust mirrored edge vertex indices */
291         me = result->medge + maxEdges;
292         for (i = 0; i < maxEdges; i++, me++) {
293                 me->v1 += maxVerts;
294                 me->v2 += maxVerts;
295         }
296
297         /* adjust mirrored poly loopstart indices, and reverse loop order (normals) */
298         mp = result->mpoly + maxPolys;
299         ml = result->mloop;
300         for (i = 0; i < maxPolys; i++, mp++) {
301                 MLoop *ml2;
302                 int j, e;
303
304                 /* reverse the loop, but we keep the first vertex in the face the same,
305                  * to ensure that quads are split the same way as on the other side */
306                 CustomData_copy_data(&result->ldata, &result->ldata, mp->loopstart, mp->loopstart + maxLoops, 1);
307
308                 for (j = 1; j < mp->totloop; j++)
309                         CustomData_copy_data(&result->ldata, &result->ldata,
310                                              mp->loopstart + j,
311                                              mp->loopstart + maxLoops + mp->totloop - j,
312                                              1);
313
314                 ml2 = ml + mp->loopstart + maxLoops;
315                 e = ml2[0].e;
316                 for (j = 0; j < mp->totloop - 1; j++) {
317                         ml2[j].e = ml2[j + 1].e;
318                 }
319                 ml2[mp->totloop - 1].e = e;
320
321                 mp->loopstart += maxLoops;
322         }
323
324         /* adjust mirrored loop vertex and edge indices */
325         ml = result->mloop + maxLoops;
326         for (i = 0; i < maxLoops; i++, ml++) {
327                 ml->v += maxVerts;
328                 ml->e += maxEdges;
329         }
330
331         /* handle uvs,
332          * let tessface recalc handle updating the MTFace data */
333         if (mmd->flag & (MOD_MIR_MIRROR_U | MOD_MIR_MIRROR_V) || (is_zero_v2(mmd->uv_offset_copy) == false)) {
334                 const bool do_mirr_u = (mmd->flag & MOD_MIR_MIRROR_U) != 0;
335                 const bool do_mirr_v = (mmd->flag & MOD_MIR_MIRROR_V) != 0;
336
337                 const int totuv = CustomData_number_of_layers(&result->ldata, CD_MLOOPUV);
338
339                 for (a = 0; a < totuv; a++) {
340                         MLoopUV *dmloopuv = CustomData_get_layer_n(&result->ldata, CD_MLOOPUV, a);
341                         int j = maxLoops;
342                         dmloopuv += j; /* second set of loops only */
343                         for (; j-- > 0; dmloopuv++) {
344                                 if (do_mirr_u) dmloopuv->uv[0] = 1.0f - dmloopuv->uv[0] + mmd->uv_offset[0];
345                                 if (do_mirr_v) dmloopuv->uv[1] = 1.0f - dmloopuv->uv[1] + mmd->uv_offset[1];
346                                 dmloopuv->uv[0] += mmd->uv_offset_copy[0];
347                                 dmloopuv->uv[1] += mmd->uv_offset_copy[1];
348                         }
349                 }
350         }
351
352         /* handle vgroup stuff */
353         if ((mmd->flag & MOD_MIR_VGROUP) && CustomData_has_layer(&result->vdata, CD_MDEFORMVERT)) {
354                 MDeformVert *dvert = (MDeformVert *) CustomData_get_layer(&result->vdata, CD_MDEFORMVERT) + maxVerts;
355                 int *flip_map = NULL, flip_map_len = 0;
356
357                 flip_map = defgroup_flip_map(ob, &flip_map_len, false);
358
359                 if (flip_map) {
360                         for (i = 0; i < maxVerts; dvert++, i++) {
361                                 /* merged vertices get both groups, others get flipped */
362                                 if (do_vtargetmap && (vtargetmap[i] != -1))
363                                         defvert_flip_merged(dvert, flip_map, flip_map_len);
364                                 else
365                                         defvert_flip(dvert, flip_map, flip_map_len);
366                         }
367
368                         MEM_freeN(flip_map);
369                 }
370         }
371
372         if (do_vtargetmap) {
373                 /* slow - so only call if one or more merge verts are found,
374                  * users may leave this on and not realize there is nothing to merge - campbell */
375                 if (tot_vtargetmap) {
376                         result = BKE_mesh_merge_verts(result, vtargetmap, tot_vtargetmap, MESH_MERGE_VERTS_DUMP_IF_MAPPED);
377                 }
378                 MEM_freeN(vtargetmap);
379         }
380
381         if (mesh_bisect != NULL) {
382                 BKE_id_free(NULL, mesh_bisect);
383         }
384
385         return result;
386 }
387
388 static Mesh *mirrorModifier__doMirror(
389         MirrorModifierData *mmd, const ModifierEvalContext *ctx,
390         Object *ob, Mesh *mesh)
391 {
392         Mesh *result = mesh;
393
394         /* check which axes have been toggled and mirror accordingly */
395         if (mmd->flag & MOD_MIR_AXIS_X) {
396                 result = doMirrorOnAxis(mmd, ctx, ob, result, 0);
397         }
398         if (mmd->flag & MOD_MIR_AXIS_Y) {
399                 Mesh *tmp = result;
400                 result = doMirrorOnAxis(mmd, ctx, ob, result, 1);
401                 if (tmp != mesh) {
402                         /* free intermediate results */
403                         BKE_id_free(NULL, tmp);
404                 }
405         }
406         if (mmd->flag & MOD_MIR_AXIS_Z) {
407                 Mesh *tmp = result;
408                 result = doMirrorOnAxis(mmd, ctx, ob, result, 2);
409                 if (tmp != mesh) {
410                         /* free intermediate results */
411                         BKE_id_free(NULL, tmp);
412                 }
413         }
414
415         return result;
416 }
417
418 static Mesh *applyModifier(
419         ModifierData *md, const ModifierEvalContext *ctx,
420         Mesh *mesh)
421 {
422         Mesh *result;
423         MirrorModifierData *mmd = (MirrorModifierData *) md;
424
425         result = mirrorModifier__doMirror(mmd, ctx, ctx->object, mesh);
426
427         if (result != mesh) {
428                 result->runtime.cd_dirty_vert |= CD_MASK_NORMAL;
429         }
430         return result;
431 }
432
433
434 ModifierTypeInfo modifierType_Mirror = {
435         /* name */              "Mirror",
436         /* structName */        "MirrorModifierData",
437         /* structSize */        sizeof(MirrorModifierData),
438         /* type */              eModifierTypeType_Constructive,
439         /* flags */             eModifierTypeFlag_AcceptsMesh |
440                                 eModifierTypeFlag_SupportsMapping |
441                                 eModifierTypeFlag_SupportsEditmode |
442                                 eModifierTypeFlag_EnableInEditmode |
443                                 eModifierTypeFlag_AcceptsCVs |
444                                 /* this is only the case when 'MOD_MIR_VGROUP' is used */
445                                 eModifierTypeFlag_UsesPreview,
446
447         /* copyData */          modifier_copyData_generic,
448
449         /* deformVerts_DM */    NULL,
450         /* deformMatrices_DM */ NULL,
451         /* deformVertsEM_DM */  NULL,
452         /* deformMatricesEM_DM*/NULL,
453         /* applyModifier_DM */  NULL,
454
455         /* deformVerts */       NULL,
456         /* deformMatrices */    NULL,
457         /* deformVertsEM */     NULL,
458         /* deformMatricesEM */  NULL,
459         /* applyModifier */     applyModifier,
460
461         /* initData */          initData,
462         /* requiredDataMask */  NULL,
463         /* freeData */          NULL,
464         /* isDisabled */        NULL,
465         /* updateDepsgraph */   updateDepsgraph,
466         /* dependsOnTime */     NULL,
467         /* dependsOnNormals */  NULL,
468         /* foreachObjectLink */ foreachObjectLink,
469         /* foreachIDLink */     NULL,
470         /* foreachTexLink */    NULL,
471 };