BMesh: add ability not to delete vertex when collapsing
[blender.git] / source / blender / bmesh / intern / bmesh_mods.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): Joseph Eagar, Geoffrey Bantle, Campbell Barton
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/bmesh/intern/bmesh_mods.c
24  *  \ingroup bmesh
25  *
26  * This file contains functions for locally modifying
27  * the topology of existing mesh data. (split, join, flip etc).
28  */
29
30 #include "MEM_guardedalloc.h"
31
32
33 #include "BLI_math.h"
34 #include "BLI_array.h"
35
36 #include "BKE_customdata.h"
37
38 #include "bmesh.h"
39 #include "intern/bmesh_private.h"
40
41 /**
42  * \brief Dissolve Vert
43  *
44  * Turns the face region surrounding a manifold vertex into a single polygon.
45  *
46  * \par Example:
47  * <pre>
48  *              +---------+             +---------+
49  *              |  \   /  |             |         |
50  *     Before:  |    v    |      After: |         |
51  *              |  /   \  |             |         |
52  *              +---------+             +---------+
53  * </pre>
54  *
55  * This function can also collapse edges too
56  * in cases when it cant merge into faces.
57  *
58  * \par Example:
59  * <pre>
60  *     Before:  +----v----+      After: +---------+
61  * </pre>
62  *
63  * \note dissolves vert, in more situations then BM_disk_dissolve
64  * (e.g. if the vert is part of a wire edge, etc).
65  */
66 bool BM_vert_dissolve(BMesh *bm, BMVert *v)
67 {
68         const int len = BM_vert_edge_count(v);
69         
70         if (len == 1) {
71                 BM_vert_kill(bm, v); /* will kill edges too */
72                 return true;
73         }
74         else if (!BM_vert_is_manifold(v)) {
75                 if (!v->e) {
76                         BM_vert_kill(bm, v);
77                         return true;
78                 }
79                 else if (!v->e->l) {
80                         if (len == 2) {
81                                 return (BM_vert_collapse_edge(bm, v->e, v, true, true) != NULL);
82                         }
83                         else {
84                                 /* used to kill the vertex here, but it may be connected to faces.
85                                  * so better do nothing */
86                                 return false;
87                         }
88                 }
89                 else {
90                         return false;
91                 }
92         }
93         else if (len == 2 && BM_vert_face_count(v) == 1) {
94                 /* boundary vertex on a face */
95                 return (BM_vert_collapse_edge(bm, v->e, v, true, true) != NULL);
96         }
97         else {
98                 return BM_disk_dissolve(bm, v);
99         }
100 }
101
102 /**
103  * dissolves all faces around a vert, and removes it.
104  */
105 bool BM_disk_dissolve(BMesh *bm, BMVert *v)
106 {
107         BMFace *f, *f2;
108         BMEdge *e, *keepedge = NULL, *baseedge = NULL;
109         int len = 0;
110
111         if (!BM_vert_is_manifold(v)) {
112                 return false;
113         }
114         
115         if (v->e) {
116                 /* v->e we keep, what else */
117                 e = v->e;
118                 do {
119                         e = bmesh_disk_edge_next(e, v);
120                         if (!(BM_edge_share_face_check(e, v->e))) {
121                                 keepedge = e;
122                                 baseedge = v->e;
123                                 break;
124                         }
125                         len++;
126                 } while (e != v->e);
127         }
128         
129         /* this code for handling 2 and 3-valence verts
130          * may be totally bad */
131         if (keepedge == NULL && len == 3) {
132 #if 0
133                 /* handle specific case for three-valence.  solve it by
134                  * increasing valence to four.  this may be hackish. .  */
135                 BMLoop *loop = e->l;
136                 if (loop->v == v) loop = loop->next;
137                 if (!BM_face_split(bm, loop->f, v, loop->v, NULL, NULL, false))
138                         return false;
139
140                 if (!BM_disk_dissolve(bm, v)) {
141                         return false;
142                 }
143 #else
144                 if (UNLIKELY(!BM_faces_join_pair(bm, e->l->f, e->l->radial_next->f, e, true))) {
145                         return false;
146                 }
147                 else if (UNLIKELY(!BM_vert_collapse_faces(bm, v->e, v, 1.0, true, false, true))) {
148                         return false;
149                 }
150 #endif
151                 return true;
152         }
153         else if (keepedge == NULL && len == 2) {
154                 /* collapse the vertex */
155                 e = BM_vert_collapse_faces(bm, v->e, v, 1.0, true, true, true);
156
157                 if (!e) {
158                         return false;
159                 }
160
161                 /* handle two-valence */
162                 f = e->l->f;
163                 f2 = e->l->radial_next->f;
164
165                 if (f != f2 && !BM_faces_join_pair(bm, f, f2, e, true)) {
166                         return false;
167                 }
168
169                 return true;
170         }
171
172         if (keepedge) {
173                 bool done = false;
174
175                 while (!done) {
176                         done = true;
177                         e = v->e;
178                         do {
179                                 f = NULL;
180                                 if (BM_edge_is_manifold(e) && (e != baseedge) && (e != keepedge)) {
181                                         f = BM_faces_join_pair(bm, e->l->f, e->l->radial_next->f, e, true);
182                                         /* return if couldn't join faces in manifold
183                                          * conditions */
184                                         /* !disabled for testing why bad things happen */
185                                         if (!f) {
186                                                 return false;
187                                         }
188                                 }
189
190                                 if (f) {
191                                         done = false;
192                                         break;
193                                 }
194                         } while ((e = bmesh_disk_edge_next(e, v)) != v->e);
195                 }
196
197                 /* collapse the vertex */
198                 /* note, the baseedge can be a boundary of manifold, use this as join_faces arg */
199                 e = BM_vert_collapse_faces(bm, baseedge, v, 1.0, true, !BM_edge_is_boundary(baseedge), true);
200
201                 if (!e) {
202                         return false;
203                 }
204                 
205                 if (e->l) {
206                         /* get remaining two faces */
207                         f = e->l->f;
208                         f2 = e->l->radial_next->f;
209
210                         if (f != f2) {
211                                 /* join two remaining faces */
212                                 if (!BM_faces_join_pair(bm, f, f2, e, true)) {
213                                         return false;
214                                 }
215                         }
216                 }
217         }
218
219         return true;
220 }
221
222 /**
223  * \brief Faces Join Pair
224  *
225  * Joins two adjacent faces together.
226  *
227  * Because this method calls to #BM_faces_join to do its work, if a pair
228  * of faces share multiple edges, the pair of faces will be joined at
229  * every edge (not just edge \a e). This part of the functionality might need
230  * to be reconsidered.
231  *
232  * If the windings do not match the winding of the new face will follow
233  * \a f_a's winding (i.e. \a f_b will be reversed before the join).
234  *
235  * \return pointer to the combined face
236  */
237 BMFace *BM_faces_join_pair(BMesh *bm, BMFace *f_a, BMFace *f_b, BMEdge *e, const bool do_del)
238 {
239         BMFace *faces[2] = {f_a, f_b};
240
241         BMLoop *l_a = BM_face_edge_share_loop(f_a, e);
242         BMLoop *l_b = BM_face_edge_share_loop(f_b, e);
243
244         BLI_assert(l_a && l_b);
245
246         if (l_a->v == l_b->v) {
247                 bmesh_loop_reverse(bm, f_b);
248         }
249         
250         return BM_faces_join(bm, faces, 2, do_del);
251 }
252
253 /**
254  * \brief Face Split
255  *
256  * Split a face along two vertices. returns the newly made face, and sets
257  * the \a r_l member to a loop in the newly created edge.
258  *
259  * \param bm The bmesh
260  * \param f the original face
261  * \param v1, v2 vertices which define the split edge, must be different
262  * \param r_l pointer which will receive the BMLoop for the split edge in the new face
263  * \param example Edge used for attributes of splitting edge, if non-NULL
264  * \param nodouble Use an existing edge if found
265  *
266  * \return Pointer to the newly created face representing one side of the split
267  * if the split is successful (and the original original face will be the
268  * other side). NULL if the split fails.
269  */
270 BMFace *BM_face_split(BMesh *bm, BMFace *f,
271                       BMLoop *l_a, BMLoop *l_b,
272                       BMLoop **r_l, BMEdge *example,
273                       const bool no_double)
274 {
275         const bool has_mdisp = CustomData_has_layer(&bm->ldata, CD_MDISPS);
276         BMFace *f_new, *f_tmp;
277
278         BLI_assert(l_a != l_b);
279         BLI_assert(f == l_a->f && f == l_b->f);
280         BLI_assert(!BM_loop_is_adjacent(l_a, l_b));
281
282         /* could be an assert */
283         if (UNLIKELY(BM_loop_is_adjacent(l_a, l_b)) ||
284             UNLIKELY((f != l_a->f || f != l_b->f)))
285         {
286                 if (r_l) {
287                         *r_l = NULL;
288                 }
289                 return NULL;
290         }
291
292         /* do we have a multires layer? */
293         if (has_mdisp) {
294                 f_tmp = BM_face_copy(bm, bm, f, false, false);
295         }
296         
297 #ifdef USE_BMESH_HOLES
298         f_new = bmesh_sfme(bm, f, l_a, l_b, r_l, NULL, example, no_double);
299 #else
300         f_new = bmesh_sfme(bm, f, l_a, l_b, r_l, example, no_double);
301 #endif
302         
303         if (f_new) {
304                 /* handle multires update */
305                 if (has_mdisp) {
306                         BMLoop *l_iter;
307                         BMLoop *l_first;
308
309                         l_iter = l_first = BM_FACE_FIRST_LOOP(f);
310                         do {
311                                 BM_loop_interp_multires(bm, l_iter, f_tmp);
312                         } while ((l_iter = l_iter->next) != l_first);
313
314                         l_iter = l_first = BM_FACE_FIRST_LOOP(f_new);
315                         do {
316                                 BM_loop_interp_multires(bm, l_iter, f_tmp);
317                         } while ((l_iter = l_iter->next) != l_first);
318
319 #if 0
320                         /* BM_face_multires_bounds_smooth doesn't flip displacement correct */
321                         BM_face_multires_bounds_smooth(bm, f);
322                         BM_face_multires_bounds_smooth(bm, f_new);
323 #endif
324                 }
325         }
326
327         if (has_mdisp) {
328                 BM_face_kill(bm, f_tmp);
329         }
330
331         return f_new;
332 }
333
334 /**
335  * \brief Face Split with intermediate points
336  *
337  * Like BM_face_split, but with an edge split by \a n intermediate points with given coordinates.
338  *
339  * \param bm The bmesh
340  * \param f the original face
341  * \param l_a, l_b vertices which define the split edge, must be different
342  * \param cos Array of coordinates for intermediate points
343  * \param n Length of \a cos (must be > 0)
344  * \param r_l pointer which will receive the BMLoop for the first split edge (from \a v1) in the new face
345  * \param example Edge used for attributes of splitting edge, if non-NULL
346  *
347  * \return Pointer to the newly created face representing one side of the split
348  * if the split is successful (and the original original face will be the
349  * other side). NULL if the split fails.
350  */
351 BMFace *BM_face_split_n(BMesh *bm, BMFace *f,
352                         BMLoop *l_a, BMLoop *l_b,
353                         float cos[][3], int n,
354                         BMLoop **r_l, BMEdge *example)
355 {
356         BMFace *f_new, *f_tmp;
357         BMLoop *l_dummy;
358         BMEdge *e, *e_new;
359         BMVert *v_new;
360         // BMVert *v_a = l_a->v; /* UNUSED */
361         BMVert *v_b = l_b->v;
362         int i, j;
363
364         BLI_assert(l_a != l_b);
365         BLI_assert(f == l_a->f && f == l_b->f);
366         BLI_assert(!((n == 0) && BM_loop_is_adjacent(l_a, l_b)));
367
368         /* could be an assert */
369         if (UNLIKELY((n == 0) && BM_loop_is_adjacent(l_a, l_b)) ||
370             UNLIKELY(l_a->f != l_b->f))
371         {
372                 if (r_l) {
373                         *r_l = NULL;
374                 }
375                 return NULL;
376         }
377
378         f_tmp = BM_face_copy(bm, bm, f, true, true);
379
380         if (!r_l)
381                 r_l = &l_dummy;
382         
383 #ifdef USE_BMESH_HOLES
384         f_new = bmesh_sfme(bm, f, l_a, l_b, r_l, NULL, example, false);
385 #else
386         f_new = bmesh_sfme(bm, f, l_a, l_b, r_l, example, false);
387 #endif
388         /* bmesh_sfme returns in r_l a Loop for f_new going from v_a to v_b.
389          * The radial_next is for f and goes from v_b to v_a  */
390
391         if (f_new) {
392                 e = (*r_l)->e;
393                 for (i = 0; i < n; i++) {
394                         v_new = bmesh_semv(bm, v_b, e, &e_new);
395                         BLI_assert(v_new != NULL);
396                         /* bmesh_semv returns in e_new the edge going from v_new to tv */
397                         copy_v3_v3(v_new->co, cos[i]);
398
399                         /* interpolate the loop data for the loops with (v == v_new), using orig face */
400                         for (j = 0; j < 2; j++) {
401                                 BMEdge *e_iter = (j == 0) ? e : e_new;
402                                 BMLoop *l_iter = e_iter->l;
403                                 do {
404                                         if (l_iter->v == v_new) {
405                                                 /* this interpolates both loop and vertex data */
406                                                 BM_loop_interp_from_face(bm, l_iter, f_tmp, true, true);
407                                         }
408                                 } while ((l_iter = l_iter->radial_next) != e_iter->l);
409                         }
410                         e = e_new;
411                 }
412         }
413
414         BM_face_verts_kill(bm, f_tmp);
415
416         return f_new;
417 }
418
419 /**
420  * \brief Vert Collapse Faces
421  *
422  * Collapses vertex \a v_kill that has only two manifold edges
423  * onto a vertex it shares an edge with.
424  * \a fac defines the amount of interpolation for Custom Data.
425  *
426  * \note that this is not a general edge collapse function.
427  *
428  * \note this function is very close to #BM_vert_collapse_edge,
429  * both collapse a vertex and return a new edge.
430  * Except this takes a factor and merges custom data.
431  *
432  * \param bm The bmesh
433  * \param e_kill The edge to collapse
434  * \param v_kill The vertex  to collapse into the edge
435  * \param fac The factor along the edge
436  * \param join_faces When true the faces around the vertex will be joined
437  * otherwise collapse the vertex by merging the 2 edges this vert touches into one.
438  * \param kill_degenerate_faces Removes faces with less than 3 verts after collapsing.
439  *
440  * \returns The New Edge
441  */
442 BMEdge *BM_vert_collapse_faces(BMesh *bm, BMEdge *e_kill, BMVert *v_kill, float fac,
443                                const bool do_del, const bool join_faces, const bool kill_degenerate_faces)
444 {
445         BMEdge *e_new = NULL;
446         BMVert *tv = BM_edge_other_vert(e_kill, v_kill);
447
448         BMEdge *e2;
449         BMVert *tv2;
450
451         /* Only intended to be called for 2-valence vertices */
452         BLI_assert(bmesh_disk_count(v_kill) <= 2);
453
454
455         /* first modify the face loop data */
456
457         if (e_kill->l) {
458                 BMLoop *l_iter;
459                 const float w[2] = {1.0f - fac, fac};
460
461                 l_iter = e_kill->l;
462                 do {
463                         if (l_iter->v == tv && l_iter->next->v == v_kill) {
464                                 void *src[2];
465                                 BMLoop *tvloop = l_iter;
466                                 BMLoop *kvloop = l_iter->next;
467
468                                 src[0] = kvloop->head.data;
469                                 src[1] = tvloop->head.data;
470                                 CustomData_bmesh_interp(&bm->ldata, src, w, NULL, 2, kvloop->head.data);
471                         }
472                 } while ((l_iter = l_iter->radial_next) != e_kill->l);
473         }
474
475         /* now interpolate the vertex data */
476         BM_data_interp_from_verts(bm, v_kill, tv, v_kill, fac);
477
478         e2 = bmesh_disk_edge_next(e_kill, v_kill);
479         tv2 = BM_edge_other_vert(e2, v_kill);
480
481         if (join_faces) {
482                 BMIter fiter;
483                 BMFace **faces = NULL;
484                 BMFace *f;
485                 BLI_array_staticdeclare(faces, BM_DEFAULT_ITER_STACK_SIZE);
486
487                 BM_ITER_ELEM (f, &fiter, v_kill, BM_FACES_OF_VERT) {
488                         BLI_array_append(faces, f);
489                 }
490
491                 if (BLI_array_count(faces) >= 2) {
492                         BMFace *f2 = BM_faces_join(bm, faces, BLI_array_count(faces), true);
493                         if (f2) {
494                                 BMLoop *l_a, *l_b;
495
496                                 if ((l_a = BM_face_vert_share_loop(f2, tv)) &&
497                                     (l_b = BM_face_vert_share_loop(f2, tv2)))
498                                 {
499                                         BMLoop *l_new;
500
501                                         if (BM_face_split(bm, f2, l_a, l_b, &l_new, NULL, false)) {
502                                                 e_new = l_new->e;
503                                         }
504                                 }
505                         }
506                 }
507
508                 BLI_assert(BLI_array_count(faces) < 8);
509
510                 BLI_array_free(faces);
511         }
512         else {
513                 /* single face or no faces */
514                 /* same as BM_vert_collapse_edge() however we already
515                  * have vars to perform this operation so don't call. */
516                 e_new = bmesh_jekv(bm, e_kill, v_kill, do_del, true);
517                 /* e_new = BM_edge_exists(tv, tv2); */ /* same as return above */
518
519                 if (e_new && kill_degenerate_faces) {
520                         BMFace **bad_faces = NULL;
521                         BLI_array_staticdeclare(bad_faces, BM_DEFAULT_ITER_STACK_SIZE);
522
523                         BMIter fiter;
524                         BMFace *f;
525                         BMVert *verts[2] = {e_new->v1, e_new->v2};
526                         int i;
527
528                         for (i = 0; i < 2; i++) {
529                                 /* cant kill data we loop on, build a list and remove those */
530                                 BLI_array_empty(bad_faces);
531                                 BM_ITER_ELEM (f, &fiter, verts[i], BM_FACES_OF_VERT) {
532                                         if (UNLIKELY(f->len < 3)) {
533                                                 BLI_array_append(bad_faces, f);
534                                         }
535                                 }
536                                 while ((f = BLI_array_pop(bad_faces))) {
537                                         BM_face_kill(bm, f);
538                                 }
539                         }
540                         BLI_array_free(bad_faces);
541                 }
542         }
543
544         return e_new;
545 }
546
547
548 /**
549  * \brief Vert Collapse Faces
550  *
551  * Collapses a vertex onto another vertex it shares an edge with.
552  *
553  * \return The New Edge
554  */
555 BMEdge *BM_vert_collapse_edge(BMesh *bm, BMEdge *e_kill, BMVert *v_kill,
556                               const bool do_del, const bool kill_degenerate_faces)
557 {
558         /* nice example implementation but we want loops to have their customdata
559          * accounted for */
560 #if 0
561         BMEdge *e_new = NULL;
562
563         /* Collapse between 2 edges */
564
565         /* in this case we want to keep all faces and not join them,
566          * rather just get rid of the vertex - see bug [#28645] */
567         BMVert *tv  = BM_edge_other_vert(e_kill, v_kill);
568         if (tv) {
569                 BMEdge *e2 = bmesh_disk_edge_next(e_kill, v_kill);
570                 if (e2) {
571                         BMVert *tv2 = BM_edge_other_vert(e2, v_kill);
572                         if (tv2) {
573                                 /* only action, other calls here only get the edge to return */
574                                 e_new = bmesh_jekv(bm, e_kill, v_kill, do_del);
575                         }
576                 }
577         }
578
579         return e_new;
580 #else
581         /* with these args faces are never joined, same as above
582          * but account for loop customdata */
583         return BM_vert_collapse_faces(bm, e_kill, v_kill, 1.0f, do_del, false, kill_degenerate_faces);
584 #endif
585 }
586
587 #undef DO_V_INTERP
588
589 /**
590  * \brief Edge Split
591  *
592  * Splits an edge. \a v should be one of the vertices in \a e and defines
593  * the "from" end of the splitting operation: the new vertex will be
594  * \a percent of the way from \a v to the other end.
595  * The newly created edge is attached to \a v and is returned in \a r_e.
596  * The original edge \a e will be the other half of the split.
597  *
598  * \return The new vert
599  */
600 BMVert *BM_edge_split(BMesh *bm, BMEdge *e, BMVert *v, BMEdge **r_e, float percent)
601 {
602         BMVert *v_new, *v2;
603         BMFace **oldfaces = NULL;
604         BMEdge *e_dummy;
605         BLI_array_staticdeclare(oldfaces, 32);
606         const bool do_mdisp = (e->l && CustomData_has_layer(&bm->ldata, CD_MDISPS));
607
608         /* we need this for handling multi-res */
609         if (!r_e) {
610                 r_e = &e_dummy;
611         }
612
613         /* do we have a multi-res layer? */
614         if (do_mdisp) {
615                 BMLoop *l;
616                 int i;
617                 
618                 l = e->l;
619                 do {
620                         BLI_array_append(oldfaces, l->f);
621                         l = l->radial_next;
622                 } while (l != e->l);
623                 
624                 /* flag existing faces so we can differentiate oldfaces from new faces */
625                 for (i = 0; i < BLI_array_count(oldfaces); i++) {
626                         BM_ELEM_API_FLAG_ENABLE(oldfaces[i], _FLAG_OVERLAP);
627                         oldfaces[i] = BM_face_copy(bm, bm, oldfaces[i], true, true);
628                         BM_ELEM_API_FLAG_DISABLE(oldfaces[i], _FLAG_OVERLAP);
629                 }
630         }
631
632         v2 = BM_edge_other_vert(e, v);
633         v_new = bmesh_semv(bm, v, e, r_e);
634
635         BLI_assert(v_new != NULL);
636
637         sub_v3_v3v3(v_new->co, v2->co, v->co);
638         madd_v3_v3v3fl(v_new->co, v->co, v_new->co, percent);
639
640         if (r_e) {
641                 (*r_e)->head.hflag = e->head.hflag;
642                 BM_elem_attrs_copy(bm, bm, e, *r_e);
643         }
644
645         /* v->v_new->v2 */
646         BM_data_interp_face_vert_edge(bm, v2, v, v_new, e, percent);
647         BM_data_interp_from_verts(bm, v, v2, v_new, percent);
648
649         if (do_mdisp) {
650                 int i, j;
651
652                 /* interpolate new/changed loop data from copied old faces */
653                 for (j = 0; j < 2; j++) {
654                         for (i = 0; i < BLI_array_count(oldfaces); i++) {
655                                 BMEdge *e1 = j ? *r_e : e;
656                                 BMLoop *l, *l2;
657                                 
658                                 l = e1->l;
659
660                                 if (UNLIKELY(!l)) {
661                                         BMESH_ASSERT(0);
662                                         break;
663                                 }
664                                 
665                                 do {
666                                         /* check this is an old face */
667                                         if (BM_ELEM_API_FLAG_TEST(l->f, _FLAG_OVERLAP)) {
668                                                 BMLoop *l2_first;
669
670                                                 l2 = l2_first = BM_FACE_FIRST_LOOP(l->f);
671                                                 do {
672                                                         BM_loop_interp_multires(bm, l2, oldfaces[i]);
673                                                 } while ((l2 = l2->next) != l2_first);
674                                         }
675                                         l = l->radial_next;
676                                 } while (l != e1->l);
677                         }
678                 }
679                 
680                 /* destroy the old faces */
681                 for (i = 0; i < BLI_array_count(oldfaces); i++) {
682                         BM_face_verts_kill(bm, oldfaces[i]);
683                 }
684                 
685                 /* fix boundaries a bit, doesn't work too well quite yet */
686 #if 0
687                 for (j = 0; j < 2; j++) {
688                         BMEdge *e1 = j ? *r_e : e;
689                         BMLoop *l, *l2;
690                         
691                         l = e1->l;
692                         if (UNLIKELY(!l)) {
693                                 BMESH_ASSERT(0);
694                                 break;
695                         }
696                         
697                         do {
698                                 BM_face_multires_bounds_smooth(bm, l->f);
699                                 l = l->radial_next;
700                         } while (l != e1->l);
701                 }
702 #endif
703                 
704                 BLI_array_free(oldfaces);
705         }
706
707         return v_new;
708 }
709
710 /**
711  * \brief Split an edge multiple times evenly
712  *
713  * \param r_varr  Optional array, verts in between (v1 -> v2)
714  */
715 BMVert  *BM_edge_split_n(BMesh *bm, BMEdge *e, int numcuts, BMVert **r_varr)
716 {
717         int i;
718         float percent;
719         BMVert *v_new = NULL;
720         
721         for (i = 0; i < numcuts; i++) {
722                 percent = 1.0f / (float)(numcuts + 1 - i);
723                 v_new = BM_edge_split(bm, e, e->v2, NULL, percent);
724                 if (r_varr) {
725                         /* fill in reverse order (v1 -> v2) */
726                         r_varr[numcuts - i - 1] = v_new;
727                 }
728         }
729         return v_new;
730 }
731
732 #if 0
733 /**
734  * Checks if a face is valid in the data structure
735  */
736 bool BM_face_validate(BMFace *face, FILE *err)
737 {
738         BMIter iter;
739         BLI_array_declare(verts);
740         BMVert **verts = NULL;
741         BMLoop *l;
742         int i, j;
743         bool ret = true;
744         
745         if (face->len == 2) {
746                 fprintf(err, "warning: found two-edged face. face ptr: %p\n", face);
747                 fflush(err);
748         }
749
750         BLI_array_grow_items(verts, face->len);
751         BM_ITER_ELEM_INDEX (l, &iter, face, BM_LOOPS_OF_FACE, i) {
752                 verts[i] = l->v;
753                 if (l->e->v1 == l->e->v2) {
754                         fprintf(err, "Found bmesh edge with identical verts!\n");
755                         fprintf(err, "  edge ptr: %p, vert: %p\n",  l->e, l->e->v1);
756                         fflush(err);
757                         ret = false;
758                 }
759         }
760
761         for (i = 0; i < face->len; i++) {
762                 for (j = 0; j < face->len; j++) {
763                         if (j == i) {
764                                 continue;
765                         }
766
767                         if (verts[i] == verts[j]) {
768                                 fprintf(err, "Found duplicate verts in bmesh face!\n");
769                                 fprintf(err, "  face ptr: %p, vert: %p\n", face, verts[i]);
770                                 fflush(err);
771                                 ret = false;
772                         }
773                 }
774         }
775         
776         BLI_array_free(verts);
777         return ret;
778 }
779 #endif
780
781 /**
782  * Calculate the 2 loops which _would_ make up the newly rotated Edge
783  * but don't actually change anything.
784  *
785  * Use this to further inspect if the loops to be connected have issues:
786  *
787  * Examples:
788  * - the newly formed edge already exists
789  * - the new face would be degenerate (zero area / concave /  bow-tie)
790  * - may want to measure if the new edge gives improved results topology.
791  *   over the old one, as with beauty fill.
792  *
793  * \note #BM_edge_rotate_check must have already run.
794  */
795 void BM_edge_calc_rotate(BMEdge *e, const bool ccw,
796                          BMLoop **r_l1, BMLoop **r_l2)
797 {
798         BMVert *v1, *v2;
799         BMFace *fa, *fb;
800
801         /* this should have already run */
802         BLI_assert(BM_edge_rotate_check(e) == true);
803
804         /* we know this will work */
805         BM_edge_face_pair(e, &fa, &fb);
806
807         /* so we can use ccw variable correctly,
808          * otherwise we could use the edges verts direct */
809         BM_edge_ordered_verts(e, &v1, &v2);
810
811         /* we could swap the verts _or_ the faces, swapping faces
812          * gives more predictable results since that way the next vert
813          * just stitches from face fa / fb */
814         if (!ccw) {
815                 SWAP(BMFace *, fa, fb);
816         }
817
818         *r_l1 = BM_face_other_vert_loop(fb, v2, v1);
819         *r_l2 = BM_face_other_vert_loop(fa, v1, v2);
820 }
821
822 /**
823  * \brief Check if Rotate Edge is OK
824  *
825  * Quick check to see if we could rotate the edge,
826  * use this to avoid calling exceptions on common cases.
827  */
828 bool BM_edge_rotate_check(BMEdge *e)
829 {
830         BMFace *fa, *fb;
831         if (BM_edge_face_pair(e, &fa, &fb)) {
832                 BMLoop *la, *lb;
833
834                 la = BM_face_other_vert_loop(fa, e->v2, e->v1);
835                 lb = BM_face_other_vert_loop(fb, e->v2, e->v1);
836
837                 /* check that the next vert in both faces isn't the same
838                  * (ie - the next edge doesn't share the same faces).
839                  * since we can't rotate usefully in this case. */
840                 if (la->v == lb->v) {
841                         return false;
842                 }
843
844                 /* mirror of the check above but in the opposite direction */
845                 la = BM_face_other_vert_loop(fa, e->v1, e->v2);
846                 lb = BM_face_other_vert_loop(fb, e->v1, e->v2);
847
848                 if (la->v == lb->v) {
849                         return false;
850                 }
851
852                 return true;
853         }
854         else {
855                 return false;
856         }
857 }
858
859 /**
860  * \brief Check if Edge Rotate Gives Degenerate Faces
861  *
862  * Check 2 cases
863  * 1) does the newly forms edge form a flipped face (compare with previous cross product)
864  * 2) does the newly formed edge cause a zero area corner (or close enough to be almost zero)
865  *
866  * \param e The edge to test rotation.
867  * \param l1,l2 are the loops of the proposed verts to rotate too and should
868  * be the result of calling #BM_edge_calc_rotate
869  */
870 bool BM_edge_rotate_check_degenerate(BMEdge *e, BMLoop *l1, BMLoop *l2)
871 {
872         /* note: for these vars 'old' just means initial edge state. */
873
874         float ed_dir_old[3]; /* edge vector */
875         float ed_dir_new[3]; /* edge vector */
876         float ed_dir_new_flip[3]; /* edge vector */
877
878         float ed_dir_v1_old[3];
879         float ed_dir_v2_old[3];
880
881         float ed_dir_v1_new[3];
882         float ed_dir_v2_new[3];
883
884         float cross_old[3];
885         float cross_new[3];
886
887         /* original verts - these will be in the edge 'e' */
888         BMVert *v1_old, *v2_old;
889
890         /* verts from the loops passed */
891
892         BMVert *v1, *v2;
893         /* these are the opposite verts - the verts that _would_ be used if 'ccw' was inverted*/
894         BMVert *v1_alt, *v2_alt;
895
896         /* this should have already run */
897         BLI_assert(BM_edge_rotate_check(e) == true);
898
899         BM_edge_ordered_verts(e, &v1_old, &v2_old);
900
901         v1 = l1->v;
902         v2 = l2->v;
903
904         /* get the next vert along */
905         v1_alt = BM_face_other_vert_loop(l1->f, v1_old, v1)->v;
906         v2_alt = BM_face_other_vert_loop(l2->f, v2_old, v2)->v;
907
908         /* normalize all so comparisons are scale independent */
909
910         BLI_assert(BM_edge_exists(v1_old, v1));
911         BLI_assert(BM_edge_exists(v1, v1_alt));
912
913         BLI_assert(BM_edge_exists(v2_old, v2));
914         BLI_assert(BM_edge_exists(v2, v2_alt));
915
916         /* old and new edge vecs */
917         sub_v3_v3v3(ed_dir_old, v1_old->co, v2_old->co);
918         sub_v3_v3v3(ed_dir_new, v1->co, v2->co);
919         normalize_v3(ed_dir_old);
920         normalize_v3(ed_dir_new);
921
922         /* old edge corner vecs */
923         sub_v3_v3v3(ed_dir_v1_old, v1_old->co, v1->co);
924         sub_v3_v3v3(ed_dir_v2_old, v2_old->co, v2->co);
925         normalize_v3(ed_dir_v1_old);
926         normalize_v3(ed_dir_v2_old);
927
928         /* old edge corner vecs */
929         sub_v3_v3v3(ed_dir_v1_new, v1->co, v1_alt->co);
930         sub_v3_v3v3(ed_dir_v2_new, v2->co, v2_alt->co);
931         normalize_v3(ed_dir_v1_new);
932         normalize_v3(ed_dir_v2_new);
933
934         /* compare */
935         cross_v3_v3v3(cross_old, ed_dir_old, ed_dir_v1_old);
936         cross_v3_v3v3(cross_new, ed_dir_new, ed_dir_v1_new);
937         if (dot_v3v3(cross_old, cross_new) < 0.0f) { /* does this flip? */
938                 return false;
939         }
940         cross_v3_v3v3(cross_old, ed_dir_old, ed_dir_v2_old);
941         cross_v3_v3v3(cross_new, ed_dir_new, ed_dir_v2_new);
942         if (dot_v3v3(cross_old, cross_new) < 0.0f) { /* does this flip? */
943                 return false;
944         }
945
946         negate_v3_v3(ed_dir_new_flip, ed_dir_new);
947
948         /* result is zero area corner */
949         if ((dot_v3v3(ed_dir_new,      ed_dir_v1_new) > 0.999f) ||
950             (dot_v3v3(ed_dir_new_flip, ed_dir_v2_new) > 0.999f))
951         {
952                 return false;
953         }
954
955         return true;
956 }
957
958 bool BM_edge_rotate_check_beauty(BMEdge *e,
959                                  BMLoop *l1, BMLoop *l2)
960 {
961         /* Stupid check for now:
962          * Could compare angles of surrounding edges
963          * before & after, but this is OK.*/
964         return (len_squared_v3v3(e->v1->co, e->v2->co) >
965                 len_squared_v3v3(l1->v->co, l2->v->co));
966 }
967
968 /**
969  * \brief Rotate Edge
970  *
971  * Spins an edge topologically,
972  * either counter-clockwise or clockwise depending on \a ccw.
973  *
974  * \return The spun edge, NULL on error
975  * (e.g., if the edge isn't surrounded by exactly two faces).
976  *
977  * \note This works by dissolving the edge then re-creating it,
978  * so the returned edge won't have the same pointer address as the original one.
979  *
980  * \see header definition for \a check_flag enum.
981  */
982 BMEdge *BM_edge_rotate(BMesh *bm, BMEdge *e, const bool ccw, const short check_flag)
983 {
984         BMVert *v1, *v2;
985         BMLoop *l1, *l2;
986         BMFace *f;
987         BMEdge *e_new = NULL;
988         char f_hflag_prev_1;
989         char f_hflag_prev_2;
990
991         if (!BM_edge_rotate_check(e)) {
992                 return NULL;
993         }
994
995         BM_edge_calc_rotate(e, ccw, &l1, &l2);
996
997         /* the loops will be freed so assign verts */
998         v1 = l1->v;
999         v2 = l2->v;
1000
1001         /* --------------------------------------- */
1002         /* Checking Code - make sure we can rotate */
1003
1004         if (check_flag & BM_EDGEROT_CHECK_BEAUTY) {
1005                 if (!BM_edge_rotate_check_beauty(e, l1, l2)) {
1006                         return NULL;
1007                 }
1008         }
1009
1010         /* check before applying */
1011         if (check_flag & BM_EDGEROT_CHECK_EXISTS) {
1012                 if (BM_edge_exists(v1, v2)) {
1013                         return NULL;
1014                 }
1015         }
1016
1017         /* slowest, check last */
1018         if (check_flag & BM_EDGEROT_CHECK_DEGENERATE) {
1019                 if (!BM_edge_rotate_check_degenerate(e, l1, l2)) {
1020                         return NULL;
1021                 }
1022         }
1023         /* Done Checking */
1024         /* ------------- */
1025
1026
1027
1028         /* --------------- */
1029         /* Rotate The Edge */
1030
1031         /* first create the new edge, this is so we can copy the customdata from the old one
1032          * if splice if disabled, always add in a new edge even if theres one there. */
1033         e_new = BM_edge_create(bm, v1, v2, e, (check_flag & BM_EDGEROT_CHECK_SPLICE) ? BM_CREATE_NO_DOUBLE : BM_CREATE_NOP);
1034
1035         f_hflag_prev_1 = l1->f->head.hflag;
1036         f_hflag_prev_2 = l2->f->head.hflag;
1037
1038         /* don't delete the edge, manually remove the edge after so we can copy its attributes */
1039         f = BM_faces_join_pair(bm, l1->f, l2->f, e, true);
1040
1041         if (f == NULL) {
1042                 return NULL;
1043         }
1044
1045         /* note, this assumes joining the faces _didnt_ also remove the verts.
1046          * the #BM_edge_rotate_check will ensure this, but its possibly corrupt state or future edits
1047          * break this */
1048         if ((l1 = BM_face_vert_share_loop(f, v1)) &&
1049             (l2 = BM_face_vert_share_loop(f, v2)) &&
1050             BM_face_split(bm, f, l1, l2, NULL, NULL, true))
1051         {
1052                 /* we should really be able to know the faces some other way,
1053                  * rather then fetching them back from the edge, but this is predictable
1054                  * where using the return values from face split isn't. - campbell */
1055                 BMFace *fa, *fb;
1056                 if (BM_edge_face_pair(e_new, &fa, &fb)) {
1057                         fa->head.hflag = f_hflag_prev_1;
1058                         fb->head.hflag = f_hflag_prev_2;
1059                 }
1060         }
1061         else {
1062                 return NULL;
1063         }
1064
1065         return e_new;
1066 }
1067
1068 /**
1069  * \brief Rip a single face from a vertex fan
1070  */
1071 BMVert *BM_face_vert_separate(BMesh *bm, BMFace *sf, BMVert *sv)
1072 {
1073         return bmesh_urmv(bm, sf, sv);
1074 }
1075
1076 /**
1077  * \brief Rip a single face from a vertex fan
1078  *
1079  * \note same as #BM_face_vert_separate but faster (avoids a loop lookup)
1080  */
1081 BMVert *BM_face_loop_separate(BMesh *bm, BMLoop *sl)
1082 {
1083         return bmesh_urmv_loop(bm, sl);
1084 }