b0fd7faa70d4be5ce7898d3386f30274c6926706
[blender.git] / source / blender / editors / sculpt_paint / sculpt_undo.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  * The Original Code is Copyright (C) 2006 by Nicholas Bishop
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  *
27  * Implements the Sculpt Mode tools
28  *
29  */
30
31 /** \file blender/editors/sculpt_paint/sculpt_undo.c
32  *  \ingroup edsculpt
33  */
34
35 #include <stddef.h>
36
37 #include "MEM_guardedalloc.h"
38
39 #include "BLI_math.h"
40 #include "BLI_utildefines.h"
41 #include "BLI_string.h"
42 #include "BLI_listbase.h"
43 #include "BLI_ghash.h"
44 #include "BLI_threads.h"
45
46 #include "DNA_meshdata_types.h"
47 #include "DNA_object_types.h"
48 #include "DNA_scene_types.h"
49 #include "DNA_mesh_types.h"
50
51 #include "BKE_ccg.h"
52 #include "BKE_cdderivedmesh.h"
53 #include "BKE_context.h"
54 #include "BKE_depsgraph.h"
55 #include "BKE_modifier.h"
56 #include "BKE_multires.h"
57 #include "BKE_paint.h"
58 #include "BKE_key.h"
59 #include "BKE_mesh.h"
60 #include "BKE_subsurf.h"
61
62 #include "WM_api.h"
63 #include "WM_types.h"
64
65 #include "GPU_buffers.h"
66
67 #include "ED_sculpt.h"
68 #include "bmesh.h"
69 #include "paint_intern.h"
70 #include "sculpt_intern.h"
71
72 /************************** Undo *************************/
73
74 static void update_cb(PBVHNode *node, void *rebuild)
75 {
76         BKE_pbvh_node_mark_update(node);
77         if (*((int *)rebuild))
78                 BKE_pbvh_node_mark_rebuild_draw(node);
79         BKE_pbvh_node_fully_hidden_set(node, 0);
80 }
81
82 static void sculpt_undo_restore_deformed(const SculptSession *ss,
83                                          SculptUndoNode *unode,
84                                          int uindex, int oindex,
85                                          float coord[3])
86 {
87         if (unode->orig_co) {
88                 swap_v3_v3(coord, unode->orig_co[uindex]);
89                 copy_v3_v3(unode->co[uindex], ss->deform_cos[oindex]);
90         }
91         else {
92                 swap_v3_v3(coord, unode->co[uindex]);
93         }
94 }
95
96 static int sculpt_undo_restore_coords(bContext *C, DerivedMesh *dm, SculptUndoNode *unode)
97 {
98         Scene *scene = CTX_data_scene(C);
99         Sculpt *sd = CTX_data_tool_settings(C)->sculpt;
100         Object *ob = CTX_data_active_object(C);
101         SculptSession *ss = ob->sculpt;
102         MVert *mvert;
103         int *index, i, j;
104         
105         if (unode->maxvert) {
106                 /* regular mesh restore */
107
108                 if (ss->kb && strcmp(ss->kb->name, unode->shapeName)) {
109                         /* shape key has been changed before calling undo operator */
110
111                         Key *key = BKE_key_from_object(ob);
112                         KeyBlock *kb = key ? BKE_keyblock_find_name(key, unode->shapeName) : NULL;
113
114                         if (kb) {
115                                 ob->shapenr = BLI_findindex(&key->block, kb) + 1;
116
117                                 sculpt_update_mesh_elements(scene, sd, ob, 0, false);
118                                 WM_event_add_notifier(C, NC_OBJECT | ND_DATA, ob);
119                         }
120                         else {
121                                 /* key has been removed -- skip this undo node */
122                                 return 0;
123                         }
124                 }
125
126                 index = unode->index;
127                 mvert = ss->mvert;
128
129                 if (ss->kb) {
130                         float (*vertCos)[3];
131                         vertCos = BKE_key_convert_to_vertcos(ob, ss->kb);
132
133                         for (i = 0; i < unode->totvert; i++) {
134                                 if (ss->modifiers_active) {
135                                         sculpt_undo_restore_deformed(ss, unode, i, index[i], vertCos[index[i]]);
136                                 }
137                                 else {
138                                         if (unode->orig_co) swap_v3_v3(vertCos[index[i]], unode->orig_co[i]);
139                                         else swap_v3_v3(vertCos[index[i]], unode->co[i]);
140                                 }
141                         }
142
143                         /* propagate new coords to keyblock */
144                         sculpt_vertcos_to_key(ob, ss->kb, vertCos);
145
146                         /* pbvh uses it's own mvert array, so coords should be */
147                         /* propagated to pbvh here */
148                         BKE_pbvh_apply_vertCos(ss->pbvh, vertCos);
149
150                         MEM_freeN(vertCos);
151                 }
152                 else {
153                         for (i = 0; i < unode->totvert; i++) {
154                                 if (ss->modifiers_active) {
155                                         sculpt_undo_restore_deformed(ss, unode, i, index[i], mvert[index[i]].co);
156                                 }
157                                 else {
158                                         if (unode->orig_co) swap_v3_v3(mvert[index[i]].co, unode->orig_co[i]);
159                                         else swap_v3_v3(mvert[index[i]].co, unode->co[i]);
160                                 }
161                                 mvert[index[i]].flag |= ME_VERT_PBVH_UPDATE;
162                         }
163                 }
164         }
165         else if (unode->maxgrid && dm->getGridData) {
166                 /* multires restore */
167                 CCGElem **grids, *grid;
168                 CCGKey key;
169                 float (*co)[3];
170                 int gridsize;
171
172                 grids = dm->getGridData(dm);
173                 gridsize = dm->getGridSize(dm);
174                 dm->getGridKey(dm, &key);
175
176                 co = unode->co;
177                 for (j = 0; j < unode->totgrid; j++) {
178                         grid = grids[unode->grids[j]];
179
180                         for (i = 0; i < gridsize * gridsize; i++, co++)
181                                 swap_v3_v3(CCG_elem_offset_co(&key, grid, i), co[0]);
182                 }
183         }
184
185         return 1;
186 }
187
188 static int sculpt_undo_restore_hidden(bContext *C, DerivedMesh *dm,
189                                       SculptUndoNode *unode)
190 {
191         Object *ob = CTX_data_active_object(C);
192         SculptSession *ss = ob->sculpt;
193         int i;
194
195         if (unode->maxvert) {
196                 MVert *mvert = ss->mvert;
197                 
198                 for (i = 0; i < unode->totvert; i++) {
199                         MVert *v = &mvert[unode->index[i]];
200                         int uval = BLI_BITMAP_GET(unode->vert_hidden, i);
201
202                         BLI_BITMAP_MODIFY(unode->vert_hidden, i,
203                                           v->flag & ME_HIDE);
204                         if (uval)
205                                 v->flag |= ME_HIDE;
206                         else
207                                 v->flag &= ~ME_HIDE;
208                         
209                         v->flag |= ME_VERT_PBVH_UPDATE;
210                 }
211         }
212         else if (unode->maxgrid && dm->getGridData) {
213                 BLI_bitmap **grid_hidden = dm->getGridHidden(dm);
214                 
215                 for (i = 0; i < unode->totgrid; i++) {
216                         SWAP(BLI_bitmap *,
217                              unode->grid_hidden[i],
218                              grid_hidden[unode->grids[i]]);
219                         
220                 }
221         }
222
223         return 1;
224 }
225
226 static int sculpt_undo_restore_mask(bContext *C, DerivedMesh *dm, SculptUndoNode *unode)
227 {
228         Object *ob = CTX_data_active_object(C);
229         SculptSession *ss = ob->sculpt;
230         MVert *mvert;
231         float *vmask;
232         int *index, i, j;
233         
234         if (unode->maxvert) {
235                 /* regular mesh restore */
236
237                 index = unode->index;
238                 mvert = ss->mvert;
239                 vmask = ss->vmask;
240
241                 for (i = 0; i < unode->totvert; i++) {
242                         SWAP(float, vmask[index[i]], unode->mask[i]);
243                         mvert[index[i]].flag |= ME_VERT_PBVH_UPDATE;
244                 }
245         }
246         else if (unode->maxgrid && dm->getGridData) {
247                 /* multires restore */
248                 CCGElem **grids, *grid;
249                 CCGKey key;
250                 float *mask;
251                 int gridsize;
252
253                 grids = dm->getGridData(dm);
254                 gridsize = dm->getGridSize(dm);
255                 dm->getGridKey(dm, &key);
256
257                 mask = unode->mask;
258                 for (j = 0; j < unode->totgrid; j++) {
259                         grid = grids[unode->grids[j]];
260
261                         for (i = 0; i < gridsize * gridsize; i++, mask++)
262                                 SWAP(float, *CCG_elem_offset_mask(&key, grid, i), *mask);
263                 }
264         }
265
266         return 1;
267 }
268
269 static void sculpt_undo_bmesh_restore_generic(bContext *C,
270                                               SculptUndoNode *unode,
271                                               Object *ob,
272                                               SculptSession *ss)
273 {
274         if (unode->applied) {
275                 BM_log_undo(ss->bm, ss->bm_log);
276                 unode->applied = false;
277         }
278         else {
279                 BM_log_redo(ss->bm, ss->bm_log);
280                 unode->applied = true;
281         }
282
283         if (ELEM(unode->type, SCULPT_UNDO_MASK, SCULPT_UNDO_MASK)) {
284                 int i, totnode;
285                 PBVHNode **nodes;
286
287 #ifdef _OPENMP
288                 Sculpt *sd = CTX_data_tool_settings(C)->sculpt;
289 #else
290                 (void)C;
291 #endif
292
293                 BKE_pbvh_search_gather(ss->pbvh, NULL, NULL, &nodes, &totnode);
294
295 #pragma omp parallel for schedule(guided) if (sd->flags & SCULPT_USE_OPENMP)
296                 for (i = 0; i < totnode; i++) {
297                         BKE_pbvh_node_mark_redraw(nodes[i]);
298                 }
299
300                 if (nodes)
301                         MEM_freeN(nodes);
302         }
303         else {
304                 sculpt_dyntopo_node_layers_reset(ss->bm);
305                 sculpt_pbvh_clear(ob);
306         }
307 }
308
309 /* Create empty sculpt BMesh and enable logging */
310 static void sculpt_undo_bmesh_enable(Object *ob,
311                                      SculptUndoNode *unode)
312 {
313         SculptSession *ss = ob->sculpt;
314         Mesh *me = ob->data;
315
316         sculpt_pbvh_clear(ob);
317
318         /* Create empty BMesh and enable logging */
319         ss->bm = BM_mesh_create(&bm_mesh_allocsize_default);
320         BM_data_layer_add(ss->bm, &ss->bm->vdata, CD_PAINT_MASK);
321         BM_data_layer_add(ss->bm, &ss->bm->vdata, CD_DYNTOPO_NODE);
322         BM_data_layer_add(ss->bm, &ss->bm->pdata, CD_DYNTOPO_NODE);
323         me->flag |= ME_SCULPT_DYNAMIC_TOPOLOGY;
324
325         /* Restore the BMLog using saved entries */
326         ss->bm_log = BM_log_from_existing_entries_create(ss->bm,
327                                                          unode->bm_entry);
328 }
329
330 static void sculpt_undo_bmesh_restore_begin(bContext *C,
331                                             SculptUndoNode *unode,
332                                             Object *ob,
333                                             SculptSession *ss)
334 {
335         if (unode->applied) {
336                 sculpt_dynamic_topology_disable(C, unode);
337                 unode->applied = false;
338         }
339         else {
340                 sculpt_undo_bmesh_enable(ob, unode);
341
342                 /* Restore the mesh from the first log entry */
343                 BM_log_redo(ss->bm, ss->bm_log);
344
345                 unode->applied = true;
346         }
347 }
348
349 static void sculpt_undo_bmesh_restore_end(bContext *C,
350                                           SculptUndoNode *unode,
351                                           Object *ob,
352                                           SculptSession *ss)
353 {
354         if (unode->applied) {
355                 sculpt_undo_bmesh_enable(ob, unode);
356
357                 /* Restore the mesh from the last log entry */
358                 BM_log_undo(ss->bm, ss->bm_log);
359
360                 unode->applied = false;
361         }
362         else {
363                 /* Disable dynamic topology sculpting */
364                 sculpt_dynamic_topology_disable(C, NULL);
365                 unode->applied = true;
366         }
367 }
368
369 /* Handle all dynamic-topology updates
370  *
371  * Returns true if this was a dynamic-topology undo step, otherwise
372  * returns false to indicate the non-dyntopo code should run. */
373 static int sculpt_undo_bmesh_restore(bContext *C,
374                                      SculptUndoNode *unode,
375                                      Object *ob,
376                                      SculptSession *ss)
377 {
378         switch (unode->type) {
379                 case SCULPT_UNDO_DYNTOPO_BEGIN:
380                         sculpt_undo_bmesh_restore_begin(C, unode, ob, ss);
381                         return true;
382
383                 case SCULPT_UNDO_DYNTOPO_END:
384                         sculpt_undo_bmesh_restore_end(C, unode, ob, ss);
385                         return true;
386
387                 default:
388                         if (ss->bm_log) {
389                                 sculpt_undo_bmesh_restore_generic(C, unode, ob, ss);
390                                 return true;
391                         }
392                         break;
393         }
394
395         return false;
396 }
397
398 static void sculpt_undo_restore(bContext *C, ListBase *lb)
399 {
400         Scene *scene = CTX_data_scene(C);
401         Sculpt *sd = CTX_data_tool_settings(C)->sculpt;
402         Object *ob = CTX_data_active_object(C);
403         DerivedMesh *dm;
404         SculptSession *ss = ob->sculpt;
405         SculptUndoNode *unode;
406         bool update = false, rebuild = false;
407         bool need_mask = false;
408
409         for (unode = lb->first; unode; unode = unode->next) {
410                 if (strcmp(unode->idname, ob->id.name) == 0) {
411                         if (unode->type == SCULPT_UNDO_MASK) {
412                                 /* is possible that we can't do the mask undo (below)
413                                  * because of the vertex count */
414                                 need_mask = true;
415                                 break;
416                         }
417                 }
418         }
419
420         sculpt_update_mesh_elements(scene, sd, ob, 0, need_mask);
421
422         /* call _after_ sculpt_update_mesh_elements() which may update 'ob->derivedFinal' */
423         dm = mesh_get_derived_final(scene, ob, 0);
424
425         if (lb->first && sculpt_undo_bmesh_restore(C, lb->first, ob, ss))
426                 return;
427
428         for (unode = lb->first; unode; unode = unode->next) {
429                 if (!(strcmp(unode->idname, ob->id.name) == 0))
430                         continue;
431
432                 /* check if undo data matches current data well enough to
433                  * continue */
434                 if (unode->maxvert) {
435                         if (ss->totvert != unode->maxvert)
436                                 continue;
437                 }
438                 else if (unode->maxgrid && dm->getGridData) {
439                         if ((dm->getNumGrids(dm) != unode->maxgrid) ||
440                             (dm->getGridSize(dm) != unode->gridsize))
441                         {
442                                 continue;
443                         }
444                 }
445
446                 switch (unode->type) {
447                         case SCULPT_UNDO_COORDS:
448                                 if (sculpt_undo_restore_coords(C, dm, unode))
449                                         update = true;
450                                 break;
451                         case SCULPT_UNDO_HIDDEN:
452                                 if (sculpt_undo_restore_hidden(C, dm, unode))
453                                         rebuild = true;
454                                 break;
455                         case SCULPT_UNDO_MASK:
456                                 if (sculpt_undo_restore_mask(C, dm, unode))
457                                         update = true;
458                                 break;
459
460                         case SCULPT_UNDO_DYNTOPO_BEGIN:
461                         case SCULPT_UNDO_DYNTOPO_END:
462                         case SCULPT_UNDO_DYNTOPO_SYMMETRIZE:
463                                 BLI_assert(!"Dynamic topology should've already been handled");
464                                 break;
465                 }
466         }
467
468         if (update || rebuild) {
469                 int tag_update = 0;
470                 /* we update all nodes still, should be more clever, but also
471                  * needs to work correct when exiting/entering sculpt mode and
472                  * the nodes get recreated, though in that case it could do all */
473                 BKE_pbvh_search_callback(ss->pbvh, NULL, NULL, update_cb, &rebuild);
474                 BKE_pbvh_update(ss->pbvh, PBVH_UpdateBB | PBVH_UpdateOriginalBB | PBVH_UpdateRedraw, NULL);
475
476                 if (sculpt_multires_active(scene, ob)) {
477                         if (rebuild)
478                                 multires_mark_as_modified(ob, MULTIRES_HIDDEN_MODIFIED);
479                         else
480                                 multires_mark_as_modified(ob, MULTIRES_COORDS_MODIFIED);
481                 }
482
483                 tag_update = ((Mesh *)ob->data)->id.us > 1;
484
485                 if (ss->modifiers_active) {
486                         Mesh *mesh = ob->data;
487                         BKE_mesh_calc_normals_tessface(mesh->mvert, mesh->totvert,
488                                                        mesh->mface, mesh->totface, NULL);
489
490                         free_sculptsession_deformMats(ss);
491                         tag_update |= 1;
492                 }
493
494                 if (tag_update) {
495                         DAG_id_tag_update(&ob->id, OB_RECALC_DATA);
496                 }
497                 else {
498                         sculpt_update_object_bounding_box(ob);
499                 }
500
501                 /* for non-PBVH drawing, need to recreate VBOs */
502                 GPU_drawobject_free(ob->derivedFinal);
503         }
504 }
505
506 static void sculpt_undo_free(ListBase *lb)
507 {
508         SculptUndoNode *unode;
509         int i;
510
511         for (unode = lb->first; unode; unode = unode->next) {
512                 if (unode->co)
513                         MEM_freeN(unode->co);
514                 if (unode->no)
515                         MEM_freeN(unode->no);
516                 if (unode->index)
517                         MEM_freeN(unode->index);
518                 if (unode->grids)
519                         MEM_freeN(unode->grids);
520                 if (unode->orig_co)
521                         MEM_freeN(unode->orig_co);
522                 if (unode->vert_hidden)
523                         MEM_freeN(unode->vert_hidden);
524                 if (unode->grid_hidden) {
525                         for (i = 0; i < unode->totgrid; i++) {
526                                 if (unode->grid_hidden[i])
527                                         MEM_freeN(unode->grid_hidden[i]);
528                         }
529                         MEM_freeN(unode->grid_hidden);
530                 }
531                 if (unode->mask)
532                         MEM_freeN(unode->mask);
533                 if (unode->bm_entry) {
534                         BM_log_entry_drop(unode->bm_entry);
535                 }
536                 if (unode->bm_enter_totvert)
537                         CustomData_free(&unode->bm_enter_vdata, unode->bm_enter_totvert);
538                 if (unode->bm_enter_totedge)
539                         CustomData_free(&unode->bm_enter_edata, unode->bm_enter_totedge);
540                 if (unode->bm_enter_totloop)
541                         CustomData_free(&unode->bm_enter_ldata, unode->bm_enter_totloop);
542                 if (unode->bm_enter_totpoly)
543                         CustomData_free(&unode->bm_enter_pdata, unode->bm_enter_totpoly);
544         }
545 }
546
547 SculptUndoNode *sculpt_undo_get_node(PBVHNode *node)
548 {
549         ListBase *lb = undo_paint_push_get_list(UNDO_PAINT_MESH);
550
551         if (!lb) {
552                 return NULL;
553         }
554
555         return BLI_findptr(lb, node, offsetof(SculptUndoNode, node));
556 }
557
558 static void sculpt_undo_alloc_and_store_hidden(PBVH *pbvh,
559                                                SculptUndoNode *unode)
560 {
561         PBVHNode *node = unode->node;
562         BLI_bitmap **grid_hidden;
563         int i, *grid_indices, totgrid;
564
565         grid_hidden = BKE_pbvh_grid_hidden(pbvh);
566
567         BKE_pbvh_node_get_grids(pbvh, node, &grid_indices, &totgrid,
568                                 NULL, NULL, NULL, NULL);
569                         
570         unode->grid_hidden = MEM_mapallocN(sizeof(*unode->grid_hidden) * totgrid,
571                                            "unode->grid_hidden");
572                 
573         for (i = 0; i < totgrid; i++) {
574                 if (grid_hidden[grid_indices[i]])
575                         unode->grid_hidden[i] = MEM_dupallocN(grid_hidden[grid_indices[i]]);
576                 else
577                         unode->grid_hidden[i] = NULL;
578         }
579 }
580
581 static SculptUndoNode *sculpt_undo_alloc_node(Object *ob, PBVHNode *node,
582                                               SculptUndoType type)
583 {
584         ListBase *lb = undo_paint_push_get_list(UNDO_PAINT_MESH);
585         SculptUndoNode *unode;
586         SculptSession *ss = ob->sculpt;
587         int totvert, allvert, totgrid, maxgrid, gridsize, *grids;
588         
589         unode = MEM_callocN(sizeof(SculptUndoNode), "SculptUndoNode");
590         BLI_strncpy(unode->idname, ob->id.name, sizeof(unode->idname));
591         unode->type = type;
592         unode->node = node;
593
594         if (node) {
595                 BKE_pbvh_node_num_verts(ss->pbvh, node, &totvert, &allvert);
596                 BKE_pbvh_node_get_grids(ss->pbvh, node, &grids, &totgrid,
597                                         &maxgrid, &gridsize, NULL, NULL);
598
599                 unode->totvert = totvert;
600         }
601         else
602                 maxgrid = 0;
603         
604         /* we will use this while sculpting, is mapalloc slow to access then? */
605
606         /* general TODO, fix count_alloc */
607         switch (type) {
608                 case SCULPT_UNDO_COORDS:
609                         unode->co = MEM_mapallocN(sizeof(float) * 3 * allvert, "SculptUndoNode.co");
610                         unode->no = MEM_mapallocN(sizeof(short) * 3 * allvert, "SculptUndoNode.no");
611                         undo_paint_push_count_alloc(UNDO_PAINT_MESH,
612                                                     (sizeof(float) * 3 +
613                                                      sizeof(short) * 3 +
614                                                      sizeof(int)) * allvert);
615                         break;
616                 case SCULPT_UNDO_HIDDEN:
617                         if (maxgrid)
618                                 sculpt_undo_alloc_and_store_hidden(ss->pbvh, unode);
619                         else
620                                 unode->vert_hidden = BLI_BITMAP_NEW(allvert, "SculptUndoNode.vert_hidden");
621                 
622                         break;
623                 case SCULPT_UNDO_MASK:
624                         unode->mask = MEM_mapallocN(sizeof(float) * allvert, "SculptUndoNode.mask");
625                         undo_paint_push_count_alloc(UNDO_PAINT_MESH, (sizeof(float) * sizeof(int)) * allvert);
626                         break;
627                 case SCULPT_UNDO_DYNTOPO_BEGIN:
628                 case SCULPT_UNDO_DYNTOPO_END:
629                 case SCULPT_UNDO_DYNTOPO_SYMMETRIZE:
630                         BLI_assert(!"Dynamic topology should've already been handled");
631                         break;
632         }
633         
634         BLI_addtail(lb, unode);
635
636         if (maxgrid) {
637                 /* multires */
638                 unode->maxgrid = maxgrid;
639                 unode->totgrid = totgrid;
640                 unode->gridsize = gridsize;
641                 unode->grids = MEM_mapallocN(sizeof(int) * totgrid, "SculptUndoNode.grids");
642         }
643         else {
644                 /* regular mesh */
645                 unode->maxvert = ss->totvert;
646                 unode->index = MEM_mapallocN(sizeof(int) * allvert, "SculptUndoNode.index");
647         }
648
649         if (ss->modifiers_active)
650                 unode->orig_co = MEM_callocN(allvert * sizeof(*unode->orig_co), "undoSculpt orig_cos");
651
652         return unode;
653 }
654
655 static void sculpt_undo_store_coords(Object *ob, SculptUndoNode *unode)
656 {
657         SculptSession *ss = ob->sculpt;
658         PBVHVertexIter vd;
659
660         BKE_pbvh_vertex_iter_begin(ss->pbvh, unode->node, vd, PBVH_ITER_ALL)
661         {
662                 copy_v3_v3(unode->co[vd.i], vd.co);
663                 if (vd.no) copy_v3_v3_short(unode->no[vd.i], vd.no);
664                 else normal_float_to_short_v3(unode->no[vd.i], vd.fno);
665
666                 if (ss->modifiers_active)
667                         copy_v3_v3(unode->orig_co[vd.i], ss->orig_cos[unode->index[vd.i]]);
668         }
669         BKE_pbvh_vertex_iter_end;
670 }
671
672 static void sculpt_undo_store_hidden(Object *ob, SculptUndoNode *unode)
673 {
674         PBVH *pbvh = ob->sculpt->pbvh;
675         PBVHNode *node = unode->node;
676
677         if (unode->grids) {
678                 /* already stored during allocation */
679         }
680         else {
681                 MVert *mvert;
682                 int *vert_indices, allvert;
683                 int i;
684                 
685                 BKE_pbvh_node_num_verts(pbvh, node, NULL, &allvert);
686                 BKE_pbvh_node_get_verts(pbvh, node, &vert_indices, &mvert);
687                 for (i = 0; i < allvert; i++) {
688                         BLI_BITMAP_MODIFY(unode->vert_hidden, i,
689                                           mvert[vert_indices[i]].flag & ME_HIDE);
690                 }
691         }
692 }
693
694 static void sculpt_undo_store_mask(Object *ob, SculptUndoNode *unode)
695 {
696         SculptSession *ss = ob->sculpt;
697         PBVHVertexIter vd;
698
699         BKE_pbvh_vertex_iter_begin(ss->pbvh, unode->node, vd, PBVH_ITER_ALL)
700         {
701                 unode->mask[vd.i] = *vd.mask;
702         }
703         BKE_pbvh_vertex_iter_end;
704 }
705
706 static SculptUndoNode *sculpt_undo_bmesh_push(Object *ob,
707                                               PBVHNode *node,
708                                               SculptUndoType type)
709 {
710         ListBase *lb = undo_paint_push_get_list(UNDO_PAINT_MESH);
711         SculptUndoNode *unode = lb->first;
712         SculptSession *ss = ob->sculpt;
713         PBVHVertexIter vd;
714
715         if (!lb->first) {
716                 unode = MEM_callocN(sizeof(*unode), __func__);
717
718                 BLI_strncpy(unode->idname, ob->id.name, sizeof(unode->idname));
719                 unode->type = type;
720                 unode->applied = true;
721
722                 if (type == SCULPT_UNDO_DYNTOPO_END) {
723                         unode->bm_entry = BM_log_entry_add(ss->bm_log);
724                         BM_log_before_all_removed(ss->bm, ss->bm_log);
725                 }
726                 else if (type == SCULPT_UNDO_DYNTOPO_BEGIN) {
727                         Mesh *me = ob->data;
728
729                         /* Store a copy of the mesh's current vertices, loops, and
730                          * polys. A full copy like this is needed because entering
731                          * dynamic-topology immediately does topological edits
732                          * (converting polys to triangles) that the BMLog can't
733                          * fully restore from */
734                         CustomData_copy(&me->vdata, &unode->bm_enter_vdata, CD_MASK_MESH,
735                                         CD_DUPLICATE, me->totvert);
736                         CustomData_copy(&me->edata, &unode->bm_enter_edata, CD_MASK_MESH,
737                                         CD_DUPLICATE, me->totedge);
738                         CustomData_copy(&me->ldata, &unode->bm_enter_ldata, CD_MASK_MESH,
739                                         CD_DUPLICATE, me->totloop);
740                         CustomData_copy(&me->pdata, &unode->bm_enter_pdata, CD_MASK_MESH,
741                                         CD_DUPLICATE, me->totpoly);
742                         unode->bm_enter_totvert = me->totvert;
743                         unode->bm_enter_totedge = me->totedge;
744                         unode->bm_enter_totloop = me->totloop;
745                         unode->bm_enter_totpoly = me->totpoly;
746
747                         unode->bm_entry = BM_log_entry_add(ss->bm_log);
748                         BM_log_all_added(ss->bm, ss->bm_log);
749                 }
750                 else {
751                         unode->bm_entry = BM_log_entry_add(ss->bm_log);
752                 }
753
754                 BLI_addtail(lb, unode);
755         }
756
757         if (node) {
758                 switch (type) {
759                         case SCULPT_UNDO_COORDS:
760                         case SCULPT_UNDO_MASK:
761                                 /* Before any vertex values get modified, ensure their
762                                  * original positions are logged */
763                                 BKE_pbvh_vertex_iter_begin(ss->pbvh, node, vd, PBVH_ITER_ALL) {
764                                         BM_log_vert_before_modified(ss->bm_log, vd.bm_vert, vd.cd_vert_mask_offset);
765                                 }
766                                 BKE_pbvh_vertex_iter_end;
767                                 break;
768
769                         case SCULPT_UNDO_HIDDEN:
770                         {
771                                 GSetIterator gs_iter;
772                                 GSet *faces = BKE_pbvh_bmesh_node_faces(node);
773                                 BKE_pbvh_vertex_iter_begin(ss->pbvh, node, vd, PBVH_ITER_ALL) {
774                                         BM_log_vert_before_modified(ss->bm_log, vd.bm_vert, vd.cd_vert_mask_offset);
775                                 }
776                                 BKE_pbvh_vertex_iter_end;
777
778                                 GSET_ITER (gs_iter, faces) {
779                                         BMFace *f = BLI_gsetIterator_getKey(&gs_iter);
780                                         BM_log_face_modified(ss->bm_log, f);
781                                 }
782                                 break;
783                         }
784
785                         case SCULPT_UNDO_DYNTOPO_BEGIN:
786                         case SCULPT_UNDO_DYNTOPO_END:
787                         case SCULPT_UNDO_DYNTOPO_SYMMETRIZE:
788                                 break;
789                 }
790         }
791
792         return unode;
793 }
794
795 SculptUndoNode *sculpt_undo_push_node(Object *ob, PBVHNode *node,
796                                       SculptUndoType type)
797 {
798         SculptSession *ss = ob->sculpt;
799         SculptUndoNode *unode;
800
801         /* list is manipulated by multiple threads, so we lock */
802         BLI_lock_thread(LOCK_CUSTOM1);
803
804         if (ss->bm ||
805             ELEM(type,
806                  SCULPT_UNDO_DYNTOPO_BEGIN,
807                  SCULPT_UNDO_DYNTOPO_END))
808         {
809                 /* Dynamic topology stores only one undo node per stroke,
810                  * regardless of the number of PBVH nodes modified */
811                 unode = sculpt_undo_bmesh_push(ob, node, type);
812                 BLI_unlock_thread(LOCK_CUSTOM1);
813                 return unode;
814         }
815         else if ((unode = sculpt_undo_get_node(node))) {
816                 BLI_unlock_thread(LOCK_CUSTOM1);
817                 return unode;
818         }
819
820         unode = sculpt_undo_alloc_node(ob, node, type);
821         
822         BLI_unlock_thread(LOCK_CUSTOM1);
823
824         /* copy threaded, hopefully this is the performance critical part */
825
826         if (unode->grids) {
827                 int totgrid, *grids;
828                 BKE_pbvh_node_get_grids(ss->pbvh, node, &grids, &totgrid,
829                                         NULL, NULL, NULL, NULL);
830                 memcpy(unode->grids, grids, sizeof(int) * totgrid);
831         }
832         else {
833                 int *vert_indices, allvert;
834                 BKE_pbvh_node_num_verts(ss->pbvh, node, NULL, &allvert);
835                 BKE_pbvh_node_get_verts(ss->pbvh, node, &vert_indices, NULL);
836                 memcpy(unode->index, vert_indices, sizeof(int) * unode->totvert);
837         }
838
839         switch (type) {
840                 case SCULPT_UNDO_COORDS:
841                         sculpt_undo_store_coords(ob, unode);
842                         break;
843                 case SCULPT_UNDO_HIDDEN:
844                         sculpt_undo_store_hidden(ob, unode);
845                         break;
846                 case SCULPT_UNDO_MASK:
847                         sculpt_undo_store_mask(ob, unode);
848                         break;
849                 case SCULPT_UNDO_DYNTOPO_BEGIN:
850                 case SCULPT_UNDO_DYNTOPO_END:
851                 case SCULPT_UNDO_DYNTOPO_SYMMETRIZE:
852                         BLI_assert(!"Dynamic topology should've already been handled");
853                         break;
854         }
855
856         /* store active shape key */
857         if (ss->kb) BLI_strncpy(unode->shapeName, ss->kb->name, sizeof(ss->kb->name));
858         else unode->shapeName[0] = '\0';
859
860         return unode;
861 }
862
863 void sculpt_undo_push_begin(const char *name)
864 {
865         ED_undo_paint_push_begin(UNDO_PAINT_MESH, name,
866                               sculpt_undo_restore, sculpt_undo_free);
867 }
868
869 void sculpt_undo_push_end(void)
870 {
871         ListBase *lb = undo_paint_push_get_list(UNDO_PAINT_MESH);
872         SculptUndoNode *unode;
873
874         /* we don't need normals in the undo stack */
875         for (unode = lb->first; unode; unode = unode->next) {
876                 if (unode->no) {
877                         MEM_freeN(unode->no);
878                         unode->no = NULL;
879                 }
880
881                 if (unode->node)
882                         BKE_pbvh_node_layer_disp_free(unode->node);
883         }
884
885         ED_undo_paint_push_end(UNDO_PAINT_MESH);
886 }