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