[CX-2314] Add sparks to pantograph

chunfeilung · chunfeilung · commit e926e929c952 · 2022-07-12T14:57:27.000+02:00
diff --git a/README.md b/README.md
@@ -52,3 +52,11 @@ slt --speed 5
 ```
 
 https://user-images.githubusercontent.com/10553406/173188082-302cf14e-e49f-414a-adaf-af715fa9128c.mov
+
+
+A complete list of supported options can be displayed by passing the `--help`
+option:
+
+```
+slt --help
+```
diff --git a/Slt/Art/Etc/Outline/Colors/Sparks.txt b/Slt/Art/Etc/Outline/Colors/Sparks.txt
@@ -0,0 +1,15 @@
+ bbb b
+  b bbb
+     b
+b bbb
+ bbbbb
+  bbbb
+bbbbbb
+ bbbbbb
+   bbb
+ bbb bbb
+  b bbbbb
+     bbb
+   bbb b
+    b bbb
+       b
diff --git a/Slt/Art/Etc/Outline/Sparks.txt b/Slt/Art/Etc/Outline/Sparks.txt
@@ -0,0 +1,15 @@
+ -*- ,
+  ' -*-
+     '
+* .!,
+ -=*=-
+  '|`*
+-*-.!,
+ '-=*=-
+   '|`
+ -*- .!,
+  ' -=*=-
+     '|`
+   -*- .
+    ' -*-
+       '
diff --git a/Slt/Art/Etc/Sparks.cs b/Slt/Art/Etc/Sparks.cs
@@ -0,0 +1,39 @@
+using Slt.Ascii;
+using Slt.Cli.Consoles;
+using Slt.Util;
+
+namespace Slt.Art.Etc;
+
+public class Sparks : IAnimation
+{
+    private readonly Figure _figure;
+    private int _frame;
+
+    public Sparks(bool useColors = false)
+    {
+        _figure = new Figure(
+            EmbeddedResource.ReadAllText("Slt.Art.Etc.Outline.Sparks.txt"),
+            useColors ? EmbeddedResource.ReadAllText("Slt.Art.Etc.Outline.Colors.Sparks.txt") : ""
+        );
+    }
+
+    public Figure GetFrame(IConsole console)
+    {
+        return _figure.Crop(9, 3, 0, _frame * 3);
+    }
+
+    public void SetFrame(int frame)
+    {
+        _frame = frame % 5 + 5;
+    }
+
+    public void Advance()
+    {
+        _frame = ++_frame % 5;
+    }
+
+    public bool HasFinished()
+    {
+        return false;
+    }
+}
diff --git a/Slt/Art/Slt/AbstractSlt.cs b/Slt/Art/Slt/AbstractSlt.cs
@@ -7,14 +7,16 @@ namespace Slt.Art.Slt;
 public abstract class AbstractSlt : IAnimation
 {
     private readonly Figure _result;
+    private readonly IAnimation? _sparks;
     private int _frame;
 
     protected AbstractSlt(
         Figure drivingCar,
         Figure trailerCar,
         Figure collectorRoof,
         Figure fullLengthRoof,
-        Figure connection)
+        Figure connection,
+        IAnimation? sparks)
     {
         _result = new Figure()
             .AddAt(drivingCar, new Point(0, 3))
@@ -26,16 +28,26 @@ protected AbstractSlt(
             .AddAt(fullLengthRoof, new Point(254, 3))
             .AddAt(connection, new Point(348, 5))
             .AddAt(Mirror.Reflect(drivingCar), new Point(368, 3));
+        _sparks = sparks;
     }
 
-    public string GetFrame(IConsole console)
+    public Figure GetFrame(IConsole console)
     {
-        return _result.Crop(
+        var train = (Figure)_result.Clone();
+
+        if (_sparks != null)
+        {
+            train = train.AddAt(_sparks.GetFrame(console), new Point(147, 0));
+            _sparks.Advance();
+            train = train.AddAt(_sparks.GetFrame(console), new Point(152, 0));
+        }
+
+        return train.Crop(
             console.GetSize().Width,
             console.GetSize().Height,
             _frame,
             0
-        ).Draw();
+        );
     }
 
     public void SetFrame(int frame)
diff --git a/Slt/Art/Slt/OutlineSlt.cs b/Slt/Art/Slt/OutlineSlt.cs
@@ -1,11 +1,13 @@
+using Slt.Art.Etc;
 using Slt.Ascii;
+using Slt.Cli;
 using Slt.Util;
 
 namespace Slt.Art.Slt;
 
 public class OutlineSlt : AbstractSlt
 {
-    public OutlineSlt() : base(
+    public OutlineSlt(AnimationConfiguration config) : base(
         new Figure(
             EmbeddedResource.ReadAllText("Slt.Art.Slt.Outline.DrivingCar.txt")
         ),
@@ -20,7 +22,8 @@ public OutlineSlt() : base(
         ),
         new Figure(
             EmbeddedResource.ReadAllText("Slt.Art.Slt.Outline.Connection.txt")
-        )
+        ),
+        config.ShowSparks ? new Sparks() : null
     )
     {
     }
diff --git a/Slt/Art/Slt/SolidSlt.cs b/Slt/Art/Slt/SolidSlt.cs
@@ -1,31 +1,34 @@
+using Slt.Art.Etc;
 using Slt.Ascii;
+using Slt.Cli;
 using Slt.Util;
 
 namespace Slt.Art.Slt;
 
 public class SolidSlt : AbstractSlt
 {
-    public SolidSlt(bool useColors = false) : base(
+    public SolidSlt(AnimationConfiguration config) : base(
         new Figure(
             EmbeddedResource.ReadAllText("Slt.Art.Slt.Solid.DrivingCar.txt"),
-            useColors ? EmbeddedResource.ReadAllText("Slt.Art.Slt.Solid.Colors.DrivingCar.txt") : ""
+            config.UseColors ? EmbeddedResource.ReadAllText("Slt.Art.Slt.Solid.Colors.DrivingCar.txt") : ""
         ),
         new Figure(
             EmbeddedResource.ReadAllText("Slt.Art.Slt.Solid.TrailerCar.txt"),
-            useColors ? EmbeddedResource.ReadAllText("Slt.Art.Slt.Solid.Colors.TrailerCar.txt") : ""
+            config.UseColors ? EmbeddedResource.ReadAllText("Slt.Art.Slt.Solid.Colors.TrailerCar.txt") : ""
         ),
         new Figure(
             EmbeddedResource.ReadAllText("Slt.Art.Slt.Solid.CollectorRoof.txt"),
-            useColors ? EmbeddedResource.ReadAllText("Slt.Art.Slt.Solid.Colors.CollectorRoof.txt") : ""
+            config.UseColors ? EmbeddedResource.ReadAllText("Slt.Art.Slt.Solid.Colors.CollectorRoof.txt") : ""
         ),
         new Figure(
             EmbeddedResource.ReadAllText("Slt.Art.Slt.Solid.FullLengthRoof.txt"),
-            useColors ? EmbeddedResource.ReadAllText("Slt.Art.Slt.Solid.Colors.FullLengthRoof.txt") : ""
+            config.UseColors ? EmbeddedResource.ReadAllText("Slt.Art.Slt.Solid.Colors.FullLengthRoof.txt") : ""
         ),
         new Figure(
             EmbeddedResource.ReadAllText("Slt.Art.Slt.Solid.Connection.txt"),
-            useColors ? EmbeddedResource.ReadAllText("Slt.Art.Slt.Solid.Colors.Connection.txt") : ""
-        )
+            config.UseColors ? EmbeddedResource.ReadAllText("Slt.Art.Slt.Solid.Colors.Connection.txt") : ""
+        ),
+        config.ShowSparks ? new Sparks(config.UseColors) : null
     )
     {
     }
diff --git a/Slt/Ascii/Colors.cs b/Slt/Ascii/Colors.cs
@@ -80,6 +80,7 @@ private static Color ConvertCodeToColor(char code)
         return code switch
         {
             'B' => Color.MediumBlue,
+            'b' => Color.LightSkyBlue,
             'D' => Color.DimGray,
             'G' => Color.Gray,
             'L' => Color.LightGray,
diff --git a/Slt/Ascii/Figure.cs b/Slt/Ascii/Figure.cs
@@ -6,7 +6,7 @@ namespace Slt.Ascii;
 ///     A Figure is an ASCII art drawing that can be arbitarily cropped and combined
 ///     with other Figures.
 /// </summary>
-public readonly struct Figure
+public readonly struct Figure : ICloneable
 {
     public readonly List<string> Lines;
     public readonly string ColorMap;
@@ -165,4 +165,9 @@ public override string ToString()
     {
         return string.Join("\n", Lines);
     }
+
+    public object Clone()
+    {
+        return new Figure(Lines, ColorMap);
+    }
 }
diff --git a/Slt/Ascii/IAnimation.cs b/Slt/Ascii/IAnimation.cs
@@ -12,7 +12,7 @@ public interface IAnimation
     /// </summary>
     /// <param name="console">Console where the frame will be displayed</param>
     /// <returns>The current frame of this animation</returns>
-    public string GetFrame(IConsole console);
+    public Figure GetFrame(IConsole console);
 
     /// <summary>
     ///     Set the animation to a specific frame
diff --git a/Slt/Cli/AnimationConfiguration.cs b/Slt/Cli/AnimationConfiguration.cs
@@ -0,0 +1,11 @@
+namespace Slt.Cli;
+
+public class AnimationConfiguration
+{
+    public bool UseLines = false;
+    public bool UseShapes = false;
+    public bool UseColors = false;
+    public double Speed = 1;
+    public bool ShowSparks = false;
+    public bool IsDebug = false;
+}
diff --git a/Slt/Cli/Consoles/InteractiveConsole.cs b/Slt/Cli/Consoles/InteractiveConsole.cs
@@ -40,7 +40,7 @@ public void Play(IAnimation animation, double speed)
         do
         {
             Console.SetCursorPosition(0, 0);
-            Console.Write(animation.GetFrame(this));
+            Console.Write(animation.GetFrame(this).Draw());
             animation.Advance();
             Thread.Sleep((int)(DefaultDelay / speed));
         } while (!animation.HasFinished());
diff --git a/Slt/Cli/SltCommand.cs b/Slt/Cli/SltCommand.cs
@@ -44,6 +44,11 @@ public static RootCommand Build()
         );
         speedOption.AddAlias("-s");
 
+        var sparkOption = new Option<bool>(
+            "--sparks",
+            "Generate sparks between (non-existing) overhead line and pantograph"
+        );
+
         var debugOption = new Option<bool>(
             "--debug",
             "Display static output without crops or animations"
@@ -56,30 +61,51 @@ public static RootCommand Build()
         command.AddOption(filledOption);
         command.AddOption(colorOption);
         command.AddOption(speedOption);
+        command.AddOption(sparkOption);
         command.AddOption(debugOption);
 
         command.SetHandler(
-            (bool useLines, bool useShapes, bool useColors, double speed, bool isDebug) =>
-            {
-                Handle(useLines, useShapes, useColors, speed, isDebug);
-            },
-            lineOption, filledOption, colorOption, speedOption, debugOption);
+            Handle,
+            lineOption,
+            filledOption,
+            colorOption,
+            speedOption,
+            sparkOption,
+            debugOption
+        );
 
         return command;
     }
 
-    private static void Handle(bool useLines, bool useShapes, bool useColors, double speed, bool isDebug)
+    private static void Handle(
+        bool useLines,
+        bool useShapes,
+        bool useColors,
+        double speed,
+        bool showSparks,
+        bool isDebug
+    )
     {
-        var animation = CreateAnimation(useLines, useShapes, useColors);
+        var config = new AnimationConfiguration
+        {
+            UseLines = useLines,
+            UseShapes = useShapes,
+            UseColors = useColors,
+            Speed = speed,
+            ShowSparks = showSparks,
+            IsDebug = isDebug
+        };
+
+        var animation = CreateAnimation(config);
 
-        IConsole console = isDebug ? new DebugConsole() : new InteractiveConsole();
-        console.Play(animation, speed);
+        IConsole console = config.IsDebug ? new DebugConsole() : new InteractiveConsole();
+        console.Play(animation, config.Speed);
     }
 
-    private static IAnimation CreateAnimation(bool useLines, bool useShapes, bool useColors)
+    private static IAnimation CreateAnimation(AnimationConfiguration config)
     {
-        return useShapes
-            ? new SolidSlt(useColors)
-            : new OutlineSlt();
+        return config.UseShapes
+            ? new SolidSlt(config)
+            : new OutlineSlt(config);
     }
 }
diff --git a/Slt/Slt.csproj b/Slt/Slt.csproj
@@ -19,6 +19,12 @@
     </ItemGroup>
 
     <ItemGroup>
+        <EmbeddedResource Include="Art\Etc\Outline\Colors\Sparks.txt">
+            <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+        </EmbeddedResource>
+        <EmbeddedResource Include="Art\Etc\Outline\Sparks.txt">
+            <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+        </EmbeddedResource>
         <EmbeddedResource Include="Art\Slt\Solid\CollectorRoof.txt">
             <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
         </EmbeddedResource>
diff --git a/SltTest/Art/Slt/OutlineSltTest.cs b/SltTest/Art/Slt/OutlineSltTest.cs
@@ -1,4 +1,5 @@
 using Slt.Art.Slt;
+using Slt.Cli;
 
 namespace SltTest.Art.Slt;
 
@@ -8,7 +9,7 @@ public class OutlineSltTest
     public void it_generates_outline()
     {
         //> Given
-        var train = new OutlineSlt();
+        var train = new OutlineSlt(new AnimationConfiguration());
         var expected = File.ReadAllText("Art/Fixtures/Outline.txt");
 
         //> When
diff --git a/SltTest/Art/Slt/SolidSltTest.cs b/SltTest/Art/Slt/SolidSltTest.cs
@@ -1,4 +1,5 @@
 using Slt.Art.Slt;
+using Slt.Cli;
 
 namespace SltTest.Art.Slt;
 
@@ -8,7 +9,7 @@ public class SolidSltTest
     public void it_generates_train()
     {
         //> Given
-        var train = new SolidSlt();
+        var train = new SolidSlt(new AnimationConfiguration());
         var expected = File.ReadAllText("Art/Fixtures/Solid.txt");
 
         //> When
diff --git a/SltTest/Cli/Consoles/InteractiveConsoleTest.cs b/SltTest/Cli/Consoles/InteractiveConsoleTest.cs
@@ -40,14 +40,14 @@ private class NotActuallyATrain : IAnimation
     {
         private int _frame;
 
-        public string GetFrame(IConsole console)
+        public Figure GetFrame(IConsole console)
         {
             return new Figure("Sprinter").Crop(
                 console.GetSize().Width,
                 console.GetSize().Height,
                 _frame,
                 0
-            ).Draw();
+            );
         }
 
         public void SetFrame(int frame)

-Original file line number
+Diff line change
@@ @@ -0,0 +1,15 @@ @@
 + bbb b
 +  b bbb
 +     b
 +b bbb
 + bbbbb
 +  bbbb
 +bbbbbb
 + bbbbbb
 +   bbb
 + bbb bbb
 +  b bbbbb
 +     bbb
 +   bbb b
 +    b bbb
 +       b
Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,13 @@`
	`1`	`+using Slt.Art.Etc;`
`1`	`2`	`using Slt.Ascii;`
	`3`	`+using Slt.Cli;`
`2`	`4`	`using Slt.Util;`
`3`	`5`
`4`	`6`	`namespace Slt.Art.Slt;`
`5`	`7`
`6`	`8`	`public class OutlineSlt : AbstractSlt`
`7`	`9`	`{`
`8`		`- public OutlineSlt() : base(`
	`10`	`+ public OutlineSlt(AnimationConfiguration config) : base(`
`9`	`11`	`new Figure(`
`10`	`12`	`EmbeddedResource.ReadAllText("Slt.Art.Slt.Outline.DrivingCar.txt")`
`11`	`13`	`),`
`@@ -20,7 +22,8 @@ public OutlineSlt() : base(`
`20`	`22`	`),`
`21`	`23`	`new Figure(`
`22`	`24`	`EmbeddedResource.ReadAllText("Slt.Art.Slt.Outline.Connection.txt")`
`23`		`- )`
	`25`	`+ ),`
	`26`	`+ config.ShowSparks ? new Sparks() : null`
`24`	`27`	`)`
`25`	`28`	`{`
`26`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,7 @@ private static Color ConvertCodeToColor(char code)`
`80`	`80`	`return code switch`
`81`	`81`	`{`
`82`	`82`	`'B' => Color.MediumBlue,`
	`83`	`+ 'b' => Color.LightSkyBlue,`
`83`	`84`	`'D' => Color.DimGray,`
`84`	`85`	`'G' => Color.Gray,`
`85`	`86`	`'L' => Color.LightGray,`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ namespace Slt.Ascii;`
`6`	`6`	`/// A Figure is an ASCII art drawing that can be arbitarily cropped and combined`
`7`	`7`	`/// with other Figures.`
`8`	`8`	`/// </summary>`
`9`		`-public readonly struct Figure`
	`9`	`+public readonly struct Figure : ICloneable`
`10`	`10`	`{`
`11`	`11`	`public readonly List<string> Lines;`
`12`	`12`	`public readonly string ColorMap;`
`@@ -165,4 +165,9 @@ public override string ToString()`
`165`	`165`	`{`
`166`	`166`	`return string.Join("\n", Lines);`
`167`	`167`	`}`
	`168`	`+`
	`169`	`+ public object Clone()`
	`170`	`+ {`
	`171`	`+ return new Figure(Lines, ColorMap);`
	`172`	`+ }`
`168`	`173`	`}`