Merge branch 'master' into blender2.8
[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 "MOD_util.h"
46
47
48 static void generate_vert_coordinates(
49         DerivedMesh *dm, Object *ob, Object *ob_center, const float offset[3],
50         const int num_verts, float (*r_cos)[3], float r_size[3])
51 {
52         float min_co[3], max_co[3];
53         float diff[3];
54         bool do_diff = false;
55
56         INIT_MINMAX(min_co, max_co);
57
58         dm->getVertCos(dm, r_cos);
59
60         /* Get size (i.e. deformation of the spheroid generating normals), either from target object, or own geometry. */
61         if (ob_center) {
62                 /* Not we are not interested in signs here - they are even troublesome actually, due to security clamping! */
63                 abs_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                 float inv_obmat[4][4];
83
84                 /* Translate our coordinates so that center of ob_center is at (0, 0, 0). */
85                 /* Get ob_center (world) coordinates in ob local coordinates.
86                  * No need to take into account ob_center's space here, see T44027. */
87                 invert_m4_m4(inv_obmat, ob->obmat);
88                 mul_v3_m4v3(diff, inv_obmat, ob_center->obmat[3]);
89                 negate_v3(diff);
90
91                 do_diff = true;
92         }
93         else if (!is_zero_v3(offset)) {
94                 negate_v3_v3(diff, offset);
95
96                 do_diff = true;
97         }
98         /* Else, no need to change coordinates! */
99
100         if (do_diff) {
101                 int i = num_verts;
102                 while (i--) {
103                         add_v3_v3(r_cos[i], diff);
104                 }
105         }
106 }
107
108 /* Note this modifies nos_new in-place. */
109 static void mix_normals(
110         const float mix_factor, MDeformVert *dvert, const int defgrp_index, const bool use_invert_vgroup,
111         const float mix_limit, const short mix_mode,
112         const int num_verts, MLoop *mloop, float (*nos_old)[3], float (*nos_new)[3], const int num_loops)
113 {
114         /* Mix with org normals... */
115         float *facs = NULL, *wfac;
116         float (*no_new)[3], (*no_old)[3];
117         int i;
118
119         if (dvert) {
120                 facs = MEM_mallocN(sizeof(*facs) * (size_t)num_loops, __func__);
121                 BKE_defvert_extract_vgroup_to_loopweights(
122                             dvert, defgrp_index, num_verts, mloop, num_loops, facs, use_invert_vgroup);
123         }
124
125         for (i = num_loops, no_new = nos_new, no_old = nos_old, wfac = facs; i--; no_new++, no_old++, wfac++) {
126                 const float fac = facs ? *wfac * mix_factor : mix_factor;
127
128                 switch (mix_mode) {
129                         case MOD_NORMALEDIT_MIX_ADD:
130                                 add_v3_v3(*no_new, *no_old);
131                                 normalize_v3(*no_new);
132                                 break;
133                         case MOD_NORMALEDIT_MIX_SUB:
134                                 sub_v3_v3(*no_new, *no_old);
135                                 normalize_v3(*no_new);
136                                 break;
137                         case MOD_NORMALEDIT_MIX_MUL:
138                                 mul_v3_v3(*no_new, *no_old);
139                                 normalize_v3(*no_new);
140                                 break;
141                         case MOD_NORMALEDIT_MIX_COPY:
142                                 break;
143                 }
144
145                 interp_v3_v3v3_slerp_safe(
146                         *no_new, *no_old, *no_new,
147                         (mix_limit < (float)M_PI) ? min_ff(fac, mix_limit / angle_v3v3(*no_new, *no_old)) : fac);
148         }
149
150         MEM_SAFE_FREE(facs);
151 }
152
153 /* Check poly normals and new loop normals are compatible, otherwise flip polygons
154  * (and invert matching poly normals). */
155 static bool polygons_check_flip(
156         MLoop *mloop, float (*nos)[3], CustomData *ldata,
157         MPoly *mpoly, float (*polynors)[3], const int num_polys)
158 {
159         MPoly *mp;
160         MDisps *mdisp = CustomData_get_layer(ldata, CD_MDISPS);
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_ex(mp, mloop, ldata, nos, mdisp, true);
180                         negate_v3(polynors[i]);
181                         flipped = true;
182                 }
183         }
184
185         return flipped;
186 }
187
188 static void normalEditModifier_do_radial(
189         NormalEditModifierData *enmd, 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, enmd->target, enmd->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                 /* We need to recompute vertex normals! */
276                 dm->calcNormals(dm);
277         }
278
279         BKE_mesh_normals_loop_custom_set(mvert, num_verts, medge, num_edges, mloop, nos, num_loops,
280                                          mpoly, (const float(*)[3])polynors, num_polys, clnors);
281
282         MEM_freeN(cos);
283         MEM_freeN(nos);
284         MEM_freeN(done_verts);
285 }
286
287 static void normalEditModifier_do_directional(
288         NormalEditModifierData *enmd, Object *ob, DerivedMesh *dm,
289         short (*clnors)[2], float (*loopnors)[3], float (*polynors)[3],
290         const short mix_mode, const float mix_factor, const float mix_limit,
291         MDeformVert *dvert, const int defgrp_index, const bool use_invert_vgroup,
292         MVert *mvert, const int num_verts, MEdge *medge, const int num_edges,
293         MLoop *mloop, const int num_loops, MPoly *mpoly, const int num_polys)
294 {
295         const bool use_parallel_normals = (enmd->flag & MOD_NORMALEDIT_USE_DIRECTION_PARALLEL) != 0;
296
297         float (*cos)[3] = MEM_mallocN(sizeof(*cos) * num_verts, __func__);
298         float (*nos)[3] = MEM_mallocN(sizeof(*nos) * num_loops, __func__);
299
300         float target_co[3];
301         int i;
302
303         dm->getVertCos(dm, cos);
304
305         /* Get target's center coordinates in ob local coordinates. */
306         {
307                 float mat[4][4];
308
309                 invert_m4_m4(mat, ob->obmat);
310                 mul_m4_m4m4(mat, mat, enmd->target->obmat);
311                 copy_v3_v3(target_co, mat[3]);
312         }
313
314         if (use_parallel_normals) {
315                 float no[3];
316
317                 sub_v3_v3v3(no, target_co, enmd->offset);
318                 normalize_v3(no);
319
320                 for (i = num_loops; i--; ) {
321                         copy_v3_v3(nos[i], no);
322                 }
323         }
324         else {
325                 BLI_bitmap *done_verts = BLI_BITMAP_NEW((size_t)num_verts, __func__);
326                 MLoop *ml;
327                 float (*no)[3];
328
329                 /* We reuse cos to now store the 'to target' normal of the verts! */
330                 for (i = num_loops, no = nos, ml = mloop; i--; no++, ml++) {
331                         const int vidx = ml->v;
332                         float *co = cos[vidx];
333
334                         if (!BLI_BITMAP_TEST(done_verts, vidx)) {
335                                 sub_v3_v3v3(co, target_co, co);
336                                 normalize_v3(co);
337
338                                 BLI_BITMAP_ENABLE(done_verts, vidx);
339                         }
340
341                         copy_v3_v3(*no, co);
342                 }
343
344                 MEM_freeN(done_verts);
345         }
346
347         if (loopnors) {
348                 mix_normals(mix_factor, dvert, defgrp_index, use_invert_vgroup,
349                             mix_limit, mix_mode, num_verts, mloop, loopnors, nos, num_loops);
350         }
351
352         if (polygons_check_flip(mloop, nos, dm->getLoopDataLayout(dm), mpoly, polynors, num_polys)) {
353                 dm->dirty |= DM_DIRTY_TESS_CDLAYERS;
354         }
355
356         BKE_mesh_normals_loop_custom_set(mvert, num_verts, medge, num_edges, mloop, nos, num_loops,
357                                          mpoly, (const float(*)[3])polynors, num_polys, clnors);
358
359         MEM_freeN(cos);
360         MEM_freeN(nos);
361 }
362
363 static bool is_valid_target(NormalEditModifierData *enmd)
364 {
365         if (enmd->mode == MOD_NORMALEDIT_MODE_RADIAL) {
366                 return true;
367         }
368         else if ((enmd->mode == MOD_NORMALEDIT_MODE_DIRECTIONAL) && enmd->target) {
369                 return true;
370         }
371         modifier_setError((ModifierData *)enmd, "Invalid target settings");
372         return false;
373 }
374
375 static DerivedMesh *normalEditModifier_do(NormalEditModifierData *enmd, Object *ob, DerivedMesh *dm)
376 {
377         Mesh *me = ob->data;
378
379         const int num_verts = dm->getNumVerts(dm);
380         const int num_edges = dm->getNumEdges(dm);
381         const int num_loops = dm->getNumLoops(dm);
382         const int num_polys = dm->getNumPolys(dm);
383         MVert *mvert;
384         MEdge *medge;
385         MLoop *mloop;
386         MPoly *mpoly;
387
388         const bool use_invert_vgroup = ((enmd->flag & MOD_NORMALEDIT_INVERT_VGROUP) != 0);
389         const bool use_current_clnors = !((enmd->mix_mode == MOD_NORMALEDIT_MIX_COPY) &&
390                                           (enmd->mix_factor == 1.0f) &&
391                                           (enmd->defgrp_name[0] == '\0') &&
392                                           (enmd->mix_limit == (float)M_PI));
393
394         int defgrp_index;
395         MDeformVert *dvert;
396
397         float (*loopnors)[3] = NULL;
398         short (*clnors)[2];
399
400         float (*polynors)[3];
401         bool free_polynors = false;
402
403         /* Do not run that modifier at all if autosmooth is disabled! */
404         if (!is_valid_target(enmd) || !num_loops) {
405                 return dm;
406         }
407
408         if (!(me->flag & ME_AUTOSMOOTH)) {
409                 modifier_setError((ModifierData *)enmd, "Enable 'Auto Smooth' option in mesh settings");
410                 return dm;
411         }
412
413         medge = dm->getEdgeArray(dm);
414         if (me->medge == medge) {
415                 /* We need to duplicate data here, otherwise setting custom normals (which may also affect sharp edges) could
416                  * modify org mesh, see T43671. */
417                 dm = CDDM_copy(dm);
418                 medge = dm->getEdgeArray(dm);
419         }
420         mvert = dm->getVertArray(dm);
421         mloop = dm->getLoopArray(dm);
422         mpoly = dm->getPolyArray(dm);
423
424         if (use_current_clnors) {
425                 dm->calcLoopNormals(dm, true, me->smoothresh);
426                 loopnors = dm->getLoopDataArray(dm, CD_NORMAL);
427         }
428
429         clnors = CustomData_duplicate_referenced_layer(&dm->loopData, CD_CUSTOMLOOPNORMAL, num_loops);
430         if (!clnors) {
431                 DM_add_loop_layer(dm, CD_CUSTOMLOOPNORMAL, CD_CALLOC, NULL);
432                 clnors = dm->getLoopDataArray(dm, CD_CUSTOMLOOPNORMAL);
433         }
434
435         polynors = dm->getPolyDataArray(dm, CD_NORMAL);
436         if (!polynors) {
437                 polynors = MEM_mallocN(sizeof(*polynors) * num_polys, __func__);
438                 BKE_mesh_calc_normals_poly(mvert, NULL, num_verts, mloop, mpoly, num_loops, num_polys, polynors, false);
439                 free_polynors = true;
440         }
441
442         modifier_get_vgroup(ob, dm, enmd->defgrp_name, &dvert, &defgrp_index);
443
444         if (enmd->mode == MOD_NORMALEDIT_MODE_RADIAL) {
445                 normalEditModifier_do_radial(
446                             enmd, ob, dm, clnors, loopnors, polynors,
447                             enmd->mix_mode, enmd->mix_factor, enmd->mix_limit, dvert, defgrp_index, use_invert_vgroup,
448                             mvert, num_verts, medge, num_edges, mloop, num_loops, mpoly, num_polys);
449         }
450         else if (enmd->mode == MOD_NORMALEDIT_MODE_DIRECTIONAL) {
451                 normalEditModifier_do_directional(
452                             enmd, ob, dm, clnors, loopnors, polynors,
453                             enmd->mix_mode, enmd->mix_factor, enmd->mix_limit, dvert, defgrp_index, use_invert_vgroup,
454                             mvert, num_verts, medge, num_edges, mloop, num_loops, mpoly, num_polys);
455         }
456
457         if (free_polynors) {
458                 MEM_freeN(polynors);
459         }
460
461         return dm;
462 }
463
464 static void initData(ModifierData *md)
465 {
466         NormalEditModifierData *enmd = (NormalEditModifierData *)md;
467
468         enmd->mode = MOD_NORMALEDIT_MODE_RADIAL;
469
470         enmd->mix_mode = MOD_NORMALEDIT_MIX_COPY;
471         enmd->mix_factor = 1.0f;
472         enmd->mix_limit = M_PI;
473 }
474
475 static void copyData(ModifierData *md, ModifierData *target)
476 {
477         modifier_copyData_generic(md, target);
478 }
479
480 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
481 {
482         NormalEditModifierData *enmd = (NormalEditModifierData *)md;
483         CustomDataMask dataMask = CD_CUSTOMLOOPNORMAL;
484
485         /* Ask for vertexgroups if we need them. */
486         if (enmd->defgrp_name[0]) {
487                 dataMask |= (CD_MASK_MDEFORMVERT);
488         }
489
490         return dataMask;
491 }
492
493 static bool dependsOnNormals(ModifierData *UNUSED(md))
494 {
495         return true;
496 }
497
498 static void foreachObjectLink(ModifierData *md, Object *ob, ObjectWalkFunc walk, void *userData)
499 {
500         NormalEditModifierData *enmd = (NormalEditModifierData *) md;
501
502         walk(userData, ob, &enmd->target, IDWALK_CB_NOP);
503 }
504
505 static bool isDisabled(ModifierData *md, int UNUSED(useRenderParams))
506 {
507         NormalEditModifierData *enmd = (NormalEditModifierData *)md;
508
509         return !is_valid_target(enmd);
510 }
511
512 static void updateDepsgraph(ModifierData *md,
513                             struct Main *UNUSED(bmain),
514                             struct Scene *UNUSED(scene),
515                             Object *UNUSED(ob),
516                             struct DepsNodeHandle *node)
517 {
518         NormalEditModifierData *enmd = (NormalEditModifierData *) md;
519         if (enmd->target) {
520                 DEG_add_object_relation(node, enmd->target, DEG_OB_COMP_TRANSFORM, "NormalEdit Modifier");
521         }
522 }
523
524 static DerivedMesh *applyModifier(ModifierData *md, Object *ob, DerivedMesh *dm, ModifierApplyFlag UNUSED(flag))
525 {
526         return normalEditModifier_do((NormalEditModifierData *)md, ob, dm);
527 }
528
529 ModifierTypeInfo modifierType_NormalEdit = {
530         /* name */              "Set Split Normals",
531         /* structName */        "NormalEditModifierData",
532         /* structSize */        sizeof(NormalEditModifierData),
533         /* type */              eModifierTypeType_Constructive,
534         /* flags */             eModifierTypeFlag_AcceptsMesh |
535                                 eModifierTypeFlag_SupportsMapping |
536                                 eModifierTypeFlag_SupportsEditmode |
537                                 eModifierTypeFlag_EnableInEditmode,
538         /* copyData */          copyData,
539         /* deformVerts */       NULL,
540         /* deformMatrices */    NULL,
541         /* deformVertsEM */     NULL,
542         /* deformMatricesEM */  NULL,
543         /* applyModifier */     applyModifier,
544         /* applyModifierEM */   NULL,
545         /* initData */          initData,
546         /* requiredDataMask */  requiredDataMask,
547         /* freeData */          NULL,
548         /* isDisabled */        isDisabled,
549         /* updateDepsgraph */   updateDepsgraph,
550         /* dependsOnTime */     NULL,
551         /* dependsOnNormals */  dependsOnNormals,
552         /* foreachObjectLink */ foreachObjectLink,
553         /* foreachIDLink */     NULL,
554         /* foreachTexLink */    NULL,
555 };