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