Blender V5.3
editlattice_undo.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <cstdlib>
10#include <cstring>
11
12#include "MEM_guardedalloc.h"
13
14#include "CLG_log.h"
15
16#include "BLI_array_utils_c.hh"
17#include "BLI_listbase.hh"
18#include "BLI_string.hh"
19
20#include "DNA_curve_types.h"
21#include "DNA_lattice_types.h"
22#include "DNA_meshdata_types.h"
23#include "DNA_object_types.h"
24#include "DNA_scene_types.h"
25
26#include "BKE_context.hh"
27#include "BKE_deform.hh"
28#include "BKE_lattice.hh"
29#include "BKE_layer.hh"
30#include "BKE_main.hh"
31#include "BKE_object.hh"
32#include "BKE_undo_system.hh"
33
34#include "DEG_depsgraph.hh"
35
36#include "ED_lattice.hh"
37#include "ED_object.hh"
38#include "ED_undo.hh"
39#include "ED_util.hh"
40
41#include "WM_api.hh"
42#include "WM_types.hh"
43
44namespace blender {
45
47static CLG_LogRef LOG = {"undo.lattice"};
48
49/* -------------------------------------------------------------------- */
52
53/* TODO(@ideasman42): this could contain an entire 'Lattice' struct. */
58 float fu, fv, fw;
59 float du, dv, dw;
62 char vgroup[/*MAX_VGROUP_NAME*/ 64];
63 ListBaseT<bDeformGroup> vertex_group_names;
65 size_t undo_size;
66};
67
69 EditLatt *editlatt,
70 ListBaseT<bDeformGroup> *vertex_group_names,
71 int *vertex_group_active_index)
72{
73 const int len_src = ult->pntsu * ult->pntsv * ult->pntsw;
74 const int len_dst = editlatt->latt->pntsu * editlatt->latt->pntsv * editlatt->latt->pntsw;
75 if (len_src != len_dst) {
76 MEM_delete(editlatt->latt->def);
77 editlatt->latt->def = MEM_dupalloc(ult->def);
78 }
79 else {
80 memcpy(editlatt->latt->def, ult->def, sizeof(BPoint) * len_src);
81 }
82
83 /* Even for the same amount of points we don't just copy memory for MDeformVert,
84 * relations to #MDeformWeight might have changed. */
85 if (editlatt->latt->dvert && ult->dvert) {
86 BKE_defvert_array_free(editlatt->latt->dvert, len_dst);
88 "Lattice MDeformVert");
89 BKE_defvert_array_copy(editlatt->latt->dvert, ult->dvert, len_src);
90 }
91
92 editlatt->latt->pntsu = ult->pntsu;
93 editlatt->latt->pntsv = ult->pntsv;
94 editlatt->latt->pntsw = ult->pntsw;
95 editlatt->latt->actbp = ult->actbp;
96
97 editlatt->latt->typeu = ult->typeu;
98 editlatt->latt->typev = ult->typev;
99 editlatt->latt->typew = ult->typew;
100
101 editlatt->latt->fu = ult->fu;
102 editlatt->latt->fv = ult->fv;
103 editlatt->latt->fw = ult->fw;
104 editlatt->latt->du = ult->du;
105 editlatt->latt->dv = ult->dv;
106 editlatt->latt->dw = ult->dw;
107
108 STRNCPY(editlatt->latt->vgroup, ult->vgroup);
109
110 vertex_group_names->free_no_destruct();
111 BKE_defgroup_copy_list(vertex_group_names, &ult->vertex_group_names);
112 *vertex_group_active_index = ult->vertex_group_active_index;
113
114 editlatt->shapenr = ult->shapenr;
115}
116
118 EditLatt *editlatt,
119 const ListBaseT<bDeformGroup> *vertex_group_names,
120 int vertex_group_active_index)
121{
123
124 ult->def = MEM_dupalloc(editlatt->latt->def);
125 ult->pntsu = editlatt->latt->pntsu;
126 ult->pntsv = editlatt->latt->pntsv;
127 ult->pntsw = editlatt->latt->pntsw;
128 ult->actbp = editlatt->latt->actbp;
129
130 ult->typeu = editlatt->latt->typeu;
131 ult->typev = editlatt->latt->typev;
132 ult->typew = editlatt->latt->typew;
133
134 ult->fu = editlatt->latt->fu;
135 ult->fv = editlatt->latt->fv;
136 ult->fw = editlatt->latt->fw;
137 ult->du = editlatt->latt->du;
138 ult->dv = editlatt->latt->dv;
139 ult->dw = editlatt->latt->dw;
140
141 STRNCPY(ult->vgroup, editlatt->latt->vgroup);
142
143 BKE_defgroup_copy_list(&ult->vertex_group_names, vertex_group_names);
144 ult->vertex_group_active_index = vertex_group_active_index;
145
146 ult->shapenr = editlatt->shapenr;
147
148 if (editlatt->latt->dvert) {
149 const int tot = ult->pntsu * ult->pntsv * ult->pntsw;
150 ult->dvert = MEM_new_array_uninitialized<MDeformVert>(tot, "Undo Lattice MDeformVert");
151 BKE_defvert_array_copy(ult->dvert, editlatt->latt->dvert, tot);
152 ult->undo_size += sizeof(*ult->dvert) * tot;
153 }
154
155 ult->undo_size += sizeof(*ult->def) * ult->pntsu * ult->pntsv * ult->pntsw;
156
157 return ult;
158}
159
161{
162 if (ult->def) {
163 MEM_delete(ult->def);
164 }
165 if (ult->dvert) {
166 BKE_defvert_array_free(ult->dvert, ult->pntsu * ult->pntsv * ult->pntsw);
167 ult->dvert = nullptr;
168 }
169 ult->vertex_group_names.free_no_destruct();
170}
171
172#if 0
173static int validate_undoLatt(void *data, void *edata)
174{
175 UndoLattice *ult = (UndoLattice *)data;
176 EditLatt *editlatt = (EditLatt *)edata;
177
178 return (ult->pntsu == editlatt->latt->pntsu && ult->pntsv == editlatt->latt->pntsv &&
179 ult->pntsw == editlatt->latt->pntsw);
180}
181#endif
182
184{
185 const Main *bmain = CTX_data_main(C);
186 Scene *scene = CTX_data_scene(C);
187 ViewLayer *view_layer = CTX_data_view_layer(C);
188 BKE_view_layer_synced_ensure(*bmain, scene, view_layer);
189 Object *obedit = BKE_view_layer_edit_object_get(view_layer);
190 if (obedit && obedit->type == OB_LATTICE) {
191 Lattice *lt = id_cast<Lattice *>(obedit->data);
192 if (lt->editlatt != nullptr) {
193 return obedit;
194 }
195 }
196
197 return nullptr;
198}
199
201
202/* -------------------------------------------------------------------- */
207
209 UndoRefID_Object obedit_ref;
211};
212
220
222{
223 return editlatt_object_from_context(C) != nullptr;
224}
225
227{
228 LatticeUndoStep *us = reinterpret_cast<LatticeUndoStep *>(us_p);
229
230 /* Important not to use the 3D view when getting objects because all objects
231 * outside of this list will be moved out of edit-mode when reading back undo steps. */
232 Scene *scene = CTX_data_scene(C);
233 ViewLayer *view_layer = CTX_data_view_layer(C);
234 Vector<Object *> objects = ED_undo_editmode_objects_from_view_layer(*bmain, scene, view_layer);
235
236 us->scene_ref.ptr = scene;
237 us->elems = MEM_new_array_zeroed<LatticeUndoStep_Elem>(objects.size(), __func__);
238 us->elems_len = objects.size();
239
240 for (uint i = 0; i < objects.size(); i++) {
241 Object *ob = objects[i];
242 LatticeUndoStep_Elem *elem = &us->elems[i];
243
244 elem->obedit_ref.ptr = ob;
245 Lattice *lt = id_cast<Lattice *>(ob->data);
249 us->step.data_size += elem->data.undo_size;
250 }
251
252 bmain->is_memfile_undo_flush_needed = true;
253
254 return true;
255}
256
258 bContext *C, Main *bmain, UndoStep *us_p, const eUndoStepDir /*dir*/, bool /*is_final*/)
259{
260 LatticeUndoStep *us = reinterpret_cast<LatticeUndoStep *>(us_p);
261 Scene *scene = CTX_data_scene(C);
262 ViewLayer *view_layer = CTX_data_view_layer(C);
263
265 CTX_wm_manager(C), us->scene_ref.ptr, &scene, &view_layer);
267 scene, view_layer, &us->elems[0].obedit_ref.ptr, us->elems_len, sizeof(*us->elems));
268
270
271 for (uint i = 0; i < us->elems_len; i++) {
272 LatticeUndoStep_Elem *elem = &us->elems[i];
273 Object *obedit = elem->obedit_ref.ptr;
274 Lattice *lt = id_cast<Lattice *>(obedit->data);
275 if (lt->editlatt == nullptr) {
276 /* Should never fail, may not crash but can give odd behavior. */
278 "name='%s', failed to enter edit-mode for object '%s', undo state invalid",
279 us_p->name,
280 obedit->id.name);
281 continue;
282 }
286
287 /* NOTE: only resize the base lattice because this is what the
288 * RNA properties do when the resolution is adjusted.
289 * Failing to do so causes the parameters to show incorrectly.
290 * See: #100651. */
291 {
292 Lattice *lt_em = lt->editlatt->latt;
293 if ((lt->pntsu != lt_em->pntsu) || /* U. */
294 (lt->pntsv != lt_em->pntsv) || /* V. */
295 (lt->pntsw != lt_em->pntsw)) /* W. */
296 {
297 BKE_lattice_resize(lt, lt_em->pntsu, lt_em->pntsv, lt_em->pntsw, nullptr);
298 }
299 }
300
301 if (obedit->shapenr != elem->data.shapenr) {
302 obedit->shapenr = elem->data.shapenr;
304 }
305
308 }
309
310 /* The first element is always active */
312 *bmain, scene, view_layer, us->elems[0].obedit_ref.ptr, us_p->name, &LOG);
313
314 /* Check after setting active (unless undoing into another scene). */
316
317 bmain->is_memfile_undo_flush_needed = true;
318
320}
321
323{
324 LatticeUndoStep *us = reinterpret_cast<LatticeUndoStep *>(us_p);
325
326 for (uint i = 0; i < us->elems_len; i++) {
327 LatticeUndoStep_Elem *elem = &us->elems[i];
328 undolatt_free_data(&elem->data);
329 }
330 MEM_delete(us->elems);
331}
332
334 UndoTypeForEachIDRefFn foreach_ID_ref_fn,
335 void *user_data)
336{
337 LatticeUndoStep *us = reinterpret_cast<LatticeUndoStep *>(us_p);
338
339 foreach_ID_ref_fn(user_data, (reinterpret_cast<UndoRefID *>(&us->scene_ref)));
340 for (uint i = 0; i < us->elems_len; i++) {
341 LatticeUndoStep_Elem *elem = &us->elems[i];
342 foreach_ID_ref_fn(user_data, (reinterpret_cast<UndoRefID *>(&elem->obedit_ref)));
343 }
344}
345
360
362
363} // namespace blender
support for deformation groups and hooks.
General operations, lookup, etc. for blender objects.
Generic array manipulation API.
#define BLI_array_is_zeroed(arr, arr_len)
#define CLOG_ERROR(clg_ref,...)
Definition CLG_log.h:188
Object is a sort of wrapper for general info.
Read Blender memory allocation and freeing.
#define C
Definition RandGen.cpp:29
#define NC_GEOM
Definition WM_types.hh:406
#define ND_DATA
Definition WM_types.hh:552
int64_t size() const
BMesh Iterators.
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
static void undolatt_free_data(UndoLattice *ult)
void BKE_defvert_array_free(MDeformVert *dvert, int totvert)
Definition deform.cc:1079
char * STRNCPY(char(&dst)[N], const char *src)
static void lattice_undosys_step_free(UndoStep *us_p)
void BKE_lattice_resize(Lattice *lt, int u_new, int v_new, int w_new, Object *lt_ob)
Definition lattice.cc:277
unsigned int uint
Definition BKE_text.h:55
void * MEM_new_array_uninitialized(size_t len, size_t size, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1
void BKE_defvert_array_copy(MDeformVert *dst, const MDeformVert *src, int totvert)
Definition deform.cc:1043
@ UNDOTYPE_FLAG_NEED_CONTEXT_FOR_ENCODE
@ UNDOTYPE_FLAG_ENCODE_PRE_MEMFILE_SUPPORTED
void BKE_lattice_params_copy(Lattice *lt_dst, const Lattice *lt_src)
Definition lattice.cc:401
static void lattice_undosys_foreach_ID_ref(UndoStep *us_p, UndoTypeForEachIDRefFn foreach_ID_ref_fn, void *user_data)
static Object * editlatt_object_from_context(bContext *C)
static void lattice_undosys_step_decode(bContext *C, Main *bmain, UndoStep *us_p, const eUndoStepDir, bool)
void ED_undo_object_set_active_or_warn(const Main &bmain, Scene *scene, ViewLayer *view_layer, Object *ob, const char *info, CLG_LogRef *log)
Definition ed_undo.cc:1024
void ED_lattice_undosys_type(UndoType *ut)
Vector< Object * > ED_undo_editmode_objects_from_view_layer(const Main &bmain, const Scene *scene, ViewLayer *view_layer)
Definition ed_undo.cc:1109
ViewLayer * CTX_data_view_layer(const bContext *C)
Object * BKE_view_layer_edit_object_get(const ViewLayer *view_layer)
void DEG_id_tag_update(ID *id, unsigned int flags)
BMesh const char void * data
wmWindowManager * CTX_wm_manager(const bContext *C)
bool BKE_view_layer_synced_ensure(const Main &bmain, const Scene *scene, ViewLayer *view_layer)
static void undolatt_to_editlatt(UndoLattice *ult, EditLatt *editlatt, ListBaseT< bDeformGroup > *vertex_group_names, int *vertex_group_active_index)
void WM_event_add_notifier(const bContext *C, uint type, void *reference)
bool BKE_object_is_in_editmode(const Object *ob)
Definition object.cc:1898
Main * CTX_data_main(const bContext *C)
@ ID_RECALC_GEOMETRY
Definition DNA_ID.h:1074
void BKE_defgroup_copy_list(ListBaseT< bDeformGroup > *outbase, const ListBaseT< bDeformGroup > *inbase)
Definition deform.cc:75
static CLG_LogRef LOG
Definition logging.cpp:12
void ED_undo_object_editmode_restore_helper(Scene *scene, ViewLayer *view_layer, Object **object_array, uint object_array_len, uint object_array_stride)
Definition ed_undo.cc:1064
void(*)(void *user_data, UndoRefID *id_ref) UndoTypeForEachIDRefFn
Scene * CTX_data_scene(const bContext *C)
static bool lattice_undosys_step_encode(bContext *C, Main *bmain, UndoStep *us_p)
static void * undolatt_from_editlatt(UndoLattice *ult, EditLatt *editlatt, const ListBaseT< bDeformGroup > *vertex_group_names, int vertex_group_active_index)
static bool lattice_undosys_poll(bContext *C)
void ED_undo_object_editmode_validate_scene_from_windows(wmWindowManager *wm, const Scene *scene_ref, Scene **scene_p, ViewLayer **view_layer_p)
Definition ed_undo.cc:1047
void * MEM_new_array_zeroed(size_t len, size_t size, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1
struct Lattice * latt
char name[258]
Definition DNA_ID.h:433
LatticeUndoStep_Elem * elems
struct EditLatt * editlatt
struct MDeformVert * dvert
ListBaseT< struct bDeformGroup > vertex_group_names
struct BPoint * def
bool is_memfile_undo_flush_needed
Definition BKE_main.hh:302
ListBaseT< bDeformGroup > vertex_group_names
bool(*) poll(bContext *C)
void(*) step_free(UndoStep *us)
void(*) step_decode(bContext *C, Main *bmain, UndoStep *us, eUndoStepDir dir, bool is_final)
void(*) step_foreach_ID_ref(UndoStep *us, UndoTypeForEachIDRefFn foreach_ID_ref_fn, void *user_data)
bool(*) step_encode(bContext *C, Main *bmain, UndoStep *us)
const char * identifier