View2D - Initial commit of Pan-View Operator
[blender.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:                                                            */
37
38 /* generic value to use when coordinate lies out of view when converting */
39 #define V2D_IS_CLIPPED  12000
40
41 /* ---  Grids --- */
42 /* grid-units (for drawing time) */
43 #define V2D_UNIT_SECONDS        0
44 #define V2D_UNIT_FRAMES         1
45
46 /* clamping of grid values to whole numbers */
47 #define V2D_GRID_CLAMP          0
48 #define V2D_GRID_NOCLAMP        1
49
50 /* flags for grid-lines to draw */
51 #define V2D_HORIZONTAL_LINES    (1<<0)
52 #define V2D_VERTICAL_LINES              (1<<1)
53 #define V2D_HORIZONTAL_AXIS             (1<<2)
54 #define V2D_VERTICAL_AXIS               (1<<3)
55
56 /* --- Scrollers --- */
57
58 /* ------------------------------------------ */
59 /* Macros:                                                              */
60
61 /* test if mouse in a scrollbar */
62 #define IN_2D_VERT_SCROLL(v2d, co) (BLI_in_rcti(&v2d->vert, co[0], co[1]))
63 #define IN_2D_HORIZ_SCROLL(v2d, co) (BLI_in_rcti(&v2d->hor, co[0], co[1]))
64
65 /* ------------------------------------------ */
66 /* Type definitions:                                            */
67
68 struct View2D;
69 struct View2DGrid;
70 struct View2DScrollers;
71
72 struct wmWindowManager;
73 struct bContext;
74
75 typedef struct View2DGrid View2DGrid;
76 typedef struct View2DScrollers View2DScrollers;
77
78 /* ----------------------------------------- */
79 /* Prototypes:                                              */
80
81 /* setup */
82 void UI_view2d_ortho(const struct bContext *C, struct View2D *v2d);
83 void UI_view2d_update_size(struct View2D *v2d, int winx, int winy);
84 void UI_view2d_enforce_status(struct View2D *v2d, int winx, int winy);
85
86 /* grid drawing */
87 View2DGrid *UI_view2d_calc_grid(const struct bContext *C, struct View2D *v2d, short unit, short type, int winx, int winy);
88 void UI_view2d_draw_grid(const struct bContext *C, struct View2D *v2d, View2DGrid *grid, int flag);
89 void UI_view2d_free_grid(View2DGrid *grid);
90
91 /* scrollbar drawing */
92
93 void UI_view2d_draw_scrollers(const struct bContext *C, struct View2D *v2d, View2DScrollers *scrollers, int flag);
94 void UI_view2d_free_scrollbars(View2DScrollers *scrollers);
95
96 /* coordinate conversion */
97 void UI_view2d_region_to_view(struct View2D *v2d, short x, short y, float *viewx, float *viewy);
98 void UI_view2d_view_to_region(struct View2D *v2d, float x, float y, short *regionx, short *regiony);
99 void UI_view2d_to_region_no_clip(struct View2D *v2d, float x, float y, short *regionx, short *region_y);
100
101 /* utilities */
102 void UI_view2d_getscale(struct View2D *v2d, float *x, float *y);
103
104
105 /* operators */
106 void ui_view2d_operatortypes(void);
107 void UI_view2d_keymap(struct wmWindowManager *wm);
108
109 #endif /* UI_VIEW2D_H */
110