[MU3 Backend] Eng-53: Horizontal spacer for FretDiagrams #8296

iveshenry18 · 2021-06-10T22:13:23Z

Resolves: ENG-53: Fretboard diagrams need to create horizontal space

This adds a case for including fretboard diagrams when
creating horizontal spacing in the ChordRest::shape() function. In
pursuit of this, it also extracts a calculateBoundingRect() function from
FretDiagram::layout().

NOTE: In order to allow "orphaned" FretDiagrams to still create space,
the spacer is added to all staves. This is redundant in some cases, so
a more performant solution may be desirable in the future.

This PR also includes the commit from #8176, as this is built on top of it.

I signed CLA
I made sure the code in the PR follows the coding rules
I made sure the code compiles on my machine
I made sure there are no unnecessary changes in the code
I made sure the title of the PR reflects the core meaning of the issue you are solving
I made sure the commit message(s) contain a description and answer the question "Why do those changes fix that particular issue?" or "Why are those changes really necessary as improvements?"
I made sure the commit message title starts with "fix #424242:" if there is a related issue
I created the test (mtest, vtest, script test) to verify the changes I made

Previously, melismas were treated the same as normal Lyrics in terms of horizontal spacing—they would cause a spacer to be added to the ChordRest to which they were attached, causing an unnecessary gap after the first note of a melisma. This commit prevents a melisma from adding a right spacer to their first ChordRest, and rather creates a right spacer on the last ChordRest of a lyric if necessary. In pursuit of this, this commit refactors ChordRest::_melismaEnd(s) from a bool to a std::set<*Lyrics>, giving a ChordRest a way to access the melismatic Lyrics that end on it. This change also solves the problem of said bool being untrustworthy (i.e. erroneously being changged to false when one of multiple melismas was removed).

This commit adds a case for including fretboard diagrams when creating horizontal spacing in the ChordRest::shape() function. In pursuit of this, it also extracts a calculateBoundingRect function from FretDiagram::layout(). NOTE: In order to allow "orphaned" FretDiagrams to still create space, the spacer is added to all staves. This is redundant in some cases, so a more performant solution may be desirable in the future.

Previously, melismas were treated the same as normal Lyrics in terms of horizontal spacing—they would cause a spacer to be added to the ChordRest to which they were attached, causing an unnecessary gap after the first note of a melisma. This commit prevents a melisma from adding a right spacer to their first ChordRest, and rather creates a right spacer on the last ChordRest of a lyric if necessary. In pursuit of this, this commit refactors ChordRest::_melismaEnd(s) from a bool to a std::set<*Lyrics>, giving a ChordRest a way to access the melismatic Lyrics that end on it. This change also solves the problem of said bool being untrustworthy (i.e. erroneously being changged to false when one of multiple melismas was removed). Duplicate pf musescore#8296

This commit adds a case for including fretboard diagrams when creating horizontal spacing in the ChordRest::shape() function. In pursuit of this, it also extracts a calculateBoundingRect function from FretDiagram::layout(). NOTE: In order to allow "orphaned" FretDiagrams to still create space, the spacer is added to all staves. This is redundant in some cases, so a more performant solution may be desirable in the future. Duplicate of musescore#8296

Previously, melismas were treated the same as normal Lyrics in terms of horizontal spacing—they would cause a spacer to be added to the ChordRest to which they were attached, causing an unnecessary gap after the first note of a melisma. This commit prevents a melisma from adding a right spacer to their first ChordRest, and rather creates a right spacer on the last ChordRest of a lyric if necessary. In pursuit of this, this commit refactors ChordRest::_melismaEnd(s) from a bool to a std::set<*Lyrics>, giving a ChordRest a way to access the melismatic Lyrics that end on it. This change also solves the problem of said bool being untrustworthy (i.e. erroneously being changged to false when one of multiple melismas was removed). Duplicate pf musescore#8296

This commit adds a case for including fretboard diagrams when creating horizontal spacing in the ChordRest::shape() function. In pursuit of this, it also extracts a calculateBoundingRect function from FretDiagram::layout(). NOTE: In order to allow "orphaned" FretDiagrams to still create space, the spacer is added to all staves. This is redundant in some cases, so a more performant solution may be desirable in the future. Duplicate of musescore#8296

Previously, melismas were treated the same as normal Lyrics in terms of horizontal spacing—they would cause a spacer to be added to the ChordRest to which they were attached, causing an unnecessary gap after the first note of a melisma. This commit prevents a melisma from adding a right spacer to their first ChordRest, and rather creates a right spacer on the last ChordRest of a lyric if necessary. In pursuit of this, this commit refactors ChordRest::_melismaEnd(s) from a bool to a std::set<*Lyrics>, giving a ChordRest a way to access the melismatic Lyrics that end on it. This change also solves the problem of said bool being untrustworthy (i.e. erroneously being changged to false when one of multiple melismas was removed). Duplicate pf musescore#8296

This commit adds a case for including fretboard diagrams when creating horizontal spacing in the ChordRest::shape() function. In pursuit of this, it also extracts a calculateBoundingRect function from FretDiagram::layout(). NOTE: In order to allow "orphaned" FretDiagrams to still create space, the spacer is added to all staves. This is redundant in some cases, so a more performant solution may be desirable in the future. Duplicate of musescore#8296

Previously, melismas were treated the same as normal Lyrics in terms of horizontal spacing—they would cause a spacer to be added to the ChordRest to which they were attached, causing an unnecessary gap after the first note of a melisma. This commit prevents a melisma from adding a right spacer to their first ChordRest, and rather creates a right spacer on the last ChordRest of a lyric if necessary. In pursuit of this, this commit refactors ChordRest::_melismaEnd(s) from a bool to a std::set<*Lyrics>, giving a ChordRest a way to access the melismatic Lyrics that end on it. This change also solves the problem of said bool being untrustworthy (i.e. erroneously being changged to false when one of multiple melismas was removed). Duplicate pf musescore#8296

This commit adds a case for including fretboard diagrams when creating horizontal spacing in the ChordRest::shape() function. In pursuit of this, it also extracts a calculateBoundingRect function from FretDiagram::layout(). NOTE: In order to allow "orphaned" FretDiagrams to still create space, the spacer is added to all staves. This is redundant in some cases, so a more performant solution may be desirable in the future. Duplicate of musescore#8296

Previously, melismas were treated the same as normal Lyrics in terms of horizontal spacing—they would cause a spacer to be added to the ChordRest to which they were attached, causing an unnecessary gap after the first note of a melisma. This commit prevents a melisma from adding a right spacer to their first ChordRest, and rather creates a right spacer on the last ChordRest of a lyric if necessary. In pursuit of this, this commit refactors ChordRest::_melismaEnd(s) from a bool to a std::set<*Lyrics>, giving a ChordRest a way to access the melismatic Lyrics that end on it. This change also solves the problem of said bool being untrustworthy (i.e. erroneously being changged to false when one of multiple melismas was removed). Duplicate of musescore#8296