svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r22099:22130
[blender.git] / source / blender / makesdna / DNA_view2d_types.h
1 /**
2  * blenlib/DNA_view2d_types.h (mar-2001 nzc)
3  *      
4  * $Id$ 
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): Joshua Leung
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31 #ifndef DNA_VIEW2D_TYPES_H
32 #define DNA_VIEW2D_TYPES_H
33
34 #include "DNA_vec_types.h"
35
36 /* ---------------------------------- */
37
38 /* View 2D data - stored per region */
39 typedef struct View2D {
40         rctf tot, cur;                                  /* tot - area that data can be drawn in; cur - region of tot that is visible in viewport */
41         rcti vert, hor;                                 /* vert - vertical scrollbar region; hor - horizontal scrollbar region */
42         rcti mask;                                              /* mask - region (in screenspace) within which 'cur' can be viewed */
43         
44         float min[2], max[2];                   /* min/max sizes of 'cur' rect (only when keepzoom not set) */
45         float minzoom, maxzoom;                 /* self explanatory. allowable zoom factor range (only when keepzoom set) */
46         
47         short scroll;                                   /* scroll - scrollbars to display (bitflag) */
48         short scroll_ui;                                /* scroll_ui - temp settings used for UI drawing of scrollers */
49         
50         short keeptot;                                  /* keeptot - 'cur' rect cannot move outside the 'tot' rect? */
51         short keepzoom;                                 /* keepzoom - axes that zooming cannot occur on, and also clamp within zoom-limits */
52         short keepofs;                                  /* keepofs - axes that translation is not allowed to occur on */
53         
54         short flag;                                             /* settings */
55         short align;                                    /* alignment of content in totrect */
56         
57         short winx, winy;                               /* storage of current winx/winy values, set in UI_view2d_size_update */
58         short oldwinx, oldwiny;                 /* storage of previous winx/winy values encountered by UI_view2d_curRect_validate(), for keepaspect */
59         
60         short around;                                   /* pivot point for transforms (rotate and scale) */
61         float cursor[2];                                /* only used in the UV view for now (for 2D-cursor) */
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 } View2D;
67
68 /* ---------------------------------- */
69
70 /* view zooming restrictions, per axis (v2d->keepzoom) */
71         /* zoom is clamped to lie within limits set by minzoom and maxzoom */
72 #define V2D_LIMITZOOM           0x0001
73         /* aspect ratio is maintained on view resize */
74 #define V2D_KEEPASPECT          0x0002
75         /* zoom is kept when the window resizes */
76 #define V2D_KEEPZOOM            0x0004
77         /* zooming on x-axis is not allowed */
78 #define V2D_LOCKZOOM_X          0x0100
79         /* zooming on y-axis is not allowed */
80 #define V2D_LOCKZOOM_Y          0x0200
81
82 /* view panning restrictions, per axis (v2d->keepofs) */
83         /* panning on x-axis is not allowed */
84 #define V2D_LOCKOFS_X   (1<<1)
85         /* panning on y-axis is not allowed */
86 #define V2D_LOCKOFS_Y   (1<<2)
87         /* on resize, keep the x offset */
88 #define V2D_KEEPOFS_X   (1<<3)
89         /* on resize, keep the y offset */
90 #define V2D_KEEPOFS_Y   (1<<4)
91
92 /* view extent restrictions (v2d->keeptot) */
93         /* 'cur' view can be out of extents of 'tot' */
94 #define V2D_KEEPTOT_FREE                0
95         /* 'cur' rect is adjusted so that it satisfies the extents of 'tot', with some compromises */
96 #define V2D_KEEPTOT_BOUNDS              1
97         /* 'cur' rect is moved so that the 'minimum' bounds of the 'tot' rect are always respected (particularly in x-axis) */
98 #define V2D_KEEPTOT_STRICT              2
99
100 /* general refresh settings (v2d->flag) */
101         /* global view2d horizontal locking (for showing same time interval) */
102 #define V2D_VIEWSYNC_SCREEN_TIME        (1<<0)
103         /* within area (i.e. between regions) view2d vertical locking */
104 #define V2D_VIEWSYNC_AREA_VERTICAL      (1<<1)
105         /* apply pixel offsets on x-axis when setting view matrices */
106 #define V2D_PIXELOFS_X                          (1<<2)
107         /* apply pixel offsets on y-axis when setting view matrices */
108 #define V2D_PIXELOFS_Y                          (1<<3)
109         /* view settings need to be set still... */
110 #define V2D_IS_INITIALISED                      (1<<10)
111
112 /* scroller flags for View2D (v2d->scroll) */
113         /* left scrollbar */
114 #define V2D_SCROLL_LEFT                         (1<<0)          
115 #define V2D_SCROLL_RIGHT                        (1<<1)
116 #define V2D_SCROLL_VERTICAL             (V2D_SCROLL_LEFT|V2D_SCROLL_RIGHT)
117         /* horizontal scrollbar */
118 #define V2D_SCROLL_TOP                          (1<<2)
119 #define V2D_SCROLL_BOTTOM                       (1<<3)
120         /* special hack for outliner hscroll - prevent hanging older versions of Blender */
121 #define V2D_SCROLL_BOTTOM_O             (1<<4)
122 #define V2D_SCROLL_HORIZONTAL           (V2D_SCROLL_TOP|V2D_SCROLL_BOTTOM|V2D_SCROLL_BOTTOM_O)
123         /* scale markings - vertical */
124 #define V2D_SCROLL_SCALE_VERTICAL       (1<<5)
125         /* scale markings - horizontal */       
126 #define V2D_SCROLL_SCALE_HORIZONTAL     (1<<6)
127         /* disable draw temporary */
128 #define V2D_SCROLL_VERTICAL_HIDE        (1<<7)          
129 #define V2D_SCROLL_HORIZONTAL_HIDE      (1<<8)
130
131 /* scroll_ui, activate flag for drawing */
132 #define V2D_SCROLL_H_ACTIVE                     (1<<0)
133 #define V2D_SCROLL_V_ACTIVE                     (1<<1)
134
135 /* alignment flags for totrect, flags use 'shading-out' convention (v2d->align) */
136         /* all quadrants free */
137 #define V2D_ALIGN_FREE                  0
138         /* horizontal restrictions */
139 #define V2D_ALIGN_NO_POS_X              (1<<0)
140 #define V2D_ALIGN_NO_NEG_X              (1<<1)
141         /* vertical restrictions */
142 #define V2D_ALIGN_NO_POS_Y              (1<<2)
143 #define V2D_ALIGN_NO_NEG_Y              (1<<3)
144
145
146 #endif
147