Comments
[blender.git] / source / blender / makesdna / DNA_view2d_types.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Joshua Leung
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_view2d_types.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_VIEW2D_TYPES_H__
33 #define __DNA_VIEW2D_TYPES_H__
34
35 #include "DNA_vec_types.h"
36
37 /* ---------------------------------- */
38
39 /* View 2D data - stored per region */
40 typedef struct View2D {
41         rctf tot, cur;                                  /* tot - area that data can be drawn in; cur - region of tot that is visible in viewport */
42         rcti vert, hor;                                 /* vert - vertical scrollbar region; hor - horizontal scrollbar region */
43         rcti mask;                                              /* mask - region (in screenspace) within which 'cur' can be viewed */
44         
45         float min[2], max[2];                   /* min/max sizes of 'cur' rect (only when keepzoom not set) */
46         float minzoom, maxzoom;                 /* self explanatory. allowable zoom factor range (only when keepzoom set) */
47         
48         short scroll;                                   /* scroll - scrollbars to display (bitflag) */
49         short scroll_ui;                                /* scroll_ui - temp settings used for UI drawing of scrollers */
50         
51         short keeptot;                                  /* keeptot - 'cur' rect cannot move outside the 'tot' rect? */
52         short keepzoom;                                 /* keepzoom - axes that zooming cannot occur on, and also clamp within zoom-limits */
53         short keepofs;                                  /* keepofs - axes that translation is not allowed to occur on */
54         
55         short flag;                                             /* settings */
56         short align;                                    /* alignment of content in totrect */
57         
58         short winx, winy;                               /* storage of current winx/winy values, set in UI_view2d_size_update */
59         short oldwinx, oldwiny;                 /* storage of previous winx/winy values encountered by UI_view2d_curRect_validate(), for keepaspect */
60         
61         short around;                                   /* pivot point for transforms (rotate and scale) */
62
63         float *tab_offset;                              /* different offset per tab, for buttons */
64         int tab_num;                                    /* number of tabs stored */
65         int tab_cur;                                    /* current tab */
66
67         /* animated smooth view */
68         struct SmoothView2DStore *sms;
69         struct wmTimer *smooth_timer;
70
71 } View2D;
72
73 /* ---------------------------------- */
74
75 /* view zooming restrictions, per axis (v2d->keepzoom) */
76         /* zoom is clamped to lie within limits set by minzoom and maxzoom */
77 #define V2D_LIMITZOOM           0x0001
78         /* aspect ratio is maintained on view resize */
79 #define V2D_KEEPASPECT          0x0002
80         /* zoom is kept when the window resizes */
81 #define V2D_KEEPZOOM            0x0004
82         /* zooming on x-axis is not allowed */
83 #define V2D_LOCKZOOM_X          0x0100
84         /* zooming on y-axis is not allowed */
85 #define V2D_LOCKZOOM_Y          0x0200
86
87 /* view panning restrictions, per axis (v2d->keepofs) */
88         /* panning on x-axis is not allowed */
89 #define V2D_LOCKOFS_X   (1<<1)
90         /* panning on y-axis is not allowed */
91 #define V2D_LOCKOFS_Y   (1<<2)
92         /* on resize, keep the x offset */
93 #define V2D_KEEPOFS_X   (1<<3)
94         /* on resize, keep the y offset */
95 #define V2D_KEEPOFS_Y   (1<<4)
96
97 /* view extent restrictions (v2d->keeptot) */
98         /* 'cur' view can be out of extents of 'tot' */
99 #define V2D_KEEPTOT_FREE                0
100         /* 'cur' rect is adjusted so that it satisfies the extents of 'tot', with some compromises */
101 #define V2D_KEEPTOT_BOUNDS              1
102         /* 'cur' rect is moved so that the 'minimum' bounds of the 'tot' rect are always respected (particularly in x-axis) */
103 #define V2D_KEEPTOT_STRICT              2
104
105 /* general refresh settings (v2d->flag) */
106         /* global view2d horizontal locking (for showing same time interval) */
107         /* TODO: this flag may be set in old files but is not accessible currently, should be exposed from RNA - Campbell */
108 #define V2D_VIEWSYNC_SCREEN_TIME        (1<<0)
109         /* within area (i.e. between regions) view2d vertical locking */
110 #define V2D_VIEWSYNC_AREA_VERTICAL      (1<<1)
111         /* apply pixel offsets on x-axis when setting view matrices */
112 #define V2D_PIXELOFS_X                          (1<<2)
113         /* apply pixel offsets on y-axis when setting view matrices */
114 #define V2D_PIXELOFS_Y                          (1<<3)
115         /* view settings need to be set still... */
116 #define V2D_IS_INITIALISED                      (1<<10)
117
118 /* scroller flags for View2D (v2d->scroll) */
119         /* left scrollbar */
120 #define V2D_SCROLL_LEFT                         (1<<0)          
121 #define V2D_SCROLL_RIGHT                        (1<<1)
122 #define V2D_SCROLL_VERTICAL             (V2D_SCROLL_LEFT|V2D_SCROLL_RIGHT)
123         /* horizontal scrollbar */
124 #define V2D_SCROLL_TOP                          (1<<2)
125 #define V2D_SCROLL_BOTTOM                       (1<<3)
126
127 /* UNUSED                                                       (1<<4) */
128 #define V2D_SCROLL_HORIZONTAL           (V2D_SCROLL_TOP|V2D_SCROLL_BOTTOM)
129         /* scale markings - vertical */
130 #define V2D_SCROLL_SCALE_VERTICAL       (1<<5)
131         /* scale markings - horizontal */
132 #define V2D_SCROLL_SCALE_HORIZONTAL     (1<<6)
133         /* induce hiding of scrollbars - set by region drawing in response to size of region */
134 #define V2D_SCROLL_VERTICAL_HIDE        (1<<7)          
135 #define V2D_SCROLL_HORIZONTAL_HIDE      (1<<8)
136         /* scrollbar extends beyond its available window - set when calculating scrollbars for drawing */
137 #define V2D_SCROLL_VERTICAL_FULLR       (1<<9)  
138 #define V2D_SCROLL_HORIZONTAL_FULLR (1<<10)     
139
140 /* scroll_ui, activate flag for drawing */
141 #define V2D_SCROLL_H_ACTIVE                     (1<<0)
142 #define V2D_SCROLL_V_ACTIVE                     (1<<1)
143
144 /* alignment flags for totrect, flags use 'shading-out' convention (v2d->align) */
145         /* all quadrants free */
146 #define V2D_ALIGN_FREE                  0
147         /* horizontal restrictions */
148 #define V2D_ALIGN_NO_POS_X              (1<<0)
149 #define V2D_ALIGN_NO_NEG_X              (1<<1)
150         /* vertical restrictions */
151 #define V2D_ALIGN_NO_POS_Y              (1<<2)
152 #define V2D_ALIGN_NO_NEG_Y              (1<<3)
153
154
155 #endif
156