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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
/* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup editorui
*
* API for simple creation of grid UIs, supporting typically needed features.
* https://wiki.blender.org/wiki/Source/Interface/Views/Grid_Views
*/
#pragma once
#include "BLI_function_ref.hh"
#include "BLI_map.hh"
#include "BLI_vector.hh"
#include "UI_abstract_view.hh"
#include "UI_resources.h"
struct bContext;
struct PreviewImage;
struct uiBlock;
struct uiButViewItem;
struct uiLayout;
struct View2D;
struct wmNotifier;
namespace blender::ui {
class AbstractGridView;
/* ---------------------------------------------------------------------- */
/** \name Grid-View Item Type
* \{ */
class AbstractGridViewItem : public AbstractViewItem {
friend class AbstractGridView;
friend class GridViewLayoutBuilder;
const AbstractGridView *view_;
protected:
/** Reference to a string that uniquely identifies this item in the view. */
StringRef identifier_{};
/** Every visible item gets a button of type #UI_BTYPE_VIEW_ITEM during the layout building. */
uiButViewItem *view_item_but_ = nullptr;
public:
virtual ~AbstractGridViewItem() = default;
virtual void build_grid_tile(uiLayout &layout) const = 0;
const AbstractGridView &get_view() const;
protected:
AbstractGridViewItem(StringRef identifier);
/** See AbstractViewItem::matches(). */
virtual bool matches(const AbstractViewItem &other) const override;
/** Called when the item's state changes from inactive to active. */
virtual void on_activate();
/**
* If the result is not empty, it controls whether the item should be active or not,
* usually depending on the data that the view represents.
*/
virtual std::optional<bool> should_be_active() const;
/**
* Activates this item, deactivates other items, and calls the
* #AbstractGridViewItem::on_activate() function.
* Requires the tree to have completed reconstruction, see #is_reconstructed(). Otherwise the
* actual item state is unknown, possibly calling state-change update functions incorrectly.
*/
void activate();
void deactivate();
private:
/** See #AbstractTreeView::change_state_delayed() */
void change_state_delayed();
static void grid_tile_click_fn(bContext *, void *but_arg1, void *);
void add_grid_tile_button(uiBlock &block);
};
/** \} */
/* ---------------------------------------------------------------------- */
/** \name Grid-View Base Class
* \{ */
struct GridViewStyle {
GridViewStyle(int width, int height);
int tile_width = 0;
int tile_height = 0;
};
class AbstractGridView : public AbstractView {
friend class AbstractGridViewItem;
friend class GridViewBuilder;
friend class GridViewLayoutBuilder;
protected:
Vector<std::unique_ptr<AbstractGridViewItem>> items_;
/** <identifier, item> map to lookup items by identifier, used for efficient lookups in
* #update_from_old(). */
Map<StringRef, AbstractGridViewItem *> item_map_;
GridViewStyle style_;
public:
AbstractGridView();
virtual ~AbstractGridView() = default;
using ItemIterFn = FunctionRef<void(AbstractGridViewItem &)>;
void foreach_item(ItemIterFn iter_fn) const;
/**
* Convenience wrapper constructing the item by forwarding given arguments to the constructor of
* the type (\a ItemT).
*
* E.g. if your grid-item type has the following constructor:
* \code{.cpp}
* MyGridItem(std::string str, int i);
* \endcode
* You can add an item like this:
* \code
* add_item<MyGridItem>("blabla", 42);
* \endcode
*/
template<class ItemT, typename... Args> inline ItemT &add_item(Args &&...args);
const GridViewStyle &get_style() const;
int get_item_count() const;
protected:
virtual void build_items() = 0;
private:
void update_children_from_old(const AbstractView &old_view) override;
AbstractGridViewItem *find_matching_item(const AbstractGridViewItem &item_to_match,
const AbstractGridView &view_to_search_in) const;
/**
* Items may want to do additional work when state changes. But these state changes can only be
* reliably detected after the view has completed reconstruction (see #is_reconstructed()). So
* the actual state changes are done in a delayed manner through this function.
*/
void change_state_delayed();
/**
* Add an already constructed item, moving ownership to the grid-view.
* All items must be added through this, it handles important invariants!
*/
AbstractGridViewItem &add_item(std::unique_ptr<AbstractGridViewItem> item);
};
/** \} */
/* ---------------------------------------------------------------------- */
/** \name Grid-View Builder
*
* TODO unify this with `TreeViewBuilder` and call view-specific functions via type erased view?
* \{ */
class GridViewBuilder {
uiBlock &block_;
public:
GridViewBuilder(uiBlock &block);
/** Build \a grid_view into the previously provided block, clipped by \a view_bounds (view space,
* typically `View2D.cur`). */
void build_grid_view(AbstractGridView &grid_view, const View2D &v2d);
};
/** \} */
/* ---------------------------------------------------------------------- */
/** \name Predefined Grid-View Item Types
*
* Common, Basic Grid-View Item Types.
* \{ */
/**
* A grid item that shows preview image icons at a nicely readable size (multiple of the normal UI
* unit size).
*/
class PreviewGridItem : public AbstractGridViewItem {
public:
using IsActiveFn = std::function<bool()>;
using ActivateFn = std::function<void(PreviewGridItem &new_active)>;
protected:
/** See #set_on_activate_fn() */
ActivateFn activate_fn_;
/** See #set_is_active_fn() */
IsActiveFn is_active_fn_;
public:
std::string label{};
int preview_icon_id = ICON_NONE;
PreviewGridItem(StringRef identifier, StringRef label, int preview_icon_id);
void build_grid_tile(uiLayout &layout) const override;
/**
* Set a custom callback to execute when activating this view item. This way users don't have to
* sub-class #PreviewGridItem, just to implement custom activation behavior (a common thing to
* do).
*/
void set_on_activate_fn(ActivateFn fn);
/**
* Set a custom callback to check if this item should be active.
*/
void set_is_active_fn(IsActiveFn fn);
private:
std::optional<bool> should_be_active() const override;
void on_activate() override;
};
/** \} */
/* ---------------------------------------------------------------------- */
template<class ItemT, typename... Args> inline ItemT &AbstractGridView::add_item(Args &&...args)
{
static_assert(std::is_base_of<AbstractGridViewItem, ItemT>::value,
"Type must derive from and implement the AbstractGridViewItem interface");
return dynamic_cast<ItemT &>(add_item(std::make_unique<ItemT>(std::forward<Args>(args)...)));
}
} // namespace blender::ui
|
