summaryrefslogtreecommitdiffstats
path: root/src/api/studio3dqml/q3dsrenderer.cpp
blob: e3fce5c0495edaeeac63190318921c23433da0c9 (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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
/****************************************************************************
**
** 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$
**
****************************************************************************/

#include "q3dsrenderer_p.h"
#include "Qt3DSViewerApp.h"
#include "Qt3DSAudioPlayerImpl.h"
#include "q3dspresentationitem_p.h"

#include <QtStudio3D/private/q3dscommandqueue_p.h>
#include <QtStudio3D/private/q3dsviewersettings_p.h>
#include <QtStudio3D/private/q3dspresentation_p.h>
#include <QtStudio3D/private/studioutils_p.h>
#include <QtStudio3D/private/q3dsdatainput_p.h>

#include <QtCore/qdebug.h>
#include <QtGui/qwindow.h>
#include <QtGui/qopenglcontext.h>
#include <QtQuick/qquickwindow.h>

using namespace Q3DSViewer;

QT_BEGIN_NAMESPACE

Q3DSRenderer::Q3DSRenderer(bool visibleFlag, qt3ds::Qt3DSAssetVisitor *assetVisitor,
                           QElapsedTimer *startupTimer)
    : m_visibleFlag(visibleFlag)
    , m_initElements(false)
    , m_runtime(0)
    , m_window(nullptr)
    , m_initialized(false)
    , m_initializationFailure(false)
    , m_visitor(assetVisitor)
    , m_settings(new Q3DSViewerSettings(this))
    , m_presentation(new Q3DSPresentation(this))
    , m_startupTimer(startupTimer)
{

}

Q3DSRenderer::~Q3DSRenderer()
{
    releaseRuntime();
}

QOpenGLFramebufferObject *Q3DSRenderer::createFramebufferObject(const QSize &size)
{
    QOpenGLFramebufferObjectFormat theFormat;
    theFormat.setAttachment(QOpenGLFramebufferObject::CombinedDepthStencil);
    QOpenGLFramebufferObject *frameBuffer =
            new QOpenGLFramebufferObject(size, theFormat);
    if (m_runtime && m_runtime->IsInitialised())
        m_runtime->setOffscreenId(frameBuffer->handle());
    return frameBuffer;
}

/** Pull pending commands from the plugin.
 *  Invoked automatically by the QML scene graph.
 *
 *  This is the only place where it is valid for the Q3DSStudio3D plugin and render to communicate.
 */
void Q3DSRenderer::synchronize(QQuickFramebufferObject *inView)
{
    // Passing m_InitElements here is a bit of a hack to easily set the flag on the plugin.
    static_cast<Q3DSStudio3D *>(inView)->getCommands(m_initElements, m_commands);

    if (m_initializationFailure)
        static_cast<Q3DSStudio3D *>(inView)->setError(m_error);

    if (m_commands.m_sourceChanged || m_commands.m_variantListChanged) {
        releaseRuntime();
        // Need to update source and variant list here rather than
        // processCommands, as both are needed for init
        m_presentation->setVariantList(m_commands.m_variantList);
        m_presentation->setSource(m_commands.m_source);
        m_presentation->setDelayedLoading(m_commands.m_delayedLoading);
        m_initialized = false;
        m_initializationFailure = false;
        m_error.clear();
        static_cast<Q3DSStudio3D *>(inView)->setError(QString());
    }

    m_initElements = false;

    // We need a handle to the window to be able to reset the GL state inside of Draw().
    // See https://bugreports.qt.io/browse/QTBUG-47213
    if (!m_window)
        m_window = inView->window();
}

void Q3DSRenderer::releaseRuntime()
{
    m_settings->d_ptr->setViewerApp(nullptr);
    m_presentation->d_ptr->setViewerApp(nullptr);

    if (m_runtime) {
        m_runtime->Release();
        m_runtime = nullptr;
    }
}

/** Invoked by the QML scene graph indicating that it's time to render.
 *  Calls `draw()` if the plugin is visible, or `processCommands()` otherwise.
 *
 *  Note that this will still render if the plugin is opacity:0. To avoid this,
 *  add a line to your QML to hide the object when opacity is zero, like:
 *
 *      visible: opacity != 0
 */
void Q3DSRenderer::render()
{
    // We may start in a non visible state but we still need
    // to init the runtime otherwise the commands are never processed
    if (!m_initialized && !m_initializationFailure) {
        m_initialized = initializeRuntime(this->framebufferObject());
        m_initializationFailure = !m_initialized;
        if (m_initializationFailure)
            m_commands.clear(true);
    }

    // Don't render if the plugin is hidden; however, if hidden, but sure
    // to process pending commands so we can be shown again.
    if (m_initialized) {
        if (m_visibleFlag)
            draw();
        else
            processCommands();
        update(); // mark as dirty to ensure update again
    }
}

/** Cause Qt3DS runtime to render content.
 *  Initializes GL and the runtime when called the first time.
 */
void Q3DSRenderer::draw()
{
    if (m_runtime && m_runtime->IsInitialised() && m_window) {
        if (m_initialized)
            m_runtime->RestoreState();
        m_runtime->Render();
        m_runtime->SaveState();

        m_window->resetOpenGLState();
    }
}

bool Q3DSRenderer::initializeRuntime(QOpenGLFramebufferObject *inFbo)
{
    m_runtime = &Q3DSViewerApp::Create(nullptr, new Qt3DSAudioPlayerImpl(), m_startupTimer);
    Q_ASSERT(m_runtime);

    // Connect presentation ready signal before initializing the app
    connect(m_runtime, &Q3DSViewer::Q3DSViewerApp::SigPresentationReady,
            this, &Q3DSRenderer::presentationReady);
    connect(m_runtime, &Q3DSViewer::Q3DSViewerApp::SigPresentationLoaded,
            this, &Q3DSRenderer::presentationLoaded);

    int theWidth = inFbo->width();
    int theHeight = inFbo->height();

    const QString localSource = Q3DSUtils::urlToLocalFileOrQrc(m_presentation->source());

    if (!m_runtime->InitializeApp(theWidth, theHeight,
                                  QOpenGLContext::currentContext()->format(),
                                  inFbo->handle(), localSource,
                                  m_presentation->variantList(),
                                  m_presentation->delayedLoading(),
                                  m_visitor)) {
        m_error = m_runtime->error();
        releaseRuntime();
        return false;
    }

    m_runtime->RegisterScriptCallback(Q3DSViewer::ViewerCallbackType::Enum::CALLBACK_ON_INIT,
                                      reinterpret_cast<qml_Function>(Q3DSRenderer::onInitHandler),
                                      this);
    m_runtime->RegisterScriptCallback(Q3DSViewer::ViewerCallbackType::Enum::CALLBACK_ON_UPDATE,
                                      reinterpret_cast<qml_Function>(Q3DSRenderer::onUpdateHandler),
                                      this);

    m_settings->d_ptr->setViewerApp(m_runtime);
    m_presentation->d_ptr->setViewerApp(m_runtime, false);

    // Connect signals
    connect(m_runtime, &Q3DSViewer::Q3DSViewerApp::SigSlideEntered,
            this, &Q3DSRenderer::enterSlide);
    connect(m_runtime, &Q3DSViewer::Q3DSViewerApp::SigSlideExited,
            this, &Q3DSRenderer::exitSlide);
    connect(m_runtime, &Q3DSViewer::Q3DSViewerApp::SigCustomSignal,
            this, &Q3DSRenderer::customSignalEmitted);
    connect(m_runtime, &Q3DSViewer::Q3DSViewerApp::SigElementsCreated,
            this, &Q3DSRenderer::elementsCreated);
    connect(m_runtime, &Q3DSViewer::Q3DSViewerApp::SigMaterialsCreated,
            this, &Q3DSRenderer::materialsCreated);
    connect(m_runtime, &Q3DSViewer::Q3DSViewerApp::SigMeshesCreated,
            this, &Q3DSRenderer::meshesCreated);
    connect(m_runtime, &Q3DSViewer::Q3DSViewerApp::SigDataOutputValueUpdated,
            this, &Q3DSRenderer::dataOutputValueUpdated);

    return true;
}

/** Accept user commands (e.g. setAttribute) needed to initialize the code.
 *
 *  If we attempt to run Qt3DS methods like setAttribute() before the runtime
 *  has been initialized, they will be lost. This method is the correct place
 *  to accept user commands.
 *
 *  Currently this method just sets a flag needed to pass a flag to the
 *  plugin next time syncronize() is called, which eventually gets the plugin
 *  to emit an `runningChanged` signal the next time `tick()` is called.
 *  As a result, code specified in an `onRunningChanged` handler may be run
 *  after one or more frames have already rendered.
 */
void Q3DSRenderer::onInitHandler(void *userData)
{
    Q3DSRenderer *theRenderer = static_cast<Q3DSRenderer *>(userData);
    theRenderer->setInitElements(true);
}

/** Accept the latest pending user commands (e.g. setAttribute).
 *
 *  This method just calls `ProcessCommands` to avoid unnecessary
 *  pointer dereferencing and accessor methods (or public member variables).
 */
void Q3DSRenderer::onUpdateHandler(void *userData)
{
    Q3DSRenderer *theRenderer = static_cast<Q3DSRenderer *>(userData);
    theRenderer->processCommands();
}

/** Apply commands queued up by the user (e.g. setAttribute).
 *
 *  Note that these commands are executed even if the plugin is not visible,
 *  in part to allow changes to the visible flag to be noticed, but also
 *  to allow specialty code to continue to be queued up even when not rendering.
 */
void Q3DSRenderer::processCommands()
{
    if (!m_runtime) {
        m_commands.clear(true);
        return;
    }

    if (m_commands.m_visibleChanged)
        m_visibleFlag = m_commands.m_visible;

    if (QOpenGLFramebufferObject *inFbo = this->framebufferObject()) {
        if (inFbo->isValid() && (inFbo->width() != m_runtime->GetWindowWidth()
                                 || inFbo->height() != m_runtime->GetWindowHeight())) {
            m_runtime->Resize(inFbo->width(), inFbo->height());
        }
    }

    if (m_commands.m_scaleModeChanged)
        m_settings->setScaleMode(m_commands.m_scaleMode);
    if (m_commands.m_shadeModeChanged)
        m_settings->setShadeMode(m_commands.m_shadeMode);
    if (m_commands.m_matteColorChanged)
        m_settings->setMatteColor(m_commands.m_matteColor);
    if (m_commands.m_showRenderStatsChanged)
        m_settings->setShowRenderStats(m_commands.m_showRenderStats);
    if (m_commands.m_delayedLoadingChanged)
        this->m_runtime->setDelayedLoading(m_commands.m_delayedLoading);
    if (m_commands.m_matteEnabledChanged)
        this->m_runtime->setMatteEnabled(m_commands.m_matteEnabled);

    if (m_commands.m_globalAnimationTimeChanged)
        m_presentation->setGlobalAnimationTime(m_commands.m_globalAnimationTime);

    // Send scene graph changes over to Q3DS
    for (int i = 0; i < m_commands.size(); i++) {
        const ElementCommand &cmd = m_commands.constCommandAt(i);
        switch (cmd.m_commandType) {
        case CommandType_SetAttribute:
            m_presentation->setAttribute(cmd.m_elementPath, cmd.m_stringValue, cmd.m_variantValue);
            break;
        case CommandType_SetPresentationActive:
            m_presentation->setPresentationActive(cmd.m_elementPath, cmd.m_boolValue);
            break;
        case CommandType_GoToTime:
            m_presentation->goToTime(cmd.m_elementPath, cmd.m_floatValue);
            break;
        case CommandType_GoToSlide:
            m_presentation->goToSlide(cmd.m_elementPath, cmd.m_intValues[0]);
            break;
        case CommandType_GoToSlideByName:
            m_presentation->goToSlide(cmd.m_elementPath, cmd.m_stringValue);
            break;
        case CommandType_GoToSlideRelative:
            m_presentation->goToSlide(cmd.m_elementPath, bool(cmd.m_intValues[0]),
                    bool(cmd.m_intValues[1]));
            break;
        case CommandType_FireEvent:
            m_presentation->fireEvent(cmd.m_elementPath, cmd.m_stringValue);
            break;
        case CommandType_MousePress:
            m_runtime->HandleMousePress(cmd.m_intValues[0],
                    cmd.m_intValues[1], cmd.m_intValues[2], true);
            break;
        case CommandType_MouseRelease:
            m_runtime->HandleMousePress(cmd.m_intValues[0],
                    cmd.m_intValues[1], cmd.m_intValues[2], false);
            break;
        case CommandType_MouseMove:
            m_runtime->HandleMouseMove(cmd.m_intValues[0], cmd.m_intValues[1], true);
            break;
        case CommandType_MouseWheel:
            m_runtime->HandleMouseWheel(cmd.m_intValues[0], cmd.m_intValues[1],
                    bool(cmd.m_intValues[2]), cmd.m_intValues[3]);
            break;
        case CommandType_KeyPress:
            m_runtime->HandleKeyInput(Q3DStudio::EKeyCode(cmd.m_intValues[0]), true);
            break;
        case CommandType_KeyRelease:
            m_runtime->HandleKeyInput(Q3DStudio::EKeyCode(cmd.m_intValues[0]), false);
            break;
        case CommandType_SetDataInputValue:
            m_runtime->SetDataInputValue(
                        cmd.m_stringValue, cmd.m_variantValue,
                        static_cast<qt3ds::runtime::DataInputValueRole>(cmd.m_intValues[0]));
            break;
        case CommandType_CreateElements: {
            m_runtime->createElements(
                        cmd.m_elementPath, cmd.m_stringValue,
                        *static_cast<QVector<QHash<QString, QVariant>> *>(cmd.m_data));
            // Runtime makes copy of the data in its own format, so we can delete it now
            auto &command = m_commands.commandAt(i);
            delete reinterpret_cast<QVector<QHash<QString, QVariant>> *>(command.m_data);
            command.m_data = nullptr;
            break;
        }
        case CommandType_DeleteElements: {
            m_runtime->deleteElements(*static_cast<QStringList *>(cmd.m_data));
            // Runtime makes copy of the data in its own format, so we can delete it now
            auto &command = m_commands.commandAt(i);
            delete reinterpret_cast<QStringList *>(command.m_data);
            command.m_data = nullptr;
            break;
        }
        case CommandType_CreateMaterials: {
            m_runtime->createMaterials(cmd.m_elementPath, *static_cast<QStringList *>(cmd.m_data));
            // Runtime makes copy of the data in its own format, so we can delete it now
            auto &command = m_commands.commandAt(i);
            delete reinterpret_cast<QStringList *>(command.m_data);
            command.m_data = nullptr;
            break;
        }
        case CommandType_DeleteMaterials: {
            m_runtime->deleteMaterials(*static_cast<QStringList *>(cmd.m_data));
            // Runtime makes copy of the data in its own format, so we can delete it now
            auto &command = m_commands.commandAt(i);
            delete reinterpret_cast<QStringList *>(command.m_data);
            command.m_data = nullptr;
            break;
        }
        case CommandType_CreateMeshes: {
            m_runtime->createMeshes(*static_cast<QHash<QString, Q3DSViewer::MeshData> *>(
                                        cmd.m_data));
            // Runtime makes copy of the data, so we can delete it now
            auto &command = m_commands.commandAt(i);
            auto meshData = reinterpret_cast<QHash<QString, Q3DSViewer::MeshData> *>(
                        command.m_data);
            delete meshData;
            command.m_data = nullptr;
            break;
        }
        case CommandType_DeleteMeshes: {
            m_runtime->deleteMeshes(*static_cast<QStringList *>(cmd.m_data));
            // Runtime makes copy of the data in its own format, so we can delete it now
            auto &command = m_commands.commandAt(i);
            delete reinterpret_cast<QStringList *>(command.m_data);
            command.m_data = nullptr;
            break;
        }
        case CommandType_RequestSlideInfo: {
            int current = 0;
            int previous = 0;
            QString currentName;
            QString previousName;
            const QByteArray path(cmd.m_elementPath.toUtf8());
            m_runtime->GetSlideInfo(path, current, previous, currentName, previousName);
            QVariantList *requestData = new QVariantList();
            requestData->append(QVariant(current));
            requestData->append(QVariant(previous));
            requestData->append(QVariant(currentName));
            requestData->append(QVariant(previousName));

            Q_EMIT requestResponse(cmd.m_elementPath, cmd.m_commandType, requestData);

            break;
        }
        case CommandType_RequestDataInputs: {
            QVariantList *requestData = new QVariantList();
            if (m_runtime) {
                const auto diList = m_runtime->dataInputs();

                for (const auto &it : diList) {
                    Q3DSDataInput *newIt = new Q3DSDataInput(it, nullptr);
                    newIt->d_ptr->m_max = m_runtime->dataInputMax(it);
                    newIt->d_ptr->m_min = m_runtime->dataInputMin(it);
                    newIt->d_ptr->m_metadata = m_runtime->dataInputMetadata(it);
                    requestData->append(QVariant::fromValue(newIt));
                }
            }

            Q_EMIT requestResponse(cmd.m_elementPath, cmd.m_commandType, requestData);
            break;
        }
        case CommandType_RequestDataOutputs: {
            QVariantList *requestData = new QVariantList();
            if (m_presentation) {
                const auto diList = m_presentation->dataOutputs();

                for (const auto &it : diList)
                    requestData->append(QVariant::fromValue(it->name()));
            }

            Q_EMIT requestResponse(cmd.m_elementPath, cmd.m_commandType, requestData);
            break;
        }
        case CommandType_PreloadSlide:
            m_runtime->preloadSlide(cmd.m_elementPath);
            break;
        case CommandType_UnloadSlide:
            m_runtime->unloadSlide(cmd.m_elementPath);
            break;
        default:
            qWarning() << __FUNCTION__ << "Unrecognized CommandType in command list!";
        }
    }

    m_commands.clear(false);
}

QT_END_NAMESPACE