Merge branch 'blender2.7'
[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         /** Tot - area that data can be drawn in; cur - region of tot that is visible in viewport. */
42         rctf tot, cur;
43         /** Vert - vertical scrollbar region; hor - horizontal scrollbar region. */
44         rcti vert, hor;
45         /** Mask - region (in screenspace) within which 'cur' can be viewed. */
46         rcti mask;
47
48         /** Min/max sizes of 'cur' rect (only when keepzoom not set). */
49         float min[2], max[2];
50         /** Allowable zoom factor range (only when (keepzoom & V2D_LIMITZOOM)) is set. */
51         float minzoom, maxzoom;
52
53         /** Scroll - scrollbars to display (bitflag). */
54         short scroll;
55         /** Scroll_ui - temp settings used for UI drawing of scrollers. */
56         short scroll_ui;
57
58         /** Keeptot - 'cur' rect cannot move outside the 'tot' rect?. */
59         short keeptot;
60         /** Keepzoom - axes that zooming cannot occur on, and also clamp within zoom-limits. */
61         short keepzoom;
62         /** Keepofs - axes that translation is not allowed to occur on. */
63         short keepofs;
64
65         /** Settings. */
66         short flag;
67         /** Alignment of content in totrect. */
68         short align;
69
70         /** Storage of current winx/winy values, set in UI_view2d_size_update. */
71         short winx, winy;
72         /** Storage of previous winx/winy values encountered by UI_view2d_curRect_validate(), for keepaspect. */
73         short oldwinx, oldwiny;
74
75         /** Pivot point for transforms (rotate and scale). */
76         short around;
77
78         /** Different offset per tab, for buttons. */
79         float *tab_offset;
80         /** Number of tabs stored. */
81         int tab_num;
82         /** Current tab. */
83         int tab_cur;
84
85         /* Usually set externally (as in, not in view2d files). */
86         /** Alpha of vertical and horizontal scrollbars (range is [0, 255]). */
87         char alpha_vert, alpha_hor;
88         short pad[3];
89
90         /* animated smooth view */
91         struct SmoothView2DStore *sms;
92         struct wmTimer *smooth_timer;
93 } View2D;
94
95 /* ---------------------------------- */
96
97 /* view zooming restrictions, per axis (v2d->keepzoom) */
98 enum {
99         /* zoom is clamped to lie within limits set by minzoom and maxzoom */
100         V2D_LIMITZOOM     = (1 << 0),
101         /* aspect ratio is maintained on view resize */
102         V2D_KEEPASPECT    = (1 << 1),
103         /* zoom is kept when the window resizes */
104         V2D_KEEPZOOM      = (1 << 2),
105         /* zooming on x-axis is not allowed */
106         V2D_LOCKZOOM_X    = (1 << 8),
107         /* zooming on y-axis is not allowed */
108         V2D_LOCKZOOM_Y    = (1 << 9),
109 };
110
111 /* view panning restrictions, per axis (v2d->keepofs) */
112 enum {
113         /* panning on x-axis is not allowed */
114         V2D_LOCKOFS_X  = (1 << 1),
115         /* panning on y-axis is not allowed */
116         V2D_LOCKOFS_Y  = (1 << 2),
117         /* on resize, keep the x offset */
118         V2D_KEEPOFS_X  = (1 << 3),
119         /* on resize, keep the y offset */
120         V2D_KEEPOFS_Y  = (1 << 4),
121 };
122
123 /* view extent restrictions (v2d->keeptot) */
124 enum {
125         /* 'cur' view can be out of extents of 'tot' */
126         V2D_KEEPTOT_FREE      = 0,
127         /* 'cur' rect is adjusted so that it satisfies the extents of 'tot', with some compromises */
128         V2D_KEEPTOT_BOUNDS    = 1,
129         /* 'cur' rect is moved so that the 'minimum' bounds of the 'tot' rect are always respected (particularly in x-axis) */
130         V2D_KEEPTOT_STRICT    = 2,
131 };
132
133 /* general refresh settings (v2d->flag) */
134 enum {
135         /* global view2d horizontal locking (for showing same time interval) */
136         /* TODO: this flag may be set in old files but is not accessible currently, should be exposed from RNA - Campbell */
137         V2D_VIEWSYNC_SCREEN_TIME      = (1 << 0),
138         /* within area (i.e. between regions) view2d vertical locking */
139         V2D_VIEWSYNC_AREA_VERTICAL    = (1 << 1),
140         /* apply pixel offsets on x-axis when setting view matrices */
141         V2D_PIXELOFS_X                = (1 << 2),
142         /* apply pixel offsets on y-axis when setting view matrices */
143         V2D_PIXELOFS_Y                = (1 << 3),
144         /* view settings need to be set still... */
145         V2D_IS_INITIALISED            = (1 << 10),
146 };
147
148 /* scroller flags for View2D (v2d->scroll) */
149 enum {
150         /* left scrollbar */
151         V2D_SCROLL_LEFT              = (1 << 0),
152         V2D_SCROLL_RIGHT             = (1 << 1),
153         V2D_SCROLL_VERTICAL          = (V2D_SCROLL_LEFT | V2D_SCROLL_RIGHT),
154         /* horizontal scrollbar */
155         V2D_SCROLL_TOP               = (1 << 2),
156         V2D_SCROLL_BOTTOM            = (1 << 3),
157         /* UNUSED                    = (1 << 4), */
158         V2D_SCROLL_HORIZONTAL        = (V2D_SCROLL_TOP | V2D_SCROLL_BOTTOM),
159         /* scale markings - vertical */
160         V2D_SCROLL_SCALE_VERTICAL    = (1 << 5),
161         /* scale markings - horizontal */
162         V2D_SCROLL_SCALE_HORIZONTAL  = (1 << 6),
163         /* induce hiding of scrollbars - set by region drawing in response to size of region */
164         V2D_SCROLL_VERTICAL_HIDE     = (1 << 7),
165         V2D_SCROLL_HORIZONTAL_HIDE   = (1 << 8),
166         /* scrollbar extends beyond its available window - set when calculating scrollbars for drawing */
167         V2D_SCROLL_VERTICAL_FULLR    = (1 << 9),
168         V2D_SCROLL_HORIZONTAL_FULLR  = (1 << 10),
169 };
170
171 /* scroll_ui, activate flag for drawing */
172 enum {
173         V2D_SCROLL_H_ACTIVE       = (1 << 0),
174         V2D_SCROLL_V_ACTIVE       = (1 << 1),
175 };
176
177 /* alignment flags for totrect, flags use 'shading-out' convention (v2d->align) */
178 enum {
179         /* all quadrants free */
180         V2D_ALIGN_FREE        = 0,
181         /* horizontal restrictions */
182         V2D_ALIGN_NO_POS_X    = (1 << 0),
183         V2D_ALIGN_NO_NEG_X    = (1 << 1),
184         /* vertical restrictions */
185         V2D_ALIGN_NO_POS_Y    = (1 << 2),
186         V2D_ALIGN_NO_NEG_Y    = (1 << 3),
187 };
188
189 #endif