fde865d4bba1afb24b55154a233886935657a675
[blender.git] / source / blender / editors / include / UI_view2d.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2008 Blender Foundation.
17  * All rights reserved.
18  * Generic 2d view with should allow drawing grids,
19  * panning, zooming, scrolling, ..
20  */
21
22 /** \file
23  * \ingroup editorui
24  */
25
26 #ifndef __UI_VIEW2D_H__
27 #define __UI_VIEW2D_H__
28
29 #include "BLI_compiler_attrs.h"
30
31 /* ------------------------------------------ */
32 /* Settings and Defines:                      */
33
34 /* ---- General Defines ---- */
35
36 /* generic value to use when coordinate lies out of view when converting */
37 #define V2D_IS_CLIPPED 12000
38
39 /* Common View2D view types
40  * NOTE: only define a type here if it completely sets all (+/- a few) of the relevant flags
41  *       and settings for a View2D region, and that set of settings is used in more
42  *       than one specific place
43  */
44 enum eView2D_CommonViewTypes {
45   /* custom view type (region has defined all necessary flags already) */
46   V2D_COMMONVIEW_CUSTOM = -1,
47   /* standard (only use this when setting up a new view, as a sensible base for most settings) */
48   V2D_COMMONVIEW_STANDARD,
49   /* listview (i.e. Outliner) */
50   V2D_COMMONVIEW_LIST,
51   /* stackview (this is basically a list where new items are added at the top) */
52   V2D_COMMONVIEW_STACK,
53   /* headers (this is basically the same as listview, but no y-panning) */
54   V2D_COMMONVIEW_HEADER,
55   /* ui region containing panels */
56   V2D_COMMONVIEW_PANELS_UI,
57 };
58
59 /* ---- Defines for Scroller/Grid Arguments ----- */
60
61 /* 'dummy' argument to pass when argument is irrelevant */
62 #define V2D_ARG_DUMMY -1
63
64 /* Grid units */
65 enum eView2D_Units {
66   /* for drawing time */
67   V2D_UNIT_SECONDS = 0,
68   V2D_UNIT_FRAMES,
69   V2D_UNIT_FRAMESCALE,
70
71   /* for drawing values */
72   V2D_UNIT_VALUES,
73 };
74
75 /* clamping of grid values to whole numbers */
76 enum eView2D_Clamp {
77   V2D_GRID_NOCLAMP = 0,
78   V2D_GRID_CLAMP,
79 };
80
81 /* flags for grid-lines to draw */
82 enum eView2D_Gridlines {
83   V2D_HORIZONTAL_LINES = (1 << 0),
84   V2D_VERTICAL_LINES = (1 << 1),
85   V2D_HORIZONTAL_AXIS = (1 << 2),
86   V2D_VERTICAL_AXIS = (1 << 3),
87   V2D_HORIZONTAL_FINELINES = (1 << 4),
88
89   V2D_GRIDLINES_MAJOR = (V2D_VERTICAL_LINES | V2D_VERTICAL_AXIS | V2D_HORIZONTAL_LINES |
90                          V2D_HORIZONTAL_AXIS),
91   V2D_GRIDLINES_ALL = (V2D_GRIDLINES_MAJOR | V2D_HORIZONTAL_FINELINES),
92 };
93
94 /* ------ Defines for Scrollers ----- */
95
96 /* scroller area */
97 #define V2D_SCROLL_HEIGHT (0.45f * U.widget_unit)
98 #define V2D_SCROLL_WIDTH (0.45f * U.widget_unit)
99 /* For scrollers with scale markings (text written onto them) */
100 #define V2D_SCROLL_HEIGHT_TEXT (0.79f * U.widget_unit)
101 #define V2D_SCROLL_WIDTH_TEXT (0.79f * U.widget_unit)
102
103 /* scroller 'handles' hotspot radius for mouse */
104 #define V2D_SCROLLER_HANDLE_SIZE (0.6f * U.widget_unit)
105
106 /* ------ Define for UI_view2d_sync ----- */
107
108 /* means copy it from another v2d */
109 #define V2D_LOCK_SET 0
110 /* means copy it to the other v2ds */
111 #define V2D_LOCK_COPY 1
112
113 /* ------------------------------------------ */
114 /* Macros:                                    */
115
116 /* test if mouse in a scrollbar (assume that scroller availability has been tested) */
117 #define IN_2D_VERT_SCROLL(v2d, co) (BLI_rcti_isect_pt_v(&v2d->vert, co))
118 #define IN_2D_HORIZ_SCROLL(v2d, co) (BLI_rcti_isect_pt_v(&v2d->hor, co))
119
120 /* ------------------------------------------ */
121 /* Type definitions:                          */
122
123 struct View2D;
124 struct View2DGrid;
125 struct View2DScrollers;
126
127 struct ARegion;
128 struct Scene;
129 struct ScrArea;
130 struct bContext;
131 struct bScreen;
132 struct rctf;
133 struct wmKeyConfig;
134
135 typedef struct View2DGrid View2DGrid;
136 typedef struct View2DScrollers View2DScrollers;
137
138 /* ----------------------------------------- */
139 /* Prototypes:                               */
140
141 /* refresh and validation (of view rects) */
142 void UI_view2d_region_reinit(struct View2D *v2d, short type, int winx, int winy);
143
144 void UI_view2d_curRect_validate(struct View2D *v2d);
145 void UI_view2d_curRect_reset(struct View2D *v2d);
146 void UI_view2d_sync(struct bScreen *screen, struct ScrArea *sa, struct View2D *v2dcur, int flag);
147
148 void UI_view2d_totRect_set(struct View2D *v2d, int width, int height);
149 void UI_view2d_totRect_set_resize(struct View2D *v2d, int width, int height, bool resize);
150
151 void UI_view2d_mask_from_win(const struct View2D *v2d, struct rcti *r_mask);
152
153 /* per tab offsets, returns 1 if tab changed */
154 bool UI_view2d_tab_set(struct View2D *v2d, int tab);
155
156 void UI_view2d_zoom_cache_reset(void);
157
158 /* view matrix operations */
159 void UI_view2d_view_ortho(struct View2D *v2d);
160 void UI_view2d_view_orthoSpecial(struct ARegion *ar, struct View2D *v2d, const bool xaxis);
161 void UI_view2d_view_restore(const struct bContext *C);
162
163 /* grid drawing */
164 View2DGrid *UI_view2d_grid_calc(struct Scene *scene,
165                                 struct View2D *v2d,
166                                 short xunits,
167                                 short xclamp,
168                                 short yunits,
169                                 short yclamp,
170                                 int winx,
171                                 int winy);
172 void UI_view2d_grid_draw(struct View2D *v2d, View2DGrid *grid, int flag);
173 void UI_view2d_constant_grid_draw(struct View2D *v2d, float step);
174 void UI_view2d_multi_grid_draw(
175     struct View2D *v2d, int colorid, float step, int level_size, int totlevels);
176 void UI_view2d_grid_size(View2DGrid *grid, float *r_dx, float *r_dy);
177 void UI_view2d_grid_draw_numbers_horizontal(const struct Scene *scene,
178                                             const struct View2D *v2d,
179                                             const View2DGrid *grid,
180                                             const struct rcti *rect,
181                                             int unit,
182                                             bool whole_numbers_only);
183 void UI_view2d_grid_draw_numbers_vertical(const struct Scene *scene,
184                                           const struct View2D *v2d,
185                                           const View2DGrid *grid,
186                                           const struct rcti *rect,
187                                           int unit,
188                                           float text_offset);
189 void UI_view2d_grid_free(View2DGrid *grid);
190
191 /* scrollbar drawing */
192 View2DScrollers *UI_view2d_scrollers_calc(const struct bContext *C,
193                                           struct View2D *v2d,
194                                           const struct rcti *mask_custom,
195                                           short xunits,
196                                           short xclamp,
197                                           short yunits,
198                                           short yclamp);
199 void UI_view2d_scrollers_draw(const struct bContext *C,
200                               struct View2D *v2d,
201                               View2DScrollers *scrollers);
202 void UI_view2d_scrollers_free(View2DScrollers *scrollers);
203
204 /* list view tools */
205 void UI_view2d_listview_cell_to_view(struct View2D *v2d,
206                                      float columnwidth,
207                                      float rowheight,
208                                      float startx,
209                                      float starty,
210                                      int column,
211                                      int row,
212                                      struct rctf *rect);
213 void UI_view2d_listview_view_to_cell(struct View2D *v2d,
214                                      float columnwidth,
215                                      float rowheight,
216                                      float startx,
217                                      float starty,
218                                      float viewx,
219                                      float viewy,
220                                      int *column,
221                                      int *row);
222 void UI_view2d_listview_visible_cells(struct View2D *v2d,
223                                       float columnwidth,
224                                       float rowheight,
225                                       float startx,
226                                       float starty,
227                                       int *column_min,
228                                       int *column_max,
229                                       int *row_min,
230                                       int *row_max);
231
232 /* coordinate conversion */
233 float UI_view2d_region_to_view_x(const struct View2D *v2d, float x);
234 float UI_view2d_region_to_view_y(const struct View2D *v2d, float y);
235 void UI_view2d_region_to_view(
236     const struct View2D *v2d, float x, float y, float *r_view_x, float *r_view_y) ATTR_NONNULL();
237 void UI_view2d_region_to_view_rctf(const struct View2D *v2d,
238                                    const struct rctf *rect_src,
239                                    struct rctf *rect_dst) ATTR_NONNULL();
240
241 float UI_view2d_view_to_region_x(const struct View2D *v2d, float x);
242 float UI_view2d_view_to_region_y(const struct View2D *v2d, float y);
243 bool UI_view2d_view_to_region_clip(
244     const struct View2D *v2d, float x, float y, int *r_region_x, int *r_region_y) ATTR_NONNULL();
245
246 void UI_view2d_view_to_region(
247     struct View2D *v2d, float x, float y, int *r_region_x, int *r_region_y) ATTR_NONNULL();
248 void UI_view2d_view_to_region_fl(
249     struct View2D *v2d, float x, float y, float *r_region_x, float *r_region_y) ATTR_NONNULL();
250 void UI_view2d_view_to_region_m4(struct View2D *v2d, float matrix[4][4]) ATTR_NONNULL();
251 void UI_view2d_view_to_region_rcti(struct View2D *v2d,
252                                    const struct rctf *rect_src,
253                                    struct rcti *rect_dst) ATTR_NONNULL();
254 bool UI_view2d_view_to_region_rcti_clip(struct View2D *v2d,
255                                         const struct rctf *rect_src,
256                                         struct rcti *rect_dst) ATTR_NONNULL();
257
258 /* utilities */
259 struct View2D *UI_view2d_fromcontext(const struct bContext *C);
260 struct View2D *UI_view2d_fromcontext_rwin(const struct bContext *C);
261
262 void UI_view2d_scale_get(struct View2D *v2d, float *r_x, float *r_y);
263 float UI_view2d_scale_get_x(const struct View2D *v2d);
264 float UI_view2d_scale_get_y(const struct View2D *v2d);
265 void UI_view2d_scale_get_inverse(struct View2D *v2d, float *r_x, float *r_y);
266
267 void UI_view2d_center_get(struct View2D *v2d, float *r_x, float *r_y);
268 void UI_view2d_center_set(struct View2D *v2d, float x, float y);
269
270 void UI_view2d_offset(struct View2D *v2d, float xfac, float yfac);
271
272 char UI_view2d_mouse_in_scrollers_ex(
273     const struct ARegion *ar, const struct View2D *v2d, int x, int y, int *r_scroll);
274 char UI_view2d_mouse_in_scrollers(const struct ARegion *ar,
275                                   const struct View2D *v2d,
276                                   int x,
277                                   int y);
278
279 /* cached text drawing in v2d, to allow pixel-aligned draw as post process */
280 void UI_view2d_text_cache_add(
281     struct View2D *v2d, float x, float y, const char *str, size_t str_len, const char col[4]);
282 void UI_view2d_text_cache_add_rectf(struct View2D *v2d,
283                                     const struct rctf *rect_view,
284                                     const char *str,
285                                     size_t str_len,
286                                     const char col[4]);
287 void UI_view2d_text_cache_draw(struct ARegion *ar);
288
289 /* operators */
290 void ED_operatortypes_view2d(void);
291 void ED_keymap_view2d(struct wmKeyConfig *keyconf);
292
293 void UI_view2d_smooth_view(struct bContext *C,
294                            struct ARegion *ar,
295                            const struct rctf *cur,
296                            const int smooth_viewtx);
297 #define UI_MARKER_MARGIN_Y (42 * UI_DPI_FAC)
298
299 #endif /* __UI_VIEW2D_H__ */