Remove SPATIUM20 variable

This is another variable that has never made any sense to me whatsoever. I can only infer from the way it was used that it was meant to represent the default value of spatium in pixel units. But if that's the case, the way in which it was defined made no sense at all. DPI / 72 used to just be equal to DPI_F, so SPATIUM20 was equal to 5 * DPI_F = 25. To me, the only reason why this seemed to work correctly as the default spatium value is that it just happened to be close to 24.8, which was the actual value.

This commit removes SPATIUM20 and replaces it with appropriate calls to the style defaults. In a couple of places (namely StaffType and EngravingFont) the Score and the corresponding Style haven't been created yet, so they need to access the StyleDef class directly. In fact I don't see what StyleDef should make its members private. I think they can be public cause they are const so they can't be changed.

Author: mike-spa

src/engraving/dom/bend.cpp

@@ -95,7 +95,7 @@ Font Bend::font(double sp) const
     f.setUnderline(m_fontStyle & FontStyle::Underline);
     f.setStrike(m_fontStyle & FontStyle::Strike);
     double m = m_fontSize;
-    m *= sp / SPATIUM20;
+    m *= sp / defaultSpatium();
 
     f.setPointSizeF(m);
     return f;

src/engraving/dom/engravingitem.cpp

@@ -264,6 +264,11 @@ double EngravingItem::spatium() const
     return s ? s->spatium(this) : style().spatium();
 }
 
+double EngravingItem::defaultSpatium() const
+{
+    return style().defaultSpatium();
+}
+
 bool EngravingItem::isInteractionAvailable() const
 {
     if (!getProperty(Pid::VISIBLE).toBool() && (score()->printing() || !score()->isShowInvisible())) {
@@ -293,7 +298,7 @@ PlacementV EngravingItem::placement() const
 
 double EngravingItem::magS() const
 {
-    return mag() * (style().spatium() / SPATIUM20);
+    return mag() * (style().spatium() / defaultSpatium());
 }
 
 //---------------------------------------------------------

src/engraving/dom/engravingitem.h

@@ -189,6 +189,7 @@ class EngravingItem : public EngravingObject
     virtual bool isEngravingItem() const override { return true; }
 
     double spatium() const;
+    double defaultSpatium() const;
 
     inline void setFlag(ElementFlag f, bool v)
     {

src/engraving/dom/indicatoricon.cpp

@@ -37,7 +37,7 @@ Font IndicatorIcon::font() const
 {
     Font font(configuration()->iconsFontFamily(), Font::Type::Icon);
     static constexpr double STANDARD_POINT_SIZE = 12.0;
-    const double scaling = spatium() / SPATIUM20;
+    const double scaling = spatium() / defaultSpatium();
     font.setPointSizeF(STANDARD_POINT_SIZE * scaling);
     return font;
 }

src/engraving/dom/layoutbreak.cpp

@@ -260,7 +260,7 @@ Font LayoutBreak::font() const
 {
     Font font(configuration()->iconsFontFamily(), Font::Type::Icon);
     static constexpr double STANDARD_POINT_SIZE = 12.0;
-    double scaling = spatium() / SPATIUM20;
+    double scaling = spatium() / defaultSpatium();
     font.setPointSizeF(STANDARD_POINT_SIZE * scaling);
     return font;
 }

src/engraving/dom/mscore.h

@@ -68,7 +68,6 @@ static constexpr double INCH      = 25.4; // millimitres per inch
 static constexpr double PPI       = 72.0; // typographical points per inch
 
 static constexpr double DPI       = 1200;
-static constexpr double SPATIUM20 = 5.0 * (DPI / 72.0);
 static constexpr double DPMM      = DPI / INCH;
 
 // NOTE: the SMuFL default is actually 20pt. We use 10 for historical reasons

src/engraving/dom/score.cpp

@@ -1382,7 +1382,7 @@ void Score::spatiumChanged(double oldValue, double newValue)
     for (Staff* staff : m_staves) {
         staff->spatiumChanged(oldValue, newValue);
     }
-    m_layoutOptions.noteHeadWidth = m_engravingFont->width(SymId::noteheadBlack, newValue / SPATIUM20);
+    m_layoutOptions.noteHeadWidth = m_engravingFont->width(SymId::noteheadBlack, newValue / style().defaultSpatium());
     createPaddingTable();
 }
 
@@ -5997,7 +5997,7 @@ void Score::doLayoutRange(const Fraction& st, const Fraction& et)
     }
 
     m_engravingFont = engravingFonts()->fontByName(style().value(Sid::musicalSymbolFont).value<String>().toStdString());
-    m_layoutOptions.noteHeadWidth = m_engravingFont->width(SymId::noteheadBlack, style().spatium() / SPATIUM20);
+    m_layoutOptions.noteHeadWidth = m_engravingFont->width(SymId::noteheadBlack, style().spatium() / style().defaultSpatium());
 
     if (this->cmdState().layoutFlags & LayoutFlag::REBUILD_MIDI_MAPPING) {
         if (this->isMaster()) {

src/engraving/dom/stafftype.cpp

@@ -441,7 +441,7 @@ void StaffType::setDurationMetrics()
     RectF bb(fm.tightBoundingRect(txt));
     // raise symbols by a default margin and, if marks are above lines, by half the line distance
     // (converted from spatium units to raster units)
-    m_durationGridYOffset = (TAB_DEFAULT_DUR_YOFFS - (m_onLines ? 0.0 : lineDistance().val() * 0.5)) * SPATIUM20;
+    m_durationGridYOffset = (TAB_DEFAULT_DUR_YOFFS - (m_onLines ? 0.0 : lineDistance().val() * 0.5)) * defaultSpatium();
     // this is the bottomest point of any duration sign
     m_durationYOffset = m_durationGridYOffset;
     // move symbols so that the lowest margin 'sits' on the base line:
@@ -480,12 +480,12 @@ void StaffType::setFretMetrics()
 
     // Calculate position for dead fret marks - these must be centred separately based on their glyph
     RectF deadBb = fm.tightBoundingRect(m_fretFontInfo.xChar);
-    double lineThickness = style().styleS(Sid::staffLineWidth).val() * SPATIUM20 * 0.5;
+    double lineThickness = style().styleS(Sid::staffLineWidth).val() * defaultSpatium() * 0.5;
     m_deadFretYOffset = -deadBb.y() / 2.0 + lineThickness;
 
     // if on string, we are done; if between strings, raise by half line distance
     if (!m_onLines) {
-        double lineAdj = lineDistance().val() * SPATIUM20 * 0.5;
+        double lineAdj = lineDistance().val() * defaultSpatium() * 0.5;
         m_fretYOffset -= lineAdj;
         m_deadFretYOffset -= lineAdj;
     }
@@ -522,6 +522,11 @@ void StaffType::setDurationFontName(const String& name)
 //   durationBoxH / durationBoxY
 //---------------------------------------------------------
 
+double StaffType::defaultSpatium() const
+{
+    return StyleDef::styleValues[static_cast<size_t>(Sid::spatium)].defaultValue().toDouble();
+}
+
 double StaffType::durationBoxH() const
 {
     if (!m_genDurations && !m_stemless) {
@@ -535,7 +540,37 @@ double StaffType::durationBoxY() const
     if (!m_genDurations && !m_stemless) {
         return 0.0;
     }
-    return m_durationBoxY + m_durationFontUserY * SPATIUM20;
+    return m_durationBoxY + m_durationFontUserY * defaultSpatium();
+}
+
+double StaffType::durationFontYOffset() const
+{
+    return m_durationYOffset + m_durationFontUserY * defaultSpatium();
+}
+
+double StaffType::fretBoxY() const
+{
+    return m_fretBoxY + m_fretFontUserY * defaultSpatium();
+}
+
+double StaffType::deadFretBoxY() const
+{
+    return m_deadFretBoxY + m_fretFontUserY * defaultSpatium();
+}
+
+double StaffType::fretMaskH() const
+{
+    return m_lineDistance.val() * defaultSpatium();
+}
+
+double StaffType::fretMaskY() const
+{
+    return (m_onLines ? -0.5 : -1.0) * m_lineDistance.val() * defaultSpatium();
+}
+
+double StaffType::fretFontYOffset() const
+{
+    return m_fretYOffset + m_fretFontUserY * defaultSpatium();
 }
 
 //---------------------------------------------------------
@@ -669,7 +704,7 @@ void StaffType::drawInputStringMarks(Painter* p, int string, const Color& select
     static constexpr double LEDGER_LINE_LEFTX = 0.25; // in % of cursor rectangle width
     static constexpr double LEDGER_LINE_RIGHTX = 0.75; // in % of cursor rectangle width
 
-    double spatium = SPATIUM20;
+    double spatium = defaultSpatium();
     double lineDist = m_lineDistance.val() * spatium;
     bool hasFret = false;
     String text = tabBassStringPrefix(string, &hasFret);

src/engraving/dom/stafftype.h

@@ -258,22 +258,22 @@ class StaffType
     const String& durationFontName() const { return m_durationFonts[m_durationFontIdx].displayName; }
     double durationFontSize() const { return m_durationFontSize; }
     double durationFontUserY() const { return m_durationFontUserY; }
-    double durationFontYOffset() const { return m_durationYOffset + m_durationFontUserY * SPATIUM20; }
+    double durationFontYOffset() const;
     double durationGridYOffset() const { return m_durationGridYOffset; }
     double fretBoxH() const { return m_fretBoxH; }
     double deadFretBoxH() const { return m_deadFretBoxH; }
-    double fretBoxY() const { return m_fretBoxY + m_fretFontUserY * SPATIUM20; }
-    double deadFretBoxY() const { return m_deadFretBoxY + m_fretFontUserY * SPATIUM20; }
+    double fretBoxY() const;
+    double deadFretBoxY() const;
 
     // 2 methods to return the size of a box masking lines under a fret mark
-    double fretMaskH() const { return m_lineDistance.val() * SPATIUM20; }
-    double fretMaskY() const { return (m_onLines ? -0.5 : -1.0) * m_lineDistance.val() * SPATIUM20; }
+    double fretMaskH() const;
+    double fretMaskY() const;
 
     const muse::draw::Font& fretFont() const { return m_fretFont; }
     const String fretFontName() const { return m_fretFontInfo.displayName; }
     double fretFontSize() const { return m_fretFontSize; }
     double fretFontUserY() const { return m_fretFontUserY; }
-    double fretFontYOffset() const { return m_fretYOffset + m_fretFontUserY * SPATIUM20; }
+    double fretFontYOffset() const;
     bool  genDurations() const { return m_genDurations; }
     bool  linesThrough() const { return m_linesThrough; }
     TablatureMinimStyle minimStyle() const { return m_minimStyle; }
@@ -336,6 +336,7 @@ class StaffType
 
     Score* m_score = nullptr;
 
+    double defaultSpatium() const;
     void  setDurationMetrics();
     void  setFretMetrics();
 

src/engraving/dom/textbase.cpp

@@ -898,9 +898,9 @@ Font TextFragment::font(const TextBase* t) const
     double spatiumScaling = 0.0;
 
     if (t->isInstrumentName()) {
-        spatiumScaling = toInstrumentName(t)->largestStaffSpatium() / SPATIUM20;
+        spatiumScaling = toInstrumentName(t)->largestStaffSpatium() / t->defaultSpatium();
     } else {
-        spatiumScaling = t->spatium() / SPATIUM20;
+        spatiumScaling = t->spatium() / t->defaultSpatium();
     }
 
     if (t->sizeIsSpatiumDependent()) {
@@ -2757,7 +2757,7 @@ Font TextBase::font() const
 {
     double m = size();
     if (sizeIsSpatiumDependent()) {
-        m *= spatium() / SPATIUM20;
+        m *= spatium() / defaultSpatium();
     }
     Font f(family(), Font::Type::Unknown);
     f.setPointSizeF(m);