Merge pull request #150 from SixLabors/js/region-clip

Remove Region and add new Clip Extension

Author: JimBobSquarePants

src/ImageSharp.Drawing/Primitives/Region.cs

@@ -1,72 +1,66 @@
 // Copyright (c) Six Labors.
 // Licensed under the Apache License, Version 2.0.
 
-using SixLabors.ImageSharp.Drawing.Processing.Processors.Drawing;
 using SixLabors.ImageSharp.Processing;
 
 namespace SixLabors.ImageSharp.Drawing.Processing
 {
     /// <summary>
-    /// Adds extensions that allow the clearing of regions with various brushes to the <see cref="Image{TPixel}"/> type.
+    /// Adds extensions that allow the flood filling of images without blending.
     /// </summary>
     public static class ClearExtensions
     {
         /// <summary>
-        /// Clones the graphic options and applies changes required to force clearing.
+        /// Flood fills the image with the specified color without any blending.
         /// </summary>
-        /// <param name="options">The options to clone</param>
-        /// <returns>A clone of option with ColorBlendingMode, AlphaCompositionMode, and BlendPercentage set</returns>
-        internal static GraphicsOptions CloneForClearOperation(this GraphicsOptions options)
-        {
-            options = options.DeepClone();
-            options.ColorBlendingMode = PixelFormats.PixelColorBlendingMode.Normal;
-            options.AlphaCompositionMode = PixelFormats.PixelAlphaCompositionMode.Src;
-            options.BlendPercentage = 1;
-            return options;
-        }
+        /// <param name="source">The image processing context.</param>
+        /// <param name="color">The color.</param>
+        /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+        public static IImageProcessingContext Clear(this IImageProcessingContext source, Color color)
+            => source.Clear(new SolidBrush(color));
 
         /// <summary>
-        /// Flood fills the image with the specified brush without any blending.
+        /// Flood fills the image with the specified color without any blending.
         /// </summary>
-        /// <param name="source">The image this method extends.</param>
-        /// <param name="options">The graphics options.</param>
-        /// <param name="brush">The details how to fill the region of interest.</param>
+        /// <param name="source">The image processing context.</param>
+        /// <param name="options">The drawing options.</param>
+        /// <param name="color">The color.</param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
-        public static IImageProcessingContext Clear(
-            this IImageProcessingContext source,
-            GraphicsOptions options,
-            IBrush brush)
-            => source.Fill(options.CloneForClearOperation(), brush);
+        public static IImageProcessingContext Clear(this IImageProcessingContext source, DrawingOptions options, Color color)
+            => source.Clear(options, new SolidBrush(color));
 
         /// <summary>
         /// Flood fills the image with the specified brush without any blending.
         /// </summary>
-        /// <param name="source">The image this method extends.</param>
-        /// <param name="brush">The details how to fill the region of interest.</param>
+        /// <param name="source">The image processing context.</param>
+        /// <param name="brush">The brush.</param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Clear(this IImageProcessingContext source, IBrush brush) =>
-            source.Clear(source.GetGraphicsOptions(), brush);
+            source.Clear(source.GetDrawingOptions(), brush);
 
         /// <summary>
-        /// Flood fills the image with the specified color without any blending.
+        /// Flood fills the image with the specified brush without any blending.
         /// </summary>
-        /// <param name="source">The image this method extends.</param>
-        /// <param name="options">The graphics options.</param>
-        /// <param name="color">The color.</param>
+        /// <param name="source">The image processing context.</param>
+        /// <param name="options">The drawing options.</param>
+        /// <param name="brush">The brush.</param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
-        public static IImageProcessingContext Clear(
-            this IImageProcessingContext source,
-            GraphicsOptions options,
-            Color color) =>
-            source.Clear(options, new SolidBrush(color));
+        public static IImageProcessingContext Clear(this IImageProcessingContext source, DrawingOptions options, IBrush brush)
+            => source.Fill(options.CloneForClearOperation(), brush);
 
         /// <summary>
-        /// Flood fills the image with the specified color without any blending.
+        /// Clones the path graphic options and applies changes required to force clearing.
         /// </summary>
-        /// <param name="source">The image this method extends.</param>
-        /// <param name="color">The color.</param>
-        /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
-        public static IImageProcessingContext Clear(this IImageProcessingContext source, Color color) =>
-            source.Clear(new SolidBrush(color));
+        /// <param name="drawingOptions">The drawing options to clone</param>
+        /// <returns>A clone of shapeOptions with ColorBlendingMode, AlphaCompositionMode, and BlendPercentage set</returns>
+        internal static DrawingOptions CloneForClearOperation(this DrawingOptions drawingOptions)
+        {
+            GraphicsOptions options = drawingOptions.GraphicsOptions.DeepClone();
+            options.ColorBlendingMode = PixelFormats.PixelColorBlendingMode.Normal;
+            options.AlphaCompositionMode = PixelFormats.PixelAlphaCompositionMode.Src;
+            options.BlendPercentage = 1F;
+
+            return new DrawingOptions(options, drawingOptions.ShapeOptions, drawingOptions.TextOptions, drawingOptions.Transform);
+        }
     }
 }

src/ImageSharp.Drawing/Primitives/ShapePath.cs

@@ -1,79 +1,73 @@
 // Copyright (c) Six Labors.
 // Licensed under the Apache License, Version 2.0.
 
-using SixLabors.ImageSharp.Drawing.Processing.Processors.Drawing;
 using SixLabors.ImageSharp.Processing;
 
 namespace SixLabors.ImageSharp.Drawing.Processing
 {
     /// <summary>
-    /// Adds extensions that allow the filling of polygon outlines to the <see cref="Image{TPixel}"/> type.
+    /// Adds extensions that allow the flood filling of polygon outlines without blending.
     /// </summary>
     public static class ClearPathExtensions
     {
         /// <summary>
-        /// Clones the shape graphic options and applies changes required to force clearing.
+        /// Flood fills the image within the provided region defined by an <see cref="IPath"/> using the specified
+        /// color without any blending.
         /// </summary>
-        /// <param name="shapeOptions">The options to clone</param>
-        /// <returns>A clone of shapeOptions with ColorBlendingMode, AlphaCompositionMode, and BlendPercentage set</returns>
-        internal static DrawingOptions CloneForClearOperation(this DrawingOptions shapeOptions)
-        {
-            GraphicsOptions options = shapeOptions.GraphicsOptions.DeepClone();
-            options.ColorBlendingMode = PixelFormats.PixelColorBlendingMode.Normal;
-            options.AlphaCompositionMode = PixelFormats.PixelAlphaCompositionMode.Src;
-            options.BlendPercentage = 1;
-
-            return new DrawingOptions(options, shapeOptions.ShapeOptions, shapeOptions.TextOptions, shapeOptions.Transform);
-        }
+        /// <param name="source">The image processing context.</param>
+        /// <param name="color">The color.</param>
+        /// <param name="region">The <see cref="IPath"/> defining the region to fill.</param>
+        /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+        public static IImageProcessingContext Clear(
+            this IImageProcessingContext source,
+            Color color,
+            IPath region)
+            => source.Clear(new SolidBrush(color), region);
 
         /// <summary>
-        /// Flood fills the image in the shape of the provided polygon with the specified brush without any blending.
+        /// Flood fills the image within the provided region defined by an <see cref="IPath"/> using the specified color
+        /// without any blending.
         /// </summary>
-        /// <param name="source">The image this method extends.</param>
-        /// <param name="options">The graphics options.</param>
-        /// <param name="brush">The brush.</param>
-        /// <param name="path">The shape.</param>
+        /// <param name="source">The image processing context.</param>
+        /// <param name="options">The drawing options.</param>
+        /// <param name="color">The color.</param>
+        /// <param name="region">The <see cref="IPath"/> defining the region to fill.</param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Clear(
             this IImageProcessingContext source,
             DrawingOptions options,
-            IBrush brush,
-            IPath path) =>
-            source.Fill(options.CloneForClearOperation(), brush, path);
+            Color color,
+            IPath region)
+            => source.Clear(options, new SolidBrush(color), region);
 
         /// <summary>
-        /// Flood fills the image in the shape of the provided polygon with the specified brush without any blending.
+        /// Flood fills the image within the provided region defined by an <see cref="IPath"/> using the specified brush
+        /// without any blending.
         /// </summary>
-        /// <param name="source">The image this method extends.</param>
+        /// <param name="source">The image processing context.</param>
         /// <param name="brush">The brush.</param>
-        /// <param name="path">The path.</param>
+        /// <param name="region">The <see cref="IPath"/> defining the region to fill.</param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
-        public static IImageProcessingContext Clear(this IImageProcessingContext source, IBrush brush, IPath path) =>
-            source.Clear(source.GetDrawingOptions(), brush, path);
+        public static IImageProcessingContext Clear(
+            this IImageProcessingContext source,
+            IBrush brush,
+            IPath region)
+            => source.Clear(source.GetDrawingOptions(), brush, region);
 
         /// <summary>
-        /// Flood fills the image in the shape of the provided polygon with the specified brush without any blending.
+        /// Flood fills the image within the provided region defined by an <see cref="IPath"/> using the specified brush
+        /// without any blending.
         /// </summary>
-        /// <param name="source">The image this method extends.</param>
-        /// <param name="options">The options.</param>
-        /// <param name="color">The color.</param>
-        /// <param name="path">The path.</param>
+        /// <param name="source">The image processing context.</param>
+        /// <param name="options">The drawing options.</param>
+        /// <param name="brush">The brush.</param>
+        /// <param name="region">The <see cref="IPath"/> defining the region to fill.</param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Clear(
             this IImageProcessingContext source,
             DrawingOptions options,
-            Color color,
-            IPath path) =>
-            source.Clear(options, new SolidBrush(color), path);
-
-        /// <summary>
-        /// Flood fills the image in the shape of the provided polygon with the specified brush without any blending.
-        /// </summary>
-        /// <param name="source">The image this method extends.</param>
-        /// <param name="color">The color.</param>
-        /// <param name="path">The path.</param>
-        /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
-        public static IImageProcessingContext Clear(this IImageProcessingContext source, Color color, IPath path) =>
-            source.Clear(new SolidBrush(color), path);
+            IBrush brush,
+            IPath region)
+            => source.Fill(options.CloneForClearOperation(), brush, region);
     }
 }