Welcome to mirror list, hosted at ThFree Co, Russian Federation.

WM_api.h « windowmanager « blender « source - git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: a2b5049b8b59b2144e1a21f90524095ec8d752b1 (plain)
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
/**
 * $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;
struct rcti;

			/* 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);

wmWindow	*WM_window_open		(struct bContext *C, struct rcti *rect);

			/* 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_cursor_set		(struct wmWindow *win, int curs);
void		WM_cursor_modal		(struct wmWindow *win, int curs);
void		WM_cursor_restore	(struct wmWindow *win);
void		WM_cursor_wait		(struct wmWindow *win, int val);
void		WM_timecursor		(struct wmWindow *win, int nr);

			/* keymap */
wmKeymapItem *WM_keymap_set_item	(ListBase *lb, char *idname, short type, 
								 short val, int modifier, short keymodifier);
wmKeymapItem *WM_keymap_verify_item(ListBase *lb, char *idname, short type, 
								 short val, int modifier, short keymodifier);
wmKeymapItem *WM_keymap_add_item	(ListBase *lb, char *idname, short type, 
								 short val, int modifier, short keymodifier);
ListBase	*WM_keymap_listbase	(wmWindowManager *wm, const char *nameid, 
								 int spaceid, int regionid);

char		*WM_key_event_string(short type);
char		*WM_key_event_operator_string(bContext *C, char *opname, int opcontext, char *str, int len);

			/* handlers */

struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, ListBase *keymap);
						/* boundbox, optional subwindow boundbox for offset */
struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, ListBase *keymap, rcti *bb, rcti *swinbb);

void		WM_event_remove_keymap_handler(ListBase *handlers, ListBase *keymap);

struct wmEventHandler *WM_event_add_ui_handler(bContext *C, ListBase *handlers,
			int (*func)(bContext *C, struct wmEvent *event, void *userdata),
			void (*remove)(bContext *C, void *userdata), void *userdata);
void		WM_event_remove_ui_handler(ListBase *handlers,
			int (*func)(bContext *C, struct wmEvent *event, void *userdata),
			void (*remove)(bContext *C, void *userdata), void *userdata);

struct wmEventHandler *WM_event_add_modal_handler(bContext *C, ListBase *handlers, wmOperator *op);
void		WM_event_remove_handlers(bContext *C, ListBase *handlers);

void		WM_event_add_mousemove(bContext *C);

void		WM_event_add_notifier(bContext *C, int type, int value, void *data);

void		wm_event_add		(wmWindow *win, struct wmEvent *event_to_add); /* XXX only for warning */

			/* 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_call		(struct bContext *C, const char *opstring, int context);

			/* default operator callbacks for border/lasso */
int			WM_border_select_invoke	(struct bContext *C, wmOperator *op, struct wmEvent *event);
int			WM_border_select_modal	(struct bContext *C, wmOperator *op, struct wmEvent *event);

			/* default operator for arearegions, generates event */
void		WM_OT_tweak_gesture(wmOperatorType *ot);

			/* Gesture manager API */
struct wmGesture *WM_gesture_new(struct bContext *C, struct wmEvent *event, int type);
void		WM_gesture_end(struct bContext *C, struct wmGesture *gesture);

			/* 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 */