1f5465b9730d5a6d082fc132e7a5628248d8b591
[blender-staging.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 struct uiLayout;
35 struct wmOperator;
36
37 #include "RNA_types.h"
38 #include "DNA_listBase.h"
39
40 /* exported types for WM */
41 #include "wm_cursors.h"
42 #include "wm_event_types.h"
43
44 /* ************** wmOperatorType ************************ */
45
46 /* flag */
47 #define OPTYPE_REGISTER         1       /* register operators in stack after finishing */
48 #define OPTYPE_UNDO                     2       /* do undo push after after */
49 #define OPTYPE_BLOCKING         4       /* let blender grab all input from the WM (X11) */
50 #define OPTYPE_MACRO            8
51 #define OPTYPE_GRAB_POINTER     16      /* */
52
53 /* context to call operator in for WM_operator_name_call */
54 /* rna_ui.c contains EnumPropertyItem's of these, keep in sync */
55 enum {
56         /* if there's invoke, call it, otherwise exec */
57         WM_OP_INVOKE_DEFAULT,
58         WM_OP_INVOKE_REGION_WIN,
59         WM_OP_INVOKE_AREA,
60         WM_OP_INVOKE_SCREEN,
61         /* only call exec */
62         WM_OP_EXEC_DEFAULT,
63         WM_OP_EXEC_REGION_WIN,
64         WM_OP_EXEC_AREA,
65         WM_OP_EXEC_SCREEN
66 };
67
68 /* ************** wmKeyMap ************************ */
69
70 /* modifier */
71 #define KM_SHIFT        1
72 #define KM_CTRL         2
73 #define KM_ALT          4
74 #define KM_OSKEY        8
75         /* means modifier should be pressed 2nd */
76 #define KM_SHIFT2       16
77 #define KM_CTRL2        32
78 #define KM_ALT2         64
79 #define KM_OSKEY2       128
80
81 /* type: defined in wm_event_types.c */
82 #define KM_TEXTINPUT    -2
83
84 /* val */
85 #define KM_ANY          -1
86 #define KM_NOTHING      0
87 #define KM_PRESS        1
88 #define KM_RELEASE      2
89 #define KM_CLICK        3
90 #define KM_DBL_CLICK    4
91
92
93 /* ************** UI Handler ***************** */
94
95 #define WM_UI_HANDLER_CONTINUE  0
96 #define WM_UI_HANDLER_BREAK             1
97
98 typedef int (*wmUIHandlerFunc)(struct bContext *C, struct wmEvent *event, void *userdata);
99 typedef void (*wmUIHandlerRemoveFunc)(struct bContext *C, void *userdata);
100
101 /* ************** Notifiers ****************** */
102
103 typedef struct wmNotifier {
104         struct wmNotifier *next, *prev;
105         
106         struct wmWindowManager *wm;
107         struct wmWindow *window;
108         
109         int swinid;                     /* can't rely on this, notifiers can be added without context, swinid of 0 */
110         unsigned int category, data, subtype, action;
111         
112         void *reference;
113         
114 } wmNotifier;
115
116
117 /* 4 levels 
118
119 0xFF000000; category
120 0x00FF0000; data
121 0x0000FF00; data subtype (unused?)
122 0x000000FF; action
123 */
124
125 /* category */
126 #define NOTE_CATEGORY           0xFF000000
127 #define NC_WM                           (1<<24)
128 #define NC_WINDOW                       (2<<24)
129 #define NC_SCREEN                       (3<<24)
130 #define NC_SCENE                        (4<<24)
131 #define NC_OBJECT                       (5<<24)
132 #define NC_MATERIAL                     (6<<24)
133 #define NC_TEXTURE                      (7<<24)
134 #define NC_LAMP                         (8<<24)
135 #define NC_GROUP                        (9<<24)
136 #define NC_IMAGE                        (10<<24)
137 #define NC_BRUSH                        (11<<24)
138 #define NC_TEXT                         (12<<24)
139 #define NC_WORLD                        (13<<24)
140 #define NC_ANIMATION            (14<<24)
141 #define NC_SPACE                        (15<<24)
142 #define NC_GEOM                         (16<<24)
143 #define NC_NODE                         (17<<24)
144 #define NC_ID                           (18<<24)
145
146 /* data type, 256 entries is enough, it can overlap */
147 #define NOTE_DATA                       0x00FF0000
148
149         /* NC_WM windowmanager */
150 #define ND_FILEREAD                     (1<<16)
151 #define ND_FILESAVE                     (2<<16)
152 #define ND_DATACHANGED          (3<<16)
153
154         /* NC_SCREEN screen */
155 #define ND_SCREENBROWSE         (1<<16)
156 #define ND_SCREENDELETE         (2<<16)
157 #define ND_SCREENCAST           (3<<16)
158 #define ND_ANIMPLAY                     (4<<16)
159 #define ND_GPENCIL                      (5<<16)
160 #define ND_EDITOR_CHANGED       (6<<16) /*sent to new editors after switching to them*/
161
162         /* NC_SCENE Scene */
163 #define ND_SCENEBROWSE          (1<<16)
164 #define ND_MARKERS                      (2<<16)
165 #define ND_FRAME                        (3<<16)
166 #define ND_RENDER_OPTIONS       (4<<16)
167 #define ND_NODES                        (5<<16)
168 #define ND_SEQUENCER            (6<<16)
169 #define ND_OB_ACTIVE            (7<<16)
170 #define ND_OB_SELECT            (8<<16)
171 #define ND_MODE                         (9<<16)
172 #define ND_RENDER_RESULT        (10<<16)
173 #define ND_COMPO_RESULT         (11<<16)
174 #define ND_KEYINGSET            (12<<16)
175 #define ND_TOOLSETTINGS         (13<<16)
176 #define ND_LAYER                        (14<<16)
177 #define ND_SEQUENCER_SELECT     (15<<16)
178
179         /* NC_OBJECT Object */
180 #define ND_TRANSFORM            (16<<16)
181 #define ND_OB_SHADING           (17<<16)
182 #define ND_POSE                         (18<<16)
183 #define ND_BONE_ACTIVE          (19<<16)
184 #define ND_BONE_SELECT          (20<<16)
185 #define ND_DRAW                         (21<<16)
186 #define ND_MODIFIER                     (22<<16) /* modifiers edited */
187 #define ND_KEYS                         (23<<16)
188 #define ND_CONSTRAINT           (24<<16) /* constraints edited */
189 #define ND_PARTICLE_DATA        (25<<16) /* particles edited */
190 #define ND_PARTICLE_SELECT      (26<<16) /* particles selecting change */
191 #define ND_VIEW3D_TRANSFORM     (27<<16)
192
193         /* NC_MATERIAL Material */
194 #define ND_SHADING                      (30<<16)
195 #define ND_SHADING_DRAW         (31<<16)
196
197         /* NC_LAMP Lamp */
198 #define ND_LIGHTING                     (40<<16)
199 #define ND_LIGHTING_DRAW        (41<<16)
200 #define ND_SKY                          (42<<16)
201
202         /* NC_WORLD World */
203 #define ND_WORLD_DRAW           (45<<16)
204
205         /* NC_TEXT Text */
206 #define ND_CURSOR                       (50<<16)
207 #define ND_DISPLAY                      (51<<16)
208         
209         /* NC_ANIMATION Animato */
210 #define ND_KEYFRAME_SELECT      (70<<16)
211 #define ND_KEYFRAME_EDIT        (71<<16)
212 #define ND_KEYFRAME_PROP        (72<<16)
213 #define ND_ANIMCHAN_SELECT      (73<<16)
214 #define ND_ANIMCHAN_EDIT        (74<<16)
215 #define ND_NLA_SELECT           (75<<16)
216 #define ND_NLA_EDIT                     (76<<16)
217 #define ND_NLA_ACTCHANGE        (77<<16)
218 #define ND_FCURVES_ORDER        (78<<16)
219
220         /* NC_GEOM Geometry */
221         /* Mesh, Curve, MetaBall, Armature, .. */
222 #define ND_SELECT                       (90<<16)
223 #define ND_DATA                         (91<<16)
224
225         /* NC_NODE Nodes */
226 #define ND_NODE_SELECT                  (1<<16)
227
228         /* NC_SPACE */
229 #define ND_SPACE_CONSOLE                (1<<16) /* general redraw */
230 #define ND_SPACE_CONSOLE_REPORT (2<<16) /* update for reports, could specify type */
231 #define ND_SPACE_INFO                   (2<<16)
232 #define ND_SPACE_IMAGE                  (3<<16)
233 #define ND_SPACE_FILE_PARAMS    (4<<16)
234 #define ND_SPACE_FILE_LIST              (5<<16)
235 #define ND_SPACE_NODE                   (6<<16)
236 #define ND_SPACE_OUTLINER               (7<<16)
237 #define ND_SPACE_VIEW3D                 (8<<16)
238 #define ND_SPACE_PROPERTIES             (9<<16)
239 #define ND_SPACE_TEXT                   (10<<16)
240 #define ND_SPACE_TIME                   (11<<16)
241 #define ND_SPACE_GRAPH                  (12<<16)
242 #define ND_SPACE_DOPESHEET              (13<<16)
243 #define ND_SPACE_NLA                    (14<<16)
244 #define ND_SPACE_SEQUENCER              (15<<16)
245 #define ND_SPACE_NODE_VIEW              (16<<16)
246 #define ND_SPACE_CHANGED                (17<<16) /*sent to a new editor type after it's replaced an old one*/
247
248 /* subtype, 256 entries too */
249 #define NOTE_SUBTYPE            0x0000FF00
250
251 /* subtype scene mode */
252 #define NS_MODE_OBJECT                  (1<<8)
253
254 #define NS_EDITMODE_MESH                (2<<8)
255 #define NS_EDITMODE_CURVE               (3<<8)
256 #define NS_EDITMODE_SURFACE             (4<<8)
257 #define NS_EDITMODE_TEXT                (5<<8)
258 #define NS_EDITMODE_MBALL               (6<<8)
259 #define NS_EDITMODE_LATTICE             (7<<8)
260 #define NS_EDITMODE_ARMATURE    (8<<8)
261 #define NS_MODE_POSE                    (9<<8)
262 #define NS_MODE_PARTICLE                (10<<8)
263
264
265 /* action classification */
266 #define NOTE_ACTION                     (0x000000FF)
267 #define NA_EDITED                       1
268 #define NA_EVALUATED            2
269 #define NA_ADDED                        3
270 #define NA_REMOVED                      4
271 #define NA_RENAME                       5
272
273 /* ************** Gesture Manager data ************** */
274
275 /* wmGesture->type */
276 #define WM_GESTURE_TWEAK                0
277 #define WM_GESTURE_LINES                1
278 #define WM_GESTURE_RECT                 2
279 #define WM_GESTURE_CROSS_RECT   3
280 #define WM_GESTURE_LASSO                4
281 #define WM_GESTURE_CIRCLE               5
282
283 /* wmGesture is registered to window listbase, handled by operator callbacks */
284 /* tweak gesture is builtin feature */
285 typedef struct wmGesture {
286         struct wmGesture *next, *prev;
287         int event_type; /* event->type */
288         int mode;               /* for modal callback */
289         int type;               /* gesture type define */
290         int swinid;             /* initial subwindow id where it started */
291         int points;             /* optional, amount of points stored */
292         int size;               /* optional, maximum amount of points stored */
293         
294         void *customdata;
295         /* customdata for border is a recti */
296         /* customdata for circle is recti, (xmin, ymin) is center, xmax radius */
297         /* customdata for lasso is short array */
298 } wmGesture;
299
300 /* ************** wmEvent ************************ */
301
302 /* each event should have full modifier state */
303 /* event comes from eventmanager and from keymap */
304 typedef struct wmEvent {
305         struct wmEvent *next, *prev;
306         
307         short type;                     /* event code itself (short, is also in keymap) */
308         short val;                      /* press, release, scrollvalue */
309         short x, y;                     /* mouse pointer position, screen coord */
310         short mval[2];          /* region mouse position, name convention pre 2.5 :) */
311         short unicode;          /* future, ghost? */
312         char ascii;                     /* from ghost */
313         char pad;
314
315         /* previous state */
316         short prevtype;
317         short prevval;
318         short prevx, prevy;
319         double prevclicktime;
320         
321         /* modifier states */
322         short shift, ctrl, alt, oskey;  /* oskey is apple or windowskey, value denotes order of pressed */
323         short keymodifier;                              /* rawkey modifier */
324         
325         short pad1;
326         
327         /* keymap item, set by handler (weak?) */
328         const char *keymap_idname;
329         
330         /* custom data */
331         short custom;           /* custom data type, stylus, 6dof, see wm_event_types.h */
332         short customdatafree;
333         int pad2;
334         void *customdata;       /* ascii, unicode, mouse coords, angles, vectors, dragdrop info */
335         
336 } wmEvent;
337
338 /* ************** custom wmEvent data ************** */
339 typedef struct wmTabletData {
340         int Active;                     /* 0=EVT_TABLET_NONE, 1=EVT_TABLET_STYLUS, 2=EVT_TABLET_ERASER */
341         float Pressure;         /* range 0.0 (not touching) to 1.0 (full pressure) */
342         float Xtilt;            /* range 0.0 (upright) to 1.0 (tilted fully against the tablet surface) */
343         float Ytilt;            /* as above */
344 } wmTabletData;
345
346 typedef struct wmTimer {
347         struct wmTimer *next, *prev;
348         
349         struct wmWindow *win;   /* window this timer is attached to (optional) */
350
351         double timestep;                /* set by timer user */
352         int event_type;                 /* set by timer user, goes to event system */
353         void *customdata;               /* set by timer user, to allow custom values */
354         
355         double duration;                /* total running time in seconds */
356         double delta;                   /* time since previous step in seconds */
357         
358         double ltime;                   /* internal, last time timer was activated */
359         double ntime;                   /* internal, next time we want to activate the timer */
360         double stime;                   /* internal, when the timer started */
361         int sleep;                              /* internal, put timers to sleep when needed */
362 } wmTimer;
363
364
365 typedef struct wmOperatorType {
366         struct wmOperatorType *next, *prev;
367
368         char *name;             /* text for ui, undo */
369         char *idname;           /* unique identifier */
370         char *description;      /* tooltips and python docs */
371
372         /* this callback executes the operator without any interactive input,
373          * parameters may be provided through operator properties. cannot use
374          * any interface code or input device state.
375          * - see defines below for return values */
376         int (*exec)(struct bContext *, struct wmOperator *);
377
378         /* for modal temporary operators, initially invoke is called. then
379          * any further events are handled in modal. if the operation is
380          * cancelled due to some external reason, cancel is called
381          * - see defines below for return values */
382         int (*invoke)(struct bContext *, struct wmOperator *, struct wmEvent *);
383         int (*cancel)(struct bContext *, struct wmOperator *);
384         int (*modal)(struct bContext *, struct wmOperator *, struct wmEvent *);
385
386         /* verify if the operator can be executed in the current context, note
387          * that the operator might still fail to execute even if this return true */
388         int (*poll)(struct bContext *);
389
390         /* optional panel for redo and repeat, autogenerated if not set */
391         void (*ui)(struct bContext *, struct wmOperator *);
392
393         /* rna for properties */
394         struct StructRNA *srna;
395
396         /* rna property to use for generic invoke functions.
397          * menus, enum search... etc */
398         PropertyRNA *prop;
399
400         /* struct wmOperatorTypeMacro */
401         ListBase macro;
402
403         short flag;
404
405         /* pointer to modal keymap, do not free! */
406         struct wmKeyMap *modalkeymap;
407
408         /* only used for operators defined with python
409          * use to store pointers to python functions */
410         void *pyop_data;
411         int (*pyop_poll)(struct bContext *, struct wmOperatorType *ot);
412
413         /* RNA integration */
414         ExtensionRNA ext;
415 } wmOperatorType;
416
417 /* **************** Paint Cursor ******************* */
418
419 typedef void (*wmPaintCursorDraw)(struct bContext *C, int, int, void *customdata);
420
421
422 /* ****************** Messages ********************* */
423
424 enum {
425         WM_LOG_DEBUG                            = 0,
426         WM_LOG_INFO                                     = 1000,
427         WM_LOG_WARNING                          = 2000,
428         WM_ERROR_UNDEFINED                      = 3000,
429         WM_ERROR_INVALID_INPUT          = 3001,
430         WM_ERROR_INVALID_CONTEXT        = 3002,
431         WM_ERROR_OUT_OF_MEMORY          = 3003
432 };
433
434 typedef struct wmReport {
435         struct wmReport *next, *prev;
436         int type;
437         const char *typestr;
438         char *message;
439 } wmReport;
440
441 /* *************** migrated stuff, clean later? ******************************** */
442
443 typedef struct RecentFile {
444         struct RecentFile *next, *prev;
445         char *filename;
446 } RecentFile;
447
448
449 #endif /* WM_TYPES_H */
450