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