WM: Add WM_menutype_poll function
[blender-staging.git] / source / blender / editors / interface / interface_region_menu_pie.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  * Contributor(s): Blender Foundation
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/editors/interface/interface_region_menu_pie.c
27  *  \ingroup edinterface
28  *
29  * Pie Menu Region
30  */
31
32 #include <stdarg.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #include <assert.h>
36
37 #include "MEM_guardedalloc.h"
38
39 #include "DNA_userdef_types.h"
40
41 #include "BLI_blenlib.h"
42 #include "BLI_utildefines.h"
43
44 #include "PIL_time.h"
45
46 #include "BKE_context.h"
47 #include "BKE_screen.h"
48
49 #include "WM_api.h"
50 #include "WM_types.h"
51
52 #include "RNA_access.h"
53
54 #include "UI_interface.h"
55
56 #include "BLT_translation.h"
57
58 #include "ED_screen.h"
59
60 #include "interface_intern.h"
61 #include "interface_regions_intern.h"
62
63 /* -------------------------------------------------------------------- */
64 /** \name Pie Menu
65  * \{ */
66
67 struct uiPieMenu {
68         uiBlock *block_radial; /* radial block of the pie menu (more could be added later) */
69         uiLayout *layout;
70         int mx, my;
71 };
72
73 static uiBlock *ui_block_func_PIE(bContext *UNUSED(C), uiPopupBlockHandle *handle, void *arg_pie)
74 {
75         uiBlock *block;
76         uiPieMenu *pie = arg_pie;
77         int minwidth, width, height;
78
79         minwidth = 50;
80         block = pie->block_radial;
81
82         /* in some cases we create the block before the region,
83          * so we set it delayed here if necessary */
84         if (BLI_findindex(&handle->region->uiblocks, block) == -1)
85                 UI_block_region_set(block, handle->region);
86
87         UI_block_layout_resolve(block, &width, &height);
88
89         UI_block_flag_enable(block, UI_BLOCK_LOOP | UI_BLOCK_NUMSELECT);
90
91         block->minbounds = minwidth;
92         block->bounds = 1;
93         block->mx = 0;
94         block->my = 0;
95         block->bounds_type = UI_BLOCK_BOUNDS_PIE_CENTER;
96
97         block->pie_data.pie_center_spawned[0] = pie->mx;
98         block->pie_data.pie_center_spawned[1] = pie->my;
99
100         return pie->block_radial;
101 }
102
103 static float ui_pie_menu_title_width(const char *name, int icon)
104 {
105         const uiFontStyle *fstyle = UI_FSTYLE_WIDGET;
106         return (UI_fontstyle_string_width(fstyle, name) +
107                  (UI_UNIT_X * (1.50f + (icon ? 0.25f : 0.0f))));
108 }
109
110 uiPieMenu *UI_pie_menu_begin(struct bContext *C, const char *title, int icon, const wmEvent *event)
111 {
112         uiStyle *style;
113         uiPieMenu *pie;
114         short event_type;
115
116         wmWindow *win = CTX_wm_window(C);
117
118         style = UI_style_get_dpi();
119         pie = MEM_callocN(sizeof(*pie), "pie menu");
120
121         pie->block_radial = UI_block_begin(C, NULL, __func__, UI_EMBOSS);
122         /* may be useful later to allow spawning pies
123          * from old positions */
124         /* pie->block_radial->flag |= UI_BLOCK_POPUP_MEMORY; */
125         pie->block_radial->puphash = ui_popup_menu_hash(title);
126         pie->block_radial->flag |= UI_BLOCK_RADIAL;
127
128         /* if pie is spawned by a left click, release or click event, it is always assumed to be click style */
129         if (event->type == LEFTMOUSE || ELEM(event->val, KM_RELEASE, KM_CLICK)) {
130                 pie->block_radial->pie_data.flags |= UI_PIE_CLICK_STYLE;
131                 pie->block_radial->pie_data.event = EVENT_NONE;
132                 win->lock_pie_event = EVENT_NONE;
133         }
134         else {
135                 if (win->last_pie_event != EVENT_NONE) {
136                         /* original pie key has been released, so don't propagate the event */
137                         if (win->lock_pie_event == EVENT_NONE) {
138                                 event_type = EVENT_NONE;
139                                 pie->block_radial->pie_data.flags |= UI_PIE_CLICK_STYLE;
140                         }
141                         else
142                                 event_type = win->last_pie_event;
143                 }
144                 else {
145                         event_type = event->type;
146                 }
147
148                 pie->block_radial->pie_data.event = event_type;
149                 win->lock_pie_event = event_type;
150         }
151
152         pie->layout = UI_block_layout(pie->block_radial, UI_LAYOUT_VERTICAL, UI_LAYOUT_PIEMENU, 0, 0, 200, 0, 0, style);
153         pie->mx = event->x;
154         pie->my = event->y;
155
156         /* create title button */
157         if (title[0]) {
158                 uiBut *but;
159                 char titlestr[256];
160                 int w;
161                 if (icon) {
162                         BLI_snprintf(titlestr, sizeof(titlestr), " %s", title);
163                         w = ui_pie_menu_title_width(titlestr, icon);
164                         but = uiDefIconTextBut(
165                                 pie->block_radial, UI_BTYPE_LABEL, 0, icon, titlestr, 0, 0, w, UI_UNIT_Y,
166                                 NULL, 0.0, 0.0, 0, 0, "");
167                 }
168                 else {
169                         w = ui_pie_menu_title_width(title, 0);
170                         but = uiDefBut(
171                                 pie->block_radial, UI_BTYPE_LABEL, 0, title, 0, 0, w, UI_UNIT_Y,
172                                 NULL, 0.0, 0.0, 0, 0, "");
173                 }
174                 /* do not align left */
175                 but->drawflag &= ~UI_BUT_TEXT_LEFT;
176                 pie->block_radial->pie_data.title = but->str;
177                 pie->block_radial->pie_data.icon = icon;
178         }
179
180         return pie;
181 }
182
183 void UI_pie_menu_end(bContext *C, uiPieMenu *pie)
184 {
185         wmWindow *window = CTX_wm_window(C);
186         uiPopupBlockHandle *menu;
187
188         menu = ui_popup_block_create(C, NULL, NULL, NULL, ui_block_func_PIE, pie);
189         menu->popup = true;
190         menu->towardstime = PIL_check_seconds_timer();
191
192         UI_popup_handlers_add(
193                 C, &window->modalhandlers,
194                 menu, WM_HANDLER_ACCEPT_DBL_CLICK);
195         WM_event_add_mousemove(C);
196
197         menu->can_refresh = false;
198         MEM_freeN(pie);
199 }
200
201 uiLayout *UI_pie_menu_layout(uiPieMenu *pie)
202 {
203         return pie->layout;
204 }
205
206 int UI_pie_menu_invoke(struct bContext *C, const char *idname, const wmEvent *event)
207 {
208         uiPieMenu *pie;
209         uiLayout *layout;
210         MenuType *mt = WM_menutype_find(idname, true);
211
212         if (mt == NULL) {
213                 printf("%s: named menu \"%s\" not found\n", __func__, idname);
214                 return OPERATOR_CANCELLED;
215         }
216
217         if (WM_menutype_poll(C, mt) == false) {
218                 /* cancel but allow event to pass through, just like operators do */
219                 return (OPERATOR_CANCELLED | OPERATOR_PASS_THROUGH);
220         }
221
222         pie = UI_pie_menu_begin(C, IFACE_(mt->label), ICON_NONE, event);
223         layout = UI_pie_menu_layout(pie);
224
225         UI_menutype_draw(C, mt, layout);
226
227         UI_pie_menu_end(C, pie);
228
229         return OPERATOR_INTERFACE;
230 }
231
232 int UI_pie_menu_invoke_from_operator_enum(
233         struct bContext *C, const char *title, const char *opname,
234         const char *propname, const wmEvent *event)
235 {
236         uiPieMenu *pie;
237         uiLayout *layout;
238
239         pie = UI_pie_menu_begin(C, IFACE_(title), ICON_NONE, event);
240         layout = UI_pie_menu_layout(pie);
241
242         layout = uiLayoutRadial(layout);
243         uiItemsEnumO(layout, opname, propname);
244
245         UI_pie_menu_end(C, pie);
246
247         return OPERATOR_INTERFACE;
248 }
249
250 int UI_pie_menu_invoke_from_rna_enum(
251         struct bContext *C, const char *title, const char *path,
252         const wmEvent *event)
253 {
254         PointerRNA ctx_ptr;
255         PointerRNA r_ptr;
256         PropertyRNA *r_prop;
257         uiPieMenu *pie;
258         uiLayout *layout;
259
260         RNA_pointer_create(NULL, &RNA_Context, C, &ctx_ptr);
261
262         if (!RNA_path_resolve(&ctx_ptr, path, &r_ptr, &r_prop)) {
263                 return OPERATOR_CANCELLED;
264         }
265
266         /* invalid property, only accept enums */
267         if (RNA_property_type(r_prop) != PROP_ENUM) {
268                 BLI_assert(0);
269                 return OPERATOR_CANCELLED;
270         }
271
272         pie = UI_pie_menu_begin(C, IFACE_(title), ICON_NONE, event);
273
274         layout = UI_pie_menu_layout(pie);
275
276         layout = uiLayoutRadial(layout);
277         uiItemFullR(layout, &r_ptr, r_prop, RNA_NO_INDEX, 0, UI_ITEM_R_EXPAND, NULL, 0);
278
279         UI_pie_menu_end(C, pie);
280
281         return OPERATOR_INTERFACE;
282 }
283
284 /** \} */
285
286 /* -------------------------------------------------------------------- */
287 /**
288  * \name Pie Menu Levels
289  *
290  * Pie menus can't contain more than 8 items (yet). When using #uiItemsFullEnumO, a "More" button is created that calls
291  * a new pie menu if the enum has too many items. We call this a new "level".
292  * Indirect recursion is used, so that a theoretically unlimited number of items is supported.
293  *
294  * This is a implementation specifically for operator enums, needed since the object mode pie now has more than 8
295  * items. Ideally we'd have some way of handling this for all kinds of pie items, but that's tricky.
296  *
297  * - Julian (Feb 2016)
298  *
299  * \{ */
300
301 typedef struct PieMenuLevelData {
302         char title[UI_MAX_NAME_STR]; /* parent pie title, copied for level */
303         int icon; /* parent pie icon, copied for level */
304         int totitem; /* total count of *remaining* items */
305
306         /* needed for calling uiItemsFullEnumO_array again for new level */
307         wmOperatorType *ot;
308         const char *propname;
309         IDProperty *properties;
310         int context, flag;
311 } PieMenuLevelData;
312
313 /**
314  * Invokes a new pie menu for a new level.
315  */
316 static void ui_pie_menu_level_invoke(bContext *C, void *argN, void *arg2)
317 {
318         EnumPropertyItem *item_array = (EnumPropertyItem *)argN;
319         PieMenuLevelData *lvl = (PieMenuLevelData *)arg2;
320         wmWindow *win = CTX_wm_window(C);
321
322         uiPieMenu *pie = UI_pie_menu_begin(C, IFACE_(lvl->title), lvl->icon, win->eventstate);
323         uiLayout *layout = UI_pie_menu_layout(pie);
324
325         layout = uiLayoutRadial(layout);
326
327         PointerRNA ptr;
328
329         WM_operator_properties_create_ptr(&ptr, lvl->ot);
330         /* so the context is passed to itemf functions (some need it) */
331         WM_operator_properties_sanitize(&ptr, false);
332         PropertyRNA *prop = RNA_struct_find_property(&ptr, lvl->propname);
333
334         if (prop) {
335                 uiItemsFullEnumO_items(
336                         layout, lvl->ot, ptr, prop, lvl->properties, lvl->context, lvl->flag,
337                         item_array, lvl->totitem);
338         }
339         else {
340                 RNA_warning("%s.%s not found", RNA_struct_identifier(ptr.type), lvl->propname);
341         }
342
343         UI_pie_menu_end(C, pie);
344 }
345
346 /**
347  * Set up data for defining a new pie menu level and add button that invokes it.
348  */
349 void ui_pie_menu_level_create(
350         uiBlock *block, wmOperatorType *ot, const char *propname, IDProperty *properties,
351         const EnumPropertyItem *items, int totitem, int context, int flag)
352 {
353         const int totitem_parent = PIE_MAX_ITEMS - 1;
354         const int totitem_remain = totitem - totitem_parent;
355         size_t array_size = sizeof(EnumPropertyItem) * totitem_remain;
356
357         /* used as but->func_argN so freeing is handled elsewhere */
358         EnumPropertyItem *remaining = MEM_mallocN(array_size + sizeof(EnumPropertyItem), "pie_level_item_array");
359         memcpy(remaining, items + totitem_parent, array_size);
360         /* a NULL terminating sentinal element is required */
361         memset(&remaining[totitem_remain], 0, sizeof(EnumPropertyItem));
362
363
364         /* yuk, static... issue is we can't reliably free this without doing dangerous changes */
365         static PieMenuLevelData lvl;
366         BLI_strncpy(lvl.title, block->pie_data.title, UI_MAX_NAME_STR);
367         lvl.totitem    = totitem_remain;
368         lvl.ot         = ot;
369         lvl.propname   = propname;
370         lvl.properties = properties;
371         lvl.context    = context;
372         lvl.flag       = flag;
373
374         /* add a 'more' menu entry */
375         uiBut *but = uiDefIconTextBut(block, UI_BTYPE_BUT, 0, ICON_PLUS, "More", 0, 0, UI_UNIT_X * 3, UI_UNIT_Y, NULL,
376                                       0.0f, 0.0f, 0.0f, 0.0f, "Show more items of this menu");
377         UI_but_funcN_set(but, ui_pie_menu_level_invoke, remaining, &lvl);
378 }
379
380 /** \} */ /* Pie Menu Levels */