1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* The Original Code is Copyright (C) 2016 Blender Foundation.
* All rights reserved.
*
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file blender/windowmanager/manipulators/WM_manipulator_types.h
* \ingroup wm
*
* \name Manipulator Types
* \brief Manipulator defines for external use.
*
* Only included in WM_types.h and lower level files.
*/
#ifndef __WM_MANIPULATOR_TYPES_H__
#define __WM_MANIPULATOR_TYPES_H__
#include "BLI_compiler_attrs.h"
struct wmManipulatorGroupType;
struct wmManipulatorGroup;
struct wmManipulator;
struct wmKeyConfig;
#include "wm_manipulator_fn.h"
/* -------------------------------------------------------------------- */
/* wmManipulator */
/**
* Simple utility wrapper for storing a single manipulator as wmManipulatorGroup.customdata (which gets freed).
*/
typedef struct wmManipulatorWrapper {
struct wmManipulator *manipulator;
} wmManipulatorWrapper;
/* wmManipulator.flag
* Flags for individual manipulators. */
enum {
WM_MANIPULATOR_DRAW_HOVER = (1 << 0), /* draw *only* while hovering */
WM_MANIPULATOR_DRAW_ACTIVE = (1 << 1), /* draw while dragging */
WM_MANIPULATOR_DRAW_VALUE = (1 << 2), /* draw an indicator for the current value while dragging */
WM_MANIPULATOR_HIDDEN = (1 << 3),
};
typedef struct wmManipulatorType {
struct wmManipulatorGroupType *next, *prev;
const char *idname; /* MAX_NAME */
uint size;
/* could become wmManipulatorType */
/* draw manipulator */
wmManipulatorFnDraw draw;
/* determines 3d intersection by rendering the manipulator in a selection routine. */
wmManipulatorFnDrawSelect draw_select;
/* determine if the mouse intersects with the manipulator. The calculation should be done in the callback itself */
wmManipulatorFnIntersect intersect;
/* handler used by the manipulator. Usually handles interaction tied to a manipulator type */
wmManipulatorFnHandler handler;
/* manipulator-specific handler to update manipulator attributes based on the property value */
wmManipulatorFnPropDataUpdate prop_data_update;
/* returns the final position which may be different from the origin, depending on the manipulator.
* used in calculations of scale */
wmManipulatorFnFinalPositionGet position_get;
/* activate a manipulator state when the user clicks on it */
wmManipulatorFnInvoke invoke;
/* called when manipulator tweaking is done - used to free data and reset property when cancelling */
wmManipulatorFnExit exit;
wmManipulatorFnCursorGet cursor_get;
/* called when manipulator selection state changes */
wmManipulatorFnSelect select;
/* maximum number of properties attached to the manipulator */
int prop_len_max;
/* RNA integration */
ExtensionRNA ext;
} wmManipulatorType;
/* -------------------------------------------------------------------- */
/* wmManipulatorGroup */
/* factory class for a manipulator-group type, gets called every time a new area is spawned */
typedef struct wmManipulatorGroupType {
struct wmManipulatorGroupType *next, *prev;
char idname[64]; /* MAX_NAME */
const char *name; /* manipulator-group name - displayed in UI (keymap editor) */
/* poll if manipulator-map should be visible */
wmManipulatorGroupFnPoll poll;
/* initially create manipulators and set permanent data - stuff you only need to do once */
wmManipulatorGroupFnInit init;
/* refresh data, only called if recreate flag is set (WM_manipulatormap_tag_refresh) */
wmManipulatorGroupFnRefresh refresh;
/* refresh data for drawing, called before each redraw */
wmManipulatorGroupFnDrawPrepare draw_prepare;
/* keymap init callback for this manipulator-group */
struct wmKeyMap *(*keymap_init)(const struct wmManipulatorGroupType *, struct wmKeyConfig *);
/* keymap created with callback from above */
struct wmKeyMap *keymap;
/* Disable for now, maybe some day we want properties. */
#if 0
/* rna for properties */
struct StructRNA *srna;
#endif
/* RNA integration */
ExtensionRNA ext;
int flag;
/* Weak, but needed to store which functions we have. */
int rna_func_flag;
/* if type is spawned from operator this is set here */
void *op;
/* same as manipulator-maps, so registering/unregistering goes to the correct region */
short spaceid, regionid;
char mapidname[64];
} wmManipulatorGroupType;
/**
* wmManipulatorGroupType.flag
* Flags that influence the behavior of all manipulators in the group.
*/
enum {
/* Mark manipulator-group as being 3D */
WM_MANIPULATORGROUPTYPE_IS_3D = (1 << 0),
/* Scale manipulators as 3D object that respects zoom (otherwise zoom independent draw size) */
WM_MANIPULATORGROUPTYPE_SCALE_3D = (1 << 1),
/* Manipulators can be depth culled with scene objects (covered by other geometry - TODO) */
WM_MANIPULATORGROUPTYPE_SCENE_DEPTH = (1 << 2),
/* Manipulators can be selected */
WM_MANIPULATORGROUPTYPE_SELECTABLE = (1 << 3),
/* manipulator group is attached to operator, and is only accessible as long as this runs */
WM_MANIPULATORGROUPTYPE_OP = (1 << 4),
};
/* -------------------------------------------------------------------- */
/* wmManipulatorMap */
struct wmManipulatorMapType_Params {
const char *idname;
const int spaceid;
const int regionid;
};
/**
* Pass a value of this enum to #WM_manipulatormap_draw to tell it what to draw.
*/
enum {
/* Draw 2D manipulator-groups (ManipulatorGroupType.is_3d == false) */
WM_MANIPULATORMAP_DRAWSTEP_2D = 0,
/* Draw 3D manipulator-groups (ManipulatorGroupType.is_3d == true) */
WM_MANIPULATORMAP_DRAWSTEP_3D,
/* Draw only depth culled manipulators (WM_MANIPULATOR_SCENE_DEPTH flag).
* Note that these are expected to be 3D manipulators too. */
WM_MANIPULATORMAP_DRAWSTEP_IN_SCENE,
};
#endif /* __WM_MANIPULATOR_TYPES_H__ */
|
