svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r23023:HEAD
[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       /* register operators in stack after finishing */
44 #define OPTYPE_UNDO                     2       /* do undo push after after */
45 #define OPTYPE_BLOCKING         4       /* let blender grab all input from the WM (X11) */
46 #define OPTYPE_MACRO            8
47
48 /* context to call operator in for WM_operator_name_call */
49 /* rna_ui.c contains EnumPropertyItem's of these, keep in sync */
50 enum {
51         /* if there's invoke, call it, otherwise exec */
52         WM_OP_INVOKE_DEFAULT,
53         WM_OP_INVOKE_REGION_WIN,
54         WM_OP_INVOKE_AREA,
55         WM_OP_INVOKE_SCREEN,
56         /* only call exec */
57         WM_OP_EXEC_DEFAULT,
58         WM_OP_EXEC_REGION_WIN,
59         WM_OP_EXEC_AREA,
60         WM_OP_EXEC_SCREEN
61 };
62
63 /* ************** wmKeyMap ************************ */
64
65 /* modifier */
66 #define KM_SHIFT        1
67 #define KM_CTRL         2
68 #define KM_ALT          4
69 #define KM_OSKEY        8
70         /* means modifier should be pressed 2nd */
71 #define KM_SHIFT2       16
72 #define KM_CTRL2        32
73 #define KM_ALT2         64
74 #define KM_OSKEY2       128
75
76 /* type: defined in wm_event_types.c */
77 #define KM_TEXTINPUT    -2
78
79 /* val */
80 #define KM_ANY          -1
81 #define KM_NOTHING      0
82 #define KM_PRESS        1
83 #define KM_RELEASE      2
84
85
86 /* ************** UI Handler ***************** */
87
88 #define WM_UI_HANDLER_CONTINUE  0
89 #define WM_UI_HANDLER_BREAK             1
90
91 typedef int (*wmUIHandlerFunc)(struct bContext *C, struct wmEvent *event, void *userdata);
92 typedef void (*wmUIHandlerRemoveFunc)(struct bContext *C, void *userdata);
93
94 /* ************** Notifiers ****************** */
95
96 typedef struct wmNotifier {
97         struct wmNotifier *next, *prev;
98         
99         struct wmWindowManager *wm;
100         struct wmWindow *window;
101         
102         int swinid;
103         unsigned int category, data, subtype, action;
104         
105         void *reference;
106         
107 } wmNotifier;
108
109
110 /* 4 levels 
111
112 0xFF000000; category
113 0x00FF0000; data
114 0x0000FF00; data subtype (unused?)
115 0x000000FF; action
116 */
117
118 /* category */
119 #define NOTE_CATEGORY           0xFF000000
120 #define NC_WM                           (1<<24)
121 #define NC_WINDOW                       (2<<24)
122 #define NC_SCREEN                       (3<<24)
123 #define NC_SCENE                        (4<<24)
124 #define NC_OBJECT                       (5<<24)
125 #define NC_MATERIAL                     (6<<24)
126 #define NC_TEXTURE                      (7<<24)
127 #define NC_LAMP                         (8<<24)
128 #define NC_GROUP                        (9<<24)
129 #define NC_IMAGE                        (10<<24)
130 #define NC_BRUSH                        (11<<24)
131 #define NC_TEXT                         (12<<24)
132 #define NC_WORLD                        (13<<24)
133 #define NC_ANIMATION            (14<<24)
134 #define NC_SPACE                        (15<<24)
135 #define NC_NODE                         (15<<24)
136 #define NC_GEOM                         (16<<24)
137
138 /* data type, 256 entries is enough, it can overlap */
139 #define NOTE_DATA                       0x00FF0000
140
141         /* NC_WM windowmanager */
142 #define ND_FILEREAD                     (1<<16)
143 #define ND_FILESAVE                     (2<<16)
144 #define ND_DATACHANGED          (3<<16)
145
146         /* NC_SCREEN screen */
147 #define ND_SCREENBROWSE         (1<<16)
148 #define ND_SCREENDELETE         (2<<16)
149 #define ND_SCREENCAST           (3<<16)
150 #define ND_ANIMPLAY                     (4<<16)
151 #define ND_GPENCIL                      (5<<16)
152
153         /* NC_SCENE Scene */
154 #define ND_SCENEBROWSE          (1<<16)
155 #define ND_MARKERS                      (2<<16)
156 #define ND_FRAME                        (3<<16)
157 #define ND_RENDER_OPTIONS       (4<<16)
158 #define ND_NODES                        (5<<16)
159 #define ND_SEQUENCER            (6<<16)
160 #define ND_OB_ACTIVE            (7<<16)
161 #define ND_OB_SELECT            (8<<16)
162 #define ND_MODE                         (9<<16)
163 #define ND_RENDER_RESULT        (10<<16)
164 #define ND_COMPO_RESULT         (11<<16)
165 #define ND_KEYINGSET            (12<<16)
166 #define ND_SCENEDELETE          (13<<16)
167
168         /* NC_OBJECT Object */
169 #define ND_TRANSFORM            (16<<16)
170 #define ND_OB_SHADING           (17<<16)
171 #define ND_POSE                         (18<<16)
172 #define ND_BONE_ACTIVE          (19<<16)
173 #define ND_BONE_SELECT          (20<<16)
174 #define ND_DRAW                         (21<<16)
175 #define ND_MODIFIER                     (22<<16) /* modifiers edited */
176 #define ND_KEYS                         (23<<16)
177 #define ND_CONSTRAINT           (24<<16) /* constraints edited */
178 #define ND_PARTICLE_DATA        (25<<16) /* particles edited */
179 #define ND_PARTICLE_SELECT      (26<<16) /* particles selecting change */
180
181         /* NC_MATERIAL Material */
182 #define ND_SHADING                      (30<<16)
183 #define ND_SHADING_DRAW         (31<<16)
184
185         /* NC_LAMP Lamp */
186 #define ND_LIGHTING                     (44<<16)
187 #define ND_LIGHTING_DRAW        (45<<16)
188 #define ND_SKY                          (46<<16)
189
190         /* NC_TEXT Text */
191 #define ND_CURSOR                       (50<<16)
192 #define ND_DISPLAY                      (51<<16)
193         
194         /* NC_ANIMATION Animato */
195 #define ND_KEYFRAME_SELECT      (70<<16)
196 #define ND_KEYFRAME_EDIT        (71<<16)
197 #define ND_KEYFRAME_PROP        (72<<16)
198 #define ND_ANIMCHAN_SELECT      (73<<16)
199 #define ND_ANIMCHAN_EDIT        (74<<16)
200 #define ND_NLA_SELECT           (75<<16)
201 #define ND_NLA_EDIT                     (76<<16)
202 #define ND_NLA_ACTCHANGE        (77<<16)
203
204         /* NC_GEOM Geometry */
205         /* Mesh, Curve, MetaBall, Armature, .. */
206 #define ND_SELECT                       (80<<16)
207 #define ND_DATA                         (81<<16)
208
209         /* NC_SPACE */
210 #define ND_SPACE_CONSOLE                (1<<16) /* general redraw */
211 #define ND_SPACE_CONSOLE_REPORT (2<<16) /* update for reports, could specify type */
212 #define ND_SPACE_INFO                   (2<<16)
213 #define ND_SPACE_IMAGE                  (3<<16)
214 #define ND_SPACE_FILE_PARAMS    (4<<16)
215 #define ND_SPACE_FILE_LIST              (5<<16)
216 #define ND_SPACE_NODE                   (6<<16)
217 #define ND_SPACE_OUTLINER               (7<<16)
218 #define ND_SPACE_VIEW3D                 (8<<16)
219 #define ND_SPACE_PROPERTIES             (9<<16)
220 #define ND_SPACE_TEXT                   (10<<16)
221 #define ND_SPACE_TIME                   (11<<16)
222 #define ND_SPACE_GRAPH                  (12<<16)
223 #define ND_SPACE_DOPESHEET              (13<<16)
224 #define ND_SPACE_NLA                    (14<<16)
225 #define ND_SPACE_SEQUENCER              (15<<16)
226
227 /* subtype, 256 entries too */
228 #define NOTE_SUBTYPE            0x0000FF00
229
230 /* subtype scene mode */
231 #define NS_MODE_OBJECT          (1<<8)
232
233 #define NS_EDITMODE_MESH        (2<<8)
234 #define NS_EDITMODE_CURVE       (3<<8)
235 #define NS_EDITMODE_SURFACE     (4<<8)
236 #define NS_EDITMODE_TEXT        (5<<8)
237 #define NS_EDITMODE_MBALL       (6<<8)
238 #define NS_EDITMODE_LATTICE     (7<<8)
239 #define NS_EDITMODE_ARMATURE    (8<<8)
240 #define NS_MODE_POSE            (9<<8)
241 #define NS_MODE_PARTICLE        (10<<8)
242
243
244 /* action classification */
245 #define NOTE_ACTION                     (0x000000FF)
246 #define NA_EDITED                       1
247 #define NA_EVALUATED            2
248 #define NA_ADDED                        3
249 #define NA_REMOVED                      4
250
251
252 /* ************** Gesture Manager data ************** */
253
254 /* wmGesture->type */
255 #define WM_GESTURE_TWEAK                0
256 #define WM_GESTURE_LINES                1
257 #define WM_GESTURE_RECT                 2
258 #define WM_GESTURE_CROSS_RECT   3
259 #define WM_GESTURE_LASSO                4
260 #define WM_GESTURE_CIRCLE               5
261
262 /* wmGesture is registered to window listbase, handled by operator callbacks */
263 /* tweak gesture is builtin feature */
264 typedef struct wmGesture {
265         struct wmGesture *next, *prev;
266         int event_type; /* event->type */
267         int mode;               /* for modal callback */
268         int type;               /* gesture type define */
269         int swinid;             /* initial subwindow id where it started */
270         int points;             /* optional, amount of points stored */
271         
272         void *customdata;
273         /* customdata for border is a recti */
274         /* customdata for circle is recti, (xmin, ymin) is center, xmax radius */
275         /* customdata for lasso is short array */
276 } wmGesture;
277
278 /* ************** custom wmEvent data ************** */
279
280 #define DEV_STYLUS      1
281 #define DEV_ERASER  2
282
283 typedef struct wmTabletData {
284         int Active;                     /* 0=None, 1=Stylus, 2=Eraser */
285         float Pressure;         /* range 0.0 (not touching) to 1.0 (full pressure) */
286         float Xtilt;            /* range 0.0 (upright) to 1.0 (tilted fully against the tablet surface) */
287         float Ytilt;            /* as above */
288 } wmTabletData;
289
290 typedef struct wmTimer {
291         struct wmTimer *next, *prev;
292         double timestep;                /* set by timer user */
293         int event_type;                 /* set by timer user, goes to event system */
294         void *customdata;               /* set by timer user, to allow custom values */
295         
296         double duration;                /* total running time in seconds */
297         double delta;                   /* time since previous step in seconds */
298         
299         double ltime;                   /* internal, last time timer was activated */
300         double ntime;                   /* internal, next time we want to activate the timer */
301         double stime;                   /* internal, when the timer started */
302         int sleep;                              /* internal, put timers to sleep when needed */
303 } wmTimer;
304
305
306 /* **************** Paint Cursor ******************* */
307
308 typedef void (*wmPaintCursorDraw)(struct bContext *C, int, int, void *customdata);
309
310
311 /* ****************** Messages ********************* */
312
313 enum {
314         WM_LOG_DEBUG                            = 0,
315         WM_LOG_INFO                                     = 1000,
316         WM_LOG_WARNING                          = 2000,
317         WM_ERROR_UNDEFINED                      = 3000,
318         WM_ERROR_INVALID_INPUT          = 3001,
319         WM_ERROR_INVALID_CONTEXT        = 3002,
320         WM_ERROR_OUT_OF_MEMORY          = 3003
321 };
322
323 typedef struct wmReport {
324         struct wmReport *next, *prev;
325         int type;
326         const char *typestr;
327         char *message;
328 } wmReport;
329
330 /* *************** migrated stuff, clean later? ******************************** */
331
332 typedef struct RecentFile {
333         struct RecentFile *next, *prev;
334         char *filename;
335 } RecentFile;
336
337
338 #endif /* WM_TYPES_H */
339