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