AutoCAD Overrule .NET: Centerline Circle TransformOverrule

eachy

AutoCAD Overrule .NET: Centerline Circle TransformOverruleAutoCAD 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 overrule implementations in some earlier posts.
In this post, let’s implement the TransformOverrule for our Centerline Circle to make it support the EXPLODE command. 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. namespace AcadNetAddinWizard_Namespace
    
33. {
    
34. /// <summary>
    
35. ///
    
36. /// </summary>
    
37.     public class CenterlineCircle_TransformOverrule : TransformOverrule
    
38.     {
    
39.         private CenterlineCircle_TransformOverrule()
    
40.         {
    
41.             //The overrule only works with certain circles marked with the Extension Dictionary Entry.
    
42.             SetExtensionDictionaryEntryFilter(CenterlineCircle_Gadgets.CLCircle_ID);
    
43.             SetCustomFilter();
    
44.         }
    
45. 
    
46.         private static CenterlineCircle_TransformOverrule mInstance;
    
47.         public static CenterlineCircle_TransformOverrule Instance
    
48.         {
    
49.             get
    
50.             {
    
51.                 if (mInstance == null)
    
52.                     mInstance = new CenterlineCircle_TransformOverrule();
    
53.                 return mInstance;
    
54.             }
    
55.         }
    
56. 
    
57.         public override bool IsApplicable(RXObject overruledSubject)
    
58.         {
    
59.             return Overrule.HasOverrule(overruledSubject, RXClass.GetClass(typeof(CenterlineCircle_DrawableOverrule5)));
    
60.         }
    
61. 
    
62.         public override void Explode(Entity entity, DBObjectCollection entitySet)
    
63.         {
    
64.             //base.Explode(entity, entitySet);  //eNotApplicable
    
65. 
    
66.             Matrix3d ucs = MgdAcApplication.DocumentManager.MdiActiveDocument.Editor.CurrentUserCoordinateSystem;
    
67. 
    
68.             Circle cir = entity as Circle;
    
69.             Point3d cen = cir.Center.TransformBy(ucs.Inverse()); ;
    
70.             double rad = cir.Radius;
    
71. 
    
72.             double ratio;
    
73.             object value = CenterlineCircle_Gadgets.GetDictionaryEntryTypedValue(
    
74.                             CenterlineCircle_Gadgets.GetExtensionDictionaryEntry(cir.ObjectId, CenterlineCircle_Gadgets.CLCircle_ID),
    
75.                             (int)DxfCode.ExtendedDataScale);
    
76.             if (value == null)
    
77.                 ratio = CenterlineCircle_Gadgets.DefaultRatioLengthToRadius;
    
78.             else
    
79.                 ratio = Convert.ToDouble(value);
    
80. 
    
81.             ObjectId linetypeId = CenterlineCircle_DrawableOverrule5.GetCenterLinetype();
    
82. 
    
83.             Point3d line1Pt1 = new Point3d(cen.X - rad * ratio, cen.Y, cen.Z).TransformBy(ucs);
    
84.             Point3d line1Pt2 = new Point3d(cen.X + rad * ratio, cen.Y, cen.Z).TransformBy(ucs);
    
85.             Point3d line2Pt1 = new Point3d(cen.X, cen.Y - rad * ratio, cen.Z).TransformBy(ucs);
    
86.             Point3d line2Pt2 = new Point3d(cen.X, cen.Y + rad * ratio, cen.Z).TransformBy(ucs);
    
87. 
    
88.             Line line1 = new Line(line1Pt1, line1Pt2);
    
89.             line1.SetDatabaseDefaults();
    
90.             line1.ColorIndex = 4;
    
91.             line1.LinetypeId = linetypeId;
    
92.             entitySet.Add(line1);
    
93. 
    
94.             Line line2 = new Line(line2Pt1, line2Pt2);
    
95.             line2.SetDatabaseDefaults();
    
96.             line2.ColorIndex = 4;
    
97.             line2.LinetypeId = linetypeId;
    
98.             entitySet.Add(line2);
    
99. 
    
100.             entitySet.Add(entity.Clone() as DBObject);
     
101.         }
     
102.     }
     

#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 /> namespace AcadNetAddinWizard_Namespace<br /> {<br /> /// <summary><br /> /// <br /> /// </summary><br />     public class CenterlineCircle_TransformOverrule : TransformOverrule<br />     {<br />         private CenterlineCircle_TransformOverrule()<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 />         private static CenterlineCircle_TransformOverrule mInstance;<br />         public static CenterlineCircle_TransformOverrule Instance<br />         {<br />             get<br />             {<br />                 if (mInstance == null)<br />                     mInstance = new CenterlineCircle_TransformOverrule();<br />                 return mInstance;<br />             }<br />         }<br /> <br />         public override bool IsApplicable(RXObject overruledSubject)<br />         {<br />             return Overrule.HasOverrule(overruledSubject, RXClass.GetClass(typeof(CenterlineCircle_DrawableOverrule5)));<br />         }<br /> <br />         public override void Explode(Entity entity, DBObjectCollection entitySet)<br />         {<br />             //base.Explode(entity, entitySet);  //eNotApplicable<br /> <br />             Matrix3d ucs = MgdAcApplication.DocumentManager.MdiActiveDocument.Editor.CurrentUserCoordinateSystem;<br /> <br />             Circle cir = entity as Circle;<br />             Point3d cen = cir.Center.TransformBy(ucs.Inverse()); ;<br />             double rad = cir.Radius;<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 />             ObjectId linetypeId = CenterlineCircle_DrawableOverrule5.GetCenterLinetype();<br /> <br />             Point3d line1Pt1 = new Point3d(cen.X - rad * ratio, cen.Y, cen.Z).TransformBy(ucs);<br />             Point3d line1Pt2 = new Point3d(cen.X + rad * ratio, cen.Y, cen.Z).TransformBy(ucs);<br />             Point3d line2Pt1 = new Point3d(cen.X, cen.Y - rad * ratio, cen.Z).TransformBy(ucs);<br />             Point3d line2Pt2 = new Point3d(cen.X, cen.Y + rad * ratio, cen.Z).TransformBy(ucs);<br /> <br />             Line line1 = new Line(line1Pt1, line1Pt2);<br />             line1.SetDatabaseDefaults();<br />             line1.ColorIndex = 4;<br />             line1.LinetypeId = linetypeId;<br />             entitySet.Add(line1);<br /> <br />             Line line2 = new Line(line2Pt1, line2Pt2);<br />             line2.SetDatabaseDefaults();<br />             line2.ColorIndex = 4;<br />             line2.LinetypeId = linetypeId;<br />             entitySet.Add(line2);<br /> <br />             entitySet.Add(entity.Clone() as DBObject);<br />         } <br />     }<br />

Here is the test command.

1. [CommandMethod("AddCLCircleTransformOverrule")]
   
2. public static void AddCLCircleTransformOverrule_Method()
   
3. {
   
4.     CenterlineCircle_Gadgets.RegisterOverrule(typeof(Circle), CenterlineCircle_TransformOverrule.Instance);
   
5. }
   
6. 
   
7. [CommandMethod("RemoveCLCircleTransformOverrule")]
   
8. public static void RemoveCLCircleTransformOverrule_Method()
   
9. {
   
10.     CenterlineCircle_Gadgets.UnregisterOverrule(typeof(Circle), CenterlineCircle_TransformOverrule.Instance);
    
11. }

[CommandMethod("AddCLCircleTransformOverrule")]<br /> public static void AddCLCircleTransformOverrule_Method()<br /> {<br />     CenterlineCircle_Gadgets.RegisterOverrule(typeof(Circle), CenterlineCircle_TransformOverrule.Instance);<br /> }<br /> <br /> [CommandMethod("RemoveCLCircleTransformOverrule")]<br /> public static void RemoveCLCircleTransformOverrule_Method()<br /> {<br />     CenterlineCircle_Gadgets.UnregisterOverrule(typeof(Circle), CenterlineCircle_TransformOverrule.Instance);<br /> }

With the Centerline Circle TransformOverrule handy, the EXPLODE command will work fine with our Centerline Circle, the cenerline circle could be exploded and the circle centerlines will be kept as separate line segments.
Here is an image to show the effect.

Some highlights may look good to help understand the code.
&#8226; The centerline circle object overrule is derived from the TransformOverrule API class;
&#8226; The centerline circle TransformOverrule is made a singleton to avoid duplicate registrations or similar issues;
&#8226; The Explode override is implemented to create the centerlines when a Centerline Circle is exploded.