Merge branch 'master' into blender2.8
[blender.git] / source / blender / windowmanager / gizmo / wm_gizmo_fn.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  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 /** \file blender/windowmanager/gizmo/wm_gizmo_fn.h
22  *  \ingroup wm
23  *
24  * Callback function definitions, needed for both Types & API headers.
25  */
26
27 #ifndef __WM_GIZMO_FN_H__
28 #define __WM_GIZMO_FN_H__
29
30 #include "BLI_compiler_attrs.h"
31
32 /* wmGizmoGroup */
33 typedef bool (*wmGizmoGroupFnPoll)(
34         const struct bContext *, struct wmGizmoGroupType *)
35         ATTR_WARN_UNUSED_RESULT;
36 typedef void (*wmGizmoGroupFnInit)(
37         const struct bContext *, struct wmGizmoGroup *);
38 typedef void (*wmGizmoGroupFnRefresh)(
39         const struct bContext *, struct wmGizmoGroup *);
40 typedef void (*wmGizmoGroupFnDrawPrepare)(
41         const struct bContext *, struct wmGizmoGroup *);
42 typedef struct wmKeyMap *(*wmGizmoGroupFnSetupKeymap)(
43         const struct wmGizmoGroupType *, struct wmKeyConfig *)
44         ATTR_WARN_UNUSED_RESULT;
45 typedef void (*wmGizmoGroupFnMsgBusSubscribe)(
46         const struct bContext *, struct wmGizmoGroup *, struct wmMsgBus *);
47
48 /* wmGizmo */
49 /* See: wmGizmoType for docs on each type. */
50
51 typedef void    (*wmGizmoFnSetup)(struct wmGizmo *);
52 typedef void    (*wmGizmoFnDraw)(const struct bContext *, struct wmGizmo *);
53 typedef void    (*wmGizmoFnDrawSelect)(const struct bContext *, struct wmGizmo *, int);
54 typedef int     (*wmGizmoFnTestSelect)(struct bContext *, struct wmGizmo *, const int mval[2]);
55 typedef int     (*wmGizmoFnModal)(struct bContext *, struct wmGizmo *, const struct wmEvent *, eWM_GizmoFlagTweak);
56 typedef void    (*wmGizmoFnPropertyUpdate)(struct wmGizmo *, struct wmGizmoProperty *);
57 typedef void    (*wmGizmoFnMatrixBasisGet)(const struct wmGizmo *, float[4][4]);
58 typedef int     (*wmGizmoFnInvoke)(struct bContext *, struct wmGizmo *, const struct wmEvent *);
59 typedef void    (*wmGizmoFnExit)(struct bContext *, struct wmGizmo *, const bool);
60 typedef int     (*wmGizmoFnCursorGet)(struct wmGizmo *);
61 typedef void    (*wmGizmoFnSelectRefresh)(struct wmGizmo *);
62 typedef void    (*wmGizmoFnFree)(struct wmGizmo *);
63
64 /* wmGizmoProperty ('value' type defined by 'wmGizmoProperty.data_type') */
65 typedef void (*wmGizmoPropertyFnGet)(
66         const struct wmGizmo *, struct wmGizmoProperty *,
67         /* typically 'float *' */
68         void *value);
69 typedef void (*wmGizmoPropertyFnSet)(
70         const struct wmGizmo *, struct wmGizmoProperty *,
71         /* typically 'const float *' */
72         const void *value);
73 typedef void (*wmGizmoPropertyFnRangeGet)(
74         const struct wmGizmo *, struct wmGizmoProperty *,
75         /* typically 'float[2]' */
76         void *range);
77 typedef void (*wmGizmoPropertyFnFree)(
78         const struct wmGizmo *, struct wmGizmoProperty *);
79
80 typedef struct wmGizmoPropertyFnParams {
81         wmGizmoPropertyFnGet value_get_fn;
82         wmGizmoPropertyFnSet value_set_fn;
83         wmGizmoPropertyFnRangeGet range_get_fn;
84         wmGizmoPropertyFnFree free_fn;
85         void *user_data;
86 } wmGizmoPropertyFnParams;
87
88 #endif  /* __WM_GIZMO_FN_H__ */