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