use bool for rna funcs.
[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_mesh_types.h"
38
39 #include "MEM_guardedalloc.h"
40
41 #include "BLI_math.h"
42 #include "BLI_blenlib.h"
43 #include "BLI_utildefines.h"
44
45 #include "BLF_translation.h"
46
47 #include "BKE_context.h"
48 #include "BKE_depsgraph.h"
49 #include "BKE_effect.h"
50 #include "BKE_main.h"
51 #include "BKE_mesh.h"
52 #include "BKE_modifier.h"
53 #include "BKE_paint.h"
54 #include "BKE_screen.h"
55 #include "BKE_tessmesh.h"
56
57 #include "RNA_access.h"
58 #include "RNA_define.h"
59 #include "RNA_enum_types.h"
60
61 #include "WM_api.h"
62 #include "WM_types.h"
63
64 #include "ED_mesh.h"
65 #include "ED_util.h"
66 #include "ED_screen.h"
67 #include "ED_transform.h"
68 #include "ED_types.h"
69
70 #include "UI_interface.h"
71 #include "UI_resources.h"
72
73 #include "view3d_intern.h"
74
75
76 /* View3d->modeselect 
77  * This is a bit of a dodgy hack to enable a 'mode' menu with icons+labels
78  * rather than those buttons.
79  * I know the implementation's not good - it's an experiment to see if this
80  * approach would work well
81  *
82  * This can be cleaned when I make some new 'mode' icons.
83  */
84
85 /* end XXX ************* */
86
87 static void do_view3d_header_buttons(bContext *C, void *arg, int event);
88
89 #define B_MODESELECT 108
90 #define B_SEL_VERT  110
91 #define B_SEL_EDGE  111
92 #define B_SEL_FACE  112
93 #define B_MAN_TRANS 116
94 #define B_MAN_ROT   117
95 #define B_MAN_SCALE 118
96 #define B_MAN_MODE  120
97
98 /* XXX quickly ported across */
99 static void handle_view3d_lock(bContext *C)
100 {
101         Main *bmain = CTX_data_main(C);
102         Scene *scene = CTX_data_scene(C);
103         ScrArea *sa = CTX_wm_area(C);
104         View3D *v3d = CTX_wm_view3d(C);
105         
106         if (v3d != NULL && sa != NULL) {
107                 if (v3d->localvd == NULL && v3d->scenelock && sa->spacetype == SPACE_VIEW3D) {
108                         /* copy to scene */
109                         scene->lay = v3d->lay;
110                         scene->layact = v3d->layact;
111                         scene->camera = v3d->camera;
112
113                         /* not through notifier, listener don't have context
114                          * and non-open screens or spaces need to be updated too */
115                         BKE_screen_view3d_main_sync(&bmain->screen, scene);
116                         
117                         /* notifiers for scene update */
118                         WM_event_add_notifier(C, NC_SCENE | ND_LAYER, scene);
119                 }
120         }
121 }
122
123 /**
124  * layer code is on three levels actually:
125  * - here for operator
126  * - uiTemplateLayers in interface/ code for buttons
127  * - ED_view3d_scene_layer_set for RNA
128  */
129 static void view3d_layers_editmode_ensure(Scene *scene, View3D *v3d)
130 {
131         /* sanity check - when in editmode disallow switching the editmode layer off since its confusing
132          * an alternative would be to always draw the editmode object. */
133         if (scene->obedit && (scene->obedit->lay & v3d->lay) == 0) {
134                 int bit;
135                 for (bit = 0; bit < 32; bit++) {
136                         if (scene->obedit->lay & (1 << bit)) {
137                                 v3d->lay |= 1 << bit;
138                                 break;
139                         }
140                 }
141         }
142 }
143
144 static int view3d_layers_exec(bContext *C, wmOperator *op)
145 {
146         Scene *scene = CTX_data_scene(C);
147         ScrArea *sa = CTX_wm_area(C);
148         View3D *v3d = sa->spacedata.first;
149         int nr = RNA_int_get(op->ptr, "nr");
150         int toggle = RNA_boolean_get(op->ptr, "toggle");
151         
152         if (nr < 0)
153                 return OPERATOR_CANCELLED;
154
155         if (nr == 0) {
156                 /* all layers */
157                 if (!v3d->layact)
158                         v3d->layact = 1;
159
160                 if (toggle && v3d->lay == ((1 << 20) - 1)) {
161                         /* return to active layer only */
162                         v3d->lay = v3d->layact;
163
164                         view3d_layers_editmode_ensure(scene, v3d);
165                 }
166                 else {
167                         v3d->lay |= (1 << 20) - 1;
168                 }
169         }
170         else {
171                 int bit;
172                 nr--;
173
174                 if (RNA_boolean_get(op->ptr, "extend")) {
175                         if (toggle && v3d->lay & (1 << nr) && (v3d->lay & ~(1 << nr)))
176                                 v3d->lay &= ~(1 << nr);
177                         else
178                                 v3d->lay |= (1 << nr);
179                 }
180                 else {
181                         v3d->lay = (1 << nr);
182                 }
183
184                 view3d_layers_editmode_ensure(scene, v3d);
185
186                 /* set active layer, ensure to always have one */
187                 if (v3d->lay & (1 << nr))
188                         v3d->layact = 1 << nr;
189                 else if ((v3d->lay & v3d->layact) == 0) {
190                         for (bit = 0; bit < 32; bit++) {
191                                 if (v3d->lay & (1 << bit)) {
192                                         v3d->layact = 1 << bit;
193                                         break;
194                                 }
195                         }
196                 }
197         }
198         
199         if (v3d->scenelock) handle_view3d_lock(C);
200         
201         DAG_on_visible_update(CTX_data_main(C), FALSE);
202
203         ED_area_tag_redraw(sa);
204         
205         return OPERATOR_FINISHED;
206 }
207
208 /* applies shift and alt, lazy coding or ok? :) */
209 /* the local per-keymap-entry keymap will solve it */
210 static int view3d_layers_invoke(bContext *C, wmOperator *op, wmEvent *event)
211 {
212         if (event->ctrl || event->oskey)
213                 return OPERATOR_PASS_THROUGH;
214         
215         if (event->shift)
216                 RNA_boolean_set(op->ptr, "extend", TRUE);
217         else
218                 RNA_boolean_set(op->ptr, "extend", FALSE);
219         
220         if (event->alt) {
221                 int nr = RNA_int_get(op->ptr, "nr") + 10;
222                 RNA_int_set(op->ptr, "nr", nr);
223         }
224         view3d_layers_exec(C, op);
225         
226         return OPERATOR_FINISHED;
227 }
228
229 static int view3d_layers_poll(bContext *C)
230 {
231         return (ED_operator_view3d_active(C) && CTX_wm_view3d(C)->localvd == NULL);
232 }
233
234 void VIEW3D_OT_layers(wmOperatorType *ot)
235 {
236         /* identifiers */
237         ot->name = "Layers";
238         ot->description = "Toggle layer(s) visibility";
239         ot->idname = "VIEW3D_OT_layers";
240         
241         /* api callbacks */
242         ot->invoke = view3d_layers_invoke;
243         ot->exec = view3d_layers_exec;
244         ot->poll = view3d_layers_poll;
245         
246         /* flags */
247         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
248         
249         RNA_def_int(ot->srna, "nr", 1, 0, 20, "Number", "The layer number to set, zero for all layers", 0, 20);
250         RNA_def_boolean(ot->srna, "extend", 0, "Extend", "Add this layer to the current view layers");
251         RNA_def_boolean(ot->srna, "toggle", 1, "Toggle", "Toggle the layer");
252 }
253
254 static int modeselect_addmode(char *str, const char *title, int id, int icon)
255 {
256         static char formatstr[] = "|%s %%x%d %%i%d";
257
258         return sprintf(str, formatstr, IFACE_(title), id, icon);
259 }
260
261 static char *view3d_modeselect_pup(Scene *scene)
262 {
263         Object *ob = OBACT;
264         static char string[512];
265         const char *title = IFACE_("Mode: %t");
266         char *str = string;
267
268         BLI_strncpy(str, title, sizeof(string));
269
270         str += modeselect_addmode(str, N_("Object Mode"), OB_MODE_OBJECT, ICON_OBJECT_DATA);
271
272         if (ob == NULL || ob->data == NULL) return string;
273         if (ob->id.lib) return string;
274
275         if (!((ID *)ob->data)->lib) {
276                 /* if active object is editable */
277                 if (ob->type == OB_ARMATURE) {
278                         if (ob->mode & OB_MODE_POSE)
279                                 str += modeselect_addmode(str, N_("Edit Mode"), OB_MODE_EDIT | OB_MODE_POSE, ICON_EDITMODE_HLT);
280                         else
281                                 str += modeselect_addmode(str, N_("Edit Mode"), OB_MODE_EDIT, ICON_EDITMODE_HLT);
282                 }
283                 else if (OB_TYPE_SUPPORT_EDITMODE(ob->type)) {
284                         str += modeselect_addmode(str, N_("Edit Mode"), OB_MODE_EDIT, ICON_EDITMODE_HLT);
285                 }
286
287                 if (ob->type == OB_MESH) {
288
289                         str += modeselect_addmode(str, N_("Sculpt Mode"), OB_MODE_SCULPT, ICON_SCULPTMODE_HLT);
290                         str += modeselect_addmode(str, N_("Vertex Paint"), OB_MODE_VERTEX_PAINT, ICON_VPAINT_HLT);
291                         str += modeselect_addmode(str, N_("Texture Paint"), OB_MODE_TEXTURE_PAINT, ICON_TPAINT_HLT);
292                         str += modeselect_addmode(str, N_("Weight Paint"), OB_MODE_WEIGHT_PAINT, ICON_WPAINT_HLT);
293                 }
294         }
295
296         /* if active object is an armature */
297         if (ob->type == OB_ARMATURE) {
298                 str += modeselect_addmode(str, N_("Pose Mode"), OB_MODE_POSE, ICON_POSE_HLT);
299         }
300
301         if (ob->particlesystem.first ||
302             modifiers_findByType(ob, eModifierType_Cloth) ||
303             modifiers_findByType(ob, eModifierType_Softbody))
304         {
305                 str += modeselect_addmode(str, N_("Particle Mode"), OB_MODE_PARTICLE_EDIT, ICON_PARTICLEMODE);
306         }
307         (void)str;
308         return (string);
309 }
310
311 static void do_view3d_header_buttons(bContext *C, void *UNUSED(arg), int event)
312 {
313         wmWindow *win = CTX_wm_window(C);
314         ScrArea *sa = CTX_wm_area(C);
315         View3D *v3d = sa->spacedata.first;
316         const int ctrl = win->eventstate->ctrl, shift = win->eventstate->shift;
317         PointerRNA props_ptr;
318
319         /* watch it: if sa->win does not exist, check that when calling direct drawing routines */
320
321         switch (event) {
322                 case B_MODESELECT:
323                         WM_operator_properties_create(&props_ptr, "OBJECT_OT_mode_set");
324                         RNA_enum_set(&props_ptr, "mode", v3d->modeselect);
325                         WM_operator_name_call(C, "OBJECT_OT_mode_set", WM_OP_EXEC_REGION_WIN, &props_ptr);
326                         WM_operator_properties_free(&props_ptr);
327                         break;
328
329                 case B_SEL_VERT:
330                         if (EDBM_selectmode_toggle(C, SCE_SELECT_VERTEX, -1, shift, ctrl)) {
331                                 ED_undo_push(C, "Selectmode Set: Vertex");
332                         }
333                         break;
334                 case B_SEL_EDGE:
335                         if (EDBM_selectmode_toggle(C, SCE_SELECT_EDGE, -1, shift, ctrl)) {
336                                 ED_undo_push(C, "Selectmode Set: Edge");
337                         }
338                         break;
339                 case B_SEL_FACE:
340                         if (EDBM_selectmode_toggle(C, SCE_SELECT_FACE, -1, shift, ctrl)) {
341                                 ED_undo_push(C, "Selectmode Set: Face");
342                         }
343                         break;
344
345                 case B_MAN_TRANS:
346                         if (shift == 0 || v3d->twtype == 0) {
347                                 v3d->twtype = V3D_MANIP_TRANSLATE;
348                         }
349                         ED_area_tag_redraw(sa);
350                         break;
351                 case B_MAN_ROT:
352                         if (shift == 0 || v3d->twtype == 0) {
353                                 v3d->twtype = V3D_MANIP_ROTATE;
354                         }
355                         ED_area_tag_redraw(sa);
356                         break;
357                 case B_MAN_SCALE:
358                         if (shift == 0 || v3d->twtype == 0) {
359                                 v3d->twtype = V3D_MANIP_SCALE;
360                         }
361                         ED_area_tag_redraw(sa);
362                         break;
363                 case B_MAN_MODE:
364                         ED_area_tag_redraw(sa);
365                         break;
366                 default:
367                         break;
368         }
369 }
370
371 /* Returns the icon associated with an object mode */
372 static int object_mode_icon(int mode)
373 {
374         EnumPropertyItem *item = object_mode_items;
375         
376         while (item->name != NULL) {
377                 if (item->value == mode) {
378                         return item->icon;
379                 }
380                 item++;
381         }
382
383         return ICON_OBJECT_DATAMODE;
384 }
385
386 void uiTemplateEditModeSelection(uiLayout *layout, struct bContext *C)
387 {
388         Object *obedit = CTX_data_edit_object(C);
389         uiBlock *block = uiLayoutGetBlock(layout);
390
391         uiBlockSetHandleFunc(block, do_view3d_header_buttons, NULL);
392
393         if (obedit && (obedit->type == OB_MESH)) {
394                 BMEditMesh *em = BMEdit_FromObject(obedit);
395                 uiLayout *row;
396
397                 row = uiLayoutRow(layout, TRUE);
398                 block = uiLayoutGetBlock(row);
399                 uiDefIconButBitS(block, TOG, SCE_SELECT_VERTEX, B_SEL_VERT, ICON_VERTEXSEL,
400                                  0, 0, UI_UNIT_X, UI_UNIT_Y, &em->selectmode, 1.0, 0.0, 0, 0,
401                                  TIP_("Vertex select - Shift-Click for multiple modes"));
402                 uiDefIconButBitS(block, TOG, SCE_SELECT_EDGE, B_SEL_EDGE, ICON_EDGESEL,
403                                  0, 0, UI_UNIT_X, UI_UNIT_Y, &em->selectmode, 1.0, 0.0, 0, 0,
404                                  TIP_("Edge select - Shift-Click for multiple modes, Ctrl-Click expands selection"));
405                 uiDefIconButBitS(block, TOG, SCE_SELECT_FACE, B_SEL_FACE, ICON_FACESEL,
406                                  0, 0, UI_UNIT_X, UI_UNIT_Y, &em->selectmode, 1.0, 0.0, 0, 0,
407                                  TIP_("Face select - Shift-Click for multiple modes, Ctrl-Click expands selection"));
408         }
409 }
410
411 void uiTemplateHeader3D(uiLayout *layout, struct bContext *C)
412 {
413         bScreen *screen = CTX_wm_screen(C);
414         ScrArea *sa = CTX_wm_area(C);
415         View3D *v3d = sa->spacedata.first;
416         Scene *scene = CTX_data_scene(C);
417         ToolSettings *ts = CTX_data_tool_settings(C);
418         PointerRNA v3dptr, toolsptr, sceneptr;
419         Object *ob = OBACT;
420         Object *obedit = CTX_data_edit_object(C);
421         uiBlock *block;
422         uiBut *but;
423         uiLayout *row;
424         const float dpi_fac = UI_DPI_FAC;
425         int is_paint = 0;
426         
427         RNA_pointer_create(&screen->id, &RNA_SpaceView3D, v3d, &v3dptr);
428         RNA_pointer_create(&scene->id, &RNA_ToolSettings, ts, &toolsptr);
429         RNA_pointer_create(&scene->id, &RNA_Scene, scene, &sceneptr);
430
431         block = uiLayoutGetBlock(layout);
432         uiBlockSetHandleFunc(block, do_view3d_header_buttons, NULL);
433
434         /* other buttons: */
435         uiBlockSetEmboss(block, UI_EMBOSS);
436         
437         /* mode */
438         if (ob) {
439                 v3d->modeselect = ob->mode;
440                 is_paint = ELEM4(ob->mode, OB_MODE_SCULPT, OB_MODE_VERTEX_PAINT, OB_MODE_WEIGHT_PAINT, OB_MODE_TEXTURE_PAINT);
441         }
442         else {
443                 v3d->modeselect = OB_MODE_OBJECT;
444         }
445
446         row = uiLayoutRow(layout, TRUE);
447         uiDefIconTextButS(block, MENU, B_MODESELECT, object_mode_icon(v3d->modeselect), view3d_modeselect_pup(scene),
448                           0, 0, 126 * dpi_fac, UI_UNIT_Y, &(v3d->modeselect), 0, 0, 0, 0, TIP_("Mode"));
449         
450         /* Draw type */
451         uiItemR(layout, &v3dptr, "viewport_shade", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
452
453         if (obedit == NULL && is_paint) {
454
455                 if (ob->mode & OB_MODE_WEIGHT_PAINT) {
456                         /* Only for Weight Paint. makes no sense in other paint modes. */
457                         row = uiLayoutRow(layout, TRUE);
458                         uiItemR(row, &v3dptr, "pivot_point", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
459                 }
460
461                 /* Manipulators aren't used in paint modes */
462                 if (!ELEM(ob->mode, OB_MODE_SCULPT, OB_MODE_PARTICLE_EDIT)) {
463                         /* masks aren't used for sculpt and particle painting */
464                         PointerRNA meshptr;
465
466                         RNA_pointer_create(&ob->id, &RNA_Mesh, ob->data, &meshptr);
467                         if (ob->mode & (OB_MODE_TEXTURE_PAINT | OB_MODE_VERTEX_PAINT)) {
468                                 uiItemR(layout, &meshptr, "use_paint_mask", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
469                         }
470                         else {
471                                 row = uiLayoutRow(layout, TRUE);
472                                 uiItemR(row, &meshptr, "use_paint_mask", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
473                                 uiItemR(row, &meshptr, "use_paint_mask_vertex", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
474                         }
475                 }
476         }
477         else {
478                 const char *str_menu;
479
480                 row = uiLayoutRow(layout, TRUE);
481                 uiItemR(row, &v3dptr, "pivot_point", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
482
483                 /* pose/object only however we want to allow in weight paint mode too
484                  * so don't be totally strict and just check not-editmode for now 
485                  * XXX We never get here when we are in Weight Paint mode
486                  */
487                 if (obedit == NULL) {
488                         uiItemR(row, &v3dptr, "use_pivot_point_align", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
489                 }
490
491                 /* Transform widget / manipulators */
492                 row = uiLayoutRow(layout, TRUE);
493                 uiItemR(row, &v3dptr, "show_manipulator", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
494                 block = uiLayoutGetBlock(row);
495                 
496                 if (v3d->twflag & V3D_USE_MANIPULATOR) {
497                         but = uiDefIconButBitC(block, TOG, V3D_MANIP_TRANSLATE, B_MAN_TRANS, ICON_MAN_TRANS,
498                                                0, 0, UI_UNIT_X, UI_UNIT_Y, &v3d->twtype, 1.0, 0.0, 0, 0,
499                                                TIP_("Translate manipulator - Shift-Click for multiple modes"));
500                         uiButClearFlag(but, UI_BUT_UNDO); /* skip undo on screen buttons */
501                         but = uiDefIconButBitC(block, TOG, V3D_MANIP_ROTATE, B_MAN_ROT, ICON_MAN_ROT,
502                                                0, 0, UI_UNIT_X, UI_UNIT_Y, &v3d->twtype, 1.0, 0.0, 0, 0,
503                                                TIP_("Rotate manipulator - Shift-Click for multiple modes"));
504                         uiButClearFlag(but, UI_BUT_UNDO); /* skip undo on screen buttons */
505                         but = uiDefIconButBitC(block, TOG, V3D_MANIP_SCALE, B_MAN_SCALE, ICON_MAN_SCALE,
506                                                0, 0, UI_UNIT_X, UI_UNIT_Y, &v3d->twtype, 1.0, 0.0, 0, 0,
507                                                TIP_("Scale manipulator - Shift-Click for multiple modes"));
508                         uiButClearFlag(but, UI_BUT_UNDO); /* skip undo on screen buttons */
509                 }
510                         
511                 if (v3d->twmode > (BIF_countTransformOrientation(C) - 1) + V3D_MANIP_CUSTOM) {
512                         v3d->twmode = 0;
513                 }
514                         
515                 str_menu = BIF_menustringTransformOrientation(C, "Orientation");
516                 but = uiDefButC(block, MENU, B_MAN_MODE, str_menu, 0, 0, 70 * dpi_fac, UI_UNIT_Y, &v3d->twmode, 0, 0, 0, 0,
517                                 TIP_("Transform Orientation"));
518                 uiButClearFlag(but, UI_BUT_UNDO); /* skip undo on screen buttons */
519                 MEM_freeN((void *)str_menu);
520         }
521
522         if (obedit == NULL && v3d->localvd == NULL) {
523                 unsigned int ob_lay = ob ? ob->lay : 0;
524
525                 /* Layers */
526                 uiTemplateLayers(layout, v3d->scenelock ? &sceneptr : &v3dptr, "layers", &v3dptr, "layers_used", ob_lay);
527
528                 /* Scene lock */
529                 uiItemR(layout, &v3dptr, "lock_camera_and_layers", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
530         }
531         
532         uiTemplateEditModeSelection(layout, C);
533 }