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