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