Merge branch 'blender2.7'
[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 "CLG_log.h"
31
32 #include "BLI_utildefines.h"
33 #include "BLI_listbase.h"
34 #include "BLI_array_utils.h"
35
36 #include "DNA_defs.h"
37 #include "DNA_meta_types.h"
38 #include "DNA_object_types.h"
39
40 #include "BKE_context.h"
41 #include "BKE_layer.h"
42 #include "BKE_undo_system.h"
43
44 #include "DEG_depsgraph.h"
45
46 #include "ED_object.h"
47 #include "ED_mball.h"
48 #include "ED_undo.h"
49 #include "ED_util.h"
50
51 #include "WM_types.h"
52 #include "WM_api.h"
53
54 /** We only need this locally. */
55 static CLG_LogRef LOG = {"ed.undo.mball"};
56
57 /* -------------------------------------------------------------------- */
58 /** \name Undo Conversion
59  * \{ */
60
61 typedef struct UndoMBall {
62         ListBase editelems;
63         int lastelem_index;
64         size_t undo_size;
65 } UndoMBall;
66
67 /* free all MetaElems from ListBase */
68 static void freeMetaElemlist(ListBase *lb)
69 {
70         MetaElem *ml;
71
72         if (lb == NULL) {
73                 return;
74         }
75
76         while ((ml = BLI_pophead(lb))) {
77                 MEM_freeN(ml);
78         }
79 }
80
81 static void undomball_to_editmball(UndoMBall *umb, MetaBall *mb)
82 {
83         freeMetaElemlist(mb->editelems);
84         mb->lastelem = NULL;
85
86         /* copy 'undo' MetaElems to 'edit' MetaElems */
87         int index = 0;
88         for (MetaElem *ml_undo = umb->editelems.first; ml_undo; ml_undo = ml_undo->next, index += 1) {
89                 MetaElem *ml_edit = MEM_dupallocN(ml_undo);
90                 BLI_addtail(mb->editelems, ml_edit);
91                 if (index == umb->lastelem_index) {
92                         mb->lastelem = ml_edit;
93                 }
94         }
95 }
96
97 static void *editmball_from_undomball(UndoMBall *umb, MetaBall *mb)
98 {
99         BLI_assert(BLI_array_is_zeroed(umb, 1));
100
101         /* allocate memory for undo ListBase */
102         umb->lastelem_index = -1;
103
104         /* copy contents of current ListBase to the undo ListBase */
105         int index = 0;
106         for (MetaElem *ml_edit = mb->editelems->first; ml_edit; ml_edit = ml_edit->next, index += 1) {
107                 MetaElem *ml_undo = MEM_dupallocN(ml_edit);
108                 BLI_addtail(&umb->editelems, ml_undo);
109                 if (ml_edit == mb->lastelem) {
110                         umb->lastelem_index = index;
111                 }
112                 umb->undo_size += sizeof(MetaElem);
113         }
114
115         return umb;
116 }
117
118 /* free undo ListBase of MetaElems */
119 static void undomball_free_data(UndoMBall *umb)
120 {
121         freeMetaElemlist(&umb->editelems);
122 }
123
124 static Object *editmball_object_from_context(bContext *C)
125 {
126         Object *obedit = CTX_data_edit_object(C);
127         if (obedit && obedit->type == OB_MBALL) {
128                 MetaBall *mb = obedit->data;
129                 if (mb->editelems != NULL) {
130                         return obedit;
131                 }
132         }
133         return NULL;
134 }
135
136 /** \} */
137
138 /* -------------------------------------------------------------------- */
139 /** \name Implements ED Undo System
140  *
141  * \note This is similar for all edit-mode types.
142  * \{ */
143
144 typedef struct MBallUndoStep_Elem {
145         UndoRefID_Object obedit_ref;
146         UndoMBall data;
147 } MBallUndoStep_Elem;
148
149 typedef struct MBallUndoStep {
150         UndoStep step;
151         MBallUndoStep_Elem *elems;
152         uint                elems_len;
153 } MBallUndoStep;
154
155 static bool mball_undosys_poll(bContext *C)
156 {
157         return editmball_object_from_context(C) != NULL;
158 }
159
160 static bool mball_undosys_step_encode(struct bContext *C, UndoStep *us_p)
161 {
162         MBallUndoStep *us = (MBallUndoStep *)us_p;
163
164         ViewLayer *view_layer = CTX_data_view_layer(C);
165         uint objects_len = 0;
166         Object **objects = BKE_view_layer_array_from_objects_in_edit_mode_unique_data(view_layer, CTX_wm_view3d(C), &objects_len);
167
168         us->elems = MEM_callocN(sizeof(*us->elems) * objects_len, __func__);
169         us->elems_len = objects_len;
170
171         for (uint i = 0; i < objects_len; i++) {
172                 Object *ob = objects[i];
173                 MBallUndoStep_Elem *elem = &us->elems[i];
174
175                 elem->obedit_ref.ptr = ob;
176                 MetaBall *mb = ob->data;
177                 editmball_from_undomball(&elem->data, mb);
178                 us->step.data_size += elem->data.undo_size;
179         }
180         MEM_freeN(objects);
181         return true;
182 }
183
184 static void mball_undosys_step_decode(struct bContext *C, UndoStep *us_p, int UNUSED(dir))
185 {
186         /* TODO(campbell): undo_system: use low-level API to set mode. */
187         ED_object_mode_set(C, OB_MODE_EDIT);
188         BLI_assert(mball_undosys_poll(C));
189
190         MBallUndoStep *us = (MBallUndoStep *)us_p;
191
192         for (uint i = 0; i < us->elems_len; i++) {
193                 MBallUndoStep_Elem *elem = &us->elems[i];
194                 Object *obedit = elem->obedit_ref.ptr;
195                 MetaBall *mb = obedit->data;
196                 if (mb->editelems == NULL) {
197                         /* Should never fail, may not crash but can give odd behavior. */
198                         CLOG_ERROR(&LOG, "name='%s', failed to enter edit-mode for object '%s', undo state invalid", us_p->name, obedit->id.name);
199                         continue;
200                 }
201                 undomball_to_editmball(&elem->data, mb);
202                 DEG_id_tag_update(&obedit->id, ID_RECALC_GEOMETRY);
203         }
204
205         /* The first element is always active */
206         ED_undo_object_set_active_or_warn(CTX_data_view_layer(C), us->elems[0].obedit_ref.ptr, us_p->name, &LOG);
207
208         WM_event_add_notifier(C, NC_GEOM | ND_DATA, NULL);
209 }
210
211 static void mball_undosys_step_free(UndoStep *us_p)
212 {
213         MBallUndoStep *us = (MBallUndoStep *)us_p;
214
215         for (uint i = 0; i < us->elems_len; i++) {
216                 MBallUndoStep_Elem *elem = &us->elems[i];
217                 undomball_free_data(&elem->data);
218         }
219         MEM_freeN(us->elems);
220 }
221
222 static void mball_undosys_foreach_ID_ref(
223         UndoStep *us_p, UndoTypeForEachIDRefFn foreach_ID_ref_fn, void *user_data)
224 {
225         MBallUndoStep *us = (MBallUndoStep *)us_p;
226
227         for (uint i = 0; i < us->elems_len; i++) {
228                 MBallUndoStep_Elem *elem = &us->elems[i];
229                 foreach_ID_ref_fn(user_data, ((UndoRefID *)&elem->obedit_ref));
230         }
231 }
232
233 /* Export for ED_undo_sys. */
234 void ED_mball_undosys_type(UndoType *ut)
235 {
236         ut->name = "Edit MBall";
237         ut->poll = mball_undosys_poll;
238         ut->step_encode = mball_undosys_step_encode;
239         ut->step_decode = mball_undosys_step_decode;
240         ut->step_free = mball_undosys_step_free;
241
242         ut->step_foreach_ID_ref = mball_undosys_foreach_ID_ref;
243
244         ut->mode = BKE_UNDOTYPE_MODE_STORE;
245         ut->use_context = true;
246
247         ut->step_size = sizeof(MBallUndoStep);
248
249 }
250
251 /** \} */