2.5
[blender.git] / source / blender / editors / interface / view2d_ops.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2008 Blender Foundation.
21  * All rights reserved.
22  * 
23  * Contributor(s): Blender Foundation, Joshua Leung
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #include <math.h>
29
30 #include "MEM_guardedalloc.h"
31
32 #include "DNA_scene_types.h"
33 #include "DNA_screen_types.h"
34 #include "DNA_space_types.h"
35 #include "DNA_view2d_types.h"
36
37 #include "BLI_blenlib.h"
38
39 #include "BKE_global.h"
40 #include "BKE_utildefines.h"
41
42 #include "RNA_access.h"
43 #include "RNA_define.h"
44
45 #include "WM_api.h"
46 #include "WM_types.h"
47
48 #include "BIF_gl.h"
49
50 #include "UI_resources.h"
51 #include "UI_view2d.h"
52
53 /* ********************************************************* */
54 /* General Polling Funcs */
55
56 /* Check if mouse is within scrollbars 
57  *      - Returns true or false (1 or 0)
58  *      
59  *      - x,y   = mouse coordinates in screen (not region) space
60  */
61 static short mouse_in_v2d_scrollers (const bContext *C, View2D *v2d, int x, int y)
62 {
63         ARegion *ar= C->region;
64         int co[2];
65         
66         /* clamp x,y to region-coordinates first */
67         // FIXME: is this needed?
68         co[0]= x - ar->winrct.xmin;
69         co[1]= y - ar->winrct.ymin;
70         
71         /* check if within scrollbars */
72         if (v2d->scroll & (HOR_SCROLL|HOR_SCROLLO)) {
73                 if (IN_2D_HORIZ_SCROLL(v2d, co)) return 1;
74         }
75         if (v2d->scroll & VERT_SCROLL) {
76                 if (IN_2D_VERT_SCROLL(v2d, co)) return 1;
77         }       
78         
79         /* not found */
80         return 0;
81
82
83
84 /* ********************************************************* */
85 /* VIEW PANNING OPERATOR                                                                 */
86
87 /*      This group of operators come in several forms:
88  *              1) Modal 'dragging' with MMB - where movement of mouse dictates amount to pan view by
89  *              2) Scrollwheel 'steps' - rolling mousewheel by one step moves view by predefined amount
90  *
91  *      In order to make sure this works, each operator must define the following RNA-Operator Props:
92  *              deltax, deltay  - define how much to move view by (relative to zoom-correction factor)
93  */
94
95 /* ------------------ Shared 'core' stuff ---------------------- */
96  
97 /* temp customdata for operator */
98 typedef struct v2dViewPanData {
99         ARegion *region;                /* region we're operating in */
100         View2D *v2d;                    /* view2d we're operating in */
101         
102         float facx, facy;               /* amount to move view relative to zoom */
103         
104                 /* options for version 1 */
105         int startx, starty;             /* mouse x/y values in window when operator was initiated */
106         int lastx, lasty;               /* previous x/y values of mouse in window */
107         
108         short in_scroller;              /* activated in scrollbar */
109 } v2dViewPanData;
110  
111 /* initialise panning customdata */
112 static int view_pan_init(bContext *C, wmOperator *op)
113 {
114         v2dViewPanData *vpd;
115         ARegion *ar;
116         View2D *v2d;
117         float winx, winy;
118         
119         /* regions now have v2d-data by default, so check for region */
120         if (C->region == NULL)
121                 return 0;
122         
123         /* set custom-data for operator */
124         vpd= MEM_callocN(sizeof(v2dViewPanData), "v2dViewPanData");
125         op->customdata= vpd;
126         
127         /* set pointers to owners */
128         vpd->region= ar= C->region;
129         vpd->v2d= v2d= &ar->v2d;
130         
131         /* calculate translation factor - based on size of view */
132         winx= (float)(ar->winrct.xmax - ar->winrct.xmin);
133         winy= (float)(ar->winrct.ymax - ar->winrct.ymin);
134         vpd->facx= (v2d->cur.xmax - v2d->cur.xmin) / winx;
135         vpd->facy= (v2d->cur.ymax - v2d->cur.ymin) / winy;
136         
137         return 1;
138 }
139
140 /* apply transform to view (i.e. adjust 'cur' rect) */
141 static void view_pan_apply(bContext *C, wmOperator *op)
142 {
143         v2dViewPanData *vpd= op->customdata;
144         View2D *v2d= vpd->v2d;
145         float dx, dy;
146         
147         /* calculate amount to move view by */
148         dx= vpd->facx * (float)RNA_int_get(op->ptr, "deltax");
149         dy= vpd->facy * (float)RNA_int_get(op->ptr, "deltay");
150         
151         /* only move view on an axis if change is allowed */
152         if ((v2d->keepofs & V2D_LOCKOFS_X)==0) {
153                 v2d->cur.xmin += dx;
154                 v2d->cur.xmax += dx;
155         }
156         if ((v2d->keepofs & V2D_LOCKOFS_Y)==0) {
157                 v2d->cur.ymin += dy;
158                 v2d->cur.ymax += dy;
159         }
160         
161         /* request updates to be done... */
162         WM_event_add_notifier(C, WM_NOTE_AREA_REDRAW, 0, NULL);
163         /* XXX: add WM_NOTE_TIME_CHANGED? */
164 }
165
166 /* cleanup temp customdata  */
167 static void view_pan_exit(bContext *C, wmOperator *op)
168 {
169         if (op->customdata) {
170                 MEM_freeN(op->customdata);
171                 op->customdata= NULL;                           
172         }
173
174  
175 /* ------------------ Modal Drag Version (1) ---------------------- */
176
177 /* for 'redo' only, with no user input */
178 static int view_pan_exec(bContext *C, wmOperator *op)
179 {
180         if (!view_pan_init(C, op))
181                 return OPERATOR_CANCELLED;
182         
183         view_pan_apply(C, op);
184         view_pan_exit(C, op);
185         return OPERATOR_FINISHED;
186 }
187
188 /* set up modal operator and relevant settings */
189 static int view_pan_invoke(bContext *C, wmOperator *op, wmEvent *event)
190 {
191         v2dViewPanData *vpd;
192         View2D *v2d;
193         
194         /* set up customdata */
195         if (!view_pan_init(C, op))
196                 return OPERATOR_CANCELLED;
197         
198         vpd= op->customdata;
199         v2d= vpd->v2d;
200         
201         /* set initial settings */
202         vpd->startx= vpd->lastx= event->x;
203         vpd->starty= vpd->lasty= event->y;
204         RNA_int_set(op->ptr, "deltax", 0);
205         RNA_int_set(op->ptr, "deltay", 0);
206         
207 #if 0 // XXX - enable this when cursors are working properly
208         if (v2d->keepofs & V2D_LOCKOFS_X)
209                 WM_set_cursor(C, BC_NS_SCROLLCURSOR);
210         else if (v2d->keepofs & V2D_LOCKOFS_Y)
211                 WM_set_cursor(C, BC_EW_SCROLLCURSOR);
212         else
213                 WM_set_cursor(C, BC_NSEW_SCROLLCURSOR);
214 #endif // XXX - enable this when cursors are working properly
215         
216         /* add temp handler */
217         WM_event_add_modal_handler(C, &C->window->handlers, op);
218
219         return OPERATOR_RUNNING_MODAL;
220 }
221
222 /* handle user input - calculations of mouse-movement need to be done here, not in the apply callback! */
223 static int view_pan_modal(bContext *C, wmOperator *op, wmEvent *event)
224 {
225         v2dViewPanData *vpd= op->customdata;
226         
227         /* execute the events */
228         switch (event->type) {
229                 case MOUSEMOVE:
230                 {
231                         /* calculate new delta transform, then store mouse-coordinates for next-time */
232                         RNA_int_set(op->ptr, "deltax", (vpd->lastx - event->x));
233                         RNA_int_set(op->ptr, "deltay", (vpd->lasty - event->y));
234                         vpd->lastx= event->x;
235                         vpd->lasty= event->y;
236                         
237                         view_pan_apply(C, op);
238                 }
239                         break;
240                         
241                 case MIDDLEMOUSE:
242                         if (event->val==0) {
243                                 /* calculate overall delta mouse-movement for redo */
244                                 RNA_int_set(op->ptr, "deltax", (vpd->startx - vpd->lastx));
245                                 RNA_int_set(op->ptr, "deltay", (vpd->starty - vpd->lasty));
246                                 
247                                 view_pan_exit(C, op);
248                                 //WM_set_cursor(C, CURSOR_STD);         // XXX - enable this when cursors are working properly  
249                                 
250                                 return OPERATOR_FINISHED;
251                         }
252                         break;
253         }
254
255         return OPERATOR_RUNNING_MODAL;
256 }
257
258 void ED_View2D_OT_view_pan(wmOperatorType *ot)
259 {
260         PropertyRNA *prop;
261         
262         /* identifiers */
263         ot->name= "Pan View";
264         ot->idname= "ED_View2D_OT_view_pan";
265         
266         /* api callbacks */
267         ot->exec= view_pan_exec;
268         ot->invoke= view_pan_invoke;
269         ot->modal= view_pan_modal;
270         
271         /* rna - must keep these in sync with the other operators */
272         prop= RNA_def_property(ot->srna, "deltax", PROP_INT, PROP_NONE);
273         prop= RNA_def_property(ot->srna, "deltay", PROP_INT, PROP_NONE);
274 }
275
276 /* ------------------ Scrollwheel Versions (2) ---------------------- */
277
278 /* this operator only needs this single callback, where it callsthe view_pan_*() methods */
279 static int view_scrollright_exec(bContext *C, wmOperator *op)
280 {
281         /* initialise default settings (and validate if ok to run) */
282         if (!view_pan_init(C, op))
283                 return OPERATOR_CANCELLED;
284         
285         /* set RNA-Props - only movement in positive x-direction */
286         RNA_int_set(op->ptr, "deltax", 20);
287         RNA_int_set(op->ptr, "deltay", 0);
288         
289         /* apply movement, then we're done */
290         view_pan_apply(C, op);
291         view_pan_exit(C, op);
292         
293         return OPERATOR_FINISHED;
294 }
295
296 void ED_View2D_OT_view_scrollright(wmOperatorType *ot)
297 {
298         PropertyRNA *prop;
299         
300         /* identifiers */
301         ot->name= "Scroll Right";
302         ot->idname= "ED_View2D_OT_view_rightscroll";
303         
304         /* api callbacks */
305         ot->exec= view_scrollright_exec;
306         
307         /* rna - must keep these in sync with the other operators */
308         prop= RNA_def_property(ot->srna, "deltax", PROP_INT, PROP_NONE);
309         prop= RNA_def_property(ot->srna, "deltay", PROP_INT, PROP_NONE);
310 }
311
312
313
314 /* this operator only needs this single callback, where it callsthe view_pan_*() methods */
315 static int view_scrollleft_exec(bContext *C, wmOperator *op)
316 {
317         /* initialise default settings (and validate if ok to run) */
318         if (!view_pan_init(C, op))
319                 return OPERATOR_CANCELLED;
320         
321         /* set RNA-Props - only movement in negative x-direction */
322         RNA_int_set(op->ptr, "deltax", -20);
323         RNA_int_set(op->ptr, "deltay", 0);
324         
325         /* apply movement, then we're done */
326         view_pan_apply(C, op);
327         view_pan_exit(C, op);
328         
329         return OPERATOR_FINISHED;
330 }
331
332 void ED_View2D_OT_view_scrollleft(wmOperatorType *ot)
333 {
334         PropertyRNA *prop;
335         
336         /* identifiers */
337         ot->name= "Scroll Left";
338         ot->idname= "ED_View2D_OT_view_leftscroll";
339         
340         /* api callbacks */
341         ot->exec= view_scrollleft_exec;
342         
343         /* rna - must keep these in sync with the other operators */
344         prop= RNA_def_property(ot->srna, "deltax", PROP_INT, PROP_NONE);
345         prop= RNA_def_property(ot->srna, "deltay", PROP_INT, PROP_NONE);
346 }
347
348 /* this operator only needs this single callback, where it callsthe view_pan_*() methods */
349 static int view_scrolldown_exec(bContext *C, wmOperator *op)
350 {
351         /* initialise default settings (and validate if ok to run) */
352         if (!view_pan_init(C, op))
353                 return OPERATOR_CANCELLED;
354         
355         /* set RNA-Props - only movement in positive x-direction */
356         RNA_int_set(op->ptr, "deltax", 0);
357         RNA_int_set(op->ptr, "deltay", -20);
358         
359         /* apply movement, then we're done */
360         view_pan_apply(C, op);
361         view_pan_exit(C, op);
362         
363         return OPERATOR_FINISHED;
364 }
365
366 void ED_View2D_OT_view_scrolldown(wmOperatorType *ot)
367 {
368         PropertyRNA *prop;
369         
370         /* identifiers */
371         ot->name= "Scroll Down";
372         ot->idname= "ED_View2D_OT_view_downscroll";
373         
374         /* api callbacks */
375         ot->exec= view_scrolldown_exec;
376         
377         /* rna - must keep these in sync with the other operators */
378         prop= RNA_def_property(ot->srna, "deltax", PROP_INT, PROP_NONE);
379         prop= RNA_def_property(ot->srna, "deltay", PROP_INT, PROP_NONE);
380 }
381
382
383
384 /* this operator only needs this single callback, where it callsthe view_pan_*() methods */
385 static int view_scrollup_exec(bContext *C, wmOperator *op)
386 {
387         /* initialise default settings (and validate if ok to run) */
388         if (!view_pan_init(C, op))
389                 return OPERATOR_CANCELLED;
390         
391         /* set RNA-Props - only movement in negative x-direction */
392         RNA_int_set(op->ptr, "deltax", 0);
393         RNA_int_set(op->ptr, "deltay", 20);
394         
395         /* apply movement, then we're done */
396         view_pan_apply(C, op);
397         view_pan_exit(C, op);
398         
399         return OPERATOR_FINISHED;
400 }
401
402 void ED_View2D_OT_view_scrollup(wmOperatorType *ot)
403 {
404         PropertyRNA *prop;
405         
406         /* identifiers */
407         ot->name= "Scroll Up";
408         ot->idname= "ED_View2D_OT_view_upscroll";
409         
410         /* api callbacks */
411         ot->exec= view_scrollup_exec;
412         
413         /* rna - must keep these in sync with the other operators */
414         prop= RNA_def_property(ot->srna, "deltax", PROP_INT, PROP_NONE);
415         prop= RNA_def_property(ot->srna, "deltay", PROP_INT, PROP_NONE);
416 }
417
418 /* ********************************************************* */
419 /* VIEW ZOOMING OPERATOR                                                                 */
420
421 /*      This group of operators come in several forms:
422  *              1) Modal 'dragging' with MMB - where movement of mouse dictates amount to zoom view by
423  *              2) Scrollwheel 'steps' - rolling mousewheel by one step moves view by predefined amount
424  *              3) Pad +/- Keys - pressing each key moves the zooms the view by a predefined amount
425  *
426  *      In order to make sure this works, each operator must define the following RNA-Operator Props:
427  *              zoomfacx, zoomfacy      - sometimes it's still useful to have non-uniform scaling  
428  */
429
430 /* ------------------ Shared 'core' stuff ---------------------- */
431
432 /* temp customdata for operator */
433 typedef struct v2dViewZoomData {
434         ARegion *region;                /* region we're operating in */
435         View2D *v2d;                    /* view2d we're operating in */
436         
437         int startx, starty;             /* mouse x/y values in window when operator was initiated */
438         int lastx, lasty;               /* previous x/y values of mouse in window */
439 } v2dViewZoomData;
440  
441 /* initialise zooming customdata */
442 static int view_zoom_init(bContext *C, wmOperator *op)
443 {
444         v2dViewZoomData *vzd;
445         ARegion *ar;
446         
447         /* regions now have v2d-data by default, so check for region */
448         if (C->region == NULL)
449                 return 0;
450         
451         /* set custom-data for operator */
452         vzd= MEM_callocN(sizeof(v2dViewZoomData), "v2dViewZoomData");
453         op->customdata= vzd;
454         
455         /* set pointers to owners */
456         vzd->region= ar= C->region;
457         vzd->v2d= &ar->v2d;
458         
459         return 1;
460 }
461
462 /* apply transform to view (i.e. adjust 'cur' rect) */
463 static void view_zoom_apply(bContext *C, wmOperator *op)
464 {
465         v2dViewZoomData *vzd= op->customdata;
466         View2D *v2d= vzd->v2d;
467         float dx, dy;
468         
469         /* calculate amount to move view by */
470         dx= (v2d->cur.xmax - v2d->cur.xmin) * (float)RNA_float_get(op->ptr, "zoomfacx");
471         dy= (v2d->cur.ymax - v2d->cur.ymin) * (float)RNA_float_get(op->ptr, "zoomfacy");
472         
473         /* only move view on an axis if change is allowed */
474         // FIXME: this still only allows for zooming around 'center' of view... userdefined center is more useful!
475         if ((v2d->keepofs & V2D_LOCKOFS_X)==0) {
476                 v2d->cur.xmin += dx;
477                 v2d->cur.xmax -= dx;
478         }
479         if ((v2d->keepofs & V2D_LOCKOFS_Y)==0) {
480                 v2d->cur.ymin += dy;
481                 v2d->cur.ymax -= dy;
482         }
483         
484         /* request updates to be done... */
485         WM_event_add_notifier(C, WM_NOTE_AREA_REDRAW, 0, NULL);
486         /* XXX: add WM_NOTE_TIME_CHANGED? */
487 }
488
489 /* cleanup temp customdata  */
490 static void view_zoom_exit(bContext *C, wmOperator *op)
491 {
492         if (op->customdata) {
493                 MEM_freeN(op->customdata);
494                 op->customdata= NULL;                           
495         }
496 }
497
498 /* ------------------ Single-step non-modal zoom (2 and 3) ---------------------- */
499
500 /* this operator only needs this single callback, where it callsthe view_zoom_*() methods */
501 // FIXME: this should be invoke (with event pointer), so that we can do non-modal but require pointer for centerpoint
502 static int view_zoomin_exec(bContext *C, wmOperator *op)
503 {
504         /* initialise default settings (and validate if ok to run) */
505         if (!view_zoom_init(C, op))
506                 return OPERATOR_CANCELLED;
507         
508         /* set RNA-Props - zooming in by uniform factor */
509         RNA_float_set(op->ptr, "zoomfacx", 0.0375);
510         RNA_float_set(op->ptr, "zoomfacy", 0.0375);
511         
512         /* apply movement, then we're done */
513         view_zoom_apply(C, op);
514         view_zoom_exit(C, op);
515         
516         return OPERATOR_FINISHED;
517 }
518
519 void ED_View2D_OT_view_zoomin(wmOperatorType *ot)
520 {
521         PropertyRNA *prop;
522         
523         /* identifiers */
524         ot->name= "Zoom In";
525         ot->idname= "ED_View2D_OT_view_zoomin";
526         
527         /* api callbacks */
528         ot->exec= view_zoomin_exec;
529         
530         /* rna - must keep these in sync with the other operators */
531         prop= RNA_def_property(ot->srna, "zoomfacx", PROP_FLOAT, PROP_NONE);
532         prop= RNA_def_property(ot->srna, "zoomfacy", PROP_FLOAT, PROP_NONE);
533 }
534
535
536
537 /* this operator only needs this single callback, where it callsthe view_zoom_*() methods */
538 // FIXME: this should be invoke (with event pointer), so that we can do non-modal but require pointer for centerpoint
539 static int view_zoomout_exec(bContext *C, wmOperator *op)
540 {
541         /* initialise default settings (and validate if ok to run) */
542         if (!view_zoom_init(C, op))
543                 return OPERATOR_CANCELLED;
544         
545         /* set RNA-Props - zooming in by uniform factor */
546         RNA_float_set(op->ptr, "zoomfacx", -0.0375);
547         RNA_float_set(op->ptr, "zoomfacy", -0.0375);
548         
549         /* apply movement, then we're done */
550         view_zoom_apply(C, op);
551         view_zoom_exit(C, op);
552         
553         return OPERATOR_FINISHED;
554 }
555
556 void ED_View2D_OT_view_zoomout(wmOperatorType *ot)
557 {
558         PropertyRNA *prop;
559         
560         /* identifiers */
561         ot->name= "Zoom Out";
562         ot->idname= "ED_View2D_OT_view_zoomout";
563         
564         /* api callbacks */
565         ot->exec= view_zoomout_exec;
566         
567         /* rna - must keep these in sync with the other operators */
568         prop= RNA_def_property(ot->srna, "zoomfacx", PROP_FLOAT, PROP_NONE);
569         prop= RNA_def_property(ot->srna, "zoomfacy", PROP_FLOAT, PROP_NONE);
570 }
571
572 /* ********************************************************* */
573 /* Scrollers */
574
575  
576 /* ********************************************************* */
577 /* Registration */
578
579 void ui_view2d_operatortypes(void)
580 {
581         WM_operatortype_append(ED_View2D_OT_view_pan);
582         
583         WM_operatortype_append(ED_View2D_OT_view_scrollleft);
584         WM_operatortype_append(ED_View2D_OT_view_scrollright);
585         WM_operatortype_append(ED_View2D_OT_view_scrollup);
586         WM_operatortype_append(ED_View2D_OT_view_scrolldown);
587         
588         WM_operatortype_append(ED_View2D_OT_view_zoomin);
589         WM_operatortype_append(ED_View2D_OT_view_zoomout);
590 }
591
592 void UI_view2d_keymap(wmWindowManager *wm)
593 {
594         ui_view2d_operatortypes();
595         
596         /* pan/scroll operators */
597         WM_keymap_add_item(&wm->view2dkeymap, "ED_View2D_OT_view_pan", MIDDLEMOUSE, KM_PRESS, 0, 0);
598         
599         WM_keymap_add_item(&wm->view2dkeymap, "ED_View2D_OT_view_rightscroll", WHEELDOWNMOUSE, KM_ANY, KM_CTRL, 0);
600         WM_keymap_add_item(&wm->view2dkeymap, "ED_View2D_OT_view_leftscroll", WHEELUPMOUSE, KM_ANY, KM_CTRL, 0);
601         
602         WM_keymap_add_item(&wm->view2dkeymap, "ED_View2D_OT_view_downscroll", WHEELDOWNMOUSE, KM_ANY, KM_SHIFT, 0);
603         WM_keymap_add_item(&wm->view2dkeymap, "ED_View2D_OT_view_upscroll", WHEELUPMOUSE, KM_ANY, KM_SHIFT, 0);
604         
605         /* zoom */
606         WM_keymap_add_item(&wm->view2dkeymap, "ED_View2D_OT_view_zoomout", WHEELUPMOUSE, KM_ANY, 0, 0);
607         WM_keymap_add_item(&wm->view2dkeymap, "ED_View2D_OT_view_zoomin", WHEELDOWNMOUSE, KM_ANY, 0, 0);
608         WM_keymap_add_item(&wm->view2dkeymap, "ED_View2D_OT_view_zoomout", PADMINUS, KM_PRESS, 0, 0);
609         WM_keymap_add_item(&wm->view2dkeymap, "ED_View2D_OT_view_zoomin", PADPLUSKEY, KM_PRESS, 0, 0);
610         
611         
612         /* scrollbars */
613         //WM_keymap_add_item(&wm->view2dkeymap, "ED_V2D_OT_scrollbar_activate", MOUSEMOVE, 0, 0, 0);
614 }
615