1/****************************************************************************
2**
3** Copyright (C) 2016 Paul Lemire
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#ifndef QT3DRENDER_RENDER_FILTERLAYERENTITYJOB_H
41#define QT3DRENDER_RENDER_FILTERLAYERENTITYJOB_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists for the convenience
48// of other Qt classes. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <Qt3DCore/qaspectjob.h>
55#include <Qt3DCore/qnodeid.h>
56#include <Qt3DRender/private/qt3drender_global_p.h>
57#include <Qt3DRender/qlayerfilter.h>
58
59QT_BEGIN_NAMESPACE
60
61namespace Qt3DRender {
62
63namespace Render {
64
65class Entity;
66class NodeManagers;
67
68class Q_3DRENDERSHARED_PRIVATE_EXPORT FilterLayerEntityJob : public Qt3DCore::QAspectJob
69{
70public:
71 FilterLayerEntityJob();
72
73 inline void setManager(NodeManagers *manager) Q_DECL_NOEXCEPT { m_manager = manager; }
74 inline void setLayerFilters(const Qt3DCore::QNodeIdVector &layerIds) Q_DECL_NOEXCEPT { m_layerFilterIds = layerIds; }
75 inline QVector<Entity *> filteredEntities() const Q_DECL_NOEXCEPT { return m_filteredEntities; }
76
77 inline bool hasLayerFilter() const Q_DECL_NOTHROW { return !m_layerFilterIds.isEmpty(); }
78 inline Qt3DCore::QNodeIdVector layerFilters() const { return m_layerFilterIds; }
79
80 // QAspectJob interface
81 void run() final;
82
83 void filterEntityAgainstLayers(Entity *entity, const Qt3DCore::QNodeIdVector &layerIds, const QLayerFilter::FilterMode filterMode);
84 void filterAcceptAnyMatchingLayers(Entity *entity, const Qt3DCore::QNodeIdVector &layerIds);
85 void filterAcceptAllMatchingLayers(Entity *entity, const Qt3DCore::QNodeIdVector &layerIds);
86 void filterDiscardAnyMatchingLayers(Entity *entity, const Qt3DCore::QNodeIdVector &layerIds);
87 void filterDiscardAllMatchingLayers(Entity *entity, const Qt3DCore::QNodeIdVector &layerIds);
88
89private:
90 void filterLayerAndEntity();
91 void selectAllEntities();
92
93 NodeManagers *m_manager;
94 Qt3DCore::QNodeIdVector m_layerFilterIds;
95 QVector<Entity *> m_filteredEntities;
96};
97
98typedef QSharedPointer<FilterLayerEntityJob> FilterLayerEntityJobPtr;
99
100} // Render
101
102} // Qt3DRender
103
104QT_END_NAMESPACE
105
106#endif // QT3DRENDER_RENDER_FILTERLAYERENTITYJOB_H
107

source code of qt3d/src/render/jobs/filterlayerentityjob_p.h