Merge branch 'blender-v2.81-release'
[blender.git] / source / blender / windowmanager / gizmo / wm_gizmo_wmapi.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) 2016 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup wm
22  *
23  * \name Gizmos Window Manager API
24  * API for usage in window manager code only. It should contain all functionality
25  * needed to hook up the gizmo system with Blender's window manager. It's
26  * mostly the event system that needs to communicate with gizmo code.
27  *
28  * Only included in wm.h and lower level files.
29  */
30
31 #ifndef __WM_GIZMO_WMAPI_H__
32 #define __WM_GIZMO_WMAPI_H__
33
34 struct wmEventHandler_Gizmo;
35 struct wmEventHandler_Op;
36 struct wmGizmoMap;
37 struct wmOperatorType;
38
39 /* -------------------------------------------------------------------- */
40 /* wmGizmo */
41
42 /* wm_gizmo_type.c, for init/exit */
43 void wm_gizmotype_free(void);
44 void wm_gizmotype_init(void);
45
46 /* wm_gizmogroup_type.c, for init/exit */
47 void wm_gizmogrouptype_free(void);
48 void wm_gizmogrouptype_init(void);
49
50 /* -------------------------------------------------------------------- */
51 /* wmGizmoGroup */
52
53 void GIZMOGROUP_OT_gizmo_select(struct wmOperatorType *ot);
54 void GIZMOGROUP_OT_gizmo_tweak(struct wmOperatorType *ot);
55
56 bool wm_gizmogroup_is_any_selected(const struct wmGizmoGroup *gzgroup);
57
58 /* -------------------------------------------------------------------- */
59 /* wmGizmoMap */
60
61 void wm_gizmomap_remove(struct wmGizmoMap *gzmap);
62
63 void wm_gizmos_keymap(struct wmKeyConfig *keyconf);
64
65 void wm_gizmomaps_handled_modal_update(bContext *C,
66                                        struct wmEvent *event,
67                                        struct wmEventHandler_Op *handler);
68 void wm_gizmomap_handler_context_op(bContext *C, struct wmEventHandler_Op *handler);
69 void wm_gizmomap_handler_context_gizmo(bContext *C, struct wmEventHandler_Gizmo *handler);
70
71 struct wmGizmo *wm_gizmomap_highlight_find(struct wmGizmoMap *gzmap,
72                                            bContext *C,
73                                            const struct wmEvent *event,
74                                            int *r_part);
75 bool wm_gizmomap_highlight_set(struct wmGizmoMap *gzmap,
76                                const bContext *C,
77                                struct wmGizmo *gz,
78                                int part);
79 struct wmGizmo *wm_gizmomap_highlight_get(struct wmGizmoMap *gzmap);
80 void wm_gizmomap_modal_set(struct wmGizmoMap *gzmap,
81                            bContext *C,
82                            struct wmGizmo *gz,
83                            const struct wmEvent *event,
84                            bool enable);
85
86 struct wmGizmo *wm_gizmomap_modal_get(struct wmGizmoMap *gzmap);
87 struct wmGizmo **wm_gizmomap_selected_get(wmGizmoMap *gzmap, int *r_selected_len);
88 struct ListBase *wm_gizmomap_groups_get(wmGizmoMap *gzmap);
89
90 /* -------------------------------------------------------------------- */
91 /* wmGizmoMapType */
92
93 void wm_gizmomaptypes_free(void);
94
95 #endif /* __WM_GIZMO_WMAPI_H__ */