ornament intervals

Author: XiaoMigros

src/engraving/api/v1/apitypes.h

@@ -1003,6 +1003,58 @@ enum class OrnamentShowAccidental {
 };
 Q_ENUM_NS(OrnamentShowAccidental);
 
+//---------------------------------------------------------
+//   OrnamentIntervalWrapper
+///   Ornament interval wrapper object available to QML plugins.
+///   Use PluginAPI::PluginAPI::ornamentInterval to create a
+///   fraction for usage within your plugin:
+///   \code
+///   var interval = ornamentInterval(IntervalStep.SECOND, IntervalType.MAJOR);
+///   \endcode
+//---------------------------------------------------------
+
+class OrnamentIntervalWrapper : public QObject
+{
+    Q_OBJECT
+    /// Interval step
+    Q_PROPERTY(IntervalStep step READ step)
+    /// Interval type
+    Q_PROPERTY(IntervalType type READ type)
+    /// Whether this interval is perfect
+    Q_PROPERTY(bool isPerfect READ isPerfect)
+
+    mu::engraving::OrnamentInterval o;
+
+    /// \cond MS_INTERNAL
+public slots:
+    void setOrnamentInterval(engraving::OrnamentInterval m_o) { o = m_o; }
+
+public:
+    OrnamentIntervalWrapper() = default;
+    OrnamentIntervalWrapper(const mu::engraving::OrnamentInterval& m_o)
+        : o(m_o) {}
+
+    mu::engraving::OrnamentInterval ornamentInterval() const { return o; }
+    IntervalStep step() const { return IntervalStep(o.step); }
+    IntervalType type() const { return IntervalType(o.type); }
+    bool isPerfect() const    { return o.isPerfect(); }
+    /// \endcond
+};
+
+//---------------------------------------------------------
+//   wrap
+///   \cond PLUGIN_API \private \endcond
+///   \relates OrnamentIntervalWrapper
+//---------------------------------------------------------
+
+inline OrnamentIntervalWrapper* wrap(mu::engraving::OrnamentInterval o)
+{
+    OrnamentIntervalWrapper* w = new OrnamentIntervalWrapper(o);
+    // All wrapper objects should belong to JavaScript code.
+    QQmlEngine::setObjectOwnership(w, QQmlEngine::JavaScriptOwnership);
+    return w;
+}
+
 enum class PartialSpannerDirection {
     NONE     = int(mu::engraving::PartialSpannerDirection::NONE),
     INCOMING = int(mu::engraving::PartialSpannerDirection::INCOMING),

src/engraving/api/v1/qmlpluginapi.cpp

@@ -27,8 +27,10 @@
 
 #include "engraving/compat/scoreaccess.h"
 #include "engraving/dom/factory.h"
+#include "engraving/types/types.h"
 
 // api
+#include "apitypes.h"
 #include "engravingapiv1.h"
 #include "score.h"
 #include "instrument.h"
@@ -541,3 +543,20 @@ qreal PluginAPI::mscoreDPI() const
 {
     return engraving::DPI;
 }
+
+OrnamentIntervalWrapper* PluginAPI::defaultOrnamentInterval() const
+{
+    return wrap(mu::engraving::DEFAULT_ORNAMENT_INTERVAL);
+}
+
+//---------------------------------------------------------
+//   PluginAPI::ornamentInterval
+///  Creates a new ornament interval with the given step and type
+//---------------------------------------------------------
+
+OrnamentIntervalWrapper* PluginAPI::ornamentInterval(apiv1::IntervalStep step, apiv1::IntervalType type) const
+{
+    return wrap(mu::engraving::OrnamentInterval(step, type));
+}
+
+

src/engraving/api/v1/qmlpluginapi.h

@@ -48,6 +48,7 @@ class EngravingItem;
 namespace mu::engraving::apiv1 {
 class EngravingItem;
 class FractionWrapper;
+class OrnamentIntervalWrapper;
 class MsProcess;
 class Score;
 
@@ -482,6 +483,8 @@ class PluginAPI : public QQuickItem, public muse::extensions::apiv1::IPluginApiV
 
     Q_INVOKABLE apiv1::FractionWrapper* fraction(int numerator, int denominator) const;
 
+    Q_INVOKABLE apiv1::OrnamentIntervalWrapper* ornamentInterval(apiv1::IntervalStep step, apiv1::IntervalType type) const;
+
     Q_INVOKABLE void quit();
 
     QString pluginType() const;
@@ -517,6 +520,7 @@ class PluginAPI : public QQuickItem, public muse::extensions::apiv1::IPluginApiV
     int mscoreMinorVersion() const;
     int mscoreUpdateVersion() const;
     qreal mscoreDPI() const;
+    OrnamentIntervalWrapper* defaultOrnamentInterval() const;
 
 private:
     mu::engraving::Score* currentScore() const;