2.5: gesture code in WM
[blender.git] / source / blender / windowmanager / WM_api.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_API_H
29 #define WM_API_H
30
31 /* dna-savable wmStructs here */
32 #include "DNA_windowmanager_types.h"
33
34 struct bContext;
35 struct wmEvent;
36 struct wmEventHandler;
37 struct wmGesture;
38 struct rcti;
39
40                         /* general API */
41 void            WM_setprefsize          (int stax, int stay, int sizx, int sizy);
42
43 void            WM_init                         (struct bContext *C);
44 void            WM_exit                         (struct bContext *C);
45 void            WM_main                         (struct bContext *C);
46
47 wmWindow        *WM_window_open         (struct bContext *C, struct rcti *rect);
48
49                         /* files */
50 int                     WM_read_homefile        (struct bContext *C, int from_memory);
51 int                     WM_write_homefile       (struct bContext *C, struct wmOperator *op);
52 void            WM_read_file            (struct bContext *C, char *name);
53 void            WM_write_file           (struct bContext *C, char *target);
54 void            WM_read_autosavefile(struct bContext *C);
55 void            WM_write_autosave       (struct bContext *C);
56
57                         /* mouse cursors */
58 void            WM_init_cursor_data     (void);
59 void            WM_set_cursor           (struct bContext *C, int curs);
60 void            WM_waitcursor           (struct bContext *C, int val);
61 void            WM_timecursor           (struct bContext *C, int nr);
62
63                         /* keymap and handlers */
64 void            WM_keymap_set_item      (ListBase *lb, char *idname, short type, 
65                                                                  short val, int modifier, short keymodifier);
66 void            WM_keymap_verify_item(ListBase *lb, char *idname, short type, 
67                                                                  short val, int modifier, short keymodifier);
68 void            WM_keymap_add_item      (ListBase *lb, char *idname, short type, 
69                                                                  short val, int modifier, short keymodifier);
70 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, ListBase *keymap);
71 void            WM_event_remove_keymap_handler(ListBase *handlers, ListBase *keymap);
72 struct wmEventHandler *WM_event_add_modal_handler(ListBase *handlers, wmOperator *op);
73 void            WM_event_remove_modal_handler(ListBase *handlers, wmOperator *op);
74 void            WM_event_remove_handlers(ListBase *handlers);
75
76 void            WM_event_add_message(wmWindowManager *wm, void *customdata,
77                                  short customdatafree);
78
79 void            WM_event_add_notifier(wmWindowManager *wm, wmWindow *window,
80                                         int swinid, int type,
81                                         int value, void *data);
82
83 void            wm_event_add            (wmWindow *win, struct wmEvent *event_to_add); /* XXX only for warning */
84
85                         /* one-shot timer, returns wmTimerData.handle */
86 struct wmTimerHandle *WM_event_add_window_timer(wmWindow *win, int delay_ms, int interval_ms);
87 void            WM_event_remove_window_timer(wmWindow *wm, struct wmTimerHandle *handle);
88
89                         /* operator api, default callbacks */
90                         /* confirm menu + exec */
91 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
92                         /* context checks */
93 int                     WM_operator_winactive   (struct bContext *C);
94
95                         /* operator api */
96 wmOperatorType *WM_operatortype_find(const char *idname);
97 void            WM_operatortype_append  (void (*opfunc)(wmOperatorType*));
98
99 int                     WM_operator_invoke              (struct bContext *C, wmOperatorType *ot, struct wmEvent *event);
100 void            WM_operator_cancel              (struct bContext *C, ListBase *modalops, wmOperatorType *ot);
101
102                         /* default operator callbacks for border/lasso */
103 int                     WM_border_select_invoke (struct bContext *C, wmOperator *op, struct wmEvent *event);
104 int                     WM_border_select_modal  (struct bContext *C, wmOperator *op, struct wmEvent *event);
105
106 /* 
107  * Operator property api
108  *
109  * Some notes to take care:
110  *
111  * All the OP_set_* functions append a new property to the operator,
112  * if the property already exist, just replace it with the new
113  * value in other case make a new property and append it.
114  *
115  * The OP_get_string function is a "special case", this function
116  * return a pointer to property data, so don't change/resize/free
117  * the string, because probably we get a segfault.
118  * I really think that is better duplicate the string, so we are
119  * really sure that the property data don't change.
120  *
121  * OP_get_int/float/array return 1 on success (found the property)
122  * or 0 if can't find the property in the operator.
123  * The property value are store in the "value" pointer.
124  *
125  * OP_verify_* sets the value only if it wasn't set already, and
126  * returns the existing or new value.
127  *
128  * Both array function copy the property data into the "array"
129  * pointer, but you need init the len pointer to the "array" size.
130  *
131  * For example:
132  *      int vec[] = { 1, 2, 3, 4 };
133  *      OP_set_int_array (op, "vector", vec, 4);
134  *
135  *      ...
136  *
137  *      short len;
138  *      int vec[4];
139  *      len= 4; <---- set the size!!
140  *      OP_get_int_array (op, "vector", vec, &len);
141  */
142 void OP_set_int(wmOperator *op, char *name, int value);
143 void OP_set_float(wmOperator *op, char *name, float value);
144 void OP_set_string(wmOperator *op, char *name, char *str);
145 void OP_set_int_array(wmOperator *op, char *name, int *array, short len);
146 void OP_set_float_array(wmOperator *op, char *name, float *array, short len);
147
148 int OP_get_int(wmOperator *op, char *name, int *value);
149 int OP_get_float(wmOperator *op, char *name, float *value);
150 char *OP_get_string(wmOperator *op, char *name);
151 int OP_get_int_array(wmOperator *op, char *name, int *array, short *len);
152 int OP_get_float_array(wmOperator *op, char *name, float *array, short *len);
153
154 void OP_verify_int(wmOperator *op, char *name, int value, int *result);
155 void OP_verify_float(wmOperator *op, char *name, float value, int *result);
156 char *OP_verify_string(wmOperator *op, char *name, char *str);
157 void OP_verify_int_array(wmOperator *op, char *name, int *array, short len, int *resultarray, short *resultlen);
158 void OP_verify_float_array(wmOperator *op, char *name, float *array, short len, float *resultarray, short *resultlen);
159
160 /*
161  * Need call this function in the "exit callback"
162  * of the operator, but only if you use the property system.
163  **/
164 void OP_free_property(wmOperator *op);
165
166                         /* Gesture manager API */
167 struct wmGesture *WM_gesture_new(struct bContext *C, struct wmEvent *event, int type);
168 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
169
170                         /* Reporting information and errors */
171 void            WM_report(struct bContext *C, int type, const char *message);
172 void            WM_reportf(struct bContext *C, int type, const char *format, ...);
173
174                         /* OpenGL wrappers, mimicing opengl syntax */
175 void            wmLoadMatrix            (wmWindow *win, float mat[][4]);
176 void            wmGetMatrix                     (wmWindow *win, float mat[][4]);
177 void            wmMultMatrix            (wmWindow *win, float mat[][4]);
178 void            wmGetSingleMatrix       (wmWindow *win, float mat[][4]);
179 void            wmScale                         (wmWindow *win, float x, float y, float z);
180 void            wmLoadIdentity          (wmWindow *win);        /* note: old name clear_view_mat */
181
182 void            wmFrustum                       (wmWindow *win, float x1, float x2, float y1, float y2, float n, float f);
183 void            wmOrtho                         (wmWindow *win, float x1, float x2, float y1, float y2, float n, float f);
184 void            wmOrtho2                        (wmWindow *win, float x1, float x2, float y1, float y2);
185
186
187 #endif /* WM_API_H */
188