Blender V5.3
UI_grid_view.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
11
12#pragma once
13
14#include <optional>
15
16#include "BLI_function_ref.hh"
17#include "BLI_map.hh"
18#include "BLI_vector.hh"
19
20#include "UI_abstract_view.hh"
21#include "UI_resources.hh"
22
23namespace blender {
24
25struct bContext;
26struct View2D;
27
28namespace ui {
29
32
33struct Layout;
34
35/* ---------------------------------------------------------------------- */
38
40 friend class AbstractGridView;
42
43 protected:
49 std::string identifier_{};
50
51 public:
52 /* virtual */ ~AbstractGridViewItem() override = default;
53
54 virtual void build_grid_tile(const bContext &C, Layout &layout) const = 0;
55
56 /* virtual */ std::optional<std::string> debug_name() const override;
57
59
60 protected:
62
64 /* virtual */ bool matches(const AbstractViewItem &other) const override;
65
66 /* virtual */ std::unique_ptr<DropTargetInterface> create_item_drop_target() final;
67 virtual std::unique_ptr<GridViewItemDropTarget> create_drop_target();
68
69 private:
70 void add_grid_tile_button(Block &block);
71};
72
74
75/* ---------------------------------------------------------------------- */
78
80 GridViewStyle(int width, int height);
81 int tile_width = 0;
82 int tile_height = 0;
83};
84
87 friend class GridViewBuilder;
89
90 protected:
93 mutable std::optional<int> item_count_filtered_;
99
100 public:
102 /* virtual */ ~AbstractGridView() override = default;
103
105 void foreach_item(ItemIterFn iter_fn) const;
106 void foreach_filtered_item(ItemIterFn iter_fn) const;
107
121 template<class ItemT, typename... Args> inline ItemT &add_item(Args &&...args);
122 const GridViewStyle &get_style() const;
123 int get_item_count() const;
124 int get_item_count_filtered() const;
125
126 void set_tile_size(int tile_width, int tile_height);
132
133 void scroll_active_into_view(bContext *C, bool scroll_active_to_center = false) override;
134 void page_scroll(bContext *C, PageScrollDirection direction) override;
135
137 const AbstractGridViewItem *force_visible_item) const;
138
139 protected:
140 virtual void build_items() = 0;
141
142 private:
143 void foreach_view_item(FunctionRef<void(AbstractViewItem &)> iter_fn) const final;
144 void update_children_from_old(const AbstractView &old_view) override;
145 AbstractGridViewItem *find_matching_item(const AbstractGridViewItem &item_to_match,
146 const AbstractGridView &view_to_search_in) const;
147
152 AbstractGridViewItem &add_item(std::unique_ptr<AbstractGridViewItem> item);
153};
154
156
157/* ---------------------------------------------------------------------- */
160
167 protected:
169
170 public:
172
175 template<class ViewType> inline ViewType &get_view() const;
176};
177
179
180/* ---------------------------------------------------------------------- */
185
187 public:
188 GridViewBuilder(Block &block);
189
190 void build_grid_view(const bContext &C,
191 AbstractGridView &grid_view,
192 Layout &layout,
193 std::optional<StringRef> search_string = {});
194};
195
197
198/* ---------------------------------------------------------------------- */
203
209 public:
210 using IsActiveFn = std::function<bool()>;
211 using ActivateFn = std::function<void(bContext &C, PreviewGridItem &new_active)>;
212
213 protected:
218 bool hide_label_ = false;
219
220 public:
221 std::string label;
222 int preview_icon_id = ICON_NONE;
223
225
226 void build_grid_tile(const bContext &C, Layout &layout) const override;
227
228 void build_grid_tile_button(Layout &layout,
229 BIFIconID override_preview_icon_id = ICON_NONE) const;
230
241
242 void hide_label();
243
244 private:
245 std::optional<bool> should_be_active() const override;
246 void on_activate(bContext &C) override;
247};
248
250
251/* ---------------------------------------------------------------------- */
252
253template<class ItemT, typename... Args> inline ItemT &AbstractGridView::add_item(Args &&...args)
254{
255 static_assert(std::is_base_of_v<AbstractGridViewItem, ItemT>,
256 "Type must derive from and implement the AbstractGridViewItem interface");
257
258 return dynamic_cast<ItemT &>(add_item(std::make_unique<ItemT>(std::forward<Args>(args)...)));
259}
260
261template<class ViewType> ViewType &GridViewItemDropTarget::get_view() const
262{
263 static_assert(std::is_base_of_v<AbstractGridView, ViewType>,
264 "Type must derive from and implement the ui::AbstractGridView interface");
265 return dynamic_cast<ViewType &>(view_);
266}
267
268} // namespace ui
269} // namespace blender
#define final(a, b, c)
Definition BLI_hash_c.hh:21
#define C
Definition RandGen.cpp:29
std::optional< std::string > debug_name() const override
Definition grid_view.cc:383
virtual void build_grid_tile(const bContext &C, Layout &layout) const =0
AbstractGridView & get_view() const
Definition grid_view.cc:388
virtual std::unique_ptr< GridViewItemDropTarget > create_drop_target()
Definition grid_view.cc:404
AbstractGridViewItem(StringRef identifier)
Definition grid_view.cc:357
std::unique_ptr< DropTargetInterface > create_item_drop_target() final
Definition grid_view.cc:399
~AbstractGridViewItem() override=default
bool matches(const AbstractViewItem &other) const override
Definition grid_view.cc:359
Map< StringRef, AbstractGridViewItem * > item_map_
ItemT & add_item(Args &&...args)
void set_tile_size(int tile_width, int tile_height)
Definition grid_view.cc:121
AbstractViewItem * navigate_up(AbstractViewItem *from) override
Definition grid_view.cc:190
void scroll_active_into_view(bContext *C, bool scroll_active_to_center=false) override
Definition grid_view.cc:304
AbstractViewItem * navigate_right(AbstractViewItem *from) override
Definition grid_view.cc:174
void foreach_filtered_item(ItemIterFn iter_fn) const
Definition grid_view.cc:64
FunctionRef< void(AbstractGridViewItem &)> ItemIterFn
AbstractViewItem * navigate_left(AbstractViewItem *from) override
Definition grid_view.cc:160
AbstractViewItem * find_active_or_visible_item() const override
Definition grid_view.cc:145
void foreach_item(ItemIterFn iter_fn) const
Definition grid_view.cc:57
IndexRange get_visible_range(const View2D &v2d, const AbstractGridViewItem *force_visible_item) const
Definition grid_view.cc:270
~AbstractGridView() override=default
std::optional< int > item_count_filtered_
const GridViewStyle & get_style() const
Definition grid_view.cc:97
void page_scroll(bContext *C, PageScrollDirection direction) override
Definition grid_view.cc:229
AbstractViewItem * navigate_down(AbstractViewItem *from) override
Definition grid_view.cc:209
virtual void build_items()=0
Vector< std::unique_ptr< AbstractGridViewItem > > items_
void build_grid_view(const bContext &C, AbstractGridView &grid_view, Layout &layout, std::optional< StringRef > search_string={})
Definition grid_view.cc:612
GridViewItemDropTarget(AbstractGridView &view)
Definition grid_view.cc:409
PreviewGridItem(StringRef identifier, StringRef label, int preview_icon_id)
Definition grid_view.cc:640
void build_grid_tile(const bContext &C, Layout &layout) const override
Definition grid_view.cc:675
void set_is_active_fn(IsActiveFn fn)
Definition grid_view.cc:685
std::function< void(bContext &C, PreviewGridItem &new_active)> ActivateFn
void set_on_activate_fn(ActivateFn fn)
Definition grid_view.cc:680
void build_grid_tile_button(Layout &layout, BIFIconID override_preview_icon_id=ICON_NONE) const
Definition grid_view.cc:645
std::function< bool()> IsActiveFn
BMesh Iterators.
int BIFIconID
Definition ED_asset.hh:30
GridViewStyle(int width, int height)
Definition grid_view.cc:353