Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / interface / view2d.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.c
27  *  \ingroup edinterface
28  */
29
30
31 #include <float.h>
32 #include <limits.h>
33 #include <math.h>
34 #include <string.h>
35
36 #include "MEM_guardedalloc.h"
37
38 #include "DNA_scene_types.h"
39 #include "DNA_userdef_types.h"
40
41 #include "BLI_utildefines.h"
42 #include "BLI_link_utils.h"
43 #include "BLI_rect.h"
44 #include "BLI_math.h"
45 #include "BLI_memarena.h"
46 #include "BLI_timecode.h"
47
48 #include "BKE_context.h"
49 #include "BKE_screen.h"
50 #include "BKE_global.h"
51
52 #include "GPU_immediate.h"
53 #include "GPU_matrix.h"
54
55 #include "WM_api.h"
56
57 #include "BLF_api.h"
58
59 #include "ED_screen.h"
60
61 #include "UI_interface.h"
62 #include "UI_view2d.h"
63
64 #include "interface_intern.h"
65
66 static void ui_view2d_curRect_validate_resize(View2D *v2d, bool resize, bool mask_scrollers);
67
68 /* *********************************************************************** */
69
70 BLI_INLINE int clamp_float_to_int(const float f)
71 {
72         const float min = INT_MIN;
73         const float max = INT_MAX;
74
75         if (UNLIKELY(f < min)) {
76                 return min;
77         }
78         else if (UNLIKELY(f > max)) {
79                 return (int)max;
80         }
81         else {
82                 return (int)f;
83         }
84 }
85
86 /**
87  * use instead of #BLI_rcti_rctf_copy so we have consistent behavior
88  * with users of #clamp_float_to_int.
89  */
90 BLI_INLINE void clamp_rctf_to_rcti(rcti *dst, const rctf *src)
91 {
92         dst->xmin = clamp_float_to_int(src->xmin);
93         dst->xmax = clamp_float_to_int(src->xmax);
94         dst->ymin = clamp_float_to_int(src->ymin);
95         dst->ymax = clamp_float_to_int(src->ymax);
96 }
97
98
99 /* XXX still unresolved: scrolls hide/unhide vs region mask handling */
100 /* XXX there's V2D_SCROLL_HORIZONTAL_HIDE and V2D_SCROLL_HORIZONTAL_FULLR ... */
101
102 /**
103  * helper to allow scrollbars to dynamically hide
104  * - returns a copy of the scrollbar settings with the flags to display
105  *   horizontal/vertical scrollbars removed
106  * - input scroll value is the v2d->scroll var
107  * - hide flags are set per region at drawtime
108  */
109 static int view2d_scroll_mapped(int scroll)
110 {
111         if (scroll & V2D_SCROLL_HORIZONTAL_FULLR)
112                 scroll &= ~(V2D_SCROLL_HORIZONTAL);
113         if (scroll & V2D_SCROLL_VERTICAL_FULLR)
114                 scroll &= ~(V2D_SCROLL_VERTICAL);
115         return scroll;
116 }
117
118 /* called each time cur changes, to dynamically update masks */
119 static void view2d_masks(View2D *v2d, bool check_scrollers)
120 {
121         int scroll;
122
123         /* mask - view frame */
124         v2d->mask.xmin = v2d->mask.ymin = 0;
125         v2d->mask.xmax = v2d->winx - 1; /* -1 yes! masks are pixels */
126         v2d->mask.ymax = v2d->winy - 1;
127
128         if (check_scrollers) {
129                 /* check size if hiding flag is set: */
130                 if (v2d->scroll & V2D_SCROLL_HORIZONTAL_HIDE) {
131                         if (!(v2d->scroll & V2D_SCROLL_SCALE_HORIZONTAL)) {
132                                 if (BLI_rctf_size_x(&v2d->tot) > BLI_rctf_size_x(&v2d->cur))
133                                         v2d->scroll &= ~V2D_SCROLL_HORIZONTAL_FULLR;
134                                 else
135                                         v2d->scroll |= V2D_SCROLL_HORIZONTAL_FULLR;
136                         }
137                 }
138                 if (v2d->scroll & V2D_SCROLL_VERTICAL_HIDE) {
139                         if (!(v2d->scroll & V2D_SCROLL_SCALE_VERTICAL)) {
140                                 if (BLI_rctf_size_y(&v2d->tot) + 0.01f > BLI_rctf_size_y(&v2d->cur))
141                                         v2d->scroll &= ~V2D_SCROLL_VERTICAL_FULLR;
142                                 else
143                                         v2d->scroll |= V2D_SCROLL_VERTICAL_FULLR;
144                         }
145                 }
146         }
147
148         scroll = view2d_scroll_mapped(v2d->scroll);
149
150         /* scrollers are based off regionsize
151          *      - they can only be on one to two edges of the region they define
152          *      - if they overlap, they must not occupy the corners (which are reserved for other widgets)
153          */
154         if (scroll) {
155                 int scroll_width  = (v2d->scroll & V2D_SCROLL_SCALE_VERTICAL) ?   V2D_SCROLL_WIDTH_TEXT  : v2d->size_vert;
156                 int scroll_height = (v2d->scroll & V2D_SCROLL_SCALE_HORIZONTAL) ? V2D_SCROLL_HEIGHT_TEXT : v2d->size_hor;
157
158                 CLAMP_MIN(scroll_width, V2D_SCROLL_WIDTH_MIN);
159                 CLAMP_MIN(scroll_height, V2D_SCROLL_HEIGHT_MIN);
160
161                 /* vertical scroller */
162                 if (scroll & V2D_SCROLL_LEFT) {
163                         /* on left-hand edge of region */
164                         v2d->vert = v2d->mask;
165                         v2d->vert.xmax = scroll_width;
166                 }
167                 else if (scroll & V2D_SCROLL_RIGHT) {
168                         /* on right-hand edge of region */
169                         v2d->vert = v2d->mask;
170                         v2d->vert.xmax++; /* one pixel extra... was leaving a minor gap... */
171                         v2d->vert.xmin = v2d->vert.xmax - scroll_width;
172                 }
173
174                 /* horizontal scroller */
175                 if (scroll & (V2D_SCROLL_BOTTOM)) {
176                         /* on bottom edge of region */
177                         v2d->hor = v2d->mask;
178                         v2d->hor.ymax = scroll_height;
179                 }
180                 else if (scroll & V2D_SCROLL_TOP) {
181                         /* on upper edge of region */
182                         v2d->hor = v2d->mask;
183                         v2d->hor.ymin = v2d->hor.ymax - scroll_height;
184                 }
185
186                 /* adjust vertical scroller if there's a horizontal scroller, to leave corner free */
187                 if (scroll & V2D_SCROLL_VERTICAL) {
188                         if (scroll & (V2D_SCROLL_BOTTOM)) {
189                                 /* on bottom edge of region */
190                                 v2d->vert.ymin = v2d->hor.ymax;
191                         }
192                         else if (scroll & V2D_SCROLL_TOP) {
193                                 /* on upper edge of region */
194                                 v2d->vert.ymax = v2d->hor.ymin;
195                         }
196                 }
197         }
198 }
199
200 /* Refresh and Validation */
201
202 /**
203  * Initialize all relevant View2D data (including view rects if first time) and/or refresh mask sizes after view resize
204  * - for some of these presets, it is expected that the region will have defined some
205  *   additional settings necessary for the customization of the 2D viewport to its requirements
206  * - this function should only be called from region init() callbacks, where it is expected that
207  *   this is called before UI_view2d_size_update(), as this one checks that the rects are properly initialized.
208  */
209 void UI_view2d_region_reinit(View2D *v2d, short type, int winx, int winy)
210 {
211         bool tot_changed = false, do_init;
212         uiStyle *style = UI_style_get();
213
214         do_init = (v2d->flag & V2D_IS_INITIALISED) == 0;
215
216         /* see eView2D_CommonViewTypes in UI_view2d.h for available view presets */
217         switch (type) {
218                 /* 'standard view' - optimum setup for 'standard' view behavior,
219                  *  that should be used new views as basis for their
220                  *  own unique View2D settings, which should be used instead of this in most cases...
221                  */
222                 case V2D_COMMONVIEW_STANDARD:
223                 {
224                         /* for now, aspect ratio should be maintained, and zoom is clamped within sane default limits */
225                         v2d->keepzoom = (V2D_KEEPASPECT | V2D_LIMITZOOM);
226                         v2d->minzoom = 0.01f;
227                         v2d->maxzoom = 1000.0f;
228
229                         /* tot rect and cur should be same size, and aligned using 'standard' OpenGL coordinates for now
230                          *      - region can resize 'tot' later to fit other data
231                          *      - keeptot is only within bounds, as strict locking is not that critical
232                          *      - view is aligned for (0,0) -> (winx-1, winy-1) setup
233                          */
234                         v2d->align = (V2D_ALIGN_NO_NEG_X | V2D_ALIGN_NO_NEG_Y);
235                         v2d->keeptot = V2D_KEEPTOT_BOUNDS;
236
237                         if (do_init) {
238                                 v2d->tot.xmin = v2d->tot.ymin = 0.0f;
239                                 v2d->tot.xmax = (float)(winx - 1);
240                                 v2d->tot.ymax = (float)(winy - 1);
241
242                                 v2d->cur = v2d->tot;
243                         }
244                         /* scrollers - should we have these by default? */
245                         /* XXX for now, we don't override this, or set it either! */
246                         break;
247                 }
248                 /* 'list/channel view' - zoom, aspect ratio, and alignment restrictions are set here */
249                 case V2D_COMMONVIEW_LIST:
250                 {
251                         /* zoom + aspect ratio are locked */
252                         v2d->keepzoom = (V2D_LOCKZOOM_X | V2D_LOCKZOOM_Y | V2D_LIMITZOOM | V2D_KEEPASPECT);
253                         v2d->minzoom = v2d->maxzoom = 1.0f;
254
255                         /* tot rect has strictly regulated placement, and must only occur in +/- quadrant */
256                         v2d->align = (V2D_ALIGN_NO_NEG_X | V2D_ALIGN_NO_POS_Y);
257                         v2d->keeptot = V2D_KEEPTOT_STRICT;
258                         tot_changed = do_init;
259
260                         /* scroller settings are currently not set here... that is left for regions... */
261                         break;
262                 }
263                 /* 'stack view' - practically the same as list/channel view, except is located in the pos y half instead.
264                  *  zoom, aspect ratio, and alignment restrictions are set here */
265                 case V2D_COMMONVIEW_STACK:
266                 {
267                         /* zoom + aspect ratio are locked */
268                         v2d->keepzoom = (V2D_LOCKZOOM_X | V2D_LOCKZOOM_Y | V2D_LIMITZOOM | V2D_KEEPASPECT);
269                         v2d->minzoom = v2d->maxzoom = 1.0f;
270
271                         /* tot rect has strictly regulated placement, and must only occur in +/+ quadrant */
272                         v2d->align = (V2D_ALIGN_NO_NEG_X | V2D_ALIGN_NO_NEG_Y);
273                         v2d->keeptot = V2D_KEEPTOT_STRICT;
274                         tot_changed = do_init;
275
276                         /* scroller settings are currently not set here... that is left for regions... */
277                         break;
278                 }
279                 /* 'header' regions - zoom, aspect ratio, alignment, and panning restrictions are set here */
280                 case V2D_COMMONVIEW_HEADER:
281                 {
282                         /* zoom + aspect ratio are locked */
283                         v2d->keepzoom = (V2D_LOCKZOOM_X | V2D_LOCKZOOM_Y | V2D_LIMITZOOM | V2D_KEEPASPECT);
284                         v2d->minzoom = v2d->maxzoom = 1.0f;
285
286                         if (do_init) {
287                                 v2d->tot.xmin = 0.0f;
288                                 v2d->tot.xmax = winx;
289                                 v2d->tot.ymin = 0.0f;
290                                 v2d->tot.ymax = winy;
291                                 v2d->cur = v2d->tot;
292
293                                 v2d->min[0] = v2d->max[0] = (float)(winx - 1);
294                                 v2d->min[1] = v2d->max[1] = (float)(winy - 1);
295                         }
296                         /* tot rect has strictly regulated placement, and must only occur in +/+ quadrant */
297                         v2d->align = (V2D_ALIGN_NO_NEG_X | V2D_ALIGN_NO_NEG_Y);
298                         v2d->keeptot = V2D_KEEPTOT_STRICT;
299                         tot_changed = do_init;
300
301                         /* panning in y-axis is prohibited */
302                         v2d->keepofs = V2D_LOCKOFS_Y;
303
304                         /* absolutely no scrollers allowed */
305                         v2d->scroll = 0;
306                         break;
307                 }
308                 /* panels view, with horizontal/vertical align */
309                 case V2D_COMMONVIEW_PANELS_UI:
310                 {
311
312                         /* for now, aspect ratio should be maintained, and zoom is clamped within sane default limits */
313                         v2d->keepzoom = (V2D_KEEPASPECT | V2D_LIMITZOOM | V2D_KEEPZOOM);
314                         v2d->minzoom = 0.5f;
315                         v2d->maxzoom = 2.0f;
316
317                         v2d->align = (V2D_ALIGN_NO_NEG_X | V2D_ALIGN_NO_POS_Y);
318                         v2d->keeptot = V2D_KEEPTOT_BOUNDS;
319
320                         /* note, scroll is being flipped in ED_region_panels() drawing */
321                         v2d->scroll |= (V2D_SCROLL_HORIZONTAL_HIDE | V2D_SCROLL_VERTICAL_HIDE);
322
323                         /* initialize without scroll bars (interferes with zoom level see: T47047) */
324                         if (do_init) {
325                                 v2d->scroll |= (V2D_SCROLL_VERTICAL_FULLR | V2D_SCROLL_HORIZONTAL_FULLR);
326                         }
327
328                         if (do_init) {
329                                 float panelzoom = (style) ? style->panelzoom : 1.0f;
330
331                                 v2d->tot.xmin = 0.0f;
332                                 v2d->tot.xmax = winx;
333
334                                 v2d->tot.ymax = 0.0f;
335                                 v2d->tot.ymin = -winy;
336
337                                 v2d->cur.xmin = 0.0f;
338                                 v2d->cur.xmax = (winx) * panelzoom;
339
340                                 v2d->cur.ymax = 0.0f;
341                                 v2d->cur.ymin = (-winy) * panelzoom;
342                         }
343                         break;
344                 }
345                 /* other view types are completely defined using their own settings already */
346                 default:
347                         /* we don't do anything here, as settings should be fine, but just make sure that rect */
348                         break;
349         }
350
351         /* set initialized flag so that View2D doesn't get reinitialised next time again */
352         v2d->flag |= V2D_IS_INITIALISED;
353
354         /* store view size */
355         v2d->winx = winx;
356         v2d->winy = winy;
357
358         /* set masks (always do), but leave scroller scheck to totrect_set */
359         view2d_masks(v2d, 0);
360
361         if (do_init) {
362                 /* Visible by default. */
363                 v2d->alpha_hor = v2d->alpha_vert = 255;
364         }
365
366         /* set 'tot' rect before setting cur? */
367         /* XXX confusing stuff here still - I made this function not check scroller hide - that happens in totrect_set */
368         if (tot_changed)
369                 UI_view2d_totRect_set_resize(v2d, winx, winy, !do_init);
370         else
371                 ui_view2d_curRect_validate_resize(v2d, !do_init, 0);
372
373 }
374
375 /**
376  * Ensure View2D rects remain in a viable configuration
377  * 'cur' is not allowed to be: larger than max, smaller than min, or outside of 'tot'
378  */
379 // XXX pre2.5 -> this used to be called  test_view2d()
380 static void ui_view2d_curRect_validate_resize(View2D *v2d, bool resize, bool mask_scrollers)
381 {
382         float totwidth, totheight, curwidth, curheight, width, height;
383         float winx, winy;
384         rctf *cur, *tot;
385
386         /* use mask as size of region that View2D resides in, as it takes into account
387          * scrollbars already - keep in sync with zoomx/zoomy in view_zoomstep_apply_ex! */
388         winx = (float)(BLI_rcti_size_x(&v2d->mask) + 1);
389         winy = (float)(BLI_rcti_size_y(&v2d->mask) + 1);
390
391         /* get pointers to rcts for less typing */
392         cur = &v2d->cur;
393         tot = &v2d->tot;
394
395         /* we must satisfy the following constraints (in decreasing order of importance):
396          *      - alignment restrictions are respected
397          *      - cur must not fall outside of tot
398          *      - axis locks (zoom and offset) must be maintained
399          *      - zoom must not be excessive (check either sizes or zoom values)
400          *      - aspect ratio should be respected (NOTE: this is quite closely related to zoom too)
401          */
402
403         /* Step 1: if keepzoom, adjust the sizes of the rects only
404          *      - firstly, we calculate the sizes of the rects
405          *      - curwidth and curheight are saved as reference... modify width and height values here
406          */
407         totwidth  = BLI_rctf_size_x(tot);
408         totheight = BLI_rctf_size_y(tot);
409         /* keep in sync with zoomx/zoomy in view_zoomstep_apply_ex! */
410         curwidth  = width  = BLI_rctf_size_x(cur);
411         curheight = height = BLI_rctf_size_y(cur);
412
413         /* if zoom is locked, size on the appropriate axis is reset to mask size */
414         if (v2d->keepzoom & V2D_LOCKZOOM_X)
415                 width = winx;
416         if (v2d->keepzoom & V2D_LOCKZOOM_Y)
417                 height = winy;
418
419         /* values used to divide, so make it safe
420          * NOTE: width and height must use FLT_MIN instead of 1, otherwise it is impossible to
421          *       get enough resolution in Graph Editor for editing some curves
422          */
423         if (width < FLT_MIN) width = 1;
424         if (height < FLT_MIN) height = 1;
425         if (winx < 1) winx = 1;
426         if (winy < 1) winy = 1;
427
428         /* V2D_LIMITZOOM indicates that zoom level should be preserved when the window size changes */
429         if (resize && (v2d->keepzoom & V2D_KEEPZOOM)) {
430                 float zoom, oldzoom;
431
432                 if ((v2d->keepzoom & V2D_LOCKZOOM_X) == 0) {
433                         zoom = winx / width;
434                         oldzoom = v2d->oldwinx / curwidth;
435
436                         if (oldzoom != zoom)
437                                 width *= zoom / oldzoom;
438                 }
439
440                 if ((v2d->keepzoom & V2D_LOCKZOOM_Y) == 0) {
441                         zoom = winy / height;
442                         oldzoom = v2d->oldwiny / curheight;
443
444                         if (oldzoom != zoom)
445                                 height *= zoom / oldzoom;
446                 }
447         }
448         /* keepzoom (V2D_LIMITZOOM set), indicates that zoom level on each axis must not exceed limits
449          * NOTE: in general, it is not expected that the lock-zoom will be used in conjunction with this
450          */
451         else if (v2d->keepzoom & V2D_LIMITZOOM) {
452
453                 /* check if excessive zoom on x-axis */
454                 if ((v2d->keepzoom & V2D_LOCKZOOM_X) == 0) {
455                         const float zoom = winx / width;
456                         if (zoom < v2d->minzoom) {
457                                 width = winx / v2d->minzoom;
458                         }
459                         else if (zoom > v2d->maxzoom) {
460                                 width = winx / v2d->maxzoom;
461                         }
462                 }
463
464                 /* check if excessive zoom on y-axis */
465                 if ((v2d->keepzoom & V2D_LOCKZOOM_Y) == 0) {
466                         const float zoom = winy / height;
467                         if (zoom < v2d->minzoom) {
468                                 height = winy / v2d->minzoom;
469                         }
470                         else if (zoom > v2d->maxzoom) {
471                                 height = winy / v2d->maxzoom;
472                         }
473                 }
474         }
475         else {
476                 /* make sure sizes don't exceed that of the min/max sizes (even though we're not doing zoom clamping) */
477                 CLAMP(width, v2d->min[0], v2d->max[0]);
478                 CLAMP(height, v2d->min[1], v2d->max[1]);
479         }
480
481         /* check if we should restore aspect ratio (if view size changed) */
482         if (v2d->keepzoom & V2D_KEEPASPECT) {
483                 bool do_x = false, do_y = false, do_cur /* , do_win */ /* UNUSED */;
484                 float curRatio, winRatio;
485
486                 /* when a window edge changes, the aspect ratio can't be used to
487                  * find which is the best new 'cur' rect. thats why it stores 'old'
488                  */
489                 if (winx != v2d->oldwinx) do_x = true;
490                 if (winy != v2d->oldwiny) do_y = true;
491
492                 curRatio = height / width;
493                 winRatio = winy / winx;
494
495                 /* both sizes change (area/region maximized)  */
496                 if (do_x == do_y) {
497                         if (do_x && do_y) {
498                                 /* here is 1,1 case, so all others must be 0,0 */
499                                 if (fabsf(winx - v2d->oldwinx) > fabsf(winy - v2d->oldwiny)) do_y = false;
500                                 else do_x = false;
501                         }
502                         else if (winRatio > curRatio) {
503                                 do_x = false;
504                         }
505                         else {
506                                 do_x = true;
507                         }
508                 }
509                 do_cur = do_x;
510                 /* do_win = do_y; */ /* UNUSED */
511
512                 if (do_cur) {
513                         if ((v2d->keeptot == V2D_KEEPTOT_STRICT) && (winx != v2d->oldwinx)) {
514                                 /* special exception for Outliner (and later channel-lists):
515                                  *  - The view may be moved left to avoid contents being pushed out of view when view shrinks.
516                                  *      - The keeptot code will make sure cur->xmin will not be less than tot->xmin (which cannot be allowed)
517                                  *      - width is not adjusted for changed ratios here...
518                                  */
519                                 if (winx < v2d->oldwinx) {
520                                         float temp = v2d->oldwinx - winx;
521
522                                         cur->xmin -= temp;
523                                         cur->xmax -= temp;
524
525                                         /* width does not get modified, as keepaspect here is just set to make
526                                          * sure visible area adjusts to changing view shape!
527                                          */
528                                 }
529                         }
530                         else {
531                                 /* portrait window: correct for x */
532                                 width = height / winRatio;
533                         }
534                 }
535                 else {
536                         if ((v2d->keeptot == V2D_KEEPTOT_STRICT) && (winy != v2d->oldwiny)) {
537                                 /* special exception for Outliner (and later channel-lists):
538                                  *      - Currently, no actions need to be taken here...
539                                  */
540
541                                 if (winy < v2d->oldwiny) {
542                                         float temp = v2d->oldwiny - winy;
543
544                                         if (v2d->align & V2D_ALIGN_NO_NEG_Y) {
545                                                 cur->ymin -= temp;
546                                                 cur->ymax -= temp;
547                                         }
548                                         else { /* Assume V2D_ALIGN_NO_POS_Y or combination */
549                                                 cur->ymin += temp;
550                                                 cur->ymax += temp;
551                                         }
552                                 }
553
554                         }
555                         else {
556                                 /* landscape window: correct for y */
557                                 height = width * winRatio;
558                         }
559                 }
560
561                 /* store region size for next time */
562                 v2d->oldwinx = (short)winx;
563                 v2d->oldwiny = (short)winy;
564         }
565
566         /* Step 2: apply new sizes to cur rect, but need to take into account alignment settings here... */
567         if ((width != curwidth) || (height != curheight)) {
568                 float temp, dh;
569
570                 /* resize from centerpoint, unless otherwise specified */
571                 if (width != curwidth) {
572                         if (v2d->keepofs & V2D_LOCKOFS_X) {
573                                 cur->xmax += width - BLI_rctf_size_x(cur);
574                         }
575                         else if (v2d->keepofs & V2D_KEEPOFS_X) {
576                                 if (v2d->align & V2D_ALIGN_NO_POS_X)
577                                         cur->xmin -= width - BLI_rctf_size_x(cur);
578                                 else
579                                         cur->xmax += width - BLI_rctf_size_x(cur);
580                         }
581                         else {
582                                 temp = BLI_rctf_cent_x(cur);
583                                 dh = width * 0.5f;
584
585                                 cur->xmin = temp - dh;
586                                 cur->xmax = temp + dh;
587                         }
588                 }
589                 if (height != curheight) {
590                         if (v2d->keepofs & V2D_LOCKOFS_Y) {
591                                 cur->ymax += height - BLI_rctf_size_y(cur);
592                         }
593                         else if (v2d->keepofs & V2D_KEEPOFS_Y) {
594                                 if (v2d->align & V2D_ALIGN_NO_POS_Y)
595                                         cur->ymin -= height - BLI_rctf_size_y(cur);
596                                 else
597                                         cur->ymax += height - BLI_rctf_size_y(cur);
598                         }
599                         else {
600                                 temp = BLI_rctf_cent_y(cur);
601                                 dh = height * 0.5f;
602
603                                 cur->ymin = temp - dh;
604                                 cur->ymax = temp + dh;
605                         }
606                 }
607         }
608
609         /* Step 3: adjust so that it doesn't fall outside of bounds of 'tot' */
610         if (v2d->keeptot) {
611                 float temp, diff;
612
613                 /* recalculate extents of cur */
614                 curwidth  = BLI_rctf_size_x(cur);
615                 curheight = BLI_rctf_size_y(cur);
616
617                 /* width */
618                 if ((curwidth > totwidth) && !(v2d->keepzoom & (V2D_KEEPZOOM | V2D_LOCKZOOM_X | V2D_LIMITZOOM))) {
619                         /* if zoom doesn't have to be maintained, just clamp edges */
620                         if (cur->xmin < tot->xmin) cur->xmin = tot->xmin;
621                         if (cur->xmax > tot->xmax) cur->xmax = tot->xmax;
622                 }
623                 else if (v2d->keeptot == V2D_KEEPTOT_STRICT) {
624                         /* This is an exception for the outliner (and later channel-lists, headers)
625                          *      - must clamp within tot rect (absolutely no excuses)
626                          *      --> therefore, cur->xmin must not be less than tot->xmin
627                          */
628                         if (cur->xmin < tot->xmin) {
629                                 /* move cur across so that it sits at minimum of tot */
630                                 temp = tot->xmin - cur->xmin;
631
632                                 cur->xmin += temp;
633                                 cur->xmax += temp;
634                         }
635                         else if (cur->xmax > tot->xmax) {
636                                 /* - only offset by difference of cur-xmax and tot-xmax if that would not move
637                                  *  cur-xmin to lie past tot-xmin
638                                  * - otherwise, simply shift to tot-xmin???
639                                  */
640                                 temp = cur->xmax - tot->xmax;
641
642                                 if ((cur->xmin - temp) < tot->xmin) {
643                                         /* only offset by difference from cur-min and tot-min */
644                                         temp = cur->xmin - tot->xmin;
645
646                                         cur->xmin -= temp;
647                                         cur->xmax -= temp;
648                                 }
649                                 else {
650                                         cur->xmin -= temp;
651                                         cur->xmax -= temp;
652                                 }
653                         }
654                 }
655                 else {
656                         /* This here occurs when:
657                          *  - width too big, but maintaining zoom (i.e. widths cannot be changed)
658                          *      - width is OK, but need to check if outside of boundaries
659                          *
660                          * So, resolution is to just shift view by the gap between the extremities.
661                          * We favour moving the 'minimum' across, as that's origin for most things
662                          * (XXX - in the past, max was favored... if there are bugs, swap!)
663                          */
664                         if ((cur->xmin < tot->xmin) && (cur->xmax > tot->xmax)) {
665                                 /* outside boundaries on both sides, so take middle-point of tot, and place in balanced way */
666                                 temp = BLI_rctf_cent_x(tot);
667                                 diff = curwidth * 0.5f;
668
669                                 cur->xmin = temp - diff;
670                                 cur->xmax = temp + diff;
671                         }
672                         else if (cur->xmin < tot->xmin) {
673                                 /* move cur across so that it sits at minimum of tot */
674                                 temp = tot->xmin - cur->xmin;
675
676                                 cur->xmin += temp;
677                                 cur->xmax += temp;
678                         }
679                         else if (cur->xmax > tot->xmax) {
680                                 /* - only offset by difference of cur-xmax and tot-xmax if that would not move
681                                  *  cur-xmin to lie past tot-xmin
682                                  * - otherwise, simply shift to tot-xmin???
683                                  */
684                                 temp = cur->xmax - tot->xmax;
685
686                                 if ((cur->xmin - temp) < tot->xmin) {
687                                         /* only offset by difference from cur-min and tot-min */
688                                         temp = cur->xmin - tot->xmin;
689
690                                         cur->xmin -= temp;
691                                         cur->xmax -= temp;
692                                 }
693                                 else {
694                                         cur->xmin -= temp;
695                                         cur->xmax -= temp;
696                                 }
697                         }
698                 }
699
700                 /* height */
701                 if ((curheight > totheight) && !(v2d->keepzoom & (V2D_KEEPZOOM | V2D_LOCKZOOM_Y | V2D_LIMITZOOM))) {
702                         /* if zoom doesn't have to be maintained, just clamp edges */
703                         if (cur->ymin < tot->ymin) cur->ymin = tot->ymin;
704                         if (cur->ymax > tot->ymax) cur->ymax = tot->ymax;
705                 }
706                 else {
707                         /* This here occurs when:
708                          *  - height too big, but maintaining zoom (i.e. heights cannot be changed)
709                          *      - height is OK, but need to check if outside of boundaries
710                          *
711                          * So, resolution is to just shift view by the gap between the extremities.
712                          * We favour moving the 'minimum' across, as that's origin for most things
713                          */
714                         if ((cur->ymin < tot->ymin) && (cur->ymax > tot->ymax)) {
715                                 /* outside boundaries on both sides, so take middle-point of tot, and place in balanced way */
716                                 temp = BLI_rctf_cent_y(tot);
717                                 diff = curheight * 0.5f;
718
719                                 cur->ymin = temp - diff;
720                                 cur->ymax = temp + diff;
721                         }
722                         else if (cur->ymin < tot->ymin) {
723                                 /* there's still space remaining, so shift up */
724                                 temp = tot->ymin - cur->ymin;
725
726                                 cur->ymin += temp;
727                                 cur->ymax += temp;
728                         }
729                         else if (cur->ymax > tot->ymax) {
730                                 /* there's still space remaining, so shift down */
731                                 temp = cur->ymax - tot->ymax;
732
733                                 cur->ymin -= temp;
734                                 cur->ymax -= temp;
735                         }
736                 }
737         }
738
739         /* Step 4: Make sure alignment restrictions are respected */
740         if (v2d->align) {
741                 /* If alignment flags are set (but keeptot is not), they must still be respected, as although
742                  * they don't specify any particular bounds to stay within, they do define ranges which are
743                  * invalid.
744                  *
745                  * Here, we only check to make sure that on each axis, the 'cur' rect doesn't stray into these
746                  * invalid zones, otherwise we offset.
747                  */
748
749                 /* handle width - posx and negx flags are mutually exclusive, so watch out */
750                 if ((v2d->align & V2D_ALIGN_NO_POS_X) && !(v2d->align & V2D_ALIGN_NO_NEG_X)) {
751                         /* width is in negative-x half */
752                         if (v2d->cur.xmax > 0) {
753                                 v2d->cur.xmin -= v2d->cur.xmax;
754                                 v2d->cur.xmax = 0.0f;
755                         }
756                 }
757                 else if ((v2d->align & V2D_ALIGN_NO_NEG_X) && !(v2d->align & V2D_ALIGN_NO_POS_X)) {
758                         /* width is in positive-x half */
759                         if (v2d->cur.xmin < 0) {
760                                 v2d->cur.xmax -= v2d->cur.xmin;
761                                 v2d->cur.xmin = 0.0f;
762                         }
763                 }
764
765                 /* handle height - posx and negx flags are mutually exclusive, so watch out */
766                 if ((v2d->align & V2D_ALIGN_NO_POS_Y) && !(v2d->align & V2D_ALIGN_NO_NEG_Y)) {
767                         /* height is in negative-y half */
768                         if (v2d->cur.ymax > 0) {
769                                 v2d->cur.ymin -= v2d->cur.ymax;
770                                 v2d->cur.ymax = 0.0f;
771                         }
772                 }
773                 else if ((v2d->align & V2D_ALIGN_NO_NEG_Y) && !(v2d->align & V2D_ALIGN_NO_POS_Y)) {
774                         /* height is in positive-y half */
775                         if (v2d->cur.ymin < 0) {
776                                 v2d->cur.ymax -= v2d->cur.ymin;
777                                 v2d->cur.ymin = 0.0f;
778                         }
779                 }
780         }
781
782         /* set masks */
783         view2d_masks(v2d, mask_scrollers);
784 }
785
786 void UI_view2d_curRect_validate(View2D *v2d)
787 {
788         ui_view2d_curRect_validate_resize(v2d, 0, 1);
789 }
790
791 /* ------------------ */
792
793 /* Called by menus to activate it, or by view2d operators to make sure 'related' views stay in synchrony */
794 void UI_view2d_sync(bScreen *screen, ScrArea *area, View2D *v2dcur, int flag)
795 {
796         ScrArea *sa;
797         ARegion *ar;
798
799         /* don't continue if no view syncing to be done */
800         if ((v2dcur->flag & (V2D_VIEWSYNC_SCREEN_TIME | V2D_VIEWSYNC_AREA_VERTICAL)) == 0)
801                 return;
802
803         /* check if doing within area syncing (i.e. channels/vertical) */
804         if ((v2dcur->flag & V2D_VIEWSYNC_AREA_VERTICAL) && (area)) {
805                 for (ar = area->regionbase.first; ar; ar = ar->next) {
806                         /* don't operate on self */
807                         if (v2dcur != &ar->v2d) {
808                                 /* only if view has vertical locks enabled */
809                                 if (ar->v2d.flag & V2D_VIEWSYNC_AREA_VERTICAL) {
810                                         if (flag == V2D_LOCK_COPY) {
811                                                 /* other views with locks on must copy active */
812                                                 ar->v2d.cur.ymin = v2dcur->cur.ymin;
813                                                 ar->v2d.cur.ymax = v2dcur->cur.ymax;
814                                         }
815                                         else { /* V2D_LOCK_SET */
816                                                    /* active must copy others */
817                                                 v2dcur->cur.ymin = ar->v2d.cur.ymin;
818                                                 v2dcur->cur.ymax = ar->v2d.cur.ymax;
819                                         }
820
821                                         /* region possibly changed, so refresh */
822                                         ED_region_tag_redraw_no_rebuild(ar);
823                                 }
824                         }
825                 }
826         }
827
828         /* check if doing whole screen syncing (i.e. time/horizontal) */
829         if ((v2dcur->flag & V2D_VIEWSYNC_SCREEN_TIME) && (screen)) {
830                 for (sa = screen->areabase.first; sa; sa = sa->next) {
831                         for (ar = sa->regionbase.first; ar; ar = ar->next) {
832                                 /* don't operate on self */
833                                 if (v2dcur != &ar->v2d) {
834                                         /* only if view has horizontal locks enabled */
835                                         if (ar->v2d.flag & V2D_VIEWSYNC_SCREEN_TIME) {
836                                                 if (flag == V2D_LOCK_COPY) {
837                                                         /* other views with locks on must copy active */
838                                                         ar->v2d.cur.xmin = v2dcur->cur.xmin;
839                                                         ar->v2d.cur.xmax = v2dcur->cur.xmax;
840                                                 }
841                                                 else { /* V2D_LOCK_SET */
842                                                            /* active must copy others */
843                                                         v2dcur->cur.xmin = ar->v2d.cur.xmin;
844                                                         v2dcur->cur.xmax = ar->v2d.cur.xmax;
845                                                 }
846
847                                                 /* region possibly changed, so refresh */
848                                                 ED_region_tag_redraw_no_rebuild(ar);
849                                         }
850                                 }
851                         }
852                 }
853         }
854 }
855
856
857 /**
858  * Restore 'cur' rect to standard orientation (i.e. optimal maximum view of tot)
859  * This does not take into account if zooming the view on an axis will improve the view (if allowed)
860  */
861 void UI_view2d_curRect_reset(View2D *v2d)
862 {
863         float width, height;
864
865         /* assume width and height of 'cur' rect by default, should be same size as mask */
866         width  = (float)(BLI_rcti_size_x(&v2d->mask) + 1);
867         height = (float)(BLI_rcti_size_y(&v2d->mask) + 1);
868
869         /* handle width - posx and negx flags are mutually exclusive, so watch out */
870         if ((v2d->align & V2D_ALIGN_NO_POS_X) && !(v2d->align & V2D_ALIGN_NO_NEG_X)) {
871                 /* width is in negative-x half */
872                 v2d->cur.xmin = -width;
873                 v2d->cur.xmax = 0.0f;
874         }
875         else if ((v2d->align & V2D_ALIGN_NO_NEG_X) && !(v2d->align & V2D_ALIGN_NO_POS_X)) {
876                 /* width is in positive-x half */
877                 v2d->cur.xmin = 0.0f;
878                 v2d->cur.xmax = width;
879         }
880         else {
881                 /* width is centered around (x == 0) */
882                 const float dx = width / 2.0f;
883
884                 v2d->cur.xmin = -dx;
885                 v2d->cur.xmax = dx;
886         }
887
888         /* handle height - posx and negx flags are mutually exclusive, so watch out */
889         if ((v2d->align & V2D_ALIGN_NO_POS_Y) && !(v2d->align & V2D_ALIGN_NO_NEG_Y)) {
890                 /* height is in negative-y half */
891                 v2d->cur.ymin = -height;
892                 v2d->cur.ymax = 0.0f;
893         }
894         else if ((v2d->align & V2D_ALIGN_NO_NEG_Y) && !(v2d->align & V2D_ALIGN_NO_POS_Y)) {
895                 /* height is in positive-y half */
896                 v2d->cur.ymin = 0.0f;
897                 v2d->cur.ymax = height;
898         }
899         else {
900                 /* height is centered around (y == 0) */
901                 const float dy = height / 2.0f;
902
903                 v2d->cur.ymin = -dy;
904                 v2d->cur.ymax = dy;
905         }
906 }
907
908 /* ------------------ */
909
910 /* Change the size of the maximum viewable area (i.e. 'tot' rect) */
911 void UI_view2d_totRect_set_resize(View2D *v2d, int width, int height, bool resize)
912 {
913 //      int scroll = view2d_scroll_mapped(v2d->scroll);
914
915         /* don't do anything if either value is 0 */
916         width = abs(width);
917         height = abs(height);
918
919         /* hrumf! */
920         /* XXX: there are work arounds for this in the panel and file browse code. */
921         /* round to int, because this is called with width + V2D_SCROLL_WIDTH */
922 //      if (scroll & V2D_SCROLL_HORIZONTAL)
923 //              width -= (int)V2D_SCROLL_WIDTH;
924 //      if (scroll & V2D_SCROLL_VERTICAL)
925 //              height -= (int)V2D_SCROLL_HEIGHT;
926
927         if (ELEM(0, width, height)) {
928                 if (G.debug & G_DEBUG)
929                         printf("Error: View2D totRect set exiting: v2d=%p width=%d height=%d\n", (void *)v2d, width, height);  // XXX temp debug info
930                 return;
931         }
932
933         /* handle width - posx and negx flags are mutually exclusive, so watch out */
934         if ((v2d->align & V2D_ALIGN_NO_POS_X) && !(v2d->align & V2D_ALIGN_NO_NEG_X)) {
935                 /* width is in negative-x half */
936                 v2d->tot.xmin = (float)-width;
937                 v2d->tot.xmax = 0.0f;
938         }
939         else if ((v2d->align & V2D_ALIGN_NO_NEG_X) && !(v2d->align & V2D_ALIGN_NO_POS_X)) {
940                 /* width is in positive-x half */
941                 v2d->tot.xmin = 0.0f;
942                 v2d->tot.xmax = (float)width;
943         }
944         else {
945                 /* width is centered around (x == 0) */
946                 const float dx = (float)width / 2.0f;
947
948                 v2d->tot.xmin = -dx;
949                 v2d->tot.xmax = dx;
950         }
951
952         /* handle height - posx and negx flags are mutually exclusive, so watch out */
953         if ((v2d->align & V2D_ALIGN_NO_POS_Y) && !(v2d->align & V2D_ALIGN_NO_NEG_Y)) {
954                 /* height is in negative-y half */
955                 v2d->tot.ymin = (float)-height;
956                 v2d->tot.ymax = 0.0f;
957         }
958         else if ((v2d->align & V2D_ALIGN_NO_NEG_Y) && !(v2d->align & V2D_ALIGN_NO_POS_Y)) {
959                 /* height is in positive-y half */
960                 v2d->tot.ymin = 0.0f;
961                 v2d->tot.ymax = (float)height;
962         }
963         else {
964                 /* height is centered around (y == 0) */
965                 const float dy = (float)height / 2.0f;
966
967                 v2d->tot.ymin = -dy;
968                 v2d->tot.ymax = dy;
969         }
970
971         /* make sure that 'cur' rect is in a valid state as a result of these changes */
972         ui_view2d_curRect_validate_resize(v2d, resize, 1);
973
974 }
975
976 void UI_view2d_totRect_set(View2D *v2d, int width, int height)
977 {
978         int scroll = view2d_scroll_mapped(v2d->scroll);
979
980         UI_view2d_totRect_set_resize(v2d, width, height, 0);
981
982         /* solve bad recursion... if scroller state changed, mask is different, so you get different rects */
983         if (scroll != view2d_scroll_mapped(v2d->scroll)) {
984                 UI_view2d_totRect_set_resize(v2d, width, height, 0);
985         }
986
987 }
988
989 bool UI_view2d_tab_set(View2D *v2d, int tab)
990 {
991         float default_offset[2] = {0.0f, 0.0f};
992         float *offset, *new_offset;
993         bool changed = false;
994
995         /* if tab changed, change offset */
996         if (tab != v2d->tab_cur && v2d->tab_offset) {
997                 if (tab < v2d->tab_num)
998                         offset = &v2d->tab_offset[tab * 2];
999                 else
1000                         offset = default_offset;
1001
1002                 v2d->cur.xmax += offset[0] - v2d->cur.xmin;
1003                 v2d->cur.xmin = offset[0];
1004
1005                 v2d->cur.ymin += offset[1] - v2d->cur.ymax;
1006                 v2d->cur.ymax = offset[1];
1007
1008                 /* validation should happen in subsequent totRect_set */
1009
1010                 changed = true;
1011         }
1012
1013         /* resize array if needed */
1014         if (tab >= v2d->tab_num) {
1015                 new_offset = MEM_callocN(sizeof(float) * (tab + 1) * 2, "view2d tab offset");
1016
1017                 if (v2d->tab_offset) {
1018                         memcpy(new_offset, v2d->tab_offset, sizeof(float) * v2d->tab_num * 2);
1019                         MEM_freeN(v2d->tab_offset);
1020                 }
1021
1022                 v2d->tab_offset = new_offset;
1023                 v2d->tab_num = tab + 1;
1024         }
1025
1026         /* set current tab and offset */
1027         v2d->tab_cur = tab;
1028         v2d->tab_offset[2 * tab + 0] = v2d->cur.xmin;
1029         v2d->tab_offset[2 * tab + 1] = v2d->cur.ymax;
1030
1031         return changed;
1032 }
1033
1034 void UI_view2d_zoom_cache_reset(void)
1035 {
1036         /* TODO(sergey): This way we avoid threading conflict with VSE rendering
1037          * text strip. But ideally we want to make glyph cache to be fully safe
1038          * for threading.
1039          */
1040         if (G.is_rendering) {
1041                 return;
1042         }
1043         /* While scaling we can accumulate fonts at many sizes (~20 or so).
1044          * Not an issue with embedded font, but can use over 500Mb with i18n ones! See [#38244]. */
1045
1046         /* note: only some views draw text, we could check for this case to avoid clearning cache */
1047         BLF_cache_clear();
1048 }
1049
1050 /* *********************************************************************** */
1051 /* View Matrix Setup */
1052
1053 /* mapping function to ensure 'cur' draws extended over the area where sliders are */
1054 static void view2d_map_cur_using_mask(View2D *v2d, rctf *curmasked)
1055 {
1056         *curmasked = v2d->cur;
1057
1058         if (view2d_scroll_mapped(v2d->scroll)) {
1059                 float sizex = BLI_rcti_size_x(&v2d->mask);
1060                 float sizey = BLI_rcti_size_y(&v2d->mask);
1061
1062                 /* prevent tiny or narrow regions to get invalid coordinates - mask can get negative even... */
1063                 if (sizex > 0.0f && sizey > 0.0f) {
1064                         float dx = BLI_rctf_size_x(&v2d->cur) / (sizex + 1);
1065                         float dy = BLI_rctf_size_y(&v2d->cur) / (sizey + 1);
1066
1067                         if (v2d->mask.xmin != 0)
1068                                 curmasked->xmin -= dx * (float)v2d->mask.xmin;
1069                         if (v2d->mask.xmax + 1 != v2d->winx)
1070                                 curmasked->xmax += dx * (float)(v2d->winx - v2d->mask.xmax - 1);
1071
1072                         if (v2d->mask.ymin != 0)
1073                                 curmasked->ymin -= dy * (float)v2d->mask.ymin;
1074                         if (v2d->mask.ymax + 1 != v2d->winy)
1075                                 curmasked->ymax += dy * (float)(v2d->winy - v2d->mask.ymax - 1);
1076                 }
1077         }
1078 }
1079
1080 /* Set view matrices to use 'cur' rect as viewing frame for View2D drawing */
1081 void UI_view2d_view_ortho(View2D *v2d)
1082 {
1083         rctf curmasked;
1084         const int sizex = BLI_rcti_size_x(&v2d->mask);
1085         const int sizey = BLI_rcti_size_y(&v2d->mask);
1086         const float eps = 0.001f;
1087         float xofs = 0.0f, yofs = 0.0f;
1088
1089         /* pixel offsets (-GLA_PIXEL_OFS) are needed to get 1:1 correspondence with pixels for smooth UI drawing,
1090          * but only applied where requested
1091          */
1092         /* XXX brecht: instead of zero at least use a tiny offset, otherwise
1093          * pixel rounding is effectively random due to float inaccuracy */
1094         if (sizex > 0)
1095                 xofs = eps * BLI_rctf_size_x(&v2d->cur) / sizex;
1096         if (sizey > 0)
1097                 yofs = eps * BLI_rctf_size_y(&v2d->cur) / sizey;
1098
1099         /* apply mask-based adjustments to cur rect (due to scrollers), to eliminate scaling artifacts */
1100         view2d_map_cur_using_mask(v2d, &curmasked);
1101
1102         BLI_rctf_translate(&curmasked, -xofs, -yofs);
1103
1104         /* XXX ton: this flag set by outliner, for icons */
1105         if (v2d->flag & V2D_PIXELOFS_X) {
1106                 curmasked.xmin = floorf(curmasked.xmin) - (eps + xofs);
1107                 curmasked.xmax = floorf(curmasked.xmax) - (eps + xofs);
1108         }
1109         if (v2d->flag & V2D_PIXELOFS_Y) {
1110                 curmasked.ymin = floorf(curmasked.ymin) - (eps + yofs);
1111                 curmasked.ymax = floorf(curmasked.ymax) - (eps + yofs);
1112         }
1113
1114         /* set matrix on all appropriate axes */
1115         wmOrtho2(curmasked.xmin, curmasked.xmax, curmasked.ymin, curmasked.ymax);
1116 }
1117
1118 /**
1119  * Set view matrices to only use one axis of 'cur' only
1120  *
1121  * \param xaxis: if non-zero, only use cur x-axis, otherwise use cur-yaxis (mostly this will be used for x)
1122  */
1123 void UI_view2d_view_orthoSpecial(ARegion *ar, View2D *v2d, const bool xaxis)
1124 {
1125         rctf curmasked;
1126         float xofs, yofs;
1127
1128         /* pixel offsets (-GLA_PIXEL_OFS) are needed to get 1:1 correspondence with pixels for smooth UI drawing,
1129          * but only applied where requested
1130          */
1131         /* XXX temp (ton) */
1132         xofs = 0.0f; // (v2d->flag & V2D_PIXELOFS_X) ? GLA_PIXEL_OFS : 0.0f;
1133         yofs = 0.0f; // (v2d->flag & V2D_PIXELOFS_Y) ? GLA_PIXEL_OFS : 0.0f;
1134
1135         /* apply mask-based adjustments to cur rect (due to scrollers), to eliminate scaling artifacts */
1136         view2d_map_cur_using_mask(v2d, &curmasked);
1137
1138         /* only set matrix with 'cur' coordinates on relevant axes */
1139         if (xaxis)
1140                 wmOrtho2(curmasked.xmin - xofs, curmasked.xmax - xofs, -yofs, ar->winy - yofs);
1141         else
1142                 wmOrtho2(-xofs, ar->winx - xofs, curmasked.ymin - yofs, curmasked.ymax - yofs);
1143 }
1144
1145
1146 /* Restore view matrices after drawing */
1147 void UI_view2d_view_restore(const bContext *C)
1148 {
1149         ARegion *ar = CTX_wm_region(C);
1150         int width  = BLI_rcti_size_x(&ar->winrct) + 1;
1151         int height = BLI_rcti_size_y(&ar->winrct) + 1;
1152
1153         wmOrtho2(0.0f, (float)width, 0.0f, (float)height);
1154         gpuLoadIdentity();
1155
1156         //      ED_region_pixelspace(CTX_wm_region(C));
1157 }
1158
1159 /* *********************************************************************** */
1160 /* Gridlines */
1161
1162 /* View2DGrid is typedef'd in UI_view2d.h */
1163 struct View2DGrid {
1164         float dx, dy;           /* stepsize (in pixels) between gridlines */
1165         float startx, starty;   /* initial coordinates to start drawing grid from */
1166         int powerx, powery;     /* step as power of 10 */
1167 };
1168
1169 /* --------------- */
1170
1171 /* try to write step as a power of 10 */
1172 static void step_to_grid(float *step, int *power, int unit)
1173 {
1174         const float loga = (float)log10(*step);
1175         float rem;
1176
1177         *power = (int)(loga);
1178
1179         rem = loga - (*power);
1180         rem = (float)pow(10.0, rem);
1181
1182         if (loga < 0.0f) {
1183                 if (rem < 0.2f) rem = 0.2f;
1184                 else if (rem < 0.5f) rem = 0.5f;
1185                 else rem = 1.0f;
1186
1187                 *step = rem * (float)pow(10.0, (*power));
1188
1189                 /* for frames, we want 1.0 frame intervals only */
1190                 if (unit == V2D_UNIT_FRAMES) {
1191                         rem = 1.0f;
1192                         *step = 2.0f; /* use 2 since there are grid lines drawn in between, this way to get 1 line per frane */
1193                 }
1194
1195                 /* prevents printing 1.0 2.0 3.0 etc */
1196                 if (rem == 1.0f) (*power)++;
1197         }
1198         else {
1199                 if (rem < 2.0f) rem = 2.0f;
1200                 else if (rem < 5.0f) rem = 5.0f;
1201                 else rem = 10.0f;
1202
1203                 *step = rem * (float)pow(10.0, (*power));
1204
1205                 (*power)++;
1206                 /* prevents printing 1.0, 2.0, 3.0, etc. */
1207                 if (rem == 10.0f) (*power)++;
1208         }
1209 }
1210
1211 /**
1212  * Initialize settings necessary for drawing gridlines in a 2d-view
1213  *
1214  * - Currently, will return pointer to View2DGrid struct that needs to
1215  *   be freed with UI_view2d_grid_free()
1216  * - Is used for scrollbar drawing too (for units drawing)
1217  * - Units + clamping args will be checked, to make sure they are valid values that can be used
1218  *   so it is very possible that we won't return grid at all!
1219  *
1220  * - xunits,yunits = V2D_UNIT_*  grid steps in seconds or frames
1221  * - xclamp,yclamp = V2D_CLAMP_* only show whole-number intervals
1222  * - winx          = width of region we're drawing to, note: not used but keeping for completeness.
1223  * - winy          = height of region we're drawing into
1224  */
1225 View2DGrid *UI_view2d_grid_calc(
1226         Scene *scene, View2D *v2d,
1227         short xunits, short xclamp, short yunits, short yclamp, int UNUSED(winx), int winy)
1228 {
1229
1230         View2DGrid *grid;
1231         float space, seconddiv;
1232
1233         /* check that there are at least some workable args */
1234         if (ELEM(V2D_ARG_DUMMY, xunits, xclamp) && ELEM(V2D_ARG_DUMMY, yunits, yclamp))
1235                 return NULL;
1236
1237         /* grid here is allocated... */
1238         grid = MEM_callocN(sizeof(View2DGrid), "View2DGrid");
1239
1240         /* rule: gridstep is minimal GRIDSTEP pixels */
1241         if (xunits == V2D_UNIT_SECONDS) {
1242                 seconddiv = (float)(0.01 * FPS);
1243         }
1244         else {
1245                 seconddiv = 1.0f;
1246         }
1247
1248         /* calculate x-axis grid scale (only if both args are valid) */
1249         if (ELEM(V2D_ARG_DUMMY, xunits, xclamp) == 0) {
1250                 space = BLI_rctf_size_x(&v2d->cur);
1251
1252                 if (space != 0.0f) {
1253                         const float pixels = (float)BLI_rcti_size_x(&v2d->mask);
1254                         if (pixels != 0.0f) {
1255                                 grid->dx = (U.v2d_min_gridsize * UI_DPI_FAC * space) / (seconddiv * pixels);
1256                                 step_to_grid(&grid->dx, &grid->powerx, xunits);
1257                                 grid->dx *= seconddiv;
1258                         }
1259                 }
1260
1261                 if (xclamp == V2D_GRID_CLAMP) {
1262                         CLAMP_MIN(grid->dx, 0.1f);
1263                         CLAMP_MIN(grid->powerx, 0);
1264                         grid->powerx -= 2;
1265                 }
1266         }
1267
1268         /* calculate y-axis grid scale (only if both args are valid) */
1269         if (ELEM(V2D_ARG_DUMMY, yunits, yclamp) == 0) {
1270                 space = BLI_rctf_size_y(&v2d->cur);
1271                 if (space != 0.0f) {
1272                         const float pixels = (float)winy;
1273                         if (pixels != 0.0f) {
1274                                 grid->dy = U.v2d_min_gridsize * UI_DPI_FAC * space / pixels;
1275                                 step_to_grid(&grid->dy, &grid->powery, yunits);
1276                         }
1277                 }
1278
1279                 if (yclamp == V2D_GRID_CLAMP) {
1280                         CLAMP_MIN(grid->dy, 1.0f);
1281                         CLAMP_MIN(grid->powery, 1);
1282                 }
1283         }
1284
1285         /* calculate start position */
1286         if (ELEM(V2D_ARG_DUMMY, xunits, xclamp) == 0) {
1287                 grid->startx = seconddiv * (v2d->cur.xmin / seconddiv - (float)fmod(v2d->cur.xmin / seconddiv, grid->dx / seconddiv));
1288                 if (v2d->cur.xmin < 0.0f) grid->startx -= grid->dx;
1289         }
1290         else
1291                 grid->startx = v2d->cur.xmin;
1292
1293         if (ELEM(V2D_ARG_DUMMY, yunits, yclamp) == 0) {
1294                 grid->starty = (v2d->cur.ymin - (float)fmod(v2d->cur.ymin, grid->dy));
1295                 if (v2d->cur.ymin < 0.0f) grid->starty -= grid->dy;
1296         }
1297         else
1298                 grid->starty = v2d->cur.ymin;
1299
1300         return grid;
1301 }
1302
1303 /* Draw gridlines in the given 2d-region */
1304 void UI_view2d_grid_draw(View2D *v2d, View2DGrid *grid, int flag)
1305 {
1306         float vec1[2], vec2[2];
1307         int a, step;
1308         int vertical_minor_step = (BLI_rcti_size_x(&v2d->mask) + 1) / (U.v2d_min_gridsize * UI_DPI_FAC),
1309                 horizontal_major_step = (BLI_rcti_size_y(&v2d->mask) + 1) / (U.v2d_min_gridsize * UI_DPI_FAC);
1310         unsigned char grid_line_color[3];
1311
1312         /* check for grid first, as it may not exist */
1313         if (grid == NULL)
1314                 return;
1315
1316         /* Count the needed vertices for the gridlines */
1317         unsigned vertex_count = 0;
1318         if (flag & V2D_VERTICAL_LINES) {
1319                 /* vertical lines */
1320                 vertex_count += 2 * vertical_minor_step;                /* minor gridlines */
1321                 vertex_count += 2 * (vertical_minor_step + 2);  /* major gridlines */
1322         }
1323         if (flag & V2D_HORIZONTAL_LINES) {
1324                 /* horizontal lines */
1325                 vertex_count += 2 * (horizontal_major_step + 1);        /* major gridlines */
1326
1327                 /* fine lines */
1328                 if (flag & V2D_HORIZONTAL_FINELINES)
1329                         vertex_count += 2 * (horizontal_major_step + 1);
1330         }
1331         /* axes */
1332         if (flag & V2D_HORIZONTAL_AXIS)
1333                 vertex_count += 2;
1334         if (flag & V2D_VERTICAL_AXIS)
1335                 vertex_count += 2;
1336
1337         /* If there is nothing to render, exit early */
1338         if (vertex_count == 0)
1339                 return;
1340
1341         Gwn_VertFormat *format = immVertexFormat();
1342         unsigned int pos = GWN_vertformat_attr_add(format, "pos", GWN_COMP_F32, 2, GWN_FETCH_FLOAT);
1343         unsigned int color = GWN_vertformat_attr_add(format, "color", GWN_COMP_U8, 3, GWN_FETCH_INT_TO_FLOAT_UNIT);
1344
1345         immBindBuiltinProgram(GPU_SHADER_2D_FLAT_COLOR);
1346         immBegin(GWN_PRIM_LINES, vertex_count);
1347
1348         /* vertical lines */
1349         if (flag & V2D_VERTICAL_LINES) {
1350                 /* initialize initial settings */
1351                 vec1[0] = vec2[0] = grid->startx;
1352                 vec1[1] = grid->starty;
1353                 vec2[1] = v2d->cur.ymax;
1354
1355                 /* minor gridlines */
1356                 step = vertical_minor_step;
1357                 if (step != 0) {
1358                         UI_GetThemeColor3ubv(TH_GRID, grid_line_color);
1359
1360                         for (a = 0; a < step; a++) {
1361                                 immSkipAttrib(color);
1362                                 immVertex2fv(pos, vec1);
1363                                 immAttrib3ubv(color, grid_line_color);
1364                                 immVertex2fv(pos, vec2);
1365
1366                                 vec2[0] = vec1[0] += grid->dx;
1367                         }
1368                 }
1369
1370                 /* major gridlines */
1371                 vec2[0] = vec1[0] -= 0.5f * grid->dx;
1372
1373                 UI_GetThemeColorShade3ubv(TH_GRID, 16, grid_line_color);
1374
1375                 step++;
1376                 for (a = 0; a <= step; a++) {
1377                         immSkipAttrib(color);
1378                         immVertex2fv(pos, vec1);
1379                         immAttrib3ubv(color, grid_line_color);
1380                         immVertex2fv(pos, vec2);
1381
1382                         vec2[0] = vec1[0] -= grid->dx;
1383                 }
1384         }
1385
1386         /* horizontal lines */
1387         if (flag & V2D_HORIZONTAL_LINES) {
1388                 /* only major gridlines */
1389                 vec1[1] = vec2[1] = grid->starty;
1390                 vec1[0] = grid->startx;
1391                 vec2[0] = v2d->cur.xmax;
1392
1393                 step = horizontal_major_step;
1394
1395                 UI_GetThemeColor3ubv(TH_GRID, grid_line_color);
1396
1397                 for (a = 0; a <= step; a++) {
1398                         immSkipAttrib(color);
1399                         immVertex2fv(pos, vec1);
1400                         immAttrib3ubv(color, grid_line_color);
1401                         immVertex2fv(pos, vec2);
1402
1403                         vec2[1] = vec1[1] += grid->dy;
1404                 }
1405
1406                 /* fine grid lines */
1407                 vec2[1] = vec1[1] -= 0.5f * grid->dy;
1408                 step++;
1409
1410                 if (flag & V2D_HORIZONTAL_FINELINES) {
1411                         UI_GetThemeColorShade3ubv(TH_GRID, 16, grid_line_color);
1412                         for (a = 0; a < step; a++) {
1413                                 immSkipAttrib(color);
1414                                 immVertex2fv(pos, vec1);
1415                                 immAttrib3ubv(color, grid_line_color);
1416                                 immVertex2fv(pos, vec2);
1417
1418                                 vec2[1] = vec1[1] -= grid->dy;
1419                         }
1420                 }
1421         }
1422
1423         /* Axes are drawn as darker lines */
1424         UI_GetThemeColorShade3ubv(TH_GRID, -50, grid_line_color);
1425
1426         /* horizontal axis */
1427         if (flag & V2D_HORIZONTAL_AXIS) {
1428                 vec1[0] = v2d->cur.xmin;
1429                 vec2[0] = v2d->cur.xmax;
1430                 vec1[1] = vec2[1] = 0.0f;
1431
1432                 immSkipAttrib(color);
1433                 immVertex2fv(pos, vec1);
1434                 immAttrib3ubv(color, grid_line_color);
1435                 immVertex2fv(pos, vec2);
1436         }
1437
1438         /* vertical axis */
1439         if (flag & V2D_VERTICAL_AXIS) {
1440                 vec1[1] = v2d->cur.ymin;
1441                 vec2[1] = v2d->cur.ymax;
1442                 vec1[0] = vec2[0] = 0.0f;
1443
1444                 immSkipAttrib(color);
1445                 immVertex2fv(pos, vec1);
1446                 immAttrib3ubv(color, grid_line_color);
1447                 immVertex2fv(pos, vec2);
1448         }
1449
1450         immEnd();
1451         immUnbindProgram();
1452 }
1453
1454 /* Draw a constant grid in given 2d-region */
1455 void UI_view2d_constant_grid_draw(View2D *v2d, float step)
1456 {
1457         float start_x, start_y;
1458         int count_x, count_y;
1459
1460         start_x = v2d->cur.xmin;
1461         if (start_x < 0.0)
1462                 start_x += -(float)fmod(v2d->cur.xmin, step);
1463         else
1464                 start_x += (step - (float)fmod(v2d->cur.xmin, step));
1465
1466         if (start_x > v2d->cur.xmax)
1467                 count_x = 0;
1468         else
1469                 count_x = (v2d->cur.xmax - start_x) / step + 1;
1470
1471         start_y = v2d->cur.ymin;
1472         if (start_y < 0.0)
1473                 start_y += -(float)fmod(v2d->cur.ymin, step);
1474         else
1475                 start_y += (step - (float)fabs(fmod(v2d->cur.ymin, step)));
1476
1477         if (start_y > v2d->cur.ymax)
1478                 count_y = 0;
1479         else
1480                 count_y = (v2d->cur.ymax - start_y) / step + 1;
1481
1482         if (count_x > 0 || count_y > 0) {
1483                 Gwn_VertFormat *format = immVertexFormat();
1484                 unsigned int pos = GWN_vertformat_attr_add(format, "pos", GWN_COMP_F32, 2, GWN_FETCH_FLOAT);
1485                 unsigned int color = GWN_vertformat_attr_add(format, "color", GWN_COMP_F32, 3, GWN_FETCH_FLOAT);
1486                 float theme_color[3];
1487
1488                 UI_GetThemeColorShade3fv(TH_BACK, -10, theme_color);
1489
1490                 immBindBuiltinProgram(GPU_SHADER_2D_FLAT_COLOR);
1491                 immBegin(GWN_PRIM_LINES, count_x * 2 + count_y * 2 + 4);
1492
1493                 immAttrib3fv(color, theme_color);
1494                 for (int i = 0; i < count_x ; start_x += step, i++) {
1495                         immVertex2f(pos, start_x, v2d->cur.ymin);
1496                         immVertex2f(pos, start_x, v2d->cur.ymax);
1497                 }
1498
1499                 for (int i = 0; i < count_y; start_y += step, i++) {
1500                         immVertex2f(pos, v2d->cur.xmin, start_y);
1501                         immVertex2f(pos, v2d->cur.xmax, start_y);
1502                 }
1503
1504                 /* X and Y axis */
1505                 UI_GetThemeColorShade3fv(TH_BACK, -18, theme_color);
1506
1507                 immAttrib3fv(color, theme_color);
1508                 immVertex2f(pos, 0.0f, v2d->cur.ymin);
1509                 immVertex2f(pos, 0.0f, v2d->cur.ymax);
1510                 immVertex2f(pos, v2d->cur.xmin, 0.0f);
1511                 immVertex2f(pos, v2d->cur.xmax, 0.0f);
1512
1513                 immEnd();
1514                 immUnbindProgram();
1515         }
1516 }
1517
1518 /* Draw a multi-level grid in given 2d-region */
1519 void UI_view2d_multi_grid_draw(View2D *v2d, int colorid, float step, int level_size, int totlevels)
1520 {
1521         /* Exit if there is nothing to draw */
1522         if (totlevels == 0)
1523                 return;
1524
1525         int offset = -10;
1526         float lstep = step;
1527         unsigned char grid_line_color[3];
1528
1529         /* Make an estimate of at least how many vertices will be needed */
1530         unsigned vertex_count = 4;
1531         vertex_count += 2 * ((int)((v2d->cur.xmax - v2d->cur.xmin) / lstep) + 1);
1532         vertex_count += 2 * ((int)((v2d->cur.ymax - v2d->cur.ymin) / lstep) + 1);
1533
1534         Gwn_VertFormat *format = immVertexFormat();
1535         unsigned int pos = GWN_vertformat_attr_add(format, "pos", GWN_COMP_F32, 2, GWN_FETCH_FLOAT);
1536         unsigned int color = GWN_vertformat_attr_add(format, "color", GWN_COMP_U8, 3, GWN_FETCH_INT_TO_FLOAT_UNIT);
1537
1538         glLineWidth(1.0f);
1539
1540         immBindBuiltinProgram(GPU_SHADER_2D_FLAT_COLOR);
1541         immBeginAtMost(GWN_PRIM_LINES, vertex_count);
1542
1543         for (int level = 0; level < totlevels; ++level) {
1544                 UI_GetThemeColorShade3ubv(colorid, offset, grid_line_color);
1545
1546                 int i = (int)(v2d->cur.xmin / lstep);
1547                 if (v2d->cur.xmin > 0.0f)
1548                         i++;
1549                 float start = i * lstep;
1550
1551                 for (; start < v2d->cur.xmax; start += lstep, ++i) {
1552                         if (i == 0 || (level < totlevels - 1 && i % level_size == 0))
1553                                 continue;
1554
1555                         immSkipAttrib(color);
1556                         immVertex2f(pos, start, v2d->cur.ymin);
1557                         immAttrib3ubv(color, grid_line_color);
1558                         immVertex2f(pos, start, v2d->cur.ymax);
1559                 }
1560
1561                 i = (int)(v2d->cur.ymin / lstep);
1562                 if (v2d->cur.ymin > 0.0f)
1563                         i++;
1564                 start = i * lstep;
1565
1566                 for (; start < v2d->cur.ymax; start += lstep, ++i) {
1567                         if (i == 0 || (level < totlevels - 1 && i % level_size == 0))
1568                                 continue;
1569
1570                         immSkipAttrib(color);
1571                         immVertex2f(pos, v2d->cur.xmin, start);
1572                         immAttrib3ubv(color, grid_line_color);
1573                         immVertex2f(pos, v2d->cur.xmax, start);
1574                 }
1575
1576                 lstep *= level_size;
1577                 offset -= 6;
1578         }
1579
1580         /* X and Y axis */
1581         UI_GetThemeColorShade3ubv(colorid, -18 + ((totlevels - 1) * -6), grid_line_color);
1582
1583         immSkipAttrib(color);
1584         immVertex2f(pos, 0.0f, v2d->cur.ymin);
1585         immAttrib3ubv(color, grid_line_color);
1586         immVertex2f(pos, 0.0f, v2d->cur.ymax);
1587
1588         immSkipAttrib(color);
1589         immVertex2f(pos, v2d->cur.xmin, 0.0f);
1590         immAttrib3ubv(color, grid_line_color);
1591         immVertex2f(pos, v2d->cur.xmax, 0.0f);
1592
1593         immEnd();
1594         immUnbindProgram();
1595 }
1596
1597 /* the price we pay for not exposting structs :( */
1598 void UI_view2d_grid_size(View2DGrid *grid, float *r_dx, float *r_dy)
1599 {
1600         *r_dx = grid->dx;
1601         *r_dy = grid->dy;
1602 }
1603
1604 /* free temporary memory used for drawing grid */
1605 void UI_view2d_grid_free(View2DGrid *grid)
1606 {
1607         /* only free if there's a grid */
1608         if (grid) {
1609                 MEM_freeN(grid);
1610         }
1611 }
1612
1613 /* *********************************************************************** */
1614 /* Scrollers */
1615
1616 /**
1617  * View2DScrollers is typedef'd in UI_view2d.h
1618  *
1619  * \warning The start of this struct must not change, as view2d_ops.c uses this too.
1620  * For now, we don't need to have a separate (internal) header for structs like this...
1621  */
1622 struct View2DScrollers {
1623         /* focus bubbles */
1624         int vert_min, vert_max; /* vertical scrollbar */
1625         int hor_min, hor_max;   /* horizontal scrollbar */
1626
1627         rcti hor, vert;         /* exact size of slider backdrop */
1628         int horfull, vertfull;  /* set if sliders are full, we don't draw them */
1629
1630         /* scales */
1631         View2DGrid *grid;       /* grid for coordinate drawing */
1632         short xunits, xclamp;   /* units and clamping options for x-axis */
1633         short yunits, yclamp;   /* units and clamping options for y-axis */
1634 };
1635
1636 /* Calculate relevant scroller properties */
1637 View2DScrollers *UI_view2d_scrollers_calc(
1638         const bContext *C, View2D *v2d,
1639         short xunits, short xclamp, short yunits, short yclamp)
1640 {
1641         View2DScrollers *scrollers;
1642         rcti vert, hor;
1643         float fac1, fac2, totsize, scrollsize;
1644         int scroll = view2d_scroll_mapped(v2d->scroll);
1645         int smaller;
1646
1647         /* scrollers is allocated here... */
1648         scrollers = MEM_callocN(sizeof(View2DScrollers), "View2DScrollers");
1649
1650         /* Always update before drawing (for dynamically sized scrollers). */
1651         view2d_masks(v2d, false);
1652
1653         vert = v2d->vert;
1654         hor = v2d->hor;
1655
1656         /* slider rects need to be smaller than region */
1657         smaller = (int)(0.1f * U.widget_unit);
1658         hor.xmin += smaller;
1659         hor.xmax -= smaller;
1660         if (scroll & V2D_SCROLL_BOTTOM)
1661                 hor.ymin += smaller;
1662         else
1663                 hor.ymax -= smaller;
1664
1665         if (scroll & V2D_SCROLL_LEFT)
1666                 vert.xmin += smaller;
1667         else
1668                 vert.xmax -= smaller;
1669         vert.ymin += smaller;
1670         vert.ymax -= smaller;
1671
1672         CLAMP(vert.ymin, vert.ymin, vert.ymax - V2D_SCROLLER_HANDLE_SIZE);
1673         CLAMP(hor.xmin, hor.xmin, hor.xmax - V2D_SCROLLER_HANDLE_SIZE);
1674
1675         /* store in scrollers, used for drawing */
1676         scrollers->vert = vert;
1677         scrollers->hor = hor;
1678
1679         /* scroller 'buttons':
1680          *      - These should always remain within the visible region of the scrollbar
1681          *      - They represent the region of 'tot' that is visible in 'cur'
1682          */
1683
1684         /* horizontal scrollers */
1685         if (scroll & V2D_SCROLL_HORIZONTAL) {
1686                 /* scroller 'button' extents */
1687                 totsize = BLI_rctf_size_x(&v2d->tot);
1688                 scrollsize = (float)BLI_rcti_size_x(&hor);
1689                 if (totsize == 0.0f) totsize = 1.0f;  /* avoid divide by zero */
1690
1691                 fac1 = (v2d->cur.xmin - v2d->tot.xmin) / totsize;
1692                 if (fac1 <= 0.0f)
1693                         scrollers->hor_min = hor.xmin;
1694                 else
1695                         scrollers->hor_min = (int)(hor.xmin + (fac1 * scrollsize));
1696
1697                 fac2 = (v2d->cur.xmax - v2d->tot.xmin) / totsize;
1698                 if (fac2 >= 1.0f)
1699                         scrollers->hor_max = hor.xmax;
1700                 else
1701                         scrollers->hor_max = (int)(hor.xmin + (fac2 * scrollsize));
1702
1703                 /* prevent inverted sliders */
1704                 if (scrollers->hor_min > scrollers->hor_max)
1705                         scrollers->hor_min = scrollers->hor_max;
1706                 /* prevent sliders from being too small, and disappearing */
1707                 if ((scrollers->hor_max - scrollers->hor_min) < V2D_SCROLLER_HANDLE_SIZE) {
1708                         scrollers->hor_max = scrollers->hor_min + V2D_SCROLLER_HANDLE_SIZE;
1709
1710                         CLAMP(scrollers->hor_max, hor.xmin + V2D_SCROLLER_HANDLE_SIZE, hor.xmax);
1711                         CLAMP(scrollers->hor_min, hor.xmin, hor.xmax - V2D_SCROLLER_HANDLE_SIZE);
1712                 }
1713
1714         }
1715
1716         /* vertical scrollers */
1717         if (scroll & V2D_SCROLL_VERTICAL) {
1718                 /* scroller 'button' extents */
1719                 totsize    =        BLI_rctf_size_y(&v2d->tot);
1720                 scrollsize = (float)BLI_rcti_size_y(&vert);
1721                 if (totsize == 0.0f) totsize = 1.0f;  /* avoid divide by zero */
1722
1723                 fac1 = (v2d->cur.ymin - v2d->tot.ymin) / totsize;
1724                 if (fac1 <= 0.0f)
1725                         scrollers->vert_min = vert.ymin;
1726                 else
1727                         scrollers->vert_min = (int)(vert.ymin + (fac1 * scrollsize));
1728
1729                 fac2 = (v2d->cur.ymax - v2d->tot.ymin) / totsize;
1730                 if (fac2 >= 1.0f)
1731                         scrollers->vert_max = vert.ymax;
1732                 else
1733                         scrollers->vert_max = (int)(vert.ymin + (fac2 * scrollsize));
1734
1735                 /* prevent inverted sliders */
1736                 if (scrollers->vert_min > scrollers->vert_max)
1737                         scrollers->vert_min = scrollers->vert_max;
1738                 /* prevent sliders from being too small, and disappearing */
1739                 if ((scrollers->vert_max - scrollers->vert_min) < V2D_SCROLLER_HANDLE_SIZE) {
1740
1741                         scrollers->vert_max = scrollers->vert_min + V2D_SCROLLER_HANDLE_SIZE;
1742
1743                         CLAMP(scrollers->vert_max, vert.ymin + V2D_SCROLLER_HANDLE_SIZE, vert.ymax);
1744                         CLAMP(scrollers->vert_min, vert.ymin, vert.ymax - V2D_SCROLLER_HANDLE_SIZE);
1745                 }
1746
1747         }
1748
1749         /* grid markings on scrollbars */
1750         if (scroll & (V2D_SCROLL_SCALE_HORIZONTAL | V2D_SCROLL_SCALE_VERTICAL)) {
1751                 /* store clamping */
1752                 scrollers->xclamp = xclamp;
1753                 scrollers->xunits = xunits;
1754                 scrollers->yclamp = yclamp;
1755                 scrollers->yunits = yunits;
1756
1757                 scrollers->grid = UI_view2d_grid_calc(CTX_data_scene(C), v2d,
1758                                                       xunits, xclamp, yunits, yclamp,
1759                                                       BLI_rcti_size_x(&hor), BLI_rcti_size_y(&vert));
1760         }
1761
1762         /* return scrollers */
1763         return scrollers;
1764 }
1765
1766 /* Print scale marking along a time scrollbar */
1767 static void scroll_printstr(Scene *scene, float x, float y, float val, int power, short unit, char dir)
1768 {
1769         int len;
1770         char timecode_str[32];
1771
1772         /* adjust the scale unit to work ok */
1773         if (dir == 'v') {
1774                 /* here we bump up the power by factor of 10, as
1775                  * rotation values (hence 'degrees') are divided by 10 to
1776                  * be able to show the curves at the same time
1777                  */
1778                 if (ELEM(unit, V2D_UNIT_DEGREES, V2D_UNIT_TIME)) {
1779                         power += 1;
1780                         val *= 10;
1781                 }
1782         }
1783
1784         /* get string to print */
1785         if (unit == V2D_UNIT_SECONDS) {
1786                 /* not neces*/
1787                 BLI_timecode_string_from_time(timecode_str, sizeof(timecode_str), power, val, FPS, U.timecode_style);
1788         }
1789         else {
1790                 BLI_timecode_string_from_time_seconds(timecode_str, sizeof(timecode_str), power, val);
1791         }
1792
1793         /* get length of string, and adjust printing location to fit it into the horizontal scrollbar */
1794         len = strlen(timecode_str);
1795         if (dir == 'h') {
1796                 /* seconds/timecode display has slightly longer strings... */
1797                 if (unit == V2D_UNIT_SECONDS)
1798                         x -= 3 * len;
1799                 else
1800                         x -= 4 * len;
1801         }
1802
1803         /* Add degree sympbol to end of string for vertical scrollbar? */
1804         if ((dir == 'v') && (unit == V2D_UNIT_DEGREES)) {
1805                 timecode_str[len] = 186;
1806                 timecode_str[len + 1] = 0;
1807         }
1808
1809         /* draw it */
1810         BLF_draw_default_ascii(x, y, 0.0f, timecode_str, sizeof(timecode_str));
1811 }
1812
1813 /* Draw scrollbars in the given 2d-region */
1814 void UI_view2d_scrollers_draw(const bContext *C, View2D *v2d, View2DScrollers *vs)
1815 {
1816         bTheme *btheme = UI_GetTheme();
1817         Scene *scene = CTX_data_scene(C);
1818         rcti vert, hor;
1819         const int scroll = view2d_scroll_mapped(v2d->scroll);
1820         const char emboss_alpha = btheme->tui.widget_emboss[3];
1821         unsigned char scrollers_back_color[4];
1822
1823         /* Color for scrollbar backs */
1824         UI_GetThemeColor4ubv(TH_BACK, scrollers_back_color);
1825
1826         /* make copies of rects for less typing */
1827         vert = vs->vert;
1828         hor = vs->hor;
1829
1830         /* horizontal scrollbar */
1831         if (scroll & V2D_SCROLL_HORIZONTAL) {
1832                 uiWidgetColors wcol = btheme->tui.wcol_scroll;
1833                 const float alpha_fac = v2d->alpha_hor / 255.0f;
1834                 rcti slider;
1835                 int state;
1836
1837                 slider.xmin = vs->hor_min;
1838                 slider.xmax = vs->hor_max;
1839                 slider.ymin = hor.ymin;
1840                 slider.ymax = hor.ymax;
1841
1842                 state = (v2d->scroll_ui & V2D_SCROLL_H_ACTIVE) ? UI_SCROLL_PRESSED : 0;
1843
1844                 wcol.inner[3]   *= alpha_fac;
1845                 wcol.item[3]    *= alpha_fac;
1846                 wcol.outline[3] *= alpha_fac;
1847                 btheme->tui.widget_emboss[3] *= alpha_fac; /* will be reset later */
1848
1849                 /* show zoom handles if:
1850                  *      - zooming on x-axis is allowed (no scroll otherwise)
1851                  *      - slider bubble is large enough (no overdraw confusion)
1852                  *      - scale is shown on the scroller
1853                  *        (workaround to make sure that button windows don't show these,
1854                  *              and only the time-grids with their zoomability can do so)
1855                  */
1856                 if ((v2d->keepzoom & V2D_LOCKZOOM_X) == 0 &&
1857                     (v2d->scroll & V2D_SCROLL_SCALE_HORIZONTAL) &&
1858                     (BLI_rcti_size_x(&slider) > V2D_SCROLLER_HANDLE_SIZE))
1859                 {
1860                         state |= UI_SCROLL_ARROWS;
1861                 }
1862
1863                 UI_draw_widget_scroll(&wcol, &hor, &slider, state);
1864
1865                 /* scale indicators */
1866                 if ((scroll & V2D_SCROLL_SCALE_HORIZONTAL) && (vs->grid)) {
1867                         const int font_id = BLF_default();
1868                         View2DGrid *grid = vs->grid;
1869                         float fac, dfac, fac2, val;
1870
1871                         /* the numbers: convert grid->startx and -dx to scroll coordinates
1872                          *      - fac is x-coordinate to draw to
1873                          *      - dfac is gap between scale markings
1874                          */
1875                         fac = (grid->startx - v2d->cur.xmin) / BLI_rctf_size_x(&v2d->cur);
1876                         fac = (float)hor.xmin + fac * BLI_rcti_size_x(&hor);
1877
1878                         dfac = grid->dx / BLI_rctf_size_x(&v2d->cur);
1879                         dfac = dfac * BLI_rcti_size_x(&hor);
1880
1881                         /* set starting value, and text color */
1882                         UI_FontThemeColor(font_id, TH_TEXT);
1883                         val = grid->startx;
1884
1885                         /* if we're clamping to whole numbers only, make sure entries won't be repeated */
1886                         if (vs->xclamp == V2D_GRID_CLAMP) {
1887                                 while (grid->dx < 0.9999f) {
1888                                         grid->dx *= 2.0f;
1889                                         dfac *= 2.0f;
1890                                 }
1891                         }
1892                         if (vs->xunits == V2D_UNIT_FRAMES)
1893                                 grid->powerx = 1;
1894
1895                         /* draw numbers in the appropriate range */
1896                         if (dfac > 0.0f) {
1897                                 float h = 0.1f * UI_UNIT_Y + (float)(hor.ymin);
1898
1899                                 BLF_batch_draw_begin();
1900
1901                                 for (; fac < hor.xmax - 0.5f * U.widget_unit; fac += dfac, val += grid->dx) {
1902
1903                                         /* make prints look nicer for scrollers */
1904                                         if (fac < hor.xmin + 0.5f * U.widget_unit)
1905                                                 continue;
1906
1907                                         switch (vs->xunits) {
1908                                                 case V2D_UNIT_FRAMES:       /* frames (as whole numbers)*/
1909                                                         scroll_printstr(scene, fac, h, val, grid->powerx, V2D_UNIT_FRAMES, 'h');
1910                                                         break;
1911
1912                                                 case V2D_UNIT_FRAMESCALE:   /* frames (not always as whole numbers) */
1913                                                         scroll_printstr(scene, fac, h, val, grid->powerx, V2D_UNIT_FRAMESCALE, 'h');
1914                                                         break;
1915
1916                                                 case V2D_UNIT_SECONDS:      /* seconds */
1917                                                         fac2 = val / (float)FPS;
1918                                                         scroll_printstr(scene, fac, h, fac2, grid->powerx, V2D_UNIT_SECONDS, 'h');
1919                                                         break;
1920
1921                                                 case V2D_UNIT_DEGREES:      /* Graph Editor for rotation Drivers */
1922                                                         /* HACK: although we're drawing horizontal, we make this draw as 'vertical', just to get degree signs */
1923                                                         scroll_printstr(scene, fac, h, val, grid->powerx, V2D_UNIT_DEGREES, 'v');
1924                                                         break;
1925                                         }
1926                                 }
1927
1928                                 BLF_batch_draw_end();
1929                         }
1930                 }
1931         }
1932
1933         /* vertical scrollbar */
1934         if (scroll & V2D_SCROLL_VERTICAL) {
1935                 uiWidgetColors wcol = btheme->tui.wcol_scroll;
1936                 rcti slider;
1937                 const float alpha_fac = v2d->alpha_vert / 255.0f;
1938                 int state;
1939
1940                 slider.xmin = vert.xmin;
1941                 slider.xmax = vert.xmax;
1942                 slider.ymin = vs->vert_min;
1943                 slider.ymax = vs->vert_max;
1944
1945                 state = (v2d->scroll_ui & V2D_SCROLL_V_ACTIVE) ? UI_SCROLL_PRESSED : 0;
1946
1947                 wcol.inner[3]   *= alpha_fac;
1948                 wcol.item[3]    *= alpha_fac;
1949                 wcol.outline[3] *= alpha_fac;
1950                 btheme->tui.widget_emboss[3] *= alpha_fac; /* will be reset later */
1951
1952                 /* show zoom handles if:
1953                  *      - zooming on y-axis is allowed (no scroll otherwise)
1954                  *      - slider bubble is large enough (no overdraw confusion)
1955                  *      - scale is shown on the scroller
1956                  *        (workaround to make sure that button windows don't show these,
1957                  *              and only the time-grids with their zoomability can do so)
1958                  */
1959                 if ((v2d->keepzoom & V2D_LOCKZOOM_Y) == 0 &&
1960                     (v2d->scroll & V2D_SCROLL_SCALE_VERTICAL) &&
1961                     (BLI_rcti_size_y(&slider) > V2D_SCROLLER_HANDLE_SIZE))
1962                 {
1963                         state |= UI_SCROLL_ARROWS;
1964                 }
1965
1966                 UI_draw_widget_scroll(&wcol, &vert, &slider, state);
1967
1968
1969                 /* scale indiators */
1970                 if ((scroll & V2D_SCROLL_SCALE_VERTICAL) && (vs->grid)) {
1971                         View2DGrid *grid = vs->grid;
1972                         float fac, dfac, val;
1973
1974                         /* the numbers: convert grid->starty and dy to scroll coordinates
1975                          *      - fac is y-coordinate to draw to
1976                          *      - dfac is gap between scale markings
1977                          *      - these involve a correction for horizontal scrollbar
1978                          *        NOTE: it's assumed that that scrollbar is there if this is involved!
1979                          */
1980                         fac = (grid->starty - v2d->cur.ymin) / BLI_rctf_size_y(&v2d->cur);
1981                         fac = vert.ymin + fac * BLI_rcti_size_y(&vert);
1982
1983                         dfac = grid->dy / BLI_rctf_size_y(&v2d->cur);
1984                         dfac = dfac     * BLI_rcti_size_y(&vert);
1985
1986                         /* set starting value, and text color */
1987                         const int font_id = BLF_default();
1988                         UI_FontThemeColor(font_id, TH_TEXT);
1989                         val = grid->starty;
1990
1991                         /* if vertical clamping (to whole numbers) is used (i.e. in Sequencer), apply correction */
1992                         if (vs->yclamp == V2D_GRID_CLAMP)
1993                                 fac += 0.5f * dfac;
1994
1995                         /* draw vertical steps */
1996                         if (dfac > 0.0f) {
1997                                 BLF_rotation(font_id, M_PI_2);
1998                                 BLF_enable(font_id, BLF_ROTATION);
1999
2000                                 for (; fac < vert.ymax - 10; fac += dfac, val += grid->dy) {
2001
2002                                         /* make prints look nicer for scrollers */
2003                                         if (fac < vert.ymin + 10)
2004                                                 continue;
2005
2006                                         scroll_printstr(scene, (float)(vert.xmax) - 2.0f, fac, val, grid->powery, vs->yunits, 'v');
2007                                 }
2008
2009                                 BLF_disable(font_id, BLF_ROTATION);
2010                         }
2011                 }
2012         }
2013
2014         /* Was changed above, so reset. */
2015         btheme->tui.widget_emboss[3] = emboss_alpha;
2016 }
2017
2018 /* free temporary memory used for drawing scrollers */
2019 void UI_view2d_scrollers_free(View2DScrollers *scrollers)
2020 {
2021         /* need to free grid as well... */
2022         if (scrollers->grid) {
2023                 MEM_freeN(scrollers->grid);
2024         }
2025         MEM_freeN(scrollers);
2026 }
2027
2028 /* *********************************************************************** */
2029 /* List View Utilities */
2030
2031 /** Get the view-coordinates of the nominated cell
2032  *
2033  * \param columnwidth, rowheight: size of each 'cell'
2034  * \param startx, starty: coordinates (in 'tot' rect space) that the list starts from.
2035  * This should be (0,0) for most views. However, for those where the starting row was offsetted
2036  * (like for Animation Editor channel lists, to make the first entry more visible), these will be
2037  * the min-coordinates of the first item.
2038  * \param column, row: The 2d-coordinates
2039  * (in 2D-view / 'tot' rect space) the cell exists at
2040  * \param rect:  coordinates of the cell
2041  * (passed as single var instead of 4 separate, as it's more useful this way)
2042  */
2043 void UI_view2d_listview_cell_to_view(
2044         View2D *v2d, float columnwidth, float rowheight,
2045         float startx, float starty,
2046         int column, int row, rctf *rect)
2047 {
2048         /* sanity checks */
2049         if (ELEM(NULL, v2d, rect)) {
2050                 return;
2051         }
2052
2053         if ((columnwidth <= 0) && (rowheight <= 0)) {
2054                 rect->xmin = rect->xmax = 0.0f;
2055                 rect->ymin = rect->ymax = 0.0f;
2056                 return;
2057         }
2058
2059         /* x-coordinates */
2060         rect->xmin = startx + (float)(columnwidth * column);
2061         rect->xmax = startx + (float)(columnwidth * (column + 1));
2062
2063         if ((v2d->align & V2D_ALIGN_NO_POS_X) && !(v2d->align & V2D_ALIGN_NO_NEG_X)) {
2064                 /* simply negate the values for the coordinates if in negative half */
2065                 rect->xmin = -rect->xmin;
2066                 rect->xmax = -rect->xmax;
2067         }
2068
2069         /* y-coordinates */
2070         rect->ymin = starty + (float)(rowheight * row);
2071         rect->ymax = starty + (float)(rowheight * (row + 1));
2072
2073         if ((v2d->align & V2D_ALIGN_NO_POS_Y) && !(v2d->align & V2D_ALIGN_NO_NEG_Y)) {
2074                 /* simply negate the values for the coordinates if in negative half */
2075                 rect->ymin = -rect->ymin;
2076                 rect->ymax = -rect->ymax;
2077         }
2078 }
2079
2080 /**
2081  * Get the 'cell' (row, column) that the given 2D-view coordinates (i.e. in 'tot' rect space) lie in.
2082  *
2083  * \param columnwidth, rowheight: size of each 'cell'
2084  * \param startx, starty: coordinates (in 'tot' rect space) that the list starts from.
2085  * This should be (0,0) for most views. However, for those where the starting row was offsetted
2086  * (like for Animation Editor channel lists, to make the first entry more visible), these will be
2087  * the min-coordinates of the first item.
2088  * \param viewx, viewy: 2D-coordinates (in 2D-view / 'tot' rect space) to get the cell for
2089  * \param column, row: the 'coordinates' of the relevant 'cell'
2090  */
2091 void UI_view2d_listview_view_to_cell(
2092         View2D *v2d, float columnwidth, float rowheight, float startx, float starty,
2093         float viewx, float viewy, int *column, int *row)
2094 {
2095         /* adjust view coordinates to be all positive ints, corrected for the start offset */
2096         const int x = (int)(floorf(fabsf(viewx) + 0.5f) - startx);
2097         const int y = (int)(floorf(fabsf(viewy) + 0.5f) - starty);
2098
2099         /* sizes must not be negative */
2100         if ((v2d == NULL) || ((columnwidth <= 0) && (rowheight <= 0))) {
2101                 if (column) *column = 0;
2102                 if (row) *row = 0;
2103
2104                 return;
2105         }
2106
2107         /* get column */
2108         if ((column) && (columnwidth > 0))
2109                 *column = x / columnwidth;
2110         else if (column)
2111                 *column = 0;
2112
2113         /* get row */
2114         if ((row) && (rowheight > 0))
2115                 *row = y / rowheight;
2116         else if (row)
2117                 *row = 0;
2118 }
2119
2120 /**
2121  * Get the 'extreme' (min/max) column and row indices which are visible within the 'cur' rect
2122  *
2123  * \param columnwidth, rowheight: Size of each 'cell'
2124  * \param startx, starty: Coordinates that the list starts from, which should be (0,0) for most views
2125  * \param column_min, column_max, row_min, row_max: The starting and ending column/row indices
2126  */
2127 void UI_view2d_listview_visible_cells(
2128         View2D *v2d, float columnwidth, float rowheight, float startx, float starty,
2129         int *column_min, int *column_max, int *row_min, int *row_max)
2130 {
2131         /* using 'cur' rect coordinates, call the cell-getting function to get the cells for this */
2132         if (v2d) {
2133                 /* min */
2134                 UI_view2d_listview_view_to_cell(v2d, columnwidth, rowheight, startx, starty,
2135                                                 v2d->cur.xmin, v2d->cur.ymin, column_min, row_min);
2136
2137                 /* max*/
2138                 UI_view2d_listview_view_to_cell(v2d, columnwidth, rowheight, startx, starty,
2139                                                 v2d->cur.xmax, v2d->cur.ymax, column_max, row_max);
2140         }
2141 }
2142
2143 /* *********************************************************************** */
2144 /* Coordinate Conversions */
2145
2146 float UI_view2d_region_to_view_x(struct View2D *v2d, float x)
2147 {
2148         return (v2d->cur.xmin + (BLI_rctf_size_x(&v2d->cur) * (x - v2d->mask.xmin) / BLI_rcti_size_x(&v2d->mask)));
2149 }
2150 float UI_view2d_region_to_view_y(struct View2D *v2d, float y)
2151 {
2152         return (v2d->cur.ymin + (BLI_rctf_size_y(&v2d->cur) * (y - v2d->mask.ymin) / BLI_rcti_size_y(&v2d->mask)));
2153 }
2154
2155 /**
2156  * Convert from screen/region space to 2d-View space
2157  *
2158  * \param x, y: coordinates to convert
2159  * \param r_view_x, r_view_y: resultant coordinates
2160  */
2161 void UI_view2d_region_to_view(View2D *v2d, float x, float y, float *r_view_x, float *r_view_y)
2162 {
2163         *r_view_x = UI_view2d_region_to_view_x(v2d, x);
2164         *r_view_y = UI_view2d_region_to_view_y(v2d, y);
2165 }
2166
2167 void UI_view2d_region_to_view_rctf(View2D *v2d, const rctf *rect_src, rctf *rect_dst)
2168 {
2169         const float cur_size[2]  = {BLI_rctf_size_x(&v2d->cur),  BLI_rctf_size_y(&v2d->cur)};
2170         const float mask_size[2] = {BLI_rcti_size_x(&v2d->mask), BLI_rcti_size_y(&v2d->mask)};
2171
2172         rect_dst->xmin = (v2d->cur.xmin + (cur_size[0] * (rect_src->xmin - v2d->mask.xmin) / mask_size[0]));
2173         rect_dst->xmax = (v2d->cur.xmin + (cur_size[0] * (rect_src->xmax - v2d->mask.xmin) / mask_size[0]));
2174         rect_dst->ymin = (v2d->cur.ymin + (cur_size[1] * (rect_src->ymin - v2d->mask.ymin) / mask_size[1]));
2175         rect_dst->ymax = (v2d->cur.ymin + (cur_size[1] * (rect_src->ymax - v2d->mask.ymin) / mask_size[1]));
2176 }
2177
2178 float UI_view2d_view_to_region_x(View2D *v2d, float x)
2179 {
2180         return (v2d->mask.xmin + (((x - v2d->cur.xmin) / BLI_rctf_size_x(&v2d->cur)) * BLI_rcti_size_x(&v2d->mask)));
2181 }
2182 float UI_view2d_view_to_region_y(View2D *v2d, float y)
2183 {
2184         return (v2d->mask.ymin + (((y - v2d->cur.ymin) / BLI_rctf_size_y(&v2d->cur)) * BLI_rcti_size_y(&v2d->mask)));
2185 }
2186
2187 /**
2188  * Convert from 2d-View space to screen/region space
2189  * \note Coordinates are clamped to lie within bounds of region
2190  *
2191  * \param x, y: Coordinates to convert.
2192  * \param r_region_x, r_region_y: Resultant coordinates.
2193  */
2194 bool UI_view2d_view_to_region_clip(View2D *v2d, float x, float y, int *r_region_x, int *r_region_y)
2195 {
2196         /* express given coordinates as proportional values */
2197         x = (x - v2d->cur.xmin) / BLI_rctf_size_x(&v2d->cur);
2198         y = (y - v2d->cur.ymin) / BLI_rctf_size_y(&v2d->cur);
2199
2200         /* check if values are within bounds */
2201         if ((x >= 0.0f) && (x <= 1.0f) && (y >= 0.0f) && (y <= 1.0f)) {
2202                 *r_region_x = (int)(v2d->mask.xmin + (x * BLI_rcti_size_x(&v2d->mask)));
2203                 *r_region_y = (int)(v2d->mask.ymin + (y * BLI_rcti_size_y(&v2d->mask)));
2204
2205                 return true;
2206         }
2207         else {
2208                 /* set initial value in case coordinate lies outside of bounds */
2209                 *r_region_x = *r_region_y = V2D_IS_CLIPPED;
2210
2211                 return false;
2212         }
2213 }
2214
2215 /**
2216  * Convert from 2d-view space to screen/region space
2217  *
2218  * \note Coordinates are NOT clamped to lie within bounds of region.
2219  *
2220  * \param x, y: Coordinates to convert.
2221  * \param r_region_x, r_region_y: Resultant coordinates.
2222  */
2223 void UI_view2d_view_to_region(View2D *v2d, float x, float y, int *r_region_x, int *r_region_y)
2224 {
2225         /* step 1: express given coordinates as proportional values */
2226         x = (x - v2d->cur.xmin) / BLI_rctf_size_x(&v2d->cur);
2227         y = (y - v2d->cur.ymin) / BLI_rctf_size_y(&v2d->cur);
2228
2229         /* step 2: convert proportional distances to screen coordinates  */
2230         x = v2d->mask.xmin + (x * BLI_rcti_size_x(&v2d->mask));
2231         y = v2d->mask.ymin + (y * BLI_rcti_size_y(&v2d->mask));
2232
2233         /* although we don't clamp to lie within region bounds, we must avoid exceeding size of ints */
2234         *r_region_x = clamp_float_to_int(x);
2235         *r_region_y = clamp_float_to_int(y);
2236 }
2237
2238 void UI_view2d_view_to_region_fl(View2D *v2d, float x, float y, float *r_region_x, float *r_region_y)
2239 {
2240         /* express given coordinates as proportional values */
2241         x = (x - v2d->cur.xmin) / BLI_rctf_size_x(&v2d->cur);
2242         y = (y - v2d->cur.ymin) / BLI_rctf_size_y(&v2d->cur);
2243
2244         /* convert proportional distances to screen coordinates */
2245         *r_region_x = v2d->mask.xmin + (x * BLI_rcti_size_x(&v2d->mask));
2246         *r_region_y = v2d->mask.ymin + (y * BLI_rcti_size_y(&v2d->mask));
2247 }
2248
2249 void UI_view2d_view_to_region_rcti(View2D *v2d, const rctf *rect_src, rcti *rect_dst)
2250 {
2251         const float cur_size[2]  = {BLI_rctf_size_x(&v2d->cur),  BLI_rctf_size_y(&v2d->cur)};
2252         const float mask_size[2] = {BLI_rcti_size_x(&v2d->mask), BLI_rcti_size_y(&v2d->mask)};
2253         rctf rect_tmp;
2254
2255         /* step 1: express given coordinates as proportional values */
2256         rect_tmp.xmin = (rect_src->xmin - v2d->cur.xmin) / cur_size[0];
2257         rect_tmp.xmax = (rect_src->xmax - v2d->cur.xmin) / cur_size[0];
2258         rect_tmp.ymin = (rect_src->ymin - v2d->cur.ymin) / cur_size[1];
2259         rect_tmp.ymax = (rect_src->ymax - v2d->cur.ymin) / cur_size[1];
2260
2261
2262         /* step 2: convert proportional distances to screen coordinates  */
2263         rect_tmp.xmin = v2d->mask.xmin + (rect_tmp.xmin * mask_size[0]);
2264         rect_tmp.xmax = v2d->mask.xmin + (rect_tmp.xmax * mask_size[0]);
2265         rect_tmp.ymin = v2d->mask.ymin + (rect_tmp.ymin * mask_size[1]);
2266         rect_tmp.ymax = v2d->mask.ymin + (rect_tmp.ymax * mask_size[1]);
2267
2268         clamp_rctf_to_rcti(rect_dst, &rect_tmp);
2269 }
2270
2271 void UI_view2d_view_to_region_m4(View2D *v2d, float matrix[4][4])
2272 {
2273         rctf mask;
2274         unit_m4(matrix);
2275         BLI_rctf_rcti_copy(&mask, &v2d->mask);
2276         BLI_rctf_transform_calc_m4_pivot_min(&v2d->cur, &mask, matrix);
2277 }
2278
2279 bool UI_view2d_view_to_region_rcti_clip(View2D *v2d, const rctf *rect_src, rcti *rect_dst)
2280 {
2281         const float cur_size[2]  = {BLI_rctf_size_x(&v2d->cur),  BLI_rctf_size_y(&v2d->cur)};
2282         const float mask_size[2] = {BLI_rcti_size_x(&v2d->mask), BLI_rcti_size_y(&v2d->mask)};
2283         rctf rect_tmp;
2284
2285         BLI_assert(rect_src->xmin <= rect_src->xmax && rect_src->ymin <= rect_src->ymax);
2286
2287         /* step 1: express given coordinates as proportional values */
2288         rect_tmp.xmin = (rect_src->xmin - v2d->cur.xmin) / cur_size[0];
2289         rect_tmp.xmax = (rect_src->xmax - v2d->cur.xmin) / cur_size[0];
2290         rect_tmp.ymin = (rect_src->ymin - v2d->cur.ymin) / cur_size[1];
2291         rect_tmp.ymax = (rect_src->ymax - v2d->cur.ymin) / cur_size[1];
2292
2293         if (((rect_tmp.xmax < 0.0f) || (rect_tmp.xmin > 1.0f) ||
2294              (rect_tmp.ymax < 0.0f) || (rect_tmp.ymin > 1.0f)) == 0)
2295         {
2296                 /* step 2: convert proportional distances to screen coordinates  */
2297                 rect_tmp.xmin = v2d->mask.xmin + (rect_tmp.xmin * mask_size[0]);
2298                 rect_tmp.xmax = v2d->mask.ymin + (rect_tmp.xmax * mask_size[0]);
2299                 rect_tmp.ymin = v2d->mask.ymin + (rect_tmp.ymin * mask_size[1]);
2300                 rect_tmp.ymax = v2d->mask.ymin + (rect_tmp.ymax * mask_size[1]);
2301
2302                 clamp_rctf_to_rcti(rect_dst, &rect_tmp);
2303
2304                 return true;
2305         }
2306         else {
2307                 rect_dst->xmin = rect_dst->xmax = rect_dst->ymin = rect_dst->ymax = V2D_IS_CLIPPED;
2308
2309                 return false;
2310         }
2311 }
2312
2313 /* *********************************************************************** */
2314 /* Utilities */
2315
2316 /* View2D data by default resides in region, so get from region stored in context */
2317 View2D *UI_view2d_fromcontext(const bContext *C)
2318 {
2319         ScrArea *area = CTX_wm_area(C);
2320         ARegion *region = CTX_wm_region(C);
2321
2322         if (area == NULL) return NULL;
2323         if (region == NULL) return NULL;
2324         return &(region->v2d);
2325 }
2326
2327 /* same as above, but it returns regionwindow. Utility for pulldowns or buttons */
2328 View2D *UI_view2d_fromcontext_rwin(const bContext *C)
2329 {
2330         ScrArea *sa = CTX_wm_area(C);
2331         ARegion *region = CTX_wm_region(C);
2332
2333         if (sa == NULL) return NULL;
2334         if (region == NULL) return NULL;
2335         if (region->regiontype != RGN_TYPE_WINDOW) {
2336                 ARegion *ar = BKE_area_find_region_type(sa, RGN_TYPE_WINDOW);
2337                 return ar ? &(ar->v2d) : NULL;
2338         }
2339         return &(region->v2d);
2340 }
2341
2342
2343 /**
2344  * Calculate the scale per-axis of the drawing-area
2345  *
2346  * Is used to inverse correct drawing of icons, etc. that need to follow view
2347  * but not be affected by scale
2348  *
2349  * \param x, y: scale on each axis
2350  */
2351 void UI_view2d_scale_get(View2D *v2d, float *x, float *y)
2352 {
2353         if (x) *x = BLI_rcti_size_x(&v2d->mask) / BLI_rctf_size_x(&v2d->cur);
2354         if (y) *y = BLI_rcti_size_y(&v2d->mask) / BLI_rctf_size_y(&v2d->cur);
2355 }
2356 /**
2357  * Same as ``UI_view2d_scale_get() - 1.0f / x, y``
2358  */
2359 void UI_view2d_scale_get_inverse(View2D *v2d, float *x, float *y)
2360 {
2361         if (x) *x = BLI_rctf_size_x(&v2d->cur) / BLI_rcti_size_x(&v2d->mask);
2362         if (y) *y = BLI_rctf_size_y(&v2d->cur) / BLI_rcti_size_y(&v2d->mask);
2363 }
2364
2365 /**
2366  * Simple functions for consistent center offset access.
2367  * Used by node editor to shift view center for each individual node tree.
2368  */
2369 void UI_view2d_center_get(struct View2D *v2d, float *x, float *y)
2370 {
2371         /* get center */
2372         if (x) *x = BLI_rctf_cent_x(&v2d->cur);
2373         if (y) *y = BLI_rctf_cent_y(&v2d->cur);
2374 }
2375 void UI_view2d_center_set(struct View2D *v2d, float x, float y)
2376 {
2377         BLI_rctf_recenter(&v2d->cur, x, y);
2378
2379         /* make sure that 'cur' rect is in a valid state as a result of these changes */
2380         UI_view2d_curRect_validate(v2d);
2381 }
2382
2383 /**
2384  * Simple pan function
2385  *  (0.0, 0.0) bottom left
2386  *  (0.5, 0.5) center
2387  *  (1.0, 1.0) top right.
2388  */
2389 void UI_view2d_offset(struct View2D *v2d, float xfac, float yfac)
2390 {
2391         if (xfac != -1.0f) {
2392                 const float xsize = BLI_rctf_size_x(&v2d->cur);
2393                 const float xmin = v2d->tot.xmin;
2394                 const float xmax = v2d->tot.xmax - xsize;
2395
2396                 v2d->cur.xmin = (xmin * (1.0f - xfac)) + (xmax * xfac);
2397                 v2d->cur.xmax = v2d->cur.xmin + xsize;
2398         }
2399
2400         if (yfac != -1.0f) {
2401                 const float ysize = BLI_rctf_size_y(&v2d->cur);
2402                 const float ymin = v2d->tot.ymin;
2403                 const float ymax = v2d->tot.ymax - ysize;
2404
2405                 v2d->cur.ymin = (ymin * (1.0f - yfac)) + (ymax * yfac);
2406                 v2d->cur.ymax = v2d->cur.ymin + ysize;
2407         }
2408
2409         UI_view2d_curRect_validate(v2d);
2410 }
2411
2412 /**
2413  * Check if mouse is within scrollers
2414  *
2415  * \param x, y: Mouse coordinates in screen (not region) space.
2416  *
2417  * \return appropriate code for match.
2418  * - 'h' = in horizontal scroller.
2419  * - 'v' = in vertical scroller.
2420  * - 0 = not in scroller.
2421  */
2422 short UI_view2d_mouse_in_scrollers(const ARegion *ar, View2D *v2d, int x, int y)
2423 {
2424         int co[2];
2425         int scroll = view2d_scroll_mapped(v2d->scroll);
2426
2427         /* clamp x,y to region-coordinates first */
2428         co[0] = x - ar->winrct.xmin;
2429         co[1] = y - ar->winrct.ymin;
2430
2431         /* check if within scrollbars */
2432         if (scroll & V2D_SCROLL_HORIZONTAL) {
2433                 if (IN_2D_HORIZ_SCROLL(v2d, co)) return 'h';
2434         }
2435         if (scroll & V2D_SCROLL_VERTICAL) {
2436                 if (IN_2D_VERT_SCROLL(v2d, co)) return 'v';
2437         }
2438
2439         /* not found */
2440         return 0;
2441 }
2442
2443 /* ******************* view2d text drawing cache ******************** */
2444
2445 typedef struct View2DString {
2446         struct View2DString *next;
2447         union {
2448                 unsigned char ub[4];
2449                 int pack;
2450         } col;
2451         rcti rect;
2452         int mval[2];
2453
2454         /* str is allocated past the end */
2455         char str[0];
2456 } View2DString;
2457
2458 /* assumes caches are used correctly, so for time being no local storage in v2d */
2459 static MemArena     *g_v2d_strings_arena = NULL;
2460 static View2DString *g_v2d_strings = NULL;
2461
2462 void UI_view2d_text_cache_add(
2463         View2D *v2d, float x, float y,
2464         const char *str, size_t str_len, const char col[4])
2465 {
2466         int mval[2];
2467
2468         BLI_assert(str_len == strlen(str));
2469
2470         if (UI_view2d_view_to_region_clip(v2d, x, y, &mval[0], &mval[1])) {
2471                 int alloc_len = str_len + 1;
2472                 View2DString *v2s;
2473
2474                 if (g_v2d_strings_arena == NULL) {
2475                         g_v2d_strings_arena = BLI_memarena_new(MEM_SIZE_OPTIMAL(1 << 14), __func__);
2476                 }
2477
2478                 v2s = BLI_memarena_alloc(g_v2d_strings_arena, sizeof(View2DString) + alloc_len);
2479
2480                 BLI_LINKS_PREPEND(g_v2d_strings, v2s);
2481
2482                 v2s->col.pack = *((const int *)col);
2483
2484                 memset(&v2s->rect, 0, sizeof(v2s->rect));
2485
2486                 v2s->mval[0] = mval[0];
2487                 v2s->mval[1] = mval[1];
2488
2489                 memcpy(v2s->str, str, alloc_len);
2490         }
2491 }
2492
2493 /* no clip (yet) */
2494 void UI_view2d_text_cache_add_rectf(
2495         View2D *v2d, const rctf *rect_view,
2496         const char *str, size_t str_len, const char col[4])
2497 {
2498         rcti rect;
2499
2500         BLI_assert(str_len == strlen(str));
2501
2502         if (UI_view2d_view_to_region_rcti_clip(v2d, rect_view, &rect)) {
2503                 int alloc_len = str_len + 1;
2504                 View2DString *v2s;
2505
2506                 if (g_v2d_strings_arena == NULL) {
2507                         g_v2d_strings_arena = BLI_memarena_new(MEM_SIZE_OPTIMAL(1 << 14), __func__);
2508                 }
2509
2510                 v2s = BLI_memarena_alloc(g_v2d_strings_arena, sizeof(View2DString) + alloc_len);
2511
2512                 BLI_LINKS_PREPEND(g_v2d_strings, v2s);
2513
2514                 v2s->col.pack = *((const int *)col);
2515
2516                 v2s->rect = rect;
2517
2518                 v2s->mval[0] = v2s->rect.xmin;
2519                 v2s->mval[1] = v2s->rect.ymin;
2520
2521                 memcpy(v2s->str, str, alloc_len);
2522         }
2523 }
2524
2525
2526 void UI_view2d_text_cache_draw(ARegion *ar)
2527 {
2528         View2DString *v2s;
2529         int col_pack_prev = 0;
2530
2531         /* investigate using BLF_ascender() */
2532         const int font_id = BLF_default();
2533         const float default_height = g_v2d_strings ? BLF_height(font_id, "28", 3) : 0.0f;
2534
2535         wmOrtho2_region_pixelspace(ar);
2536
2537         for (v2s = g_v2d_strings; v2s; v2s = v2s->next) {
2538                 int xofs = 0, yofs;
2539
2540                 yofs = ceil(0.5f * (BLI_rcti_size_y(&v2s->rect) - default_height));
2541                 if (yofs < 1) yofs = 1;
2542
2543                 if (col_pack_prev != v2s->col.pack) {
2544                         BLF_color3ubv(font_id, v2s->col.ub);
2545                         col_pack_prev = v2s->col.pack;
2546                 }
2547
2548                 if (v2s->rect.xmin >= v2s->rect.xmax)
2549                         BLF_draw_default((float)(v2s->mval[0] + xofs), (float)(v2s->mval[1] + yofs), 0.0,
2550                                           v2s->str, BLF_DRAW_STR_DUMMY_MAX);
2551                 else {
2552                         BLF_enable(font_id, BLF_CLIPPING);
2553                         BLF_clipping(font_id, v2s->rect.xmin - 4, v2s->rect.ymin - 4, v2s->rect.xmax + 4, v2s->rect.ymax + 4);
2554                         BLF_draw_default(v2s->rect.xmin + xofs, v2s->rect.ymin + yofs, 0.0f,
2555                                          v2s->str, BLF_DRAW_STR_DUMMY_MAX);
2556                         BLF_disable(font_id, BLF_CLIPPING);
2557                 }
2558         }
2559         g_v2d_strings = NULL;
2560
2561         if (g_v2d_strings_arena) {
2562                 BLI_memarena_free(g_v2d_strings_arena);
2563                 g_v2d_strings_arena = NULL;
2564         }
2565 }
2566
2567
2568 /* ******************************************************** */
2569
2570