Displaying entities in different colors using DrawableOverrule

eachy

Displaying entities in different colors using DrawableOverrule                                                        By Balaji Ramamoorthy
Recently, a developer wanted to know a method to display the entities in different colors to visually represent the results of a drawing comparison. A way to set the color for entities including those that are nested is explained in Kean's blog post :
Changing the colour of nested AutoCAD entities through .NETAnother way to show the entity in different colors would be to use of DrawableOverrule. But, the WorldDraw of the DrawableOverrule class does not use the color setting from the DrawableTraits for some entities such as MText. To overcome this limitation, the drawable is cloned inside the WorldDraw method before being assigned a new color.
Here is a sample code using this approach. Some of the helper methods to highlight / unhighlight and pick nested entities are from Kean's blog post that I mentioned about previously.

1. using Autodesk.AutoCAD.GraphicsInterface;
   
2. using System.Collections.Generic;
   
3. 
   
4. public class MyDrawOverrule : DrawableOverrule
   
5. {
   
6.     public static List<ObjectId> _redIds = new List<ObjectId>();
   
7.     public static List<ObjectId> _yellowIds = new List<ObjectId>();
   
8.     public override bool WorldDraw(Drawable drawable, WorldDraw wd)
   
9.     {
   
10.         Entity mydrawable = drawable.Clone() as Entity;
    
11.         short colorIndex = 1;
    
12.         if (_yellowIds.Contains(drawable.Id))
    
13.             colorIndex = 2;
    
14.         wd.SubEntityTraits.Color = colorIndex;
    
15.         mydrawable.ColorIndex = colorIndex;
    
16.         return base.WorldDraw(mydrawable, wd);
    
17.     }
    
18.     public override int SetAttributes(Drawable drawable,
    
19.                                         DrawableTraits traits)
    
20.     {
    
21.         return base.SetAttributes(drawable, traits);
    
22.     }
    
23. }
    
24. 
    
25. public class ColorizeClass : IExtensionApplication
    
26. {
    
27.     static MyDrawOverrule _do = null;
    
28.     [CommandMethod("Colorize")]
    
29.     public void ColorizeMethod()
    
30.     {
    
31.         Document doc = Application.DocumentManager.MdiActiveDocument;
    
32.         Editor ed = doc.Editor;
    
33.         if (_do != null)
    
34.         {
    
35.             ed.WriteMessage("Overruling is already active");
    
36.             return;
    
37.         }
    
38.         Transaction tr = doc.TransactionManager.StartTransaction();
    
39.         using (tr)
    
40.         {
    
41.             List<FullSubentityPath> paths1;
    
42.             SelectNestedEntities(   ed,
    
43.                                     out MyDrawOverrule._redIds,
    
44.                                     out paths1,
    
45.                                     "Red"
    
46.                                 );
    
47.             List<FullSubentityPath> paths2;
    
48.             SelectNestedEntities(  ed,
    
49.                                     out MyDrawOverrule._yellowIds,
    
50.                                     out paths2,
    
51.                                     "Yellow"
    
52.                                  );
    
53.             _do = new MyDrawOverrule();
    
54.             Overrule.AddOverrule(
    
55.                 RXObject.GetClass(typeof(Entity)),
    
56.                 _do,
    
57.                 true);
    
58.             List<ObjectId> ids = new List<ObjectId>();
    
59.             ids.AddRange(MyDrawOverrule._redIds.ToArray());
    
60.             ids.AddRange(MyDrawOverrule._yellowIds.ToArray());
    
61.             _do.SetIdFilter(ids.ToArray());
    
62.             Overrule.Overruling = true;
    
63.             if (MyDrawOverrule._redIds.Count > 0)
    
64.                 UnhighlightSubEntities(paths1);
    
65.             if (MyDrawOverrule._yellowIds.Count > 0)
    
66.                 UnhighlightSubEntities(paths2);
    
67.             tr.Commit();
    
68.         }
    
69.         ed.Regen();
    
70.     }
    
71.     private static bool SelectNestedEntities
    
72.         (
    
73.             Editor ed,
    
74.             out List<ObjectId> ids,
    
75.             out List<FullSubentityPath> paths,
    
76.             String colorName
    
77.         )
    
78.     {
    
79.         ids = new List<ObjectId>();
    
80.         paths = new List<FullSubentityPath>();
    
81. 
    
82.         // Loop until cancelled or completed
    
83. 
    
84.         PromptNestedEntityResult rs;
    
85.         do
    
86.         {
    
87.             rs = ed.GetNestedEntity(
    
88.                 String.Format("\nSelect entity to color {0}: ",
    
89.                 colorName));
    
90.             if (rs.Status == PromptStatus.OK)
    
91.             {
    
92.                 ids.Add(rs.ObjectId);
    
93.                 FullSubentityPath path = FullSubentityPath.Null;
    
94.                 path = HighlightSubEntity(rs);
    
95.                 if (path != FullSubentityPath.Null)
    
96.                     paths.Add(path);
    
97.             }
    
98.         } while (rs.Status == PromptStatus.OK);
    
99.         return (rs.Status == PromptStatus.Cancel);
    
100.     }
     
101. 
     
102.     // Ask the user to select a number of sub-entities.
     
103.     // These will have their ObjectIds and their sub-entity
     
104.     // paths (returned from the HighlightSubEntity() helper)
     
105.     // added to collections that are returned to the caller.
     
106. 
     
107.     private static bool SelectNestedEntities
     
108.         (
     
109.             Editor ed,
     
110.             out ObjectIdCollection ids,
     
111.             out List<FullSubentityPath> paths
     
112.         )
     
113.     {
     
114. 
     
115.         ids = new ObjectIdCollection();
     
116.         paths = new List<FullSubentityPath>();
     
117. 
     
118.         // Loop until cancelled or completed
     
119. 
     
120.         PromptNestedEntityResult rs;
     
121.         do
     
122.         {
     
123.             rs = ed.GetNestedEntity("\nSelect nested entity: ");
     
124.             if (rs.Status == PromptStatus.OK)
     
125.             {
     
126.                 ids.Add(rs.ObjectId);
     
127.                 FullSubentityPath path = FullSubentityPath.Null;
     
128.                 path = HighlightSubEntity(rs);
     
129.                 if (path != FullSubentityPath.Null)
     
130.                     paths.Add(path);
     
131.             }
     
132.         } while (rs.Status == PromptStatus.OK);
     
133. 
     
134.         // Cancel is the status when "enter" is used to
     
135.         // terminate the selection, which means we can't
     
136.         // use it to distinguish from an actual
     
137.         // cancellation.
     
138. 
     
139.         return (rs.Status == PromptStatus.Cancel);
     
140.     }
     
141. 
     
142.     // Unhighlight a set of sub-entities
     
143. 
     
144.     private static void UnhighlightSubEntities(
     
145.                                 List<FullSubentityPath> paths)
     
146.     {
     
147.         for (int i = 0; i < paths.Count; i++)
     
148.         {
     
149.             ObjectId[] ids = paths.GetObjectIds();
     
150.             Entity ent
     
151.                 = ids[0].GetObject(OpenMode.ForRead) as Entity;
     
152.             if (ent != null)
     
153.             {
     
154.                 ent.Unhighlight(paths, false);
     
155.             }
     
156.         }
     
157.     }
     
158. 
     
159.     // Highlight a sub-entity based on its nested
     
160.     // selection information.
     
161.     // Return the calculated sub-entity path, so
     
162.     // the calling application can later unhighlight.
     
163. 
     
164.     private static FullSubentityPath HighlightSubEntity(
     
165.                                     PromptNestedEntityResult rs)
     
166.     {
     
167. 
     
168.         // Extract relevant information from the prompt object
     
169. 
     
170.         ObjectId selId = rs.ObjectId;
     
171.         List<ObjectId> objIds = new List<ObjectId>(rs.GetContainers());
     
172. 
     
173.         // Reverse the "containers" list
     
174. 
     
175.         objIds.Reverse();
     
176. 
     
177.         // Now append the selected entity
     
178. 
     
179.         objIds.Add(selId);
     
180. 
     
181.         // Retrieve the sub-entity path for this entity
     
182. 
     
183.         SubentityId subEnt
     
184.             = new SubentityId(SubentityType.Null, System.IntPtr.Zero);
     
185.         FullSubentityPath path
     
186.             = new FullSubentityPath(objIds.ToArray(), subEnt);
     
187. 
     
188.         // Open the outermost container, relying on the open transaction...
     
189. 
     
190.         Entity ent = objIds[0].GetObject(OpenMode.ForRead) as Entity;
     
191.         // ... and highlight the nested entity
     
192.         if (ent == null)
     
193.             return FullSubentityPath.Null;
     
194.         ent.Highlight(path, false);
     
195.         // Return the sub-entity path for later unhighlighting
     
196.         return path;
     
197.     }
     
198.     void IExtensionApplication.Initialize() { }
     
199.     void IExtensionApplication.Terminate()
     
200.     {
     
201.         if (_do != null)
     
202.         {
     
203.             Overrule.Overruling = false;
     
204.             Overrule.RemoveOverrule(
     
205.                 RXObject.GetClass(typeof(Entity)),
     
206.                 _do);
     
207.         }
     
208.     }
     
209. }
     

using Autodesk.AutoCAD.GraphicsInterface;<br /> using System.Collections.Generic; <br /> <br /> public class MyDrawOverrule : DrawableOverrule<br /> {<br />     public static List<ObjectId> _redIds = new List<ObjectId>();<br />     public static List<ObjectId> _yellowIds = new List<ObjectId>();<br />     public override bool WorldDraw(Drawable drawable, WorldDraw wd)<br />     {<br />         Entity mydrawable = drawable.Clone() as Entity;<br />         short colorIndex = 1;<br />         if (_yellowIds.Contains(drawable.Id))<br />             colorIndex = 2;<br />         wd.SubEntityTraits.Color = colorIndex;<br />         mydrawable.ColorIndex = colorIndex;<br />         return base.WorldDraw(mydrawable, wd);<br />     }<br />     public override int SetAttributes(Drawable drawable,<br />                                         DrawableTraits traits)<br />     {<br />         return base.SetAttributes(drawable, traits);<br />     }<br /> }<br /> <br /> public class ColorizeClass : IExtensionApplication<br /> {<br />     static MyDrawOverrule _do = null;<br />     [CommandMethod("Colorize")]<br />     public void ColorizeMethod()<br />     {<br />         Document doc = Application.DocumentManager.MdiActiveDocument;<br />         Editor ed = doc.Editor;<br />         if (_do != null)<br />         {<br />             ed.WriteMessage("Overruling is already active");<br />             return;<br />         }<br />         Transaction tr = doc.TransactionManager.StartTransaction();<br />         using (tr)<br />         {<br />             List<FullSubentityPath> paths1;<br />             SelectNestedEntities(   ed,<br />                                     out MyDrawOverrule._redIds,<br />                                     out paths1,<br />                                     "Red"<br />                                 );<br />             List<FullSubentityPath> paths2;<br />             SelectNestedEntities(  ed,<br />                                     out MyDrawOverrule._yellowIds,<br />                                     out paths2,<br />                                     "Yellow"<br />                                  );<br />             _do = new MyDrawOverrule();<br />             Overrule.AddOverrule(<br />                 RXObject.GetClass(typeof(Entity)),<br />                 _do,<br />                 true);<br />             List<ObjectId> ids = new List<ObjectId>();<br />             ids.AddRange(MyDrawOverrule._redIds.ToArray());<br />             ids.AddRange(MyDrawOverrule._yellowIds.ToArray());<br />             _do.SetIdFilter(ids.ToArray()); <br />             Overrule.Overruling = true;<br />             if (MyDrawOverrule._redIds.Count > 0)<br />                 UnhighlightSubEntities(paths1);<br />             if (MyDrawOverrule._yellowIds.Count > 0)<br />                 UnhighlightSubEntities(paths2);<br />             tr.Commit();<br />         }<br />         ed.Regen();<br />     }<br />     private static bool SelectNestedEntities<br />         (<br />             Editor ed,<br />             out List<ObjectId> ids,<br />             out List<FullSubentityPath> paths,<br />             String colorName<br />         )<br />     {<br />         ids = new List<ObjectId>();<br />         paths = new List<FullSubentityPath>();<br /> <br />         // Loop until cancelled or completed<br /> <br />         PromptNestedEntityResult rs;<br />         do<br />         {<br />             rs = ed.GetNestedEntity(<br />                 String.Format("\nSelect entity to color {0}: ",<br />                 colorName));<br />             if (rs.Status == PromptStatus.OK)<br />             {<br />                 ids.Add(rs.ObjectId);<br />                 FullSubentityPath path = FullSubentityPath.Null;<br />                 path = HighlightSubEntity(rs);<br />                 if (path != FullSubentityPath.Null)<br />                     paths.Add(path);<br />             }<br />         } while (rs.Status == PromptStatus.OK);<br />         return (rs.Status == PromptStatus.Cancel);<br />     } <br /> <br />     // Ask the user to select a number of sub-entities.<br />     // These will have their ObjectIds and their sub-entity<br />     // paths (returned from the HighlightSubEntity() helper)<br />     // added to collections that are returned to the caller.<br /> <br />     private static bool SelectNestedEntities<br />         (<br />             Editor ed,<br />             out ObjectIdCollection ids,<br />             out List<FullSubentityPath> paths<br />         )<br />     {<br /> <br />         ids = new ObjectIdCollection();<br />         paths = new List<FullSubentityPath>(); <br /> <br />         // Loop until cancelled or completed<br /> <br />         PromptNestedEntityResult rs;<br />         do<br />         {<br />             rs = ed.GetNestedEntity("\nSelect nested entity: ");<br />             if (rs.Status == PromptStatus.OK)<br />             {<br />                 ids.Add(rs.ObjectId);<br />                 FullSubentityPath path = FullSubentityPath.Null;<br />                 path = HighlightSubEntity(rs);<br />                 if (path != FullSubentityPath.Null)<br />                     paths.Add(path);<br />             }<br />         } while (rs.Status == PromptStatus.OK); <br /> <br />         // Cancel is the status when "enter" is used to<br />         // terminate the selection, which means we can't<br />         // use it to distinguish from an actual<br />         // cancellation.<br /> <br />         return (rs.Status == PromptStatus.Cancel);<br />     } <br /> <br />     // Unhighlight a set of sub-entities<br /> <br />     private static void UnhighlightSubEntities(<br />                                 List<FullSubentityPath> paths)<br />     {<br />         for (int i = 0; i < paths.Count; i++)<br />         {<br />             ObjectId[] ids = paths<i>.GetObjectIds();<br />             Entity ent<br />                 = ids[0].GetObject(OpenMode.ForRead) as Entity;<br />             if (ent != null)<br />             {<br />                 ent.Unhighlight(paths<i>, false);<br />             }<br />         }<br />     }<br /> <br />     // Highlight a sub-entity based on its nested<br />     // selection information.<br />     // Return the calculated sub-entity path, so<br />     // the calling application can later unhighlight.<br /> <br />     private static FullSubentityPath HighlightSubEntity(<br />                                     PromptNestedEntityResult rs)<br />     {<br /> <br />         // Extract relevant information from the prompt object<br /> <br />         ObjectId selId = rs.ObjectId;<br />         List<ObjectId> objIds = new List<ObjectId>(rs.GetContainers()); <br /> <br />         // Reverse the "containers" list<br /> <br />         objIds.Reverse(); <br /> <br />         // Now append the selected entity<br /> <br />         objIds.Add(selId); <br /> <br />         // Retrieve the sub-entity path for this entity<br /> <br />         SubentityId subEnt<br />             = new SubentityId(SubentityType.Null, System.IntPtr.Zero);<br />         FullSubentityPath path<br />             = new FullSubentityPath(objIds.ToArray(), subEnt); <br /> <br />         // Open the outermost container, relying on the open transaction...<br /> <br />         Entity ent = objIds[0].GetObject(OpenMode.ForRead) as Entity;<br />         // ... and highlight the nested entity<br />         if (ent == null)<br />             return FullSubentityPath.Null;<br />         ent.Highlight(path, false);<br />         // Return the sub-entity path for later unhighlighting<br />         return path;<br />     }<br />     void IExtensionApplication.Initialize() { }<br />     void IExtensionApplication.Terminate()<br />     {<br />         if (_do != null)<br />         {<br />             Overrule.Overruling = false;<br />             Overrule.RemoveOverrule(<br />                 RXObject.GetClass(typeof(Entity)),<br />                 _do);<br />         }<br />     }<br /> }<br />