Cleanup: Naming in EditNormals modifier
[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(
148                         *no_new, *no_old, *no_new,
149                         (mix_limit < (float)M_PI) ? min_ff(fac, mix_limit / angle_v3v3(*no_new, *no_old)) : fac);
150         }
151
152         MEM_SAFE_FREE(facs);
153 }
154
155 /* Check poly normals and new loop normals are compatible, otherwise flip polygons
156  * (and invert matching poly normals). */
157 static bool polygons_check_flip(
158         MLoop *mloop, float (*nos)[3], CustomData *ldata,
159         MPoly *mpoly, float (*polynors)[3], const int num_polys)
160 {
161         MPoly *mp;
162         MDisps *mdisp = CustomData_get_layer(ldata, CD_MDISPS);
163         int i;
164         bool flipped = false;
165
166         for (i = 0, mp = mpoly; i < num_polys; i++, mp++) {
167                 float norsum[3] = {0.0f};
168                 float (*no)[3];
169                 int j;
170
171                 for (j = 0, no = &nos[mp->loopstart]; j < mp->totloop; j++, no++) {
172                         add_v3_v3(norsum, *no);
173                 }
174
175                 if (!normalize_v3(norsum)) {
176                         continue;
177                 }
178
179                 /* If average of new loop normals is opposed to polygon normal, flip polygon. */
180                 if (dot_v3v3(polynors[i], norsum) < 0.0f) {
181                         BKE_mesh_polygon_flip_ex(mp, mloop, ldata, nos, mdisp, true);
182                         negate_v3(polynors[i]);
183                         flipped = true;
184                 }
185         }
186
187         return flipped;
188 }
189
190 static void normalEditModifier_do_radial(
191         NormalEditModifierData *enmd, Object *ob, DerivedMesh *dm,
192         short (*clnors)[2], float (*loopnors)[3], float (*polynors)[3],
193         const short mix_mode, const float mix_factor, const float mix_limit,
194         MDeformVert *dvert, const int defgrp_index, const bool use_invert_vgroup,
195         MVert *mvert, const int num_verts, MEdge *medge, const int num_edges,
196         MLoop *mloop, const int num_loops, MPoly *mpoly, const int num_polys)
197 {
198         int i;
199
200         float (*cos)[3] = MEM_mallocN(sizeof(*cos) * num_verts, __func__);
201         float (*nos)[3] = MEM_mallocN(sizeof(*nos) * num_loops, __func__);
202         float size[3];
203
204         BLI_bitmap *done_verts = BLI_BITMAP_NEW((size_t)num_verts, __func__);
205
206         generate_vert_coordinates(dm, ob, enmd->target, enmd->offset, num_verts, cos, size);
207
208         /**
209          * size gives us our spheroid coefficients ``(A, B, C)``.
210          * Then, we want to find out for each vert its (a, b, c) triple (proportional to (A, B, C) one).
211          *
212          * Ellipsoid basic equation: ``(x^2/a^2) + (y^2/b^2) + (z^2/c^2) = 1.``
213          * Since we want to find (a, b, c) matching this equation and proportional to (A, B, C), we can do:
214          * <pre>
215          *     m = B / A
216          *     n = C / A
217          * </pre>
218          *
219          * hence:
220          * <pre>
221          *     (x^2/a^2) + (y^2/b^2) + (z^2/c^2) = 1
222          *  -> b^2*c^2*x^2 + a^2*c^2*y^2 + a^2*b^2*z^2 = a^2*b^2*c^2
223          *     b = ma
224          *     c = na
225          *  -> 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
226          *  -> 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
227          *  -> 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)
228          *  -> 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)
229          *  -> 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
230          * </pre>
231          *
232          * All we have to do now is compute normal of the spheroid at that point:
233          * <pre>
234          *     n = (x / a^2, y / b^2, z / c^2)
235          * </pre>
236          * And we are done!
237          */
238         {
239                 const float a = size[0], b = size[1], c = size[2];
240                 const float m2 = (b * b) / (a * a);
241                 const float n2 = (c * c) / (a * a);
242
243                 MLoop *ml;
244                 float (*no)[3];
245
246                 /* We reuse cos to now store the ellipsoid-normal of the verts! */
247                 for (i = num_loops, ml = mloop, no = nos; i-- ; ml++, no++) {
248                         const int vidx = ml->v;
249                         float *co = cos[vidx];
250
251                         if (!BLI_BITMAP_TEST(done_verts, vidx)) {
252                                 const float x2 = co[0] * co[0];
253                                 const float y2 = co[1] * co[1];
254                                 const float z2 = co[2] * co[2];
255                                 const float a2 = x2 + (y2 / m2) + (z2 / n2);
256                                 const float b2 = (m2 * x2) + y2 + (m2 * z2 / n2);
257                                 const float c2 = (n2 * x2) + (n2 * y2 / m2) + z2;
258
259                                 co[0] /= a2;
260                                 co[1] /= b2;
261                                 co[2] /= c2;
262                                 normalize_v3(co);
263
264                                 BLI_BITMAP_ENABLE(done_verts, vidx);
265                         }
266                         copy_v3_v3(*no, co);
267                 }
268         }
269
270         if (loopnors) {
271                 mix_normals(mix_factor, dvert, defgrp_index, use_invert_vgroup,
272                             mix_limit, mix_mode, num_verts, mloop, loopnors, nos, num_loops);
273         }
274
275         if (polygons_check_flip(mloop, nos, dm->getLoopDataLayout(dm), mpoly, polynors, num_polys)) {
276                 dm->dirty |= DM_DIRTY_TESS_CDLAYERS;
277                 /* We need to recompute vertex normals! */
278                 dm->calcNormals(dm);
279         }
280
281         BKE_mesh_normals_loop_custom_set(mvert, num_verts, medge, num_edges, mloop, nos, num_loops,
282                                          mpoly, (const float(*)[3])polynors, num_polys, clnors);
283
284         MEM_freeN(cos);
285         MEM_freeN(nos);
286         MEM_freeN(done_verts);
287 }
288
289 static void normalEditModifier_do_directional(
290         NormalEditModifierData *enmd, Object *ob, DerivedMesh *dm,
291         short (*clnors)[2], float (*loopnors)[3], float (*polynors)[3],
292         const short mix_mode, const float mix_factor, const float mix_limit,
293         MDeformVert *dvert, const int defgrp_index, const bool use_invert_vgroup,
294         MVert *mvert, const int num_verts, MEdge *medge, const int num_edges,
295         MLoop *mloop, const int num_loops, MPoly *mpoly, const int num_polys)
296 {
297         const bool use_parallel_normals = (enmd->flag & MOD_NORMALEDIT_USE_DIRECTION_PARALLEL) != 0;
298
299         float (*cos)[3] = MEM_mallocN(sizeof(*cos) * num_verts, __func__);
300         float (*nos)[3] = MEM_mallocN(sizeof(*nos) * num_loops, __func__);
301
302         float target_co[3];
303         int i;
304
305         dm->getVertCos(dm, cos);
306
307         /* Get target's center coordinates in ob local coordinates. */
308         {
309                 float mat[4][4];
310
311                 invert_m4_m4(mat, ob->obmat);
312                 mul_m4_m4m4(mat, mat, enmd->target->obmat);
313                 copy_v3_v3(target_co, mat[3]);
314         }
315
316         if (use_parallel_normals) {
317                 float no[3];
318
319                 sub_v3_v3v3(no, target_co, enmd->offset);
320                 normalize_v3(no);
321
322                 for (i = num_loops; i--; ) {
323                         copy_v3_v3(nos[i], no);
324                 }
325         }
326         else {
327                 BLI_bitmap *done_verts = BLI_BITMAP_NEW((size_t)num_verts, __func__);
328                 MLoop *ml;
329                 float (*no)[3];
330
331                 /* We reuse cos to now store the 'to target' normal of the verts! */
332                 for (i = num_loops, no = nos, ml = mloop; i--; no++, ml++) {
333                         const int vidx = ml->v;
334                         float *co = cos[vidx];
335
336                         if (!BLI_BITMAP_TEST(done_verts, vidx)) {
337                                 sub_v3_v3v3(co, target_co, co);
338                                 normalize_v3(co);
339
340                                 BLI_BITMAP_ENABLE(done_verts, vidx);
341                         }
342
343                         copy_v3_v3(*no, co);
344                 }
345
346                 MEM_freeN(done_verts);
347         }
348
349         if (loopnors) {
350                 mix_normals(mix_factor, dvert, defgrp_index, use_invert_vgroup,
351                             mix_limit, mix_mode, num_verts, mloop, loopnors, nos, num_loops);
352         }
353
354         if (polygons_check_flip(mloop, nos, dm->getLoopDataLayout(dm), mpoly, polynors, num_polys)) {
355                 dm->dirty |= DM_DIRTY_TESS_CDLAYERS;
356         }
357
358         BKE_mesh_normals_loop_custom_set(mvert, num_verts, medge, num_edges, mloop, nos, num_loops,
359                                          mpoly, (const float(*)[3])polynors, num_polys, clnors);
360
361         MEM_freeN(cos);
362         MEM_freeN(nos);
363 }
364
365 static bool is_valid_target(NormalEditModifierData *enmd)
366 {
367         if (enmd->mode == MOD_NORMALEDIT_MODE_RADIAL) {
368                 return true;
369         }
370         else if ((enmd->mode == MOD_NORMALEDIT_MODE_DIRECTIONAL) && enmd->target) {
371                 return true;
372         }
373         modifier_setError((ModifierData *)enmd, "Invalid target settings");
374         return false;
375 }
376
377 static DerivedMesh *normalEditModifier_do(NormalEditModifierData *enmd, Object *ob, DerivedMesh *dm)
378 {
379         Mesh *me = ob->data;
380
381         const int num_verts = dm->getNumVerts(dm);
382         const int num_edges = dm->getNumEdges(dm);
383         const int num_loops = dm->getNumLoops(dm);
384         const int num_polys = dm->getNumPolys(dm);
385         MVert *mvert;
386         MEdge *medge;
387         MLoop *mloop;
388         MPoly *mpoly;
389
390         const bool use_invert_vgroup = ((enmd->flag & MOD_NORMALEDIT_INVERT_VGROUP) != 0);
391         const bool use_current_clnors = !((enmd->mix_mode == MOD_NORMALEDIT_MIX_COPY) &&
392                                           (enmd->mix_factor == 1.0f) &&
393                                           (enmd->defgrp_name[0] == '\0') &&
394                                           (enmd->mix_limit == (float)M_PI));
395
396         int defgrp_index;
397         MDeformVert *dvert;
398
399         float (*loopnors)[3] = NULL;
400         short (*clnors)[2];
401
402         float (*polynors)[3];
403         bool free_polynors = false;
404
405         /* Do not run that modifier at all if autosmooth is disabled! */
406         if (!is_valid_target(enmd) || !num_loops) {
407                 return dm;
408         }
409
410         if (!(me->flag & ME_AUTOSMOOTH)) {
411                 modifier_setError((ModifierData *)enmd, "Enable 'Auto Smooth' option in mesh settings");
412                 return dm;
413         }
414
415         medge = dm->getEdgeArray(dm);
416         if (me->medge == medge) {
417                 /* We need to duplicate data here, otherwise setting custom normals (which may also affect sharp edges) could
418                  * modify org mesh, see T43671. */
419                 dm = CDDM_copy(dm);
420                 medge = dm->getEdgeArray(dm);
421         }
422         mvert = dm->getVertArray(dm);
423         mloop = dm->getLoopArray(dm);
424         mpoly = dm->getPolyArray(dm);
425
426         if (use_current_clnors) {
427                 dm->calcLoopNormals(dm, true, me->smoothresh);
428                 loopnors = dm->getLoopDataArray(dm, CD_NORMAL);
429         }
430
431         clnors = CustomData_duplicate_referenced_layer(&dm->loopData, CD_CUSTOMLOOPNORMAL, num_loops);
432         if (!clnors) {
433                 DM_add_loop_layer(dm, CD_CUSTOMLOOPNORMAL, CD_CALLOC, NULL);
434                 clnors = dm->getLoopDataArray(dm, CD_CUSTOMLOOPNORMAL);
435         }
436
437         polynors = dm->getPolyDataArray(dm, CD_NORMAL);
438         if (!polynors) {
439                 polynors = MEM_mallocN(sizeof(*polynors) * num_polys, __func__);
440                 BKE_mesh_calc_normals_poly(mvert, NULL, num_verts, mloop, mpoly, num_loops, num_polys, polynors, false);
441                 free_polynors = true;
442         }
443
444         modifier_get_vgroup(ob, dm, enmd->defgrp_name, &dvert, &defgrp_index);
445
446         if (enmd->mode == MOD_NORMALEDIT_MODE_RADIAL) {
447                 normalEditModifier_do_radial(
448                             enmd, ob, dm, clnors, loopnors, polynors,
449                             enmd->mix_mode, enmd->mix_factor, enmd->mix_limit, dvert, defgrp_index, use_invert_vgroup,
450                             mvert, num_verts, medge, num_edges, mloop, num_loops, mpoly, num_polys);
451         }
452         else if (enmd->mode == MOD_NORMALEDIT_MODE_DIRECTIONAL) {
453                 normalEditModifier_do_directional(
454                             enmd, ob, dm, clnors, loopnors, polynors,
455                             enmd->mix_mode, enmd->mix_factor, enmd->mix_limit, dvert, defgrp_index, use_invert_vgroup,
456                             mvert, num_verts, medge, num_edges, mloop, num_loops, mpoly, num_polys);
457         }
458
459         if (free_polynors) {
460                 MEM_freeN(polynors);
461         }
462
463         return dm;
464 }
465
466 static void initData(ModifierData *md)
467 {
468         NormalEditModifierData *enmd = (NormalEditModifierData *)md;
469
470         enmd->mode = MOD_NORMALEDIT_MODE_RADIAL;
471
472         enmd->mix_mode = MOD_NORMALEDIT_MIX_COPY;
473         enmd->mix_factor = 1.0f;
474         enmd->mix_limit = M_PI;
475 }
476
477 static void copyData(ModifierData *md, ModifierData *target)
478 {
479         modifier_copyData_generic(md, target);
480 }
481
482 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
483 {
484         NormalEditModifierData *enmd = (NormalEditModifierData *)md;
485         CustomDataMask dataMask = CD_CUSTOMLOOPNORMAL;
486
487         /* Ask for vertexgroups if we need them. */
488         if (enmd->defgrp_name[0]) {
489                 dataMask |= (CD_MASK_MDEFORMVERT);
490         }
491
492         return dataMask;
493 }
494
495 static bool dependsOnNormals(ModifierData *UNUSED(md))
496 {
497         return true;
498 }
499
500 static void foreachObjectLink(ModifierData *md, Object *ob, ObjectWalkFunc walk, void *userData)
501 {
502         NormalEditModifierData *enmd = (NormalEditModifierData *) md;
503
504         walk(userData, ob, &enmd->target, IDWALK_NOP);
505 }
506
507 static bool isDisabled(ModifierData *md, int UNUSED(useRenderParams))
508 {
509         NormalEditModifierData *enmd = (NormalEditModifierData *)md;
510
511         return !is_valid_target(enmd);
512 }
513
514 static void updateDepgraph(ModifierData *md, DagForest *forest,
515                            struct Main *UNUSED(bmain),
516                            struct Scene *UNUSED(scene),
517                            Object *UNUSED(ob), DagNode *obNode)
518 {
519         NormalEditModifierData *enmd = (NormalEditModifierData *) md;
520
521         if (enmd->target) {
522                 DagNode *Node = dag_get_node(forest, enmd->target);
523
524                 dag_add_relation(forest, Node, obNode, DAG_RL_OB_DATA, "NormalEdit Modifier");
525         }
526 }
527
528 static void updateDepsgraph(ModifierData *md,
529                             struct Main *UNUSED(bmain),
530                             struct Scene *UNUSED(scene),
531                             Object *UNUSED(ob),
532                             struct DepsNodeHandle *node)
533 {
534         NormalEditModifierData *enmd = (NormalEditModifierData *) md;
535         if (enmd->target) {
536                 DEG_add_object_relation(node, enmd->target, DEG_OB_COMP_TRANSFORM, "NormalEdit Modifier");
537         }
538 }
539
540 static DerivedMesh *applyModifier(ModifierData *md, Object *ob, DerivedMesh *dm, ModifierApplyFlag UNUSED(flag))
541 {
542         return normalEditModifier_do((NormalEditModifierData *)md, ob, dm);
543 }
544
545 ModifierTypeInfo modifierType_NormalEdit = {
546         /* name */              "Set Split Normals",
547         /* structName */        "NormalEditModifierData",
548         /* structSize */        sizeof(NormalEditModifierData),
549         /* type */              eModifierTypeType_Constructive,
550         /* flags */             eModifierTypeFlag_AcceptsMesh |
551                                 eModifierTypeFlag_SupportsMapping |
552                                 eModifierTypeFlag_SupportsEditmode |
553                                 eModifierTypeFlag_EnableInEditmode,
554         /* copyData */          copyData,
555         /* deformVerts */       NULL,
556         /* deformMatrices */    NULL,
557         /* deformVertsEM */     NULL,
558         /* deformMatricesEM */  NULL,
559         /* applyModifier */     applyModifier,
560         /* applyModifierEM */   NULL,
561         /* initData */          initData,
562         /* requiredDataMask */  requiredDataMask,
563         /* freeData */          NULL,
564         /* isDisabled */        isDisabled,
565         /* updateDepgraph */    updateDepgraph,
566         /* updateDepsgraph */   updateDepsgraph,
567         /* dependsOnTime */     NULL,
568         /* dependsOnNormals */  dependsOnNormals,
569         /* foreachObjectLink */ foreachObjectLink,
570         /* foreachIDLink */     NULL,
571         /* foreachTexLink */    NULL,
572 };