2.5 / SCons
[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
34 /* exported types for WM */
35
36 #include "wm_cursors.h"
37 #include "wm_event_types.h"
38
39 /* ************** wmOperatorType ************************ */
40
41 /* flag */
42 #define OPTYPE_REGISTER         1
43
44 /* context to call operator in for WM_operator_name_call */
45 enum {
46         WM_OP_INVOKE_DEFAULT,
47         WM_OP_INVOKE_REGION_WIN,
48         WM_OP_INVOKE_AREA,
49         WM_OP_INVOKE_SCREEN,
50         WM_OP_EXEC_DEFAULT,
51         WM_OP_EXEC_REGION_WIN,
52         WM_OP_EXEC_AREA,
53         WM_OP_EXEC_SCREEN
54 };
55
56 /* ************** wmEvent ************************ */
57
58 /* each event should have full modifier state */
59 /* event comes from eventmanager and from keymap */
60 typedef struct wmEvent {
61         struct wmEvent *next, *prev;
62         
63         short type;             /* event code itself (short, is also in keymap) */
64         short val;              /* press, release, scrollvalue */
65         short x, y;                             /* mouse pointer position */
66         short prevx, prevy;             /* previous mouse pointer position */
67         short unicode;  /* future, ghost? */
68         char ascii;             /* from ghost */
69         char pad1;              
70         
71         /* modifier states */
72         short shift, ctrl, alt, oskey;  /* oskey is apple or windowskey, value denotes order of pressed */
73         short keymodifier;                              /* rawkey modifier */
74         
75         /* keymap item, set by handler (weak?) */
76         const char *keymap_idname;
77         
78         /* custom data */
79         short custom;   /* custom data type, stylus, 6dof, see wm_event_types.h */
80         void *customdata;       /* ascii, unicode, mouse coords, angles, vectors, dragdrop info */
81         short customdatafree;
82         
83 } wmEvent;
84
85
86 /* ************** wmKeyMap ************************ */
87
88 /* modifier */
89 #define KM_SHIFT        1
90 #define KM_CTRL         2
91 #define KM_ALT          4
92 #define KM_OSKEY        8
93         /* means modifier should be pressed 2nd */
94 #define KM_SHIFT2       16
95 #define KM_CTRL2        32
96 #define KM_ALT2         64
97 #define KM_OSKEY2       128
98
99 /* val */
100 #define KM_ANY          -1
101 #define KM_RELEASE      0
102 #define KM_PRESS        1
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 *prev, *next;
116         
117         struct wmWindow *window;
118         
119         int swinid;
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_WINDOW                       (1<<24)
138 #define NC_SCREEN                       (2<<24)
139 #define NC_SCENE                        (3<<24)
140 #define NC_OBJECT                       (4<<24)
141 #define NC_MATERIAL                     (5<<24)
142 #define NC_TEXTURE                      (6<<24)
143
144 /* data type, 256 entries is enough, it can overlap */
145 #define NOTE_DATA                       0x00FF0000
146
147         /* Scene, node users level */
148 #define ND_MARKERS                      (2<<16)
149 #define ND_FRAME                        (3<<16)
150 #define ND_RENDER_OPTIONS       (4<<16)
151 #define ND_NODES                        (5<<16)
152 #define ND_SEQUENCER            (6<<16)
153         /* Object */
154 #define ND_TRANSFORM            (16<<16)
155 #define ND_SHADING                      (17<<16)
156
157 /* subtype, 256 entries too */
158 #define NOTE_SUBTYPE            0x0000FF00
159
160 /* action classification */
161 #define NOTE_ACTION                     (0x000000FF)
162 #define NA_EDITED                       1
163 #define NA_EVALUATED            2
164 #define NA_ADDED                        3
165 #define NA_REMOVED                      4
166
167
168 /* ************** Gesture Manager data ************** */
169
170 /* wmGesture->type */
171 #define WM_GESTURE_TWEAK                0
172 #define WM_GESTURE_LINE                 1
173 #define WM_GESTURE_RECT                 2
174 #define WM_GESTURE_CROSS_RECT   3
175 #define WM_GESTURE_LASSO                4
176 #define WM_GESTURE_CIRCLE               5
177
178 /* wmGesture is registered to window listbase, handled by operator callbacks */
179 typedef struct wmGesture {
180         struct wmGesture *next, *prev;
181         int event_type; /* event->type */
182         int mode;               /* for modal callback */
183         int type;               /* gesture type define */
184         int swinid;             /* initial subwindow id where it started */
185         
186         void *customdata;
187         /* customdata for border is a recti */
188         /* customdata for circle is recti, (xmin, ymin) is center, xmax radius */
189         
190 } wmGesture;
191
192
193 /* ************** custom wmEvent data ************** */
194
195 #define DEV_STYLUS      1
196 #define DEV_ERASER  2
197
198 typedef struct wmTabletData {
199         int Active;                     /* 0=None, 1=Stylus, 2=Eraser */
200         float Pressure;         /* range 0.0 (not touching) to 1.0 (full pressure) */
201         float Xtilt;            /* range 0.0 (upright) to 1.0 (tilted fully against the tablet surface) */
202         float Ytilt;            /* as above */
203 } wmTabletData;
204
205 typedef struct wmTimer {
206         struct wmTimer *next, *prev;
207         double timestep;                /* set by timer user */
208         int event_type;                 /* set by timer user */
209         
210         double duration;                /* total running time in seconds */
211         double delta;                   /* time since previous step in seconds */
212         
213         double ltime;                   /* internal, last time timer was activated */
214         int sleep;                              /* internal, put timers to sleep when needed */
215 } wmTimer;
216
217
218 /* ****************** Messages ********************* */
219
220 enum {
221         WM_LOG_DEBUG                            = 0,
222         WM_LOG_INFO                                     = 1000,
223         WM_LOG_WARNING                          = 2000,
224         WM_ERROR_UNDEFINED                      = 3000,
225         WM_ERROR_INVALID_INPUT          = 3001,
226         WM_ERROR_INVALID_CONTEXT        = 3002,
227         WM_ERROR_OUT_OF_MEMORY          = 3003
228 };
229
230 typedef struct wmReport {
231         struct wmReport *next, *prev;
232         int type;
233         const char *typestr;
234         char *message;
235 } wmReport;
236
237 /* *************** migrated stuff, clean later? ******************************** */
238
239 typedef struct RecentFile {
240         struct RecentFile *next, *prev;
241         char *filename;
242 } RecentFile;
243
244
245 #endif /* WM_TYPES_H */
246