View2D: Scrollbar tweaks
[blender.git] / source / blender / editors / include / UI_view2d.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation, Joshua Leung
25  *
26  *
27  * Generic 2d view with should allow drawing grids,
28  * panning, zooming, scrolling, .. 
29  * ***** END GPL LICENSE BLOCK *****
30  */
31
32 #ifndef UI_VIEW2D_H
33 #define UI_VIEW2D_H
34
35 /* ------------------------------------------ */
36 /* Settings:                                                            */
37
38 /* generic value to use when coordinate lies out of view when converting */
39 #define V2D_IS_CLIPPED  12000
40
41 /* grid-units (for drawing time) */
42 #define V2D_UNIT_SECONDS        0
43 #define V2D_UNIT_FRAMES         1
44
45 /* grid-units (for drawing values) */
46 #define V2D_UNIT_VALUES         2
47 #define V2D_UNIT_DEGREES        3
48 #define V2D_UNIT_TIME           4
49 #define V2D_UNIT_SECONDSSEQ     5
50
51 /* clamping of grid values to whole numbers */
52 #define V2D_GRID_CLAMP          0
53 #define V2D_GRID_NOCLAMP        1
54
55 /* flags for grid-lines to draw */
56 #define V2D_HORIZONTAL_LINES    (1<<0)
57 #define V2D_VERTICAL_LINES              (1<<1)
58 #define V2D_HORIZONTAL_AXIS             (1<<2)
59 #define V2D_VERTICAL_AXIS               (1<<3)
60
61
62 /* ------------------------------------------ */
63 /* Macros:                                                              */
64
65 /* test if mouse in a scrollbar */
66 #define IN_2D_VERT_SCROLL(v2d, co) (BLI_in_rcti(&v2d->vert, co[0], co[1]))
67 #define IN_2D_HORIZ_SCROLL(v2d, co) (BLI_in_rcti(&v2d->hor, co[0], co[1]))
68
69 /* ------------------------------------------ */
70 /* Type definitions:                                            */
71
72 struct View2D;
73 struct View2DGrid;
74 struct View2DScrollers;
75
76 struct wmWindowManager;
77 struct bContext;
78
79 typedef struct View2DGrid View2DGrid;
80 typedef struct View2DScrollers View2DScrollers;
81
82 /* ----------------------------------------- */
83 /* Prototypes:                                              */
84
85 /* setup */
86 void UI_view2d_view_ortho(const struct bContext *C, struct View2D *v2d);
87 void UI_view2d_view_orthospecial(const struct bContext *C, struct View2D *v2d, short xaxis);
88 void UI_view2d_view_restore(const struct bContext *C);
89
90 void UI_view2d_update_size(struct View2D *v2d, int winx, int winy);
91 void UI_view2d_enforce_status(struct View2D *v2d, int winx, int winy);
92
93 /* grid drawing */
94 View2DGrid *UI_view2d_calc_grid(const struct bContext *C, struct View2D *v2d, short unit, short clamp, int winx, int winy);
95 void UI_view2d_draw_grid(const struct bContext *C, struct View2D *v2d, View2DGrid *grid, int flag);
96 void UI_view2d_free_grid(View2DGrid *grid);
97
98 /* scrollbar drawing */
99 View2DScrollers *UI_view2d_calc_scrollers(const struct bContext *C, struct View2D *v2d, short xunits, short xclamp, short yunits, short yclamp);
100 void UI_view2d_draw_scrollers(const struct bContext *C, struct View2D *v2d, View2DScrollers *scrollers);
101 void UI_view2d_free_scrollers(View2DScrollers *scrollers);
102
103 /* coordinate conversion */
104 void UI_view2d_region_to_view(struct View2D *v2d, int x, int y, float *viewx, float *viewy);
105 void UI_view2d_view_to_region(struct View2D *v2d, float x, float y, short *regionx, short *regiony);
106 void UI_view2d_to_region_no_clip(struct View2D *v2d, float x, float y, short *regionx, short *region_y);
107
108 /* utilities */
109 struct View2D *UI_view2d_fromcontext(const struct bContext *C);
110 void UI_view2d_getscale(struct View2D *v2d, float *x, float *y);
111
112
113 /* operators */
114 void ui_view2d_operatortypes(void);
115 void UI_view2d_keymap(struct wmWindowManager *wm);
116
117 #endif /* UI_VIEW2D_H */
118