Merge pull request #56 from drewnoakes/line-caps

Initial support for line segment start/end caps

Author: jingwood

.editorconfig

@@ -5,7 +5,7 @@ root = true
 
 # Don't use tabs for indentation.
 [*.cs]
-indent_style = space
+indent_style = tabs
 indent_size = 2
 insert_final_newline = true
 charset = utf-8-bom

src/D2DLibExport/D2DEnums.cs

@@ -299,6 +299,32 @@ public enum D2DDashStyle
 		Custom = 5,
 	}
 
+	/// <summary>
+	/// From <c>D2D1_CAP_STYLE</c>.
+	/// </summary>
+	public enum D2DCapStyle
+	{
+		/// <summary>
+		/// Flat line cap.
+		/// </summary>
+		Flat = 0,
+		
+		/// <summary>
+		/// Square line cap.
+		/// </summary>
+		Square = 1,
+		
+		/// <summary>
+		/// Round line cap.
+		/// </summary>
+		Round = 2,
+		
+		/// <summary>
+		/// Triangle line cap.
+		/// </summary>
+		Triangle = 3
+	}
+
 	public enum D2D1_ARC_SIZE
 	{
 		D2D1_ARC_SIZE_SMALL = 0,

src/D2DLibExport/D2DGraphics.cs

@@ -39,9 +39,9 @@ namespace unvell.D2DLib
 {
 	public class D2DGraphics
 	{
-		internal HANDLE Handle { get; private set; }
+		internal HANDLE Handle { get; }
 
-		public D2DDevice Device { get; private set; }
+		public D2DDevice Device { get; }
 
 		public D2DGraphics(D2DDevice context)
 			: this(context.Handle)
@@ -97,15 +97,17 @@ public bool Antialias
 		}
 
 		public void DrawLine(FLOAT x1, FLOAT y1, FLOAT x2, FLOAT y2, D2DColor color,
-			FLOAT weight = 1, D2DDashStyle dashStyle = D2DDashStyle.Solid)
+			FLOAT weight = 1, D2DDashStyle dashStyle = D2DDashStyle.Solid,
+			D2DCapStyle startCap = D2DCapStyle.Flat, D2DCapStyle endCap = D2DCapStyle.Flat)
 		{
-			DrawLine(new D2DPoint(x1, y1), new D2DPoint(x2, y2), color, weight, dashStyle);
+			DrawLine(new D2DPoint(x1, y1), new D2DPoint(x2, y2), color, weight, dashStyle, startCap, endCap);
 		}
 
 		public void DrawLine(D2DPoint start, D2DPoint end, D2DColor color,
-			FLOAT weight = 1, D2DDashStyle dashStyle = D2DDashStyle.Solid)
+			FLOAT weight = 1, D2DDashStyle dashStyle = D2DDashStyle.Solid,
+			D2DCapStyle startCap = D2DCapStyle.Flat, D2DCapStyle endCap = D2DCapStyle.Flat)
 		{
-			D2D.DrawLine(this.Handle, start, end, color, weight, dashStyle);
+			D2D.DrawLine(this.Handle, start, end, color, weight, dashStyle, startCap, endCap);
 		}
 
 		public void DrawLines(D2DPoint[] points, D2DColor color, FLOAT weight = 1, D2DDashStyle dashStyle = D2DDashStyle.Solid)

src/D2DLibExport/D2DLib.cs

@@ -163,7 +163,8 @@ public static extern HANDLE PushLayer(HANDLE ctx, HANDLE layerHandle, ref D2DRec
 
 		[DllImport(DLL_NAME, CallingConvention = CallingConvention.Cdecl)]
 		public static extern void DrawLine(HANDLE context, D2DPoint start, D2DPoint end, D2DColor color,
-			FLOAT weight = 1, D2DDashStyle dashStyle = D2DDashStyle.Solid);
+			FLOAT weight = 1, D2DDashStyle dashStyle = D2DDashStyle.Solid,
+			D2DCapStyle startCap = D2DCapStyle.Flat, D2DCapStyle endCap = D2DCapStyle.Flat);
 
 		[DllImport(DLL_NAME, CallingConvention = CallingConvention.Cdecl)]
 		public static extern void DrawLines(HANDLE context, D2DPoint[] points, UINT count, D2DColor color,

src/Examples/Examples.csproj

@@ -17,6 +17,9 @@
     <Compile Update="SampleCode\ClipMaskDraw.cs">
       <SubType>Form</SubType>
     </Compile>
+    <Compile Update="SampleCode\LineCapStyle.cs">
+      <SubType>Form</SubType>
+    </Compile>
   </ItemGroup>
 
 </Project>

src/Examples/SampleCode/LineCapStyle.cs

@@ -0,0 +1,59 @@
+/*
+* MIT License
+*
+* Copyright (c) 2017-2021 Jingwood, unvell.com. All right reserved.
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+* copies of the Software, and to permit persons to whom the Software is
+* furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included in all
+* copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+* SOFTWARE.
+*/
+
+using System;
+using System.Collections.Generic;
+using System.Drawing;
+using System.Windows.Forms;
+using unvell.D2DLib.WinForm;
+
+namespace unvell.D2DLib.Examples.SampleCode
+{
+	public partial class LineCapStyle : ExampleForm
+	{
+		public LineCapStyle()
+		{
+			Text = "LineCapStyle Tests - d2dlib Examples";
+		}
+
+		protected override void OnRender(D2DGraphics g)
+		{
+			g.DrawText("Flat", D2DColor.DimGray, "Arials", 20, 110, 83);
+			g.DrawLine(300, 100, 600, 100, D2DColor.Black, 20, D2DDashStyle.Solid, D2DCapStyle.Flat, D2DCapStyle.Flat);
+  
+			g.DrawText("Round", D2DColor.DimGray, "Arials", 20, 110, 183);
+			g.DrawLine(300, 200, 600, 200, D2DColor.Black, 20, D2DDashStyle.Solid, D2DCapStyle.Round, D2DCapStyle.Round);
+
+			g.DrawText("Square", D2DColor.DimGray, "Arials", 20, 110, 283);
+			g.DrawLine(300, 300, 600, 300, D2DColor.Black, 20, D2DDashStyle.Solid, D2DCapStyle.Square, D2DCapStyle.Square);
+
+			g.DrawText("Triangle", D2DColor.DimGray, "Arials", 20, 110, 383);
+			g.DrawLine(300, 400, 600, 400, D2DColor.Black, 20, D2DDashStyle.Solid, D2DCapStyle.Triangle, D2DCapStyle.Triangle);
+
+			g.DrawText("Round, Triangle", D2DColor.DimGray, "Arials", 20, 110, 483);
+			g.DrawLine(300, 500, 600, 500, D2DColor.Black, 20, D2DDashStyle.Solid, D2DCapStyle.Round, D2DCapStyle.Triangle);
+		}
+	}
+
+}

src/d2dlib/Simple.cpp

@@ -28,7 +28,7 @@
 #include "Brush.h"
 
 void DrawLine(HANDLE ctx, D2D1_POINT_2F start, D2D1_POINT_2F end, D2D1_COLOR_F color,
-	FLOAT width, D2D1_DASH_STYLE dashStyle)
+	FLOAT width, D2D1_DASH_STYLE dashStyle, D2D1_CAP_STYLE startCap, D2D1_CAP_STYLE endCap)
 {
 	RetrieveContext(ctx);
 
@@ -39,11 +39,13 @@ void DrawLine(HANDLE ctx, D2D1_POINT_2F start, D2D1_POINT_2F end, D2D1_COLOR_F c
 
 	if (brush != NULL) {
 
-		if (dashStyle != D2D1_DASH_STYLE_SOLID)
+		if (dashStyle != D2D1_DASH_STYLE_SOLID ||
+			startCap != D2D1_CAP_STYLE_FLAT ||
+			endCap != D2D1_CAP_STYLE_FLAT)
 		{
 			context->factory->CreateStrokeStyle(D2D1::StrokeStyleProperties(
-				D2D1_CAP_STYLE_FLAT,
-				D2D1_CAP_STYLE_FLAT,
+				startCap,
+				endCap,
 				D2D1_CAP_STYLE_ROUND,
 				D2D1_LINE_JOIN_MITER,
 				10.0f,

src/d2dlib/Simple.h

@@ -29,7 +29,9 @@
 extern "C"
 {
 	D2DLIB_API void DrawLine(HANDLE ctx, D2D1_POINT_2F start, D2D1_POINT_2F end, D2D1_COLOR_F color,
-		FLOAT width = 1, D2D1_DASH_STYLE dashStyle = D2D1_DASH_STYLE::D2D1_DASH_STYLE_SOLID);
+		FLOAT width = 1, D2D1_DASH_STYLE dashStyle = D2D1_DASH_STYLE::D2D1_DASH_STYLE_SOLID,
+		D2D1_CAP_STYLE startCap = D2D1_CAP_STYLE::D2D1_CAP_STYLE_FLAT,
+		D2D1_CAP_STYLE endCap = D2D1_CAP_STYLE::D2D1_CAP_STYLE_FLAT);
 
 	D2DLIB_API void DrawLineWithPen(HANDLE ctx, D2D1_POINT_2F start, D2D1_POINT_2F end, HANDLE pen, FLOAT width = 1);