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
|
/*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file
* \ingroup spoutliner
*
* \brief Establish and manage Outliner trees for different display modes.
*
* Each Outliner display mode (e.g View Layer, Scenes, Blender File) is implemented as a
* tree-display class with the #AbstractTreeDisplay interface.
*
* Their main responsibility is building the Outliner tree for a display mode. For that, they
* implement the #buildTree() function, which based on Blender data (#TreeSourceData), builds a
* custom tree of whatever data it wants to visualize.
* Further, they can implement display mode dependent queries and general operations using the
* #AbstractTreeDisplay abstraction as common interface.
*
* Outliners keep the current tree-display object alive until the next full tree rebuild to keep
* access to it.
*/
#pragma once
#include "tree_display.h"
struct ListBase;
struct Main;
struct SpaceOutliner;
struct TreeElement;
struct TreeSourceData;
namespace blender::ed::outliner {
/* -------------------------------------------------------------------- */
/* Tree-Display Interface */
/**
* \brief Base Class For Tree-Displays
*
* Abstract base class defining the interface for tree-display variants.
*/
class AbstractTreeDisplay {
public:
AbstractTreeDisplay(SpaceOutliner &space_outliner) : space_outliner_(space_outliner)
{
}
virtual ~AbstractTreeDisplay() = default;
/**
* Build a tree for this display mode with the Blender context data given in \a source_data and
* the view settings in \a space_outliner.
*/
virtual ListBase buildTree(const TreeSourceData &source_data) = 0;
protected:
/** All derived classes will need a handle to this, so storing it in the base for convenience. */
SpaceOutliner &space_outliner_;
};
/* -------------------------------------------------------------------- */
/* View Layer Tree-Display */
/**
* \brief Tree-Display for the View Layer display mode.
*/
class TreeDisplayViewLayer final : public AbstractTreeDisplay {
ViewLayer *view_layer_ = nullptr;
bool show_objects_ = true;
public:
TreeDisplayViewLayer(SpaceOutliner &space_outliner);
ListBase buildTree(const TreeSourceData &source_data) override;
private:
void add_view_layer(ListBase &, TreeElement &);
void add_layer_collections_recursive(ListBase &, ListBase &, TreeElement &);
void add_layer_collection_objects(ListBase &, LayerCollection &, TreeElement &);
void add_layer_collection_objects_children(TreeElement &);
};
/* -------------------------------------------------------------------- */
/* Library Tree-Display */
/**
* \brief Tree-Display for the Libraries display mode.
*/
class TreeDisplayLibraries final : public AbstractTreeDisplay {
public:
TreeDisplayLibraries(SpaceOutliner &space_outliner);
ListBase buildTree(const TreeSourceData &source_data) override;
private:
TreeElement *add_library_contents(Main &, ListBase &, Library *) const;
bool library_id_filter_poll(Library *lib, ID *id) const;
short id_filter_get() const;
};
} // namespace blender::ed::outliner
|