Object Mode: move logic to 'object_modes.c'
[blender.git] / source / blender / editors / util / ed_util.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) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/util/ed_util.c
28  *  \ingroup edutil
29  */
30
31
32 #include <stdlib.h>
33 #include <string.h>
34 #include <math.h>
35
36 #include "MEM_guardedalloc.h"
37
38 #include "DNA_mesh_types.h"
39 #include "DNA_object_types.h"
40 #include "DNA_screen_types.h"
41 #include "DNA_space_types.h"
42 #include "DNA_scene_types.h"
43 #include "DNA_packedFile_types.h"
44
45 #include "BLI_utildefines.h"
46 #include "BLI_string.h"
47 #include "BLI_path_util.h"
48
49 #include "BIF_gl.h"
50 #include "BIF_glutil.h"
51
52 #include "BLT_translation.h"
53
54 #include "BKE_context.h"
55 #include "BKE_global.h"
56 #include "BKE_main.h"
57 #include "BKE_multires.h"
58 #include "BKE_packedFile.h"
59 #include "BKE_paint.h"
60 #include "BKE_screen.h"
61
62 #include "ED_armature.h"
63 #include "ED_buttons.h"
64 #include "ED_image.h"
65 #include "ED_mesh.h"
66 #include "ED_node.h"
67 #include "ED_object.h"
68 #include "ED_outliner.h"
69 #include "ED_paint.h"
70 #include "ED_space_api.h"
71 #include "ED_util.h"
72
73 #include "UI_interface.h"
74 #include "UI_resources.h"
75
76 #include "WM_types.h"
77 #include "WM_api.h"
78 #include "RNA_access.h"
79
80
81
82 /* ********* general editor util funcs, not BKE stuff please! ********* */
83
84 void ED_editors_init(bContext *C)
85 {
86         wmWindowManager *wm = CTX_wm_manager(C);
87         Main *bmain = CTX_data_main(C);
88         Scene *sce = CTX_data_scene(C);
89         Object *ob, *obact = (sce && sce->basact) ? sce->basact->object : NULL;
90         ID *data;
91
92         /* This is called during initialization, so we don't want to store any reports */
93         ReportList *reports = CTX_wm_reports(C);
94         int reports_flag_prev = reports->flag & ~RPT_STORE;
95
96         SWAP(int, reports->flag, reports_flag_prev);
97
98         /* toggle on modes for objects that were saved with these enabled. for
99          * e.g. linked objects we have to ensure that they are actually the
100          * active object in this scene. */
101         for (ob = bmain->object.first; ob; ob = ob->id.next) {
102                 int mode = ob->mode;
103
104                 if (!ELEM(mode, OB_MODE_OBJECT, OB_MODE_POSE)) {
105                         ob->mode = OB_MODE_OBJECT;
106                         data = ob->data;
107
108                         if (ob == obact && !ID_IS_LINKED(ob) && !(data && ID_IS_LINKED(data)))
109                                 ED_object_mode_toggle(C, mode);
110                 }
111         }
112
113         /* image editor paint mode */
114         if (sce) {
115                 ED_space_image_paint_update(wm, sce);
116         }
117
118         SWAP(int, reports->flag, reports_flag_prev);
119 }
120
121 /* frees all editmode stuff */
122 void ED_editors_exit(bContext *C)
123 {
124         Main *bmain = CTX_data_main(C);
125         Scene *sce;
126
127         if (!bmain)
128                 return;
129         
130         /* frees all editmode undos */
131         undo_editmode_clear();
132         ED_undo_paint_free();
133         
134         for (sce = bmain->scene.first; sce; sce = sce->id.next) {
135                 if (sce->obedit) {
136                         Object *ob = sce->obedit;
137                 
138                         if (ob) {
139                                 if (ob->type == OB_MESH) {
140                                         Mesh *me = ob->data;
141                                         if (me->edit_btmesh) {
142                                                 EDBM_mesh_free(me->edit_btmesh);
143                                                 MEM_freeN(me->edit_btmesh);
144                                                 me->edit_btmesh = NULL;
145                                         }
146                                 }
147                                 else if (ob->type == OB_ARMATURE) {
148                                         ED_armature_edit_free(ob->data);
149                                 }
150                         }
151                 }
152         }
153
154         /* global in meshtools... */
155         ED_mesh_mirror_spatial_table(NULL, NULL, NULL, NULL, 'e');
156         ED_mesh_mirror_topo_table(NULL, NULL, 'e');
157 }
158
159 /* flush any temp data from object editing to DNA before writing files,
160  * rendering, copying, etc. */
161 bool ED_editors_flush_edits(const bContext *C, bool for_render)
162 {
163         bool has_edited = false;
164         Object *ob;
165         Main *bmain = CTX_data_main(C);
166
167         /* loop through all data to find edit mode or object mode, because during
168          * exiting we might not have a context for edit object and multiple sculpt
169          * objects can exist at the same time */
170         for (ob = bmain->object.first; ob; ob = ob->id.next) {
171                 if (ob->mode & OB_MODE_SCULPT) {
172                         /* Don't allow flushing while in the middle of a stroke (frees data in use).
173                          * Auto-save prevents this from happening but scripts may cause a flush on saving: T53986. */
174                         if ((ob->sculpt && ob->sculpt->cache) == 0) {
175                                 /* flush multires changes (for sculpt) */
176                                 multires_force_update(ob);
177                                 has_edited = true;
178
179                                 if (for_render) {
180                                         /* flush changes from dynamic topology sculpt */
181                                         BKE_sculptsession_bm_to_me_for_render(ob);
182                                 }
183                                 else {
184                                         /* Set reorder=false so that saving the file doesn't reorder
185                                          * the BMesh's elements */
186                                         BKE_sculptsession_bm_to_me(ob, false);
187                                 }
188                         }
189                 }
190                 else if (ob->mode & OB_MODE_EDIT) {
191                         /* get editmode results */
192                         has_edited = true;
193                         ED_object_editmode_load(ob);
194                 }
195         }
196
197         return has_edited;
198 }
199
200 /* ***** XXX: functions are using old blender names, cleanup later ***** */
201
202
203 /* now only used in 2d spaces, like time, ipo, nla, sima... */
204 /* XXX shift/ctrl not configurable */
205 void apply_keyb_grid(int shift, int ctrl, float *val, float fac1, float fac2, float fac3, int invert)
206 {
207         /* fac1 is for 'nothing', fac2 for CTRL, fac3 for SHIFT */
208         if (invert)
209                 ctrl = !ctrl;
210         
211         if (ctrl && shift) {
212                 if (fac3 != 0.0f) *val = fac3 * floorf(*val / fac3 + 0.5f);
213         }
214         else if (ctrl) {
215                 if (fac2 != 0.0f) *val = fac2 * floorf(*val / fac2 + 0.5f);
216         }
217         else {
218                 if (fac1 != 0.0f) *val = fac1 * floorf(*val / fac1 + 0.5f);
219         }
220 }
221
222 void unpack_menu(bContext *C, const char *opname, const char *id_name, const char *abs_name, const char *folder, struct PackedFile *pf)
223 {
224         PointerRNA props_ptr;
225         uiPopupMenu *pup;
226         uiLayout *layout;
227         char line[FILE_MAX + 100];
228         wmOperatorType *ot = WM_operatortype_find(opname, 1);
229
230         pup = UI_popup_menu_begin(C, IFACE_("Unpack File"), ICON_NONE);
231         layout = UI_popup_menu_layout(pup);
232
233         uiItemFullO_ptr(
234                 layout, ot, IFACE_("Remove Pack"), ICON_NONE,
235                 NULL, WM_OP_EXEC_DEFAULT, 0, &props_ptr);
236         RNA_enum_set(&props_ptr, "method", PF_REMOVE);
237         RNA_string_set(&props_ptr, "id", id_name);
238
239         if (G.relbase_valid) {
240                 char local_name[FILE_MAXDIR + FILE_MAX], fi[FILE_MAX];
241
242                 BLI_split_file_part(abs_name, fi, sizeof(fi));
243                 BLI_snprintf(local_name, sizeof(local_name), "//%s/%s", folder, fi);
244                 if (!STREQ(abs_name, local_name)) {
245                         switch (checkPackedFile(local_name, pf)) {
246                                 case PF_NOFILE:
247                                         BLI_snprintf(line, sizeof(line), IFACE_("Create %s"), local_name);
248                                         uiItemFullO_ptr(layout, ot, line, ICON_NONE, NULL, WM_OP_EXEC_DEFAULT, 0, &props_ptr);
249                                         RNA_enum_set(&props_ptr, "method", PF_WRITE_LOCAL);
250                                         RNA_string_set(&props_ptr, "id", id_name);
251
252                                         break;
253                                 case PF_EQUAL:
254                                         BLI_snprintf(line, sizeof(line), IFACE_("Use %s (identical)"), local_name);
255                                         //uiItemEnumO_ptr(layout, ot, line, 0, "method", PF_USE_LOCAL);
256                                         uiItemFullO_ptr(layout, ot, line, ICON_NONE, NULL, WM_OP_EXEC_DEFAULT, 0, &props_ptr);
257                                         RNA_enum_set(&props_ptr, "method", PF_USE_LOCAL);
258                                         RNA_string_set(&props_ptr, "id", id_name);
259
260                                         break;
261                                 case PF_DIFFERS:
262                                         BLI_snprintf(line, sizeof(line), IFACE_("Use %s (differs)"), local_name);
263                                         //uiItemEnumO_ptr(layout, ot, line, 0, "method", PF_USE_LOCAL);
264                                         uiItemFullO_ptr(layout, ot, line, ICON_NONE, NULL, WM_OP_EXEC_DEFAULT, 0, &props_ptr);
265                                         RNA_enum_set(&props_ptr, "method", PF_USE_LOCAL);
266                                         RNA_string_set(&props_ptr, "id", id_name);
267
268                                         BLI_snprintf(line, sizeof(line), IFACE_("Overwrite %s"), local_name);
269                                         //uiItemEnumO_ptr(layout, ot, line, 0, "method", PF_WRITE_LOCAL);
270                                         uiItemFullO_ptr(layout, ot, line, ICON_NONE, NULL, WM_OP_EXEC_DEFAULT, 0, &props_ptr);
271                                         RNA_enum_set(&props_ptr, "method", PF_WRITE_LOCAL);
272                                         RNA_string_set(&props_ptr, "id", id_name);
273                                         break;
274                         }
275                 }
276         }
277
278         switch (checkPackedFile(abs_name, pf)) {
279                 case PF_NOFILE:
280                         BLI_snprintf(line, sizeof(line), IFACE_("Create %s"), abs_name);
281                         //uiItemEnumO_ptr(layout, ot, line, 0, "method", PF_WRITE_ORIGINAL);
282                         uiItemFullO_ptr(layout, ot, line, ICON_NONE, NULL, WM_OP_EXEC_DEFAULT, 0, &props_ptr);
283                         RNA_enum_set(&props_ptr, "method", PF_WRITE_ORIGINAL);
284                         RNA_string_set(&props_ptr, "id", id_name);
285                         break;
286                 case PF_EQUAL:
287                         BLI_snprintf(line, sizeof(line), IFACE_("Use %s (identical)"), abs_name);
288                         //uiItemEnumO_ptr(layout, ot, line, 0, "method", PF_USE_ORIGINAL);
289                         uiItemFullO_ptr(layout, ot, line, ICON_NONE, NULL, WM_OP_EXEC_DEFAULT, 0, &props_ptr);
290                         RNA_enum_set(&props_ptr, "method", PF_USE_ORIGINAL);
291                         RNA_string_set(&props_ptr, "id", id_name);
292                         break;
293                 case PF_DIFFERS:
294                         BLI_snprintf(line, sizeof(line), IFACE_("Use %s (differs)"), abs_name);
295                         //uiItemEnumO_ptr(layout, ot, line, 0, "method", PF_USE_ORIGINAL);
296                         uiItemFullO_ptr(layout, ot, line, ICON_NONE, NULL, WM_OP_EXEC_DEFAULT, 0, &props_ptr);
297                         RNA_enum_set(&props_ptr, "method", PF_USE_ORIGINAL);
298                         RNA_string_set(&props_ptr, "id", id_name);
299
300                         BLI_snprintf(line, sizeof(line), IFACE_("Overwrite %s"), abs_name);
301                         //uiItemEnumO_ptr(layout, ot, line, 0, "method", PF_WRITE_ORIGINAL);
302                         uiItemFullO_ptr(layout, ot, line, ICON_NONE, NULL, WM_OP_EXEC_DEFAULT, 0, &props_ptr);
303                         RNA_enum_set(&props_ptr, "method", PF_WRITE_ORIGINAL);
304                         RNA_string_set(&props_ptr, "id", id_name);
305                         break;
306         }
307
308         UI_popup_menu_end(C, pup);
309 }
310
311 /* ********************* generic callbacks for drawcall api *********************** */
312
313 /**
314  * Callback that draws a line between the mouse and a position given as the initial argument.
315  */
316 void ED_region_draw_mouse_line_cb(const bContext *C, ARegion *ar, void *arg_info)
317 {
318         wmWindow *win = CTX_wm_window(C);
319         const float *mval_src = (float *)arg_info;
320         const int mval_dst[2] = {win->eventstate->x - ar->winrct.xmin,
321                                  win->eventstate->y - ar->winrct.ymin};
322
323         UI_ThemeColor(TH_VIEW_OVERLAY);
324         setlinestyle(3);
325         glBegin(GL_LINES);
326         glVertex2iv(mval_dst);
327         glVertex2fv(mval_src);
328         glEnd();
329         setlinestyle(0);
330 }
331
332 /**
333  * Use to free ID references within runtime data (stored outside of DNA)
334  *
335  * \param new_id may be NULL to unlink \a old_id.
336  */
337 void ED_spacedata_id_remap(struct ScrArea *sa, struct SpaceLink *sl, ID *old_id, ID *new_id)
338 {
339         SpaceType *st = BKE_spacetype_from_id(sl->spacetype);
340
341         if (st && st->id_remap) {
342                 st->id_remap(sa, sl, old_id, new_id);
343         }
344 }
345
346 static int ed_flush_edits_exec(bContext *C, wmOperator *UNUSED(op))
347 {
348         ED_editors_flush_edits(C, false);
349         return OPERATOR_FINISHED;
350 }
351
352 void ED_OT_flush_edits(wmOperatorType *ot)
353 {
354         /* identifiers */
355         ot->name = "Flush Edits";
356         ot->description = "Flush edit data from active editing modes";
357         ot->idname = "ED_OT_flush_edits";
358
359         /* api callbacks */
360         ot->exec = ed_flush_edits_exec;
361
362         /* flags */
363         ot->flag = OPTYPE_INTERNAL;
364 }