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
|
/* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup wm
*/
#pragma once
struct BLI_Buffer;
struct wmGizmoMap;
struct wmKeyConfig;
#include "wm_gizmo_fn.h"
/* -------------------------------------------------------------------- */
/* wmGizmo */
/**
* Add/Remove \a gizmo to selection.
* Reallocates memory for selected gizmos so better not call for selecting multiple ones.
*
* \return if the selection has changed.
*/
bool wm_gizmo_select_set_ex(
struct wmGizmoMap *gzmap, struct wmGizmo *gz, bool select, bool use_array, bool use_callback);
bool wm_gizmo_select_and_highlight(bContext *C, struct wmGizmoMap *gzmap, struct wmGizmo *gz);
void wm_gizmo_calculate_scale(struct wmGizmo *gz, const bContext *C);
void wm_gizmo_update(struct wmGizmo *gz, const bContext *C, bool refresh_map);
int wm_gizmo_is_visible(struct wmGizmo *gz);
enum {
WM_GIZMO_IS_VISIBLE_UPDATE = (1 << 0),
WM_GIZMO_IS_VISIBLE_DRAW = (1 << 1),
};
/* -------------------------------------------------------------------- */
/* wmGizmoGroup */
enum {
TWEAK_MODAL_CANCEL = 1,
TWEAK_MODAL_CONFIRM,
TWEAK_MODAL_PRECISION_ON,
TWEAK_MODAL_PRECISION_OFF,
TWEAK_MODAL_SNAP_ON,
TWEAK_MODAL_SNAP_OFF,
};
/**
* Create a new gizmo-group from \a gzgt.
*/
struct wmGizmoGroup *wm_gizmogroup_new_from_type(struct wmGizmoMap *gzmap,
struct wmGizmoGroupType *gzgt);
void wm_gizmogroup_free(bContext *C, struct wmGizmoGroup *gzgroup);
/**
* Add \a gizmo to \a gzgroup and make sure its name is unique within the group.
*/
void wm_gizmogroup_gizmo_register(struct wmGizmoGroup *gzgroup, struct wmGizmo *gz);
struct wmGizmoGroup *wm_gizmogroup_find_by_type(const struct wmGizmoMap *gzmap,
const struct wmGizmoGroupType *gzgt);
struct wmGizmo *wm_gizmogroup_find_intersected_gizmo(wmWindowManager *wm,
const struct wmGizmoGroup *gzgroup,
struct bContext *C,
int event_modifier,
const int mval[2],
int *r_part);
/**
* Adds all gizmos of \a gzgroup that can be selected to the head of \a listbase.
* Added items need freeing!
*/
void wm_gizmogroup_intersectable_gizmos_to_list(wmWindowManager *wm,
const struct wmGizmoGroup *gzgroup,
int event_modifier,
struct BLI_Buffer *visible_gizmos);
bool wm_gizmogroup_is_visible_in_drawstep(const struct wmGizmoGroup *gzgroup,
eWM_GizmoFlagMapDrawStep drawstep);
void wm_gizmogrouptype_setup_keymap(struct wmGizmoGroupType *gzgt, struct wmKeyConfig *keyconf);
wmKeyMap *wm_gizmogroup_tweak_modal_keymap(struct wmKeyConfig *keyconf);
/* -------------------------------------------------------------------- */
/* wmGizmoMap */
typedef struct wmGizmoMapSelectState {
struct wmGizmo **items;
int len, len_alloc;
} wmGizmoMapSelectState;
struct wmGizmoMap {
struct wmGizmoMapType *type;
ListBase groups; /* wmGizmoGroup */
/* private, update tagging (enum defined in C source). */
char update_flag[WM_GIZMOMAP_DRAWSTEP_MAX];
/** Private, true when not yet used. */
bool is_init;
/** When set, one of the items in 'groups' has #wmGizmoGroup.tag_remove set. */
bool tag_remove_group;
/**
* \brief Gizmo map runtime context
*
* Contains information about this gizmo-map. Currently
* highlighted gizmo, currently selected gizmos, ...
*/
struct {
/* we redraw the gizmo-map when this changes */
struct wmGizmo *highlight;
/* User has clicked this gizmo and it gets all input. */
struct wmGizmo *modal;
/* array for all selected gizmos */
struct wmGizmoMapSelectState select;
/* cursor location at point of entering modal (see: WM_GIZMO_MOVE_CURSOR) */
int event_xy[2];
short event_grabcursor;
/* until we have nice cursor push/pop API. */
int last_cursor;
} gzmap_context;
};
/**
* This is a container for all gizmo types that can be instantiated in a region.
* (similar to dropboxes).
*
* \note There is only ever one of these for every (area, region) combination.
*/
struct wmGizmoMapType {
struct wmGizmoMapType *next, *prev;
short spaceid, regionid;
/* types of gizmo-groups for this gizmo-map type */
ListBase grouptype_refs;
/* eGizmoMapTypeUpdateFlags */
eWM_GizmoFlagMapTypeUpdateFlag type_update_flag;
};
void wm_gizmomap_select_array_clear(struct wmGizmoMap *gzmap);
/**
* Deselect all selected gizmos in \a gzmap.
* \return if selection has changed.
*/
bool wm_gizmomap_deselect_all(struct wmGizmoMap *gzmap);
void wm_gizmomap_select_array_shrink(struct wmGizmoMap *gzmap, int len_subtract);
void wm_gizmomap_select_array_push_back(struct wmGizmoMap *gzmap, wmGizmo *gz);
void wm_gizmomap_select_array_remove(struct wmGizmoMap *gzmap, wmGizmo *gz);
|
