Merge pull request #14 from papauorg/feature/use-custom-svg-creation

Feature/use custom svg creation

Dockerfile

@@ -1,5 +1,5 @@
 FROM mcr.microsoft.com/devcontainers/dotnet:1-8.0-bookworm AS dev
-RUN apt-get update -y && apt install -y vim pipx ruby-full build-essential zlib1g-dev
+RUN apt-get update -y && apt install -y vim pipx ruby-full build-essential zlib1g-dev libfontconfig
 
 RUN dotnet tool install -g dotnet-format \
  && dotnet tool install -g dotnet-outdated-tool
@@ -23,14 +23,14 @@ RUN gem install jekyll bundler
 USER root
 
 
-
 FROM dev as build
 WORKDIR /build
 COPY . .
 RUN find ./scales/definitions/*.json | xargs -I % check-jsonschema % --schemafile ./scales/definitions/schemas/scale-config
 RUN dotnet build --configuration=Release && dotnet test --no-build --configuration=Release
 
 FROM mcr.microsoft.com/dotnet/runtime:8.0
+RUN apt-get update && apt-get install -y libfontconfig
 WORKDIR /app
 COPY --from=build /build/src/dotnet-levelmeter/bin/Release/net8.0 .
 WORKDIR /config

scales/definitions/cylinder_mm_d360_h335_1-9gal-us_i1.json

@@ -22,7 +22,7 @@
           "family": "./fonts/BigShoulderStencilText/static/BigShouldersStencilText-ExtraBold.ttf",
           "size": 8,
           "offsetX": -2,
-          "offsetY": -5,
+          "offsetY": -7,
           "textAlignment": "Right"
         }
       }

scales/definitions/cyliner_mm_d600_h600_1-170l_i5.json

@@ -0,0 +1,37 @@
+{
+    "$schema": "./schemas/scale-config",
+    "scale-config": {
+        "containerForm": "cylinder",
+        "lengthUnit": "mm",
+        "volumeUnit": "l",
+        "diameter": 600,
+        "height": 600,
+        "minVolume": 1,
+        "maxVolume": 170,
+        "output": "./scales/svgs/{0}.svg",
+        "description": "Scale for 600mm diameter cylindric container. 1-170 l in 5 l intervals with text every 10 l.",
+        "sucessfullyAppliedTo": "",
+        "requiresTransferTape": false,
+        "graduationMarkSettings": [
+            {
+                "interval": 5,
+                "length": 10,
+                "height": 1.5,
+                "indentation": 0,
+                "textTemplate": ""
+            },
+            {
+                "interval": 10,
+                "length": 25,
+                "height": 1.5,
+                "font": {
+                    "family": "./fonts/BigShoulderStencilText/static/BigShouldersStencilText-ExtraBold.ttf",
+                    "size": 8,
+                    "offsetX": -2,
+                    "offsetY": -5,
+                    "textAlignment": "Right"
+                }
+            }
+        ]
+    }
+}

scales/definitions/cyliner_mm_d600_h600_1-170l_i5_bigger.json

@@ -0,0 +1,37 @@
+{
+    "$schema": "./schemas/scale-config",
+    "scale-config": {
+        "containerForm": "cylinder",
+        "lengthUnit": "mm",
+        "volumeUnit": "l",
+        "diameter": 600,
+        "height": 600,
+        "minVolume": 1,
+        "maxVolume": 170,
+        "output": "./scales/svgs/{0}.svg",
+        "description": "Scale for 600mm diameter cylindric container. 1-170 l in 5 l intervals with text every 10 l.",
+        "sucessfullyAppliedTo": "",
+        "requiresTransferTape": false,
+        "graduationMarkSettings": [
+            {
+                "interval": 5,
+                "length": 20,
+                "height": 1.5,
+                "indentation": 0,
+                "textTemplate": ""
+            },
+            {
+                "interval": 10,
+                "length": 50,
+                "height": 2.5,
+                "font": {
+                    "family": "./fonts/BigShoulderStencilText/static/BigShouldersStencilText-ExtraBold.ttf",
+                    "size": 15,
+                    "offsetX": -2,
+                    "offsetY": -10,
+                    "textAlignment": "Right"
+                }
+            }
+        ]
+    }
+}

src/dotnet-levelmeter/LevelMeter/CylindricGraduationMarkCalculator.cs

@@ -63,7 +63,8 @@ private void CalculateGraduationMark(Dictionary<Volume, GraduationMark> results,
                 Position = (Length.From(setting.Indentation, LengthUnit), currentHeight * -1),
                 Text = PrepareText(setting, currentVolume, maxVolume),
                 Volume = currentVolume,
-                Font = setting.Font
+                Font = setting.Font,
+                ReferenceSetting = setting
             };
 
             results[currentVolume] = mark;
@@ -91,7 +92,7 @@ private Volume GetMaximumScaleVolume(Length diameter, Length height, Volume maxV
         // use the maxVolume for even end of the scale
         if (maxVolume.Equals(maximumVolumeByHeight, maxVolume / 100))
             return maxVolume.ToUnit(VolumeUnit);
-        
+
         // limit to max volume if the volume by height would be more
         if (maxVolume < maximumVolumeByHeight)
             return maxVolume.ToUnit(VolumeUnit);

src/dotnet-levelmeter/LevelMeter/GraduationMark.cs

@@ -33,4 +33,9 @@ public record GraduationMark
     /// Font name or path to font file. Defines the font to write texts for the graduation mark.
     /// </summary>
     public required GraduationMarkSettings.FontSettings Font { get; init; }
+
+    /// <summary>
+    /// References the settings used to calculate this graduation mark
+    /// </summary>
+    public required GraduationMarkSettings ReferenceSetting { get; init; }
 }

src/dotnet-levelmeter/LevelMeter/GraduationMarkSettings.cs

@@ -43,7 +43,7 @@ internal void Validate()
     {
         if (Length <= 0)
             throw new ArgumentOutOfRangeException(nameof(Length), Length, "Value must be greater than 0;");
-        
+
         if (Height <= 0)
             throw new ArgumentOutOfRangeException(nameof(Height), Height, "Value must be greater than 0");
     }

src/dotnet-levelmeter/LevelMeter/SvgScalePainter.cs

@@ -1,132 +1,120 @@
 using System.Collections.Concurrent;
+using System.ComponentModel;
+using System.Drawing;
+using System.Text;
 using System.Threading.Tasks.Sources;
 using System.Xml;
 
+using Papau.Levelmeter.SvgHelper;
+
+using SkiaSharp;
+
 using UnitsNet;
 using UnitsNet.Units;
 
-using VectSharp;
-using VectSharp.SVG;
-
 namespace Papau.Levelmeter.LevelMeter;
 
 public class SvgScalePainter
 {
-    private double _topTextOverflow = 0;
-    private double _bottomTextOverflow = 0;
-
-    public Task PaintAsync(GraduationMark[] graduationMarks, Stream outputStream, CancellationToken cancellationToken)
+    public async Task PaintAsync(GraduationMark[] graduationMarks, Stream outputStream, CancellationToken cancellationToken)
     {
-        _topTextOverflow = 0;
-
         if (!graduationMarks.Any())
-            return Task.CompletedTask;
+            return;
 
-        var svgPage = new Page(1, 1)
+        var svg = new SvgModel()
         {
-            Background = Colours.White
+            Background = Color.White
         };
 
         var unit = LengthUnit.Millimeter;
         foreach (var mark in graduationMarks.Reverse())
         {
-            DrawGraduationMark(svgPage, mark);
+            DrawGraduationMark(svg, mark);
             unit = mark.Length.Unit;
         }
-
-        var padding = Length.FromMillimeters(5).ToUnit(unit).Value;
-        PaintCuttingRectangle(padding, graduationMarks, svgPage);
 
-        var svgDoc = svgPage.SaveAsSVG(SVGContextInterpreter.TextOptions.ConvertIntoPaths);
-        SetSvgDimensionsInXml(svgPage, unit, svgDoc);
-        svgDoc.Save(outputStream);
+        var padding = Length.FromMillimeters(5).ToUnit(unit).Value;
+        svg.Padding = new SizeF((float)padding, (float)padding);
 
-        return Task.CompletedTask;
+        await svg.SaveToStream(outputStream, unit, cancellationToken).ConfigureAwait(false);
     }
 
-    private void PaintCuttingRectangle(double padding, GraduationMark[] graduationMarks, Page svgPage)
+    private readonly static ConcurrentDictionary<string, SKTypeface> FontCache = [];
+
+    private void DrawGraduationMark(SvgModel scale, GraduationMark mark)
     {
-        svgPage.Crop();
-        var page = svgPage.Graphics.GetBounds();
+        // assume middle of the marker marks the spot. This helps avoiding differences in spacing due to different marker heights.
+        var markerPos = new PointF((float)mark.Position.X.Value, (float)(mark.Position.Y.Value - mark.Height.Value / 2));
 
-        var topMarker = graduationMarks.MinBy(m => m.Position.Y)!;
-        var topYBound = (_topTextOverflow + (topMarker.Height.Value / 2)) * -1;
-        var bottomMarker = graduationMarks.MaxBy(m => m.Position.Y)!;
-        var bottomYBound = _bottomTextOverflow;
+        scale.FillRectangle(markerPos, new SizeF((float)mark.Length.Value, (float)mark.Height.Value), Color.Black, $"mark_{mark.Volume.Value}");
 
-        // top left corner moved by padding to top and left
-        var pos = new Point(0 - padding, topYBound - padding);
+        if (!string.IsNullOrWhiteSpace(mark.Text))
+        {
+            var font = GetFont(mark);
+            var textPath = CreateTextPath(mark, font);
+            var textSize = new SizeF(textPath.Bounds.Size.Width, textPath.Bounds.Size.Height);
+            var textPosition = GetTextPosition(mark, markerPos, textSize, font);
 
-        var size = new Size(page.Size.Width + 2 * padding, page.Size.Height + bottomYBound + 2 * padding);
-        svgPage.Graphics.StrokeRectangle(pos, size, Colours.Red, 0.1);
+            scale.FillPath(textPath, textPosition, Color.Black);
 
-        svgPage.Crop();
+            // bounding box for debugging
+            // scale.StrokeRectangle(textPosition, textSize, Color.Green, 0.05f);
+        }
     }
 
-    private static void SetSvgDimensionsInXml(Page page, LengthUnit unit, XmlDocument svgDoc)
+    private static SKPath CreateTextPath(GraduationMark mark, SKFont font)
     {
-        var size = page.Graphics.GetBounds();
-
-        var widthAttribute = svgDoc.CreateAttribute("width");
-        widthAttribute.Value = $"{size.Size.Width}{Length.GetAbbreviation(unit)}";
-        var heightAttribute = svgDoc.CreateAttribute("height");
-        heightAttribute.Value = $"{size.Size.Height}{Length.GetAbbreviation(unit)}";
-        var rootAttributes = svgDoc.GetElementsByTagName("svg")[0]!.Attributes!;
-        rootAttributes.Append(widthAttribute);
-        rootAttributes.Append(heightAttribute);
-    }
+        using var textPath = font.GetTextPath(mark.Text);
 
-    private readonly static ConcurrentDictionary<string, FontFamily?> FontCache = [];
+        // Get the current bounds of the path
+        SKRect currentBounds = textPath.Bounds;
 
-    private void DrawGraduationMark(Page scale, GraduationMark mark)
-    {
-        // assume middle of the marker marks the spot. This helps avoiding differences in spacing due to different marker heights.
-        var markerPos = new Point(mark.Position.X.Value, mark.Position.Y.Value - mark.Height.Value / 2);
-        var markerSize = new Size(mark.Length.Value, mark.Height.Value);
-        scale.Graphics.FillRectangle(markerPos, markerSize, Colours.Black, "mark" + mark.Volume.ToString());
+        // Calculate the translation to move the top-left corner to (0, 0)
+        float translateX = -currentBounds.Left;
+        float translateY = -currentBounds.Top;
 
-        if (!string.IsNullOrWhiteSpace(mark.Text))
-        {
-            var font = GetFont(mark);
-            var textSize = font.MeasureText(mark.Text);
-            var textPosition = GetTextPosition(mark, markerPos, textSize);
-
-            _topTextOverflow = Math.Max(_topTextOverflow, markerPos.Y - textPosition.Y + (textSize.Height / 2));
-            _bottomTextOverflow = Math.Max(_bottomTextOverflow, markerPos.Y - textPosition.Y - (textSize.Height / 2));
+        // Create a transformation matrix for cropping
+        SKMatrix cropMatrix = SKMatrix.CreateTranslation(translateX, translateY);
 
-            scale.Graphics.FillText(textPosition, mark.Text, font, Colours.Black, TextBaselines.Middle, "text" + mark.Volume.ToString());
-        }
+        // Apply the transformation to the path
+        var croppedPath = new SKPath();
+        textPath.Transform(cropMatrix, croppedPath);
+        return croppedPath;
     }
 
-    private static Point GetTextPosition(GraduationMark mark, Point markerPos, Size textSize)
+    private static PointF GetTextPosition(GraduationMark mark, PointF markerPos, SizeF textSize, SKFont font)
     {
         var fontX = mark.Position.X.Value + mark.Length.Value + mark.Font.OffsetX;
+
+        // the position of the text is calculated by the top left corner of the path.
+        // but we want to align the text by its baseline so we need to calculate the
+        // offset between the top and the baseline
+        var fontBaselineOffset = font.Metrics.StrikeoutPosition + font.Metrics.StrikeoutThickness / 2;
+        if (!fontBaselineOffset.HasValue)
+            fontBaselineOffset = (textSize.Height / 2) * -1; // fallback to half height of the path
+
         // align in the middle of the marker
-        var fontY = markerPos.Y + mark.Height.Value / 2 + mark.Font.OffsetY;
+        var fontY = markerPos.Y + mark.Height.Value / 2 + mark.Font.OffsetY + fontBaselineOffset;
 
         // change text alignment
         fontX = ApplyAlignment(fontX, textSize, mark.Font.TextAlignment);
 
-        return new Point(fontX, fontY);
+        return new PointF((float)fontX, (float)fontY);
     }
 
-    private static Font GetFont(GraduationMark mark)
+    private static SKFont GetFont(GraduationMark mark)
     {
-        var fontFamily = FontCache.GetOrAdd(mark.Font.Family, f =>
-        {
-            var result = FontFamily.ResolveFontFamily(f);
-
-            if (result is null || result.TrueTypeFile is null)
-                throw new InvalidOperationException($"Font '{mark.Font}' not found or not a valid font!");
+        var fontFamily = FontCache.GetOrAdd(mark.Font.Family, f => SKTypeface.FromFile(mark.Font.Family));
 
-            return result;
-        });
-
-        var font = new Font(fontFamily, mark.Font.Size);
-        return font;
+        return new SKFont
+        {
+            Typeface = fontFamily,
+            Size = (float)mark.Font.Size,
+            Edging = SKFontEdging.Antialias
+        };
     }
 
-    private static double ApplyAlignment(double xPos, Size textSize, GraduationMarkSettings.TextAlignment textAlignment)
+    private static double ApplyAlignment(double xPos, SizeF textSize, GraduationMarkSettings.TextAlignment textAlignment)
     {
         return textAlignment switch
         {