ce6f77afaac681346b5bb555474b7e3d47b30cd9
[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(bContext *C, 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         WM_event_add_mousemove(C);
157         
158         UI_view2d_sync(vpd->sc, vpd->sa, v2d, V2D_LOCK_COPY);
159         
160         /* exceptions */
161         if (vpd->sa->spacetype == SPACE_OUTLINER) {
162                 /* don't rebuild full tree, since we're just changing our view */
163                 SpaceOops *soops = vpd->sa->spacedata.first;
164                 soops->storeflag |= SO_TREESTORE_REDRAW;
165         }
166 }
167
168 /* cleanup temp customdata  */
169 static void view_pan_exit(wmOperator *op)
170 {
171         if (op->customdata) {
172                 MEM_freeN(op->customdata);
173                 op->customdata = NULL;
174         }
175
176  
177 /* ------------------ Modal Drag Version (1) ---------------------- */
178
179 /* for 'redo' only, with no user input */
180 static int view_pan_exec(bContext *C, wmOperator *op)
181 {
182         if (!view_pan_init(C, op))
183                 return OPERATOR_CANCELLED;
184         
185         view_pan_apply(C, op);
186         view_pan_exit(op);
187         return OPERATOR_FINISHED;
188 }
189
190 /* set up modal operator and relevant settings */
191 static int view_pan_invoke(bContext *C, wmOperator *op, const wmEvent *event)
192 {
193         wmWindow *window = CTX_wm_window(C);
194         v2dViewPanData *vpd;
195         View2D *v2d;
196         
197         /* set up customdata */
198         if (!view_pan_init(C, op))
199                 return OPERATOR_PASS_THROUGH;
200         
201         vpd = op->customdata;
202         v2d = vpd->v2d;
203         
204         /* set initial settings */
205         vpd->startx = vpd->lastx = event->x;
206         vpd->starty = vpd->lasty = event->y;
207         vpd->invoke_event = event->type;
208         
209         if (event->type == MOUSEPAN) {
210                 RNA_int_set(op->ptr, "deltax", event->prevx - event->x);
211                 RNA_int_set(op->ptr, "deltay", event->prevy - event->y);
212                 
213                 view_pan_apply(C, op);
214                 view_pan_exit(op);
215                 return OPERATOR_FINISHED;
216         }
217         
218         RNA_int_set(op->ptr, "deltax", 0);
219         RNA_int_set(op->ptr, "deltay", 0);
220         
221         if (v2d->keepofs & V2D_LOCKOFS_X)
222                 WM_cursor_modal_set(window, BC_NS_SCROLLCURSOR);
223         else if (v2d->keepofs & V2D_LOCKOFS_Y)
224                 WM_cursor_modal_set(window, BC_EW_SCROLLCURSOR);
225         else
226                 WM_cursor_modal_set(window, BC_NSEW_SCROLLCURSOR);
227         
228         /* add temp handler */
229         WM_event_add_modal_handler(C, op);
230
231         return OPERATOR_RUNNING_MODAL;
232 }
233
234 /* handle user input - calculations of mouse-movement need to be done here, not in the apply callback! */
235 static int view_pan_modal(bContext *C, wmOperator *op, const wmEvent *event)
236 {
237         v2dViewPanData *vpd = op->customdata;
238         
239         /* execute the events */
240         switch (event->type) {
241                 case MOUSEMOVE:
242                 {
243                         /* calculate new delta transform, then store mouse-coordinates for next-time */
244                         RNA_int_set(op->ptr, "deltax", (vpd->lastx - event->x));
245                         RNA_int_set(op->ptr, "deltay", (vpd->lasty - event->y));
246                         
247                         vpd->lastx = event->x;
248                         vpd->lasty = event->y;
249                         
250                         view_pan_apply(C, op);
251                         break;
252                 }
253                         /* XXX - Mode switching isn't implemented. See comments in 36818.
254                          * switch to zoom */
255 #if 0
256                 case LEFTMOUSE:
257                         if (event->val == KM_PRESS) {
258                                 /* calculate overall delta mouse-movement for redo */
259                                 RNA_int_set(op->ptr, "deltax", (vpd->startx - vpd->lastx));
260                                 RNA_int_set(op->ptr, "deltay", (vpd->starty - vpd->lasty));
261                                 
262                                 view_pan_exit(op);
263                                 WM_cursor_modal_restore(CTX_wm_window(C));
264                                 WM_operator_name_call(C, "VIEW2D_OT_zoom", WM_OP_INVOKE_DEFAULT, NULL);
265                                 return OPERATOR_FINISHED;
266                         }
267 #endif
268                 default:
269                         if (event->type == vpd->invoke_event || event->type == ESCKEY) {
270                                 if (event->val == KM_RELEASE) {
271                                         /* calculate overall delta mouse-movement for redo */
272                                         RNA_int_set(op->ptr, "deltax", (vpd->startx - vpd->lastx));
273                                         RNA_int_set(op->ptr, "deltay", (vpd->starty - vpd->lasty));
274                                         
275                                         view_pan_exit(op);
276                                         WM_cursor_modal_restore(CTX_wm_window(C));
277                                         
278                                         return OPERATOR_FINISHED;
279                                 }
280                         }
281                         break;
282         }
283
284         return OPERATOR_RUNNING_MODAL;
285 }
286
287 static void view_pan_cancel(bContext *UNUSED(C), wmOperator *op)
288 {
289         view_pan_exit(op);
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 calls the 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(C, 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 calls the 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(C, 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 calls the 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(C, 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 calls the 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(C, 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, const 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 calls the 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, const 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 void view_zoomdrag_cancel(bContext *C, wmOperator *op)
909 {
910         view_zoomdrag_exit(C, op);
911 }
912
913 /* for 'redo' only, with no user input */
914 static int view_zoomdrag_exec(bContext *C, wmOperator *op)
915 {
916         if (!view_zoomdrag_init(C, op))
917                 return OPERATOR_PASS_THROUGH;
918         
919         view_zoomdrag_apply(C, op);
920         view_zoomdrag_exit(C, op);
921         return OPERATOR_FINISHED;
922 }
923
924 /* set up modal operator and relevant settings */
925 static int view_zoomdrag_invoke(bContext *C, wmOperator *op, const wmEvent *event)
926 {
927         wmWindow *window = CTX_wm_window(C);
928         v2dViewZoomData *vzd;
929         View2D *v2d;
930         
931         /* set up customdata */
932         if (!view_zoomdrag_init(C, op))
933                 return OPERATOR_PASS_THROUGH;
934         
935         vzd = op->customdata;
936         v2d = vzd->v2d;
937         
938         if (event->type == MOUSEZOOM || event->type == MOUSEPAN) {
939                 float dx, dy, fac;
940                 
941                 vzd->lastx = event->prevx;
942                 vzd->lasty = event->prevy;
943                 
944                 /* As we have only 1D information (magnify value), feed both axes
945                  * with magnify information that is stored in x axis 
946                  */
947                 fac = 0.01f * (event->prevx - event->x);
948                 dx = fac * BLI_rctf_size_x(&v2d->cur) / 10.0f;
949                 if (event->type == MOUSEPAN)
950                         fac = 0.01f * (event->prevy - event->y);
951                 dy = fac * BLI_rctf_size_y(&v2d->cur) / 10.0f;
952
953                 /* support trackpad zoom to always zoom entirely - the v2d code uses portrait or landscape exceptions */
954                 if (v2d->keepzoom & V2D_KEEPASPECT) {
955                         if (fabsf(dx) > fabsf(dy))
956                                 dy = dx;
957                         else
958                                 dx = dy;
959                 }
960                 RNA_float_set(op->ptr, "deltax", dx);
961                 RNA_float_set(op->ptr, "deltay", dy);
962                 
963                 view_zoomdrag_apply(C, op);
964                 view_zoomdrag_exit(C, op);
965                 return OPERATOR_FINISHED;
966         }
967         
968         /* set initial settings */
969         vzd->lastx = event->x;
970         vzd->lasty = event->y;
971         RNA_float_set(op->ptr, "deltax", 0);
972         RNA_float_set(op->ptr, "deltay", 0);
973         
974         /* for modal exit test */
975         vzd->invoke_event = event->type;
976         
977         if (U.uiflag & USER_ZOOM_TO_MOUSEPOS) {
978                 ARegion *ar = CTX_wm_region(C);
979                 
980                 /* store initial mouse position (in view space) */
981                 UI_view2d_region_to_view(&ar->v2d, 
982                                          event->mval[0], event->mval[1],
983                                          &vzd->mx_2d, &vzd->my_2d);
984         }
985
986         if (v2d->keepofs & V2D_LOCKOFS_X)
987                 WM_cursor_modal_set(window, BC_NS_SCROLLCURSOR);
988         else if (v2d->keepofs & V2D_LOCKOFS_Y)
989                 WM_cursor_modal_set(window, BC_EW_SCROLLCURSOR);
990         else
991                 WM_cursor_modal_set(window, BC_NSEW_SCROLLCURSOR);
992         
993         /* add temp handler */
994         WM_event_add_modal_handler(C, op);
995
996         if (U.viewzoom == USER_ZOOM_CONT) {
997                 /* needs a timer to continue redrawing */
998                 vzd->timer = WM_event_add_timer(CTX_wm_manager(C), CTX_wm_window(C), TIMER, 0.01f);
999                 vzd->timer_lastdraw = PIL_check_seconds_timer();
1000         }
1001
1002         return OPERATOR_RUNNING_MODAL;
1003 }
1004
1005 /* handle user input - calculations of mouse-movement need to be done here, not in the apply callback! */
1006 static int view_zoomdrag_modal(bContext *C, wmOperator *op, const wmEvent *event)
1007 {
1008         v2dViewZoomData *vzd = op->customdata;
1009         View2D *v2d = vzd->v2d;
1010         
1011         /* execute the events */
1012         if (event->type == TIMER && event->customdata == vzd->timer) {
1013                 view_zoomdrag_apply(C, op);
1014         }
1015         else if (event->type == MOUSEMOVE) {
1016                 float dx, dy;
1017                 
1018                 /* calculate new delta transform, based on zooming mode */
1019                 if (U.viewzoom == USER_ZOOM_SCALE) {
1020                         /* 'scale' zooming */
1021                         float dist;
1022                         
1023                         /* x-axis transform */
1024                         dist = BLI_rcti_size_x(&v2d->mask) / 2.0f;
1025                         dx = 1.0f - (fabsf(vzd->lastx - vzd->ar->winrct.xmin - dist) + 2.0f) / (fabsf(event->mval[0] - dist) + 2.0f);
1026                         dx *= 0.5f * BLI_rctf_size_x(&v2d->cur);
1027                         
1028                         /* y-axis transform */
1029                         dist = BLI_rcti_size_y(&v2d->mask) / 2.0f;
1030                         dy = 1.0f - (fabsf(vzd->lasty - vzd->ar->winrct.ymin - dist) + 2.0f) / (fabsf(event->mval[1] - dist) + 2.0f);
1031                         dy *= 0.5f * BLI_rctf_size_y(&v2d->cur);
1032                 }
1033                 else {
1034                         /* 'continuous' or 'dolly' */
1035                         float fac, zoomfac = 0.01f;
1036                         
1037                         /* some view2d's (graph) don't have min/max zoom, or extreme ones */
1038                         if (v2d->maxzoom > 0.0f)
1039                                 zoomfac = CLAMPIS(0.001f * v2d->maxzoom, 0.001f, 0.01f);
1040                         
1041                         /* x-axis transform */
1042                         fac = zoomfac * (event->x - vzd->lastx);
1043                         dx = fac * BLI_rctf_size_x(&v2d->cur);
1044                         
1045                         /* y-axis transform */
1046                         fac = zoomfac * (event->y - vzd->lasty);
1047                         dy = fac * BLI_rctf_size_y(&v2d->cur);
1048                         
1049                 }
1050                 
1051                 /* support zoom to always zoom entirely - the v2d code uses portrait or landscape exceptions */
1052                 if (v2d->keepzoom & V2D_KEEPASPECT) {
1053                         if (fabsf(dx) > fabsf(dy))
1054                                 dy = dx;
1055                         else
1056                                 dx = dy;
1057                 }
1058                 
1059                 /* set transform amount, and add current deltas to stored total delta (for redo) */
1060                 RNA_float_set(op->ptr, "deltax", dx);
1061                 RNA_float_set(op->ptr, "deltay", dy);
1062
1063                 vzd->dx += dx;
1064                 vzd->dy += dy;
1065                 
1066                 /* store mouse coordinates for next time, if not doing continuous zoom
1067                  *      - continuous zoom only depends on distance of mouse to starting point to determine rate of change
1068                  */
1069                 if (U.viewzoom != USER_ZOOM_CONT) { // XXX store this setting as RNA prop?
1070                         vzd->lastx = event->x;
1071                         vzd->lasty = event->y;
1072                 }
1073                 
1074                 /* apply zooming */
1075                 view_zoomdrag_apply(C, op);
1076         }
1077         else if (event->type == vzd->invoke_event || event->type == ESCKEY) {
1078                 if (event->val == KM_RELEASE) {
1079                         
1080                         /* for redo, store the overall deltas - need to respect zoom-locks here... */
1081                         if ((v2d->keepzoom & V2D_LOCKZOOM_X) == 0)
1082                                 RNA_float_set(op->ptr, "deltax", vzd->dx);
1083                         else
1084                                 RNA_float_set(op->ptr, "deltax", 0);
1085                                 
1086                         if ((v2d->keepzoom & V2D_LOCKZOOM_Y) == 0)
1087                                 RNA_float_set(op->ptr, "deltay", vzd->dy);
1088                         else
1089                                 RNA_float_set(op->ptr, "deltay", 0);
1090                         
1091                         /* free customdata */
1092                         view_zoomdrag_exit(C, op);
1093                         WM_cursor_modal_restore(CTX_wm_window(C));
1094                         
1095                         return OPERATOR_FINISHED;
1096                 }
1097         }
1098
1099         return OPERATOR_RUNNING_MODAL;
1100 }
1101
1102 static void VIEW2D_OT_zoom(wmOperatorType *ot)
1103 {
1104         /* identifiers */
1105         ot->name = "Zoom 2D View";
1106         ot->description = "Zoom in/out the view";
1107         ot->idname = "VIEW2D_OT_zoom";
1108         
1109         /* api callbacks */
1110         ot->exec = view_zoomdrag_exec;
1111         ot->invoke = view_zoomdrag_invoke;
1112         ot->modal = view_zoomdrag_modal;
1113         ot->cancel = view_zoomdrag_cancel;
1114         
1115         ot->poll = view_zoom_poll;
1116         
1117         /* operator is repeatable */
1118         ot->flag = OPTYPE_BLOCKING | OPTYPE_GRAB_POINTER;
1119         
1120         /* rna - must keep these in sync with the other operators */
1121         RNA_def_float(ot->srna, "deltax", 0, -FLT_MAX, FLT_MAX, "Delta X", "", -FLT_MAX, FLT_MAX);
1122         RNA_def_float(ot->srna, "deltay", 0, -FLT_MAX, FLT_MAX, "Delta Y", "", -FLT_MAX, FLT_MAX);
1123 }
1124
1125 /* ********************************************************* */
1126 /* BORDER-ZOOM */
1127
1128 /* The user defines a rect using standard borderselect tools, and we use this rect to 
1129  * define the new zoom-level of the view in the following ways:
1130  *      1) LEFTMOUSE - zoom in to view
1131  *      2) RIGHTMOUSE - zoom out of view
1132  *
1133  * Currently, these key mappings are hardcoded, but it shouldn't be too important to
1134  * have custom keymappings for this...
1135  */
1136  
1137 static int view_borderzoom_exec(bContext *C, wmOperator *op)
1138 {
1139         ARegion *ar = CTX_wm_region(C);
1140         View2D *v2d = &ar->v2d;
1141         rctf rect;
1142         rctf cur_new = v2d->cur;
1143         int gesture_mode;
1144         const int smooth_viewtx = WM_operator_smooth_viewtx_get(op);
1145         
1146         /* convert coordinates of rect to 'tot' rect coordinates */
1147         UI_view2d_region_to_view(v2d, RNA_int_get(op->ptr, "xmin"), RNA_int_get(op->ptr, "ymin"), &rect.xmin, &rect.ymin);
1148         UI_view2d_region_to_view(v2d, RNA_int_get(op->ptr, "xmax"), RNA_int_get(op->ptr, "ymax"), &rect.xmax, &rect.ymax);
1149         
1150         /* check if zooming in/out view */
1151         gesture_mode = RNA_int_get(op->ptr, "gesture_mode");
1152         
1153         if (gesture_mode == GESTURE_MODAL_IN) {
1154                 /* zoom in: 
1155                  *      - 'cur' rect will be defined by the coordinates of the border region 
1156                  *      - just set the 'cur' rect to have the same coordinates as the border region
1157                  *        if zoom is allowed to be changed
1158                  */
1159                 if ((v2d->keepzoom & V2D_LOCKZOOM_X) == 0) {
1160                         cur_new.xmin = rect.xmin;
1161                         cur_new.xmax = rect.xmax;
1162                 }
1163                 if ((v2d->keepzoom & V2D_LOCKZOOM_Y) == 0) {
1164                         cur_new.ymin = rect.ymin;
1165                         cur_new.ymax = rect.ymax;
1166                 }
1167         }
1168         else { /* if (gesture_mode == GESTURE_MODAL_OUT) */
1169
1170                 /* zoom out:
1171                  *      - the current 'cur' rect coordinates are going to end up where the 'rect' ones are,
1172                  *        but the 'cur' rect coordinates will need to be adjusted to take in more of the view
1173                  *      - calculate zoom factor, and adjust using center-point
1174                  */
1175                 float zoom, center, size;
1176                 
1177                 /* TODO: is this zoom factor calculation valid? It seems to produce same results every time... */
1178                 if ((v2d->keepzoom & V2D_LOCKZOOM_X) == 0) {
1179                         size = BLI_rctf_size_x(&cur_new);
1180                         zoom = size / BLI_rctf_size_x(&rect);
1181                         center = BLI_rctf_cent_x(&cur_new);
1182                         
1183                         cur_new.xmin = center - (size * zoom);
1184                         cur_new.xmax = center + (size * zoom);
1185                 }
1186                 if ((v2d->keepzoom & V2D_LOCKZOOM_Y) == 0) {
1187                         size = BLI_rctf_size_y(&cur_new);
1188                         zoom = size / BLI_rctf_size_y(&rect);
1189                         center = BLI_rctf_cent_y(&cur_new);
1190                         
1191                         cur_new.ymin = center - (size * zoom);
1192                         cur_new.ymax = center + (size * zoom);
1193                 }
1194         }
1195         
1196         UI_view2d_smooth_view(C, ar, &cur_new, smooth_viewtx);
1197         
1198         return OPERATOR_FINISHED;
1199
1200
1201 static void VIEW2D_OT_zoom_border(wmOperatorType *ot)
1202 {
1203         /* identifiers */
1204         ot->name = "Zoom to Border";
1205         ot->description = "Zoom in the view to the nearest item contained in the border";
1206         ot->idname = "VIEW2D_OT_zoom_border";
1207         
1208         /* api callbacks */
1209         ot->invoke = WM_border_select_invoke;
1210         ot->exec = view_borderzoom_exec;
1211         ot->modal = WM_border_select_modal;
1212         ot->cancel = WM_border_select_cancel;
1213         
1214         ot->poll = view_zoom_poll;
1215         
1216         /* rna */
1217         WM_operator_properties_gesture_border(ot, FALSE);
1218 }
1219
1220 /* ********************************************************* */
1221 /* SMOOTH VIEW */
1222
1223 struct SmoothView2DStore {
1224         rctf orig_cur, new_cur;
1225
1226         double time_allowed;
1227 };
1228
1229 /**
1230  * function to get a factor out of a rectangle
1231  *
1232  * note: this doesn't always work as well as it might because the target size
1233  *       may not be reached because of clamping the desired rect, we _could_
1234  *       attempt to clamp the rect before working out the zoom factor but its
1235  *       not really worthwhile for the few cases this happens.
1236  */
1237 static float smooth_view_rect_to_fac(const rctf *rect_a, const rctf *rect_b)
1238 {
1239         float size_a[2] = {BLI_rctf_size_x(rect_a),
1240                            BLI_rctf_size_y(rect_a)};
1241         float size_b[2] = {BLI_rctf_size_x(rect_b),
1242                            BLI_rctf_size_y(rect_b)};
1243         float cent_a[2] = {BLI_rctf_cent_x(rect_a),
1244                            BLI_rctf_cent_y(rect_a)};
1245         float cent_b[2] = {BLI_rctf_cent_x(rect_b),
1246                            BLI_rctf_cent_y(rect_b)};
1247
1248         float fac_max = 0.0f;
1249         float tfac;
1250
1251         int i;
1252
1253         for (i = 0; i < 2; i++) {
1254                 /* axis translation normalized to scale */
1255                 tfac = fabsf(cent_a[i] - cent_b[i]) / min_ff(size_a[i], size_b[i]);
1256                 fac_max = max_ff(fac_max, tfac);
1257                 if (fac_max >= 1.0f) break;
1258
1259                 /* axis scale difference, x2 so doubling or half gives 1.0f */
1260                 tfac = (1.0f - (min_ff(size_a[i], size_b[i]) / max_ff(size_a[i], size_b[i]))) * 2.0f;
1261                 fac_max = max_ff(fac_max, tfac);
1262                 if (fac_max >= 1.0f) break;
1263         }
1264         return min_ff(fac_max, 1.0f);
1265 }
1266
1267 /* will start timer if appropriate */
1268 /* the arguments are the desired situation */
1269 void UI_view2d_smooth_view(bContext *C, ARegion *ar,
1270                            const rctf *cur, const int smooth_viewtx)
1271 {
1272         wmWindowManager *wm = CTX_wm_manager(C);
1273         wmWindow *win = CTX_wm_window(C);
1274
1275         View2D *v2d = &ar->v2d;
1276         struct SmoothView2DStore sms = {{0}};
1277         short ok = FALSE;
1278         float fac = 1.0f;
1279
1280         /* initialize sms */
1281         sms.new_cur = v2d->cur;
1282
1283         /* store the options we want to end with */
1284         if (cur) sms.new_cur = *cur;
1285
1286         if (cur) {
1287                 fac = smooth_view_rect_to_fac(&v2d->cur, cur);
1288         }
1289
1290         if (smooth_viewtx && fac > FLT_EPSILON) {
1291                 bool changed = false;
1292
1293                 if (BLI_rctf_compare(&sms.new_cur, &v2d->cur, FLT_EPSILON) == FALSE)
1294                         changed = true;
1295
1296                 /* The new view is different from the old one
1297                  * so animate the view */
1298                 if (changed) {
1299                         sms.orig_cur = v2d->cur;
1300
1301                         sms.time_allowed = (double)smooth_viewtx / 1000.0;
1302
1303                         /* scale the time allowed the change in view */
1304                         sms.time_allowed *= (double)fac;
1305
1306                         /* keep track of running timer! */
1307                         if (v2d->sms == NULL)
1308                                 v2d->sms = MEM_mallocN(sizeof(struct SmoothView2DStore), "smoothview v2d");
1309                         *v2d->sms = sms;
1310                         if (v2d->smooth_timer)
1311                                 WM_event_remove_timer(wm, win, v2d->smooth_timer);
1312                         /* TIMER1 is hardcoded in keymap */
1313                         v2d->smooth_timer = WM_event_add_timer(wm, win, TIMER1, 1.0 / 100.0); /* max 30 frs/sec */
1314
1315                         ok = TRUE;
1316                 }
1317         }
1318
1319         /* if we get here nothing happens */
1320         if (ok == FALSE) {
1321                 v2d->cur = sms.new_cur;
1322
1323                 UI_view2d_curRect_validate(v2d);
1324                 ED_region_tag_redraw(ar);
1325                 UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
1326         }
1327 }
1328
1329 /* only meant for timer usage */
1330 static int view2d_smoothview_invoke(bContext *C, wmOperator *UNUSED(op), const wmEvent *event)
1331 {
1332         ARegion *ar = CTX_wm_region(C);
1333         View2D *v2d = &ar->v2d;
1334         struct SmoothView2DStore *sms = v2d->sms;
1335         float step;
1336
1337         /* escape if not our timer */
1338         if (v2d->smooth_timer == NULL || v2d->smooth_timer != event->customdata)
1339                 return OPERATOR_PASS_THROUGH;
1340
1341         if (sms->time_allowed != 0.0)
1342                 step = (float)((v2d->smooth_timer->duration) / sms->time_allowed);
1343         else
1344                 step = 1.0f;
1345
1346         /* end timer */
1347         if (step >= 1.0f) {
1348                 v2d->cur = sms->new_cur;
1349
1350                 MEM_freeN(v2d->sms);
1351                 v2d->sms = NULL;
1352
1353                 WM_event_remove_timer(CTX_wm_manager(C), CTX_wm_window(C), v2d->smooth_timer);
1354                 v2d->smooth_timer = NULL;
1355         }
1356         else {
1357                 /* ease in/out */
1358                 step = (3.0f * step * step - 2.0f * step * step * step);
1359
1360                 BLI_rctf_interp(&v2d->cur, &sms->orig_cur, &sms->new_cur, step);
1361         }
1362
1363         UI_view2d_curRect_validate(v2d);
1364         UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
1365         ED_region_tag_redraw(ar);
1366
1367         return OPERATOR_FINISHED;
1368 }
1369
1370 static void VIEW2D_OT_smoothview(wmOperatorType *ot)
1371 {
1372         /* identifiers */
1373         ot->name = "Smooth View 2D";
1374         ot->description = "";
1375         ot->idname = "VIEW2D_OT_smoothview";
1376
1377         /* api callbacks */
1378         ot->invoke = view2d_smoothview_invoke;
1379         ot->poll = view2d_poll;
1380
1381         /* flags */
1382         ot->flag = OPTYPE_INTERNAL;
1383
1384         /* rna */
1385         WM_operator_properties_gesture_border(ot, FALSE);
1386 }
1387
1388 /* ********************************************************* */
1389 /* SCROLLERS */
1390
1391 /*  Scrollers should behave in the following ways, when clicked on with LMB (and dragged):
1392  *              1) 'Handles' on end of 'bubble' - when the axis that the scroller represents is zoomable, 
1393  *                      enlarge 'cur' rect on the relevant side 
1394  *              2) 'Bubble'/'bar' - just drag, and bar should move with mouse (view pans opposite)
1395  *
1396  *      In order to make sure this works, each operator must define the following RNA-Operator Props:
1397  *              deltax, deltay  - define how much to move view by (relative to zoom-correction factor)
1398  */
1399
1400 /* customdata for scroller-invoke data */
1401 typedef struct v2dScrollerMove {
1402         View2D *v2d;            /* View2D data that this operation affects */
1403         ARegion *ar;            /* region that the scroller is in */
1404         
1405         short scroller;         /* scroller that mouse is in ('h' or 'v') */
1406         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?)
1407         
1408         float fac;              /* view adjustment factor, based on size of region */
1409         float delta;            /* amount moved by mouse on axis of interest */
1410         
1411         float scrollbarwidth;   /* width of the scrollbar itself, used for page up/down clicks */
1412         int scrollbar_orig;      /* initial location of scrollbar x/y, mouse relative */
1413         
1414         int lastx, lasty;       /* previous mouse coordinates (in screen coordinates) for determining movement */
1415 } v2dScrollerMove;
1416
1417
1418 /* View2DScrollers is typedef'd in UI_view2d.h 
1419  * This is a CUT DOWN VERSION of the 'real' version, which is defined in view2d.c, as we only need focus bubble info
1420  * WARNING: the start of this struct must not change, so that it stays in sync with the 'real' version
1421  *         For now, we don't need to have a separate (internal) header for structs like this...
1422  */
1423 struct View2DScrollers {        
1424         /* focus bubbles */
1425         int vert_min, vert_max; /* vertical scrollbar */
1426         int hor_min, hor_max;   /* horizontal scrollbar */
1427 };
1428
1429 /* quick enum for vsm->zone (scroller handles) */
1430 enum {
1431         SCROLLHANDLE_MIN = -1,
1432         SCROLLHANDLE_BAR,
1433         SCROLLHANDLE_MAX,
1434         SCROLLHANDLE_MIN_OUTSIDE,
1435         SCROLLHANDLE_MAX_OUTSIDE
1436 } /*eV2DScrollerHandle_Zone*/;
1437
1438 /* ------------------------ */
1439
1440 /* check if mouse is within scroller handle 
1441  *      - mouse                 =   relevant mouse coordinate in region space
1442  *      - sc_min, sc_max        =   extents of scroller 'groove' (potential available space for scroller)
1443  *      - sh_min, sh_max        =   positions of scrollbar handles
1444  */
1445 static short mouse_in_scroller_handle(int mouse, int sc_min, int sc_max, int sh_min, int sh_max)
1446 {
1447         short in_min, in_max, in_bar, out_min, out_max, in_view = 1;
1448         
1449         /* firstly, check if 
1450          *      - 'bubble' fills entire scroller 
1451          *      - 'bubble' completely out of view on either side 
1452          */
1453         if ((sh_min <= sc_min) && (sh_max >= sc_max)) in_view = 0;
1454         if (sh_min == sh_max) {
1455                 if (sh_min <= sc_min) in_view = 0;
1456                 if (sh_max >= sc_max) in_view = 0;
1457         }
1458         else {
1459                 if (sh_max <= sc_min) in_view = 0;
1460                 if (sh_min >= sc_max) in_view = 0;
1461         }
1462         
1463         
1464         if (in_view == 0) {
1465                 return SCROLLHANDLE_BAR;
1466         }
1467         
1468         /* check if mouse is in or past either handle */
1469         /* TODO: check if these extents are still valid or not */
1470         in_max = ( (mouse >= (sh_max - V2D_SCROLLER_HANDLE_SIZE)) && (mouse <= (sh_max + V2D_SCROLLER_HANDLE_SIZE)) );
1471         in_min = ( (mouse <= (sh_min + V2D_SCROLLER_HANDLE_SIZE)) && (mouse >= (sh_min - V2D_SCROLLER_HANDLE_SIZE)) );
1472         in_bar = ( (mouse < (sh_max - V2D_SCROLLER_HANDLE_SIZE)) && (mouse > (sh_min + V2D_SCROLLER_HANDLE_SIZE)) );
1473         out_min = mouse < (sh_min - V2D_SCROLLER_HANDLE_SIZE);
1474         out_max = mouse > (sh_max + V2D_SCROLLER_HANDLE_SIZE);
1475         
1476         if (in_bar)
1477                 return SCROLLHANDLE_BAR;
1478         else if (in_max)
1479                 return SCROLLHANDLE_MAX;
1480         else if (in_min)
1481                 return SCROLLHANDLE_MIN;
1482         else if (out_min)
1483                 return SCROLLHANDLE_MIN_OUTSIDE;
1484         else if (out_max)
1485                 return SCROLLHANDLE_MAX_OUTSIDE;
1486         
1487         /* unlikely to happen, though we just cover it in case */
1488         return SCROLLHANDLE_BAR;
1489
1490
1491 /* initialize customdata for scroller manipulation operator */
1492 static void scroller_activate_init(bContext *C, wmOperator *op, const wmEvent *event, short in_scroller)
1493 {
1494         v2dScrollerMove *vsm;
1495         View2DScrollers *scrollers;
1496         ARegion *ar = CTX_wm_region(C);
1497         View2D *v2d = &ar->v2d;
1498         rctf tot_cur_union;
1499         float mask_size;
1500         
1501         /* set custom-data for operator */
1502         vsm = MEM_callocN(sizeof(v2dScrollerMove), "v2dScrollerMove");
1503         op->customdata = vsm;
1504         
1505         /* set general data */
1506         vsm->v2d = v2d;
1507         vsm->ar = ar;
1508         vsm->scroller = in_scroller;
1509
1510         /* store mouse-coordinates, and convert mouse/screen coordinates to region coordinates */
1511         vsm->lastx = event->x;
1512         vsm->lasty = event->y;
1513         /* 'zone' depends on where mouse is relative to bubble 
1514          *      - zooming must be allowed on this axis, otherwise, default to pan
1515          */
1516         scrollers = UI_view2d_scrollers_calc(C, v2d, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY);
1517
1518         /* use a union of 'cur' & 'tot' incase the current view is far outside 'tot'.
1519          * In this cases moving the scroll bars has far too little effect and the view can get stuck [#31476] */
1520         tot_cur_union = v2d->tot;
1521         BLI_rctf_union(&tot_cur_union, &v2d->cur);
1522
1523         if (in_scroller == 'h') {
1524                 /* horizontal scroller - calculate adjustment factor first */
1525                 mask_size = (float)BLI_rcti_size_x(&v2d->hor);
1526                 vsm->fac = BLI_rctf_size_x(&tot_cur_union) / mask_size;
1527                 
1528                 /* get 'zone' (i.e. which part of scroller is activated) */
1529                 vsm->zone = mouse_in_scroller_handle(event->mval[0],
1530                                                      v2d->hor.xmin, v2d->hor.xmax,
1531                                                      scrollers->hor_min, scrollers->hor_max);
1532                 
1533                 if ((v2d->keepzoom & V2D_LOCKZOOM_X) && ELEM(vsm->zone, SCROLLHANDLE_MIN, SCROLLHANDLE_MAX)) {
1534                         /* default to scroll, as handles not usable */
1535                         vsm->zone = SCROLLHANDLE_BAR;
1536                 }
1537
1538                 vsm->scrollbarwidth = scrollers->hor_max - scrollers->hor_min;
1539                 vsm->scrollbar_orig = ((scrollers->hor_max + scrollers->hor_min) / 2) + ar->winrct.xmin;
1540         }
1541         else {
1542                 /* vertical scroller - calculate adjustment factor first */
1543                 mask_size = (float)BLI_rcti_size_y(&v2d->vert);
1544                 vsm->fac = BLI_rctf_size_y(&tot_cur_union) / mask_size;
1545                 
1546                 /* get 'zone' (i.e. which part of scroller is activated) */
1547                 vsm->zone = mouse_in_scroller_handle(event->mval[1],
1548                                                      v2d->vert.ymin, v2d->vert.ymax,
1549                                                      scrollers->vert_min, scrollers->vert_max);
1550                         
1551                 if ((v2d->keepzoom & V2D_LOCKZOOM_Y) && ELEM(vsm->zone, SCROLLHANDLE_MIN, SCROLLHANDLE_MAX)) {
1552                         /* default to scroll, as handles not usable */
1553                         vsm->zone = SCROLLHANDLE_BAR;
1554                 }
1555                 
1556                 vsm->scrollbarwidth = scrollers->vert_max - scrollers->vert_min;
1557                 vsm->scrollbar_orig = ((scrollers->vert_max + scrollers->vert_min) / 2) + ar->winrct.ymin;
1558         }
1559         
1560         UI_view2d_scrollers_free(scrollers);
1561         ED_region_tag_redraw(ar);
1562 }
1563
1564 /* cleanup temp customdata  */
1565 static void scroller_activate_exit(bContext *C, wmOperator *op)
1566 {
1567         if (op->customdata) {
1568                 v2dScrollerMove *vsm = op->customdata;
1569
1570                 vsm->v2d->scroll_ui &= ~(V2D_SCROLL_H_ACTIVE | V2D_SCROLL_V_ACTIVE);
1571                 
1572                 MEM_freeN(op->customdata);
1573                 op->customdata = NULL;
1574                 
1575                 ED_region_tag_redraw(CTX_wm_region(C));
1576         }
1577 }
1578
1579 static void scroller_activate_cancel(bContext *C, wmOperator *op)
1580 {
1581         scroller_activate_exit(C, op);
1582 }
1583
1584 /* apply transform to view (i.e. adjust 'cur' rect) */
1585 static void scroller_activate_apply(bContext *C, wmOperator *op)
1586 {
1587         v2dScrollerMove *vsm = op->customdata;
1588         View2D *v2d = vsm->v2d;
1589         float temp;
1590         
1591         /* calculate amount to move view by */
1592         temp = vsm->fac * vsm->delta;
1593         
1594         /* type of movement */
1595         switch (vsm->zone) {
1596                 case SCROLLHANDLE_MIN:
1597                         /* only expand view on axis if zoom is allowed */
1598                         if ((vsm->scroller == 'h') && !(v2d->keepzoom & V2D_LOCKZOOM_X))
1599                                 v2d->cur.xmin -= temp;
1600                         if ((vsm->scroller == 'v') && !(v2d->keepzoom & V2D_LOCKZOOM_Y))
1601                                 v2d->cur.ymin -= temp;
1602                         break;
1603                         
1604                 case SCROLLHANDLE_MAX:
1605                         
1606                         /* only expand view on axis if zoom is allowed */
1607                         if ((vsm->scroller == 'h') && !(v2d->keepzoom & V2D_LOCKZOOM_X))
1608                                 v2d->cur.xmax += temp;
1609                         if ((vsm->scroller == 'v') && !(v2d->keepzoom & V2D_LOCKZOOM_Y))
1610                                 v2d->cur.ymax += temp;
1611                         break;
1612                         
1613                 case SCROLLHANDLE_MIN_OUTSIDE:
1614                 case SCROLLHANDLE_MAX_OUTSIDE:
1615                 case SCROLLHANDLE_BAR:
1616                 default:
1617                         /* only move view on an axis if panning is allowed */
1618                         if ((vsm->scroller == 'h') && !(v2d->keepofs & V2D_LOCKOFS_X)) {
1619                                 v2d->cur.xmin += temp;
1620                                 v2d->cur.xmax += temp;
1621                         }
1622                         if ((vsm->scroller == 'v') && !(v2d->keepofs & V2D_LOCKOFS_Y)) {
1623                                 v2d->cur.ymin += temp;
1624                                 v2d->cur.ymax += temp;
1625                         }
1626                         break;
1627                         
1628         }
1629         
1630         /* validate that view is in valid configuration after this operation */
1631         UI_view2d_curRect_validate(v2d);
1632         
1633         /* request updates to be done... */
1634         ED_region_tag_redraw(vsm->ar);
1635         UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
1636 }
1637
1638 /* handle user input for scrollers - calculations of mouse-movement need to be done here, not in the apply callback! */
1639 static int scroller_activate_modal(bContext *C, wmOperator *op, const wmEvent *event)
1640 {
1641         v2dScrollerMove *vsm = op->customdata;
1642         
1643         /* execute the events */
1644         switch (event->type) {
1645                 case MOUSEMOVE:
1646                 {
1647                         /* calculate new delta transform, then store mouse-coordinates for next-time */
1648                         if (ELEM(vsm->zone, SCROLLHANDLE_BAR, SCROLLHANDLE_MAX)) {
1649                                 /* if using bar (i.e. 'panning') or 'max' zoom widget */
1650                                 switch (vsm->scroller) {
1651                                         case 'h': /* horizontal scroller - so only horizontal movement ('cur' moves opposite to mouse) */
1652                                                 vsm->delta = (float)(event->x - vsm->lastx);
1653                                                 break;
1654                                         case 'v': /* vertical scroller - so only vertical movement ('cur' moves opposite to mouse) */
1655                                                 vsm->delta = (float)(event->y - vsm->lasty);
1656                                                 break;
1657                                 }
1658                         }
1659                         else if (vsm->zone == SCROLLHANDLE_MIN) {
1660                                 /* using 'min' zoom widget */
1661                                 switch (vsm->scroller) {
1662                                         case 'h': /* horizontal scroller - so only horizontal movement ('cur' moves with mouse) */
1663                                                 vsm->delta = (float)(vsm->lastx - event->x);
1664                                                 break;
1665                                         case 'v': /* vertical scroller - so only vertical movement ('cur' moves with to mouse) */
1666                                                 vsm->delta = (float)(vsm->lasty - event->y);
1667                                                 break;
1668                                 }
1669                         }
1670                         
1671                         /* store previous coordinates */
1672                         vsm->lastx = event->x;
1673                         vsm->lasty = event->y;
1674                         
1675                         scroller_activate_apply(C, op);
1676                         break;
1677                 }
1678                 case LEFTMOUSE:
1679                 case MIDDLEMOUSE:
1680                         if (event->val == KM_RELEASE) {
1681                                 /* single-click was in empty space outside bubble, so scroll by 1 'page' */
1682                                 if (ELEM(vsm->zone, SCROLLHANDLE_MIN_OUTSIDE, SCROLLHANDLE_MAX_OUTSIDE)) {
1683                                         if (vsm->zone == SCROLLHANDLE_MIN_OUTSIDE)
1684                                                 vsm->delta = -vsm->scrollbarwidth * 0.8f;
1685                                         else if (vsm->zone == SCROLLHANDLE_MAX_OUTSIDE)
1686                                                 vsm->delta = vsm->scrollbarwidth * 0.8f;
1687                                         
1688                                         scroller_activate_apply(C, op);
1689                                         scroller_activate_exit(C, op);
1690                                         return OPERATOR_FINISHED;
1691                                 }
1692                                 
1693                                 /* otherwise, end the drag action  */
1694                                 if (vsm->lastx || vsm->lasty) {
1695                                         scroller_activate_exit(C, op);
1696                                         return OPERATOR_FINISHED;
1697                                 }
1698                         }
1699                         break;
1700
1701         }
1702
1703         return OPERATOR_RUNNING_MODAL;
1704 }
1705
1706
1707 /* a click (or click drag in progress) should have occurred, so check if it happened in scrollbar */
1708 static int scroller_activate_invoke(bContext *C, wmOperator *op, const wmEvent *event)
1709 {
1710         ARegion *ar = CTX_wm_region(C);
1711         View2D *v2d = &ar->v2d;
1712         short in_scroller = 0;
1713                 
1714         /* check if mouse in scrollbars, if they're enabled */
1715         in_scroller = UI_view2d_mouse_in_scrollers(C, v2d, event->x, event->y);
1716         
1717         /* if in a scroller, init customdata then set modal handler which will catch mousedown to start doing useful stuff */
1718         if (in_scroller) {
1719                 v2dScrollerMove *vsm;
1720                 
1721                 /* initialize customdata */
1722                 scroller_activate_init(C, op, event, in_scroller);
1723                 vsm = (v2dScrollerMove *)op->customdata;
1724                 
1725                 /* support for quick jump to location - gtk and qt do this on linux */
1726                 if (event->type == MIDDLEMOUSE) {
1727                         switch (vsm->scroller) {
1728                                 case 'h': /* horizontal scroller - so only horizontal movement ('cur' moves opposite to mouse) */
1729                                         vsm->delta = (float)(event->x - vsm->scrollbar_orig);
1730                                         break;
1731                                 case 'v': /* vertical scroller - so only vertical movement ('cur' moves opposite to mouse) */
1732                                         vsm->delta = (float)(event->y - vsm->scrollbar_orig);
1733                                         break;
1734                         }
1735                         scroller_activate_apply(C, op);
1736
1737                         vsm->zone = SCROLLHANDLE_BAR;
1738                 }
1739
1740                 /* check if zoom zones are inappropriate (i.e. zoom widgets not shown), so cannot continue
1741                  * NOTE: see view2d.c for latest conditions, and keep this in sync with that
1742                  */
1743                 if (ELEM(vsm->zone, SCROLLHANDLE_MIN, SCROLLHANDLE_MAX)) {
1744                         if (((vsm->scroller == 'h') && (v2d->scroll & V2D_SCROLL_SCALE_HORIZONTAL) == 0) ||
1745                             ((vsm->scroller == 'v') && (v2d->scroll & V2D_SCROLL_SCALE_VERTICAL) == 0))
1746                         {
1747                                 /* switch to bar (i.e. no scaling gets handled) */
1748                                 vsm->zone = SCROLLHANDLE_BAR;
1749                         }
1750                 }
1751                 
1752                 /* check if zone is inappropriate (i.e. 'bar' but panning is banned), so cannot continue */
1753                 if (vsm->zone == SCROLLHANDLE_BAR) {
1754                         if (((vsm->scroller == 'h') && (v2d->keepofs & V2D_LOCKOFS_X)) ||
1755                             ((vsm->scroller == 'v') && (v2d->keepofs & V2D_LOCKOFS_Y)))
1756                         {
1757                                 /* free customdata initialized */
1758                                 scroller_activate_exit(C, op);
1759                                 
1760                                 /* can't catch this event for ourselves, so let it go to someone else? */
1761                                 return OPERATOR_PASS_THROUGH;
1762                         }
1763                 }
1764                 
1765                 /* zone is also inappropriate if scroller is not visible... */
1766                 if (((vsm->scroller == 'h') && (v2d->scroll & (V2D_SCROLL_HORIZONTAL_FULLR))) ||
1767                     ((vsm->scroller == 'v') && (v2d->scroll & (V2D_SCROLL_VERTICAL_FULLR))) )
1768                 {
1769                         /* free customdata initialized */
1770                         scroller_activate_exit(C, op);
1771                                 
1772                         /* can't catch this event for ourselves, so let it go to someone else? */
1773                         /* XXX note: if handlers use mask rect to clip input, input will fail for this case */
1774                         return OPERATOR_PASS_THROUGH;
1775                 }
1776                 
1777                 /* activate the scroller */
1778                 if (vsm->scroller == 'h')
1779                         v2d->scroll_ui |= V2D_SCROLL_H_ACTIVE;
1780                 else
1781                         v2d->scroll_ui |= V2D_SCROLL_V_ACTIVE;
1782                 
1783                 /* still ok, so can add */
1784                 WM_event_add_modal_handler(C, op);
1785                 return OPERATOR_RUNNING_MODAL;
1786         }
1787         else {
1788                 /* not in scroller, so nothing happened... (pass through let's something else catch event) */
1789                 return OPERATOR_PASS_THROUGH;
1790         }
1791 }
1792
1793 /* LMB-Drag in Scrollers - not repeatable operator! */
1794 static void VIEW2D_OT_scroller_activate(wmOperatorType *ot)
1795 {
1796         /* identifiers */
1797         ot->name = "Scroller Activate";
1798         ot->description = "Scroll view by mouse click and drag";
1799         ot->idname = "VIEW2D_OT_scroller_activate";
1800
1801         /* flags */
1802         ot->flag = OPTYPE_BLOCKING;
1803         
1804         /* api callbacks */
1805         ot->invoke = scroller_activate_invoke;
1806         ot->modal = scroller_activate_modal;
1807         ot->cancel = scroller_activate_cancel;
1808
1809         ot->poll = view2d_poll;
1810 }
1811
1812 /* ********************************************************* */
1813 /* RESET */
1814
1815 static int reset_exec(bContext *C, wmOperator *UNUSED(op))
1816 {
1817         uiStyle *style = UI_GetStyle();
1818         ARegion *ar = CTX_wm_region(C);
1819         View2D *v2d = &ar->v2d;
1820         int winx, winy;
1821
1822         /* zoom 1.0 */
1823         winx = (float)(BLI_rcti_size_x(&v2d->mask) + 1);
1824         winy = (float)(BLI_rcti_size_y(&v2d->mask) + 1);
1825
1826         v2d->cur.xmax = v2d->cur.xmin + winx;
1827         v2d->cur.ymax = v2d->cur.ymin + winy;
1828         
1829         /* align */
1830         if (v2d->align) {
1831                 /* posx and negx flags are mutually exclusive, so watch out */
1832                 if ((v2d->align & V2D_ALIGN_NO_POS_X) && !(v2d->align & V2D_ALIGN_NO_NEG_X)) {
1833                         v2d->cur.xmax = 0.0f;
1834                         v2d->cur.xmin = -winx * style->panelzoom;
1835                 }
1836                 else if ((v2d->align & V2D_ALIGN_NO_NEG_X) && !(v2d->align & V2D_ALIGN_NO_POS_X)) {
1837                         v2d->cur.xmax = winx * style->panelzoom;
1838                         v2d->cur.xmin = 0.0f;
1839                 }
1840
1841                 /* - posx and negx flags are mutually exclusive, so watch out */
1842                 if ((v2d->align & V2D_ALIGN_NO_POS_Y) && !(v2d->align & V2D_ALIGN_NO_NEG_Y)) {
1843                         v2d->cur.ymax = 0.0f;
1844                         v2d->cur.ymin = -winy * style->panelzoom;
1845                 }
1846                 else if ((v2d->align & V2D_ALIGN_NO_NEG_Y) && !(v2d->align & V2D_ALIGN_NO_POS_Y)) {
1847                         v2d->cur.ymax = winy * style->panelzoom;
1848                         v2d->cur.ymin = 0.0f;
1849                 }
1850         }
1851
1852         /* validate that view is in valid configuration after this operation */
1853         UI_view2d_curRect_validate(v2d);
1854         
1855         /* request updates to be done... */
1856         ED_region_tag_redraw(ar);
1857         UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
1858         
1859         return OPERATOR_FINISHED;
1860 }
1861  
1862 static void VIEW2D_OT_reset(wmOperatorType *ot)
1863 {
1864         /* identifiers */
1865         ot->name = "Reset View";
1866         ot->description = "Reset the view";
1867         ot->idname = "VIEW2D_OT_reset";
1868         
1869         /* api callbacks */
1870         ot->exec = reset_exec;
1871         ot->poll = view2d_poll;
1872 }
1873  
1874 /* ********************************************************* */
1875 /* Registration */
1876
1877 void UI_view2d_operatortypes(void)
1878 {
1879         WM_operatortype_append(VIEW2D_OT_pan);
1880         
1881         WM_operatortype_append(VIEW2D_OT_scroll_left);
1882         WM_operatortype_append(VIEW2D_OT_scroll_right);
1883         WM_operatortype_append(VIEW2D_OT_scroll_up);
1884         WM_operatortype_append(VIEW2D_OT_scroll_down);
1885         
1886         WM_operatortype_append(VIEW2D_OT_zoom_in);
1887         WM_operatortype_append(VIEW2D_OT_zoom_out);
1888         
1889         WM_operatortype_append(VIEW2D_OT_zoom);
1890         WM_operatortype_append(VIEW2D_OT_zoom_border);
1891
1892         WM_operatortype_append(VIEW2D_OT_smoothview);
1893         
1894         WM_operatortype_append(VIEW2D_OT_scroller_activate);
1895
1896         WM_operatortype_append(VIEW2D_OT_reset);
1897 }
1898
1899 void UI_view2d_keymap(wmKeyConfig *keyconf)
1900 {
1901         wmKeyMap *keymap = WM_keymap_find(keyconf, "View2D", 0, 0);
1902         wmKeyMapItem *kmi;
1903
1904         /* scrollers */
1905         WM_keymap_add_item(keymap, "VIEW2D_OT_scroller_activate", LEFTMOUSE, KM_PRESS, 0, 0);
1906         WM_keymap_add_item(keymap, "VIEW2D_OT_scroller_activate", MIDDLEMOUSE, KM_PRESS, 0, 0);
1907
1908         /* pan/scroll */
1909         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MIDDLEMOUSE, KM_PRESS, 0, 0);
1910         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MIDDLEMOUSE, KM_PRESS, KM_SHIFT, 0);
1911         
1912         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MOUSEPAN, 0, 0, 0);
1913         
1914         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_right", WHEELDOWNMOUSE, KM_PRESS, KM_CTRL, 0);
1915         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_left", WHEELUPMOUSE, KM_PRESS, KM_CTRL, 0);
1916         
1917         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", WHEELDOWNMOUSE, KM_PRESS, KM_SHIFT, 0);
1918         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", WHEELUPMOUSE, KM_PRESS, KM_SHIFT, 0);
1919         
1920         /* zoom - single step */
1921         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_out", WHEELOUTMOUSE, KM_PRESS, 0, 0);
1922         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_in", WHEELINMOUSE, KM_PRESS, 0, 0);
1923         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_out", PADMINUS, KM_PRESS, 0, 0);
1924         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_in", PADPLUSKEY, KM_PRESS, 0, 0);
1925         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MOUSEPAN, 0, KM_CTRL, 0);
1926         
1927         WM_keymap_verify_item(keymap, "VIEW2D_OT_smoothview", TIMER1, KM_ANY, KM_ANY, 0);
1928
1929         /* scroll up/down - no modifiers, only when zoom fails */
1930         /* these may fail if zoom is disallowed, in which case they should pass on event */
1931         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", WHEELDOWNMOUSE, KM_PRESS, 0, 0);
1932         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", WHEELUPMOUSE, KM_PRESS, 0, 0);
1933         /* these may be necessary if vertical scroll is disallowed */
1934         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_right", WHEELDOWNMOUSE, KM_PRESS, 0, 0);
1935         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_left", WHEELUPMOUSE, KM_PRESS, 0, 0);
1936         
1937         /* alternatives for page up/down to scroll */
1938 #if 0 // XXX disabled, since this causes conflicts with hotkeys in animation editors
1939         /* scroll up/down may fall through to left/right */
1940         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", PAGEDOWNKEY, KM_PRESS, 0, 0);
1941         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", PAGEUPKEY, KM_PRESS, 0, 0);
1942         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_right", PAGEDOWNKEY, KM_PRESS, 0, 0);
1943         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_left", PAGEUPKEY, KM_PRESS, 0, 0);
1944         /* shift for moving view left/right with page up/down */
1945         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_right", PAGEDOWNKEY, KM_PRESS, KM_SHIFT, 0);
1946         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_left", PAGEUPKEY, KM_PRESS, KM_SHIFT, 0);
1947 #endif
1948         
1949         /* zoom - drag */
1950         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MIDDLEMOUSE, KM_PRESS, KM_CTRL, 0);
1951         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MOUSEZOOM, 0, 0, 0);
1952         
1953         /* borderzoom - drag */
1954         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_border", BKEY, KM_PRESS, KM_SHIFT, 0);
1955
1956         /* Alternative keymap for buttons listview */
1957         keymap = WM_keymap_find(keyconf, "View2D Buttons List", 0, 0);
1958
1959         WM_keymap_add_item(keymap, "VIEW2D_OT_scroller_activate", LEFTMOUSE, KM_PRESS, 0, 0);
1960         WM_keymap_add_item(keymap, "VIEW2D_OT_scroller_activate", MIDDLEMOUSE, KM_PRESS, 0, 0);
1961
1962         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MIDDLEMOUSE, KM_PRESS, 0, 0);
1963         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MOUSEPAN, 0, 0, 0);
1964         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", WHEELDOWNMOUSE, KM_PRESS, 0, 0);
1965         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", WHEELUPMOUSE, KM_PRESS, 0, 0);
1966         
1967         kmi = WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", PAGEDOWNKEY, KM_PRESS, 0, 0);
1968         RNA_boolean_set(kmi->ptr, "page", TRUE);
1969         kmi = WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", PAGEUPKEY, KM_PRESS, 0, 0);
1970         RNA_boolean_set(kmi->ptr, "page", TRUE);
1971         
1972         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MIDDLEMOUSE, KM_PRESS, KM_CTRL, 0);
1973         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MOUSEZOOM, 0, 0, 0);
1974         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MOUSEPAN, 0, KM_CTRL, 0);
1975         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_out", PADMINUS, KM_PRESS, 0, 0);
1976         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_in", PADPLUSKEY, KM_PRESS, 0, 0);
1977         WM_keymap_add_item(keymap, "VIEW2D_OT_reset", HOMEKEY, KM_PRESS, 0, 0);
1978 }
1979