9b987cdfa510379679a2e70f471ef88fc91a69b3
[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., 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
44 #define OPTYPE_UNDO                     2
45
46 /* context to call operator in for WM_operator_name_call */
47 /* rna_ui.c contains EnumPropertyItem's of these, keep in sync */
48 enum {
49         /* if there's invoke, call it, otherwise exec */
50         WM_OP_INVOKE_DEFAULT,
51         WM_OP_INVOKE_REGION_WIN,
52         WM_OP_INVOKE_AREA,
53         WM_OP_INVOKE_SCREEN,
54         /* only call exec */
55         WM_OP_EXEC_DEFAULT,
56         WM_OP_EXEC_REGION_WIN,
57         WM_OP_EXEC_AREA,
58         WM_OP_EXEC_SCREEN
59 };
60
61 /* ************** wmKeyMap ************************ */
62
63 /* modifier */
64 #define KM_SHIFT        1
65 #define KM_CTRL         2
66 #define KM_ALT          4
67 #define KM_OSKEY        8
68         /* means modifier should be pressed 2nd */
69 #define KM_SHIFT2       16
70 #define KM_CTRL2        32
71 #define KM_ALT2         64
72 #define KM_OSKEY2       128
73
74 /* type: defined in wm_event_types.c */
75 #define KM_TEXTINPUT    -2
76
77 /* val */
78 #define KM_ANY          -1
79 #define KM_NOTHING      0
80 #define KM_PRESS        1
81 #define KM_RELEASE      2
82
83
84 /* ************** UI Handler ***************** */
85
86 #define WM_UI_HANDLER_CONTINUE  0
87 #define WM_UI_HANDLER_BREAK             1
88
89 typedef int (*wmUIHandlerFunc)(struct bContext *C, struct wmEvent *event, void *userdata);
90 typedef void (*wmUIHandlerRemoveFunc)(struct bContext *C, void *userdata);
91
92 /* ************** Notifiers ****************** */
93
94 typedef struct wmNotifier {
95         struct wmNotifier *next, *prev;
96         
97         struct wmWindowManager *wm;
98         struct wmWindow *window;
99         
100         int swinid;
101         unsigned int category, data, subtype, action;
102         
103         void *reference;
104         
105 } wmNotifier;
106
107
108 /* 4 levels 
109
110 0xFF000000; category
111 0x00FF0000; data
112 0x0000FF00; data subtype (unused?)
113 0x000000FF; action
114 */
115
116 /* category */
117 #define NOTE_CATEGORY           0xFF000000
118 #define NC_WM                           (1<<24)
119 #define NC_WINDOW                       (2<<24)
120 #define NC_SCREEN                       (3<<24)
121 #define NC_SCENE                        (4<<24)
122 #define NC_OBJECT                       (5<<24)
123 #define NC_MATERIAL                     (6<<24)
124 #define NC_TEXTURE                      (7<<24)
125 #define NC_LAMP                         (8<<24)
126 #define NC_GROUP                        (9<<24)
127 #define NC_IMAGE                        (10<<24)
128 #define NC_BRUSH                        (11<<24)
129 #define NC_TEXT                         (12<<24)
130 #define NC_WORLD                        (13<<24)
131
132 /* data type, 256 entries is enough, it can overlap */
133 #define NOTE_DATA                       0x00FF0000
134
135         /* NC_WM windowmanager */
136 #define ND_FILEREAD                     (1<<16)
137 #define ND_FILESAVE                     (2<<16)
138 #define ND_DATACHANGED          (3<<16)
139
140         /* NC_SCREEN screen */
141 #define ND_SCREENBROWSE         (1<<16)
142 #define ND_SCREENCAST           (2<<16)
143 #define ND_ANIMPLAY                     (3<<16)
144
145         /* NC_SCENE Scene */
146 #define ND_SCENEBROWSE          (1<<16)
147 #define ND_MARKERS                      (2<<16)
148 #define ND_FRAME                        (3<<16)
149 #define ND_RENDER_OPTIONS       (4<<16)
150 #define ND_NODES                        (5<<16)
151 #define ND_SEQUENCER            (6<<16)
152 #define ND_OB_ACTIVE            (7<<16)
153 #define ND_OB_SELECT            (8<<16)
154 #define ND_MODE                         (9<<16)
155 #define ND_RENDER_RESULT        (10<<16)
156 #define ND_COMPO_RESULT         (11<<16)
157 #define ND_KEYINGSET            (12<<16)
158
159         /* NC_OBJECT Object */
160 #define ND_TRANSFORM            (16<<16)
161 #define ND_OB_SHADING           (17<<16)
162 #define ND_POSE                         (18<<16)
163 #define ND_BONE_ACTIVE          (19<<16)
164 #define ND_BONE_SELECT          (20<<16)
165 #define ND_GEOM_SELECT          (21<<16)
166 #define ND_DRAW                         (22<<16)
167 #define ND_MODIFIER                     (23<<16)
168 #define ND_KEYS                         (24<<16)
169 #define ND_GEOM_DATA            (25<<16)
170 #define ND_CONSTRAINT           (26<<16)
171 #define ND_PARTICLE                     (27<<16)
172
173         /* NC_MATERIAL Material */
174 #define ND_SHADING                      (30<<16)
175 #define ND_SHADING_DRAW         (31<<16)
176
177         /* NC_LAMP Lamp */
178 #define ND_LIGHTING                     (44<<16)
179 #define ND_LIGHTING_DRAW        (45<<16)
180 #define ND_SKY                          (46<<16)
181
182         /* NC_TEXT Text */
183 #define ND_CURSOR                       (50<<16)
184 #define ND_DISPLAY                      (51<<16)
185
186 /* subtype, 256 entries too */
187 #define NOTE_SUBTYPE            0x0000FF00
188
189 /* subtype scene mode */
190 #define NS_MODE_OBJECT          (1<<8)
191
192 #define NS_EDITMODE_MESH        (2<<8)
193 #define NS_EDITMODE_CURVE       (3<<8)
194 #define NS_EDITMODE_SURFACE     (4<<8)
195 #define NS_EDITMODE_TEXT        (5<<8)
196 #define NS_EDITMODE_MBALL       (6<<8)
197 #define NS_EDITMODE_LATTICE     (7<<8)
198 #define NS_EDITMODE_ARMATURE    (8<<8)
199 #define NS_MODE_POSE            (9<<8)
200 #define NS_MODE_PARTICLE        (10<<8)
201
202
203 /* action classification */
204 #define NOTE_ACTION                     (0x000000FF)
205 #define NA_EDITED                       1
206 #define NA_EVALUATED            2
207 #define NA_ADDED                        3
208 #define NA_REMOVED                      4
209
210
211 /* ************** Gesture Manager data ************** */
212
213 /* wmGesture->type */
214 #define WM_GESTURE_TWEAK                0
215 #define WM_GESTURE_LINES                1
216 #define WM_GESTURE_RECT                 2
217 #define WM_GESTURE_CROSS_RECT   3
218 #define WM_GESTURE_LASSO                4
219 #define WM_GESTURE_CIRCLE               5
220
221 /* wmGesture is registered to window listbase, handled by operator callbacks */
222 /* tweak gesture is builtin feature */
223 typedef struct wmGesture {
224         struct wmGesture *next, *prev;
225         int event_type; /* event->type */
226         int mode;               /* for modal callback */
227         int type;               /* gesture type define */
228         int swinid;             /* initial subwindow id where it started */
229         int points;             /* optional, amount of points stored */
230         
231         void *customdata;
232         /* customdata for border is a recti */
233         /* customdata for circle is recti, (xmin, ymin) is center, xmax radius */
234         /* customdata for lasso is short array */
235 } wmGesture;
236
237 /* ************** custom wmEvent data ************** */
238
239 #define DEV_STYLUS      1
240 #define DEV_ERASER  2
241
242 typedef struct wmTabletData {
243         int Active;                     /* 0=None, 1=Stylus, 2=Eraser */
244         float Pressure;         /* range 0.0 (not touching) to 1.0 (full pressure) */
245         float Xtilt;            /* range 0.0 (upright) to 1.0 (tilted fully against the tablet surface) */
246         float Ytilt;            /* as above */
247 } wmTabletData;
248
249 typedef struct wmTimer {
250         struct wmTimer *next, *prev;
251         double timestep;                /* set by timer user */
252         int event_type;                 /* set by timer user, goes to event system */
253         void *customdata;               /* set by timer user, to allow custom values */
254         
255         double duration;                /* total running time in seconds */
256         double delta;                   /* time since previous step in seconds */
257         
258         double ltime;                   /* internal, last time timer was activated */
259         int sleep;                              /* internal, put timers to sleep when needed */
260 } wmTimer;
261
262
263 /* ****************** Messages ********************* */
264
265 enum {
266         WM_LOG_DEBUG                            = 0,
267         WM_LOG_INFO                                     = 1000,
268         WM_LOG_WARNING                          = 2000,
269         WM_ERROR_UNDEFINED                      = 3000,
270         WM_ERROR_INVALID_INPUT          = 3001,
271         WM_ERROR_INVALID_CONTEXT        = 3002,
272         WM_ERROR_OUT_OF_MEMORY          = 3003
273 };
274
275 typedef struct wmReport {
276         struct wmReport *next, *prev;
277         int type;
278         const char *typestr;
279         char *message;
280 } wmReport;
281
282 /* *************** migrated stuff, clean later? ******************************** */
283
284 typedef struct RecentFile {
285         struct RecentFile *next, *prev;
286         char *filename;
287 } RecentFile;
288
289
290 #endif /* WM_TYPES_H */
291