Blender V5.3
tree_element.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
8
9#pragma once
10
11#include <memory>
12#include <optional>
13
14#include "BLI_string_ref.hh"
15#include "DNA_listBase.h"
16#include "UI_resources.hh"
17
18namespace blender {
19
20struct ID;
21struct SpaceOutliner;
22
23namespace ed::outliner {
24
26struct TreeElement;
28
29/* -------------------------------------------------------------------- */
30/* Tree-Display Interface */
31
33 protected:
44
45 friend class AbstractTreeDisplay;
46
47 public:
48 virtual ~AbstractTreeElement() = default;
49
53 virtual bool expand_poll(const SpaceOutliner & /*soops*/) const
54 {
55 return true;
56 }
57
59 {
60 return legacy_te_;
61 }
62
67 virtual StringRefNull get_warning() const;
68
76 virtual std::optional<BIFIconID> get_icon() const;
77
86 void print_path();
87
94 static void uncollapse_by_default(TreeElement *legacy_te);
95
96 friend void tree_element_expand(const AbstractTreeElement &tree_element,
97 SpaceOutliner &space_outliner);
98
99 protected:
100 /* Pseudo-abstract: Only allow creation through derived types. */
101 AbstractTreeElement(TreeElement &legacy_te) : legacy_te_(legacy_te) {}
102
106 virtual void expand(SpaceOutliner & /*soops*/) const {}
107
119 template<typename ElementType, typename... Args>
120 TreeElement *add_element(const TreeElementAddParams &params, Args &&...args) const;
121
123 TreeElement *add_id_element(const TreeElementAddParams &params, ID *id) const;
124
125 private:
131 AbstractTreeDisplay *display_for_adding(TreeElementAddParams &params) const;
132};
133
134void tree_element_expand(const AbstractTreeElement &tree_element, SpaceOutliner &space_outliner);
135
136} // namespace ed::outliner
137} // namespace blender
These structs are the foundation for all linked lists in the library system.
virtual StringRefNull get_warning() const
TreeElement * add_element(const TreeElementAddParams &params, Args &&...args) const
static void uncollapse_by_default(TreeElement *legacy_te)
virtual bool expand_poll(const SpaceOutliner &) const
virtual void expand(SpaceOutliner &) const
TreeElement * add_id_element(const TreeElementAddParams &params, ID *id) const
virtual std::optional< BIFIconID > get_icon() const
void tree_element_expand(const AbstractTreeElement &tree_element, SpaceOutliner &space_outliner)
BMesh Iterators.