Blender V5.3
tree_display.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
22
23#pragma once
24
25#include "DNA_listBase.h"
26
27#include <cstdint>
28#include <memory>
29#include <utility>
30
31#include "BLI_assert.hh"
32#include "BLI_function_ref.hh"
33
34#include "tree_element.hh"
35
36namespace blender {
37
38struct ID;
39struct LayerCollection;
40struct Library;
41struct Main;
42struct Scene;
43struct Strip;
44struct SpaceOutliner;
45struct ViewLayer;
46struct WorkSpace;
47
48namespace ed::outliner {
49
50struct TreeElement;
51class TreeElementID;
52
67
68/* -------------------------------------------------------------------- */
69/* Tree-Element Creation */
70
78 ListBaseT<TreeElement> *lb = nullptr;
83 TreeElement *parent = nullptr;
95 ID *owner_id = nullptr;
101 bool expand = true;
112 const void *persistent_ptr = nullptr;
113};
114
115namespace detail {
116
122template<typename ElementType, typename... Args> ID *element_owner_id(Args &...args)
123{
124 if constexpr (requires { ElementType::owner_id(args...); }) {
125 return ElementType::owner_id(args...);
126 }
127 else {
128 ((void)args, ...);
129 return nullptr;
130 }
131}
132
142template<typename ElementType, typename... Args>
143const void *element_persistent_ptr(const TreeElementAddParams &params, Args &...args)
144{
145 if constexpr (requires { ElementType::persistent_ptr(args...); }) {
146 BLI_assert_msg(params.persistent_ptr == nullptr,
147 "Element type nominates its own tree-store identity, passing one explicitly "
148 "would have no effect");
149 return ElementType::persistent_ptr(args...);
150 }
151 else {
152 ((void)args, ...);
153 return params.persistent_ptr;
154 }
155}
156
157} // namespace detail
158
159/* -------------------------------------------------------------------- */
160/* Tree-Display Interface */
161
168 public:
169 AbstractTreeDisplay(SpaceOutliner &space_outliner) : space_outliner_(space_outliner) {}
170 virtual ~AbstractTreeDisplay() = default;
171
172 static std::unique_ptr<AbstractTreeDisplay> create_from_display_mode(
173 int /*eSpaceOutliner_Mode*/ mode, SpaceOutliner &space_outliner);
174
179 virtual ListBaseT<TreeElement> build_tree(const TreeSourceData &source_data) = 0;
180
188 virtual bool supports_mode_column() const;
189
197 virtual bool is_lazy_built() const;
198
217 template<typename ElementType, typename... Args>
218 TreeElement *add_element(const TreeElementAddParams &params, Args &&...args);
219
229
230 protected:
236 const TreeElementAddParams &params,
237 short type,
238 ID *owner_id,
239 const void *persistent_ptr,
240 bool allow_null_identity,
241 FunctionRef<std::unique_ptr<AbstractTreeElement>(TreeElement &)> construct_fn);
242
245};
246
247template<typename ElementType, typename... Args>
249{
250 ID *owner_id = detail::element_owner_id<ElementType>(args...);
251 if (owner_id) {
252 BLI_assert_msg(params.owner_id == nullptr,
253 "Element type derives its owner ID from its own construction data, passing one "
254 "explicitly would have no effect");
255 }
256 else {
257 owner_id = params.owner_id;
258 }
259
260 /* Types that represent no data at all (e.g. #TreeElementLabel) have nothing to be identified by
261 * and opt out of the identity requirement. */
262 constexpr bool allow_null_identity = requires { ElementType::allow_null_identity; };
263
264 return add_element_impl(params,
265 ElementType::element_type,
266 owner_id,
268 allow_null_identity,
269 [&](TreeElement &legacy_te) -> std::unique_ptr<AbstractTreeElement> {
270 return std::make_unique<ElementType>(legacy_te,
271 std::forward<Args>(args)...);
272 });
273}
274
275/* -------------------------------------------------------------------- */
276/* View Layer Tree-Display */
277
282 const Main *bmain_ = nullptr;
283 Scene *scene_ = nullptr;
284 ViewLayer *view_layer_ = nullptr;
285 bool show_objects_ = true;
286
287 public:
288 TreeDisplayViewLayer(SpaceOutliner &space_outliner);
289
290 ListBaseT<TreeElement> build_tree(const TreeSourceData &source_data) override;
291
292 bool supports_mode_column() const override;
293
294 private:
295 void add_view_layer(Scene &, ListBaseT<TreeElement> &, TreeElement *);
296 void add_layer_collections_recursive(ListBaseT<TreeElement> &,
297 ListBaseT<LayerCollection> &,
298 TreeElement &);
299 void add_layer_collection_objects(ListBaseT<TreeElement> &, LayerCollection &, TreeElement &);
300 void add_layer_collection_objects_children(TreeElement &);
301};
302
303/* -------------------------------------------------------------------- */
304/* Library Tree-Display */
305
310 public:
311 TreeDisplayLibraries(SpaceOutliner &space_outliner);
312
313 ListBaseT<TreeElement> build_tree(const TreeSourceData &source_data) override;
314
315 private:
316 TreeElement *add_library_contents(Main &, ListBaseT<TreeElement> &, Library *);
317 bool library_id_filter_poll(const Library *lib, ID *id) const;
318 short id_filter_get() const;
319};
320
321/* -------------------------------------------------------------------- */
322/* Library Overrides Tree-Display. */
323
328 public:
330
331 ListBaseT<TreeElement> build_tree(const TreeSourceData &source_data) override;
332
333 private:
334 ListBaseT<TreeElement> add_library_contents(Main &);
335 short id_filter_get() const;
336};
337
342 public:
344
345 ListBaseT<TreeElement> build_tree(const TreeSourceData &source_data) override;
346
347 bool is_lazy_built() const override;
348
349 private:
350 ListBaseT<TreeElement> build_hierarchy_for_lib_or_main(Main *bmain,
351 TreeElement &parent_te,
352 Library *lib = nullptr);
353};
354
355/* -------------------------------------------------------------------- */
356/* Video Sequencer Tree-Display */
357
358enum class StripAddOp : int8_t { Noop = 0, Add, None };
359
364 public:
365 TreeDisplaySequencer(SpaceOutliner &space_outliner);
366
367 ListBaseT<TreeElement> build_tree(const TreeSourceData &source_data) override;
368
369 private:
370 TreeElement *add_sequencer_contents() const;
374 StripAddOp need_add_strip_dup(Strip *strip) const;
375 void add_strip_dup(Strip *strip, TreeElement *te, short index);
376};
377
378/* -------------------------------------------------------------------- */
379/* Orphaned Data Tree-Display */
380
385 public:
386 TreeDisplayIDOrphans(SpaceOutliner &space_outliner);
387
388 ListBaseT<TreeElement> build_tree(const TreeSourceData &source_data) override;
389
390 private:
391 bool datablock_has_orphans(ListBaseT<ID> &) const;
392};
393
394/* -------------------------------------------------------------------- */
395/* Scenes Tree-Display */
396
401 public:
402 TreeDisplayScenes(SpaceOutliner &space_outliner);
403
404 ListBaseT<TreeElement> build_tree(const TreeSourceData &source_data) override;
405
406 bool supports_mode_column() const override;
407};
408
409/* -------------------------------------------------------------------- */
410/* Data API Tree-Display */
411
416 public:
417 TreeDisplayDataAPI(SpaceOutliner &space_outliner);
418
419 ListBaseT<TreeElement> build_tree(const TreeSourceData &source_data) override;
420
421 bool is_lazy_built() const override;
422};
423
424/* -------------------------------------------------------------------- */
425/* Tree-Element Creation (needs the complete #AbstractTreeDisplay above) */
426
427template<typename ElementType, typename... Args>
429 Args &&...args) const
430{
431 TreeElementAddParams resolved_params = params;
432 AbstractTreeDisplay *display = display_for_adding(resolved_params);
433 if (!display) {
434 return nullptr;
435 }
436 return display->add_element<ElementType>(resolved_params, std::forward<Args>(args)...);
437}
438
439} // namespace ed::outliner
440} // namespace blender
#define final(a, b, c)
Definition BLI_hash_c.hh:21
These structs are the foundation for all linked lists in the library system.
#define BLI_assert_msg(a, msg)
TreeElement * add_id_element(const TreeElementAddParams &params, ID *id)
TreeElement * add_element_impl(const TreeElementAddParams &params, short type, ID *owner_id, const void *persistent_ptr, bool allow_null_identity, FunctionRef< std::unique_ptr< AbstractTreeElement >(TreeElement &)> construct_fn)
AbstractTreeDisplay(SpaceOutliner &space_outliner)
virtual ListBaseT< TreeElement > build_tree(const TreeSourceData &source_data)=0
TreeElement * add_element(const TreeElementAddParams &params, Args &&...args)
static std::unique_ptr< AbstractTreeDisplay > create_from_display_mode(int mode, SpaceOutliner &space_outliner)
TreeElement * add_element(const TreeElementAddParams &params, Args &&...args) const
ListBaseT< TreeElement > build_tree(const TreeSourceData &source_data) override
TreeDisplayDataAPI(SpaceOutliner &space_outliner)
TreeDisplayIDOrphans(SpaceOutliner &space_outliner)
ListBaseT< TreeElement > build_tree(const TreeSourceData &source_data) override
TreeDisplayLibraries(SpaceOutliner &space_outliner)
ListBaseT< TreeElement > build_tree(const TreeSourceData &source_data) override
ListBaseT< TreeElement > build_tree(const TreeSourceData &source_data) override
ListBaseT< TreeElement > build_tree(const TreeSourceData &source_data) override
TreeDisplayScenes(SpaceOutliner &space_outliner)
ListBaseT< TreeElement > build_tree(const TreeSourceData &source_data) override
ListBaseT< TreeElement > build_tree(const TreeSourceData &source_data) override
TreeDisplaySequencer(SpaceOutliner &space_outliner)
ListBaseT< TreeElement > build_tree(const TreeSourceData &source_data) override
ID * element_owner_id(Args &...args)
const void * element_persistent_ptr(const TreeElementAddParams &params, Args &...args)
BMesh Iterators.
__int64 int64_t
Definition BKE_text.h:90
signed char int8_t
Definition BKE_text.h:76
The data to build the tree from.
TreeSourceData(Main &bmain, WorkSpace &workspace, Scene &scene, ViewLayer &view_layer)