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