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