Retrieving nested entities under cursor aperture using .Net API

csharp

http://adndevblog.typepad.com/autocad/2012/04/retrieving-nested-entities-under-cursor-aperture-using-net-api.html
Retrieving nested entities under cursor aperture using .Net API



By Philippe Leefsma



I was asked this useful question by an ADN member a while ago, being able to retrieve in real time the entities under the cursor aperture, as the user is moving the mouse pointer. If the question is not the most challenging, looking for retrieving as well nested entities, like for example the ones contained in an xref, is making the task more interesting…

Retrieving entities at a specified point is unfortunately not directly exposed through managed functions, so one needs to rely on P/Invoking, among others, acedSSGet and acedSSName with the “:N” option. However this later will not return entities being nested, typically in a block reference. In order to retrieve nested entities, invoking acedSSNameX is required, and due to the signature of this method, P/Invoking it from .Net is not very intuitive: declaration of a custom structure “resbuf” is required, as well as relying on a piece of unsafe code in order to map managed and unmanaged objects.

Running command “UnderCursorNested” will dump to commandline any entity under mouse cursor being a block reference placed on layer “0”, or any nested entity contained by that block reference, including entities from an xref. This filtering condition can of course be modified to suits your needs.  

1. class ArxImports
   
2. 
   
3. {
   
4. 
   
5.     public struct ads_name
   
6. 
   
7.     {
   
8. 
   
9.         public IntPtr a;
   
10. 
    
11.         public IntPtr b;
    
12. 
    
13.     };
    
14. 
    
15. 
    
16. 
    
17.     [StructLayout(LayoutKind.Sequential, Size = 32)]
    
18. 
    
19.     public struct resbuf { }
    
20. 
    
21. 
    
22. 
    
23.     [DllImport("acad.exe",
    
24. 
    
25.         CallingConvention = CallingConvention.Cdecl,
    
26. 
    
27.         CharSet = CharSet.Unicode,
    
28. 
    
29.         ExactSpelling = true)]
    
30. 
    
31.     public static extern PromptStatus acedSSGet(
    
32. 
    
33.         string str, IntPtr pt1, IntPtr pt2,
    
34. 
    
35.         IntPtr filter, out ads_name ss);
    
36. 
    
37. 
    
38. 
    
39.     [DllImport("acad.exe",
    
40. 
    
41.         CallingConvention = CallingConvention.Cdecl,
    
42. 
    
43.         CharSet = CharSet.Unicode,
    
44. 
    
45.         ExactSpelling = true)]
    
46. 
    
47.     public static extern PromptStatus acedSSFree(ref ads_name ss);
    
48. 
    
49. 
    
50. 
    
51.     [DllImport("acad.exe",
    
52. 
    
53.         CallingConvention = CallingConvention.Cdecl,
    
54. 
    
55.         CharSet = CharSet.Unicode,
    
56. 
    
57.         ExactSpelling = true)]
    
58. 
    
59.     public static extern PromptStatus acedSSLength(
    
60. 
    
61.         ref ads_name ss, out int len);
    
62. 
    
63. 
    
64. 
    
65.     [DllImport("acad.exe",
    
66. 
    
67.         CallingConvention = CallingConvention.Cdecl,
    
68. 
    
69.         CharSet = CharSet.Unicode,
    
70. 
    
71.         ExactSpelling = true)]
    
72. 
    
73.     public unsafe static extern PromptStatus acedSSNameX(
    
74. 
    
75.         resbuf** rbpp, ref ads_name ss, int i);
    
76. 
    
77. }
    
78. 
    
79. 
    
80. 
    
81. class CursorDetectCls
    
82. 
    
83. {
    
84. 
    
85.     Editor _ed;
    
86. 
    
87. 
    
88. 
    
89.     [CommandMethod("UnderCursorNested")]
    
90. 
    
91.     public void UnderCursorNested()
    
92. 
    
93.     {
    
94. 
    
95.         _ed = Application.DocumentManager.MdiActiveDocument.Editor;
    
96. 
    
97. 
    
98. 
    
99.         //Set up PointMonitor event
    
100. 
     
101.         _ed.PointMonitor +=
     
102. 
     
103.             new PointMonitorEventHandler(PointMonitorMulti);
     
104. 
     
105.     }
     
106. 
     
107. 
     
108. 
     
109.     void PointMonitorMulti(object sender, PointMonitorEventArgs e)
     
110. 
     
111.     {
     
112. 
     
113.         //Filters only block references (INSERT)
     
114. 
     
115.         //that are on layer "0"
     
116. 
     
117.         ResultBuffer resbuf = new ResultBuffer(
     
118. 
     
119.             new TypedValue(-4, "<and"),
     
120. 
     
121.             new TypedValue(0, "INSERT"),
     
122. 
     
123.             new TypedValue(8, "0"),
     
124. 
     
125.             new TypedValue(-4, "and>"));
     
126. 
     
127. 
     
128. 
     
129.         ObjectId[] ids = FindAtPointNested(
     
130. 
     
131.             _ed.Document,
     
132. 
     
133.             e.Context.RawPoint,
     
134. 
     
135.             true,
     
136. 
     
137.             resbuf.UnmanagedObject);
     
138. 
     
139. 
     
140. 
     
141.         //Dump result to commandline
     
142. 
     
143.         foreach (ObjectId id in ids)
     
144. 
     
145.         {
     
146. 
     
147.             _ed.WriteMessage("\n - Entity: {0} [Id:{1}]",
     
148. 
     
149.                 id.ObjectClass.Name,
     
150. 
     
151.                 id.ToString());
     
152. 
     
153.         }
     
154. 
     
155.     }
     
156. 
     
157. 
     
158. 
     
159.     //Retruns ObjectIds of entities at a specific position
     
160. 
     
161.     //Including nested entities in block references
     
162. 
     
163.     static public ObjectId[] FindAtPointNested(
     
164. 
     
165.         Document doc,
     
166. 
     
167.         Point3d worldPoint,
     
168. 
     
169.         bool selectAll,
     
170. 
     
171.         IntPtr filter)
     
172. 
     
173.     {
     
174. 
     
175.         System.Collections.Generic.List<ObjectId> ids =
     
176. 
     
177.             new System.Collections.Generic.List<ObjectId>();
     
178. 
     
179. 
     
180. 
     
181.         Matrix3d wcs2ucs =
     
182. 
     
183.             doc.Editor.CurrentUserCoordinateSystem.Inverse();
     
184. 
     
185. 
     
186. 
     
187.         Point3d ucsPoint = worldPoint.TransformBy(wcs2ucs);
     
188. 
     
189. 
     
190. 
     
191.         string arg = selectAll ? "_:E:N" : "_:N";
     
192. 
     
193. 
     
194. 
     
195.         IntPtr ptrPoint = Marshal.UnsafeAddrOfPinnedArrayElement(
     
196. 
     
197.             worldPoint.ToArray(), 0);
     
198. 
     
199. 
     
200. 
     
201.         ArxImports.ads_name sset;
     
202. 
     
203. 
     
204. 
     
205.         PromptStatus prGetResult = ArxImports.acedSSGet(
     
206. 
     
207.             arg, ptrPoint, IntPtr.Zero, filter, out sset);
     
208. 
     
209. 
     
210. 
     
211.         int len;
     
212. 
     
213.         ArxImports.acedSSLength(ref sset, out len);
     
214. 
     
215. 
     
216. 
     
217.         //Need to rely on unsafe code in order to use pointers *
     
218. 
     
219.         unsafe
     
220. 
     
221.         {
     
222. 
     
223.             for (int i = 0; i < len; ++i)
     
224. 
     
225.             {
     
226. 
     
227.                 ArxImports.resbuf rb = new ArxImports.resbuf();
     
228. 
     
229. 
     
230. 
     
231.                 ArxImports.resbuf* pRb = &rb;
     
232. 
     
233. 
     
234. 
     
235.                 if (ArxImports.acedSSNameX(&pRb, ref sset, i) !=
     
236. 
     
237.                     PromptStatus.OK)
     
238. 
     
239.                     continue;
     
240. 
     
241. 
     
242. 
     
243.                 //Create managed ResultBuffer from our resbuf struct
     
244. 
     
245.                 using (ResultBuffer rbMng = DisposableWrapper.Create(
     
246. 
     
247.                     typeof(ResultBuffer),
     
248. 
     
249.                     (IntPtr)pRb,
     
250. 
     
251.                     true) as ResultBuffer)
     
252. 
     
253.                 {
     
254. 
     
255.                     foreach (TypedValue tpVal in rbMng)
     
256. 
     
257.                     {
     
258. 
     
259.                         //Not interested if it isn't an ObjectId
     
260. 
     
261.                         if (tpVal.TypeCode != 5006) //RTENAME
     
262. 
     
263.                             continue;
     
264. 
     
265. 
     
266. 
     
267.                         ObjectId id = (ObjectId)tpVal.Value;
     
268. 
     
269. 
     
270. 
     
271.                         if (id != null)
     
272. 
     
273.                             ids.Add(id);
     
274. 
     
275.                     }
     
276. 
     
277.                 }
     
278. 
     
279.             }
     
280. 
     
281.         }
     
282. 
     
283. 
     
284. 
     
285.         ArxImports.acedSSFree(ref sset);
     
286. 
     
287. 
     
288. 
     
289.         return ids.ToArray();
     
290. 
     
291.     }
     
292. 
     
293. }
     

class ArxImports<br /> <br /> {<br /> <br />     public struct ads_name<br /> <br />     {<br /> <br />         public IntPtr a;<br /> <br />         public IntPtr b;<br /> <br />     };<br /> <br /> <br /> <br />     [StructLayout(LayoutKind.Sequential, Size = 32)]<br /> <br />     public struct resbuf { }<br /> <br /> <br /> <br />     [DllImport("acad.exe", <br /> <br />         CallingConvention = CallingConvention.Cdecl, <br /> <br />         CharSet = CharSet.Unicode, <br /> <br />         ExactSpelling = true)]<br /> <br />     public static extern PromptStatus acedSSGet(<br /> <br />         string str, IntPtr pt1, IntPtr pt2, <br /> <br />         IntPtr filter, out ads_name ss);<br /> <br /> <br /> <br />     [DllImport("acad.exe", <br /> <br />         CallingConvention = CallingConvention.Cdecl, <br /> <br />         CharSet = CharSet.Unicode, <br /> <br />         ExactSpelling = true)]<br /> <br />     public static extern PromptStatus acedSSFree(ref ads_name ss);<br /> <br /> <br /> <br />     [DllImport("acad.exe", <br /> <br />         CallingConvention = CallingConvention.Cdecl, <br /> <br />         CharSet = CharSet.Unicode, <br /> <br />         ExactSpelling = true)]<br /> <br />     public static extern PromptStatus acedSSLength(<br /> <br />         ref ads_name ss, out int len);<br /> <br /> <br /> <br />     [DllImport("acad.exe", <br /> <br />         CallingConvention = CallingConvention.Cdecl, <br /> <br />         CharSet = CharSet.Unicode, <br /> <br />         ExactSpelling = true)]<br /> <br />     public unsafe static extern PromptStatus acedSSNameX(<br /> <br />         resbuf** rbpp, ref ads_name ss, int i);<br /> <br /> }<br /> <br /> <br /> <br /> class CursorDetectCls<br /> <br /> {<br /> <br />     Editor _ed;<br /> <br /> <br /> <br />     [CommandMethod("UnderCursorNested")]<br /> <br />     public void UnderCursorNested()<br /> <br />     {<br /> <br />         _ed = Application.DocumentManager.MdiActiveDocument.Editor;<br /> <br /> <br /> <br />         //Set up PointMonitor event<br /> <br />         _ed.PointMonitor += <br /> <br />             new PointMonitorEventHandler(PointMonitorMulti);<br /> <br />     }<br /> <br /> <br /> <br />     void PointMonitorMulti(object sender, PointMonitorEventArgs e)<br /> <br />     {<br /> <br />         //Filters only block references (INSERT)<br /> <br />         //that are on layer "0"<br /> <br />         ResultBuffer resbuf = new ResultBuffer(<br /> <br />             new TypedValue(-4, "<and"),<br /> <br />             new TypedValue(0, "INSERT"),<br /> <br />             new TypedValue(8, "0"),<br /> <br />             new TypedValue(-4, "and>"));<br /> <br /> <br /> <br />         ObjectId[] ids = FindAtPointNested(<br /> <br />             _ed.Document, <br /> <br />             e.Context.RawPoint, <br /> <br />             true, <br /> <br />             resbuf.UnmanagedObject);<br /> <br /> <br /> <br />         //Dump result to commandline<br /> <br />         foreach (ObjectId id in ids)<br /> <br />         {<br /> <br />             _ed.WriteMessage("\n - Entity: {0} [Id:{1}]", <br /> <br />                 id.ObjectClass.Name, <br /> <br />                 id.ToString());<br /> <br />         }<br /> <br />     }<br /> <br /> <br /> <br />     //Retruns ObjectIds of entities at a specific position<br /> <br />     //Including nested entities in block references<br /> <br />     static public ObjectId[] FindAtPointNested(<br /> <br />         Document doc,<br /> <br />         Point3d worldPoint,<br /> <br />         bool selectAll,<br /> <br />         IntPtr filter)<br /> <br />     {<br /> <br />         System.Collections.Generic.List<ObjectId> ids = <br /> <br />             new System.Collections.Generic.List<ObjectId>();<br /> <br /> <br /> <br />         Matrix3d wcs2ucs = <br /> <br />             doc.Editor.CurrentUserCoordinateSystem.Inverse();<br /> <br /> <br /> <br />         Point3d ucsPoint = worldPoint.TransformBy(wcs2ucs);<br /> <br /> <br /> <br />         string arg = selectAll ? "_:E:N" : "_:N";<br /> <br /> <br /> <br />         IntPtr ptrPoint = Marshal.UnsafeAddrOfPinnedArrayElement(<br /> <br />             worldPoint.ToArray(), 0);<br /> <br /> <br /> <br />         ArxImports.ads_name sset;<br /> <br /> <br /> <br />         PromptStatus prGetResult = ArxImports.acedSSGet(<br /> <br />             arg, ptrPoint, IntPtr.Zero, filter, out sset);<br /> <br /> <br /> <br />         int len;<br /> <br />         ArxImports.acedSSLength(ref sset, out len);<br /> <br /> <br /> <br />         //Need to rely on unsafe code in order to use pointers *<br /> <br />         unsafe<br /> <br />         {<br /> <br />             for (int i = 0; i < len; ++i)<br /> <br />             {<br /> <br />                 ArxImports.resbuf rb = new ArxImports.resbuf();<br /> <br /> <br /> <br />                 ArxImports.resbuf* pRb = &rb;<br /> <br /> <br /> <br />                 if (ArxImports.acedSSNameX(&pRb, ref sset, i) != <br /> <br />                     PromptStatus.OK)<br /> <br />                     continue;<br /> <br /> <br /> <br />                 //Create managed ResultBuffer from our resbuf struct<br /> <br />                 using (ResultBuffer rbMng = DisposableWrapper.Create(<br /> <br />                     typeof(ResultBuffer),<br /> <br />                     (IntPtr)pRb,<br /> <br />                     true) as ResultBuffer)<br /> <br />                 {<br /> <br />                     foreach (TypedValue tpVal in rbMng)<br /> <br />                     {<br /> <br />                         //Not interested if it isn't an ObjectId<br /> <br />                         if (tpVal.TypeCode != 5006) //RTENAME<br /> <br />                             continue;<br /> <br /> <br /> <br />                         ObjectId id = (ObjectId)tpVal.Value;<br /> <br /> <br /> <br />                         if (id != null)<br /> <br />                             ids.Add(id);<br /> <br />                     }<br /> <br />                 }<br /> <br />             }<br /> <br />         }<br /> <br /> <br /> <br />         ArxImports.acedSSFree(ref sset);<br /> <br /> <br /> <br />         return ids.ToArray();<br /> <br />     }<br /> <br /> }<br />