8d8b137732acd14261fc977ce51fc86ed97be5f6
[blender-staging.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 enum {
45                 /* custom view type (region has defined all necessary flags already) */
46         V2D_COMMONVIEW_CUSTOM = 0,
47                 /* listview (i.e. Outliner) */
48         V2D_COMMONVIEW_LIST,
49                 /* headers (this is basically the same as listview, but no y-panning) */
50         V2D_COMMONVIEW_HEADER,
51 } eView2D_CommonViewTypes;
52
53 /* ---- Defines for Scroller/Grid Arguments ----- */
54
55 /* 'dummy' argument to pass when argument is irrelevant */
56 #define V2D_ARG_DUMMY           -1
57
58 /* Grid units */
59 enum {
60         /* for drawing time */
61         V2D_UNIT_SECONDS = 0,
62         V2D_UNIT_FRAMES,
63         
64         /* for drawing values */
65         V2D_UNIT_VALUES,
66         V2D_UNIT_DEGREES,
67         V2D_UNIT_TIME,
68         V2D_UNIT_SECONDSSEQ,
69 } eView2D_Units;
70
71 /* clamping of grid values to whole numbers */
72 enum {
73         V2D_GRID_NOCLAMP = 0,
74         V2D_GRID_CLAMP,
75 } eView2D_Clamp;
76
77 /* flags for grid-lines to draw */
78 enum {
79         V2D_HORIZONTAL_LINES            = (1<<0),
80         V2D_VERTICAL_LINES                      = (1<<1),
81         V2D_HORIZONTAL_AXIS                     = (1<<2),
82         V2D_VERTICAL_AXIS                       = (1<<3),
83         V2D_HORIZONTAL_FINELINES        = (1<<4),
84         
85         V2D_GRIDLINES_MAJOR                     = (V2D_VERTICAL_LINES|V2D_VERTICAL_AXIS|V2D_HORIZONTAL_LINES|V2D_HORIZONTAL_AXIS),
86         V2D_GRIDLINES_ALL                       = (V2D_GRIDLINES_MAJOR|V2D_HORIZONTAL_FINELINES),
87 } eView2D_Gridlines;
88
89 /* ------ Defines for Scrollers ----- */
90
91 /* scroller thickness */
92 #define V2D_SCROLL_HEIGHT       16
93 #define V2D_SCROLL_WIDTH        16
94
95 /* half the size (in pixels) of scroller 'handles' */
96 #define V2D_SCROLLER_HANDLE_SIZE        5
97
98 /* ------ Define for UI_view2d_sync ----- */
99
100 /* means copy it from the other v2d */
101 #define V2D_LOCK_COPY   1
102
103
104 /* ------------------------------------------ */
105 /* Macros:                                                              */
106
107 /* test if mouse in a scrollbar (assume that scroller availability has been tested) */
108 #define IN_2D_VERT_SCROLL(v2d, co) (BLI_in_rcti(&v2d->vert, co[0], co[1]))
109 #define IN_2D_HORIZ_SCROLL(v2d, co) (BLI_in_rcti(&v2d->hor, co[0], co[1]))
110
111 /* ------------------------------------------ */
112 /* Type definitions:                                            */
113
114 struct View2D;
115 struct View2DGrid;
116 struct View2DScrollers;
117
118 struct wmWindowManager;
119 struct bContext;
120
121 typedef struct View2DGrid View2DGrid;
122 typedef struct View2DScrollers View2DScrollers;
123
124 /* ----------------------------------------- */
125 /* Prototypes:                                              */
126
127 /* refresh and validation (of view rects) */
128 void UI_view2d_regiondata_init(struct View2D *v2d, short type, int winx, int winy);
129 void UI_view2d_header_default(struct View2D *v2d);
130
131 void UI_view2d_size_update(struct View2D *v2d, int winx, int winy);
132
133 void UI_view2d_curRect_validate(struct View2D *v2d);
134 void UI_view2d_curRect_reset(struct View2D *v2d);
135
136 void UI_view2d_totRect_set(struct View2D *v2d, int width, int height);
137
138 /* view matrix operations */
139 void UI_view2d_view_ortho(const struct bContext *C, struct View2D *v2d);
140 void UI_view2d_view_orthoSpecial(const struct bContext *C, struct View2D *v2d, short xaxis);
141 void UI_view2d_view_restore(const struct bContext *C);
142
143 /* grid drawing */
144 View2DGrid *UI_view2d_grid_calc(const struct bContext *C, struct View2D *v2d, short xunits, short xclamp, short yunits, short yclamp, int winx, int winy);
145 void UI_view2d_grid_draw(const struct bContext *C, struct View2D *v2d, View2DGrid *grid, int flag);
146 void UI_view2d_grid_free(View2DGrid *grid);
147
148 /* scrollbar drawing */
149 View2DScrollers *UI_view2d_scrollers_calc(const struct bContext *C, struct View2D *v2d, short xunits, short xclamp, short yunits, short yclamp);
150 void UI_view2d_scrollers_draw(const struct bContext *C, struct View2D *v2d, View2DScrollers *scrollers);
151 void UI_view2d_scrollers_free(View2DScrollers *scrollers);
152
153 /* coordinate conversion */
154 void UI_view2d_region_to_view(struct View2D *v2d, int x, int y, float *viewx, float *viewy);
155 void UI_view2d_view_to_region(struct View2D *v2d, float x, float y, short *regionx, short *regiony);
156 void UI_view2d_to_region_no_clip(struct View2D *v2d, float x, float y, short *regionx, short *region_y);
157
158 /* utilities */
159 struct View2D *UI_view2d_fromcontext(const struct bContext *C);
160 struct View2D *UI_view2d_fromcontext_rwin(const struct bContext *C);
161 void UI_view2d_getscale(struct View2D *v2d, float *x, float *y);
162 void UI_view2d_sync(struct View2D *v2d, struct View2D *v2dfrom, int flag);
163
164 /* operators */
165 void ui_view2d_operatortypes(void);
166 void UI_view2d_keymap(struct wmWindowManager *wm);
167
168 #endif /* UI_VIEW2D_H */
169