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