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