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