Merge branch 'blender2.7'
[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
32 #ifndef __WM_GIZMO_WMAPI_H__
33 #define __WM_GIZMO_WMAPI_H__
34
35 struct wmEventHandler;
36 struct wmEventHandler_Gizmo;
37 struct wmEventHandler_Op;
38 struct wmGizmoMap;
39 struct wmOperator;
40 struct wmOperatorType;
41
42
43 /* -------------------------------------------------------------------- */
44 /* wmGizmo */
45
46 /* wm_gizmo_type.c, for init/exit */
47 void wm_gizmotype_free(void);
48 void wm_gizmotype_init(void);
49
50 /* wm_gizmogroup_type.c, for init/exit */
51 void wm_gizmogrouptype_free(void);
52 void wm_gizmogrouptype_init(void);
53
54 /* -------------------------------------------------------------------- */
55 /* wmGizmoGroup */
56
57 void GIZMOGROUP_OT_gizmo_select(struct wmOperatorType *ot);
58 void GIZMOGROUP_OT_gizmo_tweak(struct wmOperatorType *ot);
59
60 bool wm_gizmogroup_is_any_selected(const struct wmGizmoGroup *gzgroup);
61
62 /* -------------------------------------------------------------------- */
63 /* wmGizmoMap */
64
65 void wm_gizmomap_remove(struct wmGizmoMap *gzmap);
66
67 void wm_gizmos_keymap(struct wmKeyConfig *keyconf);
68
69 void wm_gizmomaps_handled_modal_update(
70         bContext *C, struct wmEvent *event, struct wmEventHandler_Op *handler);
71 void wm_gizmomap_handler_context_op(bContext *C, struct wmEventHandler_Op *handler);
72 void wm_gizmomap_handler_context_gizmo(bContext *C, struct wmEventHandler_Gizmo *handler);
73
74 struct wmGizmo *wm_gizmomap_highlight_find(
75         struct wmGizmoMap *gzmap, bContext *C, const struct wmEvent *event,
76         int *r_part);
77 bool wm_gizmomap_highlight_set(
78         struct wmGizmoMap *gzmap, const bContext *C,
79         struct wmGizmo *gz, int part);
80 struct wmGizmo *wm_gizmomap_highlight_get(struct wmGizmoMap *gzmap);
81 void wm_gizmomap_modal_set(
82         struct wmGizmoMap *gzmap, bContext *C, struct wmGizmo *gz,
83         const struct wmEvent *event, bool enable);
84
85 struct wmGizmo *wm_gizmomap_modal_get(struct wmGizmoMap *gzmap);
86 struct wmGizmo **wm_gizmomap_selected_get(wmGizmoMap *gzmap, int *r_selected_len);
87 struct ListBase *wm_gizmomap_groups_get(wmGizmoMap *gzmap);
88
89 /* -------------------------------------------------------------------- */
90 /* wmGizmoMapType */
91
92 void wm_gizmomaptypes_free(void);
93
94 #endif  /* __WM_GIZMO_WMAPI_H__ */