Multitouch trackpad 2 fingers gestures implementation
[blender-staging.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_userdef_types.h"
36 #include "DNA_vec_types.h"
37 #include "DNA_view2d_types.h"
38
39 #include "BLI_blenlib.h"
40
41 #include "BKE_context.h"
42 #include "BKE_utildefines.h"
43
44 #include "RNA_access.h"
45 #include "RNA_define.h"
46
47 #include "WM_api.h"
48 #include "WM_types.h"
49
50 #include "BIF_gl.h"
51
52 #include "ED_screen.h"
53
54 #include "UI_resources.h"
55 #include "UI_view2d.h"
56
57 static int view2d_poll(bContext *C)
58 {
59         ARegion *ar= CTX_wm_region(C);
60
61         return (ar != NULL) && (ar->v2d.flag & V2D_IS_INITIALISED);
62 }
63
64 /* ********************************************************* */
65 /* VIEW PANNING OPERATOR                                                                 */
66
67 /*      This group of operators come in several forms:
68  *              1) Modal 'dragging' with MMB - where movement of mouse dictates amount to pan view by
69  *              2) Scrollwheel 'steps' - rolling mousewheel by one step moves view by predefined amount
70  *
71  *      In order to make sure this works, each operator must define the following RNA-Operator Props:
72  *              deltax, deltay  - define how much to move view by (relative to zoom-correction factor)
73  */
74
75 /* ------------------ Shared 'core' stuff ---------------------- */
76  
77 /* temp customdata for operator */
78 typedef struct v2dViewPanData {
79         bScreen *sc;                    /* screen where view pan was initiated */
80         ScrArea *sa;                    /* area where view pan was initiated */
81         View2D *v2d;                    /* view2d we're operating in */
82         
83         float facx, facy;               /* amount to move view relative to zoom */
84         
85                 /* options for version 1 */
86         int startx, starty;             /* mouse x/y values in window when operator was initiated */
87         int lastx, lasty;               /* previous x/y values of mouse in window */
88         
89         short in_scroller;              /* for MMB in scrollers (old feature in past, but now not that useful) */
90 } v2dViewPanData;
91  
92 /* initialise panning customdata */
93 static int view_pan_init(bContext *C, wmOperator *op)
94 {
95         ARegion *ar= CTX_wm_region(C);
96         v2dViewPanData *vpd;
97         View2D *v2d;
98         float winx, winy;
99         
100         /* regions now have v2d-data by default, so check for region */
101         if (ar == NULL)
102                 return 0;
103                 
104         /* check if panning is allowed at all */
105         v2d= &ar->v2d;
106         if ((v2d->keepofs & V2D_LOCKOFS_X) && (v2d->keepofs & V2D_LOCKOFS_Y))
107                 return 0;
108         
109         /* set custom-data for operator */
110         vpd= MEM_callocN(sizeof(v2dViewPanData), "v2dViewPanData");
111         op->customdata= vpd;
112         
113         /* set pointers to owners */
114         vpd->sc= CTX_wm_screen(C);
115         vpd->sa= CTX_wm_area(C);
116         vpd->v2d= v2d;
117         
118         /* calculate translation factor - based on size of view */
119         winx= (float)(ar->winrct.xmax - ar->winrct.xmin + 1);
120         winy= (float)(ar->winrct.ymax - ar->winrct.ymin + 1);
121         vpd->facx= (v2d->cur.xmax - v2d->cur.xmin) / winx;
122         vpd->facy= (v2d->cur.ymax - v2d->cur.ymin) / winy;
123         
124         return 1;
125 }
126
127 /* apply transform to view (i.e. adjust 'cur' rect) */
128 static void view_pan_apply(bContext *C, wmOperator *op)
129 {
130         v2dViewPanData *vpd= op->customdata;
131         View2D *v2d= vpd->v2d;
132         float dx, dy;
133         
134         /* calculate amount to move view by */
135         dx= vpd->facx * (float)RNA_int_get(op->ptr, "deltax");
136         dy= vpd->facy * (float)RNA_int_get(op->ptr, "deltay");
137         
138         /* only move view on an axis if change is allowed */
139         if ((v2d->keepofs & V2D_LOCKOFS_X)==0) {
140                 v2d->cur.xmin += dx;
141                 v2d->cur.xmax += dx;
142         }
143         if ((v2d->keepofs & V2D_LOCKOFS_Y)==0) {
144                 v2d->cur.ymin += dy;
145                 v2d->cur.ymax += dy;
146         }
147         
148         /* validate that view is in valid configuration after this operation */
149         UI_view2d_curRect_validate(v2d);
150         
151         /* request updates to be done... */
152         ED_area_tag_redraw(vpd->sa);
153         UI_view2d_sync(vpd->sc, vpd->sa, v2d, V2D_LOCK_COPY);
154         WM_event_add_mousemove(C);
155         
156         /* exceptions */
157         if(vpd->sa->spacetype==SPACE_OUTLINER) {
158                 SpaceOops *soops= vpd->sa->spacedata.first;
159                 soops->storeflag |= SO_TREESTORE_REDRAW;
160         }
161 }
162
163 /* cleanup temp customdata  */
164 static void view_pan_exit(bContext *C, wmOperator *op)
165 {
166         if (op->customdata) {
167                 MEM_freeN(op->customdata);
168                 op->customdata= NULL;                           
169         }
170
171  
172 /* ------------------ Modal Drag Version (1) ---------------------- */
173
174 /* for 'redo' only, with no user input */
175 static int view_pan_exec(bContext *C, wmOperator *op)
176 {
177         if (!view_pan_init(C, op))
178                 return OPERATOR_CANCELLED;
179         
180         view_pan_apply(C, op);
181         view_pan_exit(C, op);
182         return OPERATOR_FINISHED;
183 }
184
185 /* set up modal operator and relevant settings */
186 static int view_pan_invoke(bContext *C, wmOperator *op, wmEvent *event)
187 {
188         wmWindow *window= CTX_wm_window(C);
189         v2dViewPanData *vpd;
190         View2D *v2d;
191         
192         /* set up customdata */
193         if (!view_pan_init(C, op))
194                 return OPERATOR_PASS_THROUGH;
195         
196         vpd= op->customdata;
197         v2d= vpd->v2d;
198         
199         /* set initial settings */
200         vpd->startx= vpd->lastx= event->x;
201         vpd->starty= vpd->lasty= event->y;
202
203         if (event->type == MOUSEPAN) {
204                 RNA_int_set(op->ptr, "deltax", event->prevx - event->x);
205                 RNA_int_set(op->ptr, "deltay", event->prevy - event->y);
206                 
207                 view_pan_apply(C, op);
208                 view_pan_exit(C, op);
209                 return OPERATOR_FINISHED;
210         }
211         
212         RNA_int_set(op->ptr, "deltax", 0);
213         RNA_int_set(op->ptr, "deltay", 0);
214         
215         if (v2d->keepofs & V2D_LOCKOFS_X)
216                 WM_cursor_modal(window, BC_NS_SCROLLCURSOR);
217         else if (v2d->keepofs & V2D_LOCKOFS_Y)
218                 WM_cursor_modal(window, BC_EW_SCROLLCURSOR);
219         else
220                 WM_cursor_modal(window, BC_NSEW_SCROLLCURSOR);
221         
222         /* add temp handler */
223         WM_event_add_modal_handler(C, op);
224
225         return OPERATOR_RUNNING_MODAL;
226 }
227
228 /* handle user input - calculations of mouse-movement need to be done here, not in the apply callback! */
229 static int view_pan_modal(bContext *C, wmOperator *op, wmEvent *event)
230 {
231         v2dViewPanData *vpd= op->customdata;
232         
233         /* execute the events */
234         switch (event->type) {
235                 case MOUSEMOVE:
236                 {
237                         /* calculate new delta transform, then store mouse-coordinates for next-time */
238                         RNA_int_set(op->ptr, "deltax", (vpd->lastx - event->x));
239                         RNA_int_set(op->ptr, "deltay", (vpd->lasty - event->y));
240                         
241                         vpd->lastx= event->x;
242                         vpd->lasty= event->y;
243                         
244                         view_pan_apply(C, op);
245                 }
246                         break;
247                         
248                 case LEFTMOUSE:
249                         /* switch to zoom */
250                         if (event->val==KM_PRESS) {
251                                 /* calculate overall delta mouse-movement for redo */
252                                 RNA_int_set(op->ptr, "deltax", (vpd->startx - vpd->lastx));
253                                 RNA_int_set(op->ptr, "deltay", (vpd->starty - vpd->lasty));
254                                 
255                                 view_pan_exit(C, op);
256                                 WM_cursor_restore(CTX_wm_window(C));
257                                 
258                                 WM_operator_name_call(C, "VIEW2D_OT_zoom", WM_OP_INVOKE_DEFAULT, NULL);
259                                 return OPERATOR_FINISHED;
260                         }
261                 case MIDDLEMOUSE:
262                 case ESCKEY:
263                         if (event->val==KM_RELEASE) {
264                                 /* calculate overall delta mouse-movement for redo */
265                                 RNA_int_set(op->ptr, "deltax", (vpd->startx - vpd->lastx));
266                                 RNA_int_set(op->ptr, "deltay", (vpd->starty - vpd->lasty));
267                                 
268                                 view_pan_exit(C, op);
269                                 WM_cursor_restore(CTX_wm_window(C));
270                                 
271                                 return OPERATOR_FINISHED;
272                         }
273                         break;
274         }
275
276         return OPERATOR_RUNNING_MODAL;
277 }
278
279 static int view_pan_cancel(bContext *C, wmOperator *op)
280 {
281         view_pan_exit(C, op);
282         return OPERATOR_CANCELLED;
283 }
284
285 void VIEW2D_OT_pan(wmOperatorType *ot)
286 {
287         /* identifiers */
288         ot->name= "Pan View";
289         ot->description= "Pan the view.";
290         ot->idname= "VIEW2D_OT_pan";
291         
292         /* api callbacks */
293         ot->exec= view_pan_exec;
294         ot->invoke= view_pan_invoke;
295         ot->modal= view_pan_modal;
296         ot->cancel= view_pan_cancel;
297         
298         /* operator is repeatable */
299         ot->flag= OPTYPE_BLOCKING|OPTYPE_GRAB_POINTER;
300         
301         /* rna - must keep these in sync with the other operators */
302         RNA_def_int(ot->srna, "deltax", 0, INT_MIN, INT_MAX, "Delta X", "", INT_MIN, INT_MAX);
303         RNA_def_int(ot->srna, "deltay", 0, INT_MIN, INT_MAX, "Delta Y", "", INT_MIN, INT_MAX);
304 }
305
306 /* ------------------ Scrollwheel Versions (2) ---------------------- */
307
308 /* this operator only needs this single callback, where it callsthe view_pan_*() methods */
309 static int view_scrollright_exec(bContext *C, wmOperator *op)
310 {
311         v2dViewPanData *vpd;
312         
313         /* initialise default settings (and validate if ok to run) */
314         if (!view_pan_init(C, op))
315                 return OPERATOR_PASS_THROUGH;
316                 
317         /* also, check if can pan in horizontal axis */
318         vpd= op->customdata;
319         if (vpd->v2d->keepofs & V2D_LOCKOFS_X) {
320                 view_pan_exit(C, op);
321                 return OPERATOR_PASS_THROUGH;
322         }
323         
324         /* set RNA-Props - only movement in positive x-direction */
325         RNA_int_set(op->ptr, "deltax", 20);
326         RNA_int_set(op->ptr, "deltay", 0);
327         
328         /* apply movement, then we're done */
329         view_pan_apply(C, op);
330         view_pan_exit(C, op);
331         
332         return OPERATOR_FINISHED;
333 }
334
335 void VIEW2D_OT_scroll_right(wmOperatorType *ot)
336 {
337         /* identifiers */
338         ot->name= "Scroll Right";
339         ot->description= "Scroll the view right.";
340         ot->idname= "VIEW2D_OT_scroll_right";
341         
342         /* api callbacks */
343         ot->exec= view_scrollright_exec;
344         
345         /* operator is repeatable */
346         // ot->flag= OPTYPE_REGISTER;
347         
348         /* rna - must keep these in sync with the other operators */
349         RNA_def_int(ot->srna, "deltax", 0, INT_MIN, INT_MAX, "Delta X", "", INT_MIN, INT_MAX);
350         RNA_def_int(ot->srna, "deltay", 0, INT_MIN, INT_MAX, "Delta Y", "", INT_MIN, INT_MAX);
351 }
352
353
354
355 /* this operator only needs this single callback, where it callsthe view_pan_*() methods */
356 static int view_scrollleft_exec(bContext *C, wmOperator *op)
357 {
358         v2dViewPanData *vpd;
359         
360         /* initialise default settings (and validate if ok to run) */
361         if (!view_pan_init(C, op))
362                 return OPERATOR_PASS_THROUGH;
363                 
364         /* also, check if can pan in horizontal axis */
365         vpd= op->customdata;
366         if (vpd->v2d->keepofs & V2D_LOCKOFS_X) {
367                 view_pan_exit(C, op);
368                 return OPERATOR_PASS_THROUGH;
369         }
370         
371         /* set RNA-Props - only movement in negative x-direction */
372         RNA_int_set(op->ptr, "deltax", -20);
373         RNA_int_set(op->ptr, "deltay", 0);
374         
375         /* apply movement, then we're done */
376         view_pan_apply(C, op);
377         view_pan_exit(C, op);
378         
379         return OPERATOR_FINISHED;
380 }
381
382 void VIEW2D_OT_scroll_left(wmOperatorType *ot)
383 {
384         /* identifiers */
385         ot->name= "Scroll Left";
386         ot->description= "Scroll the view left.";
387         ot->idname= "VIEW2D_OT_scroll_left";
388         
389         /* api callbacks */
390         ot->exec= view_scrollleft_exec;
391         
392         /* operator is repeatable */
393         // ot->flag= OPTYPE_REGISTER;
394         
395         /* rna - must keep these in sync with the other operators */
396         RNA_def_int(ot->srna, "deltax", 0, INT_MIN, INT_MAX, "Delta X", "", INT_MIN, INT_MAX);
397         RNA_def_int(ot->srna, "deltay", 0, INT_MIN, INT_MAX, "Delta Y", "", INT_MIN, INT_MAX);
398 }
399
400
401 /* this operator only needs this single callback, where it callsthe view_pan_*() methods */
402 static int view_scrolldown_exec(bContext *C, wmOperator *op)
403 {
404         v2dViewPanData *vpd;
405         
406         /* initialise default settings (and validate if ok to run) */
407         if (!view_pan_init(C, op))
408                 return OPERATOR_PASS_THROUGH;
409                 
410         /* also, check if can pan in vertical axis */
411         vpd= op->customdata;
412         if (vpd->v2d->keepofs & V2D_LOCKOFS_Y) {
413                 view_pan_exit(C, op);
414                 return OPERATOR_PASS_THROUGH;
415         }
416         
417         /* set RNA-Props */
418         RNA_int_set(op->ptr, "deltax", 0);
419         RNA_int_set(op->ptr, "deltay", -20);
420         
421         /* apply movement, then we're done */
422         view_pan_apply(C, op);
423         view_pan_exit(C, op);
424         
425         return OPERATOR_FINISHED;
426 }
427
428 void VIEW2D_OT_scroll_down(wmOperatorType *ot)
429 {
430         /* identifiers */
431         ot->name= "Scroll Down";
432         ot->description= "Scroll the view down.";
433         ot->idname= "VIEW2D_OT_scroll_down";
434         
435         /* api callbacks */
436         ot->exec= view_scrolldown_exec;
437         
438         /* operator is repeatable */
439         // ot->flag= OPTYPE_REGISTER;
440         
441         /* rna - must keep these in sync with the other operators */
442         RNA_def_int(ot->srna, "deltax", 0, INT_MIN, INT_MAX, "Delta X", "", INT_MIN, INT_MAX);
443         RNA_def_int(ot->srna, "deltay", 0, INT_MIN, INT_MAX, "Delta Y", "", INT_MIN, INT_MAX);
444 }
445
446
447
448 /* this operator only needs this single callback, where it callsthe view_pan_*() methods */
449 static int view_scrollup_exec(bContext *C, wmOperator *op)
450 {
451         v2dViewPanData *vpd;
452         
453         /* initialise default settings (and validate if ok to run) */
454         if (!view_pan_init(C, op))
455                 return OPERATOR_PASS_THROUGH;
456                 
457         /* also, check if can pan in vertical axis */
458         vpd= op->customdata;
459         if (vpd->v2d->keepofs & V2D_LOCKOFS_Y) {
460                 view_pan_exit(C, op);
461                 return OPERATOR_PASS_THROUGH;
462         }
463         
464         /* set RNA-Props */
465         RNA_int_set(op->ptr, "deltax", 0);
466         RNA_int_set(op->ptr, "deltay", 20);
467         
468         /* apply movement, then we're done */
469         view_pan_apply(C, op);
470         view_pan_exit(C, op);
471         
472         return OPERATOR_FINISHED;
473 }
474
475 void VIEW2D_OT_scroll_up(wmOperatorType *ot)
476 {
477         /* identifiers */
478         ot->name= "Scroll Up";
479         ot->description= "Scroll the view up.";
480         ot->idname= "VIEW2D_OT_scroll_up";
481         
482         /* api callbacks */
483         ot->exec= view_scrollup_exec;
484         
485         /* operator is repeatable */
486         // ot->flag= OPTYPE_REGISTER;
487         
488         /* rna - must keep these in sync with the other operators */
489         RNA_def_int(ot->srna, "deltax", 0, INT_MIN, INT_MAX, "Delta X", "", INT_MIN, INT_MAX);
490         RNA_def_int(ot->srna, "deltay", 0, INT_MIN, INT_MAX, "Delta Y", "", INT_MIN, INT_MAX);
491 }
492
493 /* ********************************************************* */
494 /* SINGLE-STEP VIEW ZOOMING OPERATOR                                             */
495
496 /*      This group of operators come in several forms:
497  *              1) Scrollwheel 'steps' - rolling mousewheel by one step zooms view by predefined amount
498  *              2) Scrollwheel 'steps' + alt + ctrl/shift - zooms view on one axis only (ctrl=x, shift=y)  // XXX this could be implemented...
499  *              3) Pad +/- Keys - pressing each key moves the zooms the view by a predefined amount
500  *
501  *      In order to make sure this works, each operator must define the following RNA-Operator Props:
502  *              zoomfacx, zoomfacy      - These two zoom factors allow for non-uniform scaling.
503  *                                                        It is safe to scale by 0, as these factors are used to determine
504  *                                                        amount to enlarge 'cur' by
505  */
506
507 /* ------------------ 'Shared' stuff ------------------------ */
508  
509 /* check if step-zoom can be applied */
510 static int view_zoom_poll(bContext *C)
511 {
512         ARegion *ar= CTX_wm_region(C);
513         View2D *v2d;
514         
515         /* check if there's a region in context to work with */
516         if (ar == NULL)
517                 return 0;
518         v2d= &ar->v2d;
519         
520         /* check that 2d-view is zoomable */
521         if ((v2d->keepzoom & V2D_LOCKZOOM_X) && (v2d->keepzoom & V2D_LOCKZOOM_Y))
522                 return 0;
523                 
524         /* view is zoomable */
525         return 1;
526 }
527  
528 /* apply transform to view (i.e. adjust 'cur' rect) */
529 static void view_zoomstep_apply(bContext *C, wmOperator *op)
530 {
531         ARegion *ar= CTX_wm_region(C);
532         View2D *v2d= &ar->v2d;
533         float dx, dy, facx, facy;
534         
535         /* calculate amount to move view by, ensuring symmetry so the
536          * old zoom level is restored after zooming back the same amount */
537         facx= RNA_float_get(op->ptr, "zoomfacx");
538         facy= RNA_float_get(op->ptr, "zoomfacy");
539
540         if(facx >= 0.0f) {
541                 dx= (v2d->cur.xmax - v2d->cur.xmin) * facx;
542                 dy= (v2d->cur.ymax - v2d->cur.ymin) * facy;
543         }
544         else {
545                 dx= ((v2d->cur.xmax - v2d->cur.xmin)/(1.0f + 2.0f*facx)) * facx;
546                 dy= ((v2d->cur.ymax - v2d->cur.ymin)/(1.0f + 2.0f*facy)) * facy;
547         }
548
549         /* only resize view on an axis if change is allowed */
550         if ((v2d->keepzoom & V2D_LOCKZOOM_X)==0) {
551                 if (v2d->keepofs & V2D_LOCKOFS_X) {
552                         v2d->cur.xmax -= 2*dx;
553                 }
554                 else if (v2d->keepofs & V2D_KEEPOFS_X) {
555                         if(v2d->align & V2D_ALIGN_NO_POS_X)
556                                 v2d->cur.xmin += 2*dx;
557                         else
558                                 v2d->cur.xmax -= 2*dx;
559                 }
560                 else {
561                         v2d->cur.xmin += dx;
562                         v2d->cur.xmax -= dx;
563                 }
564         }
565         if ((v2d->keepzoom & V2D_LOCKZOOM_Y)==0) {
566                 if (v2d->keepofs & V2D_LOCKOFS_Y) {
567                         v2d->cur.ymax -= 2*dy;
568                 }
569                 else if (v2d->keepofs & V2D_KEEPOFS_Y) {
570                         if(v2d->align & V2D_ALIGN_NO_POS_Y)
571                                 v2d->cur.ymin += 2*dy;
572                         else
573                                 v2d->cur.ymax -= 2*dy;
574                 }
575                 else {
576                         v2d->cur.ymin += dy;
577                         v2d->cur.ymax -= dy;
578                 }
579         }
580
581         /* validate that view is in valid configuration after this operation */
582         UI_view2d_curRect_validate(v2d);
583
584         /* request updates to be done... */
585         ED_area_tag_redraw(CTX_wm_area(C));
586         UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
587         WM_event_add_mousemove(C);
588 }
589
590 /* --------------- Individual Operators ------------------- */
591
592 /* this operator only needs this single callback, where it calls the view_zoom_*() methods */
593 static int view_zoomin_exec(bContext *C, wmOperator *op)
594 {
595         /* check that there's an active region, as View2D data resides there */
596         if (!view_zoom_poll(C))
597                 return OPERATOR_PASS_THROUGH;
598         
599         /* set RNA-Props - zooming in by uniform factor */
600         RNA_float_set(op->ptr, "zoomfacx", 0.0375f);
601         RNA_float_set(op->ptr, "zoomfacy", 0.0375f);
602         
603         /* apply movement, then we're done */
604         view_zoomstep_apply(C, op);
605         
606         return OPERATOR_FINISHED;
607 }
608
609 void VIEW2D_OT_zoom_in(wmOperatorType *ot)
610 {
611         /* identifiers */
612         ot->name= "Zoom In";
613         ot->description= "Zoom in the view.";
614         ot->idname= "VIEW2D_OT_zoom_in";
615         
616         /* api callbacks */
617         ot->exec= view_zoomin_exec;
618         
619         /* operator is repeatable */
620         // ot->flag= OPTYPE_REGISTER;
621         
622         /* rna - must keep these in sync with the other operators */
623         RNA_def_float(ot->srna, "zoomfacx", 0, -FLT_MAX, FLT_MAX, "Zoom Factor X", "", -FLT_MAX, FLT_MAX);
624         RNA_def_float(ot->srna, "zoomfacy", 0, -FLT_MAX, FLT_MAX, "Zoom Factor Y", "", -FLT_MAX, FLT_MAX);
625 }
626
627
628
629 /* this operator only needs this single callback, where it callsthe view_zoom_*() methods */
630 static int view_zoomout_exec(bContext *C, wmOperator *op)
631 {
632         /* check that there's an active region, as View2D data resides there */
633         if (!view_zoom_poll(C))
634                 return OPERATOR_PASS_THROUGH;
635         
636         /* set RNA-Props - zooming in by uniform factor */
637         RNA_float_set(op->ptr, "zoomfacx", -0.0375f);
638         RNA_float_set(op->ptr, "zoomfacy", -0.0375f);
639         
640         /* apply movement, then we're done */
641         view_zoomstep_apply(C, op);
642         
643         return OPERATOR_FINISHED;
644 }
645
646 void VIEW2D_OT_zoom_out(wmOperatorType *ot)
647 {
648         /* identifiers */
649         ot->name= "Zoom Out";
650         ot->description= "Zoom out the view.";
651         ot->idname= "VIEW2D_OT_zoom_out";
652         
653         /* api callbacks */
654         ot->exec= view_zoomout_exec;
655         
656         /* operator is repeatable */
657         // ot->flag= OPTYPE_REGISTER;
658         
659         /* rna - must keep these in sync with the other operators */
660         RNA_def_float(ot->srna, "zoomfacx", 0, -FLT_MAX, FLT_MAX, "Zoom Factor X", "", -FLT_MAX, FLT_MAX);
661         RNA_def_float(ot->srna, "zoomfacy", 0, -FLT_MAX, FLT_MAX, "Zoom Factor Y", "", -FLT_MAX, FLT_MAX);
662 }
663
664 /* ********************************************************* */
665 /* DRAG-ZOOM OPERATOR                                                                    */
666
667 /*      MMB Drag - allows non-uniform scaling by dragging mouse
668  *
669  *      In order to make sure this works, each operator must define the following RNA-Operator Props:
670  *              deltax, deltay  - amounts to add to each side of the 'cur' rect
671  */
672  
673 /* ------------------ Shared 'core' stuff ---------------------- */
674  
675 /* temp customdata for operator */
676 typedef struct v2dViewZoomData {
677         View2D *v2d;                    /* view2d we're operating in */
678         
679         int lastx, lasty;               /* previous x/y values of mouse in window */
680         float dx, dy;                   /* running tally of previous delta values (for obtaining final zoom) */
681         float mx_2d, my_2d;             /* initial mouse location in v2d coords */
682 } v2dViewZoomData;
683  
684 /* initialise panning customdata */
685 static int view_zoomdrag_init(bContext *C, wmOperator *op)
686 {
687         ARegion *ar= CTX_wm_region(C);
688         v2dViewZoomData *vzd;
689         View2D *v2d;
690         
691         /* regions now have v2d-data by default, so check for region */
692         if (ar == NULL)
693                 return 0;
694         v2d= &ar->v2d;
695         
696         /* check that 2d-view is zoomable */
697         if ((v2d->keepzoom & V2D_LOCKZOOM_X) && (v2d->keepzoom & V2D_LOCKZOOM_Y))
698                 return 0;
699         
700         /* set custom-data for operator */
701         vzd= MEM_callocN(sizeof(v2dViewZoomData), "v2dViewZoomData");
702         op->customdata= vzd;
703         
704         /* set pointers to owners */
705         vzd->v2d= v2d;
706         
707         return 1;
708 }
709
710 /* apply transform to view (i.e. adjust 'cur' rect) */
711 static void view_zoomdrag_apply(bContext *C, wmOperator *op)
712 {
713         v2dViewZoomData *vzd= op->customdata;
714         View2D *v2d= vzd->v2d;
715         float dx, dy;
716         
717         /* get amount to move view by */
718         dx= RNA_float_get(op->ptr, "deltax");
719         dy= RNA_float_get(op->ptr, "deltay");
720         
721         /* only move view on an axis if change is allowed */
722         if ((v2d->keepzoom & V2D_LOCKZOOM_X)==0) {
723                 if (v2d->keepofs & V2D_LOCKOFS_X) {
724                         v2d->cur.xmax -= 2*dx;
725                 }
726                 else {
727                         if(U.uiflag & USER_ZOOM_TO_MOUSEPOS) {
728                                 float mval_fac = (vzd->mx_2d - v2d->cur.xmin) / (v2d->cur.xmax-v2d->cur.xmin);
729                                 float mval_faci = 1.0 - mval_fac;
730                                 float ofs= (mval_fac * dx) - (mval_faci * dx);
731                                 v2d->cur.xmin += ofs + dx;
732                                 v2d->cur.xmax += ofs - dx;
733                         }
734                         else {
735                                 v2d->cur.xmin += dx;
736                                 v2d->cur.xmax -= dx;
737                         }
738                 }
739         }
740         if ((v2d->keepzoom & V2D_LOCKZOOM_Y)==0) {
741                 if (v2d->keepofs & V2D_LOCKOFS_Y) {
742                         v2d->cur.ymax -= 2*dy;
743                 }
744                 else {
745                         if(U.uiflag & USER_ZOOM_TO_MOUSEPOS) {
746                                 float mval_fac = (vzd->my_2d - v2d->cur.ymin) / (v2d->cur.ymax-v2d->cur.ymin);
747                                 float mval_faci = 1.0 - mval_fac;
748                                 float ofs= (mval_fac * dy) - (mval_faci * dy);
749                                 v2d->cur.ymin += ofs + dy;
750                                 v2d->cur.ymax += ofs - dy;
751                         }
752                         else {
753                                 v2d->cur.ymin += dy;
754                                 v2d->cur.ymax -= dy;
755                         }
756                 }
757         }
758         
759         /* validate that view is in valid configuration after this operation */
760         UI_view2d_curRect_validate(v2d);
761         
762         /* request updates to be done... */
763         ED_area_tag_redraw(CTX_wm_area(C));
764         UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
765         WM_event_add_mousemove(C);
766 }
767
768 /* cleanup temp customdata  */
769 static void view_zoomdrag_exit(bContext *C, wmOperator *op)
770 {
771         if (op->customdata) {
772                 MEM_freeN(op->customdata);
773                 op->customdata= NULL;                           
774         }
775
776
777 /* for 'redo' only, with no user input */
778 static int view_zoomdrag_exec(bContext *C, wmOperator *op)
779 {
780         if (!view_zoomdrag_init(C, op))
781                 return OPERATOR_PASS_THROUGH;
782         
783         view_zoomdrag_apply(C, op);
784         view_zoomdrag_exit(C, op);
785         return OPERATOR_FINISHED;
786 }
787
788 /* set up modal operator and relevant settings */
789 static int view_zoomdrag_invoke(bContext *C, wmOperator *op, wmEvent *event)
790 {
791         wmWindow *window= CTX_wm_window(C);
792         v2dViewZoomData *vzd;
793         View2D *v2d;
794         
795         /* set up customdata */
796         if (!view_zoomdrag_init(C, op))
797                 return OPERATOR_PASS_THROUGH;
798         
799         vzd= op->customdata;
800         v2d= vzd->v2d;
801         
802         if (event->type == MOUSEZOOM) {
803                 float dx, dy, fac;
804                 
805                 vzd->lastx= event->prevx;
806                 vzd->lasty= event->prevy;
807                 
808                 /* As we have only 1D information (magnify value), feed both axes
809                 with magnify information that is stored in x axis */
810                 fac= 0.01f * (event->x - event->prevx);
811                 dx= fac * (v2d->cur.xmax - v2d->cur.xmin) / 10.0f;
812                 dy= fac * (v2d->cur.ymax - v2d->cur.ymin) / 10.0f;
813
814                 RNA_float_set(op->ptr, "deltax", dx);
815                 RNA_float_set(op->ptr, "deltay", dy);
816                 
817                 view_zoomdrag_apply(C, op);
818                 view_zoomdrag_exit(C, op);
819                 return OPERATOR_FINISHED;
820         }       
821         
822         /* set initial settings */
823         vzd->lastx= event->x;
824         vzd->lasty= event->y;
825         RNA_float_set(op->ptr, "deltax", 0);
826         RNA_float_set(op->ptr, "deltay", 0);
827         
828         if(U.uiflag & USER_ZOOM_TO_MOUSEPOS) {
829                 ARegion *ar= CTX_wm_region(C);
830                 UI_view2d_region_to_view(&ar->v2d, event->x - ar->winrct.xmin, event->y - ar->winrct.ymin, &vzd->mx_2d, &vzd->my_2d);
831         }
832
833         if (v2d->keepofs & V2D_LOCKOFS_X)
834                 WM_cursor_modal(window, BC_NS_SCROLLCURSOR);
835         else if (v2d->keepofs & V2D_LOCKOFS_Y)
836                 WM_cursor_modal(window, BC_EW_SCROLLCURSOR);
837         else
838                 WM_cursor_modal(window, BC_NSEW_SCROLLCURSOR);
839         
840         /* add temp handler */
841         WM_event_add_modal_handler(C, op);
842
843         return OPERATOR_RUNNING_MODAL;
844 }
845
846 /* handle user input - calculations of mouse-movement need to be done here, not in the apply callback! */
847 static int view_zoomdrag_modal(bContext *C, wmOperator *op, wmEvent *event)
848 {
849         v2dViewZoomData *vzd= op->customdata;
850         View2D *v2d= vzd->v2d;
851         
852         /* execute the events */
853         switch (event->type) {
854                 case MOUSEMOVE:
855                 {
856                         float dx, dy;
857                         
858                         /* calculate new delta transform, based on zooming mode */
859                         if (U.viewzoom == USER_ZOOM_SCALE) {
860                                 /* 'scale' zooming */
861                                 float dist;
862                                 
863                                 /* x-axis transform */
864                                 dist = (v2d->mask.xmax - v2d->mask.xmin) / 2.0f;
865                                 dx= 1.0f - ((float)fabs(vzd->lastx - dist) + 2.0f) / ((float)fabs(event->x - dist) + 2.0f);
866                                 dx*= 0.5f * (v2d->cur.xmax - v2d->cur.xmin);
867                                 
868                                 /* y-axis transform */
869                                 dist = (v2d->mask.ymax - v2d->mask.ymin) / 2.0f;
870                                 dy= 1.0f - ((float)fabs(vzd->lasty - dist) + 2.0f) / ((float)fabs(event->y - dist) + 2.0f);
871                                 dy*= 0.5f * (v2d->cur.ymax - v2d->cur.ymin);
872                         }
873                         else {
874                                 /* 'continuous' or 'dolly' */
875                                 float fac;
876                                 
877                                 /* x-axis transform */
878                                 fac= 0.01f * (event->x - vzd->lastx);
879                                 dx= fac * (v2d->cur.xmax - v2d->cur.xmin);
880                                 
881                                 /* y-axis transform */
882                                 fac= 0.01f * (event->y - vzd->lasty);
883                                 dy= fac * (v2d->cur.ymax - v2d->cur.ymin);
884                                 
885                                 /* continous zoom shouldn't move that fast... */
886                                 if (U.viewzoom == USER_ZOOM_CONT) { // XXX store this setting as RNA prop?
887                                         dx /= 20.0f;
888                                         dy /= 20.0f;
889                                 }
890                         }
891                         
892                         /* set transform amount, and add current deltas to stored total delta (for redo) */
893                         RNA_float_set(op->ptr, "deltax", dx);
894                         RNA_float_set(op->ptr, "deltay", dy);
895                         vzd->dx += dx;
896                         vzd->dy += dy;
897                         
898                         /* store mouse coordinates for next time, if not doing continuous zoom
899                          *      - continuous zoom only depends on distance of mouse to starting point to determine rate of change
900                          */
901                         if (U.viewzoom != USER_ZOOM_CONT) { // XXX store this setting as RNA prop?
902                                 vzd->lastx= event->x;
903                                 vzd->lasty= event->y;
904                         }
905                         
906                         /* apply zooming */
907                         view_zoomdrag_apply(C, op);
908                 }
909                         break;
910                         
911                 case LEFTMOUSE:
912                 case MIDDLEMOUSE:
913                         if (event->val==KM_RELEASE) {
914                                 /* for redo, store the overall deltas - need to respect zoom-locks here... */
915                                 if ((v2d->keepzoom & V2D_LOCKZOOM_X)==0)
916                                         RNA_float_set(op->ptr, "deltax", vzd->dx);
917                                 else
918                                         RNA_float_set(op->ptr, "deltax", 0);
919                                         
920                                 if ((v2d->keepzoom & V2D_LOCKZOOM_Y)==0)
921                                         RNA_float_set(op->ptr, "deltay", vzd->dy);
922                                 else
923                                         RNA_float_set(op->ptr, "deltay", 0);
924                                 
925                                 /* free customdata */
926                                 view_zoomdrag_exit(C, op);
927                                 WM_cursor_restore(CTX_wm_window(C));
928                                 
929                                 return OPERATOR_FINISHED;
930                         }
931                         break;
932         }
933
934         return OPERATOR_RUNNING_MODAL;
935 }
936
937 void VIEW2D_OT_zoom(wmOperatorType *ot)
938 {
939         /* identifiers */
940         ot->name= "Zoom View";
941         ot->description= "Zoom in/out the view.";
942         ot->idname= "VIEW2D_OT_zoom";
943         
944         /* api callbacks */
945         ot->exec= view_zoomdrag_exec;
946         ot->invoke= view_zoomdrag_invoke;
947         ot->modal= view_zoomdrag_modal;
948         
949         ot->poll= view_zoom_poll;
950         
951         /* operator is repeatable */
952         // ot->flag= OPTYPE_REGISTER|OPTYPE_BLOCKING;
953         
954         /* rna - must keep these in sync with the other operators */
955         RNA_def_float(ot->srna, "deltax", 0, -FLT_MAX, FLT_MAX, "Delta X", "", -FLT_MAX, FLT_MAX);
956         RNA_def_float(ot->srna, "deltay", 0, -FLT_MAX, FLT_MAX, "Delta Y", "", -FLT_MAX, FLT_MAX);
957 }
958
959 /* ********************************************************* */
960 /* BORDER-ZOOM */
961
962 /* The user defines a rect using standard borderselect tools, and we use this rect to 
963  * define the new zoom-level of the view in the following ways:
964  *      1) LEFTMOUSE - zoom in to view
965  *      2) RIGHTMOUSE - zoom out of view
966  *
967  * Currently, these key mappings are hardcoded, but it shouldn't be too important to
968  * have custom keymappings for this...
969  */
970  
971 static int view_borderzoom_exec(bContext *C, wmOperator *op)
972 {
973         ARegion *ar= CTX_wm_region(C);
974         View2D *v2d= &ar->v2d;
975         rctf rect;
976         int event_type;
977         
978         /* convert coordinates of rect to 'tot' rect coordinates */
979         UI_view2d_region_to_view(v2d, RNA_int_get(op->ptr, "xmin"), RNA_int_get(op->ptr, "ymin"), &rect.xmin, &rect.ymin);
980         UI_view2d_region_to_view(v2d, RNA_int_get(op->ptr, "xmax"), RNA_int_get(op->ptr, "ymax"), &rect.xmax, &rect.ymax);
981         
982         /* check if zooming in/out view */
983         // XXX hardcoded for now!
984         event_type= RNA_int_get(op->ptr, "event_type");
985         
986         if (event_type == LEFTMOUSE) {
987                 /* zoom in: 
988                  *      - 'cur' rect will be defined by the coordinates of the border region 
989                  *      - just set the 'cur' rect to have the same coordinates as the border region
990                  *        if zoom is allowed to be changed
991                  */
992                 if ((v2d->keepzoom & V2D_LOCKZOOM_X)==0) {
993                         v2d->cur.xmin= rect.xmin;
994                         v2d->cur.xmax= rect.xmax;
995                 }
996                 if ((v2d->keepzoom & V2D_LOCKZOOM_Y)==0) {
997                         v2d->cur.ymin= rect.ymin;
998                         v2d->cur.ymax= rect.ymax;
999                 }
1000         }
1001         else {
1002                 /* zoom out:
1003                  *      - the current 'cur' rect coordinates are going to end upwhere the 'rect' ones are, 
1004                  *        but the 'cur' rect coordinates will need to be adjusted to take in more of the view
1005                  *      - calculate zoom factor, and adjust using center-point
1006                  */
1007                 float zoom, center, size;
1008                 
1009                 // TODO: is this zoom factor calculation valid? It seems to produce same results everytime...
1010                 if ((v2d->keepzoom & V2D_LOCKZOOM_X)==0) {
1011                         size= (v2d->cur.xmax - v2d->cur.xmin);
1012                         zoom= size / (rect.xmax - rect.xmin);
1013                         center= (v2d->cur.xmax + v2d->cur.xmin) * 0.5f;
1014                         
1015                         v2d->cur.xmin= center - (size * zoom);
1016                         v2d->cur.xmax= center + (size * zoom);
1017                 }
1018                 if ((v2d->keepzoom & V2D_LOCKZOOM_Y)==0) {
1019                         size= (v2d->cur.ymax - v2d->cur.ymin);
1020                         zoom= size / (rect.ymax - rect.ymin);
1021                         center= (v2d->cur.ymax + v2d->cur.ymin) * 0.5f;
1022                         
1023                         v2d->cur.ymin= center - (size * zoom);
1024                         v2d->cur.ymax= center + (size * zoom);
1025                 }
1026         }
1027         
1028         /* validate that view is in valid configuration after this operation */
1029         UI_view2d_curRect_validate(v2d);
1030         
1031         /* request updates to be done... */
1032         ED_area_tag_redraw(CTX_wm_area(C));
1033         UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
1034         WM_event_add_mousemove(C);
1035         
1036         return OPERATOR_FINISHED;
1037
1038
1039 void VIEW2D_OT_zoom_border(wmOperatorType *ot)
1040 {
1041         /* identifiers */
1042         ot->name= "Zoom to Border";
1043         ot->description= "Zoom in the view to the nearest item contained in the border.";
1044         ot->idname= "VIEW2D_OT_zoom_border";
1045         
1046         /* api callbacks */
1047         ot->invoke= WM_border_select_invoke;
1048         ot->exec= view_borderzoom_exec;
1049         ot->modal= WM_border_select_modal;
1050         
1051         ot->poll= view_zoom_poll;
1052         
1053         /* rna */
1054         RNA_def_int(ot->srna, "event_type", 0, INT_MIN, INT_MAX, "Event Type", "", INT_MIN, INT_MAX);
1055         RNA_def_int(ot->srna, "xmin", 0, INT_MIN, INT_MAX, "X Min", "", INT_MIN, INT_MAX);
1056         RNA_def_int(ot->srna, "xmax", 0, INT_MIN, INT_MAX, "X Max", "", INT_MIN, INT_MAX);
1057         RNA_def_int(ot->srna, "ymin", 0, INT_MIN, INT_MAX, "Y Min", "", INT_MIN, INT_MAX);
1058         RNA_def_int(ot->srna, "ymax", 0, INT_MIN, INT_MAX, "Y Max", "", INT_MIN, INT_MAX);
1059 }
1060
1061 /* ********************************************************* */
1062 /* SCROLLERS */
1063
1064 /*      Scrollers should behave in the following ways, when clicked on with LMB (and dragged):
1065  *              1) 'Handles' on end of 'bubble' - when the axis that the scroller represents is zoomable, 
1066  *                      enlarge 'cur' rect on the relevant side 
1067  *              2) 'Bubble'/'bar' - just drag, and bar should move with mouse (view pans opposite)
1068  *
1069  *      In order to make sure this works, each operator must define the following RNA-Operator Props:
1070  *              deltax, deltay  - define how much to move view by (relative to zoom-correction factor)
1071  */
1072
1073 /* customdata for scroller-invoke data */
1074 typedef struct v2dScrollerMove {
1075         View2D *v2d;                    /* View2D data that this operation affects */
1076         
1077         short scroller;                 /* scroller that mouse is in ('h' or 'v') */
1078         short zone;                             /* -1 is min zoomer, 0 is bar, 1 is max zoomer */ // XXX find some way to provide visual feedback of this (active colour?)
1079         
1080         float fac;                              /* view adjustment factor, based on size of region */
1081         float delta;                    /* amount moved by mouse on axis of interest */
1082         
1083         int lastx, lasty;               /* previous mouse coordinates (in screen coordinates) for determining movement */
1084 } v2dScrollerMove;
1085
1086
1087 /* View2DScrollers is typedef'd in UI_view2d.h 
1088  * This is a CUT DOWN VERSION of the 'real' version, which is defined in view2d.c, as we only need focus bubble info
1089  * WARNING: the start of this struct must not change, so that it stays in sync with the 'real' version
1090  *                 For now, we don't need to have a separate (internal) header for structs like this...
1091  */
1092 struct View2DScrollers {        
1093                 /* focus bubbles */
1094         int vert_min, vert_max; /* vertical scrollbar */
1095         int hor_min, hor_max;   /* horizontal scrollbar */
1096 };
1097
1098 /* quick enum for vsm->zone (scroller handles) */
1099 enum {
1100         SCROLLHANDLE_MIN= -1,
1101         SCROLLHANDLE_BAR,
1102         SCROLLHANDLE_MAX
1103 } eV2DScrollerHandle_Zone;
1104
1105 /* ------------------------ */
1106
1107 /* check if mouse is within scroller handle 
1108  *      - mouse                 =       relevant mouse coordinate in region space
1109  *      - sc_min, sc_max        =       extents of scroller
1110  *      - sh_min, sh_max        =       positions of scroller handles
1111  */
1112 static short mouse_in_scroller_handle(int mouse, int sc_min, int sc_max, int sh_min, int sh_max)
1113 {
1114         short in_min, in_max, in_view=1;
1115         
1116         /* firstly, check if 
1117          *      - 'bubble' fills entire scroller 
1118          *      - 'bubble' completely out of view on either side 
1119          */
1120         if ((sh_min <= sc_min) && (sh_max >= sc_max)) in_view= 0;
1121         if (sh_min == sh_max) {
1122                 if (sh_min <= sc_min) in_view= 0;
1123                 if (sh_max >= sc_max) in_view= 0;
1124         }
1125         else {
1126                 if (sh_max <= sc_min) in_view= 0;
1127                 if (sh_min >= sc_max) in_view= 0;
1128         }
1129         
1130         
1131         if (in_view == 0) {
1132                 return SCROLLHANDLE_BAR;
1133         }
1134         
1135         /* check if mouse is in or past either handle */
1136         in_max= ( (mouse >= (sh_max - V2D_SCROLLER_HANDLE_SIZE)) && (mouse <= (sh_max + V2D_SCROLLER_HANDLE_SIZE)) );
1137         in_min= ( (mouse <= (sh_min + V2D_SCROLLER_HANDLE_SIZE)) && (mouse >= (sh_min - V2D_SCROLLER_HANDLE_SIZE)) );
1138         
1139         /* check if overlap --> which means user clicked on bar, as bar is within handles region */
1140         if (in_max && in_min)
1141                 return SCROLLHANDLE_BAR;
1142         else if (in_max)
1143                 return SCROLLHANDLE_MAX;
1144         else if (in_min)
1145                 return SCROLLHANDLE_MIN;
1146                 
1147         /* unlikely to happen, though we just cover it in case */
1148         return SCROLLHANDLE_BAR;
1149
1150
1151 /* initialise customdata for scroller manipulation operator */
1152 static void scroller_activate_init(bContext *C, wmOperator *op, wmEvent *event, short in_scroller)
1153 {
1154         v2dScrollerMove *vsm;
1155         View2DScrollers *scrollers;
1156         ARegion *ar= CTX_wm_region(C);
1157         View2D *v2d= &ar->v2d;
1158         float mask_size;
1159         int x, y;
1160         
1161         /* set custom-data for operator */
1162         vsm= MEM_callocN(sizeof(v2dScrollerMove), "v2dScrollerMove");
1163         op->customdata= vsm;
1164         
1165         /* set general data */
1166         vsm->v2d= v2d;
1167         vsm->scroller= in_scroller;
1168         
1169         /* store mouse-coordinates, and convert mouse/screen coordinates to region coordinates */
1170         vsm->lastx = event->x;
1171         vsm->lasty = event->y;
1172         x= event->x - ar->winrct.xmin;
1173         y= event->y - ar->winrct.ymin;
1174         
1175         /* 'zone' depends on where mouse is relative to bubble 
1176          *      - zooming must be allowed on this axis, otherwise, default to pan
1177          */
1178         scrollers= UI_view2d_scrollers_calc(C, v2d, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY);
1179         if (in_scroller == 'h') {
1180                 /* horizontal scroller - calculate adjustment factor first */
1181                 mask_size= (float)(v2d->hor.xmax - v2d->hor.xmin);
1182                 vsm->fac= (v2d->tot.xmax - v2d->tot.xmin) / mask_size;
1183                 
1184                 /* get 'zone' (i.e. which part of scroller is activated) */
1185                 if (v2d->keepzoom & V2D_LOCKZOOM_X) {
1186                         /* default to scroll, as handles not usable */
1187                         vsm->zone= SCROLLHANDLE_BAR;
1188                 }
1189                 else {
1190                         /* check which handle we're in */
1191                         vsm->zone= mouse_in_scroller_handle(x, v2d->hor.xmin, v2d->hor.xmax, scrollers->hor_min, scrollers->hor_max); 
1192                 }
1193         }
1194         else {
1195                 /* vertical scroller - calculate adjustment factor first */
1196                 mask_size= (float)(v2d->vert.ymax - v2d->vert.ymin);
1197                 vsm->fac= (v2d->tot.ymax - v2d->tot.ymin) / mask_size;
1198                 
1199                 /* get 'zone' (i.e. which part of scroller is activated) */
1200                 if (v2d->keepzoom & V2D_LOCKZOOM_Y) {
1201                         /* default to scroll, as handles not usable */
1202                         vsm->zone= SCROLLHANDLE_BAR;
1203                 }
1204                 else {
1205                         /* check which handle we're in */
1206                         vsm->zone= mouse_in_scroller_handle(y, v2d->vert.ymin, v2d->vert.ymax, scrollers->vert_min, scrollers->vert_max); 
1207                 }
1208         }
1209         
1210         UI_view2d_scrollers_free(scrollers);
1211         ED_region_tag_redraw(ar);
1212 }
1213
1214 /* cleanup temp customdata  */
1215 static void scroller_activate_exit(bContext *C, wmOperator *op)
1216 {
1217         if (op->customdata) {
1218                 v2dScrollerMove *vsm= op->customdata;
1219
1220                 vsm->v2d->scroll_ui &= ~(V2D_SCROLL_H_ACTIVE|V2D_SCROLL_V_ACTIVE);
1221                 
1222                 MEM_freeN(op->customdata);
1223                 op->customdata= NULL;           
1224                 
1225                 ED_region_tag_redraw(CTX_wm_region(C));
1226         }
1227
1228
1229 /* apply transform to view (i.e. adjust 'cur' rect) */
1230 static void scroller_activate_apply(bContext *C, wmOperator *op)
1231 {
1232         v2dScrollerMove *vsm= op->customdata;
1233         View2D *v2d= vsm->v2d;
1234         float temp;
1235         
1236         /* calculate amount to move view by */
1237         temp= vsm->fac * vsm->delta;
1238         
1239         /* type of movement */
1240         switch (vsm->zone) {
1241                 case SCROLLHANDLE_MIN:
1242                         /* only expand view on axis if zoom is allowed */
1243                         if ((vsm->scroller == 'h') && !(v2d->keepzoom & V2D_LOCKZOOM_X))
1244                                 v2d->cur.xmin -= temp;
1245                         if ((vsm->scroller == 'v') && !(v2d->keepzoom & V2D_LOCKZOOM_Y))
1246                                 v2d->cur.ymin -= temp;
1247                         break;
1248                         
1249                 case SCROLLHANDLE_MAX:
1250                         
1251                         /* only expand view on axis if zoom is allowed */
1252                         if ((vsm->scroller == 'h') && !(v2d->keepzoom & V2D_LOCKZOOM_X))
1253                                 v2d->cur.xmax += temp;
1254                         if ((vsm->scroller == 'v') && !(v2d->keepzoom & V2D_LOCKZOOM_Y))
1255                                 v2d->cur.ymax += temp;
1256                         break;
1257                 
1258                 default: /* SCROLLHANDLE_BAR */
1259                         /* only move view on an axis if panning is allowed */
1260                         if ((vsm->scroller == 'h') && !(v2d->keepofs & V2D_LOCKOFS_X)) {
1261                                 v2d->cur.xmin += temp;
1262                                 v2d->cur.xmax += temp;
1263                         }
1264                         if ((vsm->scroller == 'v') && !(v2d->keepofs & V2D_LOCKOFS_Y)) {
1265                                 v2d->cur.ymin += temp;
1266                                 v2d->cur.ymax += temp;
1267                         }
1268                         break;
1269         }
1270         
1271         /* validate that view is in valid configuration after this operation */
1272         UI_view2d_curRect_validate(v2d);
1273         
1274         /* request updates to be done... */
1275         ED_area_tag_redraw(CTX_wm_area(C));
1276         UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
1277         WM_event_add_mousemove(C);
1278 }
1279
1280 /* handle user input for scrollers - calculations of mouse-movement need to be done here, not in the apply callback! */
1281 static int scroller_activate_modal(bContext *C, wmOperator *op, wmEvent *event)
1282 {
1283         v2dScrollerMove *vsm= op->customdata;
1284         
1285         /* execute the events */
1286         switch (event->type) {
1287                 case MOUSEMOVE:
1288                 {
1289                         /* calculate new delta transform, then store mouse-coordinates for next-time */
1290                         if (vsm->zone != SCROLLHANDLE_MIN) {
1291                                 /* if using bar (i.e. 'panning') or 'max' zoom widget */
1292                                 switch (vsm->scroller) {
1293                                         case 'h': /* horizontal scroller - so only horizontal movement ('cur' moves opposite to mouse) */
1294                                                 vsm->delta= (float)(event->x - vsm->lastx);
1295                                                 break;
1296                                         case 'v': /* vertical scroller - so only vertical movement ('cur' moves opposite to mouse) */
1297                                                 vsm->delta= (float)(event->y - vsm->lasty);
1298                                                 break;
1299                                 }
1300                         }
1301                         else {
1302                                 /* using 'min' zoom widget */
1303                                 switch (vsm->scroller) {
1304                                         case 'h': /* horizontal scroller - so only horizontal movement ('cur' moves with mouse) */
1305                                                 vsm->delta= (float)(vsm->lastx - event->x);
1306                                                 break;
1307                                         case 'v': /* vertical scroller - so only vertical movement ('cur' moves with to mouse) */
1308                                                 vsm->delta= (float)(vsm->lasty - event->y);
1309                                                 break;
1310                                 }
1311                         }
1312                         
1313                         /* store previous coordinates */
1314                         vsm->lastx= event->x;
1315                         vsm->lasty= event->y;
1316                         
1317                         scroller_activate_apply(C, op);
1318                 }
1319                         break;
1320                         
1321                 case LEFTMOUSE:
1322                         if (event->val==KM_RELEASE) {
1323                                 scroller_activate_exit(C, op);
1324                                 return OPERATOR_FINISHED;
1325                         }
1326                         break;
1327         }
1328
1329         return OPERATOR_RUNNING_MODAL;
1330 }
1331
1332
1333 /* a click (or click drag in progress) should have occurred, so check if it happened in scrollbar */
1334 static int scroller_activate_invoke(bContext *C, wmOperator *op, wmEvent *event)
1335 {
1336         ARegion *ar= CTX_wm_region(C);
1337         View2D *v2d= &ar->v2d;
1338         short in_scroller= 0;
1339                 
1340         /* check if mouse in scrollbars, if they're enabled */
1341         in_scroller= UI_view2d_mouse_in_scrollers(C, v2d, event->x, event->y);
1342         
1343         /* if in a scroller, init customdata then set modal handler which will catch mousedown to start doing useful stuff */
1344         if (in_scroller) {
1345                 v2dScrollerMove *vsm;
1346                 
1347                 /* initialise customdata */
1348                 scroller_activate_init(C, op, event, in_scroller);
1349                 vsm= (v2dScrollerMove *)op->customdata;
1350                 
1351                 /* check if zone is inappropriate (i.e. 'bar' but panning is banned), so cannot continue */
1352                 if (vsm->zone == SCROLLHANDLE_BAR) {
1353                         if ( ((vsm->scroller=='h') && (v2d->keepofs & V2D_LOCKOFS_X)) ||
1354                                  ((vsm->scroller=='v') && (v2d->keepofs & V2D_LOCKOFS_Y)) )
1355                         {
1356                                 /* free customdata initialised */
1357                                 scroller_activate_exit(C, op);
1358                                 
1359                                 /* can't catch this event for ourselves, so let it go to someone else? */
1360                                 return OPERATOR_PASS_THROUGH;
1361                         }                       
1362                 }
1363                 /* zone is also inappropriate if scroller is not visible... */
1364                 if ( ((vsm->scroller=='h') && (v2d->scroll & V2D_SCROLL_HORIZONTAL_HIDE)) ||
1365                          ((vsm->scroller=='v') && (v2d->scroll & V2D_SCROLL_VERTICAL_HIDE)) )
1366                 {
1367                         /* can't catch this event for ourselves, so let it go to someone else? */
1368                         return OPERATOR_PASS_THROUGH;
1369                 }
1370                 
1371                 if(vsm->scroller=='h')
1372                         v2d->scroll_ui |= V2D_SCROLL_H_ACTIVE;
1373                 else
1374                         v2d->scroll_ui |= V2D_SCROLL_V_ACTIVE;
1375                 
1376                 /* still ok, so can add */
1377                 WM_event_add_modal_handler(C, op);
1378                 return OPERATOR_RUNNING_MODAL;
1379         }
1380         else {
1381                 /* not in scroller, so nothing happened... (pass through let's something else catch event) */
1382                 return OPERATOR_PASS_THROUGH;
1383         }
1384 }
1385
1386 /* LMB-Drag in Scrollers - not repeatable operator! */
1387 void VIEW2D_OT_scroller_activate(wmOperatorType *ot)
1388 {
1389         /* identifiers */
1390         ot->name= "Scroller Activate";
1391         ot->description= "Scroll view by mouse click and drag.";
1392         ot->idname= "VIEW2D_OT_scroller_activate";
1393
1394         /* flags */
1395         ot->flag= OPTYPE_BLOCKING;
1396         
1397         /* api callbacks */
1398         ot->invoke= scroller_activate_invoke;
1399         ot->modal= scroller_activate_modal;
1400         ot->poll= view2d_poll;
1401 }
1402
1403 /* ********************************************************* */
1404 /* RESET */
1405
1406 static int reset_exec(bContext *C, wmOperator *op)
1407 {
1408         uiStyle *style= U.uistyles.first;
1409         ARegion *ar= CTX_wm_region(C);
1410         View2D *v2d= &ar->v2d;
1411         int winx, winy;
1412
1413         /* zoom 1.0 */
1414         winx= (float)(v2d->mask.xmax - v2d->mask.xmin + 1);
1415         winy= (float)(v2d->mask.ymax - v2d->mask.ymin + 1);
1416
1417         v2d->cur.xmax= v2d->cur.xmin + winx;
1418         v2d->cur.ymax= v2d->cur.ymin + winy;
1419         
1420         /* align */
1421         if(v2d->align) {
1422                 /* posx and negx flags are mutually exclusive, so watch out */
1423                 if ((v2d->align & V2D_ALIGN_NO_POS_X) && !(v2d->align & V2D_ALIGN_NO_NEG_X)) {
1424                         v2d->cur.xmax= 0.0f;
1425                         v2d->cur.xmin= -winx*style->panelzoom;
1426                 }
1427                 else if ((v2d->align & V2D_ALIGN_NO_NEG_X) && !(v2d->align & V2D_ALIGN_NO_POS_X)) {
1428                         v2d->cur.xmax= winx*style->panelzoom;
1429                         v2d->cur.xmin= 0.0f;
1430                 }
1431
1432                 /* - posx and negx flags are mutually exclusive, so watch out */
1433                 if ((v2d->align & V2D_ALIGN_NO_POS_Y) && !(v2d->align & V2D_ALIGN_NO_NEG_Y)) {
1434                         v2d->cur.ymax= 0.0f;
1435                         v2d->cur.ymin= -winy*style->panelzoom;
1436                 }
1437                 else if ((v2d->align & V2D_ALIGN_NO_NEG_Y) && !(v2d->align & V2D_ALIGN_NO_POS_Y)) {
1438                         v2d->cur.ymax= winy*style->panelzoom;
1439                         v2d->cur.ymin= 0.0f;
1440                 }
1441         }
1442
1443         /* validate that view is in valid configuration after this operation */
1444         UI_view2d_curRect_validate(v2d);
1445         
1446         /* request updates to be done... */
1447         ED_area_tag_redraw(CTX_wm_area(C));
1448         UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
1449         WM_event_add_mousemove(C);
1450         
1451         return OPERATOR_FINISHED;
1452 }
1453  
1454 void VIEW2D_OT_reset(wmOperatorType *ot)
1455 {
1456         /* identifiers */
1457         ot->name= "Reset View";
1458         ot->description= "Reset the view.";
1459         ot->idname= "VIEW2D_OT_reset";
1460         
1461         /* api callbacks */
1462         ot->exec= reset_exec;
1463         ot->poll= view2d_poll;
1464         
1465         /* flags */
1466         // ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
1467 }
1468  
1469 /* ********************************************************* */
1470 /* Registration */
1471
1472 void UI_view2d_operatortypes(void)
1473 {
1474         WM_operatortype_append(VIEW2D_OT_pan);
1475         
1476         WM_operatortype_append(VIEW2D_OT_scroll_left);
1477         WM_operatortype_append(VIEW2D_OT_scroll_right);
1478         WM_operatortype_append(VIEW2D_OT_scroll_up);
1479         WM_operatortype_append(VIEW2D_OT_scroll_down);
1480         
1481         WM_operatortype_append(VIEW2D_OT_zoom_in);
1482         WM_operatortype_append(VIEW2D_OT_zoom_out);
1483         
1484         WM_operatortype_append(VIEW2D_OT_zoom);
1485         WM_operatortype_append(VIEW2D_OT_zoom_border);
1486         
1487         WM_operatortype_append(VIEW2D_OT_scroller_activate);
1488
1489         WM_operatortype_append(VIEW2D_OT_reset);
1490 }
1491
1492 void UI_view2d_keymap(wmKeyConfig *keyconf)
1493 {
1494         wmKeyMap *keymap= WM_keymap_find(keyconf, "View2D", 0, 0);
1495         
1496         /* pan/scroll */
1497         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MIDDLEMOUSE, KM_PRESS, 0, 0);
1498         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MIDDLEMOUSE, KM_PRESS, KM_SHIFT, 0);
1499         
1500         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MOUSEPAN, 0, 0, 0);
1501         
1502         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_right", WHEELDOWNMOUSE, KM_PRESS, KM_CTRL, 0);
1503         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_left", WHEELUPMOUSE, KM_PRESS, KM_CTRL, 0);
1504         
1505         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", WHEELDOWNMOUSE, KM_PRESS, KM_SHIFT, 0);
1506         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", WHEELUPMOUSE, KM_PRESS, KM_SHIFT, 0);
1507         
1508         /* zoom - single step */
1509         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_out", WHEELOUTMOUSE, KM_PRESS, 0, 0);
1510         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_in", WHEELINMOUSE, KM_PRESS, 0, 0);
1511         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_out", PADMINUS, KM_PRESS, 0, 0);
1512         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_in", PADPLUSKEY, KM_PRESS, 0, 0);
1513         
1514         /* scroll up/down - no modifiers, only when zoom fails */
1515                 /* these may fail if zoom is disallowed, in which case they should pass on event */
1516         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", WHEELDOWNMOUSE, KM_PRESS, 0, 0);
1517         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", WHEELUPMOUSE, KM_PRESS, 0, 0);
1518                 /* these may be necessary if vertical scroll is disallowed */
1519         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_right", WHEELDOWNMOUSE, KM_PRESS, 0, 0);
1520         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_left", WHEELUPMOUSE, KM_PRESS, 0, 0);
1521         
1522         /* zoom - drag */
1523         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MIDDLEMOUSE, KM_PRESS, KM_CTRL, 0);
1524         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MOUSEZOOM, 0, 0, 0);
1525         
1526         /* borderzoom - drag */
1527         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_border", BKEY, KM_PRESS, KM_SHIFT, 0);
1528         
1529         /* scrollers */
1530         WM_keymap_add_item(keymap, "VIEW2D_OT_scroller_activate", LEFTMOUSE, KM_PRESS, 0, 0);
1531
1532         /* Alternative keymap for buttons listview */
1533         keymap= WM_keymap_find(keyconf, "View2D Buttons List", 0, 0);
1534         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MIDDLEMOUSE, KM_PRESS, 0, 0);
1535         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MOUSEPAN, 0, 0, 0);
1536         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", WHEELDOWNMOUSE, KM_PRESS, 0, 0);
1537         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", WHEELUPMOUSE, KM_PRESS, 0, 0);
1538         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MIDDLEMOUSE, KM_PRESS, KM_CTRL, 0);
1539         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MOUSEZOOM, 0, 0, 0);
1540         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_out", PADMINUS, KM_PRESS, 0, 0);
1541         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_in", PADPLUSKEY, KM_PRESS, 0, 0);
1542         WM_keymap_add_item(keymap, "VIEW2D_OT_reset", HOMEKEY, KM_PRESS, 0, 0);
1543         WM_keymap_add_item(keymap, "VIEW2D_OT_scroller_activate", LEFTMOUSE, KM_PRESS, 0, 0);
1544 }
1545