Fix method inheritance and update samples

Author: JimBobSquarePants

samples/DrawShapesWithImageSharp/Program.cs

@@ -189,7 +189,7 @@ private static void OutputStarOutline(int points, float inner = 10, float outer
             float offset = outer + 10;
 
             var star = new Star(offset, offset, points, inner, outer);
-            IPath outline = star.GenerateOutline(width, jointStyle);
+            IPath outline = star.GenerateOutline(width, jointStyle, EndCapStyle.Butt);
             outline.SaveImage("Stars", $"StarOutline_{points}_{jointStyle}.png");
         }
 

src/ImageSharp.Drawing/Processing/IPen.cs

@@ -31,8 +31,8 @@ public interface IPen
         public JointStyle JointStyle { get; set; }
 
         /// <summary>
-        /// Gets or sets the endcap style
+        /// Gets or sets the stroke endcap style
         /// </summary>
-        public EndCapStyle EndCap { get; set; }
+        public EndCapStyle EndCapStyle { get; set; }
     }
 }

src/ImageSharp.Drawing/Processing/Pen.cs

@@ -79,6 +79,6 @@ public Pen(IBrush brush, float width)
         public JointStyle JointStyle { get; set; }
 
         /// <inheritdoc/>
-        public EndCapStyle EndCap { get; set; }
+        public EndCapStyle EndCapStyle { get; set; }
     }
 }

src/ImageSharp.Drawing/Processing/Processors/Drawing/DrawPathProcessor.cs

@@ -49,7 +49,7 @@ public IImageProcessor<TPixel> CreatePixelSpecificProcessor<TPixel>(Configuratio
             // The global transform is applied in the FillPathProcessor.
             IPath outline = this.Path
                 .Transform(Matrix3x2.CreateTranslation(0.5F, 0.5F))
-                .GenerateOutline(this.Pen.StrokeWidth, this.Pen.StrokePattern, this.Pen.JointStyle, this.Pen.EndCap);
+                .GenerateOutline(this.Pen.StrokeWidth, this.Pen.StrokePattern, this.Pen.JointStyle, this.Pen.EndCapStyle);
 
             return new FillPathProcessor(this.Options, this.Pen.StrokeFill, outline)
                 .CreatePixelSpecificProcessor(configuration, source, sourceRectangle);

src/ImageSharp.Drawing/Processing/Processors/Text/DrawTextProcessor{TPixel}.cs

@@ -306,7 +306,7 @@ public void EndGlyph()
                         }
                         else
                         {
-                            path = path.GenerateOutline(this.Pen.StrokeWidth, this.Pen.StrokePattern, this.Pen.JointStyle, this.Pen.EndCap);
+                            path = path.GenerateOutline(this.Pen.StrokeWidth, this.Pen.StrokePattern, this.Pen.JointStyle, this.Pen.EndCapStyle);
                         }
 
                         renderData.OutlineMap = this.Render(path);

src/ImageSharp.Drawing/Shapes/EndCapStyle.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Six Labors.
+// Copyright (c) Six Labors.
 // Licensed under the Apache License, Version 2.0.
 
 namespace SixLabors.ImageSharp.Drawing

src/ImageSharp.Drawing/Shapes/JointStyle.cs

@@ -1,15 +1,15 @@
-// Copyright (c) Six Labors.
+// Copyright (c) Six Labors.
 // Licensed under the Apache License, Version 2.0.
 
 namespace SixLabors.ImageSharp.Drawing
 {
     /// <summary>
-    /// The style we use to generate the joints when outlining.
+    /// The style to apply to the joints when generating an outline.
     /// </summary>
     public enum JointStyle
     {
         /// <summary>
-        /// Joints will generate to a long point unless the end of the point will exceed 20 times the width then we generate the joint using <see cref="JointStyle.Square"/>.
+        /// Joints will generate to a long point unless the end of the point will exceed 20 times the width then we generate the joint using <see cref="Square"/>.
         /// </summary>
         Miter = 2,
 

src/ImageSharp.Drawing/Shapes/OutlinePathExtensions.cs

@@ -9,93 +9,98 @@
 namespace SixLabors.ImageSharp.Drawing
 {
     /// <summary>
-    /// Path extensions to generate outlines of paths.
+    /// Extensions to <see cref="IPath"/> that allow the generation of outlines.
     /// </summary>
     public static class OutlinePathExtensions
     {
         private const double MiterOffsetDelta = 20;
+        private const JointStyle DefaultJointStyle = JointStyle.Square;
+        private const EndCapStyle DefaultEndCapStyle = EndCapStyle.Butt;
 
         /// <summary>
-        /// Generates a outline of the path with alternating on and off segments based on the pattern.
+        /// Generates an outline of the path.
         /// </summary>
-        /// <param name="path">the path to outline</param>
-        /// <param name="width">The final width outline</param>
-        /// <param name="pattern">The pattern made of multiples of the width.</param>
-        /// <returns>A new path representing the outline.</returns>
-        /// <exception cref="ClipperException">Couldn't calculate offset.</exception>
-        public static IPath GenerateOutline(this IPath path, float width, float[] pattern)
-            => path.GenerateOutline(width, new ReadOnlySpan<float>(pattern));
+        /// <param name="path">The path to outline</param>
+        /// <param name="width">The outline width.</param>
+        /// <returns>A new <see cref="IPath"/> representing the outline.</returns>
+        /// <exception cref="ClipperException">Thrown when an offset cannot be calculated.</exception>
+        public static IPath GenerateOutline(this IPath path, float width) => GenerateOutline(path, width, DefaultJointStyle, DefaultEndCapStyle);
 
         /// <summary>
-        /// Generates a outline of the path with alternating on and off segments based on the pattern.
+        /// Generates an outline of the path.
         /// </summary>
-        /// <param name="path">the path to outline</param>
-        /// <param name="width">The final width outline</param>
-        /// <param name="pattern">The pattern made of multiples of the width.</param>
-        /// <returns>A new path representing the outline.</returns>
-        /// <exception cref="ClipperException">Couldn't calculate offset.</exception>
-        public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<float> pattern)
-            => path.GenerateOutline(width, pattern, false);
+        /// <param name="path">The path to outline</param>
+        /// <param name="width">The outline width.</param>
+        /// <param name="jointStyle">The style to apply to the joints.</param>
+        /// <param name="endCapStyle">The style to apply to the end caps.</param>
+        /// <returns>A new <see cref="IPath"/> representing the outline.</returns>
+        /// <exception cref="ClipperException">Thrown when an offset cannot be calculated.</exception>
+        public static IPath GenerateOutline(this IPath path, float width, JointStyle jointStyle, EndCapStyle endCapStyle)
+        {
+            ClipperOffset offset = new(MiterOffsetDelta);
+            offset.AddPath(path, jointStyle, endCapStyle);
+
+            return offset.Execute(width);
+        }
 
         /// <summary>
-        /// Generates a outline of the path with alternating on and off segments based on the pattern.
+        /// Generates an outline of the path with alternating on and off segments based on the pattern.
         /// </summary>
-        /// <param name="path">the path to outline</param>
-        /// <param name="width">The final width outline</param>
+        /// <param name="path">The path to outline</param>
+        /// <param name="width">The outline width.</param>
         /// <param name="pattern">The pattern made of multiples of the width.</param>
-        /// <param name="startOff">Weather the first item in the pattern is on or off.</param>
-        /// <returns>A new path representing the outline.</returns>
-        /// <exception cref="ClipperException">Couldn't calculate offset.</exception>
-        public static IPath GenerateOutline(this IPath path, float width, float[] pattern, bool startOff)
-            => path.GenerateOutline(width, new ReadOnlySpan<float>(pattern), startOff);
+        /// <returns>A new <see cref="IPath"/> representing the outline.</returns>
+        /// <exception cref="ClipperException">Thrown when an offset cannot be calculated.</exception>
+        public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<float> pattern)
+            => path.GenerateOutline(width, pattern, false);
 
         /// <summary>
-        /// Generates a outline of the path with alternating on and off segments based on the pattern.
+        /// Generates an outline of the path with alternating on and off segments based on the pattern.
         /// </summary>
-        /// <param name="path">the path to outline</param>
-        /// <param name="width">The final width outline</param>
+        /// <param name="path">The path to outline</param>
+        /// <param name="width">The outline width.</param>
         /// <param name="pattern">The pattern made of multiples of the width.</param>
-        /// <param name="startOff">Weather the first item in the pattern is on or off.</param>
-        /// <returns>A new path representing the outline.</returns>
-        /// <exception cref="ClipperException">Couldn't calculate offset.</exception>
+        /// <param name="startOff">Whether the first item in the pattern is on or off.</param>
+        /// <returns>A new <see cref="IPath"/> representing the outline.</returns>
+        /// <exception cref="ClipperException">Thrown when an offset cannot be calculated.</exception>
         public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<float> pattern, bool startOff)
-            => GenerateOutline(path, width, pattern, startOff, JointStyle.Square, EndCapStyle.Butt);
+            => GenerateOutline(path, width, pattern, startOff, DefaultJointStyle, DefaultEndCapStyle);
 
         /// <summary>
-        /// Generates a outline of the path with alternating on and off segments based on the pattern.
+        /// Generates an outline of the path with alternating on and off segments based on the pattern.
         /// </summary>
-        /// <param name="path">the path to outline</param>
-        /// <param name="width">The final width outline</param>
+        /// <param name="path">The path to outline</param>
+        /// <param name="width">The outline width.</param>
         /// <param name="pattern">The pattern made of multiples of the width.</param>
-        /// <param name="jointStyle">The style to render the joints.</param>
-        /// <param name="patternSectionCapStyle">The style to render between sections of the specified pattern.</param>
-        /// <returns>A new path representing the outline.</returns>
-        /// <exception cref="ClipperException">Couldn't calculate offset.</exception>
-        public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<float> pattern, JointStyle jointStyle, EndCapStyle patternSectionCapStyle)
-            => GenerateOutline(path, width, pattern, false, jointStyle, patternSectionCapStyle);
+        /// <param name="jointStyle">The style to apply to the joints.</param>
+        /// <param name="endCapStyle">The style to apply to the end caps.</param>
+        /// <returns>A new <see cref="IPath"/> representing the outline.</returns>
+        /// <exception cref="ClipperException">Thrown when an offset cannot be calculated.</exception>
+        public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<float> pattern, JointStyle jointStyle, EndCapStyle endCapStyle)
+            => GenerateOutline(path, width, pattern, false, jointStyle, endCapStyle);
 
         /// <summary>
-        /// Generates a outline of the path with alternating on and off segments based on the pattern.
+        /// Generates an outline of the path with alternating on and off segments based on the pattern.
         /// </summary>
-        /// <param name="path">the path to outline</param>
-        /// <param name="width">The final width outline</param>
+        /// <param name="path">The path to outline</param>
+        /// <param name="width">The outline width.</param>
         /// <param name="pattern">The pattern made of multiples of the width.</param>
-        /// <param name="startOff">Weather the first item in the pattern is on or off.</param>
-        /// <param name="jointStyle">The style to render the joints.</param>
-        /// <param name="patternSectionCapStyle">The style to render between sections of the specified pattern.</param>
-        /// <returns>A new path representing the outline.</returns>
-        /// <exception cref="ClipperException">Couldn't calculate offset.</exception>
-        public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<float> pattern, bool startOff, JointStyle jointStyle = JointStyle.Square, EndCapStyle patternSectionCapStyle = EndCapStyle.Butt)
+        /// <param name="startOff">Whether the first item in the pattern is on or off.</param>
+        /// <param name="jointStyle">The style to apply to the joints.</param>
+        /// <param name="endCapStyle">The style to apply to the end caps.</param>
+        /// <returns>A new <see cref="IPath"/> representing the outline.</returns>
+        /// <exception cref="ClipperException">Thrown when an offset cannot be calculated.</exception>
+        public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<float> pattern, bool startOff, JointStyle jointStyle, EndCapStyle endCapStyle)
         {
             if (pattern.Length < 2)
             {
-                return path.GenerateOutline(width, jointStyle: jointStyle);
+                return path.GenerateOutline(width, jointStyle, endCapStyle);
             }
 
             IEnumerable<ISimplePath> paths = path.Flatten();
 
-            var offset = new ClipperOffset(MiterOffsetDelta);
-            var buffer = new List<PointF>();
+            ClipperOffset offset = new(MiterOffsetDelta);
+            List<PointF> buffer = new();
             foreach (ISimplePath p in paths)
             {
                 bool online = !startOff;
@@ -130,7 +135,7 @@ public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<f
                         // we now inset a line joining
                         if (online)
                         {
-                            offset.AddPath(new ReadOnlySpan<PointF>(buffer.ToArray()), jointStyle, patternSectionCapStyle);
+                            offset.AddPath(new ReadOnlySpan<PointF>(buffer.ToArray()), jointStyle, endCapStyle);
                         }
 
                         online = !online;
@@ -165,7 +170,7 @@ public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<f
 
                     if (online)
                     {
-                        offset.AddPath(new ReadOnlySpan<PointF>(buffer.ToArray()), jointStyle, patternSectionCapStyle);
+                        offset.AddPath(new ReadOnlySpan<PointF>(buffer.ToArray()), jointStyle, endCapStyle);
                     }
 
                     online = !online;
@@ -178,31 +183,5 @@ public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<f
 
             return offset.Execute(width);
         }
-
-        /// <summary>
-        /// Generates a solid outline of the path.
-        /// </summary>
-        /// <param name="path">the path to outline</param>
-        /// <param name="width">The final width outline</param>
-        /// <returns>A new path representing the outline.</returns>
-        /// <exception cref="ClipperException">Couldn't calculate offset.</exception>
-        public static IPath GenerateOutline(this IPath path, float width) => GenerateOutline(path, width, JointStyle.Square, EndCapStyle.Butt);
-
-        /// <summary>
-        /// Generates a solid outline of the path.
-        /// </summary>
-        /// <param name="path">the path to outline</param>
-        /// <param name="width">The final width outline</param>
-        /// <param name="jointStyle">The style to render the joints.</param>
-        /// <param name="endCapStyle">The style to render the end caps of open paths (ignored on closed paths).</param>
-        /// <returns>A new path representing the outline.</returns>
-        /// <exception cref="ClipperException">Couldn't calculate offset.</exception>
-        public static IPath GenerateOutline(this IPath path, float width, JointStyle jointStyle = JointStyle.Square, EndCapStyle endCapStyle = EndCapStyle.Square)
-        {
-            var offset = new ClipperOffset(MiterOffsetDelta);
-            offset.AddPath(path, jointStyle, endCapStyle);
-
-            return offset.Execute(width);
-        }
     }
 }

src/ImageSharp.Drawing/Shapes/PolygonClipper/ClipperOffset.cs

@@ -16,7 +16,7 @@ internal class ClipperOffset
         private const float ScalingFactor = 1000.0f;
 
         private readonly ClipperLib.ClipperOffset innerClipperOffest;
-        private readonly object syncRoot = new object();
+        private readonly object syncRoot = new();
 
         /// <summary>
         /// Initializes a new instance of the <see cref="ClipperOffset"/> class.
@@ -111,19 +111,19 @@ private void AddPath(ReadOnlySpan<PointF> pathPoints, JointStyle jointStyle, End
         }
 
         private JoinType Convert(JointStyle style)
-        => style switch
-        {
-            JointStyle.Round => JoinType.jtRound,
-            JointStyle.Miter => JoinType.jtMiter,
-            _ => JoinType.jtSquare,
-        };
+            => style switch
+            {
+                JointStyle.Round => JoinType.jtRound,
+                JointStyle.Miter => JoinType.jtMiter,
+                _ => JoinType.jtSquare,
+            };
 
         private EndType Convert(EndCapStyle style)
-        => style switch
-        {
-            EndCapStyle.Round => EndType.etOpenRound,
-            EndCapStyle.Square => EndType.etOpenSquare,
-            _ => EndType.etOpenButt,
-        };
+            => style switch
+            {
+                EndCapStyle.Round => EndType.etOpenRound,
+                EndCapStyle.Square => EndType.etOpenSquare,
+                _ => EndType.etOpenButt,
+            };
     }
 }

tests/ImageSharp.Drawing.Tests/Drawing/DrawLinesTests.cs

@@ -77,7 +77,7 @@ public void DrawLines_EndCapRound<TPixel>(TestImageProvider<TPixel> provider, st
         {
             Color color = TestUtils.GetColorByName(colorName).WithAlpha(alpha);
             Pen pen = new Pen(color, thickness, new float[] { 3f, 3f });
-            pen.EndCap = EndCapStyle.Round;
+            pen.EndCapStyle = EndCapStyle.Round;
 
             DrawLinesImpl(provider, colorName, alpha, thickness, antialias, pen);
         }
@@ -89,7 +89,7 @@ public void DrawLines_EndCapButt<TPixel>(TestImageProvider<TPixel> provider, str
         {
             Color color = TestUtils.GetColorByName(colorName).WithAlpha(alpha);
             Pen pen = new Pen(color, thickness, new float[] { 3f, 3f });
-            pen.EndCap = EndCapStyle.Butt;
+            pen.EndCapStyle = EndCapStyle.Butt;
 
             DrawLinesImpl(provider, colorName, alpha, thickness, antialias, pen);
         }
@@ -101,7 +101,7 @@ public void DrawLines_EndCapSquare<TPixel>(TestImageProvider<TPixel> provider, s
         {
             Color color = TestUtils.GetColorByName(colorName).WithAlpha(alpha);
             Pen pen = new Pen(color, thickness, new float[] { 3f, 3f });
-            pen.EndCap = EndCapStyle.Square;
+            pen.EndCapStyle = EndCapStyle.Square;
 
             DrawLinesImpl(provider, colorName, alpha, thickness, antialias, pen);
         }