1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
|
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file blender/bmesh/intern/bmesh_log.c
* \ingroup bmesh
*
* The BMLog is an interface for storing undo/redo steps as a BMesh is
* modified. It only stores changes to the BMesh, not full copies.
*
* Currently it supports the following types of changes:
*
* - Adding and removing vertices
* - Adding and removing faces
* - Moving vertices
* - Setting vertex paint-mask values
* - Setting vertex hflags
*/
#include "MEM_guardedalloc.h"
#include "BLI_utildefines.h"
#include "BLI_ghash.h"
#include "BLI_listbase.h"
#include "BLI_math.h"
#include "BLI_mempool.h"
#include "BKE_customdata.h"
#include "bmesh.h"
#include "bmesh_log.h"
#include "range_tree_c_api.h"
#include "BLI_strict_flags.h"
struct BMLogEntry {
struct BMLogEntry *next, *prev;
/* The following GHashes map from an element ID to one of the log
* types above */
/* Elements that were in the previous entry, but have been
* deleted */
GHash *deleted_verts;
GHash *deleted_faces;
/* Elements that were not in the previous entry, but are in the
* result of this entry */
GHash *added_verts;
GHash *added_faces;
/* Vertices whose coordinates, mask value, or hflag have changed */
GHash *modified_verts;
GHash *modified_faces;
BLI_mempool *pool_verts;
BLI_mempool *pool_faces;
/* This is only needed for dropping BMLogEntries while still in
* dynamic-topology mode, as that should release vert/face IDs
* back to the BMLog but no BMLog pointer is available at that
* time.
*
* This field is not guaranteed to be valid, any use of it should
* check for NULL. */
BMLog *log;
};
struct BMLog {
/* Tree of free IDs */
struct RangeTreeUInt *unused_ids;
/* Mapping from unique IDs to vertices and faces
*
* Each vertex and face in the log gets a unique unsigned integer
* assigned. That ID is taken from the set managed by the
* unused_ids range tree.
*
* The ID is needed because element pointers will change as they
* are created and deleted.
*/
GHash *id_to_elem;
GHash *elem_to_id;
/* All BMLogEntrys, ordered from earliest to most recent */
ListBase entries;
/* The current log entry from entries list
*
* If null, then the original mesh from before any of the log
* entries is current (i.e. there is nothing left to undo.)
*
* If equal to the last entry in the entries list, then all log
* entries have been applied (i.e. there is nothing left to redo.)
*/
BMLogEntry *current_entry;
};
typedef struct {
float co[3];
short no[3];
float mask;
char hflag;
} BMLogVert;
typedef struct {
unsigned int v_ids[3];
char hflag;
} BMLogFace;
/************************* Get/set element IDs ************************/
/* Get the vertex's unique ID from the log */
static unsigned int bm_log_vert_id_get(BMLog *log, BMVert *v)
{
BLI_assert(BLI_ghash_haskey(log->elem_to_id, v));
return GET_UINT_FROM_POINTER(BLI_ghash_lookup(log->elem_to_id, v));
}
/* Set the vertex's unique ID in the log */
static void bm_log_vert_id_set(BMLog *log, BMVert *v, unsigned int id)
{
void *vid = SET_UINT_IN_POINTER(id);
BLI_ghash_reinsert(log->id_to_elem, vid, v, NULL, NULL);
BLI_ghash_reinsert(log->elem_to_id, v, vid, NULL, NULL);
}
/* Get a vertex from its unique ID */
static BMVert *bm_log_vert_from_id(BMLog *log, unsigned int id)
{
void *key = SET_UINT_IN_POINTER(id);
BLI_assert(BLI_ghash_haskey(log->id_to_elem, key));
return BLI_ghash_lookup(log->id_to_elem, key);
}
/* Get the face's unique ID from the log */
static unsigned int bm_log_face_id_get(BMLog *log, BMFace *f)
{
BLI_assert(BLI_ghash_haskey(log->elem_to_id, f));
return GET_UINT_FROM_POINTER(BLI_ghash_lookup(log->elem_to_id, f));
}
/* Set the face's unique ID in the log */
static void bm_log_face_id_set(BMLog *log, BMFace *f, unsigned int id)
{
void *fid = SET_UINT_IN_POINTER(id);
BLI_ghash_reinsert(log->id_to_elem, fid, f, NULL, NULL);
BLI_ghash_reinsert(log->elem_to_id, f, fid, NULL, NULL);
}
/* Get a face from its unique ID */
static BMFace *bm_log_face_from_id(BMLog *log, unsigned int id)
{
void *key = SET_UINT_IN_POINTER(id);
BLI_assert(BLI_ghash_haskey(log->id_to_elem, key));
return BLI_ghash_lookup(log->id_to_elem, key);
}
/************************ BMLogVert / BMLogFace ***********************/
/* Get a vertex's paint-mask value
*
* Returns zero if no paint-mask layer is present */
static float vert_mask_get(BMVert *v, const int cd_vert_mask_offset)
{
if (cd_vert_mask_offset != -1) {
return BM_ELEM_CD_GET_FLOAT(v, cd_vert_mask_offset);
}
else {
return 0.0f;
}
}
/* Set a vertex's paint-mask value
*
* Has no effect is no paint-mask layer is present */
static void vert_mask_set(BMVert *v, const float new_mask, const int cd_vert_mask_offset)
{
if (cd_vert_mask_offset != -1) {
BM_ELEM_CD_SET_FLOAT(v, cd_vert_mask_offset, new_mask);
}
}
/* Update a BMLogVert with data from a BMVert */
static void bm_log_vert_bmvert_copy(BMLogVert *lv, BMVert *v, const int cd_vert_mask_offset)
{
copy_v3_v3(lv->co, v->co);
normal_float_to_short_v3(lv->no, v->no);
lv->mask = vert_mask_get(v, cd_vert_mask_offset);
lv->hflag = v->head.hflag;
}
/* Allocate and initialize a BMLogVert */
static BMLogVert *bm_log_vert_alloc(BMLog *log, BMVert *v, const int cd_vert_mask_offset)
{
BMLogEntry *entry = log->current_entry;
BMLogVert *lv = BLI_mempool_alloc(entry->pool_verts);
bm_log_vert_bmvert_copy(lv, v, cd_vert_mask_offset);
return lv;
}
/* Allocate and initialize a BMLogFace */
static BMLogFace *bm_log_face_alloc(BMLog *log, BMFace *f)
{
BMLogEntry *entry = log->current_entry;
BMLogFace *lf = BLI_mempool_alloc(entry->pool_faces);
BMVert *v[3];
BLI_assert(f->len == 3);
// BM_iter_as_array(NULL, BM_VERTS_OF_FACE, f, (void **)v, 3);
BM_face_as_array_vert_tri(f, v);
lf->v_ids[0] = bm_log_vert_id_get(log, v[0]);
lf->v_ids[1] = bm_log_vert_id_get(log, v[1]);
lf->v_ids[2] = bm_log_vert_id_get(log, v[2]);
lf->hflag = f->head.hflag;
return lf;
}
/************************ Helpers for undo/redo ***********************/
static void bm_log_verts_unmake(BMesh *bm, BMLog *log, GHash *verts)
{
const int cd_vert_mask_offset = CustomData_get_offset(&bm->vdata, CD_PAINT_MASK);
GHashIterator gh_iter;
GHASH_ITER (gh_iter, verts) {
void *key = BLI_ghashIterator_getKey(&gh_iter);
BMLogVert *lv = BLI_ghashIterator_getValue(&gh_iter);
unsigned int id = GET_UINT_FROM_POINTER(key);
BMVert *v = bm_log_vert_from_id(log, id);
/* Ensure the log has the final values of the vertex before
* deleting it */
bm_log_vert_bmvert_copy(lv, v, cd_vert_mask_offset);
BM_vert_kill(bm, v);
}
}
static void bm_log_faces_unmake(BMesh *bm, BMLog *log, GHash *faces)
{
GHashIterator gh_iter;
GHASH_ITER (gh_iter, faces) {
void *key = BLI_ghashIterator_getKey(&gh_iter);
unsigned int id = GET_UINT_FROM_POINTER(key);
BMFace *f = bm_log_face_from_id(log, id);
BMEdge *e_tri[3];
BMLoop *l_iter;
int i;
l_iter = BM_FACE_FIRST_LOOP(f);
for (i = 0; i < 3; i++, l_iter = l_iter->next) {
e_tri[i] = l_iter->e;
}
/* Remove any unused edges */
BM_face_kill(bm, f);
for (i = 0; i < 3; i++) {
if (BM_edge_is_wire(e_tri[i])) {
BM_edge_kill(bm, e_tri[i]);
}
}
}
}
static void bm_log_verts_restore(BMesh *bm, BMLog *log, GHash *verts)
{
const int cd_vert_mask_offset = CustomData_get_offset(&bm->vdata, CD_PAINT_MASK);
GHashIterator gh_iter;
GHASH_ITER (gh_iter, verts) {
void *key = BLI_ghashIterator_getKey(&gh_iter);
BMLogVert *lv = BLI_ghashIterator_getValue(&gh_iter);
BMVert *v = BM_vert_create(bm, lv->co, NULL, BM_CREATE_NOP);
vert_mask_set(v, lv->mask, cd_vert_mask_offset);
v->head.hflag = lv->hflag;
normal_short_to_float_v3(v->no, lv->no);
bm_log_vert_id_set(log, v, GET_UINT_FROM_POINTER(key));
}
}
static void bm_log_faces_restore(BMesh *bm, BMLog *log, GHash *faces)
{
GHashIterator gh_iter;
GHASH_ITER (gh_iter, faces) {
void *key = BLI_ghashIterator_getKey(&gh_iter);
BMLogFace *lf = BLI_ghashIterator_getValue(&gh_iter);
BMVert *v[3] = {bm_log_vert_from_id(log, lf->v_ids[0]),
bm_log_vert_from_id(log, lf->v_ids[1]),
bm_log_vert_from_id(log, lf->v_ids[2])};
BMFace *f;
f = BM_face_create_verts(bm, v, 3, NULL, BM_CREATE_NOP, true);
f->head.hflag = lf->hflag;
bm_log_face_id_set(log, f, GET_UINT_FROM_POINTER(key));
}
}
static void bm_log_vert_values_swap(BMesh *bm, BMLog *log, GHash *verts)
{
const int cd_vert_mask_offset = CustomData_get_offset(&bm->vdata, CD_PAINT_MASK);
GHashIterator gh_iter;
GHASH_ITER (gh_iter, verts) {
void *key = BLI_ghashIterator_getKey(&gh_iter);
BMLogVert *lv = BLI_ghashIterator_getValue(&gh_iter);
unsigned int id = GET_UINT_FROM_POINTER(key);
BMVert *v = bm_log_vert_from_id(log, id);
float mask;
short normal[3];
swap_v3_v3(v->co, lv->co);
copy_v3_v3_short(normal, lv->no);
normal_float_to_short_v3(lv->no, v->no);
normal_short_to_float_v3(v->no, normal);
SWAP(char, v->head.hflag, lv->hflag);
mask = lv->mask;
lv->mask = vert_mask_get(v, cd_vert_mask_offset);
vert_mask_set(v, mask, cd_vert_mask_offset);
}
}
static void bm_log_face_values_swap(BMLog *log, GHash *faces)
{
GHashIterator gh_iter;
GHASH_ITER (gh_iter, faces) {
void *key = BLI_ghashIterator_getKey(&gh_iter);
BMLogFace *lf = BLI_ghashIterator_getValue(&gh_iter);
unsigned int id = GET_UINT_FROM_POINTER(key);
BMFace *f = bm_log_face_from_id(log, id);
SWAP(char, f->head.hflag, lf->hflag);
}
}
/**********************************************************************/
/* Assign unique IDs to all vertices and faces already in the BMesh */
static void bm_log_assign_ids(BMesh *bm, BMLog *log)
{
BMIter iter;
BMVert *v;
BMFace *f;
/* Generate vertex IDs */
BM_ITER_MESH (v, &iter, bm, BM_VERTS_OF_MESH) {
unsigned int id = range_tree_uint_take_any(log->unused_ids);
bm_log_vert_id_set(log, v, id);
}
/* Generate face IDs */
BM_ITER_MESH (f, &iter, bm, BM_FACES_OF_MESH) {
unsigned int id = range_tree_uint_take_any(log->unused_ids);
bm_log_face_id_set(log, f, id);
}
}
/* Allocate an empty log entry */
static BMLogEntry *bm_log_entry_create(void)
{
BMLogEntry *entry = MEM_callocN(sizeof(BMLogEntry), __func__);
entry->deleted_verts = BLI_ghash_ptr_new(__func__);
entry->deleted_faces = BLI_ghash_ptr_new(__func__);
entry->added_verts = BLI_ghash_ptr_new(__func__);
entry->added_faces = BLI_ghash_ptr_new(__func__);
entry->modified_verts = BLI_ghash_ptr_new(__func__);
entry->modified_faces = BLI_ghash_ptr_new(__func__);
entry->pool_verts = BLI_mempool_create(sizeof(BMLogVert), 0, 64, BLI_MEMPOOL_NOP);
entry->pool_faces = BLI_mempool_create(sizeof(BMLogFace), 0, 64, BLI_MEMPOOL_NOP);
return entry;
}
/* Free the data in a log entry
*
* Note: does not free the log entry itself */
static void bm_log_entry_free(BMLogEntry *entry)
{
BLI_ghash_free(entry->deleted_verts, NULL, NULL);
BLI_ghash_free(entry->deleted_faces, NULL, NULL);
BLI_ghash_free(entry->added_verts, NULL, NULL);
BLI_ghash_free(entry->added_faces, NULL, NULL);
BLI_ghash_free(entry->modified_verts, NULL, NULL);
BLI_ghash_free(entry->modified_faces, NULL, NULL);
BLI_mempool_destroy(entry->pool_verts);
BLI_mempool_destroy(entry->pool_faces);
}
static void bm_log_id_ghash_retake(RangeTreeUInt *unused_ids, GHash *id_ghash)
{
GHashIterator gh_iter;
GHASH_ITER (gh_iter, id_ghash) {
void *key = BLI_ghashIterator_getKey(&gh_iter);
unsigned int id = GET_UINT_FROM_POINTER(key);
if (range_tree_uint_has(unused_ids, id)) {
range_tree_uint_take(unused_ids, id);
}
}
}
static int uint_compare(const void *a_v, const void *b_v)
{
const unsigned int *a = a_v;
const unsigned int *b = b_v;
return (*a) < (*b);
}
/* Remap IDs to contiguous indices
*
* E.g. if the vertex IDs are (4, 1, 10, 3), the mapping will be:
* 4 -> 2
* 1 -> 0
* 10 -> 3
* 3 -> 1
*/
static GHash *bm_log_compress_ids_to_indices(unsigned int *ids, unsigned int totid)
{
GHash *map = BLI_ghash_int_new_ex(__func__, totid);
unsigned int i;
qsort(ids, totid, sizeof(*ids), uint_compare);
for (i = 0; i < totid; i++) {
void *key = SET_UINT_IN_POINTER(ids[i]);
void *val = SET_UINT_IN_POINTER(i);
BLI_ghash_insert(map, key, val);
}
return map;
}
/* Release all ID keys in id_ghash */
static void bm_log_id_ghash_release(BMLog *log, GHash *id_ghash)
{
GHashIterator gh_iter;
GHASH_ITER (gh_iter, id_ghash) {
void *key = BLI_ghashIterator_getKey(&gh_iter);
unsigned int id = GET_UINT_FROM_POINTER(key);
range_tree_uint_release(log->unused_ids, id);
}
}
/***************************** Public API *****************************/
/* Allocate, initialize, and assign a new BMLog */
BMLog *BM_log_create(BMesh *bm)
{
BMLog *log = MEM_callocN(sizeof(*log), __func__);
log->unused_ids = range_tree_uint_alloc(0, (unsigned)-1);
log->id_to_elem = BLI_ghash_ptr_new_ex(__func__, (unsigned int)(bm->totvert + bm->totface));
log->elem_to_id = BLI_ghash_ptr_new_ex(__func__, (unsigned int)(bm->totvert + bm->totface));
/* Assign IDs to all existing vertices and faces */
bm_log_assign_ids(bm, log);
return log;
}
void BM_log_cleanup_entry(BMLogEntry *entry)
{
BMLog *log = entry->log;
if (log) {
/* Take all used IDs */
bm_log_id_ghash_retake(log->unused_ids, entry->deleted_verts);
bm_log_id_ghash_retake(log->unused_ids, entry->deleted_faces);
bm_log_id_ghash_retake(log->unused_ids, entry->added_verts);
bm_log_id_ghash_retake(log->unused_ids, entry->added_faces);
bm_log_id_ghash_retake(log->unused_ids, entry->modified_verts);
bm_log_id_ghash_retake(log->unused_ids, entry->modified_faces);
/* delete entries to avoid releasing ids in node cleanup */
BLI_ghash_clear(entry->deleted_verts, NULL, NULL);
BLI_ghash_clear(entry->deleted_faces, NULL, NULL);
BLI_ghash_clear(entry->added_verts, NULL, NULL);
BLI_ghash_clear(entry->added_faces, NULL, NULL);
BLI_ghash_clear(entry->modified_verts, NULL, NULL);
}
}
/* Allocate and initialize a new BMLog using existing BMLogEntries
*
* The 'entry' should be the last entry in the BMLog. Its prev pointer
* will be followed back to find the first entry.
*
* The unused IDs field of the log will be initialized by taking all
* keys from all GHashes in the log entry.
*/
BMLog *BM_log_from_existing_entries_create(BMesh *bm, BMLogEntry *entry)
{
BMLog *log = BM_log_create(bm);
if (entry->prev)
log->current_entry = entry;
else
log->current_entry = NULL;
/* Let BMLog manage the entry list again */
log->entries.first = log->entries.last = entry;
{
while (entry->prev) {
entry = entry->prev;
log->entries.first = entry;
}
entry = log->entries.last;
while (entry->next) {
entry = entry->next;
log->entries.last = entry;
}
}
for (entry = log->entries.first; entry; entry = entry->next) {
entry->log = log;
/* Take all used IDs */
bm_log_id_ghash_retake(log->unused_ids, entry->deleted_verts);
bm_log_id_ghash_retake(log->unused_ids, entry->deleted_faces);
bm_log_id_ghash_retake(log->unused_ids, entry->added_verts);
bm_log_id_ghash_retake(log->unused_ids, entry->added_faces);
bm_log_id_ghash_retake(log->unused_ids, entry->modified_verts);
bm_log_id_ghash_retake(log->unused_ids, entry->modified_faces);
}
return log;
}
/* Free all the data in a BMLog including the log itself */
void BM_log_free(BMLog *log)
{
BMLogEntry *entry;
if (log->unused_ids)
range_tree_uint_free(log->unused_ids);
if (log->id_to_elem)
BLI_ghash_free(log->id_to_elem, NULL, NULL);
if (log->elem_to_id)
BLI_ghash_free(log->elem_to_id, NULL, NULL);
/* Clear the BMLog references within each entry, but do not free
* the entries themselves */
for (entry = log->entries.first; entry; entry = entry->next)
entry->log = NULL;
MEM_freeN(log);
}
/* Get the number of log entries */
int BM_log_length(const BMLog *log)
{
return BLI_countlist(&log->entries);
}
/* Apply a consistent ordering to BMesh vertices */
void BM_log_mesh_elems_reorder(BMesh *bm, BMLog *log)
{
void *varr;
void *farr;
GHash *id_to_idx;
BMIter bm_iter;
BMVert *v;
BMFace *f;
int i;
/* Put all vertex IDs into an array */
i = 0;
varr = MEM_mallocN(sizeof(int) * (size_t)bm->totvert, __func__);
BM_ITER_MESH (v, &bm_iter, bm, BM_VERTS_OF_MESH) {
((unsigned int *)varr)[i++] = bm_log_vert_id_get(log, v);
}
/* Put all face IDs into an array */
i = 0;
farr = MEM_mallocN(sizeof(int) * (size_t)bm->totface, __func__);
BM_ITER_MESH (f, &bm_iter, bm, BM_FACES_OF_MESH) {
((unsigned int *)farr)[i++] = bm_log_face_id_get(log, f);
}
/* Create BMVert index remap array */
id_to_idx = bm_log_compress_ids_to_indices(varr, (unsigned int)bm->totvert);
i = 0;
BM_ITER_MESH (v, &bm_iter, bm, BM_VERTS_OF_MESH) {
const unsigned id = bm_log_vert_id_get(log, v);
const void *key = SET_UINT_IN_POINTER(id);
const void *val = BLI_ghash_lookup(id_to_idx, key);
((unsigned int *)varr)[i++] = GET_UINT_FROM_POINTER(val);
}
BLI_ghash_free(id_to_idx, NULL, NULL);
/* Create BMFace index remap array */
id_to_idx = bm_log_compress_ids_to_indices(farr, (unsigned int)bm->totface);
i = 0;
BM_ITER_MESH (f, &bm_iter, bm, BM_FACES_OF_MESH) {
const unsigned id = bm_log_face_id_get(log, f);
const void *key = SET_UINT_IN_POINTER(id);
const void *val = BLI_ghash_lookup(id_to_idx, key);
((unsigned int *)farr)[i++] = GET_UINT_FROM_POINTER(val);
}
BLI_ghash_free(id_to_idx, NULL, NULL);
BM_mesh_remap(bm, varr, NULL, farr);
MEM_freeN(varr);
MEM_freeN(farr);
}
/* Start a new log entry and update the log entry list
*
* If the log entry list is empty, or if the current log entry is the
* last entry, the new entry is simply appended to the end.
*
* Otherwise, the new entry is added after the current entry and all
* following entries are deleted.
*
* In either case, the new entry is set as the current log entry.
*/
BMLogEntry *BM_log_entry_add(BMLog *log)
{
BMLogEntry *entry, *next;
/* Delete any entries after the current one */
entry = log->current_entry;
if (entry) {
for (entry = entry->next; entry; entry = next) {
next = entry->next;
bm_log_entry_free(entry);
BLI_freelinkN(&log->entries, entry);
}
}
/* Create and append the new entry */
entry = bm_log_entry_create();
BLI_addtail(&log->entries, entry);
entry->log = log;
log->current_entry = entry;
return entry;
}
/* Remove an entry from the log
*
* Uses entry->log as the log. If the log is NULL, the entry will be
* free'd but not removed from any list, nor shall its IDs be
* released.
*
* This operation is only valid on the first and last entries in the
* log. Deleting from the middle will assert.
*/
void BM_log_entry_drop(BMLogEntry *entry)
{
BMLog *log = entry->log;
if (!log) {
/* Unlink */
BLI_assert(!(entry->prev && entry->next));
if (entry->prev)
entry->prev->next = NULL;
else if (entry->next)
entry->next->prev = NULL;
bm_log_entry_free(entry);
MEM_freeN(entry);
return;
}
if (!entry->prev) {
/* Release IDs of elements that are deleted by this
* entry. Since the entry is at the beginning of the undo
* stack, and it's being deleted, those elements can never be
* restored. Their IDs can go back into the pool. */
/* This would never happen usually since first entry of log is
* usually dyntopo enable, which, when reverted will free the log
* completely. However, it is possible have a stroke instead of
* dyntopo enable as first entry if nodes have been cleaned up
* after sculpting on a different object than A, B.
*
* The steps are:
* A dyntopo enable - sculpt
* B dyntopo enable - sculpt - undo (A objects operators get cleaned up)
* A sculpt (now A's log has a sculpt operator as first entry)
*
* Causing a cleanup at this point will call the code below, however
* this will invalidate the state of the log since the deleted vertices
* have been reclaimed already on step 2 (see BM_log_cleanup_entry)
*
* Also, design wise, a first entry should not have any deleted vertices since it
* should not have anything to delete them -from-
*/
//bm_log_id_ghash_release(log, entry->deleted_faces);
//bm_log_id_ghash_release(log, entry->deleted_verts);
}
else if (!entry->next) {
/* Release IDs of elements that are added by this entry. Since
* the entry is at the end of the undo stack, and it's being
* deleted, those elements can never be restored. Their IDs
* can go back into the pool. */
bm_log_id_ghash_release(log, entry->added_faces);
bm_log_id_ghash_release(log, entry->added_verts);
}
else {
BLI_assert(!"Cannot drop BMLogEntry from middle");
}
if (log->current_entry == entry)
log->current_entry = entry->prev;
bm_log_entry_free(entry);
BLI_freelinkN(&log->entries, entry);
}
/* Undo one BMLogEntry
*
* Has no effect if there's nothing left to undo */
void BM_log_undo(BMesh *bm, BMLog *log)
{
BMLogEntry *entry = log->current_entry;
if (entry) {
log->current_entry = entry->prev;
/* Delete added faces and verts */
bm_log_faces_unmake(bm, log, entry->added_faces);
bm_log_verts_unmake(bm, log, entry->added_verts);
/* Restore deleted verts and faces */
bm_log_verts_restore(bm, log, entry->deleted_verts);
bm_log_faces_restore(bm, log, entry->deleted_faces);
/* Restore vertex coordinates, mask, and hflag */
bm_log_vert_values_swap(bm, log, entry->modified_verts);
bm_log_face_values_swap(log, entry->modified_faces);
}
}
/* Redo one BMLogEntry
*
* Has no effect if there's nothing left to redo */
void BM_log_redo(BMesh *bm, BMLog *log)
{
BMLogEntry *entry = log->current_entry;
if (!entry) {
/* Currently at the beginning of the undo stack, move to first entry */
entry = log->entries.first;
}
else if (entry && entry->next) {
/* Move to next undo entry */
entry = entry->next;
}
else {
/* Currently at the end of the undo stack, nothing left to redo */
return;
}
log->current_entry = entry;
if (entry) {
/* Re-delete previously deleted faces and verts */
bm_log_faces_unmake(bm, log, entry->deleted_faces);
bm_log_verts_unmake(bm, log, entry->deleted_verts);
/* Restore previously added verts and faces */
bm_log_verts_restore(bm, log, entry->added_verts);
bm_log_faces_restore(bm, log, entry->added_faces);
/* Restore vertex coordinates, mask, and hflag */
bm_log_vert_values_swap(bm, log, entry->modified_verts);
bm_log_face_values_swap(log, entry->modified_faces);
}
}
/* Log a vertex before it is modified
*
* Before modifying vertex coordinates, masks, or hflags, call this
* function to log it's current values. This is better than logging
* after the coordinates have been modified, because only those
* vertices that are modified need to have their original values
* stored.
*
* Handles two separate cases:
*
* If the vertex was added in the current log entry, update the
* vertex in the map of added vertices.
*
* If the vertex already existed prior to the current log entry, a
* separate key/value map of modified vertices is used (using the
* vertex's ID as the key). The values stored in that case are
* the vertex's original state so that an undo can restore the
* previous state.
*
* On undo, the current vertex state will be swapped with the stored
* state so that a subsequent redo operation will restore the newer
* vertex state.
*/
void BM_log_vert_before_modified(BMLog *log, BMVert *v, const int cd_vert_mask_offset)
{
BMLogEntry *entry = log->current_entry;
BMLogVert *lv;
unsigned int v_id = bm_log_vert_id_get(log, v);
void *key = SET_UINT_IN_POINTER(v_id);
/* Find or create the BMLogVert entry */
if ((lv = BLI_ghash_lookup(entry->added_verts, key))) {
bm_log_vert_bmvert_copy(lv, v, cd_vert_mask_offset);
}
else if (!BLI_ghash_haskey(entry->modified_verts, key)) {
lv = bm_log_vert_alloc(log, v, cd_vert_mask_offset);
BLI_ghash_insert(entry->modified_verts, key, lv);
}
}
/* Log a new vertex as added to the BMesh
*
* The new vertex gets a unique ID assigned. It is then added to a map
* of added vertices, with the key being its ID and the value
* containing everything needed to reconstruct that vertex.
*/
void BM_log_vert_added(BMLog *log, BMVert *v, const int cd_vert_mask_offset)
{
BMLogVert *lv;
unsigned int v_id = range_tree_uint_take_any(log->unused_ids);
void *key = SET_UINT_IN_POINTER(v_id);
bm_log_vert_id_set(log, v, v_id);
lv = bm_log_vert_alloc(log, v, cd_vert_mask_offset);
BLI_ghash_insert(log->current_entry->added_verts, key, lv);
}
/* Log a face before it is modified
*
* This is intended to handle only header flags and we always
* assume face has been added before
*/
void BM_log_face_modified(BMLog *log, BMFace *f)
{
BMLogFace *lf;
unsigned int f_id = bm_log_face_id_get(log, f);
void *key = SET_UINT_IN_POINTER(f_id);
lf = bm_log_face_alloc(log, f);
BLI_ghash_insert(log->current_entry->modified_faces, key, lf);
}
/* Log a new face as added to the BMesh
*
* The new face gets a unique ID assigned. It is then added to a map
* of added faces, with the key being its ID and the value containing
* everything needed to reconstruct that face.
*/
void BM_log_face_added(BMLog *log, BMFace *f)
{
BMLogFace *lf;
unsigned int f_id = range_tree_uint_take_any(log->unused_ids);
void *key = SET_UINT_IN_POINTER(f_id);
/* Only triangles are supported for now */
BLI_assert(f->len == 3);
bm_log_face_id_set(log, f, f_id);
lf = bm_log_face_alloc(log, f);
BLI_ghash_insert(log->current_entry->added_faces, key, lf);
}
/* Log a vertex as removed from the BMesh
*
* A couple things can happen here:
*
* If the vertex was added as part of the current log entry, then it's
* deleted and forgotten about entirely. Its unique ID is returned to
* the unused pool.
*
* If the vertex was already part of the BMesh before the current log
* entry, it is added to a map of deleted vertices, with the key being
* its ID and the value containing everything needed to reconstruct
* that vertex.
*
* If there's a move record for the vertex, that's used as the
* vertices original location, then the move record is deleted.
*/
void BM_log_vert_removed(BMLog *log, BMVert *v, const int cd_vert_mask_offset)
{
BMLogEntry *entry = log->current_entry;
unsigned int v_id = bm_log_vert_id_get(log, v);
void *key = SET_UINT_IN_POINTER(v_id);
/* if it has a key, it shouldn't be NULL */
BLI_assert(!!BLI_ghash_lookup(entry->added_verts, key) ==
!!BLI_ghash_haskey(entry->added_verts, key));
if (BLI_ghash_remove(entry->added_verts, key, NULL, NULL)) {
range_tree_uint_release(log->unused_ids, v_id);
}
else {
BMLogVert *lv, *lv_mod;
lv = bm_log_vert_alloc(log, v, cd_vert_mask_offset);
BLI_ghash_insert(entry->deleted_verts, key, lv);
/* If the vertex was modified before deletion, ensure that the
* original vertex values are stored */
if ((lv_mod = BLI_ghash_lookup(entry->modified_verts, key))) {
(*lv) = (*lv_mod);
BLI_ghash_remove(entry->modified_verts, key, NULL, NULL);
}
}
}
/* Log a face as removed from the BMesh
*
* A couple things can happen here:
*
* If the face was added as part of the current log entry, then it's
* deleted and forgotten about entirely. Its unique ID is returned to
* the unused pool.
*
* If the face was already part of the BMesh before the current log
* entry, it is added to a map of deleted faces, with the key being
* its ID and the value containing everything needed to reconstruct
* that face.
*/
void BM_log_face_removed(BMLog *log, BMFace *f)
{
BMLogEntry *entry = log->current_entry;
unsigned int f_id = bm_log_face_id_get(log, f);
void *key = SET_UINT_IN_POINTER(f_id);
/* if it has a key, it shouldn't be NULL */
BLI_assert(!!BLI_ghash_lookup(entry->added_faces, key) ==
!!BLI_ghash_haskey(entry->added_faces, key));
if (BLI_ghash_remove(entry->added_faces, key, NULL, NULL)) {
range_tree_uint_release(log->unused_ids, f_id);
}
else {
BMLogFace *lf;
lf = bm_log_face_alloc(log, f);
BLI_ghash_insert(entry->deleted_faces, key, lf);
}
}
/* Log all vertices/faces in the BMesh as added */
void BM_log_all_added(BMesh *bm, BMLog *log)
{
const int cd_vert_mask_offset = CustomData_get_offset(&bm->vdata, CD_PAINT_MASK);
BMIter bm_iter;
BMVert *v;
BMFace *f;
/* Log all vertices as newly created */
BM_ITER_MESH (v, &bm_iter, bm, BM_VERTS_OF_MESH) {
BM_log_vert_added(log, v, cd_vert_mask_offset);
}
/* Log all faces as newly created */
BM_ITER_MESH (f, &bm_iter, bm, BM_FACES_OF_MESH) {
BM_log_face_added(log, f);
}
}
/* Log all vertices/faces in the BMesh as removed */
void BM_log_before_all_removed(BMesh *bm, BMLog *log)
{
const int cd_vert_mask_offset = CustomData_get_offset(&bm->vdata, CD_PAINT_MASK);
BMIter bm_iter;
BMVert *v;
BMFace *f;
/* Log deletion of all faces */
BM_ITER_MESH (f, &bm_iter, bm, BM_FACES_OF_MESH) {
BM_log_face_removed(log, f);
}
/* Log deletion of all vertices */
BM_ITER_MESH (v, &bm_iter, bm, BM_VERTS_OF_MESH) {
BM_log_vert_removed(log, v, cd_vert_mask_offset);
}
}
/* Get the logged coordinates of a vertex
*
* Does not modify the log or the vertex */
const float *BM_log_original_vert_co(BMLog *log, BMVert *v)
{
BMLogEntry *entry = log->current_entry;
const BMLogVert *lv;
unsigned v_id = bm_log_vert_id_get(log, v);
void *key = SET_UINT_IN_POINTER(v_id);
BLI_assert(entry);
BLI_assert(BLI_ghash_haskey(entry->modified_verts, key));
lv = BLI_ghash_lookup(entry->modified_verts, key);
return lv->co;
}
/* Get the logged normal of a vertex
*
* Does not modify the log or the vertex */
const short *BM_log_original_vert_no(BMLog *log, BMVert *v)
{
BMLogEntry *entry = log->current_entry;
const BMLogVert *lv;
unsigned v_id = bm_log_vert_id_get(log, v);
void *key = SET_UINT_IN_POINTER(v_id);
BLI_assert(entry);
BLI_assert(BLI_ghash_haskey(entry->modified_verts, key));
lv = BLI_ghash_lookup(entry->modified_verts, key);
return lv->no;
}
/* Get the logged mask of a vertex
*
* Does not modify the log or the vertex */
float BM_log_original_mask(BMLog *log, BMVert *v)
{
BMLogEntry *entry = log->current_entry;
const BMLogVert *lv;
unsigned v_id = bm_log_vert_id_get(log, v);
void *key = SET_UINT_IN_POINTER(v_id);
BLI_assert(entry);
BLI_assert(BLI_ghash_haskey(entry->modified_verts, key));
lv = BLI_ghash_lookup(entry->modified_verts, key);
return lv->mask;
}
/************************ Debugging and Testing ***********************/
/* For internal use only (unit testing) */
BMLogEntry *BM_log_current_entry(BMLog *log)
{
return log->current_entry;
}
/* For internal use only (unit testing) */
RangeTreeUInt *BM_log_unused_ids(BMLog *log)
{
return log->unused_ids;
}
#if 0
/* Print the list of entries, marking the current one
*
* Keep around for debugging */
void bm_log_print(const BMLog *log, const char *description)
{
const BMLogEntry *entry;
const char *current = " <-- current";
int i;
printf("%s:\n", description);
printf(" % 2d: [ initial ]%s\n", 0,
(!log->current_entry) ? current : "");
for (entry = log->entries.first, i = 1; entry; entry = entry->next, i++) {
printf(" % 2d: [%p]%s\n", i, entry,
(entry == log->current_entry) ? current : "");
}
}
#endif
|