Merge branch 'blender2.7'
[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 void (*wmGizmoGroupFnInvokePrepare)(
43         const struct bContext *, struct wmGizmoGroup *, struct wmGizmo *);
44 typedef struct wmKeyMap *(*wmGizmoGroupFnSetupKeymap)(
45         const struct wmGizmoGroupType *, struct wmKeyConfig *)
46         ATTR_WARN_UNUSED_RESULT;
47 typedef void (*wmGizmoGroupFnMsgBusSubscribe)(
48         const struct bContext *, struct wmGizmoGroup *, struct wmMsgBus *);
49
50 /* wmGizmo */
51 /* See: wmGizmoType for docs on each type. */
52
53 typedef void    (*wmGizmoFnSetup)(struct wmGizmo *);
54 typedef void    (*wmGizmoFnDraw)(const struct bContext *, struct wmGizmo *);
55 typedef void    (*wmGizmoFnDrawSelect)(const struct bContext *, struct wmGizmo *, int);
56 typedef int     (*wmGizmoFnTestSelect)(struct bContext *, struct wmGizmo *, const int mval[2]);
57 typedef int     (*wmGizmoFnModal)(struct bContext *, struct wmGizmo *, const struct wmEvent *, eWM_GizmoFlagTweak);
58 typedef void    (*wmGizmoFnPropertyUpdate)(struct wmGizmo *, struct wmGizmoProperty *);
59 typedef void    (*wmGizmoFnMatrixBasisGet)(const struct wmGizmo *, float[4][4]);
60 typedef int     (*wmGizmoFnInvoke)(struct bContext *, struct wmGizmo *, const struct wmEvent *);
61 typedef void    (*wmGizmoFnExit)(struct bContext *, struct wmGizmo *, const bool);
62 typedef int     (*wmGizmoFnCursorGet)(struct wmGizmo *);
63 typedef void    (*wmGizmoFnSelectRefresh)(struct wmGizmo *);
64 typedef void    (*wmGizmoFnFree)(struct wmGizmo *);
65
66 /* wmGizmoProperty ('value' type defined by 'wmGizmoProperty.data_type') */
67 typedef void (*wmGizmoPropertyFnGet)(
68         const struct wmGizmo *, struct wmGizmoProperty *,
69         /* typically 'float *' */
70         void *value);
71 typedef void (*wmGizmoPropertyFnSet)(
72         const struct wmGizmo *, struct wmGizmoProperty *,
73         /* typically 'const float *' */
74         const void *value);
75 typedef void (*wmGizmoPropertyFnRangeGet)(
76         const struct wmGizmo *, struct wmGizmoProperty *,
77         /* typically 'float[2]' */
78         void *range);
79 typedef void (*wmGizmoPropertyFnFree)(
80         const struct wmGizmo *, struct wmGizmoProperty *);
81
82 typedef struct wmGizmoPropertyFnParams {
83         wmGizmoPropertyFnGet value_get_fn;
84         wmGizmoPropertyFnSet value_set_fn;
85         wmGizmoPropertyFnRangeGet range_get_fn;
86         wmGizmoPropertyFnFree free_fn;
87         void *user_data;
88 } wmGizmoPropertyFnParams;
89
90 #endif  /* __WM_GIZMO_FN_H__ */