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