AutoCAD Overrule .NET: Centerline Circle DrawableOverrule Adding Selection Ma...

eachy

AutoCAD Overrule .NET: Centerline Circle DrawableOverrule Adding Selection Markers for CenterlinesAutoCAD has provided the Overrule .NET API in recent versions. It is the most powerful .NET API so far and can provide almost the custom entity feature that is still only available in the most powerful AutoCAD API, ObjectARX. On the other hand, however, the Overrule API is also the most complex part in the AutoCAD .NET.
Centerline Circle is a common drawing element in the engineering design world but is not provided by AutoCAD natively. Though AutoCAD has some means to control how to show the circle center point, it is far from enough. We have presented the centerline circle DrawableOverrule implementations in some earlier posts.
In this post, let’s enhance our Centerline Circle DrawableOverrule a bit further to make it support selection markers for the circle centerlines. Here is the code.

1. #region Namespaces
   
2. 
   
3. using System;
   
4. using System.Text;
   
5. using System.Linq;
   
6. using System.Xml;
   
7. using System.Reflection;
   
8. using System.ComponentModel;
   
9. using System.Collections;
   
10. using System.Collections.Generic;
    
11. using System.Windows;
    
12. using System.Windows.Media.Imaging;
    
13. using System.Windows.Forms;
    
14. using System.Diagnostics;
    
15. using System.Drawing;
    
16. using System.IO;
    
17. 
    
18. using Autodesk.AutoCAD.ApplicationServices;
    
19. using Autodesk.AutoCAD.DatabaseServices;
    
20. using Autodesk.AutoCAD.Runtime;
    
21. using Autodesk.AutoCAD.EditorInput;
    
22. using Autodesk.AutoCAD.Geometry;
    
23. using Autodesk.AutoCAD.Windows;
    
24. 
    
25. using MgdAcApplication = Autodesk.AutoCAD.ApplicationServices.Application;
    
26. using MgdAcDocument = Autodesk.AutoCAD.ApplicationServices.Document;
    
27. using AcWindowsNS = Autodesk.AutoCAD.Windows;
    
28. 
    
29. #endregion
    
30. 
    
31. using Autodesk.AutoCAD.GraphicsInterface;
    
32. 
    
33. namespace AcadNetAddinWizard_Namespace
    
34. {
    
35.     /// <summary>
    
36.     /// Features:
    
37.     ///     A derivative from the DrawableOverrule;
    
38.     ///     Being made a singleton to avoid duplicate registrations;
    
39.     ///     UCS being hornored;
    
40.     ///     Adding center lines to applicable cirlces;
    
41.     ///     WorldDraw.Geometry being used to draw the lines;
    
42.     ///     Drawing the center lines with a particular color (Cyan with index 4);
    
43.     ///     Drawing the center lines with the CENTER linetype if loaded;
    
44.     ///     SetExtensionDictionaryEntryFilter() being called to filter circles with Extension Dictionary Entry;
    
45.     ///     IsApplicable being implemented to support circle filtering;
    
46.     ///     The length of the center lines of each circle can be overridden individually;
    
47.     ///     Circles in block references (INSERTs) are also supported;
    
48.     ///     Add the selection marker support;
    
49.     /// </summary>
    
50.     public class CenterlineCircle_DrawableOverrule7 : DrawableOverrule
    
51.     {
    
52.         protected CenterlineCircle_DrawableOverrule7()
    
53.         {
    
54.             //The overrule only works with certain circles marked with the Extension Dictionary Entry.
    
55.             SetExtensionDictionaryEntryFilter(CenterlineCircle_Gadgets.CLCircle_ID);
    
56.             //SetCustomFilter();
    
57.         }
    
58. 
    
59.         protected static CenterlineCircle_DrawableOverrule7 mInstance;
    
60.         public static CenterlineCircle_DrawableOverrule7 Instance
    
61.         {
    
62.             get
    
63.             {
    
64.                 if (mInstance == null)
    
65.                     mInstance = new CenterlineCircle_DrawableOverrule7();
    
66.                 return mInstance;
    
67.             }
    
68.             set
    
69.             {
    
70.                 mInstance = value;
    
71.             }
    
72.         }
    
73. 
    
74.         public override bool WorldDraw(Drawable drawable, WorldDraw wd)
    
75.         {
    
76.             if (drawable is Circle)
    
77.             {
    
78.                 Circle cir = drawable as Circle;
    
79.                 Point3d cen = cir.Center;
    
80.                 double rad = cir.Radius;
    
81. 
    
82.                 Matrix3d transform = wd.Geometry.ModelToWorldTransform;
    
83.                 if (transform == Matrix3d.Identity)
    
84.                 {
    
85.                     transform = MgdAcApplication.DocumentManager.MdiActiveDocument.Editor.CurrentUserCoordinateSystem;
    
86.                     cen = cen.TransformBy(transform.Inverse());
    
87.                 }
    
88. 
    
89.                 double ratio;
    
90.                 object value = CenterlineCircle_Gadgets.GetDictionaryEntryTypedValue(
    
91.                                 CenterlineCircle_Gadgets.GetExtensionDictionaryEntry(cir.ObjectId, CenterlineCircle_Gadgets.CLCircle_ID),
    
92.                                 (int)DxfCode.ExtendedDataScale);
    
93.                 if (value == null)
    
94.                     ratio = CenterlineCircle_Gadgets.DefaultRatioLengthToRadius;
    
95.                 else
    
96.                     ratio = Convert.ToDouble(value);
    
97. 
    
98.                 Point3d line1Pt1 = new Point3d(cen.X - rad * ratio, cen.Y, cen.Z).TransformBy(transform);
    
99.                 Point3d line1Pt2 = new Point3d(cen.X + rad * ratio, cen.Y, cen.Z).TransformBy(transform);
    
100.                 Point3d line2Pt1 = new Point3d(cen.X, cen.Y - rad * ratio, cen.Z).TransformBy(transform);
     
101.                 Point3d line2Pt2 = new Point3d(cen.X, cen.Y + rad * ratio, cen.Z).TransformBy(transform);
     
102. 
     
103.                 short backupColor = wd.SubEntityTraits.Color;
     
104.                 wd.SubEntityTraits.Color = 4;
     
105. 
     
106.                 ObjectId backupLinetypeId = wd.SubEntityTraits.LineType;
     
107.                 if (GetCenterLinetype() != ObjectId.Null)
     
108.                 {
     
109.                     wd.SubEntityTraits.LineType = CenterLinetypeId;
     
110.                 }
     
111. 
     
112.                 wd.SubEntityTraits.SetSelectionMarker((IntPtr)1);   //Horizontal center line as marker #1
     
113.                 wd.Geometry.WorldLine(line1Pt1, line1Pt2);
     
114. 
     
115.                 wd.SubEntityTraits.SetSelectionMarker((IntPtr)2);   //Vertical center line as marker #2
     
116.                 wd.Geometry.WorldLine(line2Pt1, line2Pt2);
     
117. 
     
118.                 wd.SubEntityTraits.LineType = backupLinetypeId;
     
119.                 wd.SubEntityTraits.Color = backupColor;
     
120.                 wd.SubEntityTraits.SetSelectionMarker((IntPtr)0);   //Circle still as marker #0
     
121.            }
     
122. 
     
123.             return base.WorldDraw(drawable, wd);
     
124.         }
     
125. 
     
126.         //The Extension Dictionary Entry filtering can also be implemented here, but we choose to call the
     
127.         // straightforward SetExtensionDictionaryEntryFilter() in the constructor to simply things. For custom
     
128.         // filters, the IsApplicable() has to be implemented.
     
129.         public override bool IsApplicable(RXObject overruledSubject)
     
130.         {
     
131.             return base.IsApplicable(overruledSubject);
     
132.         }
     
133. 
     
134.         private static ObjectId CenterLinetypeId = ObjectId.Null;
     
135.         public static ObjectId GetCenterLinetype()
     
136.         {
     
137.             Database db = HostApplicationServices.WorkingDatabase;
     
138.             if (CenterLinetypeId != ObjectId.Null && CenterLinetypeId.IsValid && CenterLinetypeId.IsResident && CenterLinetypeId.Database == db)
     
139.                 return CenterLinetypeId;
     
140.             else
     
141.                 CenterLinetypeId = ObjectId.Null;
     
142. 
     
143.             using (Transaction tr = db.TransactionManager.StartTransaction())
     
144.             {
     
145.                 foreach (ObjectId id in db.LinetypeTableId.GetObject(OpenMode.ForRead) as LinetypeTable)
     
146.                 {
     
147.                     LinetypeTableRecord ltr = id.GetObject(OpenMode.ForRead) as LinetypeTableRecord;
     
148.                     if (ltr.Name == "CENTER")
     
149.                     {
     
150.                         CenterLinetypeId = ltr.ObjectId;
     
151.                         break;
     
152.                     }
     
153.                 }
     
154.                 tr.Commit();
     
155.             }
     
156. 
     
157.             return CenterLinetypeId;
     
158.         }
     
159.     }
     
160. }

#region Namespaces<br /> <br /> using System;<br /> using System.Text;<br /> using System.Linq;<br /> using System.Xml;<br /> using System.Reflection;<br /> using System.ComponentModel;<br /> using System.Collections;<br /> using System.Collections.Generic;<br /> using System.Windows;<br /> using System.Windows.Media.Imaging;<br /> using System.Windows.Forms;<br /> using System.Diagnostics;<br /> using System.Drawing;<br /> using System.IO;<br /> <br /> using Autodesk.AutoCAD.ApplicationServices;<br /> using Autodesk.AutoCAD.DatabaseServices;<br /> using Autodesk.AutoCAD.Runtime;<br /> using Autodesk.AutoCAD.EditorInput;<br /> using Autodesk.AutoCAD.Geometry;<br /> using Autodesk.AutoCAD.Windows;<br /> <br /> using MgdAcApplication = Autodesk.AutoCAD.ApplicationServices.Application;<br /> using MgdAcDocument = Autodesk.AutoCAD.ApplicationServices.Document;<br /> using AcWindowsNS = Autodesk.AutoCAD.Windows;<br /> <br /> #endregion<br /> <br /> using Autodesk.AutoCAD.GraphicsInterface;<br /> <br /> namespace AcadNetAddinWizard_Namespace<br /> {<br />     /// <summary><br />     /// Features:<br />     ///     A derivative from the DrawableOverrule;<br />     ///     Being made a singleton to avoid duplicate registrations;<br />     ///     UCS being hornored;<br />     ///     Adding center lines to applicable cirlces;<br />     ///     WorldDraw.Geometry being used to draw the lines;<br />     ///     Drawing the center lines with a particular color (Cyan with index 4);<br />     ///     Drawing the center lines with the CENTER linetype if loaded;<br />     ///     SetExtensionDictionaryEntryFilter() being called to filter circles with Extension Dictionary Entry;<br />     ///     IsApplicable being implemented to support circle filtering;<br />     ///     The length of the center lines of each circle can be overridden individually;<br />     ///     Circles in block references (INSERTs) are also supported;<br />     ///     Add the selection marker support;<br />     /// </summary><br />     public class CenterlineCircle_DrawableOverrule7 : DrawableOverrule<br />     {<br />         protected CenterlineCircle_DrawableOverrule7()<br />         {<br />             //The overrule only works with certain circles marked with the Extension Dictionary Entry.<br />             SetExtensionDictionaryEntryFilter(CenterlineCircle_Gadgets.CLCircle_ID);<br />             //SetCustomFilter();<br />         }<br /> <br />         protected static CenterlineCircle_DrawableOverrule7 mInstance;<br />         public static CenterlineCircle_DrawableOverrule7 Instance<br />         {<br />             get<br />             {<br />                 if (mInstance == null)<br />                     mInstance = new CenterlineCircle_DrawableOverrule7();<br />                 return mInstance;<br />             }<br />             set<br />             {<br />                 mInstance = value;<br />             }<br />         }<br /> <br />         public override bool WorldDraw(Drawable drawable, WorldDraw wd)<br />         {<br />             if (drawable is Circle)<br />             {<br />                 Circle cir = drawable as Circle;<br />                 Point3d cen = cir.Center;<br />                 double rad = cir.Radius;<br /> <br />                 Matrix3d transform = wd.Geometry.ModelToWorldTransform;<br />                 if (transform == Matrix3d.Identity)<br />                 {<br />                     transform = MgdAcApplication.DocumentManager.MdiActiveDocument.Editor.CurrentUserCoordinateSystem;<br />                     cen = cen.TransformBy(transform.Inverse());<br />                 }<br /> <br />                 double ratio;<br />                 object value = CenterlineCircle_Gadgets.GetDictionaryEntryTypedValue(<br />                                 CenterlineCircle_Gadgets.GetExtensionDictionaryEntry(cir.ObjectId, CenterlineCircle_Gadgets.CLCircle_ID),<br />                                 (int)DxfCode.ExtendedDataScale);<br />                 if (value == null)<br />                     ratio = CenterlineCircle_Gadgets.DefaultRatioLengthToRadius;<br />                 else<br />                     ratio = Convert.ToDouble(value);<br /> <br />                 Point3d line1Pt1 = new Point3d(cen.X - rad * ratio, cen.Y, cen.Z).TransformBy(transform);<br />                 Point3d line1Pt2 = new Point3d(cen.X + rad * ratio, cen.Y, cen.Z).TransformBy(transform);<br />                 Point3d line2Pt1 = new Point3d(cen.X, cen.Y - rad * ratio, cen.Z).TransformBy(transform);<br />                 Point3d line2Pt2 = new Point3d(cen.X, cen.Y + rad * ratio, cen.Z).TransformBy(transform);<br /> <br />                 short backupColor = wd.SubEntityTraits.Color;<br />                 wd.SubEntityTraits.Color = 4;<br /> <br />                 ObjectId backupLinetypeId = wd.SubEntityTraits.LineType;<br />                 if (GetCenterLinetype() != ObjectId.Null)<br />                 {<br />                     wd.SubEntityTraits.LineType = CenterLinetypeId;<br />                 }<br /> <br />                 wd.SubEntityTraits.SetSelectionMarker((IntPtr)1);   //Horizontal center line as marker #1<br />                 wd.Geometry.WorldLine(line1Pt1, line1Pt2);<br /> <br />                 wd.SubEntityTraits.SetSelectionMarker((IntPtr)2);   //Vertical center line as marker #2<br />                 wd.Geometry.WorldLine(line2Pt1, line2Pt2);<br /> <br />                 wd.SubEntityTraits.LineType = backupLinetypeId;<br />                 wd.SubEntityTraits.Color = backupColor;<br />                 wd.SubEntityTraits.SetSelectionMarker((IntPtr)0);   //Circle still as marker #0<br />            }<br /> <br />             return base.WorldDraw(drawable, wd);<br />         }<br /> <br />         //The Extension Dictionary Entry filtering can also be implemented here, but we choose to call the <br />         // straightforward SetExtensionDictionaryEntryFilter() in the constructor to simply things. For custom<br />         // filters, the IsApplicable() has to be implemented.<br />         public override bool IsApplicable(RXObject overruledSubject)<br />         {<br />             return base.IsApplicable(overruledSubject);<br />         }<br /> <br />         private static ObjectId CenterLinetypeId = ObjectId.Null;<br />         public static ObjectId GetCenterLinetype()<br />         {<br />             Database db = HostApplicationServices.WorkingDatabase;<br />             if (CenterLinetypeId != ObjectId.Null && CenterLinetypeId.IsValid && CenterLinetypeId.IsResident && CenterLinetypeId.Database == db)<br />                 return CenterLinetypeId;<br />             else<br />                 CenterLinetypeId = ObjectId.Null;<br /> <br />             using (Transaction tr = db.TransactionManager.StartTransaction())<br />             {<br />                 foreach (ObjectId id in db.LinetypeTableId.GetObject(OpenMode.ForRead) as LinetypeTable)<br />                 {<br />                     LinetypeTableRecord ltr = id.GetObject(OpenMode.ForRead) as LinetypeTableRecord;<br />                     if (ltr.Name == "CENTER")<br />                     {<br />                         CenterLinetypeId = ltr.ObjectId;<br />                         break;<br />                     }<br />                 }<br />                 tr.Commit();<br />             }<br /> <br />             return CenterLinetypeId;<br />         } <br />     }<br /> }

Here is the test command.

1. [CommandMethod("ShowCircleCenterline7")]
   
2. public static void ShowCircleCenterline7_Method()
   
3. {
   
4.     CenterlineCircle_Gadgets.RegisterOverrule(typeof(Circle), CenterlineCircle_DrawableOverrule7.Instance);
   
5. }
   
6. 
   
7. [CommandMethod("HideCircleCenterline7")]
   
8. public static void HideCircleCenterline7_Method()
   
9. {
   
10.     CenterlineCircle_Gadgets.UnregisterOverrule(typeof(Circle), CenterlineCircle_DrawableOverrule7.Instance);
    
11. }

[CommandMethod("ShowCircleCenterline7")]<br /> public static void ShowCircleCenterline7_Method()<br /> {<br />     CenterlineCircle_Gadgets.RegisterOverrule(typeof(Circle), CenterlineCircle_DrawableOverrule7.Instance);<br /> }<br /> <br /> [CommandMethod("HideCircleCenterline7")]<br /> public static void HideCircleCenterline7_Method()<br /> {<br />     CenterlineCircle_Gadgets.UnregisterOverrule(typeof(Circle), CenterlineCircle_DrawableOverrule7.Instance);<br /> }

The selection markers of the circle centerlines do not demonstrate themselves in the graphics of centerline circles, but they will play some important roles when we implement the OsnapOverrule that we are going to introduce soon. Some highlights may look good to help understand the code.
&#8226; The centerline circle overrule is derived from the DrawableOverrule API class;
&#8226; The centerline circle overrule is made a singleton to avoid duplicate registrations or similar issues;
&#8226; The centerline circle overrule works with both UCS and WCS;
&#8226; The WorldDraw of the centerline circle overrule has been overridden and its Geometry.WorldLine is used to draw the centerlines;
&#8226; The centerline circle overrule draws the centerlines with a hard coded color (Cyan with index 4) through setting the WorldDraw.SubEntityTraits.Color property.
&#8226; The centerlines are drawn with the Center linetype through assigning its ObjectId to the WorldDraw.SubEntityTraits.LineType property before adding the centerlines.
&#8226; Please do not forget to back up the original linetype and assign it back after the centerline being drawn. Otherwise, the circle itself will be drawn with the Center linetype too.
&#8226; A filter is added to make some circles behave with centerlines added and others behave still normal.
&#8226; The SetExtensionDictionaryEntryFilter() is called to filter circles with a particular Extension Dictionary Entry;
&#8226; The IsApplicable is implemented to support circle filtering.
&#8226; The Extension Dictionary Entry filtering can also be implemented in the IsApplicable method.
&#8226; We choose to call the straightforward SetExtensionDictionaryEntryFilter() in the constructor to simply things since it work fine here.
&#8226;  The length ratio parameter of the centerlines of each circle has been recorded into the extension dictionary as an XRecord.
&#8226; To add selection markers for the circle centerlines, a few WorldDraw.SubEntityTraits.SetSelectionMarker() call are made to give the circle itself seletction marker #0, the horizontal circle centerline selection marker #1, and the vertical centerline selection marker #2.