Add Volta class to plugin API

Author: simonchatts

src/engraving/api/v1/apitypes.h

@@ -38,6 +38,7 @@
 #include "engraving/dom/timesig.h"
 #include "engraving/dom/tremolobar.h"
 #include "engraving/dom/tripletfeel.h"
+#include "engraving/dom/volta.h"
 #include "engraving/types/types.h"
 #include "engraving/rendering/layoutoptions.h"
 
@@ -1392,6 +1393,12 @@ enum class SpannerSegmentType {
 };
 Q_ENUM_NS(SpannerSegmentType);
 
+enum class VoltaType {
+    OPEN   = int(mu::engraving::Volta::Type::OPEN),
+    CLOSED = int(mu::engraving::Volta::Type::CLOSED),
+};
+Q_ENUM_NS(VoltaType);
+
 enum class TiePlacement {
     AUTO    = int(mu::engraving::TiePlacement::AUTO),
     INSIDE  = int(mu::engraving::TiePlacement::INSIDE),

src/engraving/api/v1/elements.cpp

@@ -22,6 +22,8 @@
 
 #include "elements.h"
 
+#include <QList>
+
 #include "engraving/dom/chord.h"
 #include "engraving/dom/guitarbend.h"
 #include "engraving/dom/measure.h"
@@ -649,6 +651,76 @@ bool Staff::isVoiceVisible(int voice)
     return staff()->isVoiceVisible(voice);
 }
 
+QVariantList Volta::endings() const
+{
+    QVariantList result;
+    const auto& endings = volta()->endings();
+    result.reserve(static_cast<int>(endings.size()));
+    for (int ending : endings) {
+        result.append(ending);
+    }
+    return result;
+}
+
+void Volta::setEndings(const QVariantList& endingsList)
+{
+    QList<int> endings;
+    endings.reserve(endingsList.size());
+    for (const QVariant& value : endingsList) {
+        bool ok = false;
+        const int ending = value.toInt(&ok);
+        if (ok) {
+            endings.append(ending);
+        }
+    }
+
+    set(mu::engraving::Pid::VOLTA_ENDING, QVariant::fromValue(endings));
+}
+
+QString Volta::text() const
+{
+    return volta()->text().toQString();
+}
+
+void Volta::setText(const QString& text)
+{
+    set(mu::engraving::Pid::BEGIN_TEXT, text);
+}
+
+int Volta::voltaType() const
+{
+    return static_cast<int>(volta()->voltaType());
+}
+
+void Volta::setVoltaType(int type)
+{
+    using VoltaType = mu::engraving::Volta::Type;
+    const bool valid = type == int(VoltaType::OPEN) || type == int(VoltaType::CLOSED);
+    IF_ASSERT_FAILED(valid) {
+        return;
+    }
+
+    const mu::engraving::HookType hook = (type == int(VoltaType::CLOSED))
+            ? mu::engraving::HookType::HOOK_90
+            : mu::engraving::HookType::NONE;
+    set(mu::engraving::Pid::END_HOOK_TYPE, static_cast<int>(hook));
+}
+
+bool Volta::hasEnding(int repeat) const
+{
+    return volta()->hasEnding(repeat);
+}
+
+int Volta::firstEnding() const
+{
+    return volta()->firstEnding();
+}
+
+int Volta::lastEnding() const
+{
+    return volta()->lastEnding();
+}
+
 //---------------------------------------------------------
 //   wrap
 ///   \cond PLUGIN_API \private \endcond
@@ -679,6 +751,7 @@ EngravingItem* mu::engraving::apiv1::wrap(mu::engraving::EngravingItem* e, Owner
     API_WRAP(System)
     API_WRAP(Page)
     API_WRAP(SpannerSegment)
+    API_WRAP(Volta)
     API_WRAP(Spanner)
     return wrap<EngravingItem>(e, own);
 

src/engraving/api/v1/elements.h

@@ -50,6 +50,7 @@
 #include "engraving/dom/tremolotwochord.h"
 #include "engraving/dom/tuplet.h"
 #include "engraving/dom/tie.h"
+#include "engraving/dom/volta.h"
 #include "engraving/dom/accidental.h"
 
 #include "engraving/editing/undo.h"
@@ -67,6 +68,7 @@ class Spanner;
 class Staff;
 class System;
 class Tie;
+class Volta;
 class Tuplet;
 class Measure;
 class Beam;
@@ -2356,6 +2358,46 @@ class Tie : public Spanner
     /// \endcond
 };
 
+//---------------------------------------------------------
+//   Volta
+///  Provides access to internal mu::engraving::Volta objects.
+///  \since MuseScore 4.7
+//---------------------------------------------------------
+
+class Volta : public Spanner
+{
+    Q_OBJECT
+    /// The play-through numbers assigned to this volta (e.g. [1, 2]).
+    Q_PROPERTY(QVariantList endings READ endings WRITE setEndings)
+    /// The displayed text for this volta.
+    Q_PROPERTY(QString text READ text WRITE setText)
+    /// The volta drawing style, one of PluginAPI::VoltaType values.
+    Q_PROPERTY(int voltaType READ voltaType WRITE setVoltaType)
+
+public:
+    /// \cond MS_INTERNAL
+    Volta(mu::engraving::Volta* volta, Ownership own = Ownership::PLUGIN)
+        : Spanner(volta, own) {}
+
+    mu::engraving::Volta* volta() { return toVolta(e); }
+    const mu::engraving::Volta* volta() const { return toVolta(e); }
+
+    QVariantList endings() const;
+    void setEndings(const QVariantList& endings);
+    QString text() const;
+    void setText(const QString& text);
+    int voltaType() const;
+    void setVoltaType(int type);
+
+    /// Returns whether this volta triggers on the provided repeat count.
+    Q_INVOKABLE bool hasEnding(int repeat) const;
+    /// Returns the smallest ending number assigned to this volta.
+    Q_INVOKABLE int firstEnding() const;
+    /// Returns the largest ending number assigned to this volta.
+    Q_INVOKABLE int lastEnding() const;
+    /// \endcond
+};
+
 #undef API_PROPERTY
 #undef API_PROPERTY_T
 #undef API_PROPERTY_READ_ONLY

src/engraving/api/v1/engravingapiv1.h

@@ -127,6 +127,7 @@ class EngravingApiV1 : public muse::api::ApiObject, public muse::extensions::api
     Q_PROPERTY(apiv1::Enum * LyricsDashSystemStart READ lyricsDashSystemStartEnum CONSTANT)
     Q_PROPERTY(apiv1::Enum * NoteLineEndPlacement READ noteLineEndPlacementEnum CONSTANT)
     Q_PROPERTY(apiv1::Enum * SpannerSegmentType READ spannerSegmentTypeEnum CONSTANT)
+    Q_PROPERTY(apiv1::Enum * VoltaType READ voltaTypeEnum CONSTANT)
     Q_PROPERTY(apiv1::Enum * TiePlacement READ tiePlacementEnum CONSTANT)
     Q_PROPERTY(apiv1::Enum * TieDotsPlacement READ tieDotsPlacementEnum CONSTANT)
     Q_PROPERTY(apiv1::Enum * TimeSigType READ timeSigTypeEnum CONSTANT)
@@ -250,6 +251,7 @@ class EngravingApiV1 : public muse::api::ApiObject, public muse::extensions::api
     apiv1::Enum* lyricsDashSystemStartEnum() const { return api()->get_lyricsDashSystemStartEnum(); }
     apiv1::Enum* noteLineEndPlacementEnum() const { return api()->get_noteLineEndPlacementEnum(); }
     apiv1::Enum* spannerSegmentTypeEnum() const { return api()->get_spannerSegmentTypeEnum(); }
+    apiv1::Enum* voltaTypeEnum() const { return api()->get_voltaTypeEnum(); }
     apiv1::Enum* tiePlacementEnum() const { return api()->get_tiePlacementEnum(); }
     apiv1::Enum* tieDotsPlacementEnum() const { return api()->get_tieDotsPlacementEnum(); }
     apiv1::Enum* timeSigTypeEnum() const { return api()->get_timeSigTypeEnum(); }

src/engraving/api/v1/qmlpluginapi.cpp

@@ -147,6 +147,7 @@ Enum* PluginAPI::repeatPlayCountPresetEnum = nullptr;
 Enum* PluginAPI::measureNumberPlacementEnum = nullptr;
 Enum* PluginAPI::symIdEnum = nullptr;
 Enum* PluginAPI::cursorEnum = nullptr;
+Enum* PluginAPI::voltaTypeEnum = nullptr;
 
 //---------------------------------------------------------
 //   PluginAPI::registerQmlTypes
@@ -185,6 +186,7 @@ void PluginAPI::registerQmlTypes()
     qmlRegisterAnonymousType<Excerpt>("MuseScore", 3);
     qmlRegisterAnonymousType<Selection>("MuseScore", 3);
     qmlRegisterAnonymousType<Tie>("MuseScore", 3);
+    qmlRegisterAnonymousType<Volta>("MuseScore", 3);
     qmlRegisterAnonymousType<Drumset>("MuseScore", 3);
     qmlRegisterAnonymousType<MeasureBase>("MuseScore", 3);
     qmlRegisterAnonymousType<System>("MuseScore", 3);

src/engraving/api/v1/qmlpluginapi.h

@@ -385,6 +385,9 @@ class PluginAPI : public QQuickItem, public muse::extensions::apiv1::IPluginApiV
     /// Contains mu::engraving::SpannerSegmentType enumeration values
     /// \since MuseScore 4.6
     DECLARE_API_ENUM(SpannerSegmentType, spannerSegmentTypeEnum, mu::engraving::apiv1::enums::SpannerSegmentType)
+    /// Contains mu::engraving::Volta::Type enumeration values
+    /// \since MuseScore 4.7
+    DECLARE_API_ENUM(VoltaType, voltaTypeEnum, mu::engraving::apiv1::enums::VoltaType)
     /// Contains mu::engraving::TiePlacement enumeration values
     /// \since MuseScore 4.6
     DECLARE_API_ENUM(TiePlacement, tiePlacementEnum, mu::engraving::apiv1::enums::TiePlacement)