js: start work for showing 3D uis

Author: jcelerier

src/plugins/score-plugin-js/JS/JSProcessModel.cpp

@@ -27,6 +27,7 @@
 #include <QFileInfo>
 #include <QFileSystemWatcher>
 #include <QQmlComponent>
+#include <QQuickWindow>
 
 #include <wobjectimpl.h>
 
@@ -76,6 +77,76 @@ Script {
   {
     setScript(data);
   }
+
+  setUiScript(R"_(import QtQuick
+import QtQuick3D
+
+    View3D {
+        id: view
+        anchors.fill: parent
+
+        //! [environment]
+        environment: SceneEnvironment {
+            clearColor: "skyblue"
+            backgroundMode: SceneEnvironment.Color
+        }
+        //! [environment]
+
+        //! [camera]
+        PerspectiveCamera {
+            position: Qt.vector3d(0, 200, 300)
+            eulerRotation.x: -30
+        }
+        //! [camera]
+
+        //! [light]
+        DirectionalLight {
+            eulerRotation.x: -30
+            eulerRotation.y: -70
+        }
+        //! [light]
+
+        //! [objects]
+        Model {
+            position: Qt.vector3d(0, -200, 0)
+            source: "#Cylinder"
+            scale: Qt.vector3d(2, 0.2, 1)
+            materials: [ DefaultMaterial {
+                    diffuseColor: "red"
+                }
+            ]
+        }
+
+        Model {
+            position: Qt.vector3d(0, 150, 0)
+            source: "#Sphere"
+
+            materials: [ DefaultMaterial {
+                    diffuseColor: "blue"
+                }
+            ]
+
+            //! [animation]
+            SequentialAnimation on y {
+                loops: Animation.Infinite
+                NumberAnimation {
+                    duration: 3000
+                    to: -150
+                    from: 150
+                    easing.type:Easing.InQuad
+                }
+                NumberAnimation {
+                    duration: 3000
+                    to: 150
+                    from: -150
+                    easing.type:Easing.OutQuad
+                }
+            }
+            //! [animation]
+        }
+        //! [objects]
+    }
+)_");
   metadata().setInstanceName(*this);
 }
 
@@ -100,11 +171,49 @@ bool ProcessModel::validate(const QString& script) const noexcept
   }
 }
 
+[[nodiscard]] Process::ScriptChangeResult
+ProcessModel::setUiScript(const QString& script)
+{
+  Process::ScriptChangeResult res;
+  const auto trimmed = script.trimmed();
+  const QByteArray data = trimmed.toUtf8();
+
+  if(res = setUiQmlData(data); !res.valid)
+    return res;
+
+  m_ui_script = script;
+  uiScriptChanged(script);
+  res.valid = true;
+  return res;
+}
+
 QString ProcessModel::effect() const noexcept
 {
   return m_qmlData;
 }
 
+Process::ScriptChangeResult ProcessModel::setUiQmlData(const QByteArray& data)
+{
+  Process::ScriptChangeResult res;
+  if(!data.contains("import QtQuick"))
+    return res;
+
+  auto script = m_cache.getUi(*this, data);
+  if(!script)
+    return res;
+
+  m_ui_qmlData = data;
+  res.valid = true;
+  // FIXME signal?
+
+  auto win = new QQuickWindow;
+  win->setWidth(640);
+  win->setHeight(640);
+  script->setParentItem(win->contentItem());
+  win->show();
+  return res;
+}
+
 [[nodiscard]] Process::ScriptChangeResult ProcessModel::setScript(const QString& script)
 {
   Process::ScriptChangeResult res;
@@ -132,7 +241,7 @@ QString ProcessModel::effect() const noexcept
 Process::ScriptChangeResult ProcessModel::setQmlData(const QByteArray& data, bool isFile)
 {
   Process::ScriptChangeResult res;
-  if(!isFile && !data.startsWith("import"))
+  if(!isFile && !data.contains("import "))
     return res;
 
   auto script = m_cache.get(*this, data, isFile);
@@ -199,6 +308,11 @@ Script* ProcessModel::currentObject() const noexcept
   return m_cache.tryGet(m_qmlData, m_isFile);
 }
 
+QQuickItem* ProcessModel::currentUI() const noexcept
+{
+  return m_cache.tryGet(m_ui_qmlData);
+}
+
 bool ProcessModel::isGpu() const noexcept
 {
 #if defined(SCORE_HAS_GPU_JS)
@@ -238,6 +352,19 @@ Script* ComponentCache::tryGet(const QByteArray& str, bool isFile) const noexcep
   }
 }
 
+QQuickItem* ComponentCache::tryGet(const QByteArray& str) const noexcept
+{
+  auto it = ossia::find_if(m_map, [&](const auto& k) { return k.key == str; });
+  if(it != m_map.end())
+  {
+    return it->item.get();
+  }
+  else
+  {
+    return nullptr;
+  }
+}
+
 static std::once_flag qml_dummy_engine_setup{};
 Script* ComponentCache::get(
     const ProcessModel& process, const QByteArray& str, bool isFile) noexcept
@@ -312,6 +439,58 @@ Script* ComponentCache::get(
     }
   }
 }
+QQuickItem*
+ComponentCache::getUi(const ProcessModel& process, const QByteArray& str) noexcept
+{
+  auto it = ossia::find_if(m_map, [&](const auto& k) { return k.key == str; });
+  if(it != m_map.end())
+  {
+    return it->item.get();
+  }
+  else
+  {
+    static QQmlEngine dummyEngine;
+    std::call_once(qml_dummy_engine_setup, [] { setupEngineImportPaths(dummyEngine); });
+
+    auto comp = std::make_unique<QQmlComponent>(&dummyEngine);
+    {
+      auto& lib = score::AppContext().settings<Library::Settings::Model>();
+      // FIXME QTBUG-107204
+      QString path = lib.getDefaultLibraryPath() + QDir::separator() + "Scripts"
+                     + QDir::separator() + "include" + QDir::separator() + "Script.qml";
+      comp->setData(str, QUrl::fromLocalFile(path));
+    }
+    const auto& errs = comp->errors();
+    if(!errs.empty())
+    {
+      const auto& err = errs.first();
+      qDebug() << err.line() << err.toString();
+      auto str = err.toString();
+      str.remove("<Unknown File>:");
+      process.errorMessage(err.line(), str);
+      return nullptr;
+    }
+
+    auto obj = comp->create();
+    auto script = qobject_cast<QQuickItem*>(obj);
+    if(script)
+    {
+      if(m_map.size() > 5)
+        m_map.erase(m_map.begin());
+
+      m_map.emplace_back(
+          Cache{str, std::move(comp), {}, std::unique_ptr<QQuickItem>(script)});
+      return script;
+    }
+    else
+    {
+      process.errorMessage(0, "The component must be of type Script");
+      if(obj)
+        delete obj;
+      return nullptr;
+    }
+  }
+}
 
 void ProcessModel::loadPreset(const Process::Preset& preset)
 {

src/plugins/score-plugin-js/JS/JSProcessModel.hpp

@@ -25,7 +25,9 @@ struct ComponentCache
 public:
   JS::Script*
   get(const JS::ProcessModel& process, const QByteArray& str, bool isFile) noexcept;
+  QQuickItem* getUi(const JS::ProcessModel& process, const QByteArray& str) noexcept;
   JS::Script* tryGet(const QByteArray& str, bool isFile) const noexcept;
+  QQuickItem* tryGet(const QByteArray& str) const noexcept;
   ComponentCache();
   ~ComponentCache();
 
@@ -35,6 +37,7 @@ struct ComponentCache
     QByteArray key;
     std::unique_ptr<QQmlComponent> component{};
     std::unique_ptr<JS::Script> object{};
+    std::unique_ptr<QQuickItem> item{};
   };
   std::vector<Cache> m_map;
 };
@@ -60,10 +63,14 @@ class SCORE_PLUGIN_JS_EXPORT ProcessModel final : public Process::ProcessModel
 
   [[nodiscard]] Process::ScriptChangeResult setScript(const QString& script);
   const QString& script() const noexcept { return m_script; }
-
   const QByteArray& qmlData() const noexcept { return m_qmlData; }
 
+  [[nodiscard]] Process::ScriptChangeResult setUiScript(const QString& script);
+  const QString& uiScript() const noexcept { return m_ui_script; }
+  const QByteArray& uiQmlData() const noexcept { return m_ui_qmlData; }
+
   JS::Script* currentObject() const noexcept;
+  QQuickItem* currentUI() const noexcept;
   bool isGpu() const noexcept;
 
   ~ProcessModel() override;
@@ -73,17 +80,24 @@ class SCORE_PLUGIN_JS_EXPORT ProcessModel final : public Process::ProcessModel
       W_SIGNAL(errorMessage, arg_1, arg_2);
   void scriptOk() W_SIGNAL(scriptOk);
   void scriptChanged(const QString& arg_1) W_SIGNAL(scriptChanged, arg_1);
+  void uiScriptChanged(const QString& arg_1) W_SIGNAL(uiScriptChanged, arg_1);
   void programChanged() W_SIGNAL(programChanged);
 
   PROPERTY(QString, script READ script WRITE setScript NOTIFY scriptChanged)
+  PROPERTY(QString, uiScript READ uiScript WRITE setUiScript NOTIFY uiScriptChanged)
 private:
   QString effect() const noexcept override;
   void loadPreset(const Process::Preset& preset) override;
   Process::Preset savePreset() const noexcept override;
   Process::ScriptChangeResult setQmlData(const QByteArray&, bool isFile);
+  Process::ScriptChangeResult setUiQmlData(const QByteArray&);
 
   QString m_script;
   QByteArray m_qmlData;
+
+  QString m_ui_script;
+  QByteArray m_ui_qmlData;
+
   mutable ComponentCache m_cache;
   bool m_isFile{};
 };