1/****************************************************************************
2**
3** Copyright (C) 2018 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#ifndef QT3DRENDER_QABSTRACTRAYCASTER_H
41#define QT3DRENDER_QABSTRACTRAYCASTER_H
42
43#include <Qt3DCore/qcomponent.h>
44#include <Qt3DRender/qraycasterhit.h>
45#include <Qt3DRender/qt3drender_global.h>
46
47#include <QtGui/QVector3D>
48
49QT_BEGIN_NAMESPACE
50
51namespace Qt3DRender {
52
53class QAbstractRayCasterPrivate;
54class QLayer;
55
56class Q_3DRENDERSHARED_EXPORT QAbstractRayCaster : public Qt3DCore::QComponent
57{
58 Q_OBJECT
59 Q_PROPERTY(RunMode runMode READ runMode WRITE setRunMode NOTIFY runModeChanged)
60 Q_PROPERTY(FilterMode filterMode READ filterMode WRITE setFilterMode NOTIFY filterModeChanged)
61 Q_PROPERTY(Hits hits READ hits NOTIFY hitsChanged)
62public:
63 enum RunMode {
64 Continuous,
65 SingleShot
66 };
67 Q_ENUM(RunMode)
68
69 enum FilterMode {
70 AcceptAnyMatchingLayers = 0,
71 AcceptAllMatchingLayers,
72 DiscardAnyMatchingLayers,
73 DiscardAllMatchingLayers,
74 };
75 Q_ENUM(FilterMode) // LOVC_EXLC_LINE
76
77 using Hits = QVector<QRayCasterHit>;
78
79 explicit QAbstractRayCaster(QNode *parent = nullptr);
80 ~QAbstractRayCaster();
81
82 RunMode runMode() const;
83 FilterMode filterMode() const;
84 Hits hits() const;
85
86 void addLayer(QLayer *layer);
87 void removeLayer(QLayer *layer);
88 QVector<QLayer *> layers() const;
89
90public Q_SLOTS:
91 void setRunMode(RunMode runMode);
92 void setFilterMode(FilterMode filterMode);
93
94Q_SIGNALS:
95 void runModeChanged(Qt3DRender::QAbstractRayCaster::RunMode runMode);
96 void hitsChanged(const Qt3DRender::QAbstractRayCaster::Hits &hits);
97 void filterModeChanged(Qt3DRender::QAbstractRayCaster::FilterMode filterMode);
98
99protected:
100 explicit QAbstractRayCaster(QAbstractRayCasterPrivate &dd, QNode *parent = nullptr);
101 void sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change) override;
102 Qt3DCore::QNodeCreatedChangeBasePtr createNodeCreationChange() const override;
103
104private:
105 Q_DECLARE_PRIVATE(QAbstractRayCaster)
106};
107
108} // Qt3D
109
110QT_END_NAMESPACE
111
112Q_DECLARE_METATYPE(Qt3DRender::QAbstractRayCaster::Hits) // LCOV_EXCL_LINE
113
114#endif // QT3DRENDER_QABSTRACTRAYCASTER_H
115

source code of qt3d/src/render/picking/qabstractraycaster.h