2.5
[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 /* exported types for WM */
32
33 #include "wm_cursors.h"
34 #include "wm_event_types.h"
35
36 /* ************** wmOperatorType ************************ */
37
38 /* flag */
39 #define OPTYPE_REGISTER         1
40
41 /* context to call operator in for WM_operator_call */
42 enum {
43         WM_OP_DEFAULT,
44         WM_OP_REGION_WIN,
45         WM_OP_AREA,
46         WM_OP_SCREEN
47 };
48
49 /* ************** wmEvent ************************ */
50
51 /* each event should have full modifier state */
52 /* event comes from eventmanager and from keymap */
53 typedef struct wmEvent {
54         struct wmEvent *next, *prev;
55         
56         short type;             /* event code itself (short, is also in keymap) */
57         short val;              /* press, release, scrollvalue */
58         short x, y;                             /* mouse pointer position */
59         short prevx, prevy;             /* previous mouse pointer position */
60         short unicode;  /* future, ghost? */
61         char ascii;             /* from ghost */
62         char pad1;              
63         
64         /* modifier states */
65         short shift, ctrl, alt, oskey;  /* oskey is apple or windowskey, value denotes order of pressed */
66         short keymodifier;                              /* rawkey modifier */
67         
68         /* keymap item, set by handler (weak?) */
69         const char *keymap_idname;
70         
71         /* custom data */
72         short custom;   /* custom data type, stylus, 6dof, see wm_event_types.h */
73         void *customdata;       /* ascii, unicode, mouse coords, angles, vectors, dragdrop info */
74         short customdatafree;
75         
76 } wmEvent;
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 /* val */
93 #define KM_ANY          -1
94 #define KM_RELEASE      0
95 #define KM_PRESS        1
96
97 /* ************** UI Handler ***************** */
98
99 #define WM_UI_HANDLER_CONTINUE  0
100 #define WM_UI_HANDLER_BREAK             1
101
102 typedef int (*wmUIHandlerFunc)(bContext *C, struct wmEvent *event, void *userdata);
103 typedef void (*wmUIHandlerRemoveFunc)(bContext *C, void *userdata);
104
105 /* ************** Notifiers ****************** */
106
107 typedef struct wmNotifier {
108         struct wmNotifier *prev, *next;
109         
110         struct wmWindow *window;
111         
112         int swinid;
113         int type;
114         int value;
115         void *data;
116         
117 } wmNotifier;
118
119
120 enum {
121         WM_NOTE_WINDOW_REDRAW,
122         WM_NOTE_SCREEN_CHANGED,
123         WM_NOTE_GESTURE_REDRAW,
124         WM_NOTE_MARKERS_CHANGED,
125         WM_NOTE_OBJECT_CHANGED,
126         WM_NOTE_LAST
127 };
128
129 /* ************** Gesture Manager data ************** */
130
131 /* wmGesture->type */
132 #define WM_GESTURE_TWEAK                0
133 #define WM_GESTURE_LINE                 1
134 #define WM_GESTURE_RECT                 2
135 #define WM_GESTURE_CROSS_RECT   3
136 #define WM_GESTURE_LASSO                4
137 #define WM_GESTURE_CIRCLE               5
138
139 /* wmGesture is registered to window listbase, handled by operator callbacks */
140 typedef struct wmGesture {
141         struct wmGesture *next, *prev;
142         int event_type; /* event->type */
143         int mode;               /* for modal callback */
144         int type;               /* gesture type define */
145         int swinid;             /* initial subwindow id where it started */
146         
147         void *customdata;
148         /* customdata for border is a recti */
149         /* customdata for circle is recti, (xmin, ymin) is center, xmax radius */
150         
151 } wmGesture;
152
153
154 /* ************** custom wmEvent data ************** */
155
156 #define DEV_STYLUS      1
157 #define DEV_ERASER  2
158
159 typedef struct wmTabletData {
160         int Active;                     /* 0=None, 1=Stylus, 2=Eraser */
161         float Pressure;         /* range 0.0 (not touching) to 1.0 (full pressure) */
162         float Xtilt;            /* range 0.0 (upright) to 1.0 (tilted fully against the tablet surface) */
163         float Ytilt;            /* as above */
164 } wmTabletData;
165
166 typedef struct wmTimer {
167         struct wmTimer *next, *prev;
168         double timestep;                /* set by timer user */
169         
170         double duration;                /* total running time in seconds */
171         double delta;                   /* time since previous step in seconds */
172         
173         double ltime;                   /* internal, last time timer was activated */
174         int sleep;                              /* internal, put timers to sleep when needed */
175 } wmTimer;
176
177
178 /* ****************** Messages ********************* */
179
180 enum {
181         WM_LOG_DEBUG                            = 0,
182         WM_LOG_INFO                                     = 1000,
183         WM_LOG_WARNING                          = 2000,
184         WM_ERROR_UNDEFINED                      = 3000,
185         WM_ERROR_INVALID_INPUT          = 3001,
186         WM_ERROR_INVALID_CONTEXT        = 3002,
187         WM_ERROR_OUT_OF_MEMORY          = 3003
188 };
189
190 typedef struct wmReport {
191         struct wmReport *next, *prev;
192         int type;
193         const char *typestr;
194         char *message;
195 } wmReport;
196
197 /* *************** migrated stuff, clean later? ******************************** */
198
199 typedef struct RecentFile {
200         struct RecentFile *next, *prev;
201         char *filename;
202 } RecentFile;
203
204
205 #endif /* WM_TYPES_H */
206