1/****************************************************************************
2**
3** Copyright (C) 2016 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_QPICKINGSETTINGS_H
41#define QT3DRENDER_QPICKINGSETTINGS_H
42
43#include <Qt3DCore/qnode.h>
44#include <Qt3DRender/qt3drender_global.h>
45
46QT_BEGIN_NAMESPACE
47
48namespace Qt3DRender {
49
50class QPickingSettingsPrivate;
51
52// TO DO: Qt 6 -> Make this a QObject
53
54class Q_3DRENDERSHARED_EXPORT QPickingSettings : public Qt3DCore::QNode
55{
56 Q_OBJECT
57 Q_PROPERTY(PickMethod pickMethod READ pickMethod WRITE setPickMethod NOTIFY pickMethodChanged)
58 Q_PROPERTY(PickResultMode pickResultMode READ pickResultMode WRITE setPickResultMode NOTIFY pickResultModeChanged)
59 Q_PROPERTY(FaceOrientationPickingMode faceOrientationPickingMode READ faceOrientationPickingMode WRITE setFaceOrientationPickingMode NOTIFY faceOrientationPickingModeChanged)
60 Q_PROPERTY(float worldSpaceTolerance READ worldSpaceTolerance WRITE setWorldSpaceTolerance NOTIFY worldSpaceToleranceChanged REVISION 10)
61public:
62 explicit QPickingSettings(Qt3DCore::QNode *parent = nullptr);
63 ~QPickingSettings();
64
65 enum PickMethod {
66 BoundingVolumePicking = 0x00,
67 TrianglePicking = 0x01,
68 LinePicking = 0x02,
69 PointPicking = 0x04,
70 PrimitivePicking = TrianglePicking | LinePicking | PointPicking
71 };
72 Q_ENUM(PickMethod) // LCOV_EXCL_LINE
73
74 enum PickResultMode {
75 NearestPick,
76 AllPicks,
77 NearestPriorityPick
78 };
79 Q_ENUM(PickResultMode) // LCOV_EXCL_LINE
80
81 enum FaceOrientationPickingMode {
82 FrontFace = 0x01,
83 BackFace = 0x02,
84 FrontAndBackFace = 0x03
85 };
86 Q_ENUM(FaceOrientationPickingMode) // LCOV_EXCL_LINE
87
88 PickMethod pickMethod() const;
89 PickResultMode pickResultMode() const;
90 FaceOrientationPickingMode faceOrientationPickingMode() const;
91 float worldSpaceTolerance() const;
92
93public Q_SLOTS:
94 void setPickMethod(PickMethod pickMethod);
95 void setPickResultMode(PickResultMode pickResultMode);
96 void setFaceOrientationPickingMode(FaceOrientationPickingMode faceOrientationPickingMode);
97 void setWorldSpaceTolerance(float worldSpaceTolerance);
98
99Q_SIGNALS:
100 void pickMethodChanged(QPickingSettings::PickMethod pickMethod);
101 void pickResultModeChanged(QPickingSettings::PickResultMode pickResult);
102 void faceOrientationPickingModeChanged(QPickingSettings::FaceOrientationPickingMode faceOrientationPickingMode);
103 void worldSpaceToleranceChanged(float worldSpaceTolerance);
104
105protected:
106 Q_DECLARE_PRIVATE(QPickingSettings)
107 explicit QPickingSettings(QPickingSettingsPrivate &dd, Qt3DCore::QNode *parent = nullptr);
108};
109
110} // namespace Qt3Drender
111
112QT_END_NAMESPACE
113
114#endif // QT3DRENDER_QPICKINGSETTINGS_H
115

source code of qt3d/src/render/frontend/qpickingsettings.h