Fix T58450: Skin modifier not working if applied after subsurf
[blender.git] / source / blender / modifiers / intern / MOD_skin.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): Nicholas Bishop
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  *
22  */
23
24 /** \file blender/modifiers/intern/MOD_skin.c
25  *  \ingroup modifiers
26  */
27
28 /* Implementation based in part off the paper "B-Mesh: A Fast Modeling
29  * System for Base Meshes of 3D Articulated Shapes" (Zhongping Ji,
30  * Ligang Liu, Yigang Wang)
31  *
32  * Note that to avoid confusion with Blender's BMesh data structure,
33  * this tool is renamed as the Skin modifier.
34  *
35  * The B-Mesh paper is current available here:
36  * http://www.math.zju.edu.cn/ligangliu/CAGD/Projects/BMesh/
37  *
38  * The main missing features in this code compared to the paper are:
39  *
40  * + No mesh evolution. The paper suggests iteratively subsurfing the
41  *   skin output and adapting the output to better conform with the
42  *   spheres of influence surrounding each vertex.
43  *
44  * + No mesh fairing. The paper suggests re-aligning output edges to
45  *   follow principal mesh curvatures.
46  *
47  * + No auxiliary balls. These would serve to influence mesh
48  *   evolution, which as noted above is not implemented.
49  *
50  * The code also adds some features not present in the paper:
51  *
52  * + Loops in the input edge graph.
53  *
54  * + Concave surfaces around branch nodes. The paper does not discuss
55  *   how to handle non-convex regions; this code adds a number of
56  *   cleanup operations to handle many (though not all) of these
57  *   cases.
58  */
59
60 #include "MEM_guardedalloc.h"
61
62 #include "DNA_mesh_types.h"
63 #include "DNA_meshdata_types.h"
64 #include "DNA_object_types.h"
65 #include "DNA_modifier_types.h"
66
67 #include "BLI_utildefines.h"
68 #include "BLI_array.h"
69 #include "BLI_heap_simple.h"
70 #include "BLI_math.h"
71 #include "BLI_stack.h"
72 #include "BLI_bitmap.h"
73
74 #include "BKE_deform.h"
75 #include "BKE_library.h"
76 #include "BKE_mesh.h"
77 #include "BKE_mesh_mapping.h"
78 #include "BKE_modifier.h"
79
80 #include "MOD_modifiertypes.h"
81
82 #include "bmesh.h"
83
84 typedef struct {
85         float mat[3][3];
86         /* Vert that edge is pointing away from, no relation to
87          * MEdge.v1 */
88         int origin;
89 } EMat;
90
91 typedef enum {
92         CAP_START = 1,
93         CAP_END = 2,
94         SEAM_FRAME = 4,
95         ROOT = 8
96 } SkinNodeFlag;
97
98 typedef struct Frame {
99         /* Index in the MVert array */
100         BMVert *verts[4];
101         /* Location of each corner */
102         float co[4][3];
103         /* Indicates which corners have been merged with another
104          * frame's corner (so they share an MVert index) */
105         struct {
106                 /* Merge to target frame/corner (no merge if frame is null) */
107                 struct Frame *frame;
108                 int corner;
109                 /* checked to avoid chaining.
110                  * (merging when we're already been referenced), see T39775 */
111                 unsigned int is_target : 1;
112         } merge[4];
113
114         /* For hull frames, whether each vertex is detached or not */
115         bool inside_hull[4];
116         /* Whether any part of the frame (corner or edge) is detached */
117         bool detached;
118 } Frame;
119
120 #define MAX_SKIN_NODE_FRAMES 2
121 typedef struct {
122         Frame frames[MAX_SKIN_NODE_FRAMES];
123         int totframe;
124
125         SkinNodeFlag flag;
126
127         /* Used for hulling a loop seam */
128         int seam_edges[2];
129 } SkinNode;
130
131 typedef struct {
132         BMesh *bm;
133         SkinModifierData *smd;
134         int mat_nr;
135 } SkinOutput;
136
137 static void add_poly(
138         SkinOutput *so,
139         BMVert *v1,
140         BMVert *v2,
141         BMVert *v3,
142         BMVert *v4);
143
144 /***************************** Convex Hull ****************************/
145
146 static bool is_quad_symmetric(
147         BMVert *quad[4],
148         const SkinModifierData *smd)
149 {
150         const float threshold = 0.0001f;
151         const float threshold_squared = threshold * threshold;
152         int axis;
153
154         for (axis = 0; axis < 3; axis++) {
155                 if (smd->symmetry_axes & (1 << axis)) {
156                         float a[3];
157
158                         copy_v3_v3(a, quad[0]->co);
159                         a[axis] = -a[axis];
160
161                         if (len_squared_v3v3(a, quad[1]->co) < threshold_squared) {
162                                 copy_v3_v3(a, quad[2]->co);
163                                 a[axis] = -a[axis];
164                                 if (len_squared_v3v3(a, quad[3]->co) < threshold_squared)
165                                         return 1;
166                         }
167                         else if (len_squared_v3v3(a, quad[3]->co) < threshold_squared) {
168                                 copy_v3_v3(a, quad[2]->co);
169                                 a[axis] = -a[axis];
170                                 if (len_squared_v3v3(a, quad[1]->co) < threshold_squared)
171                                         return 1;
172                         }
173                 }
174         }
175
176         return 0;
177 }
178
179 /* Returns true if the quad crosses the plane of symmetry, false otherwise */
180 static bool quad_crosses_symmetry_plane(
181         BMVert *quad[4],
182         const SkinModifierData *smd)
183 {
184         int axis;
185
186         for (axis = 0; axis < 3; axis++) {
187                 if (smd->symmetry_axes & (1 << axis)) {
188                         bool left = false, right = false;
189                         int i;
190
191                         for (i = 0; i < 4; i++) {
192                                 if (quad[i]->co[axis] < 0.0f)
193                                         left = true;
194                                 else if (quad[i]->co[axis] > 0.0f)
195                                         right = true;
196
197                                 if (left && right)
198                                         return true;
199                         }
200                 }
201         }
202
203         return false;
204 }
205
206 /* Returns true if the frame is filled by precisely two faces (and
207  * outputs those faces to fill_faces), otherwise returns false. */
208 static bool skin_frame_find_contained_faces(
209         const Frame *frame,
210         BMFace *fill_faces[2])
211 {
212         BMEdge *diag;
213
214         /* See if the frame is bisected by a diagonal edge */
215         diag = BM_edge_exists(frame->verts[0], frame->verts[2]);
216         if (!diag)
217                 diag = BM_edge_exists(frame->verts[1], frame->verts[3]);
218
219         if (diag)
220                 return BM_edge_face_pair(diag, &fill_faces[0], &fill_faces[1]);
221         else
222                 return false;
223 }
224
225 /* Returns true if hull is successfully built, false otherwise */
226 static bool build_hull(SkinOutput *so, Frame **frames, int totframe)
227 {
228 #ifdef WITH_BULLET
229         BMesh *bm = so->bm;
230         BMOperator op;
231         BMIter iter;
232         BMOIter oiter;
233         BMVert *v;
234         BMFace *f;
235         BMEdge *e;
236         int i, j;
237
238         BM_mesh_elem_hflag_disable_all(bm, BM_VERT, BM_ELEM_TAG, false);
239
240         for (i = 0; i < totframe; i++) {
241                 for (j = 0; j < 4; j++) {
242                         BM_elem_flag_enable(frames[i]->verts[j], BM_ELEM_TAG);
243                 }
244         }
245
246         /* Deselect all faces so that only new hull output faces are
247          * selected after the operator is run */
248         BM_mesh_elem_hflag_disable_all(bm, BM_ALL_NOLOOP, BM_ELEM_SELECT, false);
249
250         BMO_op_initf(bm, &op, (BMO_FLAG_DEFAULTS & ~BMO_FLAG_RESPECT_HIDE),
251                      "convex_hull input=%hv", BM_ELEM_TAG);
252         BMO_op_exec(bm, &op);
253
254         if (BMO_error_occurred(bm)) {
255                 BMO_op_finish(bm, &op);
256                 return false;
257         }
258
259         /* Apply face attributes to hull output */
260         BMO_ITER (f, &oiter, op.slots_out, "geom.out", BM_FACE) {
261                 BM_face_normal_update(f);
262                 if (so->smd->flag & MOD_SKIN_SMOOTH_SHADING)
263                         BM_elem_flag_enable(f, BM_ELEM_SMOOTH);
264                 f->mat_nr = so->mat_nr;
265         }
266
267         /* Mark interior frames */
268         BMO_ITER (v, &oiter, op.slots_out, "geom_interior.out", BM_VERT) {
269                 for (i = 0; i < totframe; i++) {
270                         Frame *frame = frames[i];
271
272                         if (!frame->detached) {
273                                 for (j = 0; j < 4; j++) {
274                                         if (frame->verts[j] == v) {
275                                                 frame->inside_hull[j] = true;
276                                                 frame->detached = true;
277                                                 break;
278                                         }
279                                 }
280                         }
281                 }
282         }
283
284         /* Also mark frames as interior if an edge is not in the hull */
285         for (i = 0; i < totframe; i++) {
286                 Frame *frame = frames[i];
287
288                 if (!frame->detached &&
289                     (!BM_edge_exists(frame->verts[0], frame->verts[1]) ||
290                      !BM_edge_exists(frame->verts[1], frame->verts[2]) ||
291                      !BM_edge_exists(frame->verts[2], frame->verts[3]) ||
292                      !BM_edge_exists(frame->verts[3], frame->verts[0])))
293                 {
294                         frame->detached = true;
295                 }
296         }
297
298         /* Remove triangles that would fill the original frames -- skip if
299          * frame is partially detached */
300         BM_mesh_elem_hflag_disable_all(bm, BM_ALL_NOLOOP, BM_ELEM_TAG, false);
301         for (i = 0; i < totframe; i++) {
302                 Frame *frame = frames[i];
303                 if (!frame->detached) {
304                         BMFace *fill_faces[2];
305
306                         /* Check if the frame is filled by precisely two
307                          * triangles. If so, delete the triangles and their shared
308                          * edge. Otherwise, give up and mark the frame as
309                          * detached. */
310                         if (skin_frame_find_contained_faces(frame, fill_faces)) {
311                                 BM_elem_flag_enable(fill_faces[0], BM_ELEM_TAG);
312                                 BM_elem_flag_enable(fill_faces[1], BM_ELEM_TAG);
313                         }
314                         else
315                                 frame->detached = true;
316                 }
317         }
318
319         /* Check if removing triangles above will create wire triangles,
320          * mark them too */
321         BMO_ITER (e, &oiter, op.slots_out, "geom.out", BM_EDGE) {
322                 bool is_wire = true;
323                 BM_ITER_ELEM (f, &iter, e, BM_FACES_OF_EDGE) {
324                         if (!BM_elem_flag_test(f, BM_ELEM_TAG)) {
325                                 is_wire = false;
326                                 break;
327                         }
328                 }
329                 if (is_wire)
330                         BM_elem_flag_enable(e, BM_ELEM_TAG);
331         }
332
333         BMO_op_finish(bm, &op);
334
335         BM_mesh_delete_hflag_tagged(bm, BM_ELEM_TAG, BM_EDGE | BM_FACE);
336
337         return true;
338 #else
339         UNUSED_VARS(so, frames, totframe, skin_frame_find_contained_faces);
340         return false;
341 #endif
342 }
343
344 /* Returns the average frame side length (frames are rectangular, so
345  * just the average of two adjacent edge lengths) */
346 static float frame_len(const Frame *frame)
347 {
348         return (len_v3v3(frame->co[0], frame->co[1]) +
349                 len_v3v3(frame->co[1], frame->co[2])) * 0.5f;
350 }
351
352 static void merge_frame_corners(Frame **frames, int totframe)
353 {
354         float dist, side_a, side_b, thresh, mid[3];
355         int i, j, k, l;
356
357         for (i = 0; i < totframe; i++) {
358                 side_a = frame_len(frames[i]);
359
360                 /* For each corner of each frame... */
361                 for (j = 0; j < 4; j++) {
362
363                         /* Ensure the merge target is not itself a merge target */
364                         if (frames[i]->merge[j].frame)
365                                 continue;
366
367                         for (k = i + 1; k < totframe; k++) {
368                                 BLI_assert(frames[i] != frames[k]);
369
370                                 side_b = frame_len(frames[k]);
371                                 thresh = min_ff(side_a, side_b) / 2.0f;
372
373                                 /* Compare with each corner of all other frames... */
374                                 for (l = 0; l < 4; l++) {
375                                         if (frames[k]->merge[l].frame || frames[k]->merge[l].is_target)
376                                                 continue;
377
378                                         /* Some additional concerns that could be checked
379                                          * further:
380                                          *
381                                          * + Vertex coords are being used for the
382                                          *   edge-length test, but are also being
383                                          *   modified, might cause symmetry problems.
384                                          *
385                                          * + A frame could be merged diagonally across
386                                          *   another, would generate a weird (bad) T
387                                          *   junction
388                                          */
389
390                                         /* Check if corners are near each other, where
391                                          * 'near' is based in the frames' minimum side
392                                          * length */
393                                         dist = len_v3v3(frames[i]->co[j],
394                                                         frames[k]->co[l]);
395                                         if (dist < thresh) {
396                                                 mid_v3_v3v3(mid,
397                                                             frames[i]->co[j],
398                                                             frames[k]->co[l]);
399
400                                                 copy_v3_v3(frames[i]->co[j], mid);
401                                                 copy_v3_v3(frames[k]->co[l], mid);
402
403                                                 frames[k]->merge[l].frame = frames[i];
404                                                 frames[k]->merge[l].corner = j;
405                                                 frames[i]->merge[j].is_target = true;
406
407                                                 /* Can't merge another corner into the same
408                                                  * frame corner, so move on to frame k+1 */
409                                                 break;
410                                         }
411                                 }
412                         }
413                 }
414         }
415 }
416
417 static Frame **collect_hull_frames(
418         int v, SkinNode *frames,
419         const MeshElemMap *emap, const MEdge *medge,
420         int *tothullframe)
421 {
422         SkinNode *f;
423         Frame **hull_frames;
424         int nbr, i;
425
426         (*tothullframe) = emap[v].count;
427         hull_frames = MEM_calloc_arrayN((*tothullframe), sizeof(Frame *),
428                                   "hull_from_frames.hull_frames");
429         i = 0;
430         for (nbr = 0; nbr < emap[v].count; nbr++) {
431                 const MEdge *e = &medge[emap[v].indices[nbr]];
432                 f = &frames[BKE_mesh_edge_other_vert(e, v)];
433                 /* Can't have adjacent branch nodes yet */
434                 if (f->totframe)
435                         hull_frames[i++] = &f->frames[0];
436                 else
437                         (*tothullframe)--;
438         }
439
440         return hull_frames;
441 }
442
443
444 /**************************** Create Frames ***************************/
445
446 static void node_frames_init(SkinNode *nf, int totframe)
447 {
448         int i;
449
450         nf->totframe = totframe;
451         memset(nf->frames, 0, sizeof(nf->frames));
452
453         nf->flag = 0;
454         for (i = 0; i < 2; i++)
455                 nf->seam_edges[i] = -1;
456 }
457
458 static void create_frame(
459         Frame *frame, const float co[3],
460         const float radius[2],
461         float mat[3][3], float offset)
462 {
463         float rx[3], ry[3], rz[3];
464         int i;
465
466         mul_v3_v3fl(ry, mat[1], radius[0]);
467         mul_v3_v3fl(rz, mat[2], radius[1]);
468
469         add_v3_v3v3(frame->co[3], co, ry);
470         add_v3_v3v3(frame->co[3], frame->co[3], rz);
471
472         sub_v3_v3v3(frame->co[2], co, ry);
473         add_v3_v3v3(frame->co[2], frame->co[2], rz);
474
475         sub_v3_v3v3(frame->co[1], co, ry);
476         sub_v3_v3v3(frame->co[1], frame->co[1], rz);
477
478         add_v3_v3v3(frame->co[0], co, ry);
479         sub_v3_v3v3(frame->co[0], frame->co[0], rz);
480
481         mul_v3_v3fl(rx, mat[0], offset);
482         for (i = 0; i < 4; i++)
483                 add_v3_v3v3(frame->co[i], frame->co[i], rx);
484 }
485
486 static float half_v2(const float v[2])
487 {
488         return (v[0] + v[1]) * 0.5f;
489 }
490
491 static void end_node_frames(
492         int v, SkinNode *skin_nodes, const MVert *mvert,
493         const MVertSkin *nodes, const MeshElemMap *emap,
494         EMat *emat)
495 {
496         const float *rad = nodes[v].radius;
497         float mat[3][3];
498
499         if (emap[v].count == 0) {
500                 float avg = half_v2(rad);
501
502                 /* For solitary nodes, just build a box (two frames) */
503                 node_frames_init(&skin_nodes[v], 2);
504                 skin_nodes[v].flag |= (CAP_START | CAP_END);
505
506                 /* Hardcoded basis */
507                 zero_m3(mat);
508                 mat[0][2] = mat[1][0] = mat[2][1] = 1;
509
510                 /* Caps */
511                 create_frame(&skin_nodes[v].frames[0], mvert[v].co, rad, mat, avg);
512                 create_frame(&skin_nodes[v].frames[1], mvert[v].co, rad, mat, -avg);
513         }
514         else {
515                 /* For nodes with an incoming edge, create a single (capped) frame */
516                 node_frames_init(&skin_nodes[v], 1);
517                 skin_nodes[v].flag |= CAP_START;
518
519                 /* Use incoming edge for orientation */
520                 copy_m3_m3(mat, emat[emap[v].indices[0]].mat);
521                 if (emat[emap[v].indices[0]].origin != v)
522                         negate_v3(mat[0]);
523
524                 /* End frame */
525                 create_frame(&skin_nodes[v].frames[0], mvert[v].co, rad, mat, 0);
526         }
527
528         if (nodes[v].flag & MVERT_SKIN_ROOT)
529                 skin_nodes[v].flag |= ROOT;
530 }
531
532 /* Returns 1 for seam, 0 otherwise */
533 static int connection_node_mat(float mat[3][3], int v, const MeshElemMap *emap, EMat *emat)
534 {
535         float axis[3], angle, ine[3][3], oute[3][3];
536         EMat *e1, *e2;
537
538         e1 = &emat[emap[v].indices[0]];
539         e2 = &emat[emap[v].indices[1]];
540
541         if (e1->origin != v && e2->origin == v) {
542                 copy_m3_m3(ine, e1->mat);
543                 copy_m3_m3(oute, e2->mat);
544         }
545         else if (e1->origin == v && e2->origin != v) {
546                 copy_m3_m3(ine, e2->mat);
547                 copy_m3_m3(oute, e1->mat);
548         }
549         else
550                 return 1;
551
552         /* Get axis and angle to rotate frame by */
553         angle = angle_normalized_v3v3(ine[0], oute[0]) / 2.0f;
554         cross_v3_v3v3(axis, ine[0], oute[0]);
555         normalize_v3(axis);
556
557         /* Build frame matrix (don't care about X axis here) */
558         copy_v3_v3(mat[0], ine[0]);
559         rotate_normalized_v3_v3v3fl(mat[1], ine[1], axis, angle);
560         rotate_normalized_v3_v3v3fl(mat[2], ine[2], axis, angle);
561
562         return 0;
563 }
564
565 static void connection_node_frames(
566         int v, SkinNode *skin_nodes, const MVert *mvert,
567         const MVertSkin *nodes, const MeshElemMap *emap,
568         EMat *emat)
569 {
570         const float *rad = nodes[v].radius;
571         float mat[3][3];
572         EMat *e1, *e2;
573
574         if (connection_node_mat(mat, v, emap, emat)) {
575                 float avg = half_v2(rad);
576
577                 /* Get edges */
578                 e1 = &emat[emap[v].indices[0]];
579                 e2 = &emat[emap[v].indices[1]];
580
581                 /* Handle seam separately to avoid twisting */
582                 /* Create two frames, will be hulled to neighbors later */
583                 node_frames_init(&skin_nodes[v], 2);
584                 skin_nodes[v].flag |= SEAM_FRAME;
585
586                 copy_m3_m3(mat, e1->mat);
587                 if (e1->origin != v) negate_v3(mat[0]);
588                 create_frame(&skin_nodes[v].frames[0], mvert[v].co, rad, mat, avg);
589                 skin_nodes[v].seam_edges[0] = emap[v].indices[0];
590
591                 copy_m3_m3(mat, e2->mat);
592                 if (e2->origin != v) negate_v3(mat[0]);
593                 create_frame(&skin_nodes[v].frames[1], mvert[v].co, rad, mat, avg);
594                 skin_nodes[v].seam_edges[1] = emap[v].indices[1];
595
596                 return;
597         }
598
599         /* Build regular frame */
600         node_frames_init(&skin_nodes[v], 1);
601         create_frame(&skin_nodes[v].frames[0], mvert[v].co, rad, mat, 0);
602 }
603
604 static SkinNode *build_frames(
605         const MVert *mvert, int totvert,
606         const MVertSkin *nodes, const MeshElemMap *emap,
607         EMat *emat)
608 {
609         SkinNode *skin_nodes;
610         int v;
611
612         skin_nodes = MEM_calloc_arrayN(totvert, sizeof(SkinNode), "build_frames.skin_nodes");
613
614         for (v = 0; v < totvert; v++) {
615                 if (emap[v].count <= 1)
616                         end_node_frames(v, skin_nodes, mvert, nodes, emap, emat);
617                 else if (emap[v].count == 2)
618                         connection_node_frames(v, skin_nodes, mvert, nodes, emap, emat);
619                 else {
620                         /* Branch node generates no frames */
621                 }
622         }
623
624         return skin_nodes;
625 }
626
627 /**************************** Edge Matrices ***************************/
628
629 static void calc_edge_mat(float mat[3][3], const float a[3], const float b[3])
630 {
631         const float z_up[3] = {0, 0, 1};
632         float dot;
633
634         /* X = edge direction */
635         sub_v3_v3v3(mat[0], b, a);
636         normalize_v3(mat[0]);
637
638         dot = dot_v3v3(mat[0], z_up);
639         if (dot > -1 + FLT_EPSILON && dot < 1 - FLT_EPSILON) {
640                 /* Y = Z cross x */
641                 cross_v3_v3v3(mat[1], z_up, mat[0]);
642                 normalize_v3(mat[1]);
643
644                 /* Z = x cross y */
645                 cross_v3_v3v3(mat[2], mat[0], mat[1]);
646                 normalize_v3(mat[2]);
647         }
648         else {
649                 mat[1][0] = 1;
650                 mat[1][1] = 0;
651                 mat[1][2] = 0;
652                 mat[2][0] = 0;
653                 mat[2][1] = 1;
654                 mat[2][2] = 0;
655         }
656 }
657
658 typedef struct {
659         float mat[3][3];
660         int parent_v;
661         int e;
662 } EdgeStackElem;
663
664 static void build_emats_stack(
665         BLI_Stack *stack, BLI_bitmap *visited_e, EMat *emat,
666         const MeshElemMap *emap, const MEdge *medge,
667         const MVertSkin *vs, const MVert *mvert)
668 {
669         EdgeStackElem stack_elem;
670         float axis[3], angle;
671         int i, e, v, parent_v, parent_is_branch;
672
673         BLI_stack_pop(stack, &stack_elem);
674         parent_v = stack_elem.parent_v;
675         e = stack_elem.e;
676
677         /* Skip if edge already visited */
678         if (BLI_BITMAP_TEST(visited_e, e))
679                 return;
680
681         /* Mark edge as visited */
682         BLI_BITMAP_ENABLE(visited_e, e);
683
684         /* Process edge */
685
686         parent_is_branch = ((emap[parent_v].count > 2) ||
687                             (vs[parent_v].flag & MVERT_SKIN_ROOT));
688
689         v = BKE_mesh_edge_other_vert(&medge[e], parent_v);
690         emat[e].origin = parent_v;
691
692         /* If parent is a branch node, start a new edge chain */
693         if (parent_is_branch) {
694                 calc_edge_mat(emat[e].mat, mvert[parent_v].co,
695                               mvert[v].co);
696         }
697         else {
698                 /* Build edge matrix guided by parent matrix */
699                 sub_v3_v3v3(emat[e].mat[0], mvert[v].co, mvert[parent_v].co);
700                 normalize_v3(emat[e].mat[0]);
701                 angle = angle_normalized_v3v3(stack_elem.mat[0], emat[e].mat[0]);
702                 cross_v3_v3v3(axis, stack_elem.mat[0], emat[e].mat[0]);
703                 normalize_v3(axis);
704                 rotate_normalized_v3_v3v3fl(emat[e].mat[1], stack_elem.mat[1], axis, angle);
705                 rotate_normalized_v3_v3v3fl(emat[e].mat[2], stack_elem.mat[2], axis, angle);
706         }
707
708         /* Add neighbors to stack */
709         for (i = 0; i < emap[v].count; i++) {
710                 /* Add neighbors to stack */
711                 copy_m3_m3(stack_elem.mat, emat[e].mat);
712                 stack_elem.e = emap[v].indices[i];
713                 stack_elem.parent_v = v;
714                 BLI_stack_push(stack, &stack_elem);
715         }
716 }
717
718 static EMat *build_edge_mats(
719         const MVertSkin *vs,
720         const MVert *mvert,
721         int totvert,
722         const MEdge *medge,
723         const MeshElemMap *emap,
724         int totedge,
725         bool *has_valid_root)
726 {
727         BLI_Stack *stack;
728         EMat *emat;
729         EdgeStackElem stack_elem;
730         BLI_bitmap *visited_e;
731         int i, v;
732
733         stack = BLI_stack_new(sizeof(stack_elem), "build_edge_mats.stack");
734
735         visited_e = BLI_BITMAP_NEW(totedge, "build_edge_mats.visited_e");
736         emat = MEM_calloc_arrayN(totedge, sizeof(EMat), "build_edge_mats.emat");
737
738         /* Edge matrices are built from the root nodes, add all roots with
739          * children to the stack */
740         for (v = 0; v < totvert; v++) {
741                 if (vs[v].flag & MVERT_SKIN_ROOT) {
742                         if (emap[v].count >= 1) {
743                                 const MEdge *e = &medge[emap[v].indices[0]];
744                                 calc_edge_mat(stack_elem.mat, mvert[v].co,
745                                               mvert[BKE_mesh_edge_other_vert(e, v)].co);
746                                 stack_elem.parent_v = v;
747
748                                 /* Add adjacent edges to stack */
749                                 for (i = 0; i < emap[v].count; i++) {
750                                         stack_elem.e = emap[v].indices[i];
751                                         BLI_stack_push(stack, &stack_elem);
752                                 }
753
754                                 *has_valid_root = true;
755                         }
756                 }
757         }
758
759         while (!BLI_stack_is_empty(stack)) {
760                 build_emats_stack(stack, visited_e, emat, emap, medge, vs, mvert);
761         }
762
763         MEM_freeN(visited_e);
764         BLI_stack_free(stack);
765
766         return emat;
767 }
768
769
770 /************************** Input Subdivision *************************/
771
772 /* Returns number of edge subdivisions, taking into account the radius
773  * of the endpoints and the edge length. If both endpoints are branch
774  * nodes, at least two intermediate frames are required. (This avoids
775  * having any special cases for dealing with sharing a frame between
776  * two hulls.) */
777 static int calc_edge_subdivisions(
778         const MVert *mvert, const MVertSkin *nodes,
779         const MEdge *e, const int *degree)
780 {
781         /* prevent memory errors [#38003] */
782 #define NUM_SUBDIVISIONS_MAX 128
783
784         const MVertSkin *evs[2] = {&nodes[e->v1], &nodes[e->v2]};
785         float avg_radius;
786         const bool v1_branch = degree[e->v1] > 2;
787         const bool v2_branch = degree[e->v2] > 2;
788         int num_subdivisions;
789
790         /* If either end is a branch node marked 'loose', don't subdivide
791          * the edge (or subdivide just twice if both are branches) */
792         if ((v1_branch && (evs[0]->flag & MVERT_SKIN_LOOSE)) ||
793             (v2_branch && (evs[1]->flag & MVERT_SKIN_LOOSE)))
794         {
795                 if (v1_branch && v2_branch)
796                         return 2;
797                 else
798                         return 0;
799         }
800
801         avg_radius = half_v2(evs[0]->radius) + half_v2(evs[1]->radius);
802
803         if (avg_radius != 0.0f) {
804                 /* possible (but unlikely) that we overflow INT_MAX */
805                 float num_subdivisions_fl;
806                 const float edge_len = len_v3v3(mvert[e->v1].co, mvert[e->v2].co);
807                 num_subdivisions_fl = (edge_len / avg_radius);
808                 if (num_subdivisions_fl < NUM_SUBDIVISIONS_MAX) {
809                         num_subdivisions = (int)num_subdivisions_fl;
810                 }
811                 else {
812                         num_subdivisions = NUM_SUBDIVISIONS_MAX;
813                 }
814         }
815         else {
816                 num_subdivisions = 0;
817         }
818
819         /* If both ends are branch nodes, two intermediate nodes are
820          * required */
821         if (num_subdivisions < 2 && v1_branch && v2_branch)
822                 num_subdivisions = 2;
823
824         return num_subdivisions;
825
826 #undef NUM_SUBDIVISIONS_MAX
827 }
828
829 /* Take a Mesh and subdivide its edges to keep skin nodes
830  * reasonably close. */
831 static Mesh *subdivide_base(Mesh *orig)
832 {
833         Mesh *result;
834         MVertSkin *orignode, *outnode;
835         MVert *origvert, *outvert;
836         MEdge *origedge, *outedge, *e;
837         MDeformVert *origdvert, *outdvert;
838         int totorigvert, totorigedge;
839         int totsubd, *degree, *edge_subd;
840         int i, j, k, u, v;
841         float radrat;
842
843         orignode = CustomData_get_layer(&orig->vdata, CD_MVERT_SKIN);
844         origvert = orig->mvert;
845         origedge = orig->medge;
846         origdvert = orig->dvert;
847         totorigvert = orig->totvert;
848         totorigedge = orig->totedge;
849
850         /* Get degree of all vertices */
851         degree = MEM_calloc_arrayN(totorigvert, sizeof(int), "degree");
852         for (i = 0; i < totorigedge; i++) {
853                 degree[origedge[i].v1]++;
854                 degree[origedge[i].v2]++;
855         }
856
857         /* Per edge, store how many subdivisions are needed */
858         edge_subd = MEM_calloc_arrayN(totorigedge, sizeof(int), "edge_subd");
859         for (i = 0, totsubd = 0; i < totorigedge; i++) {
860                 edge_subd[i] += calc_edge_subdivisions(origvert, orignode,
861                                                        &origedge[i], degree);
862                 BLI_assert(edge_subd[i] >= 0);
863                 totsubd += edge_subd[i];
864         }
865
866         MEM_freeN(degree);
867
868         /* Allocate output mesh */
869         result = BKE_mesh_new_nomain_from_template(
870                 orig,
871                 totorigvert + totsubd,
872                 totorigedge + totsubd,
873                 0, 0, 0);
874
875         outvert = result->mvert;
876         outedge = result->medge;
877         outnode = CustomData_get_layer(&result->vdata, CD_MVERT_SKIN);
878         outdvert = result->dvert;
879
880         /* Copy original vertex data */
881         CustomData_copy_data(&orig->vdata,
882                              &result->vdata,
883                              0, 0, totorigvert);
884
885         /* Subdivide edges */
886         for (i = 0, v = totorigvert; i < totorigedge; i++) {
887                 struct {
888                         /* Vertex group number */
889                         int def_nr;
890                         float w1, w2;
891                 } *vgroups = NULL, *vg;
892                 int totvgroup = 0;
893
894                 e = &origedge[i];
895
896                 if (origdvert) {
897                         const MDeformVert *dv1 = &origdvert[e->v1];
898                         const MDeformVert *dv2 = &origdvert[e->v2];
899                         vgroups = MEM_calloc_arrayN(dv1->totweight, sizeof(*vgroups), "vgroup");
900
901                         /* Only want vertex groups used by both vertices */
902                         for (j = 0; j < dv1->totweight; j++) {
903                                 vg = NULL;
904                                 for (k = 0; k < dv2->totweight; k++) {
905                                         if (dv1->dw[j].def_nr == dv2->dw[k].def_nr) {
906                                                 vg = &vgroups[totvgroup];
907                                                 totvgroup++;
908                                                 break;
909                                         }
910                                 }
911
912                                 if (vg) {
913                                         vg->def_nr = dv1->dw[j].def_nr;
914                                         vg->w1 = dv1->dw[j].weight;
915                                         vg->w2 = dv2->dw[k].weight;
916                                 }
917                         }
918                 }
919
920                 u = e->v1;
921                 radrat = (half_v2(outnode[e->v2].radius) /
922                           half_v2(outnode[e->v1].radius));
923                 radrat = (radrat + 1) / 2;
924
925                 /* Add vertices and edge segments */
926                 for (j = 0; j < edge_subd[i]; j++, v++, outedge++) {
927                         float r = (j + 1) / (float)(edge_subd[i] + 1);
928                         float t = powf(r, radrat);
929
930                         /* Interpolate vertex coord */
931                         interp_v3_v3v3(outvert[v].co, outvert[e->v1].co,
932                                        outvert[e->v2].co, t);
933
934                         /* Interpolate skin radii */
935                         interp_v3_v3v3(outnode[v].radius,
936                                        orignode[e->v1].radius,
937                                        orignode[e->v2].radius, t);
938
939                         /* Interpolate vertex group weights */
940                         for (k = 0; k < totvgroup; k++) {
941                                 float weight;
942
943                                 vg = &vgroups[k];
944                                 weight = interpf(vg->w2, vg->w1, t);
945
946                                 if (weight > 0)
947                                         defvert_add_index_notest(&outdvert[v], vg->def_nr, weight);
948                         }
949
950                         outedge->v1 = u;
951                         outedge->v2 = v;
952                         u = v;
953                 }
954
955                 if (vgroups)
956                         MEM_freeN(vgroups);
957
958                 /* Link up to final vertex */
959                 outedge->v1 = u;
960                 outedge->v2 = e->v2;
961                 outedge++;
962         }
963
964         MEM_freeN(edge_subd);
965
966         return result;
967 }
968
969 /******************************* Output *******************************/
970
971 /* Can be either quad or triangle */
972 static void add_poly(
973         SkinOutput *so,
974         BMVert *v1,
975         BMVert *v2,
976         BMVert *v3,
977         BMVert *v4)
978 {
979         BMVert *verts[4] = {v1, v2, v3, v4};
980         BMFace *f;
981
982         BLI_assert(v1 != v2 && v1 != v3 && v1 != v4);
983         BLI_assert(v2 != v3 && v2 != v4);
984         BLI_assert(v3 != v4);
985         BLI_assert(v1 && v2 && v3);
986
987         f = BM_face_create_verts(so->bm, verts, v4 ? 4 : 3, NULL, BM_CREATE_NO_DOUBLE, true);
988         BM_face_normal_update(f);
989         if (so->smd->flag & MOD_SKIN_SMOOTH_SHADING)
990                 BM_elem_flag_enable(f, BM_ELEM_SMOOTH);
991         f->mat_nr = so->mat_nr;
992 }
993
994 static void connect_frames(
995         SkinOutput *so,
996         BMVert *frame1[4],
997         BMVert *frame2[4])
998 {
999         BMVert *q[4][4] = {{frame2[0], frame2[1], frame1[1], frame1[0]},
1000                            {frame2[1], frame2[2], frame1[2], frame1[1]},
1001                            {frame2[2], frame2[3], frame1[3], frame1[2]},
1002                            {frame2[3], frame2[0], frame1[0], frame1[3]}};
1003         int i;
1004         bool swap;
1005
1006         /* Check if frame normals need swap */
1007 #if 0
1008         {
1009                 /* simple method, works mostly */
1010                 float p[3], no[3];
1011                 sub_v3_v3v3(p, q[3][0]->co, q[0][0]->co);
1012                 normal_quad_v3(no,
1013                         q[0][0]->co, q[0][1]->co,
1014                         q[0][2]->co, q[0][3]->co);
1015                 swap = dot_v3v3(no, p) > 0;
1016         }
1017 #else
1018         {
1019                 /* comprehensive method, accumulate flipping of all faces */
1020                 float cent_sides[4][3];
1021                 float cent[3];
1022                 float dot = 0.0f;
1023
1024                 for (i = 0; i < 4; i++) {
1025                         mid_v3_v3v3v3v3(cent_sides[i], UNPACK4_EX(, q[i], ->co));
1026                 }
1027                 mid_v3_v3v3v3v3(cent, UNPACK4(cent_sides));
1028
1029                 for (i = 0; i < 4; i++) {
1030                         float p[3], no[3];
1031                         normal_quad_v3(no, UNPACK4_EX(, q[i], ->co));
1032                         sub_v3_v3v3(p, cent, cent_sides[i]);
1033                         dot += dot_v3v3(no, p);
1034                 }
1035
1036                 swap = dot > 0;
1037         }
1038 #endif
1039
1040         for (i = 0; i < 4; i++) {
1041                 if (swap)
1042                         add_poly(so, q[i][3], q[i][2], q[i][1], q[i][0]);
1043                 else
1044                         add_poly(so, q[i][0], q[i][1], q[i][2], q[i][3]);
1045         }
1046 }
1047
1048 static void output_frames(
1049         BMesh *bm,
1050         SkinNode *sn,
1051         const MDeformVert *input_dvert)
1052 {
1053         Frame *f;
1054         int i, j;
1055
1056         /* Output all frame verts */
1057         for (i = 0; i < sn->totframe; i++) {
1058                 f = &sn->frames[i];
1059                 for (j = 0; j < 4; j++) {
1060                         if (!f->merge[j].frame) {
1061                                 BMVert *v = f->verts[j] = BM_vert_create(bm, f->co[j], NULL, BM_CREATE_NOP);
1062
1063                                 if (input_dvert) {
1064                                         MDeformVert *dv;
1065                                         dv = CustomData_bmesh_get(&bm->vdata,
1066                                                                   v->head.data,
1067                                                                   CD_MDEFORMVERT);
1068
1069                                         BLI_assert(dv->totweight == 0);
1070                                         defvert_copy(dv, input_dvert);
1071                                 }
1072                         }
1073                 }
1074         }
1075 }
1076
1077 #define PRINT_HOLE_INFO 0
1078
1079 static void calc_frame_center(float center[3], const Frame *frame)
1080 {
1081         add_v3_v3v3(center, frame->verts[0]->co, frame->verts[1]->co);
1082         add_v3_v3(center, frame->verts[2]->co);
1083         add_v3_v3(center, frame->verts[3]->co);
1084         mul_v3_fl(center, 0.25f);
1085 }
1086
1087 /* Does crappy fan triangulation of poly, may not be so accurate for
1088  * concave faces */
1089 static int isect_ray_poly(const float ray_start[3],
1090                           const float ray_dir[3],
1091                           BMFace *f,
1092                           float *r_lambda)
1093 {
1094         BMVert *v, *v_first = NULL, *v_prev = NULL;
1095         BMIter iter;
1096         float best_dist = FLT_MAX;
1097         bool hit = false;
1098
1099         BM_ITER_ELEM (v, &iter, f, BM_VERTS_OF_FACE) {
1100                 if (!v_first)
1101                         v_first = v;
1102                 else if (v_prev != v_first) {
1103                         float dist;
1104                         bool curhit;
1105
1106                         curhit = isect_ray_tri_v3(ray_start, ray_dir,
1107                                                   v_first->co, v_prev->co, v->co,
1108                                                   &dist, NULL);
1109                         if (curhit && dist < best_dist) {
1110                                 hit = true;
1111                                 best_dist = dist;
1112                         }
1113                 }
1114
1115                 v_prev = v;
1116         }
1117
1118         *r_lambda = best_dist;
1119         return hit;
1120 }
1121
1122 /* Reduce the face down to 'n' corners by collapsing the edges;
1123  * returns the new face.
1124  *
1125  * The orig_verts should contain the vertices of 'f'
1126  */
1127 static BMFace *collapse_face_corners(BMesh *bm, BMFace *f, int n,
1128                                      BMVert **orig_verts)
1129 {
1130         int orig_len = f->len;
1131
1132         BLI_assert(n >= 3);
1133         BLI_assert(f->len > n);
1134         if (f->len <= n)
1135                 return f;
1136
1137         /* Collapse shortest edge for now */
1138         while (f->len > n) {
1139                 BMFace *vf;
1140                 BMEdge *shortest_edge;
1141                 BMVert *v_safe, *v_merge;
1142                 BMOperator op;
1143                 BMIter iter;
1144                 int i;
1145                 BMOpSlot *slot_targetmap;
1146
1147                 shortest_edge = BM_face_find_shortest_loop(f)->e;
1148                 BMO_op_initf(bm, &op, (BMO_FLAG_DEFAULTS & ~BMO_FLAG_RESPECT_HIDE), "weld_verts");
1149
1150                 slot_targetmap = BMO_slot_get(op.slots_in, "targetmap");
1151
1152                 /* Note: could probably calculate merges in one go to be
1153                  * faster */
1154
1155                 v_safe = shortest_edge->v1;
1156                 v_merge = shortest_edge->v2;
1157                 mid_v3_v3v3(v_safe->co, v_safe->co, v_merge->co);
1158                 BMO_slot_map_elem_insert(&op, slot_targetmap, v_merge, v_safe);
1159                 BMO_op_exec(bm, &op);
1160                 BMO_op_finish(bm, &op);
1161
1162                 /* Find the new face */
1163                 f = NULL;
1164                 BM_ITER_ELEM (vf, &iter, v_safe, BM_FACES_OF_VERT) {
1165                         bool wrong_face = false;
1166
1167                         for (i = 0; i < orig_len; i++) {
1168                                 if (orig_verts[i] == v_merge) {
1169                                         orig_verts[i] = NULL;
1170                                 }
1171                                 else if (orig_verts[i] &&
1172                                          !BM_vert_in_face(orig_verts[i], vf))
1173                                 {
1174                                         wrong_face = true;
1175                                         break;
1176                                 }
1177                         }
1178
1179                         if (!wrong_face) {
1180                                 f = vf;
1181                                 break;
1182                         }
1183                 }
1184
1185                 BLI_assert(f);
1186         }
1187
1188         return f;
1189 }
1190
1191 /* Choose a good face to merge the frame with, used in case the frame
1192  * is completely inside the hull. */
1193 static BMFace *skin_hole_target_face(BMesh *bm, Frame *frame)
1194 {
1195         BMFace *f, *isect_target_face, *center_target_face;
1196         BMIter iter;
1197         float frame_center[3];
1198         float frame_normal[3];
1199         float best_isect_dist = FLT_MAX;
1200         float best_center_dist = FLT_MAX;
1201
1202         calc_frame_center(frame_center, frame);
1203         normal_quad_v3(frame_normal, frame->verts[3]->co,
1204                        frame->verts[2]->co, frame->verts[1]->co,
1205                        frame->verts[0]->co);
1206
1207         /* Use a line intersection test and nearest center test against
1208          * all faces */
1209         isect_target_face = center_target_face = NULL;
1210         BM_ITER_MESH (f, &iter, bm, BM_FACES_OF_MESH) {
1211                 float dist, poly_center[3];
1212                 int hit;
1213
1214                 /* Intersection test */
1215                 hit = isect_ray_poly(frame_center, frame_normal, f, &dist);
1216                 if (hit && dist < best_isect_dist) {
1217                         isect_target_face = f;
1218                         best_isect_dist = dist;
1219                 }
1220
1221                 /* Nearest test */
1222                 BM_face_calc_center_mean(f, poly_center);
1223                 dist = len_v3v3(frame_center, poly_center);
1224                 if (dist < best_center_dist) {
1225                         center_target_face = f;
1226                         best_center_dist = dist;
1227                 }
1228         }
1229
1230         f = isect_target_face;
1231         if (!f || best_center_dist < best_isect_dist / 2)
1232                 f = center_target_face;
1233
1234         /* This case is unlikely now, but could still happen. Should look
1235          * into splitting edges to make new faces. */
1236 #if PRINT_HOLE_INFO
1237         if (!f) {
1238                 printf("no good face found\n");
1239         }
1240 #endif
1241
1242         return f;
1243 }
1244
1245 /* Use edge-length heuristic to choose from eight possible polygon bridges */
1246 static void skin_choose_quad_bridge_order(BMVert *a[4], BMVert *b[4],
1247                                           int best_order[4])
1248 {
1249         int orders[8][4];
1250         float shortest_len;
1251         int i, j;
1252
1253         /* Enumerate all valid orderings */
1254         for (i = 0; i < 4; i++) {
1255                 for (j = 0; j < 4; j++) {
1256                         orders[i][j] = (j + i) % 4;
1257                         orders[i + 4][j] = 3 - ((j + i) % 4);
1258                 }
1259         }
1260
1261         shortest_len = FLT_MAX;
1262         for (i = 0; i < 8; i++) {
1263                 float len = 0;
1264
1265                 /* Get total edge length for this configuration */
1266                 for (j = 0; j < 4; j++)
1267                         len += len_squared_v3v3(a[j]->co, b[orders[i][j]]->co);
1268
1269                 if (len < shortest_len) {
1270                         shortest_len = len;
1271                         memcpy(best_order, orders[i], sizeof(int) * 4);
1272                 }
1273         }
1274 }
1275
1276 static void skin_fix_hole_no_good_verts(BMesh *bm, Frame *frame, BMFace *split_face)
1277 {
1278         BMFace *f;
1279         BMVert *verts[4];
1280         BMVert **vert_buf = NULL;
1281         BLI_array_declare(vert_buf);
1282         BMOIter oiter;
1283         BMOperator op;
1284         int i, best_order[4];
1285         BMOpSlot *slot_targetmap;
1286
1287         BLI_assert(split_face->len >= 3);
1288
1289         /* Extrude the split face */
1290         BM_mesh_elem_hflag_disable_all(bm, BM_FACE, BM_ELEM_TAG, false);
1291         BM_elem_flag_enable(split_face, BM_ELEM_TAG);
1292         BMO_op_initf(bm, &op, (BMO_FLAG_DEFAULTS & ~BMO_FLAG_RESPECT_HIDE),
1293                      "extrude_discrete_faces faces=%hf", BM_ELEM_TAG);
1294         BMO_op_exec(bm, &op);
1295
1296         /* Update split face (should only be one new face created
1297          * during extrusion) */
1298         split_face = NULL;
1299         BMO_ITER (f, &oiter, op.slots_out, "faces.out", BM_FACE) {
1300                 BLI_assert(!split_face);
1301                 split_face = f;
1302         }
1303
1304         BMO_op_finish(bm, &op);
1305
1306         if (split_face->len == 3) {
1307                 BMEdge *longest_edge;
1308
1309                 /* Need at least four ring edges, so subdivide longest edge if
1310                  * face is a triangle */
1311                 longest_edge = BM_face_find_longest_loop(split_face)->e;
1312
1313                 BM_mesh_elem_hflag_disable_all(bm, BM_EDGE, BM_ELEM_TAG, false);
1314                 BM_elem_flag_enable(longest_edge, BM_ELEM_TAG);
1315
1316                 BMO_op_callf(bm, BMO_FLAG_DEFAULTS,
1317                              "subdivide_edges edges=%he cuts=%i quad_corner_type=%i",
1318                              BM_ELEM_TAG, 1, SUBD_CORNER_STRAIGHT_CUT);
1319         }
1320         else if (split_face->len > 4) {
1321                 /* Maintain a dynamic vert array containing the split_face's
1322                  * vertices, avoids frequent allocs in collapse_face_corners() */
1323                 if (BLI_array_len(vert_buf) < split_face->len) {
1324                         BLI_array_grow_items(vert_buf, (split_face->len -
1325                                                         BLI_array_len(vert_buf)));
1326                 }
1327
1328                 /* Get split face's verts */
1329                 BM_iter_as_array(bm, BM_VERTS_OF_FACE, split_face,
1330                                  (void **)vert_buf, split_face->len);
1331
1332                 /* Earlier edge split operations may have turned some quads
1333                  * into higher-degree faces */
1334                 split_face = collapse_face_corners(bm, split_face, 4, vert_buf);
1335         }
1336
1337         /* Done with dynamic array, split_face must now be a quad */
1338         BLI_array_free(vert_buf);
1339         BLI_assert(split_face->len == 4);
1340         if (split_face->len != 4)
1341                 return;
1342
1343         /* Get split face's verts */
1344         // BM_iter_as_array(bm, BM_VERTS_OF_FACE, split_face, (void **)verts, 4);
1345         BM_face_as_array_vert_quad(split_face, verts);
1346         skin_choose_quad_bridge_order(verts, frame->verts, best_order);
1347
1348         /* Delete split face and merge */
1349         BM_face_kill(bm, split_face);
1350         BMO_op_init(bm, &op, (BMO_FLAG_DEFAULTS & ~BMO_FLAG_RESPECT_HIDE),
1351                     "weld_verts");
1352         slot_targetmap = BMO_slot_get(op.slots_in, "targetmap");
1353         for (i = 0; i < 4; i++) {
1354                 BMO_slot_map_elem_insert(&op, slot_targetmap, verts[i], frame->verts[best_order[i]]);
1355         }
1356         BMO_op_exec(bm, &op);
1357         BMO_op_finish(bm, &op);
1358 }
1359
1360 /* If the frame has some vertices that are inside the hull (detached)
1361  * and some attached, duplicate the attached vertices and take the
1362  * whole frame off the hull. */
1363 static void skin_hole_detach_partially_attached_frame(BMesh *bm, Frame *frame)
1364 {
1365         int i, attached[4], totattached = 0;
1366
1367         /* Get/count attached frame corners */
1368         for (i = 0; i < 4; i++) {
1369                 if (!frame->inside_hull[i])
1370                         attached[totattached++] = i;
1371         }
1372
1373         /* Detach everything */
1374         for (i = 0; i < totattached; i++) {
1375                 BMVert **av = &frame->verts[attached[i]];
1376                 (*av) = BM_vert_create(bm, (*av)->co, *av, BM_CREATE_NOP);
1377         }
1378 }
1379
1380
1381 static void quad_from_tris(BMEdge *e, BMFace *adj[2], BMVert *ndx[4])
1382 {
1383         BMVert *tri[2][3];
1384         BMVert *opp = NULL;
1385         int i, j;
1386
1387         BLI_assert(adj[0]->len == 3 && adj[1]->len == 3);
1388
1389 #if 0
1390         BM_iter_as_array(bm, BM_VERTS_OF_FACE, adj[0], (void **)tri[0], 3);
1391         BM_iter_as_array(bm, BM_VERTS_OF_FACE, adj[1], (void **)tri[1], 3);
1392 #else
1393         BM_face_as_array_vert_tri(adj[0], tri[0]);
1394         BM_face_as_array_vert_tri(adj[1], tri[1]);
1395 #endif
1396
1397         /* Find what the second tri has that the first doesn't */
1398         for (i = 0; i < 3; i++) {
1399                 if (tri[1][i] != tri[0][0] &&
1400                     tri[1][i] != tri[0][1] &&
1401                     tri[1][i] != tri[0][2])
1402                 {
1403                         opp = tri[1][i];
1404                         break;
1405                 }
1406         }
1407         BLI_assert(opp);
1408
1409         for (i = 0, j = 0; i < 3; i++, j++) {
1410                 ndx[j] = tri[0][i];
1411                 /* When the triangle edge cuts across our quad-to-be,
1412                  * throw in the second triangle's vertex */
1413                 if ((tri[0][i] == e->v1 || tri[0][i] == e->v2) &&
1414                     (tri[0][(i + 1) % 3] == e->v1 || tri[0][(i + 1) % 3] == e->v2))
1415                 {
1416                         j++;
1417                         ndx[j] = opp;
1418                 }
1419         }
1420 }
1421
1422 static void add_quad_from_tris(SkinOutput *so, BMEdge *e, BMFace *adj[2])
1423 {
1424         BMVert *quad[4];
1425
1426         quad_from_tris(e, adj, quad);
1427
1428         add_poly(so, quad[0], quad[1], quad[2], quad[3]);
1429 }
1430
1431 static void hull_merge_triangles(SkinOutput *so, const SkinModifierData *smd)
1432 {
1433         BMIter iter;
1434         BMEdge *e;
1435         HeapSimple *heap;
1436         float score;
1437
1438         heap = BLI_heapsimple_new();
1439
1440         BM_mesh_elem_hflag_disable_all(so->bm, BM_FACE, BM_ELEM_TAG, false);
1441
1442         /* Build heap */
1443         BM_ITER_MESH (e, &iter, so->bm, BM_EDGES_OF_MESH) {
1444                 BMFace *adj[2];
1445
1446                 /* Only care if the edge is used by exactly two triangles */
1447                 if (BM_edge_face_pair(e, &adj[0], &adj[1])) {
1448                         if (adj[0]->len == 3 && adj[1]->len == 3) {
1449                                 BMVert *quad[4];
1450
1451                                 BLI_assert(BM_face_is_normal_valid(adj[0]));
1452                                 BLI_assert(BM_face_is_normal_valid(adj[1]));
1453
1454                                 /* Construct quad using the two triangles adjacent to
1455                                  * the edge */
1456                                 quad_from_tris(e, adj, quad);
1457
1458                                 /* Calculate a score for the quad, higher score for
1459                                  * triangles being closer to coplanar */
1460                                 score = ((BM_face_calc_area(adj[0]) +
1461                                           BM_face_calc_area(adj[1])) *
1462                                          dot_v3v3(adj[0]->no, adj[1]->no));
1463
1464                                 /* Check if quad crosses the axis of symmetry */
1465                                 if (quad_crosses_symmetry_plane(quad, smd)) {
1466                                         /* Increase score if the triangles form a
1467                                          * symmetric quad, otherwise don't use it */
1468                                         if (is_quad_symmetric(quad, smd))
1469                                                 score *= 10;
1470                                         else
1471                                                 continue;
1472                                 }
1473
1474                                 /* Don't use the quad if it's concave */
1475                                 if (!is_quad_convex_v3(quad[0]->co, quad[1]->co,
1476                                                        quad[2]->co, quad[3]->co))
1477                                 {
1478                                         continue;
1479                                 }
1480
1481                                 BLI_heapsimple_insert(heap, -score, e);
1482                         }
1483                 }
1484         }
1485
1486         while (!BLI_heapsimple_is_empty(heap)) {
1487                 BMFace *adj[2];
1488
1489                 e = BLI_heapsimple_pop_min(heap);
1490
1491                 if (BM_edge_face_pair(e, &adj[0], &adj[1])) {
1492                         /* If both triangles still free, and if they don't already
1493                          * share a border with another face, output as a quad */
1494                         if (!BM_elem_flag_test(adj[0], BM_ELEM_TAG) &&
1495                             !BM_elem_flag_test(adj[1], BM_ELEM_TAG) &&
1496                             !BM_face_share_face_check(adj[0], adj[1]))
1497                         {
1498                                 add_quad_from_tris(so, e, adj);
1499                                 BM_elem_flag_enable(adj[0], BM_ELEM_TAG);
1500                                 BM_elem_flag_enable(adj[1], BM_ELEM_TAG);
1501                                 BM_elem_flag_enable(e, BM_ELEM_TAG);
1502                         }
1503                 }
1504         }
1505
1506         BLI_heapsimple_free(heap, NULL);
1507
1508         BM_mesh_delete_hflag_tagged(so->bm, BM_ELEM_TAG, BM_EDGE | BM_FACE);
1509
1510 }
1511
1512 static void skin_merge_close_frame_verts(SkinNode *skin_nodes, int totvert,
1513                                          const MeshElemMap *emap,
1514                                          const MEdge *medge)
1515 {
1516         Frame **hull_frames;
1517         int v, tothullframe;
1518
1519         for (v = 0; v < totvert; v++) {
1520                 /* Only check branch nodes */
1521                 if (!skin_nodes[v].totframe) {
1522                         hull_frames = collect_hull_frames(v, skin_nodes,
1523                                                           emap, medge,
1524                                                           &tothullframe);
1525                         merge_frame_corners(hull_frames, tothullframe);
1526                         MEM_freeN(hull_frames);
1527                 }
1528         }
1529 }
1530
1531 static void skin_update_merged_vertices(SkinNode *skin_nodes, int totvert)
1532 {
1533         int v;
1534
1535         for (v = 0; v < totvert; ++v) {
1536                 SkinNode *sn = &skin_nodes[v];
1537                 int i, j;
1538
1539                 for (i = 0; i < sn->totframe; i++) {
1540                         Frame *f = &sn->frames[i];
1541
1542                         for (j = 0; j < 4; j++) {
1543                                 if (f->merge[j].frame) {
1544                                         /* Merge chaining not allowed */
1545                                         BLI_assert(!f->merge[j].frame->merge[f->merge[j].corner].frame);
1546
1547                                         f->verts[j] = f->merge[j].frame->verts[f->merge[j].corner];
1548                                 }
1549                         }
1550                 }
1551         }
1552 }
1553
1554 static void skin_fix_hull_topology(BMesh *bm, SkinNode *skin_nodes,
1555                                    int totvert)
1556 {
1557         int v;
1558
1559         for (v = 0; v < totvert; v++) {
1560                 SkinNode *sn = &skin_nodes[v];
1561                 int j;
1562
1563                 for (j = 0; j < sn->totframe; j++) {
1564                         Frame *f = &sn->frames[j];
1565
1566                         if (f->detached) {
1567                                 BMFace *target_face;
1568
1569                                 skin_hole_detach_partially_attached_frame(bm, f);
1570
1571                                 target_face = skin_hole_target_face(bm, f);
1572                                 if (target_face)
1573                                         skin_fix_hole_no_good_verts(bm, f, target_face);
1574                         }
1575                 }
1576         }
1577 }
1578
1579 static void skin_output_end_nodes(SkinOutput *so, SkinNode *skin_nodes,
1580                                   int totvert)
1581 {
1582         int v;
1583
1584         for (v = 0; v < totvert; ++v) {
1585                 SkinNode *sn = &skin_nodes[v];
1586                 /* Assuming here just two frames */
1587                 if (sn->flag & SEAM_FRAME) {
1588                         BMVert *v_order[4];
1589                         int i, order[4];
1590
1591                         skin_choose_quad_bridge_order(sn->frames[0].verts,
1592                                                       sn->frames[1].verts,
1593                                                       order);
1594                         for (i = 0; i < 4; i++)
1595                                 v_order[i] = sn->frames[1].verts[order[i]];
1596                         connect_frames(so, sn->frames[0].verts, v_order);
1597                 }
1598                 else if (sn->totframe == 2) {
1599                         connect_frames(so,
1600                                        sn->frames[0].verts,
1601                                        sn->frames[1].verts);
1602                 }
1603
1604                 if (sn->flag & CAP_START) {
1605                         if (sn->flag & ROOT) {
1606                                 add_poly(so,
1607                                          sn->frames[0].verts[0],
1608                                          sn->frames[0].verts[1],
1609                                          sn->frames[0].verts[2],
1610                                          sn->frames[0].verts[3]);
1611                         }
1612                         else {
1613                                 add_poly(so,
1614                                          sn->frames[0].verts[3],
1615                                          sn->frames[0].verts[2],
1616                                          sn->frames[0].verts[1],
1617                                          sn->frames[0].verts[0]);
1618                         }
1619                 }
1620                 if (sn->flag & CAP_END) {
1621                         add_poly(so,
1622                                  sn->frames[1].verts[0],
1623                                 sn->frames[1].verts[1],
1624                                  sn->frames[1].verts[2],
1625                                  sn->frames[1].verts[3]);
1626                 }
1627         }
1628 }
1629
1630 static void skin_output_connections(SkinOutput *so, SkinNode *skin_nodes,
1631                                     const MEdge *medge,
1632                                     int totedge)
1633 {
1634         int e;
1635
1636         for (e = 0; e < totedge; e++) {
1637                 SkinNode *a, *b;
1638                 a = &skin_nodes[medge[e].v1];
1639                 b = &skin_nodes[medge[e].v2];
1640
1641                 if (a->totframe && b->totframe) {
1642                         if ((a->flag & SEAM_FRAME) || (b->flag & SEAM_FRAME)) {
1643                                 Frame *fr[2] = {&a->frames[0], &b->frames[0]};
1644                                 BMVert *v_order[4];
1645                                 int i, order[4];
1646
1647                                 if ((a->flag & SEAM_FRAME) && (e != a->seam_edges[0]))
1648                                         fr[0]++;
1649                                 if ((b->flag & SEAM_FRAME) && (e != b->seam_edges[0]))
1650                                         fr[1]++;
1651
1652                                 skin_choose_quad_bridge_order(fr[0]->verts, fr[1]->verts, order);
1653                                 for (i = 0; i < 4; i++)
1654                                         v_order[i] = fr[1]->verts[order[i]];
1655                                 connect_frames(so, fr[0]->verts, v_order);
1656                         }
1657                         else {
1658                                 connect_frames(so,
1659                                                a->frames[0].verts,
1660                                                b->frames[0].verts);
1661                         }
1662                 }
1663         }
1664 }
1665
1666 static void skin_smooth_hulls(BMesh *bm, SkinNode *skin_nodes,
1667                               int totvert, const SkinModifierData *smd)
1668 {
1669         BMIter iter, eiter;
1670         BMVert *v;
1671         int i, j, k, skey;
1672
1673         if (smd->branch_smoothing == 0)
1674                 return;
1675
1676         /* Mark all frame vertices */
1677         BM_mesh_elem_hflag_disable_all(bm, BM_VERT, BM_ELEM_TAG, false);
1678         for (i = 0; i < totvert; i++) {
1679                 for (j = 0; j < skin_nodes[i].totframe; j++) {
1680                         Frame *frame = &skin_nodes[i].frames[j];
1681
1682                         for (k = 0; k < 4; k++)
1683                                 BM_elem_flag_enable(frame->verts[k], BM_ELEM_TAG);
1684                 }
1685         }
1686
1687         /* Add temporary shapekey layer to store original coordinates */
1688         BM_data_layer_add(bm, &bm->vdata, CD_SHAPEKEY);
1689         skey = CustomData_number_of_layers(&bm->vdata, CD_SHAPEKEY) - 1;
1690         BM_ITER_MESH (v, &iter, bm, BM_VERTS_OF_MESH) {
1691                 copy_v3_v3(CustomData_bmesh_get_n(&bm->vdata, v->head.data,
1692                                                   CD_SHAPEKEY, skey), v->co);
1693         }
1694
1695         /* Smooth vertices, weight unmarked vertices more strongly (helps
1696          * to smooth frame vertices, but don't want to alter them too
1697          * much) */
1698         BM_ITER_MESH (v, &iter, bm, BM_VERTS_OF_MESH) {
1699                 BMEdge *e;
1700                 float avg[3];
1701                 float weight = smd->branch_smoothing;
1702                 int totv = 1;
1703
1704                 if (BM_elem_flag_test(v, BM_ELEM_TAG))
1705                         weight *= 0.5f;
1706
1707                 copy_v3_v3(avg, v->co);
1708                 BM_ITER_ELEM (e, &eiter, v, BM_EDGES_OF_VERT) {
1709                         BMVert *other = BM_edge_other_vert(e, v);
1710
1711                         add_v3_v3(avg, CustomData_bmesh_get_n(&bm->vdata,
1712                                                               other->head.data,
1713                                                               CD_SHAPEKEY, skey));
1714                         totv++;
1715                 }
1716
1717                 if (totv > 1) {
1718                         mul_v3_fl(avg, 1.0f / (float)totv);
1719                         interp_v3_v3v3(v->co, v->co, avg, weight);
1720                 }
1721         }
1722
1723         /* Done with original coordinates */
1724         BM_data_layer_free_n(bm, &bm->vdata, CD_SHAPEKEY, skey);
1725 }
1726
1727 /* Returns true if all hulls are successfully built, false otherwise */
1728 static bool skin_output_branch_hulls(SkinOutput *so, SkinNode *skin_nodes,
1729                                      int totvert, const MeshElemMap *emap,
1730                                      const MEdge *medge)
1731 {
1732         bool result = true;
1733         int v;
1734
1735         for (v = 0; v < totvert; v++) {
1736                 SkinNode *sn = &skin_nodes[v];
1737
1738                 /* Branch node hulls */
1739                 if (!sn->totframe) {
1740                         Frame **hull_frames;
1741                         int tothullframe;
1742
1743                         hull_frames = collect_hull_frames(v, skin_nodes,
1744                                                           emap, medge,
1745                                                           &tothullframe);
1746                         if (!build_hull(so, hull_frames, tothullframe))
1747                                 result = false;
1748
1749                         MEM_freeN(hull_frames);
1750                 }
1751         }
1752
1753         return result;
1754 }
1755
1756 static BMesh *build_skin(SkinNode *skin_nodes,
1757                          int totvert, const MeshElemMap *emap,
1758                          const MEdge *medge, int totedge,
1759                          const MDeformVert *input_dvert,
1760                          SkinModifierData *smd)
1761 {
1762         SkinOutput so;
1763         int v;
1764
1765         so.smd = smd;
1766         so.bm = BM_mesh_create(
1767                 &bm_mesh_allocsize_default,
1768                 &((struct BMeshCreateParams){.use_toolflags = true,}));
1769         so.mat_nr = 0;
1770
1771         /* BMESH_TODO: bumping up the stack level (see MOD_array.c) */
1772         BM_mesh_elem_toolflags_ensure(so.bm);
1773         BMO_push(so.bm, NULL);
1774         bmesh_edit_begin(so.bm, 0);
1775
1776         if (input_dvert)
1777                 BM_data_layer_add(so.bm, &so.bm->vdata, CD_MDEFORMVERT);
1778
1779         /* Check for mergeable frame corners around hulls before
1780          * outputting vertices */
1781         skin_merge_close_frame_verts(skin_nodes, totvert, emap, medge);
1782
1783         /* Write out all frame vertices to the mesh */
1784         for (v = 0; v < totvert; ++v) {
1785                 if (skin_nodes[v].totframe)
1786                         output_frames(so.bm, &skin_nodes[v],
1787                                       input_dvert ? &input_dvert[v] : NULL);
1788         }
1789
1790         /* Update vertex pointers for merged frame corners */
1791         skin_update_merged_vertices(skin_nodes, totvert);
1792
1793         if (!skin_output_branch_hulls(&so, skin_nodes, totvert, emap, medge))
1794                 modifier_setError(&smd->modifier, "Hull error");
1795
1796         /* Merge triangles here in the hope of providing better target
1797          * faces for skin_fix_hull_topology() to connect to */
1798         hull_merge_triangles(&so, smd);
1799
1800         /* Using convex hulls may not generate a nice manifold mesh. Two
1801          * problems can occur: an input frame's edges may be inside the
1802          * hull, and/or an input frame's vertices may be inside the hull.
1803          *
1804          * General fix to produce manifold mesh: for any frame that is
1805          * partially detached, first detach it fully, then find a suitable
1806          * existing face to merge with. (Note that we do this after
1807          * creating all hull faces, but before creating any other
1808          * faces.
1809          */
1810         skin_fix_hull_topology(so.bm, skin_nodes, totvert);
1811
1812         skin_smooth_hulls(so.bm, skin_nodes, totvert, smd);
1813
1814         skin_output_end_nodes(&so, skin_nodes, totvert);
1815         skin_output_connections(&so, skin_nodes, medge, totedge);
1816         hull_merge_triangles(&so, smd);
1817
1818         bmesh_edit_end(so.bm, 0);
1819         BMO_pop(so.bm);
1820
1821         return so.bm;
1822 }
1823
1824 static void skin_set_orig_indices(Mesh *mesh)
1825 {
1826         int *orig, totpoly;
1827
1828         totpoly = mesh->totpoly;
1829         orig = CustomData_add_layer(&mesh->pdata, CD_ORIGINDEX,
1830                                     CD_CALLOC, NULL, totpoly);
1831         copy_vn_i(orig, totpoly, ORIGINDEX_NONE);
1832 }
1833
1834 /*
1835  * 0) Subdivide edges (in caller)
1836  * 1) Generate good edge matrices (uses root nodes)
1837  * 2) Generate node frames
1838  * 3) Output vertices and polygons from frames, connections, and hulls
1839  */
1840 static Mesh *base_skin(Mesh *origmesh,
1841                        SkinModifierData *smd)
1842 {
1843         Mesh *result;
1844         MVertSkin *nodes;
1845         BMesh *bm;
1846         EMat *emat;
1847         SkinNode *skin_nodes;
1848         MeshElemMap *emap;
1849         int *emapmem;
1850         MVert *mvert;
1851         MEdge *medge;
1852         MDeformVert *dvert;
1853         int totvert, totedge;
1854         bool has_valid_root = false;
1855
1856         nodes = CustomData_get_layer(&origmesh->vdata, CD_MVERT_SKIN);
1857
1858         mvert = origmesh->mvert;
1859         dvert = origmesh->dvert;
1860         medge = origmesh->medge;
1861         totvert = origmesh->totvert;
1862         totedge = origmesh->totedge;
1863
1864         BKE_mesh_vert_edge_map_create(&emap, &emapmem, medge, totvert, totedge);
1865
1866         emat = build_edge_mats(nodes, mvert, totvert, medge, emap, totedge, &has_valid_root);
1867         skin_nodes = build_frames(mvert, totvert, nodes, emap, emat);
1868         MEM_freeN(emat);
1869         emat = NULL;
1870
1871         bm = build_skin(skin_nodes, totvert, emap, medge, totedge, dvert, smd);
1872
1873         MEM_freeN(skin_nodes);
1874         MEM_freeN(emap);
1875         MEM_freeN(emapmem);
1876
1877         if (!has_valid_root) {
1878                 modifier_setError(&smd->modifier, "No valid root vertex found (you need one per mesh island you want to skin)");
1879         }
1880
1881         if (!bm)
1882                 return NULL;
1883
1884         result = BKE_mesh_from_bmesh_for_eval_nomain(bm, 0);
1885         BM_mesh_free(bm);
1886
1887         result->runtime.cd_dirty_vert |= CD_MASK_NORMAL;
1888
1889         skin_set_orig_indices(result);
1890
1891         return result;
1892 }
1893
1894 static Mesh *final_skin(SkinModifierData *smd, Mesh *mesh)
1895 {
1896         Mesh *result;
1897
1898         /* Skin node layer is required */
1899         if (!CustomData_get_layer(&mesh->vdata, CD_MVERT_SKIN))
1900                 return mesh;
1901
1902         mesh = subdivide_base(mesh);
1903         result = base_skin(mesh, smd);
1904
1905         BKE_id_free(NULL, mesh);
1906         return result;
1907 }
1908
1909
1910 /**************************** Skin Modifier ***************************/
1911
1912 static void initData(ModifierData *md)
1913 {
1914         SkinModifierData *smd = (SkinModifierData *) md;
1915
1916         /* Enable in editmode by default */
1917         md->mode |= eModifierMode_Editmode;
1918
1919         smd->branch_smoothing = 0;
1920         smd->flag = 0;
1921         smd->symmetry_axes = MOD_SKIN_SYMM_X;
1922 }
1923
1924 static Mesh *applyModifier(ModifierData *md,
1925                            const ModifierEvalContext *UNUSED(ctx),
1926                            Mesh *mesh)
1927 {
1928         Mesh *result;
1929
1930         if (!(result = final_skin((SkinModifierData *)md, mesh)))
1931                 return mesh;
1932         return result;
1933 }
1934
1935 static CustomDataMask requiredDataMask(Object *UNUSED(ob),
1936                                        ModifierData *UNUSED(md))
1937 {
1938         return CD_MASK_MVERT_SKIN | CD_MASK_MDEFORMVERT;
1939 }
1940
1941 ModifierTypeInfo modifierType_Skin = {
1942         /* name */              "Skin",
1943         /* structName */        "SkinModifierData",
1944         /* structSize */        sizeof(SkinModifierData),
1945         /* type */              eModifierTypeType_Constructive,
1946         /* flags */             eModifierTypeFlag_AcceptsMesh | eModifierTypeFlag_SupportsEditmode,
1947
1948         /* copyData */          modifier_copyData_generic,
1949
1950         /* deformVerts_DM */    NULL,
1951         /* deformMatrices_DM */ NULL,
1952         /* deformVertsEM_DM */  NULL,
1953         /* deformMatricesEM_DM*/NULL,
1954         /* applyModifier_DM */  NULL,
1955
1956         /* deformVerts */       NULL,
1957         /* deformMatrices */    NULL,
1958         /* deformVertsEM */     NULL,
1959         /* deformMatricesEM */  NULL,
1960         /* applyModifier */     applyModifier,
1961
1962         /* initData */          initData,
1963         /* requiredDataMask */  requiredDataMask,
1964         /* freeData */          NULL,
1965         /* isDisabled */        NULL,
1966         /* updateDepsgraph */   NULL,
1967         /* dependsOnTime */     NULL,
1968         /* dependsOnNormals */  NULL,
1969         /* foreachObjectLink */ NULL,
1970         /* foreachIDLink */     NULL,
1971 };