rename api functions...
[blender.git] / source / blender / editors / interface / view2d_ops.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2008 Blender Foundation.
19  * All rights reserved.
20  * 
21  * Contributor(s): Blender Foundation, Joshua Leung
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/editors/interface/view2d_ops.c
27  *  \ingroup edinterface
28  */
29
30
31 #include <math.h>
32
33 #include "MEM_guardedalloc.h"
34
35 #include "DNA_userdef_types.h"
36
37 #include "BLI_blenlib.h"
38 #include "BLI_utildefines.h"
39 #include "BLI_math_base.h"
40
41 #include "BKE_context.h"
42
43 #include "RNA_access.h"
44 #include "RNA_define.h"
45
46 #include "WM_api.h"
47 #include "WM_types.h"
48
49
50 #include "ED_screen.h"
51
52 #include "UI_view2d.h"
53 #include "UI_interface.h"
54
55 #include "PIL_time.h" /* USER_ZOOM_CONT */
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         ARegion *ar;            /* region where view pan was initiated */
82         View2D *v2d;            /* view2d we're operating in */
83
84         float facx, facy;       /* amount to move view relative to zoom */
85
86         /* options for version 1 */
87         int startx, starty;     /* mouse x/y values in window when operator was initiated */
88         int lastx, lasty;       /* previous x/y values of mouse in window */
89         int invoke_event;       /* event starting pan, for modal exit */
90         
91         short in_scroller;      /* for MMB in scrollers (old feature in past, but now not that useful) */
92 } v2dViewPanData;
93  
94 /* initialize panning customdata */
95 static int view_pan_init(bContext *C, wmOperator *op)
96 {
97         ARegion *ar = CTX_wm_region(C);
98         v2dViewPanData *vpd;
99         View2D *v2d;
100         float winx, winy;
101         
102         /* regions now have v2d-data by default, so check for region */
103         if (ar == NULL)
104                 return 0;
105                 
106         /* check if panning is allowed at all */
107         v2d = &ar->v2d;
108         if ((v2d->keepofs & V2D_LOCKOFS_X) && (v2d->keepofs & V2D_LOCKOFS_Y))
109                 return 0;
110         
111         /* set custom-data for operator */
112         vpd = MEM_callocN(sizeof(v2dViewPanData), "v2dViewPanData");
113         op->customdata = vpd;
114         
115         /* set pointers to owners */
116         vpd->sc = CTX_wm_screen(C);
117         vpd->sa = CTX_wm_area(C);
118         vpd->v2d = v2d;
119         vpd->ar = ar;
120         
121         /* calculate translation factor - based on size of view */
122         winx = (float)(BLI_rcti_size_x(&ar->winrct) + 1);
123         winy = (float)(BLI_rcti_size_y(&ar->winrct) + 1);
124         vpd->facx = (BLI_rctf_size_x(&v2d->cur)) / winx;
125         vpd->facy = (BLI_rctf_size_y(&v2d->cur)) / winy;
126         
127         return 1;
128 }
129
130 /* apply transform to view (i.e. adjust 'cur' rect) */
131 static void view_pan_apply(wmOperator *op)
132 {
133         v2dViewPanData *vpd = op->customdata;
134         View2D *v2d = vpd->v2d;
135         float dx, dy;
136         
137         /* calculate amount to move view by */
138         dx = vpd->facx * (float)RNA_int_get(op->ptr, "deltax");
139         dy = vpd->facy * (float)RNA_int_get(op->ptr, "deltay");
140         
141         /* only move view on an axis if change is allowed */
142         if ((v2d->keepofs & V2D_LOCKOFS_X) == 0) {
143                 v2d->cur.xmin += dx;
144                 v2d->cur.xmax += dx;
145         }
146         if ((v2d->keepofs & V2D_LOCKOFS_Y) == 0) {
147                 v2d->cur.ymin += dy;
148                 v2d->cur.ymax += dy;
149         }
150         
151         /* validate that view is in valid configuration after this operation */
152         UI_view2d_curRect_validate(v2d);
153         
154         /* request updates to be done... */
155         ED_region_tag_redraw(vpd->ar);
156         
157         UI_view2d_sync(vpd->sc, vpd->sa, v2d, V2D_LOCK_COPY);
158         
159         /* exceptions */
160         if (vpd->sa->spacetype == SPACE_OUTLINER) {
161                 /* don't rebuild full tree, since we're just changing our view */
162                 SpaceOops *soops = vpd->sa->spacedata.first;
163                 soops->storeflag |= SO_TREESTORE_REDRAW;
164         }
165 }
166
167 /* cleanup temp customdata  */
168 static void view_pan_exit(wmOperator *op)
169 {
170         if (op->customdata) {
171                 MEM_freeN(op->customdata);
172                 op->customdata = NULL;
173         }
174
175  
176 /* ------------------ Modal Drag Version (1) ---------------------- */
177
178 /* for 'redo' only, with no user input */
179 static int view_pan_exec(bContext *C, wmOperator *op)
180 {
181         if (!view_pan_init(C, op))
182                 return OPERATOR_CANCELLED;
183         
184         view_pan_apply(op);
185         view_pan_exit(op);
186         return OPERATOR_FINISHED;
187 }
188
189 /* set up modal operator and relevant settings */
190 static int view_pan_invoke(bContext *C, wmOperator *op, wmEvent *event)
191 {
192         wmWindow *window = CTX_wm_window(C);
193         v2dViewPanData *vpd;
194         View2D *v2d;
195         
196         /* set up customdata */
197         if (!view_pan_init(C, op))
198                 return OPERATOR_PASS_THROUGH;
199         
200         vpd = op->customdata;
201         v2d = vpd->v2d;
202         
203         /* set initial settings */
204         vpd->startx = vpd->lastx = event->x;
205         vpd->starty = vpd->lasty = event->y;
206         vpd->invoke_event = event->type;
207         
208         if (event->type == MOUSEPAN) {
209                 RNA_int_set(op->ptr, "deltax", event->prevx - event->x);
210                 RNA_int_set(op->ptr, "deltay", event->prevy - event->y);
211                 
212                 view_pan_apply(op);
213                 view_pan_exit(op);
214                 return OPERATOR_FINISHED;
215         }
216         
217         RNA_int_set(op->ptr, "deltax", 0);
218         RNA_int_set(op->ptr, "deltay", 0);
219         
220         if (v2d->keepofs & V2D_LOCKOFS_X)
221                 WM_cursor_modal(window, BC_NS_SCROLLCURSOR);
222         else if (v2d->keepofs & V2D_LOCKOFS_Y)
223                 WM_cursor_modal(window, BC_EW_SCROLLCURSOR);
224         else
225                 WM_cursor_modal(window, BC_NSEW_SCROLLCURSOR);
226         
227         /* add temp handler */
228         WM_event_add_modal_handler(C, op);
229
230         return OPERATOR_RUNNING_MODAL;
231 }
232
233 /* handle user input - calculations of mouse-movement need to be done here, not in the apply callback! */
234 static int view_pan_modal(bContext *C, wmOperator *op, wmEvent *event)
235 {
236         v2dViewPanData *vpd = op->customdata;
237         
238         /* execute the events */
239         switch (event->type) {
240                 case MOUSEMOVE:
241                 {
242                         /* calculate new delta transform, then store mouse-coordinates for next-time */
243                         RNA_int_set(op->ptr, "deltax", (vpd->lastx - event->x));
244                         RNA_int_set(op->ptr, "deltay", (vpd->lasty - event->y));
245                         
246                         vpd->lastx = event->x;
247                         vpd->lasty = event->y;
248                         
249                         view_pan_apply(op);
250                 }
251                 break;
252                         /* XXX - Mode switching isn't implemented. See comments in 36818.
253                          * switch to zoom */
254 #if 0
255                 case LEFTMOUSE:
256                         if (event->val == KM_PRESS) {
257                                 /* calculate overall delta mouse-movement for redo */
258                                 RNA_int_set(op->ptr, "deltax", (vpd->startx - vpd->lastx));
259                                 RNA_int_set(op->ptr, "deltay", (vpd->starty - vpd->lasty));
260                                 
261                                 view_pan_exit(op);
262                                 WM_cursor_restore(CTX_wm_window(C));
263                                 WM_operator_name_call(C, "VIEW2D_OT_zoom", WM_OP_INVOKE_DEFAULT, NULL);
264                                 return OPERATOR_FINISHED;
265                         }
266 #endif
267                 default:
268                         if (event->type == vpd->invoke_event || event->type == ESCKEY) {
269                                 if (event->val == KM_RELEASE) {
270                                         /* calculate overall delta mouse-movement for redo */
271                                         RNA_int_set(op->ptr, "deltax", (vpd->startx - vpd->lastx));
272                                         RNA_int_set(op->ptr, "deltay", (vpd->starty - vpd->lasty));
273                                         
274                                         view_pan_exit(op);
275                                         WM_cursor_restore(CTX_wm_window(C));
276                                         
277                                         return OPERATOR_FINISHED;
278                                 }
279                         }
280                         break;
281         }
282
283         return OPERATOR_RUNNING_MODAL;
284 }
285
286 static int view_pan_cancel(bContext *UNUSED(C), wmOperator *op)
287 {
288         view_pan_exit(op);
289         return OPERATOR_CANCELLED;
290 }
291
292 static void VIEW2D_OT_pan(wmOperatorType *ot)
293 {
294         /* identifiers */
295         ot->name = "Pan View";
296         ot->description = "Pan the view";
297         ot->idname = "VIEW2D_OT_pan";
298         
299         /* api callbacks */
300         ot->exec = view_pan_exec;
301         ot->invoke = view_pan_invoke;
302         ot->modal = view_pan_modal;
303         ot->cancel = view_pan_cancel;
304         
305         /* operator is modal */
306         ot->flag = OPTYPE_BLOCKING | OPTYPE_GRAB_POINTER;
307         
308         /* rna - must keep these in sync with the other operators */
309         RNA_def_int(ot->srna, "deltax", 0, INT_MIN, INT_MAX, "Delta X", "", INT_MIN, INT_MAX);
310         RNA_def_int(ot->srna, "deltay", 0, INT_MIN, INT_MAX, "Delta Y", "", INT_MIN, INT_MAX);
311 }
312
313 /* ------------------ Scrollwheel Versions (2) ---------------------- */
314
315 /* this operator only needs this single callback, where it callsthe view_pan_*() methods */
316 static int view_scrollright_exec(bContext *C, wmOperator *op)
317 {
318         v2dViewPanData *vpd;
319         
320         /* initialize default settings (and validate if ok to run) */
321         if (!view_pan_init(C, op))
322                 return OPERATOR_PASS_THROUGH;
323                 
324         /* also, check if can pan in horizontal axis */
325         vpd = op->customdata;
326         if (vpd->v2d->keepofs & V2D_LOCKOFS_X) {
327                 view_pan_exit(op);
328                 return OPERATOR_PASS_THROUGH;
329         }
330         
331         /* set RNA-Props - only movement in positive x-direction */
332         RNA_int_set(op->ptr, "deltax", 20);
333         RNA_int_set(op->ptr, "deltay", 0);
334         
335         /* apply movement, then we're done */
336         view_pan_apply(op);
337         view_pan_exit(op);
338         
339         return OPERATOR_FINISHED;
340 }
341
342 static void VIEW2D_OT_scroll_right(wmOperatorType *ot)
343 {
344         /* identifiers */
345         ot->name = "Scroll Right";
346         ot->description = "Scroll the view right";
347         ot->idname = "VIEW2D_OT_scroll_right";
348         
349         /* api callbacks */
350         ot->exec = view_scrollright_exec;
351         
352         /* rna - must keep these in sync with the other operators */
353         RNA_def_int(ot->srna, "deltax", 0, INT_MIN, INT_MAX, "Delta X", "", INT_MIN, INT_MAX);
354         RNA_def_int(ot->srna, "deltay", 0, INT_MIN, INT_MAX, "Delta Y", "", INT_MIN, INT_MAX);
355 }
356
357
358
359 /* this operator only needs this single callback, where it callsthe view_pan_*() methods */
360 static int view_scrollleft_exec(bContext *C, wmOperator *op)
361 {
362         v2dViewPanData *vpd;
363         
364         /* initialize default settings (and validate if ok to run) */
365         if (!view_pan_init(C, op))
366                 return OPERATOR_PASS_THROUGH;
367                 
368         /* also, check if can pan in horizontal axis */
369         vpd = op->customdata;
370         if (vpd->v2d->keepofs & V2D_LOCKOFS_X) {
371                 view_pan_exit(op);
372                 return OPERATOR_PASS_THROUGH;
373         }
374         
375         /* set RNA-Props - only movement in negative x-direction */
376         RNA_int_set(op->ptr, "deltax", -20);
377         RNA_int_set(op->ptr, "deltay", 0);
378         
379         /* apply movement, then we're done */
380         view_pan_apply(op);
381         view_pan_exit(op);
382         
383         return OPERATOR_FINISHED;
384 }
385
386 static void VIEW2D_OT_scroll_left(wmOperatorType *ot)
387 {
388         /* identifiers */
389         ot->name = "Scroll Left";
390         ot->description = "Scroll the view left";
391         ot->idname = "VIEW2D_OT_scroll_left";
392         
393         /* api callbacks */
394         ot->exec = view_scrollleft_exec;
395         
396         /* rna - must keep these in sync with the other operators */
397         RNA_def_int(ot->srna, "deltax", 0, INT_MIN, INT_MAX, "Delta X", "", INT_MIN, INT_MAX);
398         RNA_def_int(ot->srna, "deltay", 0, INT_MIN, INT_MAX, "Delta Y", "", INT_MIN, INT_MAX);
399 }
400
401
402 /* this operator only needs this single callback, where it callsthe view_pan_*() methods */
403 static int view_scrolldown_exec(bContext *C, wmOperator *op)
404 {
405         v2dViewPanData *vpd;
406         
407         /* initialize default settings (and validate if ok to run) */
408         if (!view_pan_init(C, op))
409                 return OPERATOR_PASS_THROUGH;
410                 
411         /* also, check if can pan in vertical axis */
412         vpd = op->customdata;
413         if (vpd->v2d->keepofs & V2D_LOCKOFS_Y) {
414                 view_pan_exit(op);
415                 return OPERATOR_PASS_THROUGH;
416         }
417         
418         /* set RNA-Props */
419         RNA_int_set(op->ptr, "deltax", 0);
420         RNA_int_set(op->ptr, "deltay", -40);
421         
422         if (RNA_boolean_get(op->ptr, "page")) {
423                 ARegion *ar = CTX_wm_region(C);
424                 RNA_int_set(op->ptr, "deltay", ar->v2d.mask.ymin - ar->v2d.mask.ymax);
425         }
426         
427         /* apply movement, then we're done */
428         view_pan_apply(op);
429         view_pan_exit(op);
430         
431         return OPERATOR_FINISHED;
432 }
433
434 static void VIEW2D_OT_scroll_down(wmOperatorType *ot)
435 {
436         /* identifiers */
437         ot->name = "Scroll Down";
438         ot->description = "Scroll the view down";
439         ot->idname = "VIEW2D_OT_scroll_down";
440         
441         /* api callbacks */
442         ot->exec = view_scrolldown_exec;
443         
444         /* rna - must keep these in sync with the other operators */
445         RNA_def_int(ot->srna, "deltax", 0, INT_MIN, INT_MAX, "Delta X", "", INT_MIN, INT_MAX);
446         RNA_def_int(ot->srna, "deltay", 0, INT_MIN, INT_MAX, "Delta Y", "", INT_MIN, INT_MAX);
447         RNA_def_boolean(ot->srna, "page", 0, "Page", "Scroll down one page");
448 }
449
450
451
452 /* this operator only needs this single callback, where it callsthe view_pan_*() methods */
453 static int view_scrollup_exec(bContext *C, wmOperator *op)
454 {
455         v2dViewPanData *vpd;
456         
457         /* initialize default settings (and validate if ok to run) */
458         if (!view_pan_init(C, op))
459                 return OPERATOR_PASS_THROUGH;
460                 
461         /* also, check if can pan in vertical axis */
462         vpd = op->customdata;
463         if (vpd->v2d->keepofs & V2D_LOCKOFS_Y) {
464                 view_pan_exit(op);
465                 return OPERATOR_PASS_THROUGH;
466         }
467         
468         /* set RNA-Props */
469         RNA_int_set(op->ptr, "deltax", 0);
470         RNA_int_set(op->ptr, "deltay", 40);
471         
472         if (RNA_boolean_get(op->ptr, "page")) {
473                 ARegion *ar = CTX_wm_region(C);
474                 RNA_int_set(op->ptr, "deltay", BLI_rcti_size_y(&ar->v2d.mask));
475         }
476         
477         /* apply movement, then we're done */
478         view_pan_apply(op);
479         view_pan_exit(op);
480         
481         return OPERATOR_FINISHED;
482 }
483
484 static void VIEW2D_OT_scroll_up(wmOperatorType *ot)
485 {
486         /* identifiers */
487         ot->name = "Scroll Up";
488         ot->description = "Scroll the view up";
489         ot->idname = "VIEW2D_OT_scroll_up";
490         
491         /* api callbacks */
492         ot->exec = view_scrollup_exec;
493         
494         /* rna - must keep these in sync with the other operators */
495         RNA_def_int(ot->srna, "deltax", 0, INT_MIN, INT_MAX, "Delta X", "", INT_MIN, INT_MAX);
496         RNA_def_int(ot->srna, "deltay", 0, INT_MIN, INT_MAX, "Delta Y", "", INT_MIN, INT_MAX);
497         RNA_def_boolean(ot->srna, "page", 0, "Page", "Scroll up one page");
498 }
499
500 /* ********************************************************* */
501 /* SINGLE-STEP VIEW ZOOMING OPERATOR                                             */
502
503 /* This group of operators come in several forms:
504  * 1) Scrollwheel 'steps' - rolling mousewheel by one step zooms view by predefined amount
505  * 2) Scrollwheel 'steps' + alt + ctrl/shift - zooms view on one axis only (ctrl=x, shift=y)  // XXX this could be implemented...
506  * 3) Pad +/- Keys - pressing each key moves the zooms the view by a predefined amount
507  *
508  * In order to make sure this works, each operator must define the following RNA-Operator Props:
509  * zoomfacx, zoomfacy - These two zoom factors allow for non-uniform scaling.
510  *                      It is safe to scale by 0, as these factors are used to determine
511  *                      amount to enlarge 'cur' by
512  */
513
514 /* ------------------ 'Shared' stuff ------------------------ */
515
516 /* temp customdata for operator */
517 typedef struct v2dViewZoomData {
518         View2D *v2d;            /* view2d we're operating in */
519         ARegion *ar;
520
521         /* needed for continuous zoom */
522         wmTimer *timer;
523         double timer_lastdraw;
524
525         int lastx, lasty;       /* previous x/y values of mouse in window */
526         int invoke_event;       /* event type that invoked, for modal exits */
527         float dx, dy;           /* running tally of previous delta values (for obtaining final zoom) */
528         float mx_2d, my_2d;     /* initial mouse location in v2d coords */
529 } v2dViewZoomData;
530
531
532 /* initialize panning customdata */
533 static int view_zoomdrag_init(bContext *C, wmOperator *op)
534 {
535         ARegion *ar = CTX_wm_region(C);
536         v2dViewZoomData *vzd;
537         View2D *v2d;
538         
539         /* regions now have v2d-data by default, so check for region */
540         if (ar == NULL)
541                 return 0;
542         v2d = &ar->v2d;
543         
544         /* check that 2d-view is zoomable */
545         if ((v2d->keepzoom & V2D_LOCKZOOM_X) && (v2d->keepzoom & V2D_LOCKZOOM_Y))
546                 return 0;
547         
548         /* set custom-data for operator */
549         vzd = MEM_callocN(sizeof(v2dViewZoomData), "v2dViewZoomData");
550         op->customdata = vzd;
551         
552         /* set pointers to owners */
553         vzd->v2d = v2d;
554         vzd->ar = ar;
555         
556         return 1;
557 }
558
559 /* check if step-zoom can be applied */
560 static int view_zoom_poll(bContext *C)
561 {
562         ARegion *ar = CTX_wm_region(C);
563         View2D *v2d;
564         
565         /* check if there's a region in context to work with */
566         if (ar == NULL)
567                 return 0;
568         v2d = &ar->v2d;
569         
570         /* check that 2d-view is zoomable */
571         if ((v2d->keepzoom & V2D_LOCKZOOM_X) && (v2d->keepzoom & V2D_LOCKZOOM_Y))
572                 return 0;
573                 
574         /* view is zoomable */
575         return 1;
576 }
577  
578 /* apply transform to view (i.e. adjust 'cur' rect) */
579 static void view_zoomstep_apply(bContext *C, wmOperator *op)
580 {
581         v2dViewZoomData *vzd = op->customdata;
582         ARegion *ar = CTX_wm_region(C);
583         View2D *v2d = &ar->v2d;
584         float dx, dy, facx, facy;
585         
586         /* calculate amount to move view by, ensuring symmetry so the
587          * old zoom level is restored after zooming back the same amount 
588          */
589         facx = RNA_float_get(op->ptr, "zoomfacx");
590         facy = RNA_float_get(op->ptr, "zoomfacy");
591
592         if (facx >= 0.0f) {
593                 dx = BLI_rctf_size_x(&v2d->cur) * facx;
594                 dy = BLI_rctf_size_y(&v2d->cur) * facy;
595         }
596         else {
597                 dx = (BLI_rctf_size_x(&v2d->cur) / (1.0f + 2.0f * facx)) * facx;
598                 dy = (BLI_rctf_size_y(&v2d->cur) / (1.0f + 2.0f * facy)) * facy;
599         }
600
601         /* only resize view on an axis if change is allowed */
602         if ((v2d->keepzoom & V2D_LOCKZOOM_X) == 0) {
603                 if (v2d->keepofs & V2D_LOCKOFS_X) {
604                         v2d->cur.xmax -= 2 * dx;
605                 }
606                 else if (v2d->keepofs & V2D_KEEPOFS_X) {
607                         if (v2d->align & V2D_ALIGN_NO_POS_X)
608                                 v2d->cur.xmin += 2 * dx;
609                         else
610                                 v2d->cur.xmax -= 2 * dx;
611                 }
612                 else {
613                         if (U.uiflag & USER_ZOOM_TO_MOUSEPOS) {
614                                 float mval_fac = (vzd->mx_2d - v2d->cur.xmin) / BLI_rctf_size_x(&v2d->cur);
615                                 float mval_faci = 1.0f - mval_fac;
616                                 float ofs = (mval_fac * dx) - (mval_faci * dx);
617                                 
618                                 v2d->cur.xmin += ofs + dx;
619                                 v2d->cur.xmax += ofs - dx;
620                         }
621                         else {
622                                 v2d->cur.xmin += dx;
623                                 v2d->cur.xmax -= dx;
624                         }
625                 }
626         }
627         if ((v2d->keepzoom & V2D_LOCKZOOM_Y) == 0) {
628                 if (v2d->keepofs & V2D_LOCKOFS_Y) {
629                         v2d->cur.ymax -= 2 * dy;
630                 }
631                 else if (v2d->keepofs & V2D_KEEPOFS_Y) {
632                         if (v2d->align & V2D_ALIGN_NO_POS_Y)
633                                 v2d->cur.ymin += 2 * dy;
634                         else
635                                 v2d->cur.ymax -= 2 * dy;
636                 }
637                 else {
638                         if (U.uiflag & USER_ZOOM_TO_MOUSEPOS) {
639                                 float mval_fac = (vzd->my_2d - v2d->cur.ymin) / BLI_rctf_size_y(&v2d->cur);
640                                 float mval_faci = 1.0f - mval_fac;
641                                 float ofs = (mval_fac * dy) - (mval_faci * dy);
642                                 
643                                 v2d->cur.ymin += ofs + dy;
644                                 v2d->cur.ymax += ofs - dy;
645                         }
646                         else {
647                                 v2d->cur.ymin += dy;
648                                 v2d->cur.ymax -= dy;
649                         }
650                 }
651         }
652
653         /* validate that view is in valid configuration after this operation */
654         UI_view2d_curRect_validate(v2d);
655
656         /* request updates to be done... */
657         ED_region_tag_redraw(vzd->ar);
658         UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
659 }
660
661 /* --------------- Individual Operators ------------------- */
662
663 /* cleanup temp customdata  */
664 static void view_zoomstep_exit(wmOperator *op)
665 {
666         if (op->customdata) {
667                 MEM_freeN(op->customdata);
668                 op->customdata = NULL;
669         }
670 }
671
672 /* this operator only needs this single callback, where it calls the view_zoom_*() methods */
673 static int view_zoomin_exec(bContext *C, wmOperator *op)
674 {
675         ScrArea *sa = CTX_wm_area(C);
676         short do_zoom_x = TRUE;
677         short do_zoom_y = TRUE;
678
679         /* check that there's an active region, as View2D data resides there */
680         if (!view_zoom_poll(C))
681                 return OPERATOR_PASS_THROUGH;
682         
683         /* default not to zoom the sequencer vertically */
684         if (sa && sa->spacetype == SPACE_SEQ) {
685                 ARegion *ar = CTX_wm_region(C);
686
687                 if (ar && ar->regiontype != RGN_TYPE_PREVIEW)
688                         do_zoom_y = FALSE;
689         }
690
691         /* set RNA-Props - zooming in by uniform factor */
692         RNA_float_set(op->ptr, "zoomfacx", do_zoom_x ? 0.0375f : 0.0f);
693         RNA_float_set(op->ptr, "zoomfacy", do_zoom_y ? 0.0375f : 0.0f);
694         
695         /* apply movement, then we're done */
696         view_zoomstep_apply(C, op);
697         
698         view_zoomstep_exit(op);
699         
700         return OPERATOR_FINISHED;
701 }
702
703 static int view_zoomin_invoke(bContext *C, wmOperator *op, wmEvent *event)
704 {
705         v2dViewZoomData *vzd;
706         
707         if (!view_zoomdrag_init(C, op))
708                 return OPERATOR_PASS_THROUGH;
709         
710         vzd = op->customdata;
711         
712         if (U.uiflag & USER_ZOOM_TO_MOUSEPOS) {
713                 ARegion *ar = CTX_wm_region(C);
714                 
715                 /* store initial mouse position (in view space) */
716                 UI_view2d_region_to_view(&ar->v2d, 
717                                          event->mval[0], event->mval[1],
718                                          &vzd->mx_2d, &vzd->my_2d);
719         }
720         
721         return view_zoomin_exec(C, op);
722 }
723
724 static void VIEW2D_OT_zoom_in(wmOperatorType *ot)
725 {
726         /* identifiers */
727         ot->name = "Zoom In";
728         ot->description = "Zoom in the view";
729         ot->idname = "VIEW2D_OT_zoom_in";
730         
731         /* api callbacks */
732         ot->invoke = view_zoomin_invoke;
733         ot->exec = view_zoomin_exec;  // XXX, needs view_zoomdrag_init called first.
734         ot->poll = view_zoom_poll;
735         
736         /* rna - must keep these in sync with the other operators */
737         RNA_def_float(ot->srna, "zoomfacx", 0, -FLT_MAX, FLT_MAX, "Zoom Factor X", "", -FLT_MAX, FLT_MAX);
738         RNA_def_float(ot->srna, "zoomfacy", 0, -FLT_MAX, FLT_MAX, "Zoom Factor Y", "", -FLT_MAX, FLT_MAX);
739 }
740         
741 /* this operator only needs this single callback, where it callsthe view_zoom_*() methods */
742 static int view_zoomout_exec(bContext *C, wmOperator *op)
743 {
744         ScrArea *sa = CTX_wm_area(C);
745         short do_zoom_x = TRUE;
746         short do_zoom_y = TRUE;
747
748         /* check that there's an active region, as View2D data resides there */
749         if (!view_zoom_poll(C))
750                 return OPERATOR_PASS_THROUGH;
751         
752         /* default not to zoom the sequencer vertically */
753         if (sa && sa->spacetype == SPACE_SEQ) {
754                 ARegion *ar = CTX_wm_region(C);
755
756                 if (ar && ar->regiontype != RGN_TYPE_PREVIEW)
757                         do_zoom_y = FALSE;
758         }
759
760         /* set RNA-Props - zooming in by uniform factor */
761         RNA_float_set(op->ptr, "zoomfacx", do_zoom_x ? -0.0375f : 0.0f);
762         RNA_float_set(op->ptr, "zoomfacy", do_zoom_y ? -0.0375f : 0.0f);
763         
764         /* apply movement, then we're done */
765         view_zoomstep_apply(C, op);
766
767         view_zoomstep_exit(op);
768         
769         return OPERATOR_FINISHED;
770 }
771
772 static int view_zoomout_invoke(bContext *C, wmOperator *op, wmEvent *event)
773 {
774         v2dViewZoomData *vzd;
775         
776         if (!view_zoomdrag_init(C, op))
777                 return OPERATOR_PASS_THROUGH;
778
779         vzd = op->customdata;
780         
781         if (U.uiflag & USER_ZOOM_TO_MOUSEPOS) {
782                 ARegion *ar = CTX_wm_region(C);
783                 
784                 /* store initial mouse position (in view space) */
785                 UI_view2d_region_to_view(&ar->v2d, 
786                                          event->mval[0], event->mval[1],
787                                          &vzd->mx_2d, &vzd->my_2d);
788         }
789         
790         return view_zoomout_exec(C, op);
791 }
792
793 static void VIEW2D_OT_zoom_out(wmOperatorType *ot)
794 {
795         /* identifiers */
796         ot->name = "Zoom Out";
797         ot->description = "Zoom out the view";
798         ot->idname = "VIEW2D_OT_zoom_out";
799         
800         /* api callbacks */
801         ot->invoke = view_zoomout_invoke;
802 //      ot->exec = view_zoomout_exec; // XXX, needs view_zoomdrag_init called first.
803         ot->poll = view_zoom_poll;
804         
805         /* rna - must keep these in sync with the other operators */
806         RNA_def_float(ot->srna, "zoomfacx", 0, -FLT_MAX, FLT_MAX, "Zoom Factor X", "", -FLT_MAX, FLT_MAX);
807         RNA_def_float(ot->srna, "zoomfacy", 0, -FLT_MAX, FLT_MAX, "Zoom Factor Y", "", -FLT_MAX, FLT_MAX);
808 }
809
810 /* ********************************************************* */
811 /* DRAG-ZOOM OPERATOR                                                                    */
812
813 /*  MMB Drag - allows non-uniform scaling by dragging mouse
814  *
815  *      In order to make sure this works, each operator must define the following RNA-Operator Props:
816  *              deltax, deltay  - amounts to add to each side of the 'cur' rect
817  */
818
819 /* apply transform to view (i.e. adjust 'cur' rect) */
820 static void view_zoomdrag_apply(bContext *C, wmOperator *op)
821 {
822         v2dViewZoomData *vzd = op->customdata;
823         View2D *v2d = vzd->v2d;
824         float dx, dy;
825         
826         /* get amount to move view by */
827         dx = RNA_float_get(op->ptr, "deltax");
828         dy = RNA_float_get(op->ptr, "deltay");
829
830         if (U.uiflag & USER_ZOOM_INVERT) {
831                 dx *= -1;
832                 dy *= -1;
833         }
834         
835         /* continuous zoom shouldn't move that fast... */
836         if (U.viewzoom == USER_ZOOM_CONT) { // XXX store this setting as RNA prop?
837                 double time = PIL_check_seconds_timer();
838                 float time_step = (float)(time - vzd->timer_lastdraw);
839
840                 dx *= time_step * 0.5f;
841                 dy *= time_step * 0.5f;
842                 
843                 vzd->timer_lastdraw = time;
844         }
845
846         /* only move view on an axis if change is allowed */
847         if ((v2d->keepzoom & V2D_LOCKZOOM_X) == 0) {
848                 if (v2d->keepofs & V2D_LOCKOFS_X) {
849                         v2d->cur.xmax -= 2 * dx;
850                 }
851                 else {
852                         if (U.uiflag & USER_ZOOM_TO_MOUSEPOS) {
853                                 float mval_fac = (vzd->mx_2d - v2d->cur.xmin) / BLI_rctf_size_x(&v2d->cur);
854                                 float mval_faci = 1.0f - mval_fac;
855                                 float ofs = (mval_fac * dx) - (mval_faci * dx);
856                                 
857                                 v2d->cur.xmin += ofs + dx;
858                                 v2d->cur.xmax += ofs - dx;
859                         }
860                         else {
861                                 v2d->cur.xmin += dx;
862                                 v2d->cur.xmax -= dx;
863                         }
864                 }
865         }
866         if ((v2d->keepzoom & V2D_LOCKZOOM_Y) == 0) {
867                 if (v2d->keepofs & V2D_LOCKOFS_Y) {
868                         v2d->cur.ymax -= 2 * dy;
869                 }
870                 else {
871                         if (U.uiflag & USER_ZOOM_TO_MOUSEPOS) {
872                                 float mval_fac = (vzd->my_2d - v2d->cur.ymin) / BLI_rctf_size_y(&v2d->cur);
873                                 float mval_faci = 1.0f - mval_fac;
874                                 float ofs = (mval_fac * dy) - (mval_faci * dy);
875                                 
876                                 v2d->cur.ymin += ofs + dy;
877                                 v2d->cur.ymax += ofs - dy;
878                         }
879                         else {
880                                 v2d->cur.ymin += dy;
881                                 v2d->cur.ymax -= dy;
882                         }
883                 }
884         }
885         
886         /* validate that view is in valid configuration after this operation */
887         UI_view2d_curRect_validate(v2d);
888         
889         /* request updates to be done... */
890         ED_region_tag_redraw(vzd->ar);
891         UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
892 }
893
894 /* cleanup temp customdata  */
895 static void view_zoomdrag_exit(bContext *C, wmOperator *op)
896 {
897         if (op->customdata) {
898                 v2dViewZoomData *vzd = op->customdata;
899                 
900                 if (vzd->timer)
901                         WM_event_remove_timer(CTX_wm_manager(C), CTX_wm_window(C), vzd->timer);
902                 
903                 MEM_freeN(op->customdata);
904                 op->customdata = NULL;
905         }
906
907
908 static int view_zoomdrag_cancel(bContext *C, wmOperator *op)
909 {
910         view_zoomdrag_exit(C, op);
911
912         return OPERATOR_CANCELLED;
913 }
914
915 /* for 'redo' only, with no user input */
916 static int view_zoomdrag_exec(bContext *C, wmOperator *op)
917 {
918         if (!view_zoomdrag_init(C, op))
919                 return OPERATOR_PASS_THROUGH;
920         
921         view_zoomdrag_apply(C, op);
922         view_zoomdrag_exit(C, op);
923         return OPERATOR_FINISHED;
924 }
925
926 /* set up modal operator and relevant settings */
927 static int view_zoomdrag_invoke(bContext *C, wmOperator *op, wmEvent *event)
928 {
929         wmWindow *window = CTX_wm_window(C);
930         v2dViewZoomData *vzd;
931         View2D *v2d;
932         
933         /* set up customdata */
934         if (!view_zoomdrag_init(C, op))
935                 return OPERATOR_PASS_THROUGH;
936         
937         vzd = op->customdata;
938         v2d = vzd->v2d;
939         
940         if (event->type == MOUSEZOOM) {
941                 float dx, dy, fac;
942                 
943                 vzd->lastx = event->prevx;
944                 vzd->lasty = event->prevy;
945                 
946                 /* As we have only 1D information (magnify value), feed both axes
947                  * with magnify information that is stored in x axis 
948                  */
949                 fac = 0.01f * (event->x - event->prevx);
950                 dx = fac * BLI_rctf_size_x(&v2d->cur) / 10.0f;
951                 dy = fac * BLI_rctf_size_y(&v2d->cur) / 10.0f;
952
953                 RNA_float_set(op->ptr, "deltax", dx);
954                 RNA_float_set(op->ptr, "deltay", dy);
955                 
956                 view_zoomdrag_apply(C, op);
957                 view_zoomdrag_exit(C, op);
958                 return OPERATOR_FINISHED;
959         }
960         
961         /* set initial settings */
962         vzd->lastx = event->x;
963         vzd->lasty = event->y;
964         RNA_float_set(op->ptr, "deltax", 0);
965         RNA_float_set(op->ptr, "deltay", 0);
966         
967         /* for modal exit test */
968         vzd->invoke_event = event->type;
969         
970         if (U.uiflag & USER_ZOOM_TO_MOUSEPOS) {
971                 ARegion *ar = CTX_wm_region(C);
972                 
973                 /* store initial mouse position (in view space) */
974                 UI_view2d_region_to_view(&ar->v2d, 
975                                          event->mval[0], event->mval[1],
976                                          &vzd->mx_2d, &vzd->my_2d);
977         }
978
979         if (v2d->keepofs & V2D_LOCKOFS_X)
980                 WM_cursor_modal(window, BC_NS_SCROLLCURSOR);
981         else if (v2d->keepofs & V2D_LOCKOFS_Y)
982                 WM_cursor_modal(window, BC_EW_SCROLLCURSOR);
983         else
984                 WM_cursor_modal(window, BC_NSEW_SCROLLCURSOR);
985         
986         /* add temp handler */
987         WM_event_add_modal_handler(C, op);
988
989         if (U.viewzoom == USER_ZOOM_CONT) {
990                 /* needs a timer to continue redrawing */
991                 vzd->timer = WM_event_add_timer(CTX_wm_manager(C), CTX_wm_window(C), TIMER, 0.01f);
992                 vzd->timer_lastdraw = PIL_check_seconds_timer();
993         }
994
995         return OPERATOR_RUNNING_MODAL;
996 }
997
998 /* handle user input - calculations of mouse-movement need to be done here, not in the apply callback! */
999 static int view_zoomdrag_modal(bContext *C, wmOperator *op, wmEvent *event)
1000 {
1001         v2dViewZoomData *vzd = op->customdata;
1002         View2D *v2d = vzd->v2d;
1003         
1004         /* execute the events */
1005         if (event->type == TIMER && event->customdata == vzd->timer) {
1006                 view_zoomdrag_apply(C, op);
1007         }
1008         else if (event->type == MOUSEMOVE) {
1009                 float dx, dy;
1010                 
1011                 /* calculate new delta transform, based on zooming mode */
1012                 if (U.viewzoom == USER_ZOOM_SCALE) {
1013                         /* 'scale' zooming */
1014                         float dist;
1015                         
1016                         /* x-axis transform */
1017                         dist = BLI_rcti_size_x(&v2d->mask) / 2.0f;
1018                         dx = 1.0f - (fabsf(vzd->lastx - dist) + 2.0f) / (fabsf(event->x - dist) + 2.0f);
1019                         dx *= 0.5f * BLI_rctf_size_x(&v2d->cur);
1020                         
1021                         /* y-axis transform */
1022                         dist = BLI_rcti_size_y(&v2d->mask) / 2.0f;
1023                         dy = 1.0f - (fabsf(vzd->lasty - dist) + 2.0f) / (fabsf(event->y - dist) + 2.0f);
1024                         dy *= 0.5f * BLI_rctf_size_y(&v2d->cur);
1025                 }
1026                 else {
1027                         /* 'continuous' or 'dolly' */
1028                         float fac;
1029                         
1030                         /* x-axis transform */
1031                         fac = 0.01f * (event->x - vzd->lastx);
1032                         dx = fac * BLI_rctf_size_x(&v2d->cur);
1033                         
1034                         /* y-axis transform */
1035                         fac = 0.01f * (event->y - vzd->lasty);
1036                         dy = fac * BLI_rctf_size_y(&v2d->cur);
1037 #if 0
1038                         /* continuous zoom shouldn't move that fast... */
1039                         if (U.viewzoom == USER_ZOOM_CONT) { // XXX store this setting as RNA prop?
1040                                 double time = PIL_check_seconds_timer();
1041                                 float time_step = (float)(time - vzd->timer_lastdraw);
1042
1043                                 dx /= (0.1f / time_step);
1044                                 dy /= (0.1f / time_step);
1045                                 
1046                                 vzd->timer_lastdraw = time;
1047                         }
1048 #endif
1049                 }
1050                 
1051                 /* set transform amount, and add current deltas to stored total delta (for redo) */
1052                 RNA_float_set(op->ptr, "deltax", dx);
1053                 RNA_float_set(op->ptr, "deltay", dy);
1054
1055                 vzd->dx += dx;
1056                 vzd->dy += dy;
1057                 
1058                 /* store mouse coordinates for next time, if not doing continuous zoom
1059                  *      - continuous zoom only depends on distance of mouse to starting point to determine rate of change
1060                  */
1061                 if (U.viewzoom != USER_ZOOM_CONT) { // XXX store this setting as RNA prop?
1062                         vzd->lastx = event->x;
1063                         vzd->lasty = event->y;
1064                 }
1065                 
1066                 /* apply zooming */
1067                 view_zoomdrag_apply(C, op);
1068         }
1069         else if (event->type == vzd->invoke_event || event->type == ESCKEY) {
1070                 if (event->val == KM_RELEASE) {
1071                         
1072                         /* for redo, store the overall deltas - need to respect zoom-locks here... */
1073                         if ((v2d->keepzoom & V2D_LOCKZOOM_X) == 0)
1074                                 RNA_float_set(op->ptr, "deltax", vzd->dx);
1075                         else
1076                                 RNA_float_set(op->ptr, "deltax", 0);
1077                                 
1078                         if ((v2d->keepzoom & V2D_LOCKZOOM_Y) == 0)
1079                                 RNA_float_set(op->ptr, "deltay", vzd->dy);
1080                         else
1081                                 RNA_float_set(op->ptr, "deltay", 0);
1082                         
1083                         /* free customdata */
1084                         view_zoomdrag_exit(C, op);
1085                         WM_cursor_restore(CTX_wm_window(C));
1086                         
1087                         return OPERATOR_FINISHED;
1088                 }
1089         }
1090
1091         return OPERATOR_RUNNING_MODAL;
1092 }
1093
1094 static void VIEW2D_OT_zoom(wmOperatorType *ot)
1095 {
1096         /* identifiers */
1097         ot->name = "Zoom 2D View";
1098         ot->description = "Zoom in/out the view";
1099         ot->idname = "VIEW2D_OT_zoom";
1100         
1101         /* api callbacks */
1102         ot->exec = view_zoomdrag_exec;
1103         ot->invoke = view_zoomdrag_invoke;
1104         ot->modal = view_zoomdrag_modal;
1105         ot->cancel = view_zoomdrag_cancel;
1106         
1107         ot->poll = view_zoom_poll;
1108         
1109         /* operator is repeatable */
1110         // ot->flag = OPTYPE_BLOCKING;
1111         
1112         /* rna - must keep these in sync with the other operators */
1113         RNA_def_float(ot->srna, "deltax", 0, -FLT_MAX, FLT_MAX, "Delta X", "", -FLT_MAX, FLT_MAX);
1114         RNA_def_float(ot->srna, "deltay", 0, -FLT_MAX, FLT_MAX, "Delta Y", "", -FLT_MAX, FLT_MAX);
1115 }
1116
1117 /* ********************************************************* */
1118 /* BORDER-ZOOM */
1119
1120 /* The user defines a rect using standard borderselect tools, and we use this rect to 
1121  * define the new zoom-level of the view in the following ways:
1122  *      1) LEFTMOUSE - zoom in to view
1123  *      2) RIGHTMOUSE - zoom out of view
1124  *
1125  * Currently, these key mappings are hardcoded, but it shouldn't be too important to
1126  * have custom keymappings for this...
1127  */
1128  
1129 static int view_borderzoom_exec(bContext *C, wmOperator *op)
1130 {
1131         ARegion *ar = CTX_wm_region(C);
1132         View2D *v2d = &ar->v2d;
1133         rctf rect;
1134         rctf cur_new = v2d->cur;
1135         int gesture_mode;
1136         
1137         /* convert coordinates of rect to 'tot' rect coordinates */
1138         UI_view2d_region_to_view(v2d, RNA_int_get(op->ptr, "xmin"), RNA_int_get(op->ptr, "ymin"), &rect.xmin, &rect.ymin);
1139         UI_view2d_region_to_view(v2d, RNA_int_get(op->ptr, "xmax"), RNA_int_get(op->ptr, "ymax"), &rect.xmax, &rect.ymax);
1140         
1141         /* check if zooming in/out view */
1142         gesture_mode = RNA_int_get(op->ptr, "gesture_mode");
1143         
1144         if (gesture_mode == GESTURE_MODAL_IN) {
1145                 /* zoom in: 
1146                  *      - 'cur' rect will be defined by the coordinates of the border region 
1147                  *      - just set the 'cur' rect to have the same coordinates as the border region
1148                  *        if zoom is allowed to be changed
1149                  */
1150                 if ((v2d->keepzoom & V2D_LOCKZOOM_X) == 0) {
1151                         cur_new.xmin = rect.xmin;
1152                         cur_new.xmax = rect.xmax;
1153                 }
1154                 if ((v2d->keepzoom & V2D_LOCKZOOM_Y) == 0) {
1155                         cur_new.ymin = rect.ymin;
1156                         cur_new.ymax = rect.ymax;
1157                 }
1158         }
1159         else { /* if (gesture_mode == GESTURE_MODAL_OUT) */
1160
1161                 /* zoom out:
1162                  *      - the current 'cur' rect coordinates are going to end up where the 'rect' ones are,
1163                  *        but the 'cur' rect coordinates will need to be adjusted to take in more of the view
1164                  *      - calculate zoom factor, and adjust using center-point
1165                  */
1166                 float zoom, center, size;
1167                 
1168                 /* TODO: is this zoom factor calculation valid? It seems to produce same results everytime... */
1169                 if ((v2d->keepzoom & V2D_LOCKZOOM_X) == 0) {
1170                         size = BLI_rctf_size_x(&cur_new);
1171                         zoom = size / BLI_rctf_size_x(&rect);
1172                         center = BLI_rctf_cent_x(&cur_new);
1173                         
1174                         cur_new.xmin = center - (size * zoom);
1175                         cur_new.xmax = center + (size * zoom);
1176                 }
1177                 if ((v2d->keepzoom & V2D_LOCKZOOM_Y) == 0) {
1178                         size = BLI_rctf_size_y(&cur_new);
1179                         zoom = size / BLI_rctf_size_y(&rect);
1180                         center = BLI_rctf_cent_y(&cur_new);
1181                         
1182                         cur_new.ymin = center - (size * zoom);
1183                         cur_new.ymax = center + (size * zoom);
1184                 }
1185         }
1186         
1187         UI_view2d_smooth_view(C, ar, &cur_new);
1188         
1189         return OPERATOR_FINISHED;
1190
1191
1192 static void VIEW2D_OT_zoom_border(wmOperatorType *ot)
1193 {
1194         /* identifiers */
1195         ot->name = "Zoom to Border";
1196         ot->description = "Zoom in the view to the nearest item contained in the border";
1197         ot->idname = "VIEW2D_OT_zoom_border";
1198         
1199         /* api callbacks */
1200         ot->invoke = WM_border_select_invoke;
1201         ot->exec = view_borderzoom_exec;
1202         ot->modal = WM_border_select_modal;
1203         ot->cancel = WM_border_select_cancel;
1204         
1205         ot->poll = view_zoom_poll;
1206         
1207         /* rna */
1208         WM_operator_properties_gesture_border(ot, FALSE);
1209 }
1210
1211 /* ********************************************************* */
1212 /* SMOOTH VIEW */
1213
1214 struct SmoothView2DStore {
1215         rctf orig_cur, new_cur;
1216
1217         double time_allowed;
1218 };
1219
1220 /**
1221  * function to get a factor out of a rectangle
1222  *
1223  * note: this doesn't always work as well as it might because the target size
1224  *       may not be reached because of clamping the desired rect, we _could_
1225  *       attempt to clamp the rect before working out the zoom factor but its
1226  *       not really worthwhile for the few cases this happens.
1227  */
1228 static float smooth_view_rect_to_fac(const rctf *rect_a, const rctf *rect_b)
1229 {
1230         float size_a[2] = {BLI_rctf_size_x(rect_a),
1231                            BLI_rctf_size_y(rect_a)};
1232         float size_b[2] = {BLI_rctf_size_x(rect_b),
1233                            BLI_rctf_size_y(rect_b)};
1234         float cent_a[2] = {BLI_rctf_cent_x(rect_a),
1235                            BLI_rctf_cent_y(rect_a)};
1236         float cent_b[2] = {BLI_rctf_cent_x(rect_b),
1237                            BLI_rctf_cent_y(rect_b)};
1238
1239         float fac_max = 0.0f;
1240         float tfac;
1241
1242         int i;
1243
1244         for (i = 0; i < 2; i++) {
1245                 /* axis translation normalized to scale */
1246                 tfac = fabsf(cent_a[i] - cent_b[i]) / min_ff(size_a[i], size_b[i]);
1247                 fac_max = max_ff(fac_max, tfac);
1248                 if (fac_max >= 1.0f) break;
1249
1250                 /* axis scale difference, x2 so doubling or half gives 1.0f */
1251                 tfac = (1.0f - (min_ff(size_a[i], size_b[i]) / max_ff(size_a[i], size_b[i]))) * 2.0f;
1252                 fac_max = max_ff(fac_max, tfac);
1253                 if (fac_max >= 1.0f) break;
1254         }
1255         return min_ff(fac_max, 1.0f);
1256 }
1257
1258 /* will start timer if appropriate */
1259 /* the arguments are the desired situation */
1260 void UI_view2d_smooth_view(bContext *C, ARegion *ar,
1261                            const rctf *cur)
1262 {
1263         wmWindowManager *wm = CTX_wm_manager(C);
1264         wmWindow *win = CTX_wm_window(C);
1265
1266         View2D *v2d = &ar->v2d;
1267         struct SmoothView2DStore sms = {{0}};
1268         short ok = FALSE;
1269         float fac = 1.0f;
1270
1271         /* initialize sms */
1272         sms.new_cur = v2d->cur;
1273
1274         /* store the options we want to end with */
1275         if (cur) sms.new_cur = *cur;
1276
1277         if (cur) {
1278                 fac = smooth_view_rect_to_fac(&v2d->cur, cur);
1279         }
1280
1281         if (C && U.smooth_viewtx && fac > FLT_EPSILON) {
1282                 int changed = FALSE;
1283
1284                 if (BLI_rctf_compare(&sms.new_cur, &v2d->cur, FLT_EPSILON) == FALSE)
1285                         changed = TRUE;
1286
1287                 /* The new view is different from the old one
1288                  * so animate the view */
1289                 if (changed) {
1290                         sms.orig_cur = v2d->cur;
1291
1292                         sms.time_allowed = (double)U.smooth_viewtx / 1000.0;
1293
1294                         /* scale the time allowed the change in view */
1295                         sms.time_allowed *= (double)fac;
1296
1297                         /* keep track of running timer! */
1298                         if (v2d->sms == NULL)
1299                                 v2d->sms = MEM_mallocN(sizeof(struct SmoothView2DStore), "smoothview v2d");
1300                         *v2d->sms = sms;
1301                         if (v2d->smooth_timer)
1302                                 WM_event_remove_timer(wm, win, v2d->smooth_timer);
1303                         /* TIMER1 is hardcoded in keymap */
1304                         v2d->smooth_timer = WM_event_add_timer(wm, win, TIMER1, 1.0 / 100.0); /* max 30 frs/sec */
1305
1306                         ok = TRUE;
1307                 }
1308         }
1309
1310         /* if we get here nothing happens */
1311         if (ok == FALSE) {
1312                 v2d->cur = sms.new_cur;
1313
1314                 UI_view2d_curRect_validate(v2d);
1315                 ED_region_tag_redraw(ar);
1316                 UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
1317         }
1318 }
1319
1320 /* only meant for timer usage */
1321 static int view2d_smoothview_invoke(bContext *C, wmOperator *UNUSED(op), wmEvent *event)
1322 {
1323         ARegion *ar = CTX_wm_region(C);
1324         View2D *v2d = &ar->v2d;
1325         struct SmoothView2DStore *sms = v2d->sms;
1326         float step;
1327
1328         /* escape if not our timer */
1329         if (v2d->smooth_timer == NULL || v2d->smooth_timer != event->customdata)
1330                 return OPERATOR_PASS_THROUGH;
1331
1332         if (sms->time_allowed != 0.0)
1333                 step = (float)((v2d->smooth_timer->duration) / sms->time_allowed);
1334         else
1335                 step = 1.0f;
1336
1337         /* end timer */
1338         if (step >= 1.0f) {
1339                 v2d->cur = sms->new_cur;
1340
1341                 MEM_freeN(v2d->sms);
1342                 v2d->sms = NULL;
1343
1344                 WM_event_remove_timer(CTX_wm_manager(C), CTX_wm_window(C), v2d->smooth_timer);
1345                 v2d->smooth_timer = NULL;
1346         }
1347         else {
1348                 /* ease in/out */
1349                 step = (3.0f * step * step - 2.0f * step * step * step);
1350
1351                 BLI_rctf_interp(&v2d->cur, &sms->orig_cur, &sms->new_cur, step);
1352         }
1353
1354         UI_view2d_curRect_validate(v2d);
1355         UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
1356         ED_region_tag_redraw(ar);
1357
1358         return OPERATOR_FINISHED;
1359 }
1360
1361 static void VIEW2D_OT_smoothview(wmOperatorType *ot)
1362 {
1363         /* identifiers */
1364         ot->name = "Smooth View 2D";
1365         ot->description = "Zoom in the view to the nearest item contained in the border";
1366         ot->idname = "VIEW2D_OT_smoothview";
1367
1368         /* api callbacks */
1369         ot->invoke = view2d_smoothview_invoke;
1370
1371         ot->poll = view2d_poll;
1372
1373         /* rna */
1374         WM_operator_properties_gesture_border(ot, FALSE);
1375 }
1376
1377 /* ********************************************************* */
1378 /* SCROLLERS */
1379
1380 /*  Scrollers should behave in the following ways, when clicked on with LMB (and dragged):
1381  *              1) 'Handles' on end of 'bubble' - when the axis that the scroller represents is zoomable, 
1382  *                      enlarge 'cur' rect on the relevant side 
1383  *              2) 'Bubble'/'bar' - just drag, and bar should move with mouse (view pans opposite)
1384  *
1385  *      In order to make sure this works, each operator must define the following RNA-Operator Props:
1386  *              deltax, deltay  - define how much to move view by (relative to zoom-correction factor)
1387  */
1388
1389 /* customdata for scroller-invoke data */
1390 typedef struct v2dScrollerMove {
1391         View2D *v2d;            /* View2D data that this operation affects */
1392         ARegion *ar;            /* region that the scroller is in */
1393         
1394         short scroller;         /* scroller that mouse is in ('h' or 'v') */
1395         short zone; /* -1 is min zoomer, 0 is bar, 1 is max zoomer */             // XXX find some way to provide visual feedback of this (active color?)
1396         
1397         float fac;              /* view adjustment factor, based on size of region */
1398         float delta;            /* amount moved by mouse on axis of interest */
1399         
1400         float scrollbarwidth;   /* width of the scrollbar itself, used for page up/down clicks */
1401         int scrollbar_orig;      /* initial location of scrollbar x/y, mouse relative */
1402         
1403         int lastx, lasty;       /* previous mouse coordinates (in screen coordinates) for determining movement */
1404 } v2dScrollerMove;
1405
1406
1407 /* View2DScrollers is typedef'd in UI_view2d.h 
1408  * This is a CUT DOWN VERSION of the 'real' version, which is defined in view2d.c, as we only need focus bubble info
1409  * WARNING: the start of this struct must not change, so that it stays in sync with the 'real' version
1410  *         For now, we don't need to have a separate (internal) header for structs like this...
1411  */
1412 struct View2DScrollers {        
1413         /* focus bubbles */
1414         int vert_min, vert_max; /* vertical scrollbar */
1415         int hor_min, hor_max;   /* horizontal scrollbar */
1416 };
1417
1418 /* quick enum for vsm->zone (scroller handles) */
1419 enum {
1420         SCROLLHANDLE_MIN = -1,
1421         SCROLLHANDLE_BAR,
1422         SCROLLHANDLE_MAX,
1423         SCROLLHANDLE_MIN_OUTSIDE,
1424         SCROLLHANDLE_MAX_OUTSIDE
1425 } /*eV2DScrollerHandle_Zone*/;
1426
1427 /* ------------------------ */
1428
1429 /* check if mouse is within scroller handle 
1430  *      - mouse                 =   relevant mouse coordinate in region space
1431  *      - sc_min, sc_max        =   extents of scroller 'groove' (potential available space for scroller)
1432  *      - sh_min, sh_max        =   positions of scrollbar handles
1433  */
1434 static short mouse_in_scroller_handle(int mouse, int sc_min, int sc_max, int sh_min, int sh_max)
1435 {
1436         short in_min, in_max, in_bar, out_min, out_max, in_view = 1;
1437         
1438         /* firstly, check if 
1439          *      - 'bubble' fills entire scroller 
1440          *      - 'bubble' completely out of view on either side 
1441          */
1442         if ((sh_min <= sc_min) && (sh_max >= sc_max)) in_view = 0;
1443         if (sh_min == sh_max) {
1444                 if (sh_min <= sc_min) in_view = 0;
1445                 if (sh_max >= sc_max) in_view = 0;
1446         }
1447         else {
1448                 if (sh_max <= sc_min) in_view = 0;
1449                 if (sh_min >= sc_max) in_view = 0;
1450         }
1451         
1452         
1453         if (in_view == 0) {
1454                 return SCROLLHANDLE_BAR;
1455         }
1456         
1457         /* check if mouse is in or past either handle */
1458         /* TODO: check if these extents are still valid or not */
1459         in_max = ( (mouse >= (sh_max - V2D_SCROLLER_HANDLE_SIZE)) && (mouse <= (sh_max + V2D_SCROLLER_HANDLE_SIZE)) );
1460         in_min = ( (mouse <= (sh_min + V2D_SCROLLER_HANDLE_SIZE)) && (mouse >= (sh_min - V2D_SCROLLER_HANDLE_SIZE)) );
1461         in_bar = ( (mouse < (sh_max - V2D_SCROLLER_HANDLE_SIZE)) && (mouse > (sh_min + V2D_SCROLLER_HANDLE_SIZE)) );
1462         out_min = mouse < (sh_min - V2D_SCROLLER_HANDLE_SIZE);
1463         out_max = mouse > (sh_max + V2D_SCROLLER_HANDLE_SIZE);
1464         
1465         if (in_bar)
1466                 return SCROLLHANDLE_BAR;
1467         else if (in_max)
1468                 return SCROLLHANDLE_MAX;
1469         else if (in_min)
1470                 return SCROLLHANDLE_MIN;
1471         else if (out_min)
1472                 return SCROLLHANDLE_MIN_OUTSIDE;
1473         else if (out_max)
1474                 return SCROLLHANDLE_MAX_OUTSIDE;
1475         
1476         /* unlikely to happen, though we just cover it in case */
1477         return SCROLLHANDLE_BAR;
1478
1479
1480 /* initialize customdata for scroller manipulation operator */
1481 static void scroller_activate_init(bContext *C, wmOperator *op, wmEvent *event, short in_scroller)
1482 {
1483         v2dScrollerMove *vsm;
1484         View2DScrollers *scrollers;
1485         ARegion *ar = CTX_wm_region(C);
1486         View2D *v2d = &ar->v2d;
1487         rctf tot_cur_union;
1488         float mask_size;
1489         
1490         /* set custom-data for operator */
1491         vsm = MEM_callocN(sizeof(v2dScrollerMove), "v2dScrollerMove");
1492         op->customdata = vsm;
1493         
1494         /* set general data */
1495         vsm->v2d = v2d;
1496         vsm->ar = ar;
1497         vsm->scroller = in_scroller;
1498
1499         /* store mouse-coordinates, and convert mouse/screen coordinates to region coordinates */
1500         vsm->lastx = event->x;
1501         vsm->lasty = event->y;
1502         /* 'zone' depends on where mouse is relative to bubble 
1503          *      - zooming must be allowed on this axis, otherwise, default to pan
1504          */
1505         scrollers = UI_view2d_scrollers_calc(C, v2d, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY);
1506
1507         /* use a union of 'cur' & 'tot' incase the current view is far outside 'tot'.
1508          * In this cases moving the scroll bars has far too little effect and the view can get stuck [#31476] */
1509         tot_cur_union = v2d->tot;
1510         BLI_rctf_union(&tot_cur_union, &v2d->cur);
1511
1512         if (in_scroller == 'h') {
1513                 /* horizontal scroller - calculate adjustment factor first */
1514                 mask_size = (float)BLI_rcti_size_x(&v2d->hor);
1515                 vsm->fac = BLI_rctf_size_x(&tot_cur_union) / mask_size;
1516                 
1517                 /* get 'zone' (i.e. which part of scroller is activated) */
1518                 vsm->zone = mouse_in_scroller_handle(event->mval[0],
1519                                                      v2d->hor.xmin, v2d->hor.xmax,
1520                                                      scrollers->hor_min, scrollers->hor_max);
1521                 
1522                 if ((v2d->keepzoom & V2D_LOCKZOOM_X) && ELEM(vsm->zone, SCROLLHANDLE_MIN, SCROLLHANDLE_MAX)) {
1523                         /* default to scroll, as handles not usable */
1524                         vsm->zone = SCROLLHANDLE_BAR;
1525                 }
1526
1527                 vsm->scrollbarwidth = scrollers->hor_max - scrollers->hor_min;
1528                 vsm->scrollbar_orig = ((scrollers->hor_max + scrollers->hor_min) / 2) + ar->winrct.xmin;
1529         }
1530         else {
1531                 /* vertical scroller - calculate adjustment factor first */
1532                 mask_size = (float)BLI_rcti_size_y(&v2d->vert);
1533                 vsm->fac = BLI_rctf_size_y(&tot_cur_union) / mask_size;
1534                 
1535                 /* get 'zone' (i.e. which part of scroller is activated) */
1536                 vsm->zone = mouse_in_scroller_handle(event->mval[1],
1537                                                      v2d->vert.ymin, v2d->vert.ymax,
1538                                                      scrollers->vert_min, scrollers->vert_max);
1539                         
1540                 if ((v2d->keepzoom & V2D_LOCKZOOM_Y) && ELEM(vsm->zone, SCROLLHANDLE_MIN, SCROLLHANDLE_MAX)) {
1541                         /* default to scroll, as handles not usable */
1542                         vsm->zone = SCROLLHANDLE_BAR;
1543                 }
1544                 
1545                 vsm->scrollbarwidth = scrollers->vert_max - scrollers->vert_min;
1546                 vsm->scrollbar_orig = ((scrollers->vert_max + scrollers->vert_min) / 2) + ar->winrct.ymin;
1547         }
1548         
1549         UI_view2d_scrollers_free(scrollers);
1550         ED_region_tag_redraw(ar);
1551 }
1552
1553 /* cleanup temp customdata  */
1554 static void scroller_activate_exit(bContext *C, wmOperator *op)
1555 {
1556         if (op->customdata) {
1557                 v2dScrollerMove *vsm = op->customdata;
1558
1559                 vsm->v2d->scroll_ui &= ~(V2D_SCROLL_H_ACTIVE | V2D_SCROLL_V_ACTIVE);
1560                 
1561                 MEM_freeN(op->customdata);
1562                 op->customdata = NULL;
1563                 
1564                 ED_region_tag_redraw(CTX_wm_region(C));
1565         }
1566 }
1567
1568 static int scroller_activate_cancel(bContext *C, wmOperator *op)
1569 {
1570         scroller_activate_exit(C, op);
1571
1572         return OPERATOR_CANCELLED;
1573 }
1574
1575 /* apply transform to view (i.e. adjust 'cur' rect) */
1576 static void scroller_activate_apply(bContext *C, wmOperator *op)
1577 {
1578         v2dScrollerMove *vsm = op->customdata;
1579         View2D *v2d = vsm->v2d;
1580         float temp;
1581         
1582         /* calculate amount to move view by */
1583         temp = vsm->fac * vsm->delta;
1584         
1585         /* type of movement */
1586         switch (vsm->zone) {
1587                 case SCROLLHANDLE_MIN:
1588                         /* only expand view on axis if zoom is allowed */
1589                         if ((vsm->scroller == 'h') && !(v2d->keepzoom & V2D_LOCKZOOM_X))
1590                                 v2d->cur.xmin -= temp;
1591                         if ((vsm->scroller == 'v') && !(v2d->keepzoom & V2D_LOCKZOOM_Y))
1592                                 v2d->cur.ymin -= temp;
1593                         break;
1594                         
1595                 case SCROLLHANDLE_MAX:
1596                         
1597                         /* only expand view on axis if zoom is allowed */
1598                         if ((vsm->scroller == 'h') && !(v2d->keepzoom & V2D_LOCKZOOM_X))
1599                                 v2d->cur.xmax += temp;
1600                         if ((vsm->scroller == 'v') && !(v2d->keepzoom & V2D_LOCKZOOM_Y))
1601                                 v2d->cur.ymax += temp;
1602                         break;
1603                         
1604                 case SCROLLHANDLE_MIN_OUTSIDE:
1605                 case SCROLLHANDLE_MAX_OUTSIDE:
1606                 case SCROLLHANDLE_BAR:
1607                 default:
1608                         /* only move view on an axis if panning is allowed */
1609                         if ((vsm->scroller == 'h') && !(v2d->keepofs & V2D_LOCKOFS_X)) {
1610                                 v2d->cur.xmin += temp;
1611                                 v2d->cur.xmax += temp;
1612                         }
1613                         if ((vsm->scroller == 'v') && !(v2d->keepofs & V2D_LOCKOFS_Y)) {
1614                                 v2d->cur.ymin += temp;
1615                                 v2d->cur.ymax += temp;
1616                         }
1617                         break;
1618                         
1619         }
1620         
1621         /* validate that view is in valid configuration after this operation */
1622         UI_view2d_curRect_validate(v2d);
1623         
1624         /* request updates to be done... */
1625         ED_region_tag_redraw(vsm->ar);
1626         UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
1627 }
1628
1629 /* handle user input for scrollers - calculations of mouse-movement need to be done here, not in the apply callback! */
1630 static int scroller_activate_modal(bContext *C, wmOperator *op, wmEvent *event)
1631 {
1632         v2dScrollerMove *vsm = op->customdata;
1633         
1634         /* execute the events */
1635         switch (event->type) {
1636                 case MOUSEMOVE:
1637                 {
1638                         /* calculate new delta transform, then store mouse-coordinates for next-time */
1639                         if (ELEM(vsm->zone, SCROLLHANDLE_BAR, SCROLLHANDLE_MAX)) {
1640                                 /* if using bar (i.e. 'panning') or 'max' zoom widget */
1641                                 switch (vsm->scroller) {
1642                                         case 'h': /* horizontal scroller - so only horizontal movement ('cur' moves opposite to mouse) */
1643                                                 vsm->delta = (float)(event->x - vsm->lastx);
1644                                                 break;
1645                                         case 'v': /* vertical scroller - so only vertical movement ('cur' moves opposite to mouse) */
1646                                                 vsm->delta = (float)(event->y - vsm->lasty);
1647                                                 break;
1648                                 }
1649                         }
1650                         else if (vsm->zone == SCROLLHANDLE_MIN) {
1651                                 /* using 'min' zoom widget */
1652                                 switch (vsm->scroller) {
1653                                         case 'h': /* horizontal scroller - so only horizontal movement ('cur' moves with mouse) */
1654                                                 vsm->delta = (float)(vsm->lastx - event->x);
1655                                                 break;
1656                                         case 'v': /* vertical scroller - so only vertical movement ('cur' moves with to mouse) */
1657                                                 vsm->delta = (float)(vsm->lasty - event->y);
1658                                                 break;
1659                                 }
1660                         }
1661                         
1662                         /* store previous coordinates */
1663                         vsm->lastx = event->x;
1664                         vsm->lasty = event->y;
1665                         
1666                         scroller_activate_apply(C, op);
1667                 }
1668                 break;
1669                         
1670                 case LEFTMOUSE:
1671                 case MIDDLEMOUSE:
1672                         if (event->val == KM_RELEASE) {
1673                                 /* single-click was in empty space outside bubble, so scroll by 1 'page' */
1674                                 if (ELEM(vsm->zone, SCROLLHANDLE_MIN_OUTSIDE, SCROLLHANDLE_MAX_OUTSIDE)) {
1675                                         if (vsm->zone == SCROLLHANDLE_MIN_OUTSIDE)
1676                                                 vsm->delta = -vsm->scrollbarwidth * 0.8f;
1677                                         else if (vsm->zone == SCROLLHANDLE_MAX_OUTSIDE)
1678                                                 vsm->delta = vsm->scrollbarwidth * 0.8f;
1679                                         
1680                                         scroller_activate_apply(C, op);
1681                                         scroller_activate_exit(C, op);
1682                                         return OPERATOR_FINISHED;
1683                                 }
1684                                 
1685                                 /* otherwise, end the drag action  */
1686                                 if (vsm->lastx || vsm->lasty) {
1687                                         scroller_activate_exit(C, op);
1688                                         return OPERATOR_FINISHED;
1689                                 }
1690                         }
1691                         break;
1692
1693         }
1694
1695         return OPERATOR_RUNNING_MODAL;
1696 }
1697
1698
1699 /* a click (or click drag in progress) should have occurred, so check if it happened in scrollbar */
1700 static int scroller_activate_invoke(bContext *C, wmOperator *op, wmEvent *event)
1701 {
1702         ARegion *ar = CTX_wm_region(C);
1703         View2D *v2d = &ar->v2d;
1704         short in_scroller = 0;
1705                 
1706         /* check if mouse in scrollbars, if they're enabled */
1707         in_scroller = UI_view2d_mouse_in_scrollers(C, v2d, event->x, event->y);
1708         
1709         /* if in a scroller, init customdata then set modal handler which will catch mousedown to start doing useful stuff */
1710         if (in_scroller) {
1711                 v2dScrollerMove *vsm;
1712                 
1713                 /* initialize customdata */
1714                 scroller_activate_init(C, op, event, in_scroller);
1715                 vsm = (v2dScrollerMove *)op->customdata;
1716                 
1717                 /* support for quick jump to location - gtk and qt do this on linux */
1718                 if (event->type == MIDDLEMOUSE) {
1719                         switch (vsm->scroller) {
1720                                 case 'h': /* horizontal scroller - so only horizontal movement ('cur' moves opposite to mouse) */
1721                                         vsm->delta = (float)(event->x - vsm->scrollbar_orig);
1722                                         break;
1723                                 case 'v': /* vertical scroller - so only vertical movement ('cur' moves opposite to mouse) */
1724                                         vsm->delta = (float)(event->y - vsm->scrollbar_orig);
1725                                         break;
1726                         }
1727                         scroller_activate_apply(C, op);
1728
1729                         vsm->zone = SCROLLHANDLE_BAR;
1730                 }
1731
1732                 /* check if zoom zones are inappropriate (i.e. zoom widgets not shown), so cannot continue
1733                  * NOTE: see view2d.c for latest conditions, and keep this in sync with that
1734                  */
1735                 if (ELEM(vsm->zone, SCROLLHANDLE_MIN, SCROLLHANDLE_MAX)) {
1736                         if (((vsm->scroller == 'h') && (v2d->scroll & V2D_SCROLL_SCALE_HORIZONTAL) == 0) ||
1737                             ((vsm->scroller == 'v') && (v2d->scroll & V2D_SCROLL_SCALE_VERTICAL) == 0))
1738                         {
1739                                 /* switch to bar (i.e. no scaling gets handled) */
1740                                 vsm->zone = SCROLLHANDLE_BAR;
1741                         }
1742                 }
1743                 
1744                 /* check if zone is inappropriate (i.e. 'bar' but panning is banned), so cannot continue */
1745                 if (vsm->zone == SCROLLHANDLE_BAR) {
1746                         if (((vsm->scroller == 'h') && (v2d->keepofs & V2D_LOCKOFS_X)) ||
1747                             ((vsm->scroller == 'v') && (v2d->keepofs & V2D_LOCKOFS_Y)))
1748                         {
1749                                 /* free customdata initialized */
1750                                 scroller_activate_exit(C, op);
1751                                 
1752                                 /* can't catch this event for ourselves, so let it go to someone else? */
1753                                 return OPERATOR_PASS_THROUGH;
1754                         }
1755                 }
1756                 
1757                 /* zone is also inappropriate if scroller is not visible... */
1758                 if (((vsm->scroller == 'h') && (v2d->scroll & (V2D_SCROLL_HORIZONTAL_HIDE | V2D_SCROLL_HORIZONTAL_FULLR))) ||
1759                     ((vsm->scroller == 'v') && (v2d->scroll & (V2D_SCROLL_VERTICAL_HIDE | V2D_SCROLL_VERTICAL_FULLR))) )
1760                 {
1761                         /* free customdata initialized */
1762                         scroller_activate_exit(C, op);
1763                                 
1764                         /* can't catch this event for ourselves, so let it go to someone else? */
1765                         /* XXX note: if handlers use mask rect to clip input, input will fail for this case */
1766                         return OPERATOR_PASS_THROUGH;
1767                 }
1768                 
1769                 /* activate the scroller */
1770                 if (vsm->scroller == 'h')
1771                         v2d->scroll_ui |= V2D_SCROLL_H_ACTIVE;
1772                 else
1773                         v2d->scroll_ui |= V2D_SCROLL_V_ACTIVE;
1774                 
1775                 /* still ok, so can add */
1776                 WM_event_add_modal_handler(C, op);
1777                 return OPERATOR_RUNNING_MODAL;
1778         }
1779         else {
1780                 /* not in scroller, so nothing happened... (pass through let's something else catch event) */
1781                 return OPERATOR_PASS_THROUGH;
1782         }
1783 }
1784
1785 /* LMB-Drag in Scrollers - not repeatable operator! */
1786 static void VIEW2D_OT_scroller_activate(wmOperatorType *ot)
1787 {
1788         /* identifiers */
1789         ot->name = "Scroller Activate";
1790         ot->description = "Scroll view by mouse click and drag";
1791         ot->idname = "VIEW2D_OT_scroller_activate";
1792
1793         /* flags */
1794         ot->flag = OPTYPE_BLOCKING;
1795         
1796         /* api callbacks */
1797         ot->invoke = scroller_activate_invoke;
1798         ot->modal = scroller_activate_modal;
1799         ot->cancel = scroller_activate_cancel;
1800
1801         ot->poll = view2d_poll;
1802 }
1803
1804 /* ********************************************************* */
1805 /* RESET */
1806
1807 static int reset_exec(bContext *C, wmOperator *UNUSED(op))
1808 {
1809         uiStyle *style = UI_GetStyle();
1810         ARegion *ar = CTX_wm_region(C);
1811         View2D *v2d = &ar->v2d;
1812         int winx, winy;
1813
1814         /* zoom 1.0 */
1815         winx = (float)(BLI_rcti_size_x(&v2d->mask) + 1);
1816         winy = (float)(BLI_rcti_size_y(&v2d->mask) + 1);
1817
1818         v2d->cur.xmax = v2d->cur.xmin + winx;
1819         v2d->cur.ymax = v2d->cur.ymin + winy;
1820         
1821         /* align */
1822         if (v2d->align) {
1823                 /* posx and negx flags are mutually exclusive, so watch out */
1824                 if ((v2d->align & V2D_ALIGN_NO_POS_X) && !(v2d->align & V2D_ALIGN_NO_NEG_X)) {
1825                         v2d->cur.xmax = 0.0f;
1826                         v2d->cur.xmin = -winx * style->panelzoom;
1827                 }
1828                 else if ((v2d->align & V2D_ALIGN_NO_NEG_X) && !(v2d->align & V2D_ALIGN_NO_POS_X)) {
1829                         v2d->cur.xmax = winx * style->panelzoom;
1830                         v2d->cur.xmin = 0.0f;
1831                 }
1832
1833                 /* - posx and negx flags are mutually exclusive, so watch out */
1834                 if ((v2d->align & V2D_ALIGN_NO_POS_Y) && !(v2d->align & V2D_ALIGN_NO_NEG_Y)) {
1835                         v2d->cur.ymax = 0.0f;
1836                         v2d->cur.ymin = -winy * style->panelzoom;
1837                 }
1838                 else if ((v2d->align & V2D_ALIGN_NO_NEG_Y) && !(v2d->align & V2D_ALIGN_NO_POS_Y)) {
1839                         v2d->cur.ymax = winy * style->panelzoom;
1840                         v2d->cur.ymin = 0.0f;
1841                 }
1842         }
1843
1844         /* validate that view is in valid configuration after this operation */
1845         UI_view2d_curRect_validate(v2d);
1846         
1847         /* request updates to be done... */
1848         ED_region_tag_redraw(ar);
1849         UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
1850         
1851         return OPERATOR_FINISHED;
1852 }
1853  
1854 static void VIEW2D_OT_reset(wmOperatorType *ot)
1855 {
1856         /* identifiers */
1857         ot->name = "Reset View";
1858         ot->description = "Reset the view";
1859         ot->idname = "VIEW2D_OT_reset";
1860         
1861         /* api callbacks */
1862         ot->exec = reset_exec;
1863         ot->poll = view2d_poll;
1864 }
1865  
1866 /* ********************************************************* */
1867 /* Registration */
1868
1869 void UI_view2d_operatortypes(void)
1870 {
1871         WM_operatortype_append(VIEW2D_OT_pan);
1872         
1873         WM_operatortype_append(VIEW2D_OT_scroll_left);
1874         WM_operatortype_append(VIEW2D_OT_scroll_right);
1875         WM_operatortype_append(VIEW2D_OT_scroll_up);
1876         WM_operatortype_append(VIEW2D_OT_scroll_down);
1877         
1878         WM_operatortype_append(VIEW2D_OT_zoom_in);
1879         WM_operatortype_append(VIEW2D_OT_zoom_out);
1880         
1881         WM_operatortype_append(VIEW2D_OT_zoom);
1882         WM_operatortype_append(VIEW2D_OT_zoom_border);
1883
1884         WM_operatortype_append(VIEW2D_OT_smoothview);
1885         
1886         WM_operatortype_append(VIEW2D_OT_scroller_activate);
1887
1888         WM_operatortype_append(VIEW2D_OT_reset);
1889 }
1890
1891 void UI_view2d_keymap(wmKeyConfig *keyconf)
1892 {
1893         wmKeyMap *keymap = WM_keymap_find(keyconf, "View2D", 0, 0);
1894         wmKeyMapItem *kmi;
1895
1896         /* scrollers */
1897         WM_keymap_add_item(keymap, "VIEW2D_OT_scroller_activate", LEFTMOUSE, KM_PRESS, 0, 0);
1898         WM_keymap_add_item(keymap, "VIEW2D_OT_scroller_activate", MIDDLEMOUSE, KM_PRESS, 0, 0);
1899
1900         /* pan/scroll */
1901         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MIDDLEMOUSE, KM_PRESS, 0, 0);
1902         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MIDDLEMOUSE, KM_PRESS, KM_SHIFT, 0);
1903         
1904         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MOUSEPAN, 0, 0, 0);
1905         
1906         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_right", WHEELDOWNMOUSE, KM_PRESS, KM_CTRL, 0);
1907         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_left", WHEELUPMOUSE, KM_PRESS, KM_CTRL, 0);
1908         
1909         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", WHEELDOWNMOUSE, KM_PRESS, KM_SHIFT, 0);
1910         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", WHEELUPMOUSE, KM_PRESS, KM_SHIFT, 0);
1911         
1912         /* zoom - single step */
1913         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_out", WHEELOUTMOUSE, KM_PRESS, 0, 0);
1914         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_in", WHEELINMOUSE, KM_PRESS, 0, 0);
1915         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_out", PADMINUS, KM_PRESS, 0, 0);
1916         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_in", PADPLUSKEY, KM_PRESS, 0, 0);
1917         
1918         WM_keymap_verify_item(keymap, "VIEW2D_OT_smoothview", TIMER1, KM_ANY, KM_ANY, 0);
1919
1920         /* scroll up/down - no modifiers, only when zoom fails */
1921         /* these may fail if zoom is disallowed, in which case they should pass on event */
1922         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", WHEELDOWNMOUSE, KM_PRESS, 0, 0);
1923         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", WHEELUPMOUSE, KM_PRESS, 0, 0);
1924         /* these may be necessary if vertical scroll is disallowed */
1925         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_right", WHEELDOWNMOUSE, KM_PRESS, 0, 0);
1926         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_left", WHEELUPMOUSE, KM_PRESS, 0, 0);
1927         
1928         /* alternatives for page up/down to scroll */
1929 #if 0 // XXX disabled, since this causes conflicts with hotkeys in animation editors
1930         /* scroll up/down may fall through to left/right */
1931         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", PAGEDOWNKEY, KM_PRESS, 0, 0);
1932         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", PAGEUPKEY, KM_PRESS, 0, 0);
1933         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_right", PAGEDOWNKEY, KM_PRESS, 0, 0);
1934         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_left", PAGEUPKEY, KM_PRESS, 0, 0);
1935         /* shift for moving view left/right with page up/down */
1936         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_right", PAGEDOWNKEY, KM_PRESS, KM_SHIFT, 0);
1937         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_left", PAGEUPKEY, KM_PRESS, KM_SHIFT, 0);
1938 #endif
1939         
1940         /* zoom - drag */
1941         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MIDDLEMOUSE, KM_PRESS, KM_CTRL, 0);
1942         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MOUSEZOOM, 0, 0, 0);
1943         
1944         /* borderzoom - drag */
1945         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_border", BKEY, KM_PRESS, KM_SHIFT, 0);
1946
1947         /* Alternative keymap for buttons listview */
1948         keymap = WM_keymap_find(keyconf, "View2D Buttons List", 0, 0);
1949
1950         WM_keymap_add_item(keymap, "VIEW2D_OT_scroller_activate", LEFTMOUSE, KM_PRESS, 0, 0);
1951         WM_keymap_add_item(keymap, "VIEW2D_OT_scroller_activate", MIDDLEMOUSE, KM_PRESS, 0, 0);
1952
1953         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MIDDLEMOUSE, KM_PRESS, 0, 0);
1954         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MOUSEPAN, 0, 0, 0);
1955         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", WHEELDOWNMOUSE, KM_PRESS, 0, 0);
1956         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", WHEELUPMOUSE, KM_PRESS, 0, 0);
1957         
1958         kmi = WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", PAGEDOWNKEY, KM_PRESS, 0, 0);
1959         RNA_boolean_set(kmi->ptr, "page", TRUE);
1960         kmi = WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", PAGEUPKEY, KM_PRESS, 0, 0);
1961         RNA_boolean_set(kmi->ptr, "page", TRUE);
1962         
1963         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MIDDLEMOUSE, KM_PRESS, KM_CTRL, 0);
1964         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MOUSEZOOM, 0, 0, 0);
1965         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_out", PADMINUS, KM_PRESS, 0, 0);
1966         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_in", PADPLUSKEY, KM_PRESS, 0, 0);
1967         WM_keymap_add_item(keymap, "VIEW2D_OT_reset", HOMEKEY, KM_PRESS, 0, 0);
1968 }
1969