Merge pull request #126 from SixLabors/sw/drawing-transforms

Apply global matrix transform drawing text and shapes.

Author: tocsoft

…awing/Processing/ShapeGraphicsOptions.cs …arp.Drawing/Processing/DrawingOptions.cssrc/ImageSharp.Drawing/Processing/ShapeGraphicsOptions.cs renamed to src/ImageSharp.Drawing/Processing/DrawingOptions.cs src/ImageSharp.Drawing/Processing/ShapeGraphicsOptions.cs renamed to src/ImageSharp.Drawing/Processing/DrawingOptions.cs

@@ -2,6 +2,7 @@
 // Licensed under the Apache License, Version 2.0.
 
 using System;
+using System.Numerics;
 using SixLabors.ImageSharp.PixelFormats;
 using SixLabors.ImageSharp.Processing;
 
@@ -10,31 +11,37 @@ namespace SixLabors.ImageSharp.Drawing.Processing
     /// <summary>
     /// Options for influencing the drawing functions.
     /// </summary>
-    public class ShapeGraphicsOptions
+    public class DrawingOptions
     {
         private GraphicsOptions graphicsOptions;
         private ShapeOptions shapeOptions;
+        private TextOptions textOptions;
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="ShapeGraphicsOptions"/> class.
+        /// Initializes a new instance of the <see cref="DrawingOptions"/> class.
         /// </summary>
-        public ShapeGraphicsOptions()
+        public DrawingOptions()
         {
             this.graphicsOptions = new GraphicsOptions();
             this.shapeOptions = new ShapeOptions();
+            this.textOptions = new TextOptions();
+            this.Transform = Matrix3x2.Identity;
         }
 
-        /// <summary>
-        /// Initializes a new instance of the <see cref="ShapeGraphicsOptions"/> class.
-        /// </summary>
-        /// <param name="graphicsOptions">The graphic options to use</param>
-        /// <param name="shapeOptions">The text options to use</param>
-        public ShapeGraphicsOptions(GraphicsOptions graphicsOptions, ShapeOptions shapeOptions)
+        internal DrawingOptions(
+            GraphicsOptions graphicsOptions,
+            ShapeOptions shapeOptions,
+            TextOptions textOptions,
+            Matrix3x2 transform)
         {
-            Guard.NotNull(graphicsOptions, nameof(graphicsOptions));
-            Guard.NotNull(shapeOptions, nameof(shapeOptions));
+            DebugGuard.NotNull(graphicsOptions, nameof(graphicsOptions));
+            DebugGuard.NotNull(shapeOptions, nameof(shapeOptions));
+            DebugGuard.NotNull(textOptions, nameof(textOptions));
+
             this.graphicsOptions = graphicsOptions;
             this.shapeOptions = shapeOptions;
+            this.textOptions = textOptions;
+            this.Transform = transform;
         }
 
         /// <summary>
@@ -51,7 +58,7 @@ public GraphicsOptions GraphicsOptions
         }
 
         /// <summary>
-        /// Gets or sets the Text Options.
+        /// Gets or sets the Shape Options.
         /// </summary>
         public ShapeOptions ShapeOptions
         {
@@ -62,5 +69,23 @@ public ShapeOptions ShapeOptions
                 this.shapeOptions = value;
             }
         }
+
+        /// <summary>
+        /// Gets or sets the Text Options.
+        /// </summary>
+        public TextOptions TextOptions
+        {
+            get => this.textOptions;
+            set
+            {
+                Guard.NotNull(value, nameof(this.TextOptions));
+                this.textOptions = value;
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the Transform to apply during rasterization.
+        /// </summary>
+        public Matrix3x2 Transform { get; set; }
     }
 }

src/ImageSharp.Drawing/Processing/DrawingOptionsDefaultsExtensions.cs

@@ -0,0 +1,80 @@
+// Copyright (c) Six Labors.
+// Licensed under the Apache License, Version 2.0.
+
+using System.Numerics;
+using SixLabors.ImageSharp.Processing;
+
+namespace SixLabors.ImageSharp.Drawing.Processing
+{
+    /// <summary>
+    /// Adds extensions that help working with <see cref="DrawingOptions" />.
+    /// </summary>
+    public static class DrawingOptionsDefaultsExtensions
+    {
+        private const string DrawingTransformMatrixKey = "DrawingTransformMatrix3x2";
+
+        /// <summary>
+        /// Gets the default shape processing options against the image processing context.
+        /// </summary>
+        /// <param name="context">The image processing context to retrieve defaults from.</param>
+        /// <returns>The globally configured default options.</returns>
+        public static DrawingOptions GetDrawingOptions(this IImageProcessingContext context)
+            => new DrawingOptions(context.GetGraphicsOptions(), context.GetShapeOptions(), context.GetTextOptions(), context.GetDrawingTransform());
+
+        /// <summary>
+        /// Sets the 2D transformation matrix to be used during rasterization when drawing shapes or text.
+        /// </summary>
+        /// <param name="context">The image processing context to store default against.</param>
+        /// <param name="matrix">The matrix to use.</param>
+        /// <returns>The passed in <paramref name="context"/> to allow chaining.</returns>
+        public static IImageProcessingContext SetDrawingTransform(this IImageProcessingContext context, Matrix3x2 matrix)
+        {
+            context.Properties[DrawingTransformMatrixKey] = matrix;
+            return context;
+        }
+
+        /// <summary>
+        /// Sets the default 2D transformation matrix to be used during rasterization when drawing shapes or text.
+        /// </summary>
+        /// <param name="configuration">The configuration to store default against.</param>
+        /// <param name="matrix">The default matrix to use.</param>
+        public static void SetDrawingTransform(this Configuration configuration, Matrix3x2 matrix)
+        {
+            configuration.Properties[DrawingTransformMatrixKey] = matrix;
+        }
+
+        /// <summary>
+        /// Gets the default 2D transformation matrix to be used during rasterization when drawing shapes or text.
+        /// </summary>
+        /// <param name="context">The image processing context to retrieve defaults from.</param>
+        /// <returns>The matrix.</returns>
+        public static Matrix3x2 GetDrawingTransform(this IImageProcessingContext context)
+        {
+            if (context.Properties.TryGetValue(DrawingTransformMatrixKey, out var options) && options is Matrix3x2 go)
+            {
+                return go;
+            }
+
+            Matrix3x2 matrix = context.Configuration.GetDrawingTransform();
+
+            // do not cache the fall back to config into the processing context
+            // in case someone want to change the value on the config and expects it re-flow thru.
+            return matrix;
+        }
+
+        /// <summary>
+        /// Gets the default 2D transformation matrix to be used during rasterization when drawing shapes or text.
+        /// </summary>
+        /// <param name="configuration">The configuration to retrieve defaults from.</param>
+        /// <returns>The globally configured default matrix.</returns>
+        public static Matrix3x2 GetDrawingTransform(this Configuration configuration)
+        {
+            if (configuration.Properties.TryGetValue(DrawingTransformMatrixKey, out var options) && options is Matrix3x2 go)
+            {
+                return go;
+            }
+
+            return Matrix3x2.Identity;
+        }
+    }
+}

src/ImageSharp.Drawing/Processing/Extensions/ClearPathExtensions.cs

@@ -16,14 +16,14 @@ public static class ClearPathExtensions
         /// </summary>
         /// <param name="shapeOptions">The options to clone</param>
         /// <returns>A clone of shapeOptions with ColorBlendingMode, AlphaCompositionMode, and BlendPercentage set</returns>
-        internal static ShapeGraphicsOptions CloneForClearOperation(this ShapeGraphicsOptions shapeOptions)
+        internal static DrawingOptions CloneForClearOperation(this DrawingOptions shapeOptions)
         {
-            var options = shapeOptions.GraphicsOptions.DeepClone();
+            GraphicsOptions options = shapeOptions.GraphicsOptions.DeepClone();
             options.ColorBlendingMode = PixelFormats.PixelColorBlendingMode.Normal;
             options.AlphaCompositionMode = PixelFormats.PixelAlphaCompositionMode.Src;
             options.BlendPercentage = 1;
 
-            return new ShapeGraphicsOptions(options, shapeOptions.ShapeOptions);
+            return new DrawingOptions(options, shapeOptions.ShapeOptions, shapeOptions.TextOptions, shapeOptions.Transform);
         }
 
         /// <summary>
@@ -36,7 +36,7 @@ internal static ShapeGraphicsOptions CloneForClearOperation(this ShapeGraphicsOp
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Clear(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             IBrush brush,
             IPath path) =>
             source.Fill(options.CloneForClearOperation(), brush, path);
@@ -49,7 +49,7 @@ public static IImageProcessingContext Clear(
         /// <param name="path">The path.</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.GetShapeGraphicsOptions(), brush, path);
+            source.Clear(source.GetDrawingOptions(), brush, path);
 
         /// <summary>
         /// Flood fills the image in the shape of the provided polygon with the specified brush without any blending.
@@ -61,7 +61,7 @@ public static IImageProcessingContext Clear(this IImageProcessingContext source,
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Clear(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             Color color,
             IPath path) =>
             source.Clear(options, new SolidBrush(color), path);

src/ImageSharp.Drawing/Processing/Extensions/ClearRectangleExtensions.cs

@@ -20,7 +20,7 @@ public static class ClearRectangleExtensions
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Clear(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             IBrush brush,
             RectangleF shape) =>
             source.Clear(options, brush, new RectangularPolygon(shape.X, shape.Y, shape.Width, shape.Height));
@@ -45,7 +45,7 @@ public static IImageProcessingContext Clear(this IImageProcessingContext source,
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Clear(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             Color color,
             RectangleF shape) =>
             source.Clear(options, new SolidBrush(color), shape);

src/ImageSharp.Drawing/Processing/Extensions/ClearRegionExtensions.cs

@@ -19,7 +19,7 @@ public static class ClearRegionExtensions
         /// <param name="region">The region.</param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Clear(this IImageProcessingContext source, IBrush brush, Region region) =>
-            source.Clear(source.GetShapeGraphicsOptions(), brush, region);
+            source.Clear(source.GetDrawingOptions(), brush, region);
 
         /// <summary>
         /// Flood fills the image with in the region with the specified brush without any blending.
@@ -31,7 +31,7 @@ public static IImageProcessingContext Clear(this IImageProcessingContext source,
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Clear(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             IBrush brush,
             Region region) =>
             source.Fill(options.CloneForClearOperation(), brush, region);
@@ -46,7 +46,7 @@ public static IImageProcessingContext Clear(
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Clear(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             Color color,
             Region region) =>
             source.Clear(options, new SolidBrush(color), region);

src/ImageSharp.Drawing/Processing/Extensions/DrawBezierExtensions.cs

@@ -20,7 +20,7 @@ public static class DrawBezierExtensions
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext DrawBeziers(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             IPen pen,
             params PointF[] points) =>
             source.Draw(options, pen, new Path(new CubicBezierLineSegment(points)));
@@ -49,7 +49,7 @@ public static IImageProcessingContext DrawBeziers(
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext DrawBeziers(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             IBrush brush,
             float thickness,
             params PointF[] points) =>
@@ -96,7 +96,7 @@ public static IImageProcessingContext DrawBeziers(
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext DrawBeziers(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             Color color,
             float thickness,
             params PointF[] points) =>

src/ImageSharp.Drawing/Processing/Extensions/DrawLineExtensions.cs

@@ -21,7 +21,7 @@ public static class DrawLineExtensions
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext DrawLines(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             IBrush brush,
             float thickness,
             params PointF[] points) =>
@@ -68,7 +68,7 @@ public static IImageProcessingContext DrawLines(
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>>
         public static IImageProcessingContext DrawLines(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             Color color,
             float thickness,
             params PointF[] points) =>
@@ -84,7 +84,7 @@ public static IImageProcessingContext DrawLines(
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext DrawLines(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             IPen pen,
             params PointF[] points) =>
             source.Draw(options, pen, new Path(new LinearLineSegment(points)));

src/ImageSharp.Drawing/Processing/Extensions/DrawPathCollectionExtensions.cs

@@ -20,7 +20,7 @@ public static class DrawPathCollectionExtensions
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Draw(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             IPen pen,
             IPathCollection paths)
         {
@@ -41,7 +41,7 @@ public static IImageProcessingContext Draw(
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext
             Draw(this IImageProcessingContext source, IPen pen, IPathCollection paths) =>
-            source.Draw(source.GetShapeGraphicsOptions(), pen, paths);
+            source.Draw(source.GetDrawingOptions(), pen, paths);
 
         /// <summary>
         /// Draws the outline of the polygon with the provided brush at the provided thickness.
@@ -54,7 +54,7 @@ public static IImageProcessingContext
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Draw(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             IBrush brush,
             float thickness,
             IPathCollection paths) =>
@@ -86,7 +86,7 @@ public static IImageProcessingContext Draw(
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Draw(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             Color color,
             float thickness,
             IPathCollection paths) =>

src/ImageSharp.Drawing/Processing/Extensions/DrawPathExtensions.cs

@@ -21,7 +21,7 @@ public static class DrawPathExtensions
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Draw(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             IPen pen,
             IPath path) =>
             source.ApplyProcessor(new DrawPathProcessor(options, pen, path));
@@ -34,7 +34,7 @@ public static IImageProcessingContext Draw(
         /// <param name="path">The path.</param>
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Draw(this IImageProcessingContext source, IPen pen, IPath path) =>
-            source.Draw(source.GetShapeGraphicsOptions(), pen, path);
+            source.Draw(source.GetDrawingOptions(), pen, path);
 
         /// <summary>
         /// Draws the outline of the polygon with the provided brush at the provided thickness.
@@ -47,7 +47,7 @@ public static IImageProcessingContext Draw(this IImageProcessingContext source,
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Draw(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             IBrush brush,
             float thickness,
             IPath path) =>
@@ -79,7 +79,7 @@ public static IImageProcessingContext Draw(
         /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
         public static IImageProcessingContext Draw(
             this IImageProcessingContext source,
-            ShapeGraphicsOptions options,
+            DrawingOptions options,
             Color color,
             float thickness,
             IPath path) =>