1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/**
* $Id:
*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* The Original Code is Copyright (C) 2007 Blender Foundation.
* All rights reserved.
*
*
* Contributor(s): Blender Foundation
*
* ***** END GPL LICENSE BLOCK *****
*/
#ifndef WM_API_H
#define WM_API_H
/* dna-savable wmStructs here */
#include "DNA_windowmanager_types.h"
struct bContext;
struct wmEvent;
struct wmEventHandler;
struct wmGesture;
/* general API */
void WM_setprefsize (int stax, int stay, int sizx, int sizy);
void WM_init (struct bContext *C);
void WM_exit (struct bContext *C);
void WM_main (struct bContext *C);
/* files */
int WM_read_homefile (struct bContext *C, int from_memory);
int WM_write_homefile (struct bContext *C, struct wmOperator *op);
void WM_read_file (struct bContext *C, char *name);
void WM_write_file (struct bContext *C, char *target);
void WM_read_autosavefile(struct bContext *C);
void WM_write_autosave (struct bContext *C);
/* mouse cursors */
void WM_init_cursor_data (void);
void WM_set_cursor (struct bContext *C, int curs);
void WM_waitcursor (struct bContext *C, int val);
void WM_timecursor (struct bContext *C, int nr);
/* keymap and handlers */
void WM_keymap_set_item (ListBase *lb, char *idname, short type,
short val, int modifier, short keymodifier);
void WM_keymap_verify_item(ListBase *lb, char *idname, short type,
short val, int modifier, short keymodifier);
void WM_keymap_add_item (ListBase *lb, char *idname, short type,
short val, int modifier, short keymodifier);
struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, ListBase *keymap);
void WM_event_remove_keymap_handler(ListBase *handlers, ListBase *keymap);
struct wmEventHandler *WM_event_add_modal_handler(ListBase *handlers, wmOperator *op);
void WM_event_remove_modal_handler(ListBase *handlers, wmOperator *op);
void WM_event_remove_handlers(ListBase *handlers);
void WM_event_add_message(wmWindowManager *wm, void *customdata,
short customdatafree);
void WM_event_add_notifier(wmWindowManager *wm, wmWindow *window,
int swinid, int type,
int value, void *data);
/* one-shot timer, returns wmTimerData.handle */
struct wmTimerHandle *WM_event_add_window_timer(wmWindow *win, int delay_ms, int interval_ms);
void WM_event_remove_window_timer(wmWindow *wm, struct wmTimerHandle *handle);
/* operator api, default callbacks */
/* confirm menu + exec */
int WM_operator_confirm (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
/* context checks */
int WM_operator_winactive (struct bContext *C);
/* operator api */
wmOperatorType *WM_operatortype_find(const char *idname);
void WM_operatortype_append(void (*opfunc)(wmOperatorType*));
int WM_operator_invoke(struct bContext *C, wmOperatorType *ot, struct wmEvent *event);
void WM_operator_cancel(struct bContext *C, ListBase *modalops, wmOperatorType *ot);
/*
* Operator property api
*
* Some notes to take care:
*
* All the OP_set_* functions append a new property to the operator,
* if the property already exist, just replace it with the new
* value in other case make a new property and append it.
*
* The OP_get_string function is a "special case", this function
* return a pointer to property data, so don't change/resize/free
* the string, because probably we get a segfault.
* I really think that is better duplicate the string, so we are
* really sure that the property data don't change.
*
* OP_get_int/float/array return 1 on success (found the property)
* or 0 if can't find the property in the operator.
* The property value are store in the "value" pointer.
*
* OP_verify_* sets the value only if it wasn't set already, and
* returns the existing or new value.
*
* Both array function copy the property data into the "array"
* pointer, but you need init the len pointer to the "array" size.
*
* For example:
* int vec[] = { 1, 2, 3, 4 };
* OP_set_int_array (op, "vector", vec, 4);
*
* ...
*
* short len;
* int vec[4];
* len= 4; <---- set the size!!
* OP_get_int_array (op, "vector", vec, &len);
*/
void OP_set_int(wmOperator *op, char *name, int value);
void OP_set_float(wmOperator *op, char *name, float value);
void OP_set_string(wmOperator *op, char *name, char *str);
void OP_set_int_array(wmOperator *op, char *name, int *array, short len);
void OP_set_float_array(wmOperator *op, char *name, float *array, short len);
int OP_get_int(wmOperator *op, char *name, int *value);
int OP_get_float(wmOperator *op, char *name, float *value);
char *OP_get_string(wmOperator *op, char *name);
int OP_get_int_array(wmOperator *op, char *name, int *array, short *len);
int OP_get_float_array(wmOperator *op, char *name, float *array, short *len);
void OP_verify_int(wmOperator *op, char *name, int value, int *result);
void OP_verify_float(wmOperator *op, char *name, float value, int *result);
char *OP_verify_string(wmOperator *op, char *name, char *str);
void OP_verify_int_array(wmOperator *op, char *name, int *array, short len, int *resultarray, short *resultlen);
void OP_verify_float_array(wmOperator *op, char *name, float *array, short len, float *resultarray, short *resultlen);
/*
* Need call this function in the "exit callback"
* of the operator, but only if you use the property system.
**/
void OP_free_property(wmOperator *op);
/* Gesture manager API */
void WM_gesture_init(struct bContext *C, int type);
void WM_gesture_update(struct bContext *C, struct wmGesture *from);
void WM_gesture_end(struct bContext *C, int type);
void WM_gesture_free(wmWindow *win);
/* Reporting information and errors */
void WM_report(struct bContext *C, int type, const char *message);
void WM_reportf(struct bContext *C, int type, const char *format, ...);
/* OpenGL wrappers, mimicing opengl syntax */
void wmLoadMatrix (wmWindow *win, float mat[][4]);
void wmGetMatrix (wmWindow *win, float mat[][4]);
void wmMultMatrix (wmWindow *win, float mat[][4]);
void wmGetSingleMatrix (wmWindow *win, float mat[][4]);
void wmScale (wmWindow *win, float x, float y, float z);
void wmLoadIdentity (wmWindow *win); /* note: old name clear_view_mat */
void wmFrustum (wmWindow *win, float x1, float x2, float y1, float y2, float n, float f);
void wmOrtho (wmWindow *win, float x1, float x2, float y1, float y2, float n, float f);
void wmOrtho2 (wmWindow *win, float x1, float x2, float y1, float y2);
#endif /* WM_API_H */
|
