UI: ignore events in empty region overlap areas
[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 #define IN_2D_VERT_SCROLL_RECT(v2d, rct) (BLI_rcti_isect(&v2d->vert, rct, NULL))
121 #define IN_2D_HORIZ_SCROLL_RECT(v2d, rct) (BLI_rcti_isect(&v2d->hor, rct, NULL))
122
123 /* ------------------------------------------ */
124 /* Type definitions:                          */
125
126 struct View2D;
127 struct View2DGrid;
128 struct View2DScrollers;
129
130 struct ARegion;
131 struct Scene;
132 struct ScrArea;
133 struct bContext;
134 struct bScreen;
135 struct rctf;
136 struct wmKeyConfig;
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_reset(struct View2D *v2d);
149 void UI_view2d_sync(struct bScreen *screen, struct ScrArea *sa, struct View2D *v2dcur, int flag);
150
151 void UI_view2d_totRect_set(struct View2D *v2d, int width, int height);
152 void UI_view2d_totRect_set_resize(struct View2D *v2d, int width, int height, bool resize);
153
154 void UI_view2d_mask_from_win(const struct View2D *v2d, struct rcti *r_mask);
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, const bool xaxis);
164 void UI_view2d_view_restore(const struct bContext *C);
165
166 /* grid drawing */
167 View2DGrid *UI_view2d_grid_calc(struct Scene *scene,
168                                 struct View2D *v2d,
169                                 short xunits,
170                                 short xclamp,
171                                 short yunits,
172                                 short yclamp,
173                                 int winx,
174                                 int winy);
175 void UI_view2d_grid_draw(struct View2D *v2d, View2DGrid *grid, int flag);
176 void UI_view2d_constant_grid_draw(struct View2D *v2d, float step);
177 void UI_view2d_multi_grid_draw(
178     struct View2D *v2d, int colorid, float step, int level_size, int totlevels);
179 void UI_view2d_grid_size(View2DGrid *grid, float *r_dx, float *r_dy);
180 void UI_view2d_grid_draw_numbers_horizontal(const struct Scene *scene,
181                                             const struct View2D *v2d,
182                                             const View2DGrid *grid,
183                                             const struct rcti *rect,
184                                             int unit,
185                                             bool whole_numbers_only);
186 void UI_view2d_grid_draw_numbers_vertical(const struct Scene *scene,
187                                           const struct View2D *v2d,
188                                           const View2DGrid *grid,
189                                           const struct rcti *rect,
190                                           int unit,
191                                           float text_offset);
192 void UI_view2d_grid_free(View2DGrid *grid);
193
194 /* scrollbar drawing */
195 View2DScrollers *UI_view2d_scrollers_calc(const struct bContext *C,
196                                           struct View2D *v2d,
197                                           const struct rcti *mask_custom,
198                                           short xunits,
199                                           short xclamp,
200                                           short yunits,
201                                           short yclamp);
202 void UI_view2d_scrollers_draw(const struct bContext *C,
203                               struct View2D *v2d,
204                               View2DScrollers *scrollers);
205 void UI_view2d_scrollers_free(View2DScrollers *scrollers);
206
207 /* list view tools */
208 void UI_view2d_listview_cell_to_view(struct View2D *v2d,
209                                      float columnwidth,
210                                      float rowheight,
211                                      float startx,
212                                      float starty,
213                                      int column,
214                                      int row,
215                                      struct rctf *rect);
216 void UI_view2d_listview_view_to_cell(struct View2D *v2d,
217                                      float columnwidth,
218                                      float rowheight,
219                                      float startx,
220                                      float starty,
221                                      float viewx,
222                                      float viewy,
223                                      int *column,
224                                      int *row);
225 void UI_view2d_listview_visible_cells(struct View2D *v2d,
226                                       float columnwidth,
227                                       float rowheight,
228                                       float startx,
229                                       float starty,
230                                       int *column_min,
231                                       int *column_max,
232                                       int *row_min,
233                                       int *row_max);
234
235 /* coordinate conversion */
236 float UI_view2d_region_to_view_x(const struct View2D *v2d, float x);
237 float UI_view2d_region_to_view_y(const struct View2D *v2d, float y);
238 void UI_view2d_region_to_view(
239     const struct View2D *v2d, float x, float y, float *r_view_x, float *r_view_y) ATTR_NONNULL();
240 void UI_view2d_region_to_view_rctf(const struct View2D *v2d,
241                                    const struct rctf *rect_src,
242                                    struct rctf *rect_dst) ATTR_NONNULL();
243
244 float UI_view2d_view_to_region_x(const struct View2D *v2d, float x);
245 float UI_view2d_view_to_region_y(const struct View2D *v2d, float y);
246 bool UI_view2d_view_to_region_clip(
247     const struct View2D *v2d, float x, float y, int *r_region_x, int *r_region_y) ATTR_NONNULL();
248
249 void UI_view2d_view_to_region(
250     struct View2D *v2d, float x, float y, int *r_region_x, int *r_region_y) ATTR_NONNULL();
251 void UI_view2d_view_to_region_fl(
252     struct View2D *v2d, float x, float y, float *r_region_x, float *r_region_y) ATTR_NONNULL();
253 void UI_view2d_view_to_region_m4(struct View2D *v2d, float matrix[4][4]) ATTR_NONNULL();
254 void UI_view2d_view_to_region_rcti(struct View2D *v2d,
255                                    const struct rctf *rect_src,
256                                    struct rcti *rect_dst) ATTR_NONNULL();
257 bool UI_view2d_view_to_region_rcti_clip(struct View2D *v2d,
258                                         const struct rctf *rect_src,
259                                         struct rcti *rect_dst) ATTR_NONNULL();
260
261 /* utilities */
262 struct View2D *UI_view2d_fromcontext(const struct bContext *C);
263 struct View2D *UI_view2d_fromcontext_rwin(const struct bContext *C);
264
265 void UI_view2d_scale_get(struct View2D *v2d, float *r_x, float *r_y);
266 float UI_view2d_scale_get_x(const struct View2D *v2d);
267 float UI_view2d_scale_get_y(const struct View2D *v2d);
268 void UI_view2d_scale_get_inverse(struct View2D *v2d, float *r_x, float *r_y);
269
270 void UI_view2d_center_get(struct View2D *v2d, float *r_x, float *r_y);
271 void UI_view2d_center_set(struct View2D *v2d, float x, float y);
272
273 void UI_view2d_offset(struct View2D *v2d, float xfac, float yfac);
274
275 char UI_view2d_mouse_in_scrollers_ex(
276     const struct ARegion *ar, const struct View2D *v2d, int x, int y, int *r_scroll);
277 char UI_view2d_mouse_in_scrollers(const struct ARegion *ar,
278                                   const struct View2D *v2d,
279                                   int x,
280                                   int y);
281 char UI_view2d_rect_in_scrollers_ex(const struct ARegion *ar,
282                                     const struct View2D *v2d,
283                                     const struct rcti *rect,
284                                     int *r_scroll);
285 char UI_view2d_rect_in_scrollers(const struct ARegion *ar,
286                                  const struct View2D *v2d,
287                                  const struct rcti *rect);
288
289 /* cached text drawing in v2d, to allow pixel-aligned draw as post process */
290 void UI_view2d_text_cache_add(
291     struct View2D *v2d, float x, float y, const char *str, size_t str_len, const char col[4]);
292 void UI_view2d_text_cache_add_rectf(struct View2D *v2d,
293                                     const struct rctf *rect_view,
294                                     const char *str,
295                                     size_t str_len,
296                                     const char col[4]);
297 void UI_view2d_text_cache_draw(struct ARegion *ar);
298
299 /* operators */
300 void ED_operatortypes_view2d(void);
301 void ED_keymap_view2d(struct wmKeyConfig *keyconf);
302
303 void UI_view2d_smooth_view(struct bContext *C,
304                            struct ARegion *ar,
305                            const struct rctf *cur,
306                            const int smooth_viewtx);
307 #define UI_MARKER_MARGIN_Y (42 * UI_DPI_FAC)
308
309 #endif /* __UI_VIEW2D_H__ */