Merge branch 'blender-v2.81-release'
[blender.git] / source / blender / editors / object / object_modes.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup edobj
19  *
20  * General utils to handle mode switching,
21  * actual mode switching logic is per-object type.
22  */
23
24 #include "DNA_gpencil_types.h"
25 #include "DNA_object_types.h"
26 #include "DNA_scene_types.h"
27 #include "DNA_workspace_types.h"
28
29 #include "BLI_utildefines.h"
30
31 #include "BKE_context.h"
32 #include "BKE_layer.h"
33 #include "BKE_object.h"
34 #include "BKE_paint.h"
35 #include "BKE_report.h"
36 #include "BKE_scene.h"
37
38 #include "WM_api.h"
39 #include "WM_types.h"
40
41 #include "RNA_access.h"
42
43 #include "DEG_depsgraph.h"
44
45 #include "ED_armature.h"
46 #include "ED_gpencil.h"
47 #include "ED_screen.h"
48
49 #include "ED_object.h" /* own include */
50
51 /* -------------------------------------------------------------------- */
52 /** \name High Level Mode Operations
53  *
54  * \{ */
55
56 static const char *object_mode_op_string(eObjectMode mode)
57 {
58   if (mode & OB_MODE_EDIT) {
59     return "OBJECT_OT_editmode_toggle";
60   }
61   if (mode == OB_MODE_SCULPT) {
62     return "SCULPT_OT_sculptmode_toggle";
63   }
64   if (mode == OB_MODE_VERTEX_PAINT) {
65     return "PAINT_OT_vertex_paint_toggle";
66   }
67   if (mode == OB_MODE_WEIGHT_PAINT) {
68     return "PAINT_OT_weight_paint_toggle";
69   }
70   if (mode == OB_MODE_TEXTURE_PAINT) {
71     return "PAINT_OT_texture_paint_toggle";
72   }
73   if (mode == OB_MODE_PARTICLE_EDIT) {
74     return "PARTICLE_OT_particle_edit_toggle";
75   }
76   if (mode == OB_MODE_POSE) {
77     return "OBJECT_OT_posemode_toggle";
78   }
79   if (mode == OB_MODE_EDIT_GPENCIL) {
80     return "GPENCIL_OT_editmode_toggle";
81   }
82   if (mode == OB_MODE_PAINT_GPENCIL) {
83     return "GPENCIL_OT_paintmode_toggle";
84   }
85   if (mode == OB_MODE_SCULPT_GPENCIL) {
86     return "GPENCIL_OT_sculptmode_toggle";
87   }
88   if (mode == OB_MODE_WEIGHT_GPENCIL) {
89     return "GPENCIL_OT_weightmode_toggle";
90   }
91   return NULL;
92 }
93
94 /**
95  * Checks the mode to be set is compatible with the object
96  * should be made into a generic function
97  */
98 bool ED_object_mode_compat_test(const Object *ob, eObjectMode mode)
99 {
100   if (ob) {
101     if (mode == OB_MODE_OBJECT) {
102       return true;
103     }
104
105     switch (ob->type) {
106       case OB_MESH:
107         if (mode & (OB_MODE_EDIT | OB_MODE_SCULPT | OB_MODE_VERTEX_PAINT | OB_MODE_WEIGHT_PAINT |
108                     OB_MODE_TEXTURE_PAINT | OB_MODE_PARTICLE_EDIT)) {
109           return true;
110         }
111         break;
112       case OB_CURVE:
113       case OB_SURF:
114       case OB_FONT:
115       case OB_MBALL:
116         if (mode & (OB_MODE_EDIT)) {
117           return true;
118         }
119         break;
120       case OB_LATTICE:
121         if (mode & (OB_MODE_EDIT | OB_MODE_WEIGHT_PAINT)) {
122           return true;
123         }
124         break;
125       case OB_ARMATURE:
126         if (mode & (OB_MODE_EDIT | OB_MODE_POSE)) {
127           return true;
128         }
129         break;
130       case OB_GPENCIL:
131         if (mode & (OB_MODE_EDIT | OB_MODE_EDIT_GPENCIL | OB_MODE_PAINT_GPENCIL |
132                     OB_MODE_SCULPT_GPENCIL | OB_MODE_WEIGHT_GPENCIL)) {
133           return true;
134         }
135         break;
136     }
137   }
138
139   return false;
140 }
141
142 /**
143  * Sets the mode to a compatible state (use before entering the mode).
144  *
145  * This is so each mode's exec function can call
146  */
147 bool ED_object_mode_compat_set(bContext *C, Object *ob, eObjectMode mode, ReportList *reports)
148 {
149   bool ok;
150   if (!ELEM(ob->mode, mode, OB_MODE_OBJECT)) {
151     const char *opstring = object_mode_op_string(ob->mode);
152
153     WM_operator_name_call(C, opstring, WM_OP_EXEC_REGION_WIN, NULL);
154     ok = ELEM(ob->mode, mode, OB_MODE_OBJECT);
155     if (!ok) {
156       wmOperatorType *ot = WM_operatortype_find(opstring, false);
157       BKE_reportf(reports, RPT_ERROR, "Unable to execute '%s', error changing modes", ot->name);
158     }
159   }
160   else {
161     ok = true;
162   }
163
164   return ok;
165 }
166
167 void ED_object_mode_toggle(bContext *C, eObjectMode mode)
168 {
169   if (mode != OB_MODE_OBJECT) {
170     const char *opstring = object_mode_op_string(mode);
171
172     if (opstring) {
173       wmOperatorType *ot = WM_operatortype_find(opstring, false);
174       WM_operator_name_call_ptr(C, ot, WM_OP_EXEC_REGION_WIN, NULL);
175     }
176   }
177 }
178
179 /* Wrapper for operator  */
180 void ED_object_mode_set(bContext *C, eObjectMode mode)
181 {
182   wmWindowManager *wm = CTX_wm_manager(C);
183   wm->op_undo_depth++;
184   /* needed so we don't do undo pushes. */
185   ED_object_mode_generic_enter(C, mode);
186   wm->op_undo_depth--;
187 }
188
189 void ED_object_mode_exit(bContext *C, Depsgraph *depsgraph)
190 {
191   struct Main *bmain = CTX_data_main(C);
192   Scene *scene = CTX_data_scene(C);
193   ViewLayer *view_layer = CTX_data_view_layer(C);
194   FOREACH_OBJECT_BEGIN (view_layer, ob) {
195     if (ob->mode & OB_MODE_ALL_MODE_DATA) {
196       ED_object_mode_generic_exit(bmain, depsgraph, scene, ob);
197     }
198   }
199   FOREACH_OBJECT_END;
200 }
201
202 /** \} */
203
204 /* -------------------------------------------------------------------- */
205 /** \name Generic Mode Enter/Exit
206  *
207  * Supports exiting a mode without it being in the current context.
208  * This could be done for entering modes too if it's needed.
209  *
210  * \{ */
211
212 bool ED_object_mode_generic_enter(struct bContext *C, eObjectMode object_mode)
213 {
214   ViewLayer *view_layer = CTX_data_view_layer(C);
215   Object *ob = OBACT(view_layer);
216   if (ob == NULL) {
217     return (object_mode == OB_MODE_OBJECT);
218   }
219   if (ob->mode == object_mode) {
220     return true;
221   }
222   wmOperatorType *ot = WM_operatortype_find("OBJECT_OT_mode_set", false);
223   PointerRNA ptr;
224   WM_operator_properties_create_ptr(&ptr, ot);
225   RNA_enum_set(&ptr, "mode", object_mode);
226   WM_operator_name_call_ptr(C, ot, WM_OP_INVOKE_DEFAULT, &ptr);
227   WM_operator_properties_free(&ptr);
228   return (ob->mode == object_mode);
229 }
230
231 /**
232  * Use for changing works-paces or changing active object.
233  * Caller can check #OB_MODE_ALL_MODE_DATA to test if this needs to be run.
234  */
235 static bool ed_object_mode_generic_exit_ex(struct Main *bmain,
236                                            struct Depsgraph *depsgraph,
237                                            struct Scene *scene,
238                                            struct Object *ob,
239                                            bool only_test)
240 {
241   BLI_assert((bmain == NULL) == only_test);
242   if (ob->mode & OB_MODE_EDIT) {
243     if (BKE_object_is_in_editmode(ob)) {
244       if (only_test) {
245         return true;
246       }
247       ED_object_editmode_exit_ex(bmain, scene, ob, EM_FREEDATA);
248     }
249   }
250   else if (ob->mode & OB_MODE_VERTEX_PAINT) {
251     if (ob->sculpt && (ob->sculpt->mode_type == OB_MODE_VERTEX_PAINT)) {
252       if (only_test) {
253         return true;
254       }
255       ED_object_vpaintmode_exit_ex(ob);
256     }
257   }
258   else if (ob->mode & OB_MODE_WEIGHT_PAINT) {
259     if (ob->sculpt && (ob->sculpt->mode_type == OB_MODE_WEIGHT_PAINT)) {
260       if (only_test) {
261         return true;
262       }
263       ED_object_wpaintmode_exit_ex(ob);
264     }
265   }
266   else if (ob->mode & OB_MODE_SCULPT) {
267     if (ob->sculpt && (ob->sculpt->mode_type == OB_MODE_SCULPT)) {
268       if (only_test) {
269         return true;
270       }
271       ED_object_sculptmode_exit_ex(bmain, depsgraph, scene, ob);
272     }
273   }
274   else if (ob->mode & OB_MODE_POSE) {
275     if (ob->pose != NULL) {
276       if (only_test) {
277         return true;
278       }
279       ED_object_posemode_exit_ex(bmain, ob);
280     }
281   }
282   else if ((ob->type == OB_GPENCIL) && ((ob->mode & OB_MODE_OBJECT) == 0)) {
283     if (only_test) {
284       return true;
285     }
286     ED_object_gpencil_exit(bmain, ob);
287   }
288   else {
289     if (only_test) {
290       return false;
291     }
292     BLI_assert((ob->mode & OB_MODE_ALL_MODE_DATA) == 0);
293   }
294
295   return false;
296 }
297
298 void ED_object_mode_generic_exit(struct Main *bmain,
299                                  struct Depsgraph *depsgraph,
300                                  struct Scene *scene,
301                                  struct Object *ob)
302 {
303   ed_object_mode_generic_exit_ex(bmain, depsgraph, scene, ob, false);
304 }
305
306 bool ED_object_mode_generic_has_data(struct Depsgraph *depsgraph, struct Object *ob)
307 {
308   return ed_object_mode_generic_exit_ex(NULL, depsgraph, NULL, ob, true);
309 }
310
311 /** \} */