WM: refactor gestures for use as tools
[blender.git] / source / blender / editors / space_view3d / view3d_header.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) 2004-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/space_view3d/view3d_header.c
28  *  \ingroup spview3d
29  */
30
31 #include <string.h>
32 #include <stdio.h>
33 #include <stdlib.h>
34
35 #include "DNA_scene_types.h"
36 #include "DNA_object_types.h"
37 #include "DNA_gpencil_types.h"
38
39 #include "BLI_utildefines.h"
40
41 #include "BLT_translation.h"
42
43 #include "BKE_context.h"
44 #include "BKE_depsgraph.h"
45 #include "BKE_main.h"
46 #include "BKE_screen.h"
47 #include "BKE_editmesh.h"
48
49 #include "RNA_access.h"
50 #include "RNA_define.h"
51 #include "RNA_enum_types.h"
52
53 #include "WM_api.h"
54 #include "WM_types.h"
55
56 #include "ED_mesh.h"
57 #include "ED_util.h"
58 #include "ED_screen.h"
59
60 #include "UI_interface.h"
61 #include "UI_resources.h"
62
63 #include "view3d_intern.h"
64
65 static void do_view3d_header_buttons(bContext *C, void *arg, int event);
66
67 #define B_SEL_VERT  110
68 #define B_SEL_EDGE  111
69 #define B_SEL_FACE  112
70
71 /* XXX quickly ported across */
72 static void handle_view3d_lock(bContext *C)
73 {
74         Main *bmain = CTX_data_main(C);
75         Scene *scene = CTX_data_scene(C);
76         ScrArea *sa = CTX_wm_area(C);
77         View3D *v3d = CTX_wm_view3d(C);
78         
79         if (v3d != NULL && sa != NULL) {
80                 if (v3d->localvd == NULL && v3d->scenelock && sa->spacetype == SPACE_VIEW3D) {
81                         /* copy to scene */
82                         scene->lay = v3d->lay;
83                         scene->layact = v3d->layact;
84                         scene->camera = v3d->camera;
85
86                         /* not through notifier, listener don't have context
87                          * and non-open screens or spaces need to be updated too */
88                         BKE_screen_view3d_main_sync(&bmain->screen, scene);
89                         
90                         /* notifiers for scene update */
91                         WM_event_add_notifier(C, NC_SCENE | ND_LAYER, scene);
92                 }
93         }
94 }
95
96 /**
97  * layer code is on three levels actually:
98  * - here for operator
99  * - uiTemplateLayers in interface/ code for buttons
100  * - ED_view3d_scene_layer_set for RNA
101  */
102 static void view3d_layers_editmode_ensure(Scene *scene, View3D *v3d)
103 {
104         /* sanity check - when in editmode disallow switching the editmode layer off since its confusing
105          * an alternative would be to always draw the editmode object. */
106         if (scene->obedit && (scene->obedit->lay & v3d->lay) == 0) {
107                 int bit;
108                 for (bit = 0; bit < 32; bit++) {
109                         if (scene->obedit->lay & (1u << bit)) {
110                                 v3d->lay |= (1u << bit);
111                                 break;
112                         }
113                 }
114         }
115 }
116
117 static int view3d_layers_exec(bContext *C, wmOperator *op)
118 {
119         Scene *scene = CTX_data_scene(C);
120         ScrArea *sa = CTX_wm_area(C);
121         View3D *v3d = sa->spacedata.first;
122         int nr = RNA_int_get(op->ptr, "nr");
123         const bool toggle = RNA_boolean_get(op->ptr, "toggle");
124         
125         if (nr < 0)
126                 return OPERATOR_CANCELLED;
127
128         if (nr == 0) {
129                 /* all layers */
130                 if (!v3d->lay_prev)
131                         v3d->lay_prev = 1;
132
133                 if (toggle && v3d->lay == ((1 << 20) - 1)) {
134                         /* return to active layer only */
135                         v3d->lay = v3d->lay_prev;
136
137                         view3d_layers_editmode_ensure(scene, v3d);
138                 }
139                 else {
140                         v3d->lay_prev = v3d->lay;
141                         v3d->lay |= (1 << 20) - 1;
142                 }
143         }
144         else {
145                 int bit;
146                 nr--;
147
148                 if (RNA_boolean_get(op->ptr, "extend")) {
149                         if (toggle && v3d->lay & (1 << nr) && (v3d->lay & ~(1 << nr)))
150                                 v3d->lay &= ~(1 << nr);
151                         else
152                                 v3d->lay |= (1 << nr);
153                 }
154                 else {
155                         v3d->lay = (1 << nr);
156                 }
157
158                 view3d_layers_editmode_ensure(scene, v3d);
159
160                 /* set active layer, ensure to always have one */
161                 if (v3d->lay & (1 << nr))
162                         v3d->layact = 1 << nr;
163                 else if ((v3d->lay & v3d->layact) == 0) {
164                         for (bit = 0; bit < 32; bit++) {
165                                 if (v3d->lay & (1u << bit)) {
166                                         v3d->layact = (1u << bit);
167                                         break;
168                                 }
169                         }
170                 }
171         }
172         
173         if (v3d->scenelock) handle_view3d_lock(C);
174         
175         DAG_on_visible_update(CTX_data_main(C), false);
176
177         ED_area_tag_redraw(sa);
178         
179         return OPERATOR_FINISHED;
180 }
181
182 /* applies shift and alt, lazy coding or ok? :) */
183 /* the local per-keymap-entry keymap will solve it */
184 static int view3d_layers_invoke(bContext *C, wmOperator *op, const wmEvent *event)
185 {
186         if (event->ctrl || event->oskey)
187                 return OPERATOR_PASS_THROUGH;
188         
189         if (event->shift)
190                 RNA_boolean_set(op->ptr, "extend", true);
191         else
192                 RNA_boolean_set(op->ptr, "extend", false);
193         
194         if (event->alt) {
195                 const int nr = RNA_int_get(op->ptr, "nr") + 10;
196                 RNA_int_set(op->ptr, "nr", nr);
197         }
198         view3d_layers_exec(C, op);
199         
200         return OPERATOR_FINISHED;
201 }
202
203 static int view3d_layers_poll(bContext *C)
204 {
205         return (ED_operator_view3d_active(C) && CTX_wm_view3d(C)->localvd == NULL);
206 }
207
208 void VIEW3D_OT_layers(wmOperatorType *ot)
209 {
210         /* identifiers */
211         ot->name = "Layers";
212         ot->description = "Toggle layer(s) visibility";
213         ot->idname = "VIEW3D_OT_layers";
214         
215         /* api callbacks */
216         ot->invoke = view3d_layers_invoke;
217         ot->exec = view3d_layers_exec;
218         ot->poll = view3d_layers_poll;
219         
220         /* flags */
221         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
222         
223         RNA_def_int(ot->srna, "nr", 1, 0, 20, "Number", "The layer number to set, zero for all layers", 0, 20);
224         RNA_def_boolean(ot->srna, "extend", 0, "Extend", "Add this layer to the current view layers");
225         RNA_def_boolean(ot->srna, "toggle", 1, "Toggle", "Toggle the layer");
226 }
227
228 static void do_view3d_header_buttons(bContext *C, void *UNUSED(arg), int event)
229 {
230         wmWindow *win = CTX_wm_window(C);
231         const int ctrl = win->eventstate->ctrl, shift = win->eventstate->shift;
232
233         /* watch it: if sa->win does not exist, check that when calling direct drawing routines */
234
235         switch (event) {
236                 case B_SEL_VERT:
237                         if (EDBM_selectmode_toggle(C, SCE_SELECT_VERTEX, -1, shift, ctrl)) {
238                                 ED_undo_push(C, "Selectmode Set: Vertex");
239                         }
240                         break;
241                 case B_SEL_EDGE:
242                         if (EDBM_selectmode_toggle(C, SCE_SELECT_EDGE, -1, shift, ctrl)) {
243                                 ED_undo_push(C, "Selectmode Set: Edge");
244                         }
245                         break;
246                 case B_SEL_FACE:
247                         if (EDBM_selectmode_toggle(C, SCE_SELECT_FACE, -1, shift, ctrl)) {
248                                 ED_undo_push(C, "Selectmode Set: Face");
249                         }
250                         break;
251                 default:
252                         break;
253         }
254 }
255
256 void uiTemplateEditModeSelection(uiLayout *layout, struct bContext *C)
257 {
258         Object *obedit = CTX_data_edit_object(C);
259         uiBlock *block = uiLayoutGetBlock(layout);
260
261         UI_block_func_handle_set(block, do_view3d_header_buttons, NULL);
262
263         if (obedit && (obedit->type == OB_MESH)) {
264                 BMEditMesh *em = BKE_editmesh_from_object(obedit);
265                 uiLayout *row;
266
267                 row = uiLayoutRow(layout, true);
268                 block = uiLayoutGetBlock(row);
269                 uiDefIconButBitS(block, UI_BTYPE_TOGGLE, SCE_SELECT_VERTEX, B_SEL_VERT, ICON_VERTEXSEL,
270                                  0, 0, UI_UNIT_X, UI_UNIT_Y, &em->selectmode, 1.0, 0.0, 0, 0,
271                                  TIP_("Vertex select - Shift-Click for multiple modes, Ctrl-Click contracts selection"));
272                 uiDefIconButBitS(block, UI_BTYPE_TOGGLE, SCE_SELECT_EDGE, B_SEL_EDGE, ICON_EDGESEL,
273                                  0, 0, UI_UNIT_X, UI_UNIT_Y, &em->selectmode, 1.0, 0.0, 0, 0,
274                                  TIP_("Edge select - Shift-Click for multiple modes, Ctrl-Click expands/contracts selection"));
275                 uiDefIconButBitS(block, UI_BTYPE_TOGGLE, SCE_SELECT_FACE, B_SEL_FACE, ICON_FACESEL,
276                                  0, 0, UI_UNIT_X, UI_UNIT_Y, &em->selectmode, 1.0, 0.0, 0, 0,
277                                  TIP_("Face select - Shift-Click for multiple modes, Ctrl-Click expands selection"));
278         }
279 }
280
281 void uiTemplateHeader3D(uiLayout *layout, struct bContext *C)
282 {
283         bScreen *screen = CTX_wm_screen(C);
284         ScrArea *sa = CTX_wm_area(C);
285         View3D *v3d = sa->spacedata.first;
286         Scene *scene = CTX_data_scene(C);
287         ToolSettings *ts = CTX_data_tool_settings(C);
288         PointerRNA v3dptr, toolsptr, sceneptr;
289         Object *ob = OBACT;
290         Object *obedit = CTX_data_edit_object(C);
291         bGPdata *gpd = CTX_data_gpencil_data(C);
292         uiBlock *block;
293         uiLayout *row;
294         bool is_paint = false;
295         int modeselect;
296         
297         RNA_pointer_create(&screen->id, &RNA_SpaceView3D, v3d, &v3dptr);
298         RNA_pointer_create(&scene->id, &RNA_ToolSettings, ts, &toolsptr);
299         RNA_pointer_create(&scene->id, &RNA_Scene, scene, &sceneptr);
300
301         block = uiLayoutGetBlock(layout);
302         UI_block_func_handle_set(block, do_view3d_header_buttons, NULL);
303
304         /* other buttons: */
305         UI_block_emboss_set(block, UI_EMBOSS);
306         
307         /* mode */
308         if ((gpd) && (gpd->flag & GP_DATA_STROKE_EDITMODE)) {
309                 modeselect = OB_MODE_GPENCIL;
310         }
311         else if (ob) {
312                 modeselect = ob->mode;
313                 is_paint = ELEM(ob->mode, OB_MODE_SCULPT, OB_MODE_VERTEX_PAINT, OB_MODE_WEIGHT_PAINT, OB_MODE_TEXTURE_PAINT);
314         }
315         else {
316                 modeselect = OB_MODE_OBJECT;
317         }
318
319         row = uiLayoutRow(layout, false);
320         {
321                 EnumPropertyItem *item = rna_enum_object_mode_items;
322                 const char *name = "";
323                 int icon = ICON_OBJECT_DATAMODE;
324
325                 while (item->identifier) {
326                         if (item->value == modeselect && item->identifier[0]) {
327                                 name = IFACE_(item->name);
328                                 icon = item->icon;
329                                 break;
330                         }
331                         item++;
332                 }
333
334                 uiItemMenuEnumO(row, C, "OBJECT_OT_mode_set", "mode", name, icon);
335         }
336
337         /* Draw type */
338         uiItemR(layout, &v3dptr, "viewport_shade", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
339
340         row = uiLayoutRow(layout, true);
341         uiItemR(row, &v3dptr, "pivot_point", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
342         if (!ob || ELEM(ob->mode, OB_MODE_OBJECT, OB_MODE_POSE, OB_MODE_WEIGHT_PAINT)) {
343                 uiItemR(row, &v3dptr, "use_pivot_point_align", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
344         }
345
346         if (obedit == NULL && is_paint) {
347                 /* Manipulators aren't used in paint modes */
348                 if (!ELEM(ob->mode, OB_MODE_SCULPT, OB_MODE_PARTICLE_EDIT)) {
349                         /* masks aren't used for sculpt and particle painting */
350                         PointerRNA meshptr;
351
352                         RNA_pointer_create(ob->data, &RNA_Mesh, ob->data, &meshptr);
353                         if (ob->mode & (OB_MODE_TEXTURE_PAINT)) {
354                                 uiItemR(layout, &meshptr, "use_paint_mask", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
355                         }
356                         else {
357                                 row = uiLayoutRow(layout, true);
358                                 uiItemR(row, &meshptr, "use_paint_mask", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
359                                 uiItemR(row, &meshptr, "use_paint_mask_vertex", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
360                         }
361                 }
362         }
363         else {
364                 /* Transform widget / manipulators */
365                 row = uiLayoutRow(layout, true);
366                 uiItemR(row, &v3dptr, "show_manipulator", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
367                 if (v3d->twflag & V3D_USE_MANIPULATOR) {
368                         uiItemR(row, &v3dptr, "transform_manipulators", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
369                 }
370                 uiItemR(row, &v3dptr, "transform_orientation", 0, "", ICON_NONE);
371         }
372
373         if (obedit == NULL && v3d->localvd == NULL) {
374                 unsigned int ob_lay = ob ? ob->lay : 0;
375
376                 /* Layers */
377                 uiTemplateLayers(layout, v3d->scenelock ? &sceneptr : &v3dptr, "layers", &v3dptr, "layers_used", ob_lay);
378
379                 /* Scene lock */
380                 uiItemR(layout, &v3dptr, "lock_camera_and_layers", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
381         }
382         
383         uiTemplateEditModeSelection(layout, C);
384 }