1/****************************************************************************
2**
3** Copyright (C) 2015 Paul Lemire paul.lemire350@gmail.com
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_PICKBOUNDINGVOLUMEJOB_H
41#define QT3DRENDER_RENDER_PICKBOUNDINGVOLUMEJOB_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 "abstractpickingjob_p.h"
55#include <Qt3DCore/qaspectjob.h>
56#include <Qt3DRender/private/qray3d_p.h>
57#include <Qt3DRender/private/handle_types_p.h>
58#include <Qt3DRender/private/qboundingvolumeprovider_p.h>
59#include <Qt3DRender/private/qcollisionqueryresult_p.h>
60#include <Qt3DRender/private/pickboundingvolumeutils_p.h>
61#include <Qt3DRender/qpickevent.h>
62#include <QMouseEvent>
63#include <QKeyEvent>
64#include <QSharedPointer>
65
66QT_BEGIN_NAMESPACE
67
68namespace Qt3DRender {
69
70class QViewport;
71
72namespace Render {
73
74namespace PickingUtils {
75typedef QVector<RayCasting::QCollisionQueryResult::Hit> HitList;
76}
77
78class Q_AUTOTEST_EXPORT PickBoundingVolumeJob : public AbstractPickingJob
79{
80public:
81 PickBoundingVolumeJob();
82
83 void setRoot(Entity *root);
84 void setMouseEvents(const QList<QPair<QObject*, QMouseEvent>> &pendingEvents);
85 void setKeyEvents(const QList<QKeyEvent> &pendingEvents);
86 void markPickersDirty();
87 bool pickersDirty() const { return m_pickersDirty; }
88
89 // For unit tests
90 inline HObjectPicker currentPicker() const { return m_currentPicker; }
91 inline QVector<HObjectPicker> hoveredPickers() const { return m_hoveredPickers; }
92 bool runHelper() override;
93
94protected:
95 void dispatchPickEvents(const QMouseEvent &event,
96 const PickingUtils::HitList &sphereHits,
97 QPickEvent::Buttons eventButton,
98 int eventButtons,
99 int eventModifiers,
100 bool allHitsRequested,
101 Qt3DCore::QNodeId viewportNodeId);
102
103private:
104 void clearPreviouslyHoveredPickers();
105
106 QList<QPair<QObject*, QMouseEvent>> m_pendingMouseEvents;
107 QList<QKeyEvent> m_pendingKeyEvents;
108 bool m_pickersDirty;
109 bool m_oneHoverAtLeast;
110 HObjectPicker m_currentPicker;
111 QVector<HObjectPicker> m_hoveredPickers;
112 QVector<HObjectPicker> m_hoveredPickersToClear;
113};
114
115typedef QSharedPointer<PickBoundingVolumeJob> PickBoundingVolumeJobPtr;
116
117} // namespace Render
118
119} // namespace Qt3DRender
120
121QT_END_NAMESPACE
122
123#endif // QT3DRENDER_RENDER_PICKBOUNDINGVOLUMEJOB_H
124