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