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
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
|
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#include "effectcomposerwidget.h"
#include "compositionnode.h"
#include "effectcomposercontextobject.h"
#include "effectcomposermodel.h"
#include "effectcomposernodesmodel.h"
#include "effectcomposertr.h"
#include "effectcomposerview.h"
#include "effectshaderscodeeditor.h"
#include "effectutils.h"
#include "propertyhandler.h"
#include <modelnodeoperations.h>
#include <qmlitemnode.h>
#include <coreplugin/icore.h>
#include <coreplugin/idocument.h>
#include <coreplugin/editormanager/editormanager.h>
#include <qmldesigner/components/componentcore/theme.h>
#include <qmldesigner/components/propertyeditor/assetimageprovider.h>
#include <qmldesigner/designermcumanager.h>
#include <qmldesigner/documentmanager.h>
#include <qmldesigner/qmldesignerconstants.h>
#include <qmldesigner/qmldesignerplugin.h>
#include <qmldesignerutils/asset.h>
#include <studioquickwidget.h>
#include <qmljs/qmljsmodelmanagerinterface.h>
#include <utils/algorithm.h>
#include <utils/async.h>
#include <utils/environment.h>
#include <utils/fileutils.h>
#include <utils/qtcassert.h>
#include <QHBoxLayout>
#include <QQmlContext>
#include <QQmlEngine>
#include <QQuickItem>
#include <QTimer>
using namespace Core;
namespace EffectComposer {
constexpr char qmlEffectComposerContextId[] = "QmlDesigner::EffectComposer";
static QString propertyEditorResourcesPath()
{
#ifdef SHARE_QML_PATH
if (Utils::qtcEnvironmentVariableIsSet("LOAD_QML_FROM_SOURCE"))
return QLatin1String(SHARE_QML_PATH) + "/propertyEditorQmlSources";
#endif
return Core::ICore::resourcePath("qmldesigner/propertyEditorQmlSources").toUrlishString();
}
static QList<QmlDesigner::ModelNode> modelNodesFromMimeData(const QByteArray &mimeData,
QmlDesigner::AbstractView *view)
{
QByteArray encodedModelNodeData = mimeData;
QDataStream modelNodeStream(&encodedModelNodeData, QIODevice::ReadOnly);
QList<QmlDesigner::ModelNode> modelNodeList;
while (!modelNodeStream.atEnd()) {
qint32 internalId;
modelNodeStream >> internalId;
if (view->hasModelNodeForInternalId(internalId))
modelNodeList.append(view->modelNodeForInternalId(internalId));
}
return modelNodeList;
}
EffectComposerWidget::EffectComposerWidget(EffectComposerView *view)
: m_effectComposerModel{new EffectComposerModel(this)}
, m_effectComposerView(view)
, m_quickWidget{new StudioQuickWidget(this)}
, m_editor(Utils::makeUniqueObjectLatePtr<EffectShadersCodeEditor>(
Tr::tr("Shaders Code Editor"), Core::ICore::dialogParent()))
{
setWindowTitle(Tr::tr("Effect Composer", "Title of effect composer widget"));
setMinimumWidth(400);
setupCodeEditor();
// create the inner widget
m_quickWidget->quickWidget()->setObjectName(QmlDesigner::Constants::OBJECT_NAME_EFFECT_COMPOSER);
m_quickWidget->setResizeMode(QQuickWidget::SizeRootObjectToView);
QmlDesigner::Theme::setupTheme(m_quickWidget->engine());
m_quickWidget->engine()->addImportPath(propertyEditorResourcesPath() + "/imports");
m_quickWidget->engine()->addImportPath(EffectUtils::nodesSourcesPath() + "/common");
m_quickWidget->setClearColor(QmlDesigner::Theme::getColor(
QmlDesigner::Theme::Color::QmlDesigner_BackgroundColorDarkAlternate));
auto layout = new QHBoxLayout(this);
layout->setContentsMargins({});
layout->setSpacing(0);
layout->addWidget(m_quickWidget.data());
setStyleSheet(QmlDesigner::Theme::replaceCssColors(
Utils::FileUtils::fetchQrc(":/qmldesigner/stylesheet.css")));
QmlDesigner::QmlDesignerPlugin::trackWidgetFocusTime(this, QmlDesigner::Constants::EVENT_EFFECTCOMPOSER_TIME);
qmlRegisterSingletonInstance<QQmlPropertyMap>(
"EffectComposerPropertyData", 1, 0, "GlobalPropertyData", g_propertyData());
QString blurPath = "file:" + EffectUtils::nodesSourcesPath() + "/common/";
g_propertyData()->insert("blur_vs_path", QString(blurPath + "bluritems.vert.qsb"));
g_propertyData()->insert("blur_fs_path", QString(blurPath + "bluritems.frag.qsb"));
auto map = m_quickWidget->registerPropertyMap("EffectComposerBackend");
map->setProperties({{"effectComposerNodesModel", QVariant::fromValue(effectComposerNodesModel().data())},
{"effectComposerModel", QVariant::fromValue(m_effectComposerModel.data())},
{"rootView", QVariant::fromValue(this)}});
connect(m_effectComposerModel.data(), &EffectComposerModel::resourcesSaved,
this, [this](const QmlDesigner::TypeName &type, const Utils::FilePath &path) {
if (!m_importScan.timer) {
m_importScan.timer = new QTimer(this);
connect(m_importScan.timer, &QTimer::timeout,
this, &EffectComposerWidget::handleImportScanTimer);
}
if (m_importScan.timer->isActive() && !m_importScan.future.isFinished())
m_importScan.future.cancel();
m_importScan.counter = 0;
m_importScan.type = type;
m_importScan.path = path;
m_importScan.timer->start(100);
});
connect(m_effectComposerModel.data(), &EffectComposerModel::hasUnsavedChangesChanged,
this, [this] {
if (m_effectComposerModel->hasUnsavedChanges() && !m_effectComposerModel->currentComposition().isEmpty()) {
if (auto doc = QmlDesigner::QmlDesignerPlugin::instance()->documentManager().currentDesignDocument())
doc->setModified();
}
});
connect(m_effectComposerModel.data(), &EffectComposerModel::modelAboutToBeReset,
this, [this] {
QMetaObject::invokeMethod(quickWidget()->rootObject(), "storeExpandStates");
});
connect(
m_effectComposerModel.data(),
&EffectComposerModel::modelReset,
this,
&EffectComposerWidget::updateCodeEditorIndex);
connect(
m_effectComposerModel.data(),
&EffectComposerModel::rowsMoved,
this,
&EffectComposerWidget::updateCodeEditorIndex);
connect(Core::EditorManager::instance(), &Core::EditorManager::aboutToSave, this, [this] {
if (m_effectComposerModel->hasUnsavedChanges()) {
QString compName = m_effectComposerModel->currentComposition();
if (!compName.isEmpty())
m_effectComposerModel->saveComposition(compName);
}
});
IContext::attach(this,
Context(qmlEffectComposerContextId,
QmlDesigner::Constants::qtQuickToolsMenuContextId),
[this](const IContext::HelpCallback &callback) { contextHelp(callback); });
}
void EffectComposerWidget::contextHelp(const Core::IContext::HelpCallback &callback) const
{
Q_UNUSED(callback)
}
StudioQuickWidget *EffectComposerWidget::quickWidget() const
{
return m_quickWidget.data();
}
QPointer<EffectComposerModel> EffectComposerWidget::effectComposerModel() const
{
return m_effectComposerModel;
}
QPointer<EffectComposerNodesModel> EffectComposerWidget::effectComposerNodesModel() const
{
return m_effectComposerModel->effectComposerNodesModel();
}
void EffectComposerWidget::addEffectNode(const QString &nodeQenPath)
{
m_effectComposerModel->addNode(nodeQenPath);
if (!nodeQenPath.isEmpty()) {
using namespace QmlDesigner;
QString id = nodeQenPath.split('/').last().chopped(4).prepend('_');
QmlDesignerPlugin::emitUsageStatistics(Constants::EVENT_EFFECTCOMPOSER_NODE + id);
}
}
void EffectComposerWidget::removeEffectNodeFromLibrary(const QString &nodeName)
{
effectComposerNodesModel()->removeEffectNode(nodeName);
}
void EffectComposerWidget::focusSection(int section)
{
Q_UNUSED(section)
}
QRect EffectComposerWidget::screenRect() const
{
if (m_quickWidget && m_quickWidget->screen())
return m_quickWidget->screen()->availableGeometry();
return {};
}
QPoint EffectComposerWidget::globalPos(const QPoint &point) const
{
if (m_quickWidget)
return m_quickWidget->mapToGlobal(point);
return point;
}
QString EffectComposerWidget::uniformDefaultImage(const QString &nodeName, const QString &uniformName) const
{
return effectComposerNodesModel()->defaultImagesForNode(nodeName).value(uniformName);
}
QString EffectComposerWidget::imagesPath() const
{
return Core::ICore::resourcePath("qmldesigner/effectComposerNodes/images").toUrlishString();
}
bool EffectComposerWidget::isEffectAsset(const QUrl &url) const
{
return QmlDesigner::Asset(url.toLocalFile()).isEffect();
}
void EffectComposerWidget::dropAsset(const QUrl &url)
{
if (isEffectAsset(url))
openComposition(url.toLocalFile());
}
bool EffectComposerWidget::isEffectNode(const QByteArray &mimeData) const
{
QList<QmlDesigner::ModelNode> nodes = modelNodesFromMimeData(mimeData, m_effectComposerView);
if (!nodes.isEmpty())
return QmlDesigner::QmlItemNode(nodes.last()).isEffectItem();
return false;
}
void EffectComposerWidget::dropNode(const QByteArray &mimeData)
{
QList<QmlDesigner::ModelNode> nodes = modelNodesFromMimeData(mimeData, m_effectComposerView);
if (!nodes.isEmpty() && QmlDesigner::QmlItemNode(nodes.last()).isEffectItem()) {
Utils::FilePath path = QmlDesigner::ModelNodeOperations::findEffectFile(nodes.last());
openComposition(path.toFSPathString());
}
}
void EffectComposerWidget::updateCanBeAdded()
{
effectComposerNodesModel()->updateCanBeAdded(m_effectComposerModel->uniformNames(),
m_effectComposerModel->nodeNames());
}
bool EffectComposerWidget::isMCUProject() const
{
return QmlDesigner::DesignerMcuManager::instance().isMCUProject();
}
void EffectComposerWidget::openCodeEditor(int idx)
{
ShaderEditorData *editorData = [&]() -> ShaderEditorData * {
auto creatorFunction
= std::bind_front(&EffectShadersCodeEditor::createEditorData, m_editor.get());
if (idx == MAIN_CODE_EDITOR_INDEX)
return effectComposerModel()->editorData(creatorFunction);
else if (auto node = effectComposerModel()->nodeAt(idx))
return node->editorData(creatorFunction);
return nullptr;
}();
if (!editorData)
return;
m_editor->setupShader(editorData);
m_editor->showWidget();
updateCodeEditorIndex();
}
void EffectComposerWidget::openNearestAvailableCodeEditor(int idx)
{
int nearestIdx = idx;
if (int rows = m_effectComposerModel->rowCount(); nearestIdx >= rows)
nearestIdx = rows - 1;
while (nearestIdx >= 0) {
CompositionNode *node = m_effectComposerModel->nodeAt(nearestIdx);
if (!node->isDependency())
return openCodeEditor(nearestIdx);
--nearestIdx;
}
openCodeEditor(MAIN_CODE_EDITOR_INDEX);
}
QSize EffectComposerWidget::sizeHint() const
{
return {420, 420};
}
void EffectComposerWidget::setupCodeEditor()
{
EffectShadersCodeEditor *editor = m_editor.get();
EffectComposerModel *model = m_effectComposerModel.get();
editor->setCompositionsModel(model);
connect(
editor,
&EffectShadersCodeEditor::liveUpdateChanged,
model,
&EffectComposerModel::setLiveUpdateMode);
connect(
editor,
&EffectShadersCodeEditor::rebakeRequested,
model,
&EffectComposerModel::startRebakeTimer);
connect(
editor,
&EffectShadersCodeEditor::openedChanged,
this,
&EffectComposerWidget::updateCodeEditorIndex);
connect(
model,
&EffectComposerModel::currentCompositionChanged,
editor,
&EffectShadersCodeEditor::close);
connect(
editor,
&EffectShadersCodeEditor::requestToOpenNode,
this,
&EffectComposerWidget::openCodeEditor);
model->setLiveUpdateMode(editor->liveUpdate());
}
QString EffectComposerWidget::qmlSourcesPath()
{
#ifdef SHARE_QML_PATH
if (Utils::qtcEnvironmentVariableIsSet("LOAD_QML_FROM_SOURCE"))
return QLatin1String(SHARE_QML_PATH) + "/effectComposerQmlSources";
#endif
return Core::ICore::resourcePath("qmldesigner/effectComposerQmlSources").toUrlishString();
}
void EffectComposerWidget::initView()
{
auto ctxObj = new EffectComposerContextObject(m_quickWidget->rootContext());
m_quickWidget->rootContext()->setContextObject(ctxObj);
m_backendModelNode.setup(m_effectComposerView->rootModelNode());
m_quickWidget->rootContext()->setContextProperty("anchorBackend", &m_backendAnchorBinding);
m_quickWidget->rootContext()->setContextProperty("modelNodeBackend", &m_backendModelNode);
m_quickWidget->rootContext()->setContextProperty("activeDragSuffix", "");
m_quickWidget->engine()->addImageProvider("qmldesigner_thumbnails",
new QmlDesigner::AssetImageProvider(
QmlDesigner::QmlDesignerPlugin::imageCache()));
// init the first load of the QML UI elements
reloadQmlSource();
}
void EffectComposerWidget::openComposition(const QString &path)
{
m_compositionPath = path;
if (effectComposerModel()->hasUnsavedChanges())
QMetaObject::invokeMethod(quickWidget()->rootObject(), "promptToSaveBeforeOpen");
else
doOpenComposition();
}
void EffectComposerWidget::doOpenComposition()
{
effectComposerModel()->openComposition(m_compositionPath);
}
void EffectComposerWidget::reloadQmlSource()
{
const QString effectComposerQmlPath = qmlSourcesPath() + "/EffectComposer.qml";
QTC_ASSERT(QFileInfo::exists(effectComposerQmlPath), return);
m_quickWidget->setSource(QUrl::fromLocalFile(effectComposerQmlPath));
}
void EffectComposerWidget::handleImportScanTimer()
{
++m_importScan.counter;
if (m_importScan.counter == 1) {
// Rescan the effect import to update code model
auto modelManager = QmlJS::ModelManagerInterface::instance();
if (modelManager) {
QmlJS::PathsAndLanguages pathToScan;
pathToScan.maybeInsert(m_importScan.path);
m_importScan.future = ::Utils::asyncRun(&QmlJS::ModelManagerInterface::importScan,
modelManager->workingCopy(),
pathToScan, modelManager, true, true, true);
}
} else if (m_importScan.counter < 100) {
// We have to wait a while to ensure qmljs detects new files and updates its
// internal model. Then we force amend on rewriter to trigger qmljs snapshot update.
if (m_importScan.future.isCanceled() || m_importScan.future.isFinished())
m_importScan.counter = 100; // skip the timeout step
} else if (m_importScan.counter == 100) {
// Scanning is taking too long, abort
m_importScan.future.cancel();
m_importScan.timer->stop();
m_importScan.counter = 0;
} else if (m_importScan.counter == 101) {
if (m_effectComposerView->model() && m_effectComposerView->model()->rewriterView()) {
QmlDesigner::QmlDesignerPlugin::instance()->documentManager().resetPossibleImports();
m_effectComposerView->model()->rewriterView()->forceAmend();
}
} else if (m_importScan.counter == 102) {
if (m_effectComposerView->model()) {
// If type is in use, we have to reset QML Puppet to update 2D view
if (!m_effectComposerView->allModelNodesOfType(
m_effectComposerView->model()->metaInfo(m_importScan.type)).isEmpty()) {
m_effectComposerView->resetPuppet();
}
}
} else if (m_importScan.counter >= 103) {
// Refresh property view by resetting selection if any selected node is of updated type
if (m_effectComposerView->model() && m_effectComposerView->hasSelectedModelNodes()) {
const auto nodes = m_effectComposerView->selectedModelNodes();
QmlDesigner::MetaInfoType metaType
= m_effectComposerView->model()->metaInfo(m_importScan.type).type();
bool match = false;
for (const QmlDesigner::ModelNode &node : nodes) {
if (node.metaInfo().type() == metaType) {
match = true;
break;
}
}
if (match) {
m_effectComposerView->clearSelectedModelNodes();
m_effectComposerView->setSelectedModelNodes(nodes);
}
}
m_importScan.timer->stop();
m_importScan.counter = 0;
}
}
void EffectComposerWidget::updateCodeEditorIndex()
{
if (m_editor->isOpened()) {
if (auto editorData = m_editor->currentEditorData())
m_effectComposerModel->updateCodeEditorIndex(editorData);
else
openNearestAvailableCodeEditor(m_effectComposerModel->codeEditorIndex());
} else {
m_effectComposerModel->updateCodeEditorIndex(nullptr);
}
}
} // namespace EffectComposer
|