Undo: unified undo system w/ linear history
[blender.git] / source / blender / editors / metaball / editmball_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  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 /** \file blender/editors/metaball/editmball_undo.c
22  *  \ingroup edmeta
23  */
24
25 #include <math.h>
26 #include <string.h>
27
28 #include "MEM_guardedalloc.h"
29
30 #include "BLI_utildefines.h"
31 #include "BLI_listbase.h"
32 #include "BLI_array_utils.h"
33
34 #include "DNA_defs.h"
35 #include "DNA_meta_types.h"
36 #include "DNA_object_types.h"
37
38 #include "BKE_context.h"
39 #include "BKE_depsgraph.h"
40 #include "BKE_undo_system.h"
41
42 #include "ED_object.h"
43 #include "ED_mball.h"
44 #include "ED_util.h"
45
46 #include "WM_types.h"
47 #include "WM_api.h"
48
49 /* -------------------------------------------------------------------- */
50 /** \name Undo Conversion
51  * \{ */
52
53 typedef struct UndoMBall {
54         ListBase editelems;
55         int lastelem_index;
56         size_t undo_size;
57 } UndoMBall;
58
59 /* free all MetaElems from ListBase */
60 static void freeMetaElemlist(ListBase *lb)
61 {
62         MetaElem *ml;
63
64         if (lb == NULL) {
65                 return;
66         }
67
68         while ((ml = BLI_pophead(lb))) {
69                 MEM_freeN(ml);
70         }
71 }
72
73 static void undomball_to_editmball(UndoMBall *umb, MetaBall *mb)
74 {
75         freeMetaElemlist(mb->editelems);
76         mb->lastelem = NULL;
77
78         /* copy 'undo' MetaElems to 'edit' MetaElems */
79         int index = 0;
80         for (MetaElem *ml_undo = umb->editelems.first; ml_undo; ml_undo = ml_undo->next, index += 1) {
81                 MetaElem *ml_edit = MEM_dupallocN(ml_undo);
82                 BLI_addtail(mb->editelems, ml_edit);
83                 if (index == umb->lastelem_index) {
84                         mb->lastelem = ml_edit;
85                 }
86         }
87 }
88
89 static void *editmball_from_undomball(UndoMBall *umb, MetaBall *mb)
90 {
91         BLI_assert(BLI_array_is_zeroed(umb, 1));
92
93         /* allocate memory for undo ListBase */
94         umb->lastelem_index = -1;
95
96         /* copy contents of current ListBase to the undo ListBase */
97         int index = 0;
98         for (MetaElem *ml_edit = mb->editelems->first; ml_edit; ml_edit = ml_edit->next, index += 1) {
99                 MetaElem *ml_undo = MEM_dupallocN(ml_edit);
100                 BLI_addtail(&umb->editelems, ml_undo);
101                 if (ml_edit == mb->lastelem) {
102                         umb->lastelem_index = index;
103                 }
104                 umb->undo_size += sizeof(MetaElem);
105         }
106
107         return umb;
108 }
109
110 /* free undo ListBase of MetaElems */
111 static void undomball_free_data(UndoMBall *umb)
112 {
113         freeMetaElemlist(&umb->editelems);
114 }
115
116 static Object *editmball_object_from_context(bContext *C)
117 {
118         Object *obedit = CTX_data_edit_object(C);
119         if (obedit && obedit->type == OB_MBALL) {
120                 MetaBall *mb = obedit->data;
121                 if (mb->editelems != NULL) {
122                         return obedit;
123                 }
124         }
125         return NULL;
126 }
127
128 /** \} */
129
130 /* -------------------------------------------------------------------- */
131 /** \name Implements ED Undo System
132  * \{ */
133
134 typedef struct MBallUndoStep {
135         UndoStep step;
136         /* note: will split out into list for multi-object-editmode. */
137         UndoRefID_Object obedit_ref;
138         UndoMBall data;
139 } MBallUndoStep;
140
141 static bool mball_undosys_poll(bContext *C)
142 {
143         return editmball_object_from_context(C) != NULL;
144 }
145
146 static bool mball_undosys_step_encode(struct bContext *C, UndoStep *us_p)
147 {
148         MBallUndoStep *us = (MBallUndoStep *)us_p;
149         us->obedit_ref.ptr = editmball_object_from_context(C);
150         MetaBall *mb = us->obedit_ref.ptr->data;
151         editmball_from_undomball(&us->data, mb);
152         us->step.data_size = us->data.undo_size;
153         return true;
154 }
155
156 static void mball_undosys_step_decode(struct bContext *C, UndoStep *us_p, int UNUSED(dir))
157 {
158         ED_object_mode_set(C, OB_MODE_EDIT);
159
160         MBallUndoStep *us = (MBallUndoStep *)us_p;
161         Object *obedit = us->obedit_ref.ptr;
162         MetaBall *mb = obedit->data;
163         undomball_to_editmball(&us->data, mb);
164         DAG_id_tag_update(&obedit->id, OB_RECALC_DATA);
165         WM_event_add_notifier(C, NC_GEOM | ND_DATA, NULL);
166 }
167
168 static void mball_undosys_step_free(UndoStep *us_p)
169 {
170         MBallUndoStep *us = (MBallUndoStep *)us_p;
171         undomball_free_data(&us->data);
172 }
173
174 static void mball_undosys_foreach_ID_ref(
175         UndoStep *us_p, UndoTypeForEachIDRefFn foreach_ID_ref_fn, void *user_data)
176 {
177         MBallUndoStep *us = (MBallUndoStep *)us_p;
178         foreach_ID_ref_fn(user_data, ((UndoRefID *)&us->obedit_ref));
179 }
180
181 /* Export for ED_undo_sys. */
182 void ED_mball_undosys_type(UndoType *ut)
183 {
184         ut->name = "Edit MBall";
185         ut->poll = mball_undosys_poll;
186         ut->step_encode = mball_undosys_step_encode;
187         ut->step_decode = mball_undosys_step_decode;
188         ut->step_free = mball_undosys_step_free;
189
190         ut->step_foreach_ID_ref = mball_undosys_foreach_ID_ref;
191
192         ut->mode = BKE_UNDOTYPE_MODE_STORE;
193         ut->use_context = true;
194
195         ut->step_size = sizeof(MBallUndoStep);
196
197 }
198
199 /** \} */