Fix T43671: Playing with Mix Factor of Data Transfer Modifier Is Overwritting Data...
[blender.git] / source / blender / modifiers / intern / MOD_normal_edit.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  * Contributor(s): Bastien Montagne
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  *
22  */
23
24 /** \file blender/modifiers/intern/MOD_normal_edit.c
25  *  \ingroup modifiers
26  */
27
28 #include <string.h>
29
30 #include "MEM_guardedalloc.h"
31
32 #include "DNA_object_types.h"
33 #include "DNA_meshdata_types.h"
34 #include "DNA_mesh_types.h"
35
36 #include "BLI_math.h"
37 #include "BLI_utildefines.h"
38 #include "BLI_bitmap.h"
39
40 #include "BKE_cdderivedmesh.h"
41 #include "BKE_mesh.h"
42 #include "BKE_deform.h"
43
44 #include "depsgraph_private.h"
45
46 #include "MOD_util.h"
47
48
49 static void generate_vert_coordinates(
50         DerivedMesh *dm, Object *ob, Object *ob_center, const float offset[3],
51         const int num_verts, float (*r_cos)[3], float r_size[3])
52 {
53         float min_co[3], max_co[3];
54         float diff[3];
55         bool do_diff = false;
56
57         INIT_MINMAX(min_co, max_co);
58
59         dm->getVertCos(dm, r_cos);
60
61         /* Get size (i.e. deformation of the spheroid generating normals), either from target object, or own geometry. */
62         if (ob_center) {
63                 copy_v3_v3(r_size, ob_center->size);
64         }
65         else {
66                 minmax_v3v3_v3_array(min_co, max_co, r_cos, num_verts);
67                 /* Set size. */
68                 sub_v3_v3v3(r_size, max_co, min_co);
69         }
70
71         /* Error checks - we do not want one or more of our sizes to be null! */
72         if (is_zero_v3(r_size)) {
73                 r_size[0] = r_size[1] = r_size[2] = 1.0f;
74         }
75         else {
76                 CLAMP_MIN(r_size[0], FLT_EPSILON);
77                 CLAMP_MIN(r_size[1], FLT_EPSILON);
78                 CLAMP_MIN(r_size[2], FLT_EPSILON);
79         }
80
81         if (ob_center) {
82                 /* Translate our coordinates so that center of ob_center is at (0, 0, 0). */
83                 float mat[4][4];
84
85                 /* Get ob_center coordinates in ob local coordinates. */
86                 invert_m4_m4(mat, ob_center->obmat);
87                 mul_m4_m4m4(mat, mat, ob->obmat);
88                 copy_v3_v3(diff, mat[3]);
89
90                 do_diff = true;
91         }
92         else if (!is_zero_v3(offset)) {
93                 negate_v3_v3(diff, offset);
94
95                 do_diff = true;
96         }
97         /* Else, no need to change coordinates! */
98
99         if (do_diff) {
100                 int i = num_verts;
101                 while (i--) {
102                         add_v3_v3(r_cos[i], diff);
103                 }
104         }
105 }
106
107 /* Note this modifies nos_new in-place. */
108 static void mix_normals(
109         const float mix_factor, MDeformVert *dvert, const int defgrp_index, const bool use_invert_vgroup,
110         const short mix_mode,
111         const int num_verts, MLoop *mloop, float (*nos_old)[3], float (*nos_new)[3], const int num_loops)
112 {
113         /* Mix with org normals... */
114         float *facs = NULL, *wfac;
115         float (*no_new)[3], (*no_old)[3];
116         int i;
117
118         if (dvert) {
119                 facs = MEM_mallocN(sizeof(*facs) * (size_t)num_loops, __func__);
120                 BKE_defvert_extract_vgroup_to_loopweights(
121                             dvert, defgrp_index, num_verts, mloop, num_loops, facs, use_invert_vgroup);
122         }
123
124         for (i = num_loops, no_new = nos_new, no_old = nos_old, wfac = facs; i--; no_new++, no_old++, wfac++) {
125                 const float fac = facs ? *wfac * mix_factor : mix_factor;
126
127                 switch (mix_mode) {
128                         case MOD_NORMALEDIT_MIX_ADD:
129                                 add_v3_v3(*no_new, *no_old);
130                                 normalize_v3(*no_new);
131                                 break;
132                         case MOD_NORMALEDIT_MIX_SUB:
133                                 sub_v3_v3(*no_new, *no_old);
134                                 normalize_v3(*no_new);
135                                 break;
136                         case MOD_NORMALEDIT_MIX_MUL:
137                                 mul_v3_v3(*no_new, *no_old);
138                                 normalize_v3(*no_new);
139                                 break;
140                         case MOD_NORMALEDIT_MIX_COPY:
141                                 break;
142                 }
143                 interp_v3_v3v3_slerp_safe(*no_new, *no_old, *no_new, fac);
144         }
145
146         MEM_SAFE_FREE(facs);
147 }
148
149 static void normalEditModifier_do_radial(
150         NormalEditModifierData *smd, Object *ob, DerivedMesh *dm,
151         short (*clnors)[2], float (*loopnors)[3], float (*polynors)[3],
152         const short mix_mode, const float mix_factor,
153         MDeformVert *dvert, const int defgrp_index, const bool use_invert_vgroup,
154         MVert *mvert, const int num_verts, MEdge *medge, const int num_edges,
155         MLoop *mloop, const int num_loops, MPoly *mpoly, const int num_polys)
156 {
157         int i;
158
159         float (*cos)[3] = MEM_mallocN(sizeof(*cos) * num_verts, __func__);
160         float (*nos)[3] = MEM_mallocN(sizeof(*nos) * num_loops, __func__);
161         float size[3];
162
163         BLI_bitmap *done_verts = BLI_BITMAP_NEW((size_t)num_verts, __func__);
164
165         generate_vert_coordinates(dm, ob, smd->target, smd->offset, num_verts, cos, size);
166
167         /**
168          * size gives us our spheroid coefficients ``(A, B, C)``.
169          * Then, we want to find out for each vert its (a, b, c) triple (proportional to (A, B, C) one).
170          *
171          * Ellipsoid basic equation: ``(x^2/a^2) + (y^2/b^2) + (z^2/c^2) = 1.``
172          * Since we want to find (a, b, c) matching this equation and proportional to (A, B, C), we can do:
173          * <pre>
174          *     m = B / A
175          *     n = C / A
176          * </pre>
177          *
178          * hence:
179          * <pre>
180          *     (x^2/a^2) + (y^2/b^2) + (z^2/c^2) = 1
181          *  -> b^2*c^2*x^2 + a^2*c^2*y^2 + a^2*b^2*z^2 = a^2*b^2*c^2
182          *     b = ma
183          *     c = na
184          *  -> m^2*a^2*n^2*a^2*x^2 + a^2*n^2*a^2*y^2 + a^2*m^2*a^2*z^2 = a^2*m^2*a^2*n^2*a^2
185          *  -> m^2*n^2*a^4*x^2 + n^2*a^4*y^2 + m^2*a^4*z^2 = m^2*n^2*a^6
186          *  -> a^2 = (m^2*n^2*x^2 + n^2y^2 + m^2z^2) / (m^2*n^2) = x^2 + (y^2 / m^2) + (z^2 / n^2)
187          *  -> b^2 = (m^2*n^2*x^2 + n^2y^2 + m^2z^2) / (n^2)     = (m^2 * x^2) + y^2 + (m^2 * z^2 / n^2)
188          *  -> c^2 = (m^2*n^2*x^2 + n^2y^2 + m^2z^2) / (m^2)     = (n^2 * x^2) + (n^2 * y^2 / m^2) + z^2
189          * </pre>
190          *
191          * All we have to do now is compute normal of the spheroid at that point:
192          * <pre>
193          *     n = (x / a^2, y / b^2, z / c^2)
194          * </pre>
195          * And we are done!
196          */
197         {
198                 const float a = size[0], b = size[1], c = size[2];
199                 const float m2 = (b * b) / (a * a);
200                 const float n2 = (c * c) / (a * a);
201
202                 MLoop *ml;
203                 float (*no)[3];
204
205                 /* We reuse cos to now store the ellipsoid-normal of the verts! */
206                 for (i = num_loops, ml = mloop, no = nos; i-- ; ml++, no++) {
207                         const int vidx = ml->v;
208                         float *co = cos[vidx];
209
210                         if (!BLI_BITMAP_TEST(done_verts, vidx)) {
211                                 const float x2 = co[0] * co[0];
212                                 const float y2 = co[1] * co[1];
213                                 const float z2 = co[2] * co[2];
214                                 const float a2 = x2 + (y2 / m2) + (z2 / n2);
215                                 const float b2 = (m2 * x2) + y2 + (m2 * z2 / n2);
216                                 const float c2 = (n2 * x2) + (n2 * y2 / m2) + z2;
217
218                                 co[0] /= a2;
219                                 co[1] /= b2;
220                                 co[2] /= c2;
221                                 normalize_v3(co);
222
223                                 BLI_BITMAP_ENABLE(done_verts, vidx);
224                         }
225                         copy_v3_v3(*no, co);
226                 }
227         }
228
229         if (loopnors) {
230                 mix_normals(mix_factor, dvert, defgrp_index, use_invert_vgroup,
231                             mix_mode, num_verts, mloop, loopnors, nos, num_loops);
232         }
233
234         BKE_mesh_normals_loop_custom_set(mvert, num_verts, medge, num_edges, mloop, nos, num_loops,
235                                          mpoly, (const float(*)[3])polynors, num_polys, clnors);
236
237         MEM_freeN(cos);
238         MEM_freeN(nos);
239         MEM_freeN(done_verts);
240 }
241
242 static void normalEditModifier_do_directional(
243         NormalEditModifierData *smd, Object *ob, DerivedMesh *dm,
244         short (*clnors)[2], float (*loopnors)[3], float (*polynors)[3],
245         const short mix_mode, const float mix_factor,
246         MDeformVert *dvert, const int defgrp_index, const bool use_invert_vgroup,
247         MVert *mvert, const int num_verts, MEdge *medge, const int num_edges,
248         MLoop *mloop, const int num_loops, MPoly *mpoly, const int num_polys)
249 {
250         const bool use_parallel_normals = (smd->flag & MOD_NORMALEDIT_USE_DIRECTION_PARALLEL) != 0;
251
252         float (*cos)[3] = MEM_mallocN(sizeof(*cos) * num_verts, __func__);
253         float (*nos)[3] = MEM_mallocN(sizeof(*nos) * num_loops, __func__);
254
255         float target_co[3];
256         int i;
257
258         dm->getVertCos(dm, cos);
259
260         /* Get target's center coordinates in ob local coordinates. */
261         {
262                 float mat[4][4];
263
264                 invert_m4_m4(mat, ob->obmat);
265                 mul_m4_m4m4(mat, mat, smd->target->obmat);
266                 copy_v3_v3(target_co, mat[3]);
267         }
268
269         if (use_parallel_normals) {
270                 float no[3];
271
272                 sub_v3_v3v3(no, target_co, smd->offset);
273                 normalize_v3(no);
274
275                 for (i = num_loops; i--; ) {
276                         copy_v3_v3(nos[i], no);
277                 }
278         }
279         else {
280                 BLI_bitmap *done_verts = BLI_BITMAP_NEW((size_t)num_verts, __func__);
281                 MLoop *ml;
282                 float (*no)[3];
283
284                 /* We reuse cos to now store the 'to target' normal of the verts! */
285                 for (i = num_loops, no = nos, ml = mloop; i--; no++, ml++) {
286                         const int vidx = ml->v;
287                         float *co = cos[vidx];
288
289                         if (!BLI_BITMAP_TEST(done_verts, vidx)) {
290                                 sub_v3_v3v3(co, target_co, co);
291                                 normalize_v3(co);
292
293                                 BLI_BITMAP_ENABLE(done_verts, vidx);
294                         }
295
296                         copy_v3_v3(*no, co);
297                 }
298
299                 MEM_freeN(done_verts);
300         }
301
302         if (loopnors) {
303                 mix_normals(mix_factor, dvert, defgrp_index, use_invert_vgroup,
304                             mix_mode, num_verts, mloop, loopnors, nos, num_loops);
305         }
306
307         BKE_mesh_normals_loop_custom_set(mvert, num_verts, medge, num_edges, mloop, nos, num_loops,
308                                          mpoly, (const float(*)[3])polynors, num_polys, clnors);
309
310         MEM_freeN(cos);
311         MEM_freeN(nos);
312 }
313
314 static bool is_valid_target(NormalEditModifierData *smd)
315 {
316         if (smd->mode == MOD_NORMALEDIT_MODE_RADIAL) {
317                 return true;
318         }
319         else if ((smd->mode == MOD_NORMALEDIT_MODE_DIRECTIONAL) && smd->target) {
320                 return true;
321         }
322         modifier_setError((ModifierData *)smd, "Invalid target settings");
323         return false;
324 }
325
326 static DerivedMesh *normalEditModifier_do(NormalEditModifierData *smd, Object *ob, DerivedMesh *dm)
327 {
328         Mesh *me = ob->data;
329
330         const int num_verts = dm->getNumVerts(dm);
331         const int num_edges = dm->getNumEdges(dm);
332         const int num_loops = dm->getNumLoops(dm);
333         const int num_polys = dm->getNumPolys(dm);
334         MVert *mvert;
335         MEdge *medge;
336         MLoop *mloop;
337         MPoly *mpoly;
338
339         const bool use_invert_vgroup = ((smd->flag & MOD_NORMALEDIT_INVERT_VGROUP) != 0);
340         const bool use_current_clnors = !((smd->mix_mode == MOD_NORMALEDIT_MIX_COPY) &&
341                                           (smd->mix_factor == 1.0f) &&
342                                           (smd->defgrp_name[0] == '\0'));
343
344         int defgrp_index;
345         MDeformVert *dvert;
346
347         float (*loopnors)[3] = NULL;
348         short (*clnors)[2];
349
350         float (*polynors)[3];
351         bool free_polynors = false;
352
353         /* Do not run that modifier at all if autosmooth is disabled! */
354         if (!is_valid_target(smd) || !num_loops) {
355                 return dm;
356         }
357
358         if (!(me->flag & ME_AUTOSMOOTH)) {
359                 modifier_setError((ModifierData *)smd, "Enable 'Auto Smooth' option in mesh settings");
360                 return dm;
361         }
362
363         medge = dm->getEdgeArray(dm);
364         if (me->medge == medge) {
365                 /* We need to duplicate data here, otherwise setting custom normals (which may also affect sharp edges) could
366                  * modify org mesh, see T43671. */
367                 dm = CDDM_copy(dm);
368                 medge = dm->getEdgeArray(dm);
369         }
370         mvert = dm->getVertArray(dm);
371         mloop = dm->getLoopArray(dm);
372         mpoly = dm->getPolyArray(dm);
373
374         if (use_current_clnors) {
375                 dm->calcLoopNormals(dm, true, me->smoothresh);
376                 loopnors = dm->getLoopDataArray(dm, CD_NORMAL);
377         }
378
379         clnors = CustomData_duplicate_referenced_layer(&dm->loopData, CD_CUSTOMLOOPNORMAL, num_loops);
380         if (!clnors) {
381                 DM_add_loop_layer(dm, CD_CUSTOMLOOPNORMAL, CD_CALLOC, NULL);
382                 clnors = dm->getLoopDataArray(dm, CD_CUSTOMLOOPNORMAL);
383         }
384
385         polynors = dm->getPolyDataArray(dm, CD_NORMAL);
386         if (!polynors) {
387                 polynors = MEM_mallocN(sizeof(*polynors) * num_polys, __func__);
388                 BKE_mesh_calc_normals_poly(mvert, num_verts, mloop, mpoly, num_loops, num_polys, polynors, false);
389                 free_polynors = true;
390         }
391
392         modifier_get_vgroup(ob, dm, smd->defgrp_name, &dvert, &defgrp_index);
393
394         if (smd->mode == MOD_NORMALEDIT_MODE_RADIAL) {
395                 normalEditModifier_do_radial(
396                             smd, ob, dm, clnors, loopnors, polynors,
397                             smd->mix_mode, smd->mix_factor, dvert, defgrp_index, use_invert_vgroup,
398                             mvert, num_verts, medge, num_edges, mloop, num_loops, mpoly, num_polys);
399         }
400         else if (smd->mode == MOD_NORMALEDIT_MODE_DIRECTIONAL) {
401                 normalEditModifier_do_directional(
402                             smd, ob, dm, clnors, loopnors, polynors,
403                             smd->mix_mode, smd->mix_factor, dvert, defgrp_index, use_invert_vgroup,
404                             mvert, num_verts, medge, num_edges, mloop, num_loops, mpoly, num_polys);
405         }
406
407         if (free_polynors) {
408                 MEM_freeN(polynors);
409         }
410
411         return dm;
412 }
413
414 static void initData(ModifierData *md)
415 {
416         NormalEditModifierData *smd = (NormalEditModifierData *)md;
417
418         smd->mode = MOD_NORMALEDIT_MODE_RADIAL;
419
420         smd->mix_mode = MOD_NORMALEDIT_MIX_COPY;
421         smd->mix_factor = 1.0f;
422 }
423
424 static void copyData(ModifierData *md, ModifierData *target)
425 {
426         modifier_copyData_generic(md, target);
427 }
428
429 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
430 {
431         NormalEditModifierData *smd = (NormalEditModifierData *)md;
432         CustomDataMask dataMask = CD_CUSTOMLOOPNORMAL;
433
434         /* Ask for vertexgroups if we need them. */
435         if (smd->defgrp_name[0]) {
436                 dataMask |= (CD_MASK_MDEFORMVERT);
437         }
438
439         return dataMask;
440 }
441
442 static bool dependsOnNormals(ModifierData *UNUSED(md))
443 {
444         return true;
445 }
446
447 static void foreachObjectLink(ModifierData *md, Object *ob, ObjectWalkFunc walk, void *userData)
448 {
449         NormalEditModifierData *smd = (NormalEditModifierData *) md;
450
451         walk(userData, ob, &smd->target);
452 }
453
454 static void foreachIDLink(ModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
455 {
456         NormalEditModifierData *smd = (NormalEditModifierData *) md;
457
458         walk(userData, ob, (ID **)&smd->target);
459 }
460
461 static bool isDisabled(ModifierData *md, int UNUSED(useRenderParams))
462 {
463         NormalEditModifierData *smd = (NormalEditModifierData *)md;
464
465         return !is_valid_target(smd);
466 }
467
468 static void updateDepgraph(ModifierData *md, DagForest *forest, struct Scene *UNUSED(scene),
469                            Object *UNUSED(ob), DagNode *obNode)
470 {
471         NormalEditModifierData *smd = (NormalEditModifierData *) md;
472
473         if (smd->target) {
474                 DagNode *Node = dag_get_node(forest, smd->target);
475
476                 dag_add_relation(forest, Node, obNode, DAG_RL_OB_DATA, "NormalEdit Modifier");
477         }
478 }
479
480 static DerivedMesh *applyModifier(ModifierData *md, Object *ob, DerivedMesh *dm, ModifierApplyFlag UNUSED(flag))
481 {
482         return normalEditModifier_do((NormalEditModifierData *)md, ob, dm);
483 }
484
485 ModifierTypeInfo modifierType_NormalEdit = {
486         /* name */              "Set Split Normals",
487         /* structName */        "NormalEditModifierData",
488         /* structSize */        sizeof(NormalEditModifierData),
489         /* type */              eModifierTypeType_Constructive,
490         /* flags */             eModifierTypeFlag_AcceptsMesh |
491                                 eModifierTypeFlag_AcceptsCVs |
492                                 eModifierTypeFlag_SupportsMapping |
493                                 eModifierTypeFlag_SupportsEditmode |
494                                 eModifierTypeFlag_EnableInEditmode,
495         /* copyData */          copyData,
496         /* deformVerts */       NULL,
497         /* deformMatrices */    NULL,
498         /* deformVertsEM */     NULL,
499         /* deformMatricesEM */  NULL,
500         /* applyModifier */     applyModifier,
501         /* applyModifierEM */   NULL,
502         /* initData */          initData,
503         /* requiredDataMask */  requiredDataMask,
504         /* freeData */          NULL,
505         /* isDisabled */        isDisabled,
506         /* updateDepgraph */    updateDepgraph,
507         /* dependsOnTime */     NULL,
508         /* dependsOnNormals */  dependsOnNormals,
509         /* foreachObjectLink */ foreachObjectLink,
510         /* foreachIDLink */     foreachIDLink,
511         /* foreachTexLink */    NULL,
512 };