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_RENDER_ABSTRACTPICKINGJOB_P_H
41#define QT3DRENDER_RENDER_ABSTRACTPICKINGJOB_P_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 <Qt3DRender/private/qray3d_p.h>
56#include <Qt3DRender/private/handle_types_p.h>
57#include <Qt3DRender/private/qboundingvolumeprovider_p.h>
58#include <Qt3DRender/private/qcollisionqueryresult_p.h>
59#include <Qt3DRender/private/pickboundingvolumeutils_p.h>
60#include <Qt3DRender/private/qt3drender_global_p.h>
61
62QT_BEGIN_NAMESPACE
63
64namespace Qt3DCore {
65class QNodeId;
66}
67
68namespace Qt3DRender {
69namespace Render {
70
71class Entity;
72class Renderer;
73class NodeManagers;
74class RenderSettings;
75
76class Q_3DRENDERSHARED_PRIVATE_EXPORT AbstractPickingJob : public Qt3DCore::QAspectJob
77{
78public:
79 AbstractPickingJob();
80
81 void setRoot(Entity *root);
82 void setFrameGraphRoot(FrameGraphNode *frameGraphRoot);
83 void setRenderSettings(RenderSettings *settings);
84 void setManagers(NodeManagers *manager);
85
86 // public for unit tests
87 virtual bool runHelper() = 0;
88 static RayCasting::QRay3D intersectionRay(const QPoint &pos,
89 const Matrix4x4 &viewMatrix,
90 const Matrix4x4 &projectionMatrix,
91 const QRect &viewport);
92
93protected:
94 AbstractPickingJob(Qt3DCore::QAspectJobPrivate &dd);
95
96 void run() final;
97
98 NodeManagers *m_manager;
99 Entity *m_node;
100 FrameGraphNode *m_frameGraphRoot;
101 RenderSettings *m_renderSettings;
102
103 bool m_oneEnabledAtLeast;
104
105 QRect windowViewport(const QSize &area, const QRectF &relativeViewport) const;
106 RayCasting::QRay3D rayForViewportAndCamera(const PickingUtils::ViewportCameraAreaDetails &vca,
107 QObject *eventSource,
108 const QPoint &pos) const;
109};
110
111} // namespace Render
112
113} // namespace Qt3DRender
114
115QT_END_NAMESPACE
116
117#endif // QT3DRENDER_RENDER_ABSTRACTPICKINGJOB_P_H
118

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