1/****************************************************************************
2**
3** Copyright (C) 2019 Klaralvdalens Datakonsult AB (KDAB).
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt3D module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#include "entityvisitor_p.h"
41#include <Qt3DRender/private/managers_p.h>
42#include <Qt3DRender/private/nodemanagers_p.h>
43
44QT_USE_NAMESPACE
45using namespace Qt3DRender::Render;
46
47EntityVisitor::EntityVisitor(NodeManagers *manager)
48 : m_manager(manager)
49 , m_pruneDisabled(false)
50{
51
52}
53
54EntityVisitor::~EntityVisitor() = default;
55
56/*!
57 * \internal
58 *
59 * Override in derived class to do work on the current entity
60 *
61 * Return value (Continue, Prune, Stop) will affect traversal
62 */
63EntityVisitor::Operation EntityVisitor::visit(Entity *entity) {
64 // return false to stop traversal
65 if (!entity)
66 return Stop;
67 return Continue;
68}
69
70/*!
71 * \internal
72 *
73 * If true, disabled entities and all their children will be ignored
74 * during traversal
75 *
76 */
77bool EntityVisitor::pruneDisabled() const
78{
79 return m_pruneDisabled;
80}
81
82void EntityVisitor::setPruneDisabled(bool pruneDisabled)
83{
84 m_pruneDisabled = pruneDisabled;
85}
86
87/*!
88 * \internal
89 *
90 * Call on the root of the tree that should be traversed.
91 * Returns false if any visit resulted in Stop
92 */
93bool EntityVisitor::apply(Entity *root) {
94 if (!root)
95 return false;
96 if (m_pruneDisabled && !root->isEnabled())
97 return true;
98
99 const auto op = visit(entity: root);
100 if (op == Stop)
101 return false;
102 if (op == Prune)
103 return true;
104
105 const auto childrenHandles = root->childrenHandles();
106 for (const HEntity &handle : childrenHandles) {
107 Entity *child = m_manager->renderNodesManager()->data(handle);
108 if (child != nullptr && !apply(root: child))
109 return false;
110 }
111
112 return true;
113}
114

source code of qt3d/src/render/backend/entityvisitor.cpp