8fbff25589d422224df77affabf86628119b4b65
[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 and Defines:                                        */
37
38 /* ---- General Defines ---- */
39
40 /* generic value to use when coordinate lies out of view when converting */
41 #define V2D_IS_CLIPPED  12000
42
43 /* Common View2D view types 
44  * NOTE: only define a type here if it completely sets all (+/- a few) of the relevant flags 
45  *          and settings for a View2D region, and that set of settings is used in more
46  *          than one specific place
47  */
48 enum {
49                 /* custom view type (region has defined all necessary flags already) */
50         V2D_COMMONVIEW_CUSTOM = -1,
51                 /* standard (only use this when setting up a new view, as a sensible base for most settings) */
52         V2D_COMMONVIEW_STANDARD,
53                 /* listview (i.e. Outliner) */
54         V2D_COMMONVIEW_LIST,
55                 /* stackview (this is basically a list where new items are added at the top) */
56         V2D_COMMONVIEW_STACK,
57                 /* headers (this is basically the same as listview, but no y-panning) */
58         V2D_COMMONVIEW_HEADER,
59                 /* ui region containing panels */
60         V2D_COMMONVIEW_PANELS_UI,
61 } eView2D_CommonViewTypes;
62
63 /* ---- Defines for Scroller/Grid Arguments ----- */
64
65 /* 'dummy' argument to pass when argument is irrelevant */
66 #define V2D_ARG_DUMMY           -1
67
68 /* Grid units */
69 enum {
70         /* for drawing time */
71         V2D_UNIT_SECONDS = 0,
72         V2D_UNIT_FRAMES,
73         V2D_UNIT_FRAMESCALE,
74         
75         /* for drawing values */
76         V2D_UNIT_VALUES,
77         V2D_UNIT_DEGREES,
78         V2D_UNIT_TIME,
79         V2D_UNIT_SECONDSSEQ,
80 } eView2D_Units;
81
82 /* clamping of grid values to whole numbers */
83 enum {
84         V2D_GRID_NOCLAMP = 0,
85         V2D_GRID_CLAMP,
86 } eView2D_Clamp;
87
88 /* flags for grid-lines to draw */
89 enum {
90         V2D_HORIZONTAL_LINES            = (1<<0),
91         V2D_VERTICAL_LINES                      = (1<<1),
92         V2D_HORIZONTAL_AXIS                     = (1<<2),
93         V2D_VERTICAL_AXIS                       = (1<<3),
94         V2D_HORIZONTAL_FINELINES        = (1<<4),
95         
96         V2D_GRIDLINES_MAJOR                     = (V2D_VERTICAL_LINES|V2D_VERTICAL_AXIS|V2D_HORIZONTAL_LINES|V2D_HORIZONTAL_AXIS),
97         V2D_GRIDLINES_ALL                       = (V2D_GRIDLINES_MAJOR|V2D_HORIZONTAL_FINELINES),
98 } eView2D_Gridlines;
99
100 /* ------ Defines for Scrollers ----- */
101
102 /* scroller area */
103 #define V2D_SCROLL_HEIGHT       17
104 #define V2D_SCROLL_WIDTH        17
105
106 /* scroller 'handles' hotspot radius for mouse */
107 #define V2D_SCROLLER_HANDLE_SIZE        12
108
109 /* ------ Define for UI_view2d_sync ----- */
110
111 /* means copy it from another v2d */
112 #define V2D_LOCK_SET    0
113 /* means copy it to the other v2ds */
114 #define V2D_LOCK_COPY   1
115
116
117 /* ------------------------------------------ */
118 /* Macros:                                                              */
119
120 /* test if mouse in a scrollbar (assume that scroller availability has been tested) */
121 #define IN_2D_VERT_SCROLL(v2d, co) (BLI_in_rcti(&v2d->vert, co[0], co[1]))
122 #define IN_2D_HORIZ_SCROLL(v2d, co) (BLI_in_rcti(&v2d->hor, co[0], co[1]))
123
124 /* ------------------------------------------ */
125 /* Type definitions:                                            */
126
127 struct View2D;
128 struct View2DGrid;
129 struct View2DScrollers;
130
131 struct wmKeyConfig;
132 struct bScreen;
133 struct ScrArea;
134 struct ARegion;
135 struct bContext;
136 struct rctf;
137
138 typedef struct View2DGrid View2DGrid;
139 typedef struct View2DScrollers View2DScrollers;
140
141 /* ----------------------------------------- */
142 /* Prototypes:                                              */
143
144 /* refresh and validation (of view rects) */
145 void UI_view2d_region_reinit(struct View2D *v2d, short type, int winx, int winy);
146
147 void UI_view2d_curRect_validate(struct View2D *v2d);
148 void UI_view2d_curRect_validate_resize(struct View2D *v2d, int resize);
149 void UI_view2d_curRect_reset(struct View2D *v2d);
150 void UI_view2d_sync(struct bScreen *screen, struct ScrArea *sa, struct View2D *v2dcur, int flag);
151
152 void UI_view2d_totRect_set(struct View2D *v2d, int width, int height);
153 void UI_view2d_totRect_set_resize(struct View2D *v2d, int width, int height, int resize);
154
155 /* per tab offsets, returns 1 if tab changed */
156 int UI_view2d_tab_set(struct View2D *v2d, int tab);
157
158 /* view matrix operations */
159 void UI_view2d_view_ortho(const struct bContext *C, struct View2D *v2d);
160 void UI_view2d_view_orthoSpecial(const struct bContext *C, struct View2D *v2d, short xaxis);
161 void UI_view2d_view_restore(const struct bContext *C);
162
163 /* grid drawing */
164 View2DGrid *UI_view2d_grid_calc(const struct bContext *C, struct View2D *v2d, short xunits, short xclamp, short yunits, short yclamp, int winx, int winy);
165 void UI_view2d_grid_draw(const struct bContext *C, struct View2D *v2d, View2DGrid *grid, int flag);
166 void UI_view2d_constant_grid_draw(const struct bContext *C, struct View2D *v2d);
167 void UI_view2d_grid_free(View2DGrid *grid);
168
169 /* scrollbar drawing */
170 View2DScrollers *UI_view2d_scrollers_calc(const struct bContext *C, struct View2D *v2d, short xunits, short xclamp, short yunits, short yclamp);
171 void UI_view2d_scrollers_draw(const struct bContext *C, struct View2D *v2d, View2DScrollers *scrollers);
172 void UI_view2d_scrollers_free(View2DScrollers *scrollers);
173
174 /* list view tools */
175 void UI_view2d_listview_cell_to_view(struct View2D *v2d, short columnwidth, short rowheight, float startx, float starty, int column, int row, struct rctf *rect);
176 void UI_view2d_listview_view_to_cell(struct View2D *v2d, short columnwidth, short rowheight, float startx, float starty, float viewx, float viewy, int *column, int *row);
177 void UI_view2d_listview_visible_cells(struct View2D *v2d, short columnwidth, short rowheight, float startx, float starty, int *column_min, int *column_max, int *row_min, int *row_max);
178
179 /* coordinate conversion */
180 void UI_view2d_region_to_view(struct View2D *v2d, int x, int y, float *viewx, float *viewy);
181 void UI_view2d_view_to_region(struct View2D *v2d, float x, float y, int *regionx, int *regiony);
182 void UI_view2d_to_region_no_clip(struct View2D *v2d, float x, float y, int *regionx, int *region_y);
183
184 /* utilities */
185 struct View2D *UI_view2d_fromcontext(const struct bContext *C);
186 struct View2D *UI_view2d_fromcontext_rwin(const struct bContext *C);
187
188 void UI_view2d_getscale(struct View2D *v2d, float *x, float *y);
189
190 short UI_view2d_mouse_in_scrollers(const struct bContext *C, struct View2D *v2d, int x, int y);
191
192 /* cached text drawing in v2d, to allow pixel-aligned draw as post process */
193 void UI_view2d_text_cache_add(struct View2D *v2d, float x, float y, char *str);
194 void UI_view2d_text_cache_rectf(struct View2D *v2d, struct rctf *rect, char *str);
195 void UI_view2d_text_cache_draw(struct ARegion *ar);
196
197 /* operators */
198 void ui_view2d_operatortypes(void);
199 void UI_view2d_keymap(struct wmKeyConfig *keyconf);
200
201 #endif /* UI_VIEW2D_H */
202