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