merge with 2.5 at r18679
[blender.git] / source / blender / windowmanager / WM_types.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) 2007 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28 #ifndef WM_TYPES_H
29 #define WM_TYPES_H
30
31 struct bContext;
32 struct wmEvent;
33 struct wmWindowManager;
34
35 /* exported types for WM */
36
37 #include "wm_cursors.h"
38 #include "wm_event_types.h"
39
40 /* ************** wmOperatorType ************************ */
41
42 /* flag */
43 #define OPTYPE_REGISTER         1
44
45 /* context to call operator in for WM_operator_name_call */
46 enum {
47         WM_OP_INVOKE_DEFAULT,
48         WM_OP_INVOKE_REGION_WIN,
49         WM_OP_INVOKE_AREA,
50         WM_OP_INVOKE_SCREEN,
51         WM_OP_EXEC_DEFAULT,
52         WM_OP_EXEC_REGION_WIN,
53         WM_OP_EXEC_AREA,
54         WM_OP_EXEC_SCREEN
55 };
56
57 /* ************** wmEvent ************************ */
58
59 /* each event should have full modifier state */
60 /* event comes from eventmanager and from keymap */
61 typedef struct wmEvent {
62         struct wmEvent *next, *prev;
63         
64         short type;             /* event code itself (short, is also in keymap) */
65         short val;              /* press, release, scrollvalue */
66         short x, y;                             /* mouse pointer position */
67         short prevx, prevy;             /* previous mouse pointer position */
68         short unicode;  /* future, ghost? */
69         char ascii;             /* from ghost */
70         char pad1;              
71         
72         /* modifier states */
73         short shift, ctrl, alt, oskey;  /* oskey is apple or windowskey, value denotes order of pressed */
74         short keymodifier;                              /* rawkey modifier */
75         
76         /* keymap item, set by handler (weak?) */
77         const char *keymap_idname;
78         
79         /* custom data */
80         short custom;   /* custom data type, stylus, 6dof, see wm_event_types.h */
81         void *customdata;       /* ascii, unicode, mouse coords, angles, vectors, dragdrop info */
82         short customdatafree;
83         
84 } wmEvent;
85
86
87 /* ************** wmKeyMap ************************ */
88
89 /* modifier */
90 #define KM_SHIFT        1
91 #define KM_CTRL         2
92 #define KM_ALT          4
93 #define KM_OSKEY        8
94         /* means modifier should be pressed 2nd */
95 #define KM_SHIFT2       16
96 #define KM_CTRL2        32
97 #define KM_ALT2         64
98 #define KM_OSKEY2       128
99
100 /* type: defined in wm_event_types.c */
101 #define KM_TEXTINPUT    -2
102
103 /* val */
104 #define KM_ANY          -1
105 #define KM_RELEASE      0
106 #define KM_PRESS        1
107
108
109 /* ************** UI Handler ***************** */
110
111 #define WM_UI_HANDLER_CONTINUE  0
112 #define WM_UI_HANDLER_BREAK             1
113
114 typedef int (*wmUIHandlerFunc)(struct bContext *C, struct wmEvent *event, void *userdata);
115 typedef void (*wmUIHandlerRemoveFunc)(struct bContext *C, void *userdata);
116
117 /* ************** Notifiers ****************** */
118
119 typedef struct wmNotifier {
120         struct wmNotifier *prev, *next;
121         
122         struct wmWindowManager *wm;
123         struct wmWindow *window;
124         
125         int swinid;
126         unsigned int category, data, subtype, action;
127         
128         void *reference;
129         
130 } wmNotifier;
131
132
133 /* 4 levels 
134
135 0xFF000000; category
136 0x00FF0000; data
137 0x0000FF00; data subtype (unused?)
138 0x000000FF; action
139 */
140
141 /* category */
142 #define NOTE_CATEGORY           0xFF000000
143 #define NC_WINDOW                       (1<<24)
144 #define NC_SCREEN                       (2<<24)
145 #define NC_SCENE                        (3<<24)
146 #define NC_OBJECT                       (4<<24)
147 #define NC_MATERIAL                     (5<<24)
148 #define NC_TEXTURE                      (6<<24)
149 #define NC_LAMP                         (7<<24)
150 #define NC_GROUP                        (8<<24)
151
152 /* data type, 256 entries is enough, it can overlap */
153 #define NOTE_DATA                       0x00FF0000
154
155         /* Scene */
156 #define ND_MARKERS                      (2<<16)
157 #define ND_FRAME                        (3<<16)
158 #define ND_RENDER_OPTIONS       (4<<16)
159 #define ND_NODES                        (5<<16)
160 #define ND_SEQUENCER            (6<<16)
161 #define ND_OB_ACTIVE            (7<<16)
162 #define ND_OB_SELECT            (8<<16)
163 #define ND_MODE                         (9<<16)
164
165         /* Object */
166 #define ND_TRANSFORM            (16<<16)
167 #define ND_OB_SHADING           (17<<16)
168 #define ND_POSE                         (18<<16)
169 #define ND_BONE_ACTIVE          (19<<16)
170 #define ND_BONE_SELECT          (20<<16)
171 #define ND_GEOM_SELECT          (21<<16)
172 #define ND_DRAW                         (22<<16)
173 #define ND_MODIFIER                     (23<<16)
174
175         /* Material */
176 #define ND_SHADING                      (30<<16)
177 #define ND_SHADING_DRAW         (31<<16)
178
179         /* Lamp */
180 #define ND_LIGHTING                     (44<<16)
181 #define ND_LIGHTING_DRAW        (45<<16)
182 #define ND_SKY                          (46<<16)
183
184 /* subtype, 256 entries too */
185 #define NOTE_SUBTYPE            0x0000FF00
186
187 /* subtype scene mode */
188 #define NS_MODE_OBJECT          (1<<8)
189
190 #define NS_EDITMODE_MESH        (2<<8)
191 #define NS_EDITMODE_CURVE       (3<<8)
192 #define NS_EDITMODE_SURFACE     (4<<8)
193 #define NS_EDITMODE_TEXT        (5<<8)
194 #define NS_EDITMODE_MBALL       (6<<8)
195 #define NS_EDITMODE_LATTICE     (7<<8)
196 #define NS_EDITMODE_ARMATURE    (8<<8)
197
198
199 /* action classification */
200 #define NOTE_ACTION                     (0x000000FF)
201 #define NA_EDITED                       1
202 #define NA_EVALUATED            2
203 #define NA_ADDED                        3
204 #define NA_REMOVED                      4
205
206
207 /* ************** Gesture Manager data ************** */
208
209 /* wmGesture->type */
210 #define WM_GESTURE_TWEAK                0
211 #define WM_GESTURE_LINE                 1
212 #define WM_GESTURE_RECT                 2
213 #define WM_GESTURE_CROSS_RECT   3
214 #define WM_GESTURE_LASSO                4
215 #define WM_GESTURE_CIRCLE               5
216
217 /* wmGesture is registered to window listbase, handled by operator callbacks */
218 typedef struct wmGesture {
219         struct wmGesture *next, *prev;
220         int event_type; /* event->type */
221         int mode;               /* for modal callback */
222         int type;               /* gesture type define */
223         int swinid;             /* initial subwindow id where it started */
224         int points;             /* optional, amount of points stored */
225         
226         void *customdata;
227         /* customdata for border is a recti */
228         /* customdata for circle is recti, (xmin, ymin) is center, xmax radius */
229         /* customdata for lasso is short array */
230 } wmGesture;
231
232 /* ************** custom wmEvent data ************** */
233
234 #define DEV_STYLUS      1
235 #define DEV_ERASER  2
236
237 typedef struct wmTabletData {
238         int Active;                     /* 0=None, 1=Stylus, 2=Eraser */
239         float Pressure;         /* range 0.0 (not touching) to 1.0 (full pressure) */
240         float Xtilt;            /* range 0.0 (upright) to 1.0 (tilted fully against the tablet surface) */
241         float Ytilt;            /* as above */
242 } wmTabletData;
243
244 typedef struct wmTimer {
245         struct wmTimer *next, *prev;
246         double timestep;                /* set by timer user */
247         int event_type;                 /* set by timer user */
248         
249         double duration;                /* total running time in seconds */
250         double delta;                   /* time since previous step in seconds */
251         
252         double ltime;                   /* internal, last time timer was activated */
253         int sleep;                              /* internal, put timers to sleep when needed */
254 } wmTimer;
255
256
257 /* ****************** Messages ********************* */
258
259 enum {
260         WM_LOG_DEBUG                            = 0,
261         WM_LOG_INFO                                     = 1000,
262         WM_LOG_WARNING                          = 2000,
263         WM_ERROR_UNDEFINED                      = 3000,
264         WM_ERROR_INVALID_INPUT          = 3001,
265         WM_ERROR_INVALID_CONTEXT        = 3002,
266         WM_ERROR_OUT_OF_MEMORY          = 3003
267 };
268
269 typedef struct wmReport {
270         struct wmReport *next, *prev;
271         int type;
272         const char *typestr;
273         char *message;
274 } wmReport;
275
276 /* *************** migrated stuff, clean later? ******************************** */
277
278 typedef struct RecentFile {
279         struct RecentFile *next, *prev;
280         char *filename;
281 } RecentFile;
282
283
284 #endif /* WM_TYPES_H */
285