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