Merge branch 'master' into blender2.8
[blender.git] / source / blender / windowmanager / WM_api.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2007 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26 #ifndef __WM_API_H__
27 #define __WM_API_H__
28
29 /** \file blender/windowmanager/WM_api.h
30  *  \ingroup wm
31  *
32  *  \page wmpage windowmanager
33  *  \section wmabout About windowmanager
34  *  \ref wm handles events received from \ref GHOST and manages
35  *  the screens, areas and input for Blender
36  *  \section wmnote NOTE
37  *  \todo document
38  */
39
40 /* dna-savable wmStructs here */
41 #include "DNA_windowmanager_types.h"
42 #include "WM_keymap.h"
43 #include "BLI_compiler_attrs.h"
44
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48
49 struct bContext;
50 struct GHashIterator;
51 struct IDProperty;
52 struct wmEvent;
53 struct wmEventHandler;
54 struct wmGesture;
55 struct wmJob;
56 struct wmOperatorType;
57 struct wmOperator;
58 struct rcti;
59 struct PointerRNA;
60 struct PropertyRNA;
61 struct MenuType;
62 struct wmDropBox;
63 struct wmDrag;
64 struct ImBuf;
65 struct ImageFormatData;
66 struct ARegion;
67 struct ScrArea;
68 struct Main;
69 struct bToolDef;
70
71 #ifdef WITH_INPUT_NDOF
72 struct wmNDOFMotionData;
73 #endif
74
75 typedef struct wmJob wmJob;
76 typedef struct wmManipulator wmManipulator;
77 typedef struct wmManipulatorMap wmManipulatorMap;
78 typedef struct wmManipulatorMapType wmManipulatorMapType;
79
80 /* general API */
81 void            WM_init_state_size_set          (int stax, int stay, int sizx, int sizy);
82 void            WM_init_state_fullscreen_set(void);
83 void            WM_init_state_normal_set(void);
84 void            WM_init_native_pixels(bool do_it);
85
86 void            WM_init                         (struct bContext *C, int argc, const char **argv);
87 void            WM_exit_ext                     (struct bContext *C, const bool do_python);
88
89 void            WM_exit                         (struct bContext *C) ATTR_NORETURN;
90
91 void            WM_main                         (struct bContext *C) ATTR_NORETURN;
92
93 bool            WM_init_game            (struct bContext *C);
94 void            WM_init_splash          (struct bContext *C);
95
96
97 void            WM_check                        (struct bContext *C);
98
99 int                     WM_window_pixels_x              (struct wmWindow *win);
100 int                     WM_window_pixels_y              (struct wmWindow *win);
101 bool            WM_window_is_fullscreen (struct wmWindow *win);
102
103 void WM_windows_scene_data_sync(const ListBase *win_lb, struct Scene *scene) ATTR_NONNULL();
104 struct Scene *WM_windows_scene_get_from_screen(const struct wmWindowManager *wm, const struct bScreen *screen) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
105 struct WorkSpace *WM_windows_workspace_get_from_screen(const wmWindowManager *wm, const struct bScreen *screen) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
106
107 struct Scene *WM_window_get_active_scene(const struct wmWindow *win) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
108 void          WM_window_change_active_scene(struct Main *bmain, struct bContext *C, struct wmWindow *win,
109                                             struct Scene *scene_new) ATTR_NONNULL();
110 struct WorkSpace *WM_window_get_active_workspace(const struct wmWindow *win) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
111 void              WM_window_set_active_workspace(struct wmWindow *win, struct WorkSpace *workspace) ATTR_NONNULL(1);
112 struct WorkSpaceLayout *WM_window_get_active_layout(const struct wmWindow *win) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
113 void                    WM_window_set_active_layout(
114         struct wmWindow *win, struct WorkSpace *workspace, struct WorkSpaceLayout *layout) ATTR_NONNULL(1);
115 struct bScreen *WM_window_get_active_screen(const struct wmWindow *win) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
116 void            WM_window_set_active_screen(struct wmWindow *win, struct WorkSpace *workspace, struct bScreen *screen) ATTR_NONNULL(1);
117 bool WM_window_is_temp_screen(const struct wmWindow *win) ATTR_WARN_UNUSED_RESULT;
118
119 /* defines for 'type' WM_window_open_temp */
120 enum {
121         WM_WINDOW_RENDER = 1,
122         WM_WINDOW_USERPREFS,
123         // WM_WINDOW_FILESEL // UNUSED
124 };
125
126 struct wmWindow *WM_window_open(struct bContext *C, const struct rcti *rect);
127 struct wmWindow *WM_window_open_temp(struct bContext *C, int x, int y, int sizex, int sizey, int type);
128 void             WM_window_set_dpi(wmWindow *win);
129                         
130                         /* returns true if draw method is triple buffer */
131 bool            WM_is_draw_triple(struct wmWindow *win);
132
133 bool            WM_stereo3d_enabled(struct wmWindow *win, bool only_fullscreen_test);
134
135
136                         /* files */
137 void            WM_file_autoexec_init(const char *filepath);
138 bool            WM_file_read(struct bContext *C, const char *filepath, struct ReportList *reports);
139 void            WM_autosave_init(struct wmWindowManager *wm);
140 void            WM_recover_last_session(struct bContext *C, struct ReportList *reports);
141 void            WM_file_tag_modified(const struct bContext *C);
142
143 void        WM_lib_reload(struct Library *lib, struct bContext *C, struct ReportList *reports);
144
145                         /* mouse cursors */
146 void            WM_cursor_set(struct wmWindow *win, int curs);
147 void            WM_cursor_modal_set(struct wmWindow *win, int curs);
148 void            WM_cursor_modal_restore(struct wmWindow *win);
149 void            WM_cursor_wait          (bool val);
150 void            WM_cursor_grab_enable(struct wmWindow *win, bool wrap, bool hide, int bounds[4]);
151 void            WM_cursor_grab_disable(struct wmWindow *win, const int mouse_ungrab_xy[2]);
152 void            WM_cursor_time          (struct wmWindow *win, int nr);
153
154 void            *WM_paint_cursor_activate(struct wmWindowManager *wm,
155                                       int (*poll)(struct bContext *C),
156                                       void (*draw)(struct bContext *C, int, int, void *customdata),
157                                       void *customdata);
158
159 void            WM_paint_cursor_end(struct wmWindowManager *wm, void *handle);
160 void            WM_paint_cursor_tag_redraw(struct wmWindow *win, struct ARegion *ar);
161
162 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
163 void            WM_cursor_compatible_xy(wmWindow *win, int *x, int *y);
164 float           WM_cursor_pressure      (const struct wmWindow *win);
165
166                         /* event map */
167 int                     WM_userdef_event_map(int kmitype);
168 int                     WM_userdef_event_type_from_keymap_type(int kmitype);
169
170                         /* handlers */
171
172 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
173                                                 /* boundbox, optional subwindow boundbox for offset */
174 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, const rcti *bb, const rcti *swinbb);
175                                                 /* priority not implemented, it adds in begin */
176 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
177
178 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
179
180 typedef int (*wmUIHandlerFunc)(struct bContext *C, const struct wmEvent *event, void *userdata);
181 typedef void (*wmUIHandlerRemoveFunc)(struct bContext *C, void *userdata);
182
183 struct wmEventHandler *WM_event_add_ui_handler(
184         const struct bContext *C, ListBase *handlers,
185         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove,
186         void *userdata, const char flag);
187 void WM_event_remove_ui_handler(
188         ListBase *handlers,
189         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove,
190         void *userdata, const bool postpone);
191 void WM_event_remove_area_handler(
192         struct ListBase *handlers, void *area);
193 void WM_event_free_ui_handler_all(
194         struct bContext *C, ListBase *handlers,
195         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove);
196
197 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
198 void WM_event_modal_handler_area_replace(wmWindow *win, const struct ScrArea *old_area, struct ScrArea *new_area);
199 void WM_event_modal_handler_region_replace(wmWindow *win, const struct ARegion *old_region, struct ARegion *new_region);
200
201 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
202
203 /* handler flag */
204 enum {
205         WM_HANDLER_BLOCKING             = (1 << 0),  /* after this handler all others are ignored */
206         WM_HANDLER_ACCEPT_DBL_CLICK     = (1 << 1),  /* handler accepts double key press events */
207
208         /* internal */
209         WM_HANDLER_DO_FREE              = (1 << 7),  /* handler tagged to be freed in wm_handlers_do() */
210 };
211
212 struct wmEventHandler *WM_event_add_dropbox_handler(ListBase *handlers, ListBase *dropboxes);
213
214                         /* mouse */
215 void            WM_event_add_mousemove(struct bContext *C);
216 bool            WM_event_is_modal_tweak_exit(const struct wmEvent *event, int tweak_event);
217 bool            WM_event_is_last_mousemove(const struct wmEvent *event);
218
219 #ifdef WITH_INPUT_NDOF
220                         /* 3D mouse */
221 void            WM_ndof_deadzone_set(float deadzone);
222 #endif
223                         /* notifiers */
224 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
225 void            WM_main_add_notifier(unsigned int type, void *reference);
226 void            WM_main_remove_notifier_reference(const void *reference);
227 void            WM_main_remap_editor_id_reference(struct ID *old_id, struct ID *new_id);
228
229                         /* reports */
230 void        WM_report_banner_show(void);
231 void        WM_report(ReportType type, const char *message);
232 void        WM_reportf(ReportType type, const char *format, ...) ATTR_PRINTF_FORMAT(2, 3);
233
234 struct wmEvent *wm_event_add_ex(
235         struct wmWindow *win, const struct wmEvent *event_to_add,
236         const struct wmEvent *event_to_add_after)
237         ATTR_NONNULL(1, 2);
238 struct wmEvent *wm_event_add(
239         struct wmWindow *win, const struct wmEvent *event_to_add)
240         ATTR_NONNULL(1, 2);
241
242 void wm_event_init_from_window(struct wmWindow *win, struct wmEvent *event);
243
244
245                         /* at maximum, every timestep seconds it triggers event_type events */
246 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
247 struct wmTimer *WM_event_add_timer_notifier(struct wmWindowManager *wm, struct wmWindow *win, unsigned int type, double timestep);
248 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
249 void            WM_event_remove_timer_notifier(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
250 void        WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, bool do_sleep);
251
252                 /* operator api, default callbacks */
253                         /* invoke callback, uses enum property named "type" */
254 void            WM_operator_view3d_unit_defaults(struct bContext *C, struct wmOperator *op);
255 int                     WM_operator_smooth_viewtx_get(const struct wmOperator *op);
256 int                     WM_menu_invoke_ex(struct bContext *C, struct wmOperator *op, int opcontext);
257 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
258 void            WM_menu_name_call(struct bContext *C, const char *menu_name, short context);
259 int         WM_enum_search_invoke_previews(struct bContext *C, struct wmOperator *op, short prv_cols, short prv_rows);
260 int                     WM_enum_search_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
261                         /* invoke callback, confirm menu + exec */
262 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
263                 /* invoke callback, file selector "filepath" unset + exec */
264 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
265 bool        WM_operator_filesel_ensure_ext_imtype(wmOperator *op, const struct ImageFormatData *im_format);
266                         /* poll callback, context checks */
267 int                     WM_operator_winactive   (struct bContext *C);
268                         /* invoke callback, exec + redo popup */
269 int                     WM_operator_props_popup_confirm(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
270 int                     WM_operator_props_popup_call(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
271 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
272 int             WM_operator_props_dialog_popup(struct bContext *C, struct wmOperator *op, int width, int height);
273 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
274 int                     WM_operator_ui_popup    (struct bContext *C, struct wmOperator *op, int width, int height);
275
276 int         WM_operator_confirm_message_ex(struct bContext *C, struct wmOperator *op,
277                                            const char *title, const int icon,
278                                            const char *message);
279 int         WM_operator_confirm_message(struct bContext *C, struct wmOperator *op,
280                                         const char *message);
281
282                 /* operator api */
283 void            WM_operator_free                (struct wmOperator *op);
284 void            WM_operator_free_all_after(wmWindowManager *wm, struct wmOperator *op);
285 void            WM_operator_type_set(struct wmOperator *op, struct wmOperatorType *ot);
286 void            WM_operator_stack_clear(struct wmWindowManager *wm);
287 void            WM_operator_handlers_clear(wmWindowManager *wm, struct wmOperatorType *ot);
288
289 struct wmOperatorType *WM_operatortype_find(const char *idname, bool quiet);
290 void        WM_operatortype_iter(struct GHashIterator *ghi);
291 void            WM_operatortype_append(void (*opfunc)(struct wmOperatorType *));
292 void            WM_operatortype_append_ptr(void (*opfunc)(struct wmOperatorType *, void *), void *userdata);
293 void            WM_operatortype_append_macro_ptr(void (*opfunc)(struct wmOperatorType *, void *), void *userdata);
294 void        WM_operatortype_remove_ptr(struct wmOperatorType *ot);
295 bool        WM_operatortype_remove(const char *idname);
296 void        WM_operatortype_last_properties_clear_all(void);
297 void        WM_operatortype_props_advanced_begin(struct wmOperatorType *ot);
298 void        WM_operatortype_props_advanced_end(struct wmOperatorType *ot);
299
300 #define WM_operatortype_prop_tag(property, tags) \
301         { \
302                 CHECK_TYPE(tags, eOperatorPropTags); \
303                 RNA_def_property_tags(prop, tags); \
304         } (void)0
305
306 struct wmOperatorType *WM_operatortype_append_macro(const char *idname, const char *name, const char *description, int flag);
307 struct wmOperatorTypeMacro *WM_operatortype_macro_define(struct wmOperatorType *ot, const char *idname);
308
309
310 int                     WM_operator_poll                (struct bContext *C, struct wmOperatorType *ot);
311 int                     WM_operator_poll_context(struct bContext *C, struct wmOperatorType *ot, short context);
312 int         WM_operator_call_ex(struct bContext *C, struct wmOperator *op, const bool store);
313 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
314 int                     WM_operator_call_notest(struct bContext *C, struct wmOperator *op);
315 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
316 bool        WM_operator_repeat_check(const struct bContext *C, struct wmOperator *op);
317 bool        WM_operator_is_repeat(const struct bContext *C, const struct wmOperator *op);
318 int         WM_operator_name_call_ptr(struct bContext *C, struct wmOperatorType *ot, short context, struct PointerRNA *properties);
319 int                     WM_operator_name_call(struct bContext *C, const char *opstring, short context, struct PointerRNA *properties);
320 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, short context, struct PointerRNA *properties, struct ReportList *reports, const bool is_undo);
321
322 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
323 void            WM_operator_properties_sanitize(struct PointerRNA *ptr, const bool no_context); /* make props context sensitive or not */
324 bool        WM_operator_properties_default(struct PointerRNA *ptr, const bool do_update);
325 void        WM_operator_properties_reset(struct wmOperator *op);
326 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
327 void            WM_operator_properties_create_ptr(struct PointerRNA *ptr, struct wmOperatorType *ot);
328 void        WM_operator_properties_clear(struct PointerRNA *ptr);
329 void            WM_operator_properties_free(struct PointerRNA *ptr);
330
331 bool        WM_operator_check_ui_enabled(const struct bContext *C, const char *idname);
332 wmOperator *WM_operator_last_redo(const struct bContext *C);
333 ID         *WM_operator_drop_load_path(struct bContext *C, struct wmOperator *op, const short idcode);
334
335 bool        WM_operator_last_properties_init(struct wmOperator *op);
336 bool        WM_operator_last_properties_store(struct wmOperator *op);
337
338
339 /* wm_operator_props.c */
340 void        WM_operator_properties_filesel(
341         struct wmOperatorType *ot, int filter, short type, short action,
342         short flag, short display, short sort);
343 void        WM_operator_properties_border(struct wmOperatorType *ot);
344 void        WM_operator_properties_border_to_rcti(struct wmOperator *op, struct rcti *rect);
345 void        WM_operator_properties_border_to_rctf(struct wmOperator *op, rctf *rect);
346 void        WM_operator_properties_gesture_border_ex(struct wmOperatorType *ot, bool deselect, bool extend);
347 void        WM_operator_properties_gesture_border(struct wmOperatorType *ot);
348 void        WM_operator_properties_gesture_border_select(struct wmOperatorType *ot);
349 void        WM_operator_properties_gesture_border_zoom(struct wmOperatorType *ot);
350 void        WM_operator_properties_gesture_lasso_ex(struct wmOperatorType *ot, bool deselect, bool extend);
351 void        WM_operator_properties_gesture_lasso(struct wmOperatorType *ot);
352 void        WM_operator_properties_gesture_lasso_select(struct wmOperatorType *ot);
353 void        WM_operator_properties_gesture_straightline(struct wmOperatorType *ot, int cursor);
354 void        WM_operator_properties_gesture_circle_ex(struct wmOperatorType *ot, bool deselect);
355 void        WM_operator_properties_gesture_circle(struct wmOperatorType *ot);
356 void        WM_operator_properties_gesture_circle_select(struct wmOperatorType *ot);
357 void        WM_operator_properties_mouse_select(struct wmOperatorType *ot);
358 void        WM_operator_properties_select_all(struct wmOperatorType *ot);
359 void        WM_operator_properties_select_action(struct wmOperatorType *ot, int default_action);
360 void        WM_operator_properties_select_action_simple(struct wmOperatorType *ot, int default_action);
361 void        WM_operator_properties_select_random(struct wmOperatorType *ot);
362 int         WM_operator_properties_select_random_seed_increment_get(wmOperator *op);
363 struct CheckerIntervalParams {
364         int nth;  /* bypass when set to zero */
365         int skip;
366         int offset;
367 };
368 void        WM_operator_properties_checker_interval(struct wmOperatorType *ot, bool nth_can_disable);
369 void        WM_operator_properties_checker_interval_from_op(
370         struct wmOperator *op, struct CheckerIntervalParams *op_params);
371 bool        WM_operator_properties_checker_interval_test(
372         const struct CheckerIntervalParams *op_params, int depth);
373
374
375 /* MOVE THIS SOMEWHERE ELSE */
376 #define SEL_TOGGLE              0
377 #define SEL_SELECT              1
378 #define SEL_DESELECT    2
379 #define SEL_INVERT              3
380
381
382 /* flags for WM_operator_properties_filesel */
383 #define WM_FILESEL_RELPATH              (1 << 0)
384
385 #define WM_FILESEL_DIRECTORY    (1 << 1)
386 #define WM_FILESEL_FILENAME             (1 << 2)
387 #define WM_FILESEL_FILEPATH             (1 << 3)
388 #define WM_FILESEL_FILES                (1 << 4)
389
390
391                 /* operator as a python command (resultuing string must be freed) */
392 char            *WM_operator_pystring_ex(struct bContext *C, struct wmOperator *op,
393                                      const bool all_args, const bool macro_args,
394                                      struct wmOperatorType *ot, struct PointerRNA *opptr);
395 char            *WM_operator_pystring(struct bContext *C, struct wmOperator *op,
396                                   const bool all_args, const bool macro_args);
397 bool         WM_operator_pystring_abbreviate(char *str, int str_len_max);
398 char            *WM_prop_pystring_assign(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, int index);
399 void            WM_operator_bl_idname(char *to, const char *from);
400 void            WM_operator_py_idname(char *to, const char *from);
401 bool        WM_operator_py_idname_ok_or_report(struct ReportList *reports, const char *classname, const char *idname);
402
403 /* *************** uilist types ******************** */
404 void                WM_uilisttype_init(void);
405 struct uiListType  *WM_uilisttype_find(const char *idname, bool quiet);
406 bool                WM_uilisttype_add(struct uiListType *ult);
407 void                WM_uilisttype_freelink(struct uiListType *ult);
408 void                WM_uilisttype_free(void);
409
410 /* *************** menu types ******************** */
411 void                WM_menutype_init(void);
412 struct MenuType    *WM_menutype_find(const char *idname, bool quiet);
413 bool                WM_menutype_add(struct MenuType *mt);
414 void                WM_menutype_freelink(struct MenuType *mt);
415 void                WM_menutype_free(void);
416
417 /* wm_gesture_ops.c */
418 int                     WM_gesture_border_invoke        (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
419 int                     WM_gesture_border_modal (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
420 void            WM_gesture_border_cancel(struct bContext *C, struct wmOperator *op);
421 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
422 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
423 void            WM_gesture_circle_cancel(struct bContext *C, struct wmOperator *op);
424 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
425 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
426 void            WM_gesture_lines_cancel(struct bContext *C, struct wmOperator *op);
427 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
428 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
429 void            WM_gesture_lasso_cancel(struct bContext *C, struct wmOperator *op);
430 const int (*WM_gesture_lasso_path_to_array(struct bContext *C, struct wmOperator *op, int *mcords_tot))[2];
431 int                     WM_gesture_straightline_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
432 int                     WM_gesture_straightline_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
433 void            WM_gesture_straightline_cancel(struct bContext *C, struct wmOperator *op);
434
435                         /* Gesture manager API */
436 struct wmGesture *WM_gesture_new(struct bContext *C, const struct wmEvent *event, int type);
437 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
438 void            WM_gestures_remove(struct bContext *C);
439
440                         /* fileselecting support */
441 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
442 void            WM_event_fileselect_event(struct wmWindowManager *wm, void *ophandle, int eventval);
443 void            WM_event_print(const struct wmEvent *event);
444
445 void            WM_operator_region_active_win_set(struct bContext *C);
446
447                         /* drag and drop */
448 struct wmDrag           *WM_event_start_drag(struct bContext *C, int icon, int type, void *poin, double value, unsigned int flags);
449 void                            WM_event_drag_image(struct wmDrag *, struct ImBuf *, float scale, int sx, int sy);
450 void                WM_drag_free(struct wmDrag *drag);
451 void                WM_drag_free_list(struct ListBase *lb);
452
453 struct wmDropBox        *WM_dropbox_add(ListBase *lb, const char *idname, int (*poll)(struct bContext *, struct wmDrag *, const struct wmEvent *event),
454                                     void (*copy)(struct wmDrag *, struct wmDropBox *));
455 ListBase        *WM_dropboxmap_find(const char *idname, int spaceid, int regionid);
456
457                         /* Set a subwindow active in pixelspace view, with optional scissor subset */
458 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
459 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, const struct rcti *srct, bool srct_pad);
460
461                         /* OpenGL utilities with safety check */
462 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
463                         /* use for conventions (avoid hard-coded offsets all over) */
464 void            wmOrtho2_region_pixelspace(const struct ARegion *ar);
465 void            wmOrtho2_pixelspace(const float x, const float y);
466
467                         /* threaded Jobs Manager */
468 enum {
469         WM_JOB_PRIORITY     = (1 << 0),
470         WM_JOB_EXCL_RENDER  = (1 << 1),
471         WM_JOB_PROGRESS     = (1 << 2),
472         WM_JOB_SUSPEND      = (1 << 3)
473 };
474
475 /* identifying jobs by owner alone is unreliable, this isnt saved, order can change (keep 0 for 'any') */
476 enum {
477         WM_JOB_TYPE_ANY = 0,
478         WM_JOB_TYPE_COMPOSITE,
479         WM_JOB_TYPE_RENDER,
480         WM_JOB_TYPE_RENDER_PREVIEW,  /* UI preview */
481         WM_JOB_TYPE_SCREENCAST,
482         WM_JOB_TYPE_OBJECT_SIM_OCEAN,
483         WM_JOB_TYPE_OBJECT_SIM_FLUID,
484         WM_JOB_TYPE_OBJECT_BAKE_TEXTURE,
485         WM_JOB_TYPE_OBJECT_BAKE,
486         WM_JOB_TYPE_FILESEL_READDIR,
487         WM_JOB_TYPE_CLIP_BUILD_PROXY,
488         WM_JOB_TYPE_CLIP_TRACK_MARKERS,
489         WM_JOB_TYPE_CLIP_SOLVE_CAMERA,
490         WM_JOB_TYPE_CLIP_PREFETCH,
491         WM_JOB_TYPE_SEQ_BUILD_PROXY,
492         WM_JOB_TYPE_SEQ_BUILD_PREVIEW,
493         WM_JOB_TYPE_POINTCACHE,
494         WM_JOB_TYPE_DPAINT_BAKE,
495         WM_JOB_TYPE_ALEMBIC,
496         /* add as needed, screencast, seq proxy build
497          * if having hard coded values is a problem */
498 };
499
500 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, const char *name, int flag, int job_type);
501
502 bool        WM_jobs_test(struct wmWindowManager *wm, void *owner, int job_type);
503 float           WM_jobs_progress(struct wmWindowManager *wm, void *owner);
504 char       *WM_jobs_name(struct wmWindowManager *wm, void *owner);
505 double      WM_jobs_starttime(struct wmWindowManager *wm, void *owner);
506 void       *WM_jobs_customdata(struct wmWindowManager *wm, void *owner);
507 void       *WM_jobs_customdata_from_type(struct wmWindowManager *wm, int job_type);
508
509 bool        WM_jobs_is_running(struct wmJob *);
510 bool            WM_jobs_is_stopped(wmWindowManager *wm, void *owner);
511 void       *WM_jobs_customdata_get(struct wmJob *);
512 void        WM_jobs_customdata_set(struct wmJob *, void *customdata, void (*free)(void *));
513 void        WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
514 void        WM_jobs_callbacks(struct wmJob *,
515                               void (*startjob)(void *, short *, short *, float *),
516                               void (*initjob)(void *),
517                               void (*update)(void *),
518                               void (*endjob)(void *));
519
520 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
521 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner, void *startjob);
522 void            WM_jobs_kill(struct wmWindowManager *wm, void *owner, void (*)(void *, short int *, short int *, float *));
523 void            WM_jobs_kill_all(struct wmWindowManager *wm);
524 void            WM_jobs_kill_all_except(struct wmWindowManager *wm, void *owner);
525 void            WM_jobs_kill_type(struct wmWindowManager *wm, void *owner, int job_type);
526
527 bool        WM_jobs_has_running(struct wmWindowManager *wm);
528
529 void            WM_job_main_thread_lock_acquire(struct wmJob *job);
530 void            WM_job_main_thread_lock_release(struct wmJob *job);
531
532                         /* clipboard */
533 char       *WM_clipboard_text_get(bool selection, int *r_len);
534 char       *WM_clipboard_text_get_firstline(bool selection, int *r_len);
535 void        WM_clipboard_text_set(const char *buf, bool selection);
536
537                         /* progress */
538 void            WM_progress_set(struct wmWindow *win, float progress);
539 void            WM_progress_clear(struct wmWindow *win);
540
541                         /* Draw (for screenshot) */
542 void        *WM_draw_cb_activate(
543                     struct wmWindow *win,
544                     void (*draw)(const struct wmWindow *, void *),
545                     void *customdata);
546 void        WM_draw_cb_exit(struct wmWindow *win, void *handle);
547 void            WM_redraw_windows(struct bContext *C);
548
549 void        WM_main_playanim(int argc, const char **argv);
550
551 /* debugging only, convenience function to write on crash */
552 bool write_crash_blend(void);
553
554                         /* Lock the interface for any communication */
555 void        WM_set_locked_interface(struct wmWindowManager *wm, bool lock);
556
557 #ifdef WITH_INPUT_NDOF
558 void        WM_event_ndof_pan_get(const struct wmNDOFMotionData *ndof, float r_pan[3], const bool use_zoom);
559 void        WM_event_ndof_rotate_get(const struct wmNDOFMotionData *ndof, float r_rot[3]);
560
561 float       WM_event_ndof_to_axis_angle(const struct wmNDOFMotionData *ndof, float axis[3]);
562 void        WM_event_ndof_to_quat(const struct wmNDOFMotionData *ndof, float q[4]);
563 #endif /* WITH_INPUT_NDOF */
564
565 float       WM_event_tablet_data(const struct wmEvent *event, int *pen_flip, float tilt[2]);
566 bool        WM_event_is_tablet(const struct wmEvent *event);
567
568 #ifdef WITH_INPUT_IME
569 bool        WM_event_is_ime_switch(const struct wmEvent *event);
570 #endif
571
572 /* wm_toolsystem.c  */
573 void WM_toolsystem_unlink(struct bContext *C, struct WorkSpace *workspace);
574 void WM_toolsystem_link(struct bContext *C, struct WorkSpace *workspace);
575
576 void WM_toolsystem_set(struct bContext *C, const struct bToolDef *tool);
577 void WM_toolsystem_init(struct bContext *C);
578
579 #ifdef __cplusplus
580 }
581 #endif
582
583 #endif /* __WM_API_H__ */
584