summaryrefslogtreecommitdiffstats
path: root/src/api/studio3dqml/q3dsstudio3d_p.h
blob: eed8459a68ae6ceac0b0bdcdc0b77c353e81985d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/****************************************************************************
**
** Copyright (c) 2016 NVIDIA CORPORATION.
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef Q3DS_STUDIO3D_H
#define Q3DS_STUDIO3D_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the QtStudio3D API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <QtStudio3D/private/q3dscommandqueue_p.h>
#include <QtGui/qopenglframebufferobject.h>
#include <QtQuick/qquickframebufferobject.h>

QT_BEGIN_NAMESPACE

class Q3DSRenderer;
class Q3DSViewerSettings;
class Q3DSPresentationItem;

class Q3DSStudio3D : public QQuickFramebufferObject
{
    Q_OBJECT
    Q_PROPERTY(bool running READ isRunning NOTIFY runningChanged)
    Q_PROPERTY(Q3DSPresentationItem *presentation READ presentation CONSTANT)
    Q_PROPERTY(Q3DSViewerSettings *viewerSettings READ viewerSettings CONSTANT)
    Q_PROPERTY(QString error READ error NOTIFY errorChanged)
    Q_PROPERTY(EventIgnoreFlags ignoredEvents READ ignoredEvents WRITE setIgnoredEvents NOTIFY ignoredEventsChanged)

public:
    enum EventIgnoreFlag {
        EnableAllEvents = 0,
        IgnoreMouseEvents = 0x01,
        IgnoreWheelEvents = 0x02,
        IgnoreKeyboardEvents = 0x04,
        IgnoreAllInputEvents = IgnoreMouseEvents | IgnoreWheelEvents | IgnoreKeyboardEvents
    };
    Q_DECLARE_FLAGS(EventIgnoreFlags, EventIgnoreFlag)
    Q_FLAG(EventIgnoreFlags)

    Q3DSStudio3D();
    ~Q3DSStudio3D() override;

    QQuickFramebufferObject::Renderer *createRenderer() const override;

    bool isRunning() const;
    Q3DSPresentationItem *presentation() const;
    Q3DSViewerSettings *viewerSettings() const;
    QString error() const;
    void setError(const QString &error);

    void getCommands(bool emitInitialize, CommandQueue &renderQueue);

    void mousePressEvent(QMouseEvent *event) override;
    void mouseReleaseEvent(QMouseEvent *event) override;
    void mouseMoveEvent(QMouseEvent *event) override;
    void wheelEvent(QWheelEvent *event) override;
    void keyPressEvent(QKeyEvent *event) override;
    void keyReleaseEvent(QKeyEvent *event) override;

    EventIgnoreFlags ignoredEvents() const;
    void setIgnoredEvents(EventIgnoreFlags flags);

    void componentComplete() override;

Q_SIGNALS:
    void frameUpdate();
    void runningChanged(bool initialized);
    void errorChanged(const QString &error);
    void ignoredEventsChanged();
    void presentationReady();
    void presentationLoaded();

public Q_SLOTS:
    void reset();

protected Q_SLOTS:
    void handleWindowChanged(QQuickWindow *window);
    void handleVisibleChanged();
    void tick();
    void requestResponseHandler(const QString &elementPath, CommandType commandType,
                                void *requestData);
private:
    void updateEventMasks();

protected:
    Q3DSViewerSettings *m_viewerSettings;
    Q3DSPresentationItem *m_presentation;

    bool m_emitRunningChange;
    bool m_isRunning;
    EventIgnoreFlags m_eventIgnoreFlags;

    CommandQueue m_pendingCommands;
    qreal m_pixelRatio;
    QString m_error;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(Q3DSStudio3D::EventIgnoreFlags)

QT_END_NAMESPACE

#endif // Q3DS_STUDIO3D_H