Merge branch 'blender2.7'
[blender.git] / source / blender / windowmanager / gizmo / WM_gizmo_api.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_api.h
27  *  \ingroup wm
28  *
29  * \name Gizmo API
30  * \brief API for external use of wmGizmo types.
31  *
32  * Only included in WM_api.h
33  */
34
35
36 #ifndef __WM_GIZMO_API_H__
37 #define __WM_GIZMO_API_H__
38
39 struct ARegion;
40 struct GHashIterator;
41 struct IDProperty;
42 struct Main;
43 struct PropertyRNA;
44 struct wmKeyConfig;
45 struct wmGizmo;
46 struct wmGizmoProperty;
47 struct wmGizmoPropertyType;
48 struct wmGizmoType;
49 struct wmGizmoGroup;
50 struct wmGizmoGroupType;
51 struct wmGizmoMap;
52 struct wmGizmoMapType;
53 struct wmGizmoMapType_Params;
54 struct wmMsgSubscribeKey;
55 struct wmMsgSubscribeValue;
56
57 #include "wm_gizmo_fn.h"
58
59 /* -------------------------------------------------------------------- */
60 /* wmGizmo */
61
62 struct wmGizmo *WM_gizmo_new_ptr(
63         const struct wmGizmoType *gzt, struct wmGizmoGroup *gzgroup,
64         struct PointerRNA *properties);
65 struct wmGizmo *WM_gizmo_new(
66         const char *idname, struct wmGizmoGroup *gzgroup,
67         struct PointerRNA *properties);
68 void WM_gizmo_free(struct wmGizmo *gz);
69 void WM_gizmo_unlink(
70         ListBase *gizmolist, struct wmGizmoMap *gzmap, struct wmGizmo *gz,
71         struct bContext *C);
72
73 bool WM_gizmo_select_unlink(struct wmGizmoMap *gzmap, struct wmGizmo *gz);
74 bool WM_gizmo_select_set(struct wmGizmoMap *gzmap, struct wmGizmo *gz, bool select);
75 void WM_gizmo_highlight_set(struct wmGizmoMap *gzmap, struct wmGizmo *gz);
76
77 void WM_gizmo_modal_set_from_setup(
78         struct wmGizmoMap *gzmap, struct bContext *C,
79         struct wmGizmo *gz, int part_index, const struct wmEvent *event);
80
81 struct wmGizmoOpElem *WM_gizmo_operator_get(
82         struct wmGizmo *gz, int part_index);
83 struct PointerRNA *WM_gizmo_operator_set(
84         struct wmGizmo *gz, int part_index,
85         struct wmOperatorType *ot, struct IDProperty *properties);
86
87 /* callbacks */
88 void WM_gizmo_set_fn_custom_modal(struct wmGizmo *gz, wmGizmoFnModal fn);
89
90 void WM_gizmo_set_matrix_location(
91         struct wmGizmo *gz, const float origin[3]);
92 void WM_gizmo_set_matrix_rotation_from_z_axis(
93         struct wmGizmo *gz, const float z_axis[3]);
94 void WM_gizmo_set_matrix_rotation_from_yz_axis(
95         struct wmGizmo *gz, const float y_axis[3], const float z_axis[3]);
96
97 void WM_gizmo_set_matrix_offset_location(
98         struct wmGizmo *gz, const float origin[3]);
99 void WM_gizmo_set_matrix_offset_rotation_from_z_axis(
100         struct wmGizmo *gz, const float z_axis[3]);
101 void WM_gizmo_set_matrix_offset_rotation_from_yz_axis(
102         struct wmGizmo *gz, const float y_axis[3], const float z_axis[3]);
103
104 void WM_gizmo_set_flag(struct wmGizmo *gz, const int flag, const bool enable);
105 void WM_gizmo_set_scale(struct wmGizmo *gz, const float scale);
106 void WM_gizmo_set_line_width(struct wmGizmo *gz, const float line_width);
107
108 void WM_gizmo_get_color(const struct wmGizmo *gz, float color[4]);
109 void WM_gizmo_set_color(struct wmGizmo *gz, const float color[4]);
110 void WM_gizmo_get_color_highlight(const struct wmGizmo *gz, float color_hi[4]);
111 void WM_gizmo_set_color_highlight(struct wmGizmo *gz, const float color[4]);
112
113 /**
114  * Leaving values NULL use values from #wmGizmo.
115  */
116 struct WM_GizmoMatrixParams {
117         const float(*matrix_space)[4];
118         const float(*matrix_basis)[4];
119         const float(*matrix_offset)[4];
120         const float *scale_final;
121 };
122
123 void WM_gizmo_calc_matrix_final_params(
124         const struct wmGizmo *gz, const struct WM_GizmoMatrixParams *params,
125         float r_mat[4][4]);
126 void WM_gizmo_calc_matrix_final_no_offset(
127         const struct wmGizmo *gz, float r_mat[4][4]);
128
129 void WM_gizmo_calc_matrix_final(
130         const struct wmGizmo *gz, float r_mat[4][4]);
131
132 /* properties */
133 void WM_gizmo_properties_create_ptr(struct PointerRNA *ptr, struct wmGizmoType *gzt);
134 void WM_gizmo_properties_create(struct PointerRNA *ptr, const char *opstring);
135 void WM_gizmo_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *wtstring);
136 void WM_gizmo_properties_sanitize(struct PointerRNA *ptr, const bool no_context);
137 bool WM_gizmo_properties_default(struct PointerRNA *ptr, const bool do_update);
138 void WM_gizmo_properties_reset(struct wmGizmo *op);
139 void WM_gizmo_properties_clear(struct PointerRNA *ptr);
140 void WM_gizmo_properties_free(struct PointerRNA *ptr);
141
142
143 /* wm_gizmo_type.c */
144 const struct wmGizmoType *WM_gizmotype_find(const char *idname, bool quiet);
145 void WM_gizmotype_append(void (*wtfunc)(struct wmGizmoType *));
146 void WM_gizmotype_append_ptr(void (*mnpfunc)(struct wmGizmoType *, void *), void *userdata);
147 bool WM_gizmotype_remove(struct bContext *C, struct Main *bmain, const char *idname);
148 void WM_gizmotype_remove_ptr(struct bContext *C, struct Main *bmain, struct wmGizmoType *gzt);
149 void WM_gizmotype_iter(struct GHashIterator *ghi);
150
151 /* wm_gizmo_group_type.c */
152 struct wmGizmoGroupType *WM_gizmogrouptype_find(const char *idname, bool quiet);
153 struct wmGizmoGroupType *WM_gizmogrouptype_append(void (*wtfunc)(struct wmGizmoGroupType *));
154 struct wmGizmoGroupType *WM_gizmogrouptype_append_ptr(void (*mnpfunc)(struct wmGizmoGroupType *, void *), void *userdata);
155 bool WM_gizmogrouptype_free(const char *idname);
156 void WM_gizmogrouptype_free_ptr(struct wmGizmoGroupType *wt);
157 void WM_gizmogrouptype_iter(struct GHashIterator *ghi);
158
159 struct wmGizmoGroupTypeRef *WM_gizmogrouptype_append_and_link(
160         struct wmGizmoMapType *gzmap_type,
161         void (*wtfunc)(struct wmGizmoGroupType *));
162
163 /* wm_gizmo_map.c */
164
165 /* Dynamic Updates (for RNA runtime registration) */
166 void WM_gizmoconfig_update_tag_init(struct wmGizmoMapType *gzmap_type, struct wmGizmoGroupType *gzgt);
167 void WM_gizmoconfig_update_tag_remove(struct wmGizmoMapType *gzmap_type, struct wmGizmoGroupType *gzgt);
168 void WM_gizmoconfig_update(struct Main *bmain);
169
170
171 /* wm_maniulator_target_props.c */
172 struct wmGizmoProperty *WM_gizmo_target_property_array(struct wmGizmo *gz);
173 struct wmGizmoProperty *WM_gizmo_target_property_at_index(
174         struct wmGizmo *gz, int index);
175 struct wmGizmoProperty *WM_gizmo_target_property_find(
176         struct wmGizmo *gz, const char *idname);
177
178 void WM_gizmo_target_property_def_rna_ptr(
179         struct wmGizmo *gz, const struct wmGizmoPropertyType *gz_prop_type,
180         struct PointerRNA *ptr, struct PropertyRNA *prop, int index);
181 void WM_gizmo_target_property_def_rna(
182         struct wmGizmo *gz, const char *idname,
183         struct PointerRNA *ptr, const char *propname, int index);
184
185 void WM_gizmo_target_property_def_func_ptr(
186         struct wmGizmo *gz, const struct wmGizmoPropertyType *gz_prop_type,
187         const struct wmGizmoPropertyFnParams *params);
188 void WM_gizmo_target_property_def_func(
189         struct wmGizmo *gz, const char *idname,
190         const struct wmGizmoPropertyFnParams *params);
191
192 void WM_gizmo_target_property_clear_rna_ptr(
193         struct wmGizmo *gz, const struct wmGizmoPropertyType *gz_prop_type);
194 void WM_gizmo_target_property_clear_rna(
195         struct wmGizmo *gz, const char *idname);
196
197 bool WM_gizmo_target_property_is_valid_any(struct wmGizmo *gz);
198 bool WM_gizmo_target_property_is_valid(
199         const struct wmGizmoProperty *gz_prop);
200 float WM_gizmo_target_property_float_get(
201         const struct wmGizmo *gz, struct wmGizmoProperty *gz_prop);
202 void  WM_gizmo_target_property_float_set(
203         struct bContext *C, const struct wmGizmo *gz, struct wmGizmoProperty *gz_prop,
204         const float value);
205
206 void WM_gizmo_target_property_float_get_array(
207         const struct wmGizmo *gz, struct wmGizmoProperty *gz_prop,
208         float *value);
209 void WM_gizmo_target_property_float_set_array(
210         struct bContext *C, const struct wmGizmo *gz, struct wmGizmoProperty *gz_prop,
211         const float *value);
212
213 bool WM_gizmo_target_property_float_range_get(
214         const struct wmGizmo *gz, struct wmGizmoProperty *gz_prop,
215         float range[2]);
216
217 int WM_gizmo_target_property_array_length(
218         const struct wmGizmo *gz, struct wmGizmoProperty *gz_prop);
219
220 /* definitions */
221 const struct wmGizmoPropertyType *WM_gizmotype_target_property_find(
222         const struct wmGizmoType *gzt, const char *idname);
223 void WM_gizmotype_target_property_def(
224         struct wmGizmoType *gzt, const char *idname, int data_type, int array_length);
225
226 /* utilities */
227 void WM_gizmo_do_msg_notify_tag_refresh(
228         struct bContext *C, struct wmMsgSubscribeKey *msg_key, struct wmMsgSubscribeValue *msg_val);
229 void WM_gizmo_target_property_subscribe_all(
230         struct wmGizmo *gz, struct wmMsgBus *mbus, struct ARegion *ar);
231
232 /* -------------------------------------------------------------------- */
233 /* wmGizmoGroup */
234
235 /* Callbacks for 'wmGizmoGroupType.setup_keymap' */
236 struct wmKeyMap *WM_gizmogroup_keymap_common(
237         const struct wmGizmoGroupType *gzgt, struct wmKeyConfig *config);
238 struct wmKeyMap *WM_gizmogroup_keymap_common_select(
239         const struct wmGizmoGroupType *gzgt, struct wmKeyConfig *config);
240
241 /* Sort utilities for use with 'BLI_listbase_sort'. */
242 int WM_gizmo_cmp_temp_fl(const void *gz_a_ptr, const void *gz_b_ptr);
243 int WM_gizmo_cmp_temp_fl_reverse(const void *gz_a_ptr, const void *gz_b_ptr);
244
245 /* -------------------------------------------------------------------- */
246 /* wmGizmoMap */
247
248 struct wmGizmoMap *WM_gizmomap_new_from_type(
249         const struct wmGizmoMapType_Params *gzmap_params);
250 const struct ListBase *WM_gizmomap_group_list(struct wmGizmoMap *gzmap);
251 struct wmGizmoGroup *WM_gizmomap_group_find(
252         struct wmGizmoMap *gzmap,
253         const char *idname);
254 struct wmGizmoGroup *WM_gizmomap_group_find_ptr(
255         struct wmGizmoMap *gzmap,
256         const struct wmGizmoGroupType *gzgt);
257 void WM_gizmomap_tag_refresh(struct wmGizmoMap *gzmap);
258 void WM_gizmomap_draw(
259         struct wmGizmoMap *gzmap, const struct bContext *C, const eWM_GizmoFlagMapDrawStep drawstep);
260 void WM_gizmomap_add_handlers(struct ARegion *ar, struct wmGizmoMap *gzmap);
261 bool WM_gizmomap_select_all(struct bContext *C, struct wmGizmoMap *gzmap, const int action);
262 bool WM_gizmomap_cursor_set(const struct wmGizmoMap *gzmap, struct wmWindow *win);
263 void WM_gizmomap_message_subscribe(
264         struct bContext *C, struct wmGizmoMap *gzmap, struct ARegion *ar, struct wmMsgBus *mbus);
265 bool WM_gizmomap_is_any_selected(const struct wmGizmoMap *gzmap);
266 bool WM_gizmomap_minmax(
267         const struct wmGizmoMap *gzmap, bool use_hidden, bool use_select,
268         float r_min[3], float r_max[3]);
269
270 struct ARegion *WM_gizmomap_tooltip_init(
271         struct bContext *C, struct ARegion *ar, int *pass, double *pass_delay, bool *r_exit_on_event);
272
273 /* -------------------------------------------------------------------- */
274 /* wmGizmoMapType */
275
276 struct wmGizmoMapType *WM_gizmomaptype_find(
277         const struct wmGizmoMapType_Params *gzmap_params);
278 struct wmGizmoMapType *WM_gizmomaptype_ensure(
279         const struct wmGizmoMapType_Params *gzmap_params);
280
281 struct wmGizmoGroupTypeRef *WM_gizmomaptype_group_find(
282         struct wmGizmoMapType *gzmap_type,
283         const char *idname);
284 struct wmGizmoGroupTypeRef *WM_gizmomaptype_group_find_ptr(
285         struct wmGizmoMapType *gzmap_type,
286         const struct wmGizmoGroupType *gzgt);
287 struct wmGizmoGroupTypeRef *WM_gizmomaptype_group_link(
288         struct wmGizmoMapType *gzmap_type,
289         const char *idname);
290 struct wmGizmoGroupTypeRef *WM_gizmomaptype_group_link_ptr(
291         struct wmGizmoMapType *gzmap_type,
292         struct wmGizmoGroupType *gzgt);
293
294 void WM_gizmomaptype_group_init_runtime_keymap(
295         const struct Main *bmain,
296         struct wmGizmoGroupType *gzgt);
297 void WM_gizmomaptype_group_init_runtime(
298         const struct Main *bmain, struct wmGizmoMapType *gzmap_type,
299         struct wmGizmoGroupType *gzgt);
300 void WM_gizmomaptype_group_init_runtime_with_region(
301         struct wmGizmoMapType *gzmap_type,
302         struct wmGizmoGroupType *gzgt, struct ARegion *ar);
303 void WM_gizmomaptype_group_unlink(
304         struct bContext *C, struct Main *bmain, struct wmGizmoMapType *gzmap_type,
305         const struct wmGizmoGroupType *gzgt);
306
307 void WM_gizmomaptype_group_free(struct wmGizmoGroupTypeRef *gzgt);
308
309 /* -------------------------------------------------------------------- */
310 /* GizmoGroup */
311
312 /* Add/Ensure/Remove (High level API) */
313
314 void WM_gizmo_group_type_add_ptr_ex(
315         struct wmGizmoGroupType *gzgt,
316         struct wmGizmoMapType *gzmap_type);
317 void WM_gizmo_group_type_add_ptr(
318         struct wmGizmoGroupType *gzgt);
319 void WM_gizmo_group_type_add(const char *idname);
320
321 bool WM_gizmo_group_type_ensure_ptr_ex(
322         struct wmGizmoGroupType *gzgt,
323         struct wmGizmoMapType *gzmap_type);
324 bool WM_gizmo_group_type_ensure_ptr(
325         struct wmGizmoGroupType *gzgt);
326 bool WM_gizmo_group_type_ensure(const char *idname);
327
328 void WM_gizmo_group_type_remove_ptr_ex(
329         struct Main *bmain, struct wmGizmoGroupType *gzgt,
330         struct wmGizmoMapType *gzmap_type);
331 void WM_gizmo_group_type_remove_ptr(
332         struct Main *bmain, struct wmGizmoGroupType *gzgt);
333 void WM_gizmo_group_type_remove(struct Main *bmain, const char *idname);
334
335 void WM_gizmo_group_type_unlink_delayed_ptr_ex(
336         struct wmGizmoGroupType *gzgt,
337         struct wmGizmoMapType *gzmap_type);
338 void WM_gizmo_group_type_unlink_delayed_ptr(
339         struct wmGizmoGroupType *gzgt);
340 void WM_gizmo_group_type_unlink_delayed(const char *idname);
341
342 /* Has the result of unlinking and linking (re-initializes gizmo's). */
343 void WM_gizmo_group_type_reinit_ptr_ex(
344         struct Main *bmain, struct wmGizmoGroupType *gzgt,
345         struct wmGizmoMapType *gzmap_type);
346 void WM_gizmo_group_type_reinit_ptr(
347         struct Main *bmain, struct wmGizmoGroupType *gzgt);
348 void WM_gizmo_group_type_reinit(struct Main *bmain, const char *idname);
349
350 /* Utilities */
351 bool WM_gizmo_context_check_drawstep(const struct bContext *C, eWM_GizmoFlagMapDrawStep step);
352
353 bool WM_gizmo_group_type_poll(const struct bContext *C, const struct wmGizmoGroupType *gzgt);
354
355 #endif  /* __WM_GIZMO_API_H__ */