f12a9e06312b25bdd5992e20da357546ddff6468
[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)(ar->winrct.xmax - ar->winrct.xmin + 1);
123         winy = (float)(ar->winrct.ymax - ar->winrct.ymin + 1);
124         vpd->facx = (v2d->cur.xmax - v2d->cur.xmin) / winx;
125         vpd->facy = (v2d->cur.ymax - v2d->cur.ymin) / 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", ar->v2d.mask.ymax - ar->v2d.mask.ymin);
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 = (v2d->cur.xmax - v2d->cur.xmin) * facx;
594                 dy = (v2d->cur.ymax - v2d->cur.ymin) * facy;
595         }
596         else {
597                 dx = ((v2d->cur.xmax - v2d->cur.xmin) / (1.0f + 2.0f * facx)) * facx;
598                 dy = ((v2d->cur.ymax - v2d->cur.ymin) / (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) / (v2d->cur.xmax - v2d->cur.xmin);
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) / (v2d->cur.ymax - v2d->cur.ymin);
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         /* check that there's an active region, as View2D data resides there */
676         if (!view_zoom_poll(C))
677                 return OPERATOR_PASS_THROUGH;
678         
679         /* set RNA-Props - zooming in by uniform factor */
680         RNA_float_set(op->ptr, "zoomfacx", 0.0375f);
681         RNA_float_set(op->ptr, "zoomfacy", 0.0375f);
682         
683         /* apply movement, then we're done */
684         view_zoomstep_apply(C, op);
685         
686         view_zoomstep_exit(op);
687         
688         return OPERATOR_FINISHED;
689 }
690
691 static int view_zoomin_invoke(bContext *C, wmOperator *op, wmEvent *event)
692 {
693         v2dViewZoomData *vzd;
694         
695         if (!view_zoomdrag_init(C, op))
696                 return OPERATOR_PASS_THROUGH;
697         
698         vzd = op->customdata;
699         
700         if (U.uiflag & USER_ZOOM_TO_MOUSEPOS) {
701                 ARegion *ar = CTX_wm_region(C);
702                 
703                 /* store initial mouse position (in view space) */
704                 UI_view2d_region_to_view(&ar->v2d, 
705                                          event->mval[0], event->mval[1],
706                                          &vzd->mx_2d, &vzd->my_2d);
707         }
708         
709         return view_zoomin_exec(C, op);
710 }
711
712 static void VIEW2D_OT_zoom_in(wmOperatorType *ot)
713 {
714         /* identifiers */
715         ot->name = "Zoom In";
716         ot->description = "Zoom in the view";
717         ot->idname = "VIEW2D_OT_zoom_in";
718         
719         /* api callbacks */
720         ot->invoke = view_zoomin_invoke;
721 //      ot->exec = view_zoomin_exec;  // XXX, needs view_zoomdrag_init called first.
722         ot->poll = view_zoom_poll;
723         
724         /* rna - must keep these in sync with the other operators */
725         RNA_def_float(ot->srna, "zoomfacx", 0, -FLT_MAX, FLT_MAX, "Zoom Factor X", "", -FLT_MAX, FLT_MAX);
726         RNA_def_float(ot->srna, "zoomfacy", 0, -FLT_MAX, FLT_MAX, "Zoom Factor Y", "", -FLT_MAX, FLT_MAX);
727 }
728         
729 /* this operator only needs this single callback, where it callsthe view_zoom_*() methods */
730 static int view_zoomout_exec(bContext *C, wmOperator *op)
731 {
732         /* check that there's an active region, as View2D data resides there */
733         if (!view_zoom_poll(C))
734                 return OPERATOR_PASS_THROUGH;
735         
736         /* set RNA-Props - zooming in by uniform factor */
737         RNA_float_set(op->ptr, "zoomfacx", -0.0375f);
738         RNA_float_set(op->ptr, "zoomfacy", -0.0375f);
739         
740         /* apply movement, then we're done */
741         view_zoomstep_apply(C, op);
742
743         view_zoomstep_exit(op);
744         
745         return OPERATOR_FINISHED;
746 }
747
748 static int view_zoomout_invoke(bContext *C, wmOperator *op, wmEvent *event)
749 {
750         v2dViewZoomData *vzd;
751         
752         if (!view_zoomdrag_init(C, op))
753                 return OPERATOR_PASS_THROUGH;
754
755         vzd = op->customdata;
756         
757         if (U.uiflag & USER_ZOOM_TO_MOUSEPOS) {
758                 ARegion *ar = CTX_wm_region(C);
759                 
760                 /* store initial mouse position (in view space) */
761                 UI_view2d_region_to_view(&ar->v2d, 
762                                          event->mval[0], event->mval[1],
763                                          &vzd->mx_2d, &vzd->my_2d);
764         }
765         
766         return view_zoomout_exec(C, op);
767 }
768
769 static void VIEW2D_OT_zoom_out(wmOperatorType *ot)
770 {
771         /* identifiers */
772         ot->name = "Zoom Out";
773         ot->description = "Zoom out the view";
774         ot->idname = "VIEW2D_OT_zoom_out";
775         
776         /* api callbacks */
777         ot->invoke = view_zoomout_invoke;
778 //      ot->exec = view_zoomout_exec; // XXX, needs view_zoomdrag_init called first.
779         ot->poll = view_zoom_poll;
780         
781         /* rna - must keep these in sync with the other operators */
782         RNA_def_float(ot->srna, "zoomfacx", 0, -FLT_MAX, FLT_MAX, "Zoom Factor X", "", -FLT_MAX, FLT_MAX);
783         RNA_def_float(ot->srna, "zoomfacy", 0, -FLT_MAX, FLT_MAX, "Zoom Factor Y", "", -FLT_MAX, FLT_MAX);
784 }
785
786 /* ********************************************************* */
787 /* DRAG-ZOOM OPERATOR                                                                    */
788
789 /*  MMB Drag - allows non-uniform scaling by dragging mouse
790  *
791  *      In order to make sure this works, each operator must define the following RNA-Operator Props:
792  *              deltax, deltay  - amounts to add to each side of the 'cur' rect
793  */
794
795 /* apply transform to view (i.e. adjust 'cur' rect) */
796 static void view_zoomdrag_apply(bContext *C, wmOperator *op)
797 {
798         v2dViewZoomData *vzd = op->customdata;
799         View2D *v2d = vzd->v2d;
800         float dx, dy;
801         
802         /* get amount to move view by */
803         dx = RNA_float_get(op->ptr, "deltax");
804         dy = RNA_float_get(op->ptr, "deltay");
805
806         /* continuous zoom shouldn't move that fast... */
807         if (U.viewzoom == USER_ZOOM_CONT) { // XXX store this setting as RNA prop?
808                 double time = PIL_check_seconds_timer();
809                 float time_step = (float)(time - vzd->timer_lastdraw);
810
811                 dx *= time_step * 0.5f;
812                 dy *= time_step * 0.5f;
813                 
814                 vzd->timer_lastdraw = time;
815         }
816
817         /* only move view on an axis if change is allowed */
818         if ((v2d->keepzoom & V2D_LOCKZOOM_X) == 0) {
819                 if (v2d->keepofs & V2D_LOCKOFS_X) {
820                         v2d->cur.xmax -= 2 * dx;
821                 }
822                 else {
823                         if (U.uiflag & USER_ZOOM_TO_MOUSEPOS) {
824                                 float mval_fac = (vzd->mx_2d - v2d->cur.xmin) / (v2d->cur.xmax - v2d->cur.xmin);
825                                 float mval_faci = 1.0f - mval_fac;
826                                 float ofs = (mval_fac * dx) - (mval_faci * dx);
827                                 
828                                 v2d->cur.xmin += ofs + dx;
829                                 v2d->cur.xmax += ofs - dx;
830                         }
831                         else {
832                                 v2d->cur.xmin += dx;
833                                 v2d->cur.xmax -= dx;
834                         }
835                 }
836         }
837         if ((v2d->keepzoom & V2D_LOCKZOOM_Y) == 0) {
838                 if (v2d->keepofs & V2D_LOCKOFS_Y) {
839                         v2d->cur.ymax -= 2 * dy;
840                 }
841                 else {
842                         if (U.uiflag & USER_ZOOM_TO_MOUSEPOS) {
843                                 float mval_fac = (vzd->my_2d - v2d->cur.ymin) / (v2d->cur.ymax - v2d->cur.ymin);
844                                 float mval_faci = 1.0f - mval_fac;
845                                 float ofs = (mval_fac * dy) - (mval_faci * dy);
846                                 
847                                 v2d->cur.ymin += ofs + dy;
848                                 v2d->cur.ymax += ofs - dy;
849                         }
850                         else {
851                                 v2d->cur.ymin += dy;
852                                 v2d->cur.ymax -= dy;
853                         }
854                 }
855         }
856         
857         /* validate that view is in valid configuration after this operation */
858         UI_view2d_curRect_validate(v2d);
859         
860         /* request updates to be done... */
861         ED_region_tag_redraw(vzd->ar);
862         UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
863 }
864
865 /* cleanup temp customdata  */
866 static void view_zoomdrag_exit(bContext *C, wmOperator *op)
867 {
868         if (op->customdata) {
869                 v2dViewZoomData *vzd = op->customdata;
870                 
871                 if (vzd->timer)
872                         WM_event_remove_timer(CTX_wm_manager(C), CTX_wm_window(C), vzd->timer);
873                 
874                 MEM_freeN(op->customdata);
875                 op->customdata = NULL;
876         }
877
878
879 static int view_zoomdrag_cancel(bContext *C, wmOperator *op)
880 {
881         view_zoomdrag_exit(C, op);
882
883         return OPERATOR_CANCELLED;
884 }
885
886 /* for 'redo' only, with no user input */
887 static int view_zoomdrag_exec(bContext *C, wmOperator *op)
888 {
889         if (!view_zoomdrag_init(C, op))
890                 return OPERATOR_PASS_THROUGH;
891         
892         view_zoomdrag_apply(C, op);
893         view_zoomdrag_exit(C, op);
894         return OPERATOR_FINISHED;
895 }
896
897 /* set up modal operator and relevant settings */
898 static int view_zoomdrag_invoke(bContext *C, wmOperator *op, wmEvent *event)
899 {
900         wmWindow *window = CTX_wm_window(C);
901         v2dViewZoomData *vzd;
902         View2D *v2d;
903         
904         /* set up customdata */
905         if (!view_zoomdrag_init(C, op))
906                 return OPERATOR_PASS_THROUGH;
907         
908         vzd = op->customdata;
909         v2d = vzd->v2d;
910         
911         if (event->type == MOUSEZOOM) {
912                 float dx, dy, fac;
913                 
914                 vzd->lastx = event->prevx;
915                 vzd->lasty = event->prevy;
916                 
917                 /* As we have only 1D information (magnify value), feed both axes
918                  * with magnify information that is stored in x axis 
919                  */
920                 fac = 0.01f * (event->x - event->prevx);
921                 dx = fac * (v2d->cur.xmax - v2d->cur.xmin) / 10.0f;
922                 dy = fac * (v2d->cur.ymax - v2d->cur.ymin) / 10.0f;
923
924                 RNA_float_set(op->ptr, "deltax", dx);
925                 RNA_float_set(op->ptr, "deltay", dy);
926                 
927                 view_zoomdrag_apply(C, op);
928                 view_zoomdrag_exit(C, op);
929                 return OPERATOR_FINISHED;
930         }       
931         
932         /* set initial settings */
933         vzd->lastx = event->x;
934         vzd->lasty = event->y;
935         RNA_float_set(op->ptr, "deltax", 0);
936         RNA_float_set(op->ptr, "deltay", 0);
937         
938         /* for modal exit test */
939         vzd->invoke_event = event->type;
940         
941         if (U.uiflag & USER_ZOOM_TO_MOUSEPOS) {
942                 ARegion *ar = CTX_wm_region(C);
943                 
944                 /* store initial mouse position (in view space) */
945                 UI_view2d_region_to_view(&ar->v2d, 
946                                          event->mval[0], event->mval[1],
947                                          &vzd->mx_2d, &vzd->my_2d);
948         }
949
950         if (v2d->keepofs & V2D_LOCKOFS_X)
951                 WM_cursor_modal(window, BC_NS_SCROLLCURSOR);
952         else if (v2d->keepofs & V2D_LOCKOFS_Y)
953                 WM_cursor_modal(window, BC_EW_SCROLLCURSOR);
954         else
955                 WM_cursor_modal(window, BC_NSEW_SCROLLCURSOR);
956         
957         /* add temp handler */
958         WM_event_add_modal_handler(C, op);
959
960         if (U.viewzoom == USER_ZOOM_CONT) {
961                 /* needs a timer to continue redrawing */
962                 vzd->timer = WM_event_add_timer(CTX_wm_manager(C), CTX_wm_window(C), TIMER, 0.01f);
963                 vzd->timer_lastdraw = PIL_check_seconds_timer();
964         }
965
966         return OPERATOR_RUNNING_MODAL;
967 }
968
969 /* handle user input - calculations of mouse-movement need to be done here, not in the apply callback! */
970 static int view_zoomdrag_modal(bContext *C, wmOperator *op, wmEvent *event)
971 {
972         v2dViewZoomData *vzd = op->customdata;
973         View2D *v2d = vzd->v2d;
974         
975         /* execute the events */
976         if (event->type == TIMER && event->customdata == vzd->timer) {
977                 view_zoomdrag_apply(C, op);
978         }
979         else if (event->type == MOUSEMOVE) {
980                 float dx, dy;
981                 
982                 /* calculate new delta transform, based on zooming mode */
983                 if (U.viewzoom == USER_ZOOM_SCALE) {
984                         /* 'scale' zooming */
985                         float dist;
986                         
987                         /* x-axis transform */
988                         dist = (v2d->mask.xmax - v2d->mask.xmin) / 2.0f;
989                         dx = 1.0f - (fabsf(vzd->lastx - dist) + 2.0f) / (fabsf(event->x - dist) + 2.0f);
990                         dx *= 0.5f * (v2d->cur.xmax - v2d->cur.xmin);
991                         
992                         /* y-axis transform */
993                         dist = (v2d->mask.ymax - v2d->mask.ymin) / 2.0f;
994                         dy = 1.0f - (fabsf(vzd->lasty - dist) + 2.0f) / (fabsf(event->y - dist) + 2.0f);
995                         dy *= 0.5f * (v2d->cur.ymax - v2d->cur.ymin);
996                 }
997                 else {
998                         /* 'continuous' or 'dolly' */
999                         float fac;
1000                         
1001                         /* x-axis transform */
1002                         fac = 0.01f * (event->x - vzd->lastx);
1003                         dx = fac * (v2d->cur.xmax - v2d->cur.xmin);
1004                         
1005                         /* y-axis transform */
1006                         fac = 0.01f * (event->y - vzd->lasty);
1007                         dy = fac * (v2d->cur.ymax - v2d->cur.ymin);
1008 #if 0
1009                         /* continuous zoom shouldn't move that fast... */
1010                         if (U.viewzoom == USER_ZOOM_CONT) { // XXX store this setting as RNA prop?
1011                                 double time = PIL_check_seconds_timer();
1012                                 float time_step = (float)(time - vzd->timer_lastdraw);
1013
1014                                 dx /= (0.1f / time_step);
1015                                 dy /= (0.1f / time_step);
1016                                 
1017                                 vzd->timer_lastdraw = time;
1018                         }
1019 #endif
1020                 }
1021                 
1022                 /* set transform amount, and add current deltas to stored total delta (for redo) */
1023                 RNA_float_set(op->ptr, "deltax", dx);
1024                 RNA_float_set(op->ptr, "deltay", dy);
1025                 vzd->dx += dx;
1026                 vzd->dy += dy;
1027                 
1028                 /* store mouse coordinates for next time, if not doing continuous zoom
1029                  *      - continuous zoom only depends on distance of mouse to starting point to determine rate of change
1030                  */
1031                 if (U.viewzoom != USER_ZOOM_CONT) { // XXX store this setting as RNA prop?
1032                         vzd->lastx = event->x;
1033                         vzd->lasty = event->y;
1034                 }
1035                 
1036                 /* apply zooming */
1037                 view_zoomdrag_apply(C, op);
1038         } 
1039         else if (event->type == vzd->invoke_event || event->type == ESCKEY) {
1040                 if (event->val == KM_RELEASE) {
1041                         
1042                         /* for redo, store the overall deltas - need to respect zoom-locks here... */
1043                         if ((v2d->keepzoom & V2D_LOCKZOOM_X) == 0)
1044                                 RNA_float_set(op->ptr, "deltax", vzd->dx);
1045                         else
1046                                 RNA_float_set(op->ptr, "deltax", 0);
1047                                 
1048                         if ((v2d->keepzoom & V2D_LOCKZOOM_Y) == 0)
1049                                 RNA_float_set(op->ptr, "deltay", vzd->dy);
1050                         else
1051                                 RNA_float_set(op->ptr, "deltay", 0);
1052                         
1053                         /* free customdata */
1054                         view_zoomdrag_exit(C, op);
1055                         WM_cursor_restore(CTX_wm_window(C));
1056                         
1057                         return OPERATOR_FINISHED;
1058                 }
1059         }
1060
1061         return OPERATOR_RUNNING_MODAL;
1062 }
1063
1064 static void VIEW2D_OT_zoom(wmOperatorType *ot)
1065 {
1066         /* identifiers */
1067         ot->name = "Zoom 2D View";
1068         ot->description = "Zoom in/out the view";
1069         ot->idname = "VIEW2D_OT_zoom";
1070         
1071         /* api callbacks */
1072         ot->exec = view_zoomdrag_exec;
1073         ot->invoke = view_zoomdrag_invoke;
1074         ot->modal = view_zoomdrag_modal;
1075         ot->cancel = view_zoomdrag_cancel;
1076         
1077         ot->poll = view_zoom_poll;
1078         
1079         /* operator is repeatable */
1080         // ot->flag = OPTYPE_BLOCKING;
1081         
1082         /* rna - must keep these in sync with the other operators */
1083         RNA_def_float(ot->srna, "deltax", 0, -FLT_MAX, FLT_MAX, "Delta X", "", -FLT_MAX, FLT_MAX);
1084         RNA_def_float(ot->srna, "deltay", 0, -FLT_MAX, FLT_MAX, "Delta Y", "", -FLT_MAX, FLT_MAX);
1085 }
1086
1087 /* ********************************************************* */
1088 /* BORDER-ZOOM */
1089
1090 /* The user defines a rect using standard borderselect tools, and we use this rect to 
1091  * define the new zoom-level of the view in the following ways:
1092  *      1) LEFTMOUSE - zoom in to view
1093  *      2) RIGHTMOUSE - zoom out of view
1094  *
1095  * Currently, these key mappings are hardcoded, but it shouldn't be too important to
1096  * have custom keymappings for this...
1097  */
1098  
1099 static int view_borderzoom_exec(bContext *C, wmOperator *op)
1100 {
1101         ARegion *ar = CTX_wm_region(C);
1102         View2D *v2d = &ar->v2d;
1103         rctf rect;
1104         rctf cur_new = v2d->cur;
1105         int gesture_mode;
1106         
1107         /* convert coordinates of rect to 'tot' rect coordinates */
1108         UI_view2d_region_to_view(v2d, RNA_int_get(op->ptr, "xmin"), RNA_int_get(op->ptr, "ymin"), &rect.xmin, &rect.ymin);
1109         UI_view2d_region_to_view(v2d, RNA_int_get(op->ptr, "xmax"), RNA_int_get(op->ptr, "ymax"), &rect.xmax, &rect.ymax);
1110         
1111         /* check if zooming in/out view */
1112         gesture_mode = RNA_int_get(op->ptr, "gesture_mode");
1113         
1114         if (gesture_mode == GESTURE_MODAL_IN) {
1115                 /* zoom in: 
1116                  *      - 'cur' rect will be defined by the coordinates of the border region 
1117                  *      - just set the 'cur' rect to have the same coordinates as the border region
1118                  *        if zoom is allowed to be changed
1119                  */
1120                 if ((v2d->keepzoom & V2D_LOCKZOOM_X) == 0) {
1121                         cur_new.xmin = rect.xmin;
1122                         cur_new.xmax = rect.xmax;
1123                 }
1124                 if ((v2d->keepzoom & V2D_LOCKZOOM_Y) == 0) {
1125                         cur_new.ymin = rect.ymin;
1126                         cur_new.ymax = rect.ymax;
1127                 }
1128         }
1129         else { /* if (gesture_mode == GESTURE_MODAL_OUT) */
1130
1131                 /* zoom out:
1132                  *      - the current 'cur' rect coordinates are going to end up where the 'rect' ones are,
1133                  *        but the 'cur' rect coordinates will need to be adjusted to take in more of the view
1134                  *      - calculate zoom factor, and adjust using center-point
1135                  */
1136                 float zoom, center, size;
1137                 
1138                 /* TODO: is this zoom factor calculation valid? It seems to produce same results everytime... */
1139                 if ((v2d->keepzoom & V2D_LOCKZOOM_X) == 0) {
1140                         size = (cur_new.xmax - cur_new.xmin);
1141                         zoom = size / (rect.xmax - rect.xmin);
1142                         center = BLI_RCT_CENTER_X(&cur_new);
1143                         
1144                         cur_new.xmin = center - (size * zoom);
1145                         cur_new.xmax = center + (size * zoom);
1146                 }
1147                 if ((v2d->keepzoom & V2D_LOCKZOOM_Y) == 0) {
1148                         size = (cur_new.ymax - cur_new.ymin);
1149                         zoom = size / (rect.ymax - rect.ymin);
1150                         center = BLI_RCT_CENTER_Y(&cur_new);
1151                         
1152                         cur_new.ymin = center - (size * zoom);
1153                         cur_new.ymax = center + (size * zoom);
1154                 }
1155         }
1156         
1157         UI_view2d_smooth_view(C, ar, &cur_new);
1158         
1159         return OPERATOR_FINISHED;
1160
1161
1162 static void VIEW2D_OT_zoom_border(wmOperatorType *ot)
1163 {
1164         /* identifiers */
1165         ot->name = "Zoom to Border";
1166         ot->description = "Zoom in the view to the nearest item contained in the border";
1167         ot->idname = "VIEW2D_OT_zoom_border";
1168         
1169         /* api callbacks */
1170         ot->invoke = WM_border_select_invoke;
1171         ot->exec = view_borderzoom_exec;
1172         ot->modal = WM_border_select_modal;
1173         ot->cancel = WM_border_select_cancel;
1174         
1175         ot->poll = view_zoom_poll;
1176         
1177         /* rna */
1178         WM_operator_properties_gesture_border(ot, FALSE);
1179 }
1180
1181 /* ********************************************************* */
1182 /* SMOOTH VIEW */
1183
1184 struct SmoothView2DStore {
1185         rctf orig_cur, new_cur;
1186
1187         double time_allowed;
1188 };
1189
1190 /**
1191  * function to get a factor out of a rectangle
1192  *
1193  * note: this doesn't always work as well as it might because the target size
1194  *       may not be reached because of clamping the desired rect, we _could_
1195  *       attempt to clamp the rect before working out the zoom factor but its
1196  *       not really worthwhile for the few cases this happens.
1197  */
1198 static float smooth_view_rect_to_fac(const rctf *rect_a, const rctf *rect_b)
1199 {
1200         float size_a[2] = {rect_a->xmax - rect_a->xmin,
1201                            rect_a->ymax - rect_a->ymin};
1202         float size_b[2] = {rect_b->xmax - rect_b->xmin,
1203                            rect_b->ymax - rect_b->ymin};
1204         float cent_a[2] = {BLI_RCT_CENTER_X(rect_a),
1205                            BLI_RCT_CENTER_Y(rect_a)};
1206         float cent_b[2] = {BLI_RCT_CENTER_X(rect_b),
1207                            BLI_RCT_CENTER_Y(rect_b)};
1208
1209         float fac_max = 0.0f;
1210         float tfac;
1211
1212         int i;
1213
1214         for (i = 0; i < 2; i++) {
1215                 /* axis translation normalized to scale */
1216                 tfac = fabsf(cent_a[i] - cent_b[i]) / minf(size_a[i], size_b[i]);
1217                 fac_max = maxf(fac_max, tfac);
1218                 if (fac_max >= 1.0f) break;
1219
1220                 /* axis scale difference, x2 so doubling or half gives 1.0f */
1221                 tfac = (1.0f - (minf(size_a[i], size_b[i]) / maxf(size_a[i], size_b[i]))) * 2.0f;
1222                 fac_max = maxf(fac_max, tfac);
1223                 if (fac_max >= 1.0f) break;
1224         }
1225         return minf(fac_max, 1.0f);
1226 }
1227
1228 /* will start timer if appropriate */
1229 /* the arguments are the desired situation */
1230 void UI_view2d_smooth_view(bContext *C, ARegion *ar,
1231                            const rctf *cur)
1232 {
1233         wmWindowManager *wm = CTX_wm_manager(C);
1234         wmWindow *win = CTX_wm_window(C);
1235
1236         View2D *v2d = &ar->v2d;
1237         struct SmoothView2DStore sms = {{0}};
1238         short ok = FALSE;
1239         float fac = 1.0f;
1240
1241         /* initialize sms */
1242         sms.new_cur = v2d->cur;
1243
1244         /* store the options we want to end with */
1245         if (cur) sms.new_cur = *cur;
1246
1247         if (cur) {
1248                 fac = smooth_view_rect_to_fac(&v2d->cur, cur);
1249         }
1250
1251         if (C && U.smooth_viewtx && fac > FLT_EPSILON) {
1252                 int changed = 0; /* zero means no difference */
1253
1254                 if (BLI_rctf_compare(&sms.new_cur, &v2d->cur, FLT_EPSILON) == FALSE)
1255                         changed = 1;
1256                 changed=1;
1257
1258                 /* The new view is different from the old one
1259                  * so animate the view */
1260                 if (changed) {
1261                         sms.orig_cur = v2d->cur;
1262
1263                         sms.time_allowed = (double)U.smooth_viewtx / 1000.0;
1264
1265                         /* scale the time allowed the change in view */
1266                         sms.time_allowed *= (double)fac;
1267
1268                         /* keep track of running timer! */
1269                         if (v2d->sms == NULL)
1270                                 v2d->sms = MEM_mallocN(sizeof(struct SmoothView2DStore), "smoothview v2d");
1271                         *v2d->sms = sms;
1272                         if (v2d->smooth_timer)
1273                                 WM_event_remove_timer(wm, win, v2d->smooth_timer);
1274                         /* TIMER1 is hardcoded in keymap */
1275                         v2d->smooth_timer = WM_event_add_timer(wm, win, TIMER1, 1.0 / 100.0); /* max 30 frs/sec */
1276
1277                         ok = TRUE;
1278                 }
1279         }
1280
1281         /* if we get here nothing happens */
1282         if (ok == FALSE) {
1283                 v2d->cur = sms.new_cur;
1284
1285                 UI_view2d_curRect_validate(v2d);
1286                 ED_region_tag_redraw(ar);
1287                 UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
1288         }
1289 }
1290
1291 /* only meant for timer usage */
1292 static int view2d_smoothview_invoke(bContext *C, wmOperator *UNUSED(op), wmEvent *event)
1293 {
1294         ARegion *ar = CTX_wm_region(C);
1295         View2D *v2d = &ar->v2d;
1296         struct SmoothView2DStore *sms = v2d->sms;
1297         float step;
1298
1299         /* escape if not our timer */
1300         if (v2d->smooth_timer == NULL || v2d->smooth_timer != event->customdata)
1301                 return OPERATOR_PASS_THROUGH;
1302
1303         if (sms->time_allowed != 0.0)
1304                 step = (float)((v2d->smooth_timer->duration) / sms->time_allowed);
1305         else
1306                 step = 1.0f;
1307
1308         /* end timer */
1309         if (step >= 1.0f) {
1310                 v2d->cur = sms->new_cur;
1311
1312                 MEM_freeN(v2d->sms);
1313                 v2d->sms = NULL;
1314
1315                 WM_event_remove_timer(CTX_wm_manager(C), CTX_wm_window(C), v2d->smooth_timer);
1316                 v2d->smooth_timer = NULL;
1317         }
1318         else {
1319                 /* ease in/out */
1320                 step = (3.0f * step * step - 2.0f * step * step * step);
1321
1322                 BLI_rctf_interp(&v2d->cur, &sms->orig_cur, &sms->new_cur, step);
1323         }
1324
1325         UI_view2d_curRect_validate(v2d);
1326         UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
1327         ED_region_tag_redraw(ar);
1328
1329         return OPERATOR_FINISHED;
1330 }
1331
1332 static void VIEW2D_OT_smoothview(wmOperatorType *ot)
1333 {
1334         /* identifiers */
1335         ot->name = "Smooth View 2D";
1336         ot->description = "Zoom in the view to the nearest item contained in the border";
1337         ot->idname = "VIEW2D_OT_smoothview";
1338
1339         /* api callbacks */
1340         ot->invoke = view2d_smoothview_invoke;
1341
1342         ot->poll = view2d_poll;
1343
1344         /* rna */
1345         WM_operator_properties_gesture_border(ot, FALSE);
1346 }
1347
1348 /* ********************************************************* */
1349 /* SCROLLERS */
1350
1351 /*  Scrollers should behave in the following ways, when clicked on with LMB (and dragged):
1352  *              1) 'Handles' on end of 'bubble' - when the axis that the scroller represents is zoomable, 
1353  *                      enlarge 'cur' rect on the relevant side 
1354  *              2) 'Bubble'/'bar' - just drag, and bar should move with mouse (view pans opposite)
1355  *
1356  *      In order to make sure this works, each operator must define the following RNA-Operator Props:
1357  *              deltax, deltay  - define how much to move view by (relative to zoom-correction factor)
1358  */
1359
1360 /* customdata for scroller-invoke data */
1361 typedef struct v2dScrollerMove {
1362         View2D *v2d;            /* View2D data that this operation affects */
1363         ARegion *ar;            /* region that the scroller is in */
1364         
1365         short scroller;         /* scroller that mouse is in ('h' or 'v') */
1366         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?)
1367         
1368         float fac;              /* view adjustment factor, based on size of region */
1369         float delta;            /* amount moved by mouse on axis of interest */
1370         
1371         float scrollbarwidth;   /* width of the scrollbar itself, used for page up/down clicks */
1372         int scrollbar_orig;      /* initial location of scrollbar x/y, mouse relative */
1373         
1374         int lastx, lasty;       /* previous mouse coordinates (in screen coordinates) for determining movement */
1375 } v2dScrollerMove;
1376
1377
1378 /* View2DScrollers is typedef'd in UI_view2d.h 
1379  * This is a CUT DOWN VERSION of the 'real' version, which is defined in view2d.c, as we only need focus bubble info
1380  * WARNING: the start of this struct must not change, so that it stays in sync with the 'real' version
1381  *         For now, we don't need to have a separate (internal) header for structs like this...
1382  */
1383 struct View2DScrollers {        
1384         /* focus bubbles */
1385         int vert_min, vert_max; /* vertical scrollbar */
1386         int hor_min, hor_max;   /* horizontal scrollbar */
1387 };
1388
1389 /* quick enum for vsm->zone (scroller handles) */
1390 enum {
1391         SCROLLHANDLE_MIN = -1,
1392         SCROLLHANDLE_BAR,
1393         SCROLLHANDLE_MAX,
1394         SCROLLHANDLE_MIN_OUTSIDE,
1395         SCROLLHANDLE_MAX_OUTSIDE
1396 } /*eV2DScrollerHandle_Zone*/;
1397
1398 /* ------------------------ */
1399
1400 /* check if mouse is within scroller handle 
1401  *      - mouse                 =   relevant mouse coordinate in region space
1402  *      - sc_min, sc_max        =   extents of scroller 'groove' (potential available space for scroller)
1403  *      - sh_min, sh_max        =   positions of scrollbar handles
1404  */
1405 static short mouse_in_scroller_handle(int mouse, int sc_min, int sc_max, int sh_min, int sh_max)
1406 {
1407         short in_min, in_max, in_bar, out_min, out_max, in_view = 1;
1408         
1409         /* firstly, check if 
1410          *      - 'bubble' fills entire scroller 
1411          *      - 'bubble' completely out of view on either side 
1412          */
1413         if ((sh_min <= sc_min) && (sh_max >= sc_max)) in_view = 0;
1414         if (sh_min == sh_max) {
1415                 if (sh_min <= sc_min) in_view = 0;
1416                 if (sh_max >= sc_max) in_view = 0;
1417         }
1418         else {
1419                 if (sh_max <= sc_min) in_view = 0;
1420                 if (sh_min >= sc_max) in_view = 0;
1421         }
1422         
1423         
1424         if (in_view == 0) {
1425                 return SCROLLHANDLE_BAR;
1426         }
1427         
1428         /* check if mouse is in or past either handle */
1429         /* TODO: check if these extents are still valid or not */
1430         in_max = ( (mouse >= (sh_max - V2D_SCROLLER_HANDLE_SIZE)) && (mouse <= (sh_max + V2D_SCROLLER_HANDLE_SIZE)) );
1431         in_min = ( (mouse <= (sh_min + V2D_SCROLLER_HANDLE_SIZE)) && (mouse >= (sh_min - V2D_SCROLLER_HANDLE_SIZE)) );
1432         in_bar = ( (mouse < (sh_max - V2D_SCROLLER_HANDLE_SIZE)) && (mouse > (sh_min + V2D_SCROLLER_HANDLE_SIZE)) );
1433         out_min = mouse < (sh_min - V2D_SCROLLER_HANDLE_SIZE);
1434         out_max = mouse > (sh_max + V2D_SCROLLER_HANDLE_SIZE);
1435         
1436         if (in_bar)
1437                 return SCROLLHANDLE_BAR;
1438         else if (in_max)
1439                 return SCROLLHANDLE_MAX;
1440         else if (in_min)
1441                 return SCROLLHANDLE_MIN;
1442         else if (out_min)
1443                 return SCROLLHANDLE_MIN_OUTSIDE;                          
1444         else if (out_max)
1445                 return SCROLLHANDLE_MAX_OUTSIDE;
1446         
1447         /* unlikely to happen, though we just cover it in case */
1448         return SCROLLHANDLE_BAR;
1449
1450
1451 /* initialize customdata for scroller manipulation operator */
1452 static void scroller_activate_init(bContext *C, wmOperator *op, wmEvent *event, short in_scroller)
1453 {
1454         v2dScrollerMove *vsm;
1455         View2DScrollers *scrollers;
1456         ARegion *ar = CTX_wm_region(C);
1457         View2D *v2d = &ar->v2d;
1458         float mask_size;
1459         
1460         /* set custom-data for operator */
1461         vsm = MEM_callocN(sizeof(v2dScrollerMove), "v2dScrollerMove");
1462         op->customdata = vsm;
1463         
1464         /* set general data */
1465         vsm->v2d = v2d;
1466         vsm->ar = ar;
1467         vsm->scroller = in_scroller;
1468
1469         /* store mouse-coordinates, and convert mouse/screen coordinates to region coordinates */
1470         vsm->lastx = event->x;
1471         vsm->lasty = event->y;
1472         /* 'zone' depends on where mouse is relative to bubble 
1473          *      - zooming must be allowed on this axis, otherwise, default to pan
1474          */
1475         scrollers = UI_view2d_scrollers_calc(C, v2d, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY);
1476
1477
1478         if (in_scroller == 'h') {
1479                 /* horizontal scroller - calculate adjustment factor first */
1480                 mask_size = (float)(v2d->hor.xmax - v2d->hor.xmin);
1481                 vsm->fac = (v2d->tot.xmax - v2d->tot.xmin) / mask_size;
1482                 
1483                 /* get 'zone' (i.e. which part of scroller is activated) */
1484                 vsm->zone = mouse_in_scroller_handle(event->mval[0], v2d->hor.xmin, v2d->hor.xmax, scrollers->hor_min, scrollers->hor_max);
1485                 
1486                 if ((v2d->keepzoom & V2D_LOCKZOOM_X) && ELEM(vsm->zone, SCROLLHANDLE_MIN, SCROLLHANDLE_MAX)) {
1487                         /* default to scroll, as handles not usable */
1488                         vsm->zone = SCROLLHANDLE_BAR;
1489                 }
1490
1491                 vsm->scrollbarwidth = scrollers->hor_max - scrollers->hor_min;
1492                 vsm->scrollbar_orig = ((scrollers->hor_max + scrollers->hor_min) / 2) + ar->winrct.xmin;
1493         }
1494         else {
1495                 /* vertical scroller - calculate adjustment factor first */
1496                 mask_size = (float)(v2d->vert.ymax - v2d->vert.ymin);
1497                 vsm->fac = (v2d->tot.ymax - v2d->tot.ymin) / mask_size;
1498                 
1499                 /* get 'zone' (i.e. which part of scroller is activated) */
1500                 vsm->zone = mouse_in_scroller_handle(event->mval[1], v2d->vert.ymin, v2d->vert.ymax, scrollers->vert_min, scrollers->vert_max);
1501                         
1502                 if ((v2d->keepzoom & V2D_LOCKZOOM_Y) && ELEM(vsm->zone, SCROLLHANDLE_MIN, SCROLLHANDLE_MAX)) {
1503                         /* default to scroll, as handles not usable */
1504                         vsm->zone = SCROLLHANDLE_BAR;
1505                 }
1506                 
1507                 vsm->scrollbarwidth = scrollers->vert_max - scrollers->vert_min;
1508                 vsm->scrollbar_orig = ((scrollers->vert_max + scrollers->vert_min) / 2) +  +ar->winrct.ymin;
1509         }
1510         
1511         UI_view2d_scrollers_free(scrollers);
1512         ED_region_tag_redraw(ar);
1513 }
1514
1515 /* cleanup temp customdata  */
1516 static void scroller_activate_exit(bContext *C, wmOperator *op)
1517 {
1518         if (op->customdata) {
1519                 v2dScrollerMove *vsm = op->customdata;
1520
1521                 vsm->v2d->scroll_ui &= ~(V2D_SCROLL_H_ACTIVE | V2D_SCROLL_V_ACTIVE);
1522                 
1523                 MEM_freeN(op->customdata);
1524                 op->customdata = NULL;
1525                 
1526                 ED_region_tag_redraw(CTX_wm_region(C));
1527         }
1528 }
1529
1530 static int scroller_activate_cancel(bContext *C, wmOperator *op)
1531 {
1532         scroller_activate_exit(C, op);
1533
1534         return OPERATOR_CANCELLED;
1535 }
1536
1537 /* apply transform to view (i.e. adjust 'cur' rect) */
1538 static void scroller_activate_apply(bContext *C, wmOperator *op)
1539 {
1540         v2dScrollerMove *vsm = op->customdata;
1541         View2D *v2d = vsm->v2d;
1542         float temp;
1543         
1544         /* calculate amount to move view by */
1545         temp = vsm->fac * vsm->delta;
1546         
1547         /* type of movement */
1548         switch (vsm->zone) {
1549                 case SCROLLHANDLE_MIN:
1550                         /* only expand view on axis if zoom is allowed */
1551                         if ((vsm->scroller == 'h') && !(v2d->keepzoom & V2D_LOCKZOOM_X))
1552                                 v2d->cur.xmin -= temp;
1553                         if ((vsm->scroller == 'v') && !(v2d->keepzoom & V2D_LOCKZOOM_Y))
1554                                 v2d->cur.ymin -= temp;
1555                         break;
1556                         
1557                 case SCROLLHANDLE_MAX:
1558                         
1559                         /* only expand view on axis if zoom is allowed */
1560                         if ((vsm->scroller == 'h') && !(v2d->keepzoom & V2D_LOCKZOOM_X))
1561                                 v2d->cur.xmax += temp;
1562                         if ((vsm->scroller == 'v') && !(v2d->keepzoom & V2D_LOCKZOOM_Y))
1563                                 v2d->cur.ymax += temp;
1564                         break;
1565                         
1566                 case SCROLLHANDLE_MIN_OUTSIDE:
1567                 case SCROLLHANDLE_MAX_OUTSIDE:
1568                 case SCROLLHANDLE_BAR:
1569                 default:
1570                         /* only move view on an axis if panning is allowed */
1571                         if ((vsm->scroller == 'h') && !(v2d->keepofs & V2D_LOCKOFS_X)) {
1572                                 v2d->cur.xmin += temp;
1573                                 v2d->cur.xmax += temp;
1574                         }
1575                         if ((vsm->scroller == 'v') && !(v2d->keepofs & V2D_LOCKOFS_Y)) {
1576                                 v2d->cur.ymin += temp;
1577                                 v2d->cur.ymax += temp;
1578                         }
1579                         break;
1580                         
1581         }
1582         
1583         /* validate that view is in valid configuration after this operation */
1584         UI_view2d_curRect_validate(v2d);
1585         
1586         /* request updates to be done... */
1587         ED_region_tag_redraw(vsm->ar);
1588         UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
1589 }
1590
1591 /* handle user input for scrollers - calculations of mouse-movement need to be done here, not in the apply callback! */
1592 static int scroller_activate_modal(bContext *C, wmOperator *op, wmEvent *event)
1593 {
1594         v2dScrollerMove *vsm = op->customdata;
1595         
1596         /* execute the events */
1597         switch (event->type) {
1598                 case MOUSEMOVE:
1599                 {
1600                         /* calculate new delta transform, then store mouse-coordinates for next-time */
1601                         if (ELEM(vsm->zone, SCROLLHANDLE_BAR, SCROLLHANDLE_MAX)) {
1602                                 /* if using bar (i.e. 'panning') or 'max' zoom widget */
1603                                 switch (vsm->scroller) {
1604                                         case 'h': /* horizontal scroller - so only horizontal movement ('cur' moves opposite to mouse) */
1605                                                 vsm->delta = (float)(event->x - vsm->lastx);
1606                                                 break;
1607                                         case 'v': /* vertical scroller - so only vertical movement ('cur' moves opposite to mouse) */
1608                                                 vsm->delta = (float)(event->y - vsm->lasty);
1609                                                 break;
1610                                 }
1611                         }
1612                         else if (vsm->zone == SCROLLHANDLE_MIN) {
1613                                 /* using 'min' zoom widget */
1614                                 switch (vsm->scroller) {
1615                                         case 'h': /* horizontal scroller - so only horizontal movement ('cur' moves with mouse) */
1616                                                 vsm->delta = (float)(vsm->lastx - event->x);
1617                                                 break;
1618                                         case 'v': /* vertical scroller - so only vertical movement ('cur' moves with to mouse) */
1619                                                 vsm->delta = (float)(vsm->lasty - event->y);
1620                                                 break;
1621                                 }
1622                         }
1623                         
1624                         /* store previous coordinates */
1625                         vsm->lastx = event->x;
1626                         vsm->lasty = event->y;
1627                         
1628                         scroller_activate_apply(C, op);
1629                 }
1630                 break;
1631                         
1632                 case LEFTMOUSE:
1633                 case MIDDLEMOUSE:
1634                         if (event->val == KM_RELEASE) {
1635                                 /* single-click was in empty space outside bubble, so scroll by 1 'page' */
1636                                 if (ELEM(vsm->zone, SCROLLHANDLE_MIN_OUTSIDE, SCROLLHANDLE_MAX_OUTSIDE)) {
1637                                         if (vsm->zone == SCROLLHANDLE_MIN_OUTSIDE)
1638                                                 vsm->delta = -vsm->scrollbarwidth * 0.8f;
1639                                         else if (vsm->zone == SCROLLHANDLE_MAX_OUTSIDE)
1640                                                 vsm->delta = vsm->scrollbarwidth * 0.8f;
1641                                         
1642                                         scroller_activate_apply(C, op);
1643                                         scroller_activate_exit(C, op);
1644                                         return OPERATOR_FINISHED;
1645                                 }
1646                                 
1647                                 /* otherwise, end the drag action  */
1648                                 if (vsm->lastx || vsm->lasty) {
1649                                         scroller_activate_exit(C, op);
1650                                         return OPERATOR_FINISHED;
1651                                 }
1652                         }
1653                         break;
1654
1655         }
1656
1657         return OPERATOR_RUNNING_MODAL;
1658 }
1659
1660
1661 /* a click (or click drag in progress) should have occurred, so check if it happened in scrollbar */
1662 static int scroller_activate_invoke(bContext *C, wmOperator *op, wmEvent *event)
1663 {
1664         ARegion *ar = CTX_wm_region(C);
1665         View2D *v2d = &ar->v2d;
1666         short in_scroller = 0;
1667                 
1668         /* check if mouse in scrollbars, if they're enabled */
1669         in_scroller = UI_view2d_mouse_in_scrollers(C, v2d, event->x, event->y);
1670         
1671         /* if in a scroller, init customdata then set modal handler which will catch mousedown to start doing useful stuff */
1672         if (in_scroller) {
1673                 v2dScrollerMove *vsm;
1674                 
1675                 /* initialize customdata */
1676                 scroller_activate_init(C, op, event, in_scroller);
1677                 vsm = (v2dScrollerMove *)op->customdata;
1678                 
1679                 /* support for quick jump to location - gtk and qt do this on linux */
1680                 if (event->type == MIDDLEMOUSE) {
1681                         switch (vsm->scroller) {
1682                                 case 'h': /* horizontal scroller - so only horizontal movement ('cur' moves opposite to mouse) */
1683                                         vsm->delta = (float)(event->x - vsm->scrollbar_orig);
1684                                         break;
1685                                 case 'v': /* vertical scroller - so only vertical movement ('cur' moves opposite to mouse) */
1686                                         vsm->delta = (float)(event->y - vsm->scrollbar_orig);
1687                                         break;
1688                         }
1689                         scroller_activate_apply(C, op);
1690
1691                         vsm->zone = SCROLLHANDLE_BAR;
1692                 }
1693
1694                 /* check if zoom zones are inappropriate (i.e. zoom widgets not shown), so cannot continue
1695                  * NOTE: see view2d.c for latest conditions, and keep this in sync with that
1696                  */
1697                 if (ELEM(vsm->zone, SCROLLHANDLE_MIN, SCROLLHANDLE_MAX)) {
1698                         if ( ((vsm->scroller == 'h') && (v2d->scroll & V2D_SCROLL_SCALE_HORIZONTAL) == 0) ||
1699                              ((vsm->scroller == 'v') && (v2d->scroll & V2D_SCROLL_SCALE_VERTICAL) == 0) )
1700                         {
1701                                 /* switch to bar (i.e. no scaling gets handled) */
1702                                 vsm->zone = SCROLLHANDLE_BAR;
1703                         }
1704                 }
1705                 
1706                 /* check if zone is inappropriate (i.e. 'bar' but panning is banned), so cannot continue */
1707                 if (vsm->zone == SCROLLHANDLE_BAR) {
1708                         if ( ((vsm->scroller == 'h') && (v2d->keepofs & V2D_LOCKOFS_X)) ||
1709                              ((vsm->scroller == 'v') && (v2d->keepofs & V2D_LOCKOFS_Y)) )
1710                         {
1711                                 /* free customdata initialized */
1712                                 scroller_activate_exit(C, op);
1713                                 
1714                                 /* can't catch this event for ourselves, so let it go to someone else? */
1715                                 return OPERATOR_PASS_THROUGH;
1716                         }                       
1717                 }
1718                 
1719                 /* zone is also inappropriate if scroller is not visible... */
1720                 if ( ((vsm->scroller == 'h') && (v2d->scroll & (V2D_SCROLL_HORIZONTAL_HIDE | V2D_SCROLL_HORIZONTAL_FULLR))) ||
1721                      ((vsm->scroller == 'v') && (v2d->scroll & (V2D_SCROLL_VERTICAL_HIDE | V2D_SCROLL_VERTICAL_FULLR))) )
1722                 {
1723                         /* free customdata initialized */
1724                         scroller_activate_exit(C, op);
1725                                 
1726                         /* can't catch this event for ourselves, so let it go to someone else? */
1727                         /* XXX note: if handlers use mask rect to clip input, input will fail for this case */
1728                         return OPERATOR_PASS_THROUGH;
1729                 }
1730                 
1731                 /* activate the scroller */
1732                 if (vsm->scroller == 'h')
1733                         v2d->scroll_ui |= V2D_SCROLL_H_ACTIVE;
1734                 else
1735                         v2d->scroll_ui |= V2D_SCROLL_V_ACTIVE;
1736                 
1737                 /* still ok, so can add */
1738                 WM_event_add_modal_handler(C, op);
1739                 return OPERATOR_RUNNING_MODAL;
1740         }
1741         else {
1742                 /* not in scroller, so nothing happened... (pass through let's something else catch event) */
1743                 return OPERATOR_PASS_THROUGH;
1744         }
1745 }
1746
1747 /* LMB-Drag in Scrollers - not repeatable operator! */
1748 static void VIEW2D_OT_scroller_activate(wmOperatorType *ot)
1749 {
1750         /* identifiers */
1751         ot->name = "Scroller Activate";
1752         ot->description = "Scroll view by mouse click and drag";
1753         ot->idname = "VIEW2D_OT_scroller_activate";
1754
1755         /* flags */
1756         ot->flag = OPTYPE_BLOCKING;
1757         
1758         /* api callbacks */
1759         ot->invoke = scroller_activate_invoke;
1760         ot->modal = scroller_activate_modal;
1761         ot->cancel = scroller_activate_cancel;
1762
1763         ot->poll = view2d_poll;
1764 }
1765
1766 /* ********************************************************* */
1767 /* RESET */
1768
1769 static int reset_exec(bContext *C, wmOperator *UNUSED(op))
1770 {
1771         uiStyle *style = UI_GetStyle();
1772         ARegion *ar = CTX_wm_region(C);
1773         View2D *v2d = &ar->v2d;
1774         int winx, winy;
1775
1776         /* zoom 1.0 */
1777         winx = (float)(v2d->mask.xmax - v2d->mask.xmin + 1);
1778         winy = (float)(v2d->mask.ymax - v2d->mask.ymin + 1);
1779
1780         v2d->cur.xmax = v2d->cur.xmin + winx;
1781         v2d->cur.ymax = v2d->cur.ymin + winy;
1782         
1783         /* align */
1784         if (v2d->align) {
1785                 /* posx and negx flags are mutually exclusive, so watch out */
1786                 if ((v2d->align & V2D_ALIGN_NO_POS_X) && !(v2d->align & V2D_ALIGN_NO_NEG_X)) {
1787                         v2d->cur.xmax = 0.0f;
1788                         v2d->cur.xmin = -winx * style->panelzoom;
1789                 }
1790                 else if ((v2d->align & V2D_ALIGN_NO_NEG_X) && !(v2d->align & V2D_ALIGN_NO_POS_X)) {
1791                         v2d->cur.xmax = winx * style->panelzoom;
1792                         v2d->cur.xmin = 0.0f;
1793                 }
1794
1795                 /* - posx and negx flags are mutually exclusive, so watch out */
1796                 if ((v2d->align & V2D_ALIGN_NO_POS_Y) && !(v2d->align & V2D_ALIGN_NO_NEG_Y)) {
1797                         v2d->cur.ymax = 0.0f;
1798                         v2d->cur.ymin = -winy * style->panelzoom;
1799                 }
1800                 else if ((v2d->align & V2D_ALIGN_NO_NEG_Y) && !(v2d->align & V2D_ALIGN_NO_POS_Y)) {
1801                         v2d->cur.ymax = winy * style->panelzoom;
1802                         v2d->cur.ymin = 0.0f;
1803                 }
1804         }
1805
1806         /* validate that view is in valid configuration after this operation */
1807         UI_view2d_curRect_validate(v2d);
1808         
1809         /* request updates to be done... */
1810         ED_region_tag_redraw(ar);
1811         UI_view2d_sync(CTX_wm_screen(C), CTX_wm_area(C), v2d, V2D_LOCK_COPY);
1812         
1813         return OPERATOR_FINISHED;
1814 }
1815  
1816 static void VIEW2D_OT_reset(wmOperatorType *ot)
1817 {
1818         /* identifiers */
1819         ot->name = "Reset View";
1820         ot->description = "Reset the view";
1821         ot->idname = "VIEW2D_OT_reset";
1822         
1823         /* api callbacks */
1824         ot->exec = reset_exec;
1825         ot->poll = view2d_poll;
1826 }
1827  
1828 /* ********************************************************* */
1829 /* Registration */
1830
1831 void UI_view2d_operatortypes(void)
1832 {
1833         WM_operatortype_append(VIEW2D_OT_pan);
1834         
1835         WM_operatortype_append(VIEW2D_OT_scroll_left);
1836         WM_operatortype_append(VIEW2D_OT_scroll_right);
1837         WM_operatortype_append(VIEW2D_OT_scroll_up);
1838         WM_operatortype_append(VIEW2D_OT_scroll_down);
1839         
1840         WM_operatortype_append(VIEW2D_OT_zoom_in);
1841         WM_operatortype_append(VIEW2D_OT_zoom_out);
1842         
1843         WM_operatortype_append(VIEW2D_OT_zoom);
1844         WM_operatortype_append(VIEW2D_OT_zoom_border);
1845
1846         WM_operatortype_append(VIEW2D_OT_smoothview);
1847         
1848         WM_operatortype_append(VIEW2D_OT_scroller_activate);
1849
1850         WM_operatortype_append(VIEW2D_OT_reset);
1851 }
1852
1853 void UI_view2d_keymap(wmKeyConfig *keyconf)
1854 {
1855         wmKeyMap *keymap = WM_keymap_find(keyconf, "View2D", 0, 0);
1856         wmKeyMapItem *kmi;
1857
1858         /* scrollers */
1859         WM_keymap_add_item(keymap, "VIEW2D_OT_scroller_activate", LEFTMOUSE, KM_PRESS, 0, 0);
1860         WM_keymap_add_item(keymap, "VIEW2D_OT_scroller_activate", MIDDLEMOUSE, KM_PRESS, 0, 0);
1861
1862         /* pan/scroll */
1863         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MIDDLEMOUSE, KM_PRESS, 0, 0);
1864         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MIDDLEMOUSE, KM_PRESS, KM_SHIFT, 0);
1865         
1866         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MOUSEPAN, 0, 0, 0);
1867         
1868         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_right", WHEELDOWNMOUSE, KM_PRESS, KM_CTRL, 0);
1869         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_left", WHEELUPMOUSE, KM_PRESS, KM_CTRL, 0);
1870         
1871         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", WHEELDOWNMOUSE, KM_PRESS, KM_SHIFT, 0);
1872         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", WHEELUPMOUSE, KM_PRESS, KM_SHIFT, 0);
1873         
1874         /* zoom - single step */
1875         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_out", WHEELOUTMOUSE, KM_PRESS, 0, 0);
1876         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_in", WHEELINMOUSE, KM_PRESS, 0, 0);
1877         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_out", PADMINUS, KM_PRESS, 0, 0);
1878         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_in", PADPLUSKEY, KM_PRESS, 0, 0);
1879         
1880         WM_keymap_verify_item(keymap, "VIEW2D_OT_smoothview", TIMER1, KM_ANY, KM_ANY, 0);
1881
1882         /* scroll up/down - no modifiers, only when zoom fails */
1883         /* these may fail if zoom is disallowed, in which case they should pass on event */
1884         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", WHEELDOWNMOUSE, KM_PRESS, 0, 0);
1885         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", WHEELUPMOUSE, KM_PRESS, 0, 0);
1886         /* these may be necessary if vertical scroll is disallowed */
1887         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_right", WHEELDOWNMOUSE, KM_PRESS, 0, 0);
1888         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_left", WHEELUPMOUSE, KM_PRESS, 0, 0);
1889         
1890         /* alternatives for page up/down to scroll */
1891 #if 0 // XXX disabled, since this causes conflicts with hotkeys in animation editors
1892         /* scroll up/down may fall through to left/right */
1893         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", PAGEDOWNKEY, KM_PRESS, 0, 0);
1894         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", PAGEUPKEY, KM_PRESS, 0, 0);
1895         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_right", PAGEDOWNKEY, KM_PRESS, 0, 0);
1896         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_left", PAGEUPKEY, KM_PRESS, 0, 0);
1897         /* shift for moving view left/right with page up/down */
1898         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_right", PAGEDOWNKEY, KM_PRESS, KM_SHIFT, 0);
1899         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_left", PAGEUPKEY, KM_PRESS, KM_SHIFT, 0);
1900 #endif
1901         
1902         /* zoom - drag */
1903         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MIDDLEMOUSE, KM_PRESS, KM_CTRL, 0);
1904         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MOUSEZOOM, 0, 0, 0);
1905         
1906         /* borderzoom - drag */
1907         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_border", BKEY, KM_PRESS, KM_SHIFT, 0);
1908
1909         /* Alternative keymap for buttons listview */
1910         keymap = WM_keymap_find(keyconf, "View2D Buttons List", 0, 0);
1911
1912         WM_keymap_add_item(keymap, "VIEW2D_OT_scroller_activate", LEFTMOUSE, KM_PRESS, 0, 0);
1913         WM_keymap_add_item(keymap, "VIEW2D_OT_scroller_activate", MIDDLEMOUSE, KM_PRESS, 0, 0);
1914
1915         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MIDDLEMOUSE, KM_PRESS, 0, 0);
1916         WM_keymap_add_item(keymap, "VIEW2D_OT_pan", MOUSEPAN, 0, 0, 0);
1917         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", WHEELDOWNMOUSE, KM_PRESS, 0, 0);
1918         WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", WHEELUPMOUSE, KM_PRESS, 0, 0);
1919         
1920         kmi = WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_down", PAGEDOWNKEY, KM_PRESS, 0, 0);
1921         RNA_boolean_set(kmi->ptr, "page", TRUE);
1922         kmi = WM_keymap_add_item(keymap, "VIEW2D_OT_scroll_up", PAGEUPKEY, KM_PRESS, 0, 0);
1923         RNA_boolean_set(kmi->ptr, "page", TRUE);
1924         
1925         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MIDDLEMOUSE, KM_PRESS, KM_CTRL, 0);
1926         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom", MOUSEZOOM, 0, 0, 0);
1927         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_out", PADMINUS, KM_PRESS, 0, 0);
1928         WM_keymap_add_item(keymap, "VIEW2D_OT_zoom_in", PADPLUSKEY, KM_PRESS, 0, 0);
1929         WM_keymap_add_item(keymap, "VIEW2D_OT_reset", HOMEKEY, KM_PRESS, 0, 0);
1930 }
1931