Merge remote-tracking branch 'origin/master' into blender2.8
[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;                 /* allowable zoom factor range (only when (keepzoom & V2D_LIMITZOOM)) is 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         /* Usually set externally (as in, not in view2d files). */
68         char alpha_vert, alpha_hor;             /* alpha of vertical and horizontal scrollbars (range is [0, 255]) */
69         short pad[3];
70
71         /* animated smooth view */
72         struct SmoothView2DStore *sms;
73         struct wmTimer *smooth_timer;
74 } View2D;
75
76 /* ---------------------------------- */
77
78 /* view zooming restrictions, per axis (v2d->keepzoom) */
79 enum {
80         /* zoom is clamped to lie within limits set by minzoom and maxzoom */
81         V2D_LIMITZOOM     = (1 << 0),
82         /* aspect ratio is maintained on view resize */
83         V2D_KEEPASPECT    = (1 << 1),
84         /* zoom is kept when the window resizes */
85         V2D_KEEPZOOM      = (1 << 2),
86         /* zooming on x-axis is not allowed */
87         V2D_LOCKZOOM_X    = (1 << 8),
88         /* zooming on y-axis is not allowed */
89         V2D_LOCKZOOM_Y    = (1 << 9),
90 };
91
92 /* view panning restrictions, per axis (v2d->keepofs) */
93 enum {
94         /* panning on x-axis is not allowed */
95         V2D_LOCKOFS_X  = (1 << 1),
96         /* panning on y-axis is not allowed */
97         V2D_LOCKOFS_Y  = (1 << 2),
98         /* on resize, keep the x offset */
99         V2D_KEEPOFS_X  = (1 << 3),
100         /* on resize, keep the y offset */
101         V2D_KEEPOFS_Y  = (1 << 4),
102 };
103
104 /* view extent restrictions (v2d->keeptot) */
105 enum {
106         /* 'cur' view can be out of extents of 'tot' */
107         V2D_KEEPTOT_FREE      = 0,
108         /* 'cur' rect is adjusted so that it satisfies the extents of 'tot', with some compromises */
109         V2D_KEEPTOT_BOUNDS    = 1,
110         /* 'cur' rect is moved so that the 'minimum' bounds of the 'tot' rect are always respected (particularly in x-axis) */
111         V2D_KEEPTOT_STRICT    = 2,
112 };
113
114 /* general refresh settings (v2d->flag) */
115 enum {
116         /* global view2d horizontal locking (for showing same time interval) */
117         /* TODO: this flag may be set in old files but is not accessible currently, should be exposed from RNA - Campbell */
118         V2D_VIEWSYNC_SCREEN_TIME      = (1 << 0),
119         /* within area (i.e. between regions) view2d vertical locking */
120         V2D_VIEWSYNC_AREA_VERTICAL    = (1 << 1),
121         /* apply pixel offsets on x-axis when setting view matrices */
122         V2D_PIXELOFS_X                = (1 << 2),
123         /* apply pixel offsets on y-axis when setting view matrices */
124         V2D_PIXELOFS_Y                = (1 << 3),
125         /* view settings need to be set still... */
126         V2D_IS_INITIALISED            = (1 << 10),
127 };
128
129 /* scroller flags for View2D (v2d->scroll) */
130 enum {
131         /* left scrollbar */
132         V2D_SCROLL_LEFT              = (1 << 0),
133         V2D_SCROLL_RIGHT             = (1 << 1),
134         V2D_SCROLL_VERTICAL          = (V2D_SCROLL_LEFT | V2D_SCROLL_RIGHT),
135         /* horizontal scrollbar */
136         V2D_SCROLL_TOP               = (1 << 2),
137         V2D_SCROLL_BOTTOM            = (1 << 3),
138         /* UNUSED                    = (1 << 4), */
139         V2D_SCROLL_HORIZONTAL        = (V2D_SCROLL_TOP | V2D_SCROLL_BOTTOM),
140         /* scale markings - vertical */
141         V2D_SCROLL_SCALE_VERTICAL    = (1 << 5),
142         /* scale markings - horizontal */
143         V2D_SCROLL_SCALE_HORIZONTAL  = (1 << 6),
144         /* induce hiding of scrollbars - set by region drawing in response to size of region */
145         V2D_SCROLL_VERTICAL_HIDE     = (1 << 7),
146         V2D_SCROLL_HORIZONTAL_HIDE   = (1 << 8),
147         /* scrollbar extends beyond its available window - set when calculating scrollbars for drawing */
148         V2D_SCROLL_VERTICAL_FULLR    = (1 << 9),
149         V2D_SCROLL_HORIZONTAL_FULLR  = (1 << 10),
150 };
151
152 /* scroll_ui, activate flag for drawing */
153 enum {
154         V2D_SCROLL_H_ACTIVE       = (1 << 0),
155         V2D_SCROLL_V_ACTIVE       = (1 << 1),
156 };
157
158 /* alignment flags for totrect, flags use 'shading-out' convention (v2d->align) */
159 enum {
160         /* all quadrants free */
161         V2D_ALIGN_FREE        = 0,
162         /* horizontal restrictions */
163         V2D_ALIGN_NO_POS_X    = (1 << 0),
164         V2D_ALIGN_NO_NEG_X    = (1 << 1),
165         /* vertical restrictions */
166         V2D_ALIGN_NO_POS_Y    = (1 << 2),
167         V2D_ALIGN_NO_NEG_Y    = (1 << 3),
168 };
169
170 #endif