Fix arpeggio cross stave collisions #19734

miiizen · 2023-10-16T16:39:37Z

Resolves: #19668
Resolves: #14359

Arpeggios can now span from a voice to any other voice.
Accidentals across all staves the arpeggio spans are taken into consideration for proper placement with no collisions.
Slurs do not collide with arpeggios except for outside slurs ending on the arpeggio start or end chord.
The top and bottom handle can be dragged to change the start/end position of the arpeggio
Deleting the top note an arpeggio is attached to moves the arpeggio down to the next available chord
Arpeggio handles are shown on drop from palette

I signed the CLA
The title of the PR describes the problem it addresses
Each commit's message describes its purpose and effects, and references the issue it resolves
If changes are extensive, there is a sequence of easily reviewable commits
The code in the PR follows the coding rules
There are no unnecessary changes
The code compiles and runs on my machine, preferably after each commit individually
I created a unit test or vtest to verify the changes I made (if applicable)

cbjeukendrup · 2023-11-03T11:22:49Z

src/engraving/rw/read400/tread.cpp

@@ -1771,7 +1771,8 @@ void TRead::read(Arpeggio* a, XmlReader& e, ReadContext& ctx)
        } else if (tag == "userLen2") {
            a->setUserLen2(e.readDouble() * a->spatium());
        } else if (tag == "span") {
-            a->setSpan(e.readInt());
+            // Span now refers to number of voices spanned, not staves
+            a->setSpan((e.readInt() - 1) * VOICES + 1);


It seems that this way, the arpeggio will only span the first voice of the bottom staff. Would it make sense to span all voices by default? Or is spanning only the first voice the closest to the old behaviour?

Arpeggios used to span to the same voice on the bottom stave as the arpeggio was added to on the upper stave. This preserves this when opening old scores, so an arpeggio added to voice 1 will span to voice 1 on the bottom staff, an arpeggio on voice 2 will span to voice 2 etc.

src/engraving/dom/arpeggio.cpp

src/engraving/dom/arpeggio.h

src/engraving/rendering/dev/arpeggiolayout.cpp

src/engraving/dom/arpeggio.cpp

cbjeukendrup · 2023-11-04T21:08:01Z

src/engraving/rendering/dev/arpeggiolayout.cpp

+            bool aboveStart = chord->vStaffIdx() <= item->vStaffIdx() && chord->line() < item->chord()->line();
+            bool belowEnd = chord->vStaffIdx() >= endChord->vStaffIdx() && chord->line() > endChord->line();


Don't you want to use upLine and downLine explicitly, instead of just line which decides based on the stem direction (which seems irrelevant to me here)?

Also, shouldn't the logic be like this:

Suggested change

bool aboveStart = chord->vStaffIdx() <= item->vStaffIdx() && chord->line() < item->chord()->line();

bool belowEnd = chord->vStaffIdx() >= endChord->vStaffIdx() && chord->line() > endChord->line();

bool aboveStart = chord->vStaffIdx() < item->vStaffIdx() ||(chord->vStaffIdx() == item->vStaffIdx() && chord->line() < item->chord()->line());

bool belowEnd = chord->vStaffIdx() > endChord->vStaffIdx() || (chord->vStaffIdx() == endChord->vStaffIdx() && chord->line() > endChord->line());

which might be written more concisely as

Suggested change

bool aboveStart = chord->vStaffIdx() <= item->vStaffIdx() && chord->line() < item->chord()->line();

bool belowEnd = chord->vStaffIdx() >= endChord->vStaffIdx() && chord->line() > endChord->line();

bool aboveStart = std::make_pair(chord->vStaffIdx(), chord->line()) < std::make_pair(item->vStaffIdx(), item->chord()->line());

bool belowEnd = std::make_pair(chord->vStaffIdx(), chord->line()) > std::make_pair(endChord->vStaffIdx(), endChord->line());

cbjeukendrup · 2023-11-04T21:09:47Z

src/engraving/rendering/dev/chordlayout.cpp

+        bool aboveStart = item->vStaffIdx() <= spanArp->vStaffIdx() && item->line() < spanArp->chord()->line();
+        bool belowEnd = item->vStaffIdx() >= endChord->vStaffIdx() && item->line() > endChord->line();


Same as above about upLine/downLine vs line

cbjeukendrup · 2023-11-10T13:08:00Z

src/engraving/dom/chord.cpp

+        Chord* chord = toChord(linkedObject);
+        Score* score = chord->score();
+        if (score) {
+            score->undo(new ChangeSpanArpeggio(chord, a));


Instead of a itself, shouldn't we use the Arpeggio that is linked to a in the same score as chord?

cbjeukendrup · 2023-11-10T13:10:50Z

src/engraving/rendering/dev/arpeggiolayout.cpp

+//   insetDistance
+//---------------------------------------------------------
+
+double ArpeggioLayout::insetDistance(Arpeggio* item, LayoutContext& ctx, double mag_, Chord* chord, std::vector<Accidental*> accidentals)


const std::vector<Accidental*>&

cbjeukendrup · 2023-11-10T14:01:24Z

src/engraving/rendering/dev/scorerenderer.cpp

@@ -96,7 +96,7 @@ void ScoreRenderer::layoutText1(TextBase* item, bool base)
 void ScoreRenderer::layoutOnEdit(Arpeggio* item)


Looks like this method doesn't do much anymore, can we get rid of it?

cbjeukendrup · 2023-11-10T16:18:52Z

src/engraving/rendering/dev/chordlayout.cpp

+                if (downnote->line() > firstLedgerBelow || upnote->line() < firstLedgerAbove) {
+                    gapSize = arpeggioLedgerDistance + ctx.conf().styleS(Sid::ledgerLineLength).val() * item->spatium();
+                }
+            } else if (leftNote->line() > firstLedgerBelow || leftNote->line() < firstLedgerAbove) {


Don't we need a null check?

Suggested change

} else if (leftNote->line() > firstLedgerBelow || leftNote->line() < firstLedgerAbove) {

} else if (leftNote && (leftNote->line() > firstLedgerBelow || leftNote->line() < firstLedgerAbove)) {

cbjeukendrup · 2023-11-10T16:20:02Z

src/engraving/rendering/dev/chordlayout.cpp

@@ -198,7 +202,11 @@ void ChordLayout::layoutPitched(Chord* item, LayoutContext& ctx)

            double gapSize = arpeggioNoteDistance;

-            if (downnote->line() > firstLedgerBelow || upnote->line() < firstLedgerAbove) {
+            if (leftNote && leftNote->x() == 0) {


Perhaps RealIsNull(leftNote->x()) is more reliable (from realfn.h)

RomanPudashkin · 2023-11-13T10:32:15Z

src/engraving/dom/arpeggio.cpp

+    }
+}
+
+void Arpeggio::rebaseStartAnchor(int direction)


It would be better to use enum instead of int (rebaseStartAnchor/rebaseEndAnchor)

RomanPudashkin · 2023-11-13T10:33:29Z

src/engraving/dom/arpeggio.h

@@ -40,6 +40,7 @@ class Arpeggio final : public EngravingItem

 public:

+    ~Arpeggio();


RomanPudashkin · 2023-11-13T10:36:11Z

src/engraving/rendering/dev/arpeggiolayout.cpp

+        double chordX = -chordShape.left();
+        double diff = chordX - arpX;
+
+        if (diff != 0.0) {


Please use RealIsNull

RomanPudashkin · 2023-11-13T10:38:30Z

src/engraving/rendering/dev/arpeggiolayout.cpp

+            // Arpeggio doesn't start on this staff so move to last note and extend upwards
+            curArpShape.translate(PointF(0.0, endChord->downNote()->pagePos().y() - item->pagePos().y()));
+            curArpShape.addBBox(RectF(curArpShape.bbox().topLeft().x(), curArpShape.bbox().topLeft().y() - 10000,
+                                      curArpShape.bbox().width(), 10000));


Please use a named constant instead of this magic number (same for other places where you use it)

RomanPudashkin · 2023-11-13T10:39:02Z

src/engraving/rendering/dev/arpeggiolayout.cpp

+        }
+    }
+
+    if (_accidentals.size() == 0) {


if (_accidentals.empty())

RomanPudashkin · 2023-11-13T10:41:19Z

src/engraving/rendering/dev/arpeggiolayout.cpp

+//   insetDistance
+//---------------------------------------------------------
+
+double ArpeggioLayout::insetDistance(Arpeggio* item, LayoutContext& ctx, double mag_, Chord* chord,


item, ctx and chord should be const

RomanPudashkin · 2023-11-13T10:42:12Z

src/engraving/rendering/dev/arpeggiolayout.cpp

+}
+
+//---------------------------------------------------------
+//   insetDistance


Please remove this comment (and other similar comments)

RomanPudashkin · 2023-11-13T10:42:45Z

src/engraving/rendering/dev/arpeggiolayout.cpp

+                          || type == ArpeggioType::BRACKET;
+
+    Accidental* furthestAccidental = nullptr;
+    for (auto accidental : accidentals) {


Please use const Accidental* instead of auto

RomanPudashkin · 2023-11-14T08:52:14Z

src/engraving/rendering/dev/chordlayout.cpp

@@ -91,6 +91,7 @@ void ChordLayout::layout(Chord* item, LayoutContext& ctx)

 void ChordLayout::layoutPitched(Chord* item, LayoutContext& ctx)
 {
+    PaddingTable paddingTable = item->score()->paddingTable();


Please declare this closer to the place where it's used

It should be const PaddingTable & paddingTable

RomanPudashkin · 2023-11-14T08:52:33Z

src/engraving/rendering/dev/chordlayout.cpp

    if (item->arpeggio()) {
+        item->arpeggio()->findAndAttachToChords();
+        item->arpeggio()->mutldata()->maxChordPad = 0.0;
+        item->arpeggio()->mutldata()->minChordX = 10000;


magic number

RomanPudashkin · 2023-11-14T08:54:06Z

src/engraving/rendering/dev/arpeggiolayout.cpp

+
+    const Segment* seg = item->chord()->segment();
+    Chord* endChord = item->chord();
+    const PaddingTable paddingTable = item->score()->paddingTable();


Don't forget &

RomanPudashkin · 2023-11-14T08:54:27Z

src/engraving/rendering/dev/arpeggiolayout.cpp

+        return 0.0;
+    }
+
+    if (accidentals.size() == 0) {


if (accidentals.empty())

RomanPudashkin · 2023-11-14T08:55:54Z

src/engraving/rendering/dev/arpeggiolayout.cpp

+                          || type == ArpeggioType::BRACKET;
+
+    Accidental* furthestAccidental = nullptr;
+    for (Accidental* accidental : accidentals) {


const Accidental*

src/engraving/rendering/stable/chordlayout.cpp

RomanPudashkin · 2023-11-14T09:01:41Z

src/engraving/rendering/dev/chordlayout.cpp

-            lll += extraX;
-        }
-        // _arpeggio->layout() called in layoutArpeggio2()
+            if (chordAccidentals.size()) {


if (!chordAccidentals.empty())

miiizen force-pushed the arpeggio-overhaul branch from ad3cec0 to f437994 Compare October 19, 2023 16:08

miiizen force-pushed the arpeggio-overhaul branch 2 times, most recently from 6873adc to e603857 Compare October 30, 2023 16:25

oktophonie added the vtests This PR produces approved changes to vtest results label Oct 30, 2023

oktophonie approved these changes Oct 30, 2023

View reviewed changes

oktophonie requested review from cbjeukendrup and RomanPudashkin October 30, 2023 17:25

cbjeukendrup reviewed Nov 4, 2023

View reviewed changes

miiizen force-pushed the arpeggio-overhaul branch 4 times, most recently from e8b67cc to 38338ca Compare November 9, 2023 14:40

miiizen added 11 commits November 9, 2023 17:48

Fix arpeggio cross stave collisions

0385688

Allow moving arpeggio start anchor

3040d3f

Fix deleting bottom arpeggio note

8254462

Show arpeggio handles on palette drop

22cb1db

Move arpeggio inset functions to ArpeggioLayout

55f0a72

Fix arpeggio notehead offset bugs

370f945

Arpeggio avoids accidentals from chords it does not span

cdade1c

Review fixes

2c1a232

slur collisions

aceaf14

Add arpeggio to ledger distance

8149ce8

Fix handle drag crash

98e168b

miiizen force-pushed the arpeggio-overhaul branch 2 times, most recently from ebb6dfb to 155527b Compare November 10, 2023 13:13

cbjeukendrup reviewed Nov 10, 2023

View reviewed changes

update arpeggio padding values in padding table

c1cff17

miiizen force-pushed the arpeggio-overhaul branch 2 times, most recently from 4b16c5e to 2934183 Compare November 10, 2023 16:10

cbjeukendrup reviewed Nov 10, 2023

View reviewed changes

Review fixes

a1b3373

miiizen force-pushed the arpeggio-overhaul branch from 2934183 to a1b3373 Compare November 10, 2023 16:28

oktophonie requested a review from mike-spa November 13, 2023 09:10

RomanPudashkin reviewed Nov 13, 2023

View reviewed changes

src/engraving/rendering/dev/arpeggiolayout.cpp Outdated

}

}

if (_accidentals.size() == 0) {

Copy link

Contributor

RomanPudashkin Nov 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if (_accidentals.empty())

RomanPudashkin reviewed Nov 13, 2023

View reviewed changes

RomanPudashkin reviewed Nov 14, 2023

View reviewed changes

src/engraving/rendering/stable/chordlayout.cpp Show resolved Hide resolved

RomanPudashkin reviewed Nov 14, 2023

View reviewed changes

Review fixes and extra test

58781a8

miiizen force-pushed the arpeggio-overhaul branch from 6e87e9f to 58781a8 Compare November 14, 2023 09:34

RomanPudashkin approved these changes Nov 14, 2023

View reviewed changes

RomanPudashkin merged commit 9e57b69 into musescore:master Nov 14, 2023
10 of 11 checks passed

DmitryArefiev mentioned this pull request Nov 29, 2023

Crash after copy-paste arpeggio, Undo and delete Tempo #20246

Closed

Jojo-Schmitz mentioned this pull request Aug 15, 2024

Backport Arpeggio Shift+Down/Up across voices Jojo-Schmitz/MuseScore#577

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix arpeggio cross stave collisions #19734

Fix arpeggio cross stave collisions #19734

miiizen commented Oct 16, 2023 •

edited

Loading

cbjeukendrup Nov 3, 2023

miiizen Nov 6, 2023

cbjeukendrup Nov 4, 2023

cbjeukendrup Nov 4, 2023

cbjeukendrup Nov 10, 2023

cbjeukendrup Nov 10, 2023

cbjeukendrup Nov 10, 2023

cbjeukendrup Nov 10, 2023

cbjeukendrup Nov 10, 2023

RomanPudashkin Nov 13, 2023

RomanPudashkin Nov 13, 2023

RomanPudashkin Nov 13, 2023

RomanPudashkin Nov 13, 2023

RomanPudashkin Nov 13, 2023

RomanPudashkin Nov 13, 2023

RomanPudashkin Nov 13, 2023

RomanPudashkin Nov 13, 2023

RomanPudashkin Nov 14, 2023 •

edited

Loading

RomanPudashkin Nov 14, 2023

RomanPudashkin Nov 14, 2023

RomanPudashkin Nov 14, 2023

RomanPudashkin Nov 14, 2023

RomanPudashkin Nov 14, 2023

		bool aboveStart = chord->vStaffIdx() <= item->vStaffIdx() && chord->line() < item->chord()->line();
		bool belowEnd = chord->vStaffIdx() >= endChord->vStaffIdx() && chord->line() > endChord->line();

		bool aboveStart = item->vStaffIdx() <= spanArp->vStaffIdx() && item->line() < spanArp->chord()->line();
		bool belowEnd = item->vStaffIdx() >= endChord->vStaffIdx() && item->line() > endChord->line();

		@@ -96,7 +96,7 @@ void ScoreRenderer::layoutText1(TextBase* item, bool base)
		void ScoreRenderer::layoutOnEdit(Arpeggio* item)

	} else if (leftNote->line() > firstLedgerBelow \|\| leftNote->line() < firstLedgerAbove) {
	} else if (leftNote && (leftNote->line() > firstLedgerBelow \|\| leftNote->line() < firstLedgerAbove)) {

		@@ -40,6 +40,7 @@ class Arpeggio final : public EngravingItem

		public:

		~Arpeggio();

Fix arpeggio cross stave collisions #19734

Fix arpeggio cross stave collisions #19734

Conversation

miiizen commented Oct 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RomanPudashkin Nov 14, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miiizen commented Oct 16, 2023 •

edited

Loading

RomanPudashkin Nov 14, 2023 •

edited

Loading