318945918e70ac128009d54aaaecd66b35885f71
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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
35 /* exported types for WM */
36
37 #include "wm_cursors.h"
38 #include "wm_event_types.h"
39
40 /* ************** wmOperatorType ************************ */
41
42 /* flag */
43 #define OPTYPE_REGISTER         1       /* register operators in stack after finishing */
44 #define OPTYPE_UNDO                     2       /* do undo push after after */
45 #define OPTYPE_BLOCKING         4       /* let blender grab all input from the WM (X11) */
46 #define OPTYPE_MACRO            8
47 #define OPTYPE_GRAB_POINTER     16      /* */
48
49 /* context to call operator in for WM_operator_name_call */
50 /* rna_ui.c contains EnumPropertyItem's of these, keep in sync */
51 enum {
52         /* if there's invoke, call it, otherwise exec */
53         WM_OP_INVOKE_DEFAULT,
54         WM_OP_INVOKE_REGION_WIN,
55         WM_OP_INVOKE_AREA,
56         WM_OP_INVOKE_SCREEN,
57         /* only call exec */
58         WM_OP_EXEC_DEFAULT,
59         WM_OP_EXEC_REGION_WIN,
60         WM_OP_EXEC_AREA,
61         WM_OP_EXEC_SCREEN
62 };
63
64 /* ************** wmKeyMap ************************ */
65
66 /* modifier */
67 #define KM_SHIFT        1
68 #define KM_CTRL         2
69 #define KM_ALT          4
70 #define KM_OSKEY        8
71         /* means modifier should be pressed 2nd */
72 #define KM_SHIFT2       16
73 #define KM_CTRL2        32
74 #define KM_ALT2         64
75 #define KM_OSKEY2       128
76
77 /* type: defined in wm_event_types.c */
78 #define KM_TEXTINPUT    -2
79
80 /* val */
81 #define KM_ANY          -1
82 #define KM_NOTHING      0
83 #define KM_PRESS        1
84 #define KM_RELEASE      2
85 #define KM_CLICK        3
86 #define KM_DBL_CLICK    4
87
88
89 /* ************** UI Handler ***************** */
90
91 #define WM_UI_HANDLER_CONTINUE  0
92 #define WM_UI_HANDLER_BREAK             1
93
94 typedef int (*wmUIHandlerFunc)(struct bContext *C, struct wmEvent *event, void *userdata);
95 typedef void (*wmUIHandlerRemoveFunc)(struct bContext *C, void *userdata);
96
97 /* ************** Notifiers ****************** */
98
99 typedef struct wmNotifier {
100         struct wmNotifier *next, *prev;
101         
102         struct wmWindowManager *wm;
103         struct wmWindow *window;
104         
105         int swinid;
106         unsigned int category, data, subtype, action;
107         
108         void *reference;
109         
110 } wmNotifier;
111
112
113 /* 4 levels 
114
115 0xFF000000; category
116 0x00FF0000; data
117 0x0000FF00; data subtype (unused?)
118 0x000000FF; action
119 */
120
121 /* category */
122 #define NOTE_CATEGORY           0xFF000000
123 #define NC_WM                           (1<<24)
124 #define NC_WINDOW                       (2<<24)
125 #define NC_SCREEN                       (3<<24)
126 #define NC_SCENE                        (4<<24)
127 #define NC_OBJECT                       (5<<24)
128 #define NC_MATERIAL                     (6<<24)
129 #define NC_TEXTURE                      (7<<24)
130 #define NC_LAMP                         (8<<24)
131 #define NC_GROUP                        (9<<24)
132 #define NC_IMAGE                        (10<<24)
133 #define NC_BRUSH                        (11<<24)
134 #define NC_TEXT                         (12<<24)
135 #define NC_WORLD                        (13<<24)
136 #define NC_ANIMATION            (14<<24)
137 #define NC_SPACE                        (15<<24)
138 #define NC_GEOM                         (16<<24)
139 #define NC_NODE                         (17<<24)
140 #define NC_ID                           (18<<24)
141
142 /* data type, 256 entries is enough, it can overlap */
143 #define NOTE_DATA                       0x00FF0000
144
145         /* NC_WM windowmanager */
146 #define ND_FILEREAD                     (1<<16)
147 #define ND_FILESAVE                     (2<<16)
148 #define ND_DATACHANGED          (3<<16)
149
150         /* NC_SCREEN screen */
151 #define ND_SCREENBROWSE         (1<<16)
152 #define ND_SCREENDELETE         (2<<16)
153 #define ND_SCREENCAST           (3<<16)
154 #define ND_ANIMPLAY                     (4<<16)
155 #define ND_GPENCIL                      (5<<16)
156
157         /* NC_SCENE Scene */
158 #define ND_SCENEBROWSE          (1<<16)
159 #define ND_MARKERS                      (2<<16)
160 #define ND_FRAME                        (3<<16)
161 #define ND_RENDER_OPTIONS       (4<<16)
162 #define ND_NODES                        (5<<16)
163 #define ND_SEQUENCER            (6<<16)
164 #define ND_OB_ACTIVE            (7<<16)
165 #define ND_OB_SELECT            (8<<16)
166 #define ND_MODE                         (9<<16)
167 #define ND_RENDER_RESULT        (10<<16)
168 #define ND_COMPO_RESULT         (11<<16)
169 #define ND_KEYINGSET            (12<<16)
170 #define ND_SCENEDELETE          (13<<16)
171 #define ND_LAYER                        (14<<16)
172 #define ND_SEQUENCER_SELECT     (15<<16)
173
174         /* NC_OBJECT Object */
175 #define ND_TRANSFORM            (16<<16)
176 #define ND_OB_SHADING           (17<<16)
177 #define ND_POSE                         (18<<16)
178 #define ND_BONE_ACTIVE          (19<<16)
179 #define ND_BONE_SELECT          (20<<16)
180 #define ND_DRAW                         (21<<16)
181 #define ND_MODIFIER                     (22<<16) /* modifiers edited */
182 #define ND_KEYS                         (23<<16)
183 #define ND_CONSTRAINT           (24<<16) /* constraints edited */
184 #define ND_PARTICLE_DATA        (25<<16) /* particles edited */
185 #define ND_PARTICLE_SELECT      (26<<16) /* particles selecting change */
186
187         /* NC_MATERIAL Material */
188 #define ND_SHADING                      (30<<16)
189 #define ND_SHADING_DRAW         (31<<16)
190
191         /* NC_LAMP Lamp */
192 #define ND_LIGHTING                     (40<<16)
193 #define ND_LIGHTING_DRAW        (41<<16)
194 #define ND_SKY                          (42<<16)
195
196         /* NC_WORLD World */
197 #define ND_WORLD_DRAW           (45<<16)
198
199         /* NC_TEXT Text */
200 #define ND_CURSOR                       (50<<16)
201 #define ND_DISPLAY                      (51<<16)
202         
203         /* NC_ANIMATION Animato */
204 #define ND_KEYFRAME_SELECT      (70<<16)
205 #define ND_KEYFRAME_EDIT        (71<<16)
206 #define ND_KEYFRAME_PROP        (72<<16)
207 #define ND_ANIMCHAN_SELECT      (73<<16)
208 #define ND_ANIMCHAN_EDIT        (74<<16)
209 #define ND_NLA_SELECT           (75<<16)
210 #define ND_NLA_EDIT                     (76<<16)
211 #define ND_NLA_ACTCHANGE        (77<<16)
212
213         /* NC_GEOM Geometry */
214         /* Mesh, Curve, MetaBall, Armature, .. */
215 #define ND_SELECT                       (80<<16)
216 #define ND_DATA                         (81<<16)
217
218         /* NC_NODE Nodes */
219 #define ND_NODE_SELECT                  (1<<16)
220
221         /* NC_SPACE */
222 #define ND_SPACE_CONSOLE                (1<<16) /* general redraw */
223 #define ND_SPACE_CONSOLE_REPORT (2<<16) /* update for reports, could specify type */
224 #define ND_SPACE_INFO                   (2<<16)
225 #define ND_SPACE_IMAGE                  (3<<16)
226 #define ND_SPACE_FILE_PARAMS    (4<<16)
227 #define ND_SPACE_FILE_LIST              (5<<16)
228 #define ND_SPACE_NODE                   (6<<16)
229 #define ND_SPACE_OUTLINER               (7<<16)
230 #define ND_SPACE_VIEW3D                 (8<<16)
231 #define ND_SPACE_PROPERTIES             (9<<16)
232 #define ND_SPACE_TEXT                   (10<<16)
233 #define ND_SPACE_TIME                   (11<<16)
234 #define ND_SPACE_GRAPH                  (12<<16)
235 #define ND_SPACE_DOPESHEET              (13<<16)
236 #define ND_SPACE_NLA                    (14<<16)
237 #define ND_SPACE_SEQUENCER              (15<<16)
238 #define ND_SPACE_NODE_VIEW              (16<<16)
239
240 /* subtype, 256 entries too */
241 #define NOTE_SUBTYPE            0x0000FF00
242
243 /* subtype scene mode */
244 #define NS_MODE_OBJECT                  (1<<8)
245
246 #define NS_EDITMODE_MESH                (2<<8)
247 #define NS_EDITMODE_CURVE               (3<<8)
248 #define NS_EDITMODE_SURFACE             (4<<8)
249 #define NS_EDITMODE_TEXT                (5<<8)
250 #define NS_EDITMODE_MBALL               (6<<8)
251 #define NS_EDITMODE_LATTICE             (7<<8)
252 #define NS_EDITMODE_ARMATURE    (8<<8)
253 #define NS_MODE_POSE                    (9<<8)
254 #define NS_MODE_PARTICLE                (10<<8)
255
256
257 /* action classification */
258 #define NOTE_ACTION                     (0x000000FF)
259 #define NA_EDITED                       1
260 #define NA_EVALUATED            2
261 #define NA_ADDED                        3
262 #define NA_REMOVED                      4
263 #define NA_RENAME                       5
264
265 /* ************** Gesture Manager data ************** */
266
267 /* wmGesture->type */
268 #define WM_GESTURE_TWEAK                0
269 #define WM_GESTURE_LINES                1
270 #define WM_GESTURE_RECT                 2
271 #define WM_GESTURE_CROSS_RECT   3
272 #define WM_GESTURE_LASSO                4
273 #define WM_GESTURE_CIRCLE               5
274
275 /* wmGesture is registered to window listbase, handled by operator callbacks */
276 /* tweak gesture is builtin feature */
277 typedef struct wmGesture {
278         struct wmGesture *next, *prev;
279         int event_type; /* event->type */
280         int mode;               /* for modal callback */
281         int type;               /* gesture type define */
282         int swinid;             /* initial subwindow id where it started */
283         int points;             /* optional, amount of points stored */
284         
285         void *customdata;
286         /* customdata for border is a recti */
287         /* customdata for circle is recti, (xmin, ymin) is center, xmax radius */
288         /* customdata for lasso is short array */
289 } wmGesture;
290
291 /* ************** wmEvent ************************ */
292
293 /* each event should have full modifier state */
294 /* event comes from eventmanager and from keymap */
295 typedef struct wmEvent {
296         struct wmEvent *next, *prev;
297         
298         short type;                     /* event code itself (short, is also in keymap) */
299         short val;                      /* press, release, scrollvalue */
300         short x, y;                     /* mouse pointer position, screen coord */
301         short mval[2];          /* region mouse position, name convention pre 2.5 :) */
302         short unicode;          /* future, ghost? */
303         char ascii;                     /* from ghost */
304         char pad;
305
306         /* previous state */
307         short prevtype;
308         short prevval;
309         short prevx, prevy;
310         double prevclicktime;
311         
312         /* modifier states */
313         short shift, ctrl, alt, oskey;  /* oskey is apple or windowskey, value denotes order of pressed */
314         short keymodifier;                              /* rawkey modifier */
315         
316         short pad1;
317         
318         /* keymap item, set by handler (weak?) */
319         const char *keymap_idname;
320         
321         /* custom data */
322         short custom;           /* custom data type, stylus, 6dof, see wm_event_types.h */
323         short customdatafree;
324         int pad2;
325         void *customdata;       /* ascii, unicode, mouse coords, angles, vectors, dragdrop info */
326         
327 } wmEvent;
328
329 /* ************** custom wmEvent data ************** */
330 typedef struct wmTabletData {
331         int Active;                     /* 0=EVT_TABLET_NONE, 1=EVT_TABLET_STYLUS, 2=EVT_TABLET_ERASER */
332         float Pressure;         /* range 0.0 (not touching) to 1.0 (full pressure) */
333         float Xtilt;            /* range 0.0 (upright) to 1.0 (tilted fully against the tablet surface) */
334         float Ytilt;            /* as above */
335 } wmTabletData;
336
337 typedef struct wmTimer {
338         struct wmTimer *next, *prev;
339         
340         struct wmWindow *win;   /* window this timer is attached to (optional) */
341
342         double timestep;                /* set by timer user */
343         int event_type;                 /* set by timer user, goes to event system */
344         void *customdata;               /* set by timer user, to allow custom values */
345         
346         double duration;                /* total running time in seconds */
347         double delta;                   /* time since previous step in seconds */
348         
349         double ltime;                   /* internal, last time timer was activated */
350         double ntime;                   /* internal, next time we want to activate the timer */
351         double stime;                   /* internal, when the timer started */
352         int sleep;                              /* internal, put timers to sleep when needed */
353 } wmTimer;
354
355
356 /* **************** Paint Cursor ******************* */
357
358 typedef void (*wmPaintCursorDraw)(struct bContext *C, int, int, void *customdata);
359
360
361 /* ****************** Messages ********************* */
362
363 enum {
364         WM_LOG_DEBUG                            = 0,
365         WM_LOG_INFO                                     = 1000,
366         WM_LOG_WARNING                          = 2000,
367         WM_ERROR_UNDEFINED                      = 3000,
368         WM_ERROR_INVALID_INPUT          = 3001,
369         WM_ERROR_INVALID_CONTEXT        = 3002,
370         WM_ERROR_OUT_OF_MEMORY          = 3003
371 };
372
373 typedef struct wmReport {
374         struct wmReport *next, *prev;
375         int type;
376         const char *typestr;
377         char *message;
378 } wmReport;
379
380 /* *************** migrated stuff, clean later? ******************************** */
381
382 typedef struct RecentFile {
383         struct RecentFile *next, *prev;
384         char *filename;
385 } RecentFile;
386
387
388 #endif /* WM_TYPES_H */
389