Spatial Filter (XCLIP command) command in C#

eachy

Spatial Filter (XCLIP command) command in C#                                                        By Augusto Goncalves
  Is it possible to programmatically create a spatial filter like XCLIP command in .Net? Unfortunately the AcDbIndexFilterManager::addFilter method is not exposed, but we can P/Invoke it. The following C# sample illustrates how to do that. Note that some version specific decorated names are used (see EntryPoint parameter), which can cause this code not to work on other versions.

2. 
   
3. 
   
4. // required ObjectARX methods, called with P/Invoke
   
5. // this is valid for R19 release (AutoCAD 2013)
   
6. 
   
7. [DllImport("acdb19.dll",
   
8.     CharSet = CharSet.Unicode,
   
9.     CallingConvention = CallingConvention.Cdecl,
   
10.     EntryPoint = "?addFilter@AcDbIndexFilterManager@@YA?AW4ErrorStatus@Acad@@PAVAcDbBlockReference@@PAVAcDbFilter@@@Z")]
    
11. private static extern int addFilter32(IntPtr pBlkRef, IntPtr pFilter);
    
12. 
    
13. [DllImport("acdb19.dll",
    
14.     CharSet = CharSet.Unicode,
    
15.     CallingConvention = CallingConvention.Cdecl,
    
16.     EntryPoint = "?addFilter@AcDbIndexFilterManager@@YA?AW4ErrorStatus@Acad@@PEAVAcDbBlockReference@@PEAVAcDbFilter@@@Z")]
    
17. private static extern int addFilter64(IntPtr pBlkRef, IntPtr pFilter);
    
18. 
    
19. 
    
20. 
    
21. /// <summary>
    
22. /// Check if the OS is 32 or 64 bit
    
23. /// </summary>
    
24. static public bool is64bits
    
25. {
    
26.   get { return (Application.GetSystemVariable
    
27.     ("PLATFORM").ToString().IndexOf("64") > 0); }
    
28. }
    
29. 
    
30. //Create a spatial filter on the selected block reference
    
31. //create rectangular cliping area by providing the 2 corners
    
32. [CommandMethod("NetClip")]
    
33. public void NetClip()
    
34. {
    
35.   // required variables
    
36.   Document doc = Application.DocumentManager.
    
37.     MdiActiveDocument;
    
38.   Database db = doc.Database;
    
39.   Editor ed = doc.Editor;
    
40.   // select a block reference
    
41.   PromptEntityOptions peo = new PromptEntityOptions(
    
42.     "\nSelect a block reference: ");
    
43.   peo.SetRejectMessage("\nMust be a block reference...");
    
44.   peo.AddAllowedClass(typeof(BlockReference), true);
    
45.   PromptEntityResult per = ed.GetEntity(peo);
    
46. 
    
47.   if (per.Status != PromptStatus.OK) return;
    
48.   PromptPointOptions ppo = new PromptPointOptions(
    
49.     "\nSelect rect clip 1st corner: ");
    
50.   PromptPointResult ppr1 = ed.GetPoint(ppo);
    
51. 
    
52.   if (ppr1.Status != PromptStatus.OK)
    
53.     return;
    
54.   PromptCornerOptions pco = new PromptCornerOptions(
    
55.     "\nSelect rect clip 2nd corner: ", ppr1.Value);
    
56.   pco.UseDashedLine = true;
    
57.   PromptPointResult ppr2 = ed.GetCorner(pco);
    
58.   if (ppr2.Status != PromptStatus.OK)
    
59.     return;
    
60.   using (Transaction trans = db.TransactionManager
    
61.     .StartTransaction())
    
62.   {
    
63.     BlockReference bref = trans.GetObject(per.ObjectId,
    
64.       OpenMode.ForWrite) as BlockReference;
    
65. 
    
66.    //Define clip rectangle
    
67.     Point3d pt3d1 = ppr1.Value.TransformBy(
    
68.       bref.BlockTransform.Inverse());
    
69.     Point3d pt3d2 = ppr2.Value.TransformBy(
    
70.       bref.BlockTransform.Inverse());
    
71.     Point2dCollection boundary =
    
72.       GetClipRectangle(pt3d1, pt3d2);
    
73.     double elevation = 0.0;
    
74.     SpatialFilter filter = new SpatialFilter();
    
75.     filter.Definition = new
    
76.       SpatialFilterDefinition(boundary,
    
77.       bref.Normal, elevation, 1000, -1000, true);
    
78.     //P/Invoke AcDbIndexFilterManager::addFilter
    
79.     int es;
    
80.     if (is64bits)
    
81.       es = addFilter64(bref.UnmanagedObject,
    
82.         filter.UnmanagedObject);
    
83.     else
    
84.       es = addFilter32(bref.UnmanagedObject,
    
85.         filter.UnmanagedObject);
    
86.     if (es == 0)
    
87.     {
    
88.       ed.WriteMessage(
    
89.         "\nSpatial filter added successfully...");
    
90.       DrawClipBoundary(boundary, bref,
    
91.         bref.Normal, elevation);
    
92.     }
    
93.     else
    
94.     {
    
95.       ed.WriteMessage(
    
96.         "\nSpatial filter failed:(...Error code:"
    
97.         + es.ToString());
    
98.     };
    
99. 
    
100.     // need to explicitely close the filter
     
101.     filter.Close();
     
102.     trans.Commit();
     
103.   }
     
104. }
     
105. // the clip rectangle needs to be provided
     
106. // with (lower-left, upper-right) so we may
     
107. // need to re-arrange depending on how the
     
108. // user selected corners
     
109. Point2dCollection GetClipRectangle(
     
110.   Point3d p1, Point3d p2)
     
111. {
     
112.   Point2dCollection clipRect =
     
113.     new Point2dCollection();
     
114.   double minX = p1.X;
     
115.   double minY = p1.Y;
     
116.   double maxX = p2.X;
     
117.   double maxY = p2.Y;
     
118. 
     
119.   if (minX > p2.X)
     
120.   {
     
121.     minX = p2.X;
     
122.     maxX = p1.X;
     
123.   }
     
124. 
     
125.   if (minY > p2.Y)
     
126.   {
     
127.     minY = p2.Y;
     
128.     maxY = p1.Y;
     
129.   }
     
130. 
     
131.   clipRect.Add(new Point2d(minX, minY));
     
132.   clipRect.Add(new Point2d(maxX, maxY));
     
133.   return clipRect;
     
134. }
     
135. 
     
136. //Just an optional method in order to visualize the clip area
     
137. 
     
138. void DrawClipBoundary(
     
139.   Point2dCollection boundary,
     
140.   BlockReference bref,
     
141.   Vector3d Normal,
     
142.   double elevation)
     
143. {
     
144.   Database db = HostApplicationServices.
     
145.     WorkingDatabase;
     
146. 
     
147.   using (Transaction trans =
     
148.     db.TransactionManager.StartTransaction())
     
149.   {
     
150.     BlockTable bT = trans.GetObject(
     
151.       db.BlockTableId, OpenMode.ForRead)
     
152.       as BlockTable;
     
153.     BlockTableRecord bTR = trans.GetObject(
     
154.       bT[BlockTableRecord.ModelSpace],
     
155.       OpenMode.ForWrite)
     
156.         as BlockTableRecord;
     
157.     Polyline pline = new Polyline();
     
158.     pline.Closed = true;
     
159.     pline.Thickness = 0.0;
     
160.     pline.SetPropertiesFrom(bref);
     
161.     pline.Normal = Normal;
     
162.     pline.Elevation = elevation;
     
163.     pline.ColorIndex = 1;
     
164.     pline.AddVertexAt(0,
     
165.       new Point2d(
     
166.         boundary[0].X, boundary[0].Y), 0, 0, 0);
     
167.     pline.AddVertexAt(1,
     
168.       new Point2d(
     
169.         boundary[0].X, boundary[1].Y), 0, 0, 0);
     
170.     pline.AddVertexAt(2,
     
171.       new Point2d(
     
172.         boundary[1].X, boundary[1].Y), 0, 0, 0);
     
173.     pline.AddVertexAt(3,
     
174.       new Point2d(
     
175.         boundary[1].X, boundary[0].Y), 0, 0, 0);
     
176.     pline.TransformBy(bref.BlockTransform);
     
177.     bTR.AppendEntity(pline);
     
178.     trans.AddNewlyCreatedDBObject(pline, true);
     
179.     trans.Commit();
     
180.   }
     
181. }
     

<br /> <br /> // required ObjectARX methods, called with P/Invoke<br /> // this is valid for R19 release (AutoCAD 2013)<br /> <br /> [DllImport("acdb19.dll",<br />     CharSet = CharSet.Unicode,<br />     CallingConvention = CallingConvention.Cdecl,<br />     EntryPoint = "?addFilter@AcDbIndexFilterManager@@YA?AW4ErrorStatus@Acad@@PAVAcDbBlockReference@@PAVAcDbFilter@@@Z")]<br /> private static extern int addFilter32(IntPtr pBlkRef, IntPtr pFilter);<br /> <br /> [DllImport("acdb19.dll",<br />     CharSet = CharSet.Unicode,<br />     CallingConvention = CallingConvention.Cdecl,<br />     EntryPoint = "?addFilter@AcDbIndexFilterManager@@YA?AW4ErrorStatus@Acad@@PEAVAcDbBlockReference@@PEAVAcDbFilter@@@Z")]<br /> private static extern int addFilter64(IntPtr pBlkRef, IntPtr pFilter);<br /> <br /> <br /> <br /> /// <summary><br /> /// Check if the OS is 32 or 64 bit<br /> /// </summary><br /> static public bool is64bits<br /> {<br />   get { return (Application.GetSystemVariable<br />     ("PLATFORM").ToString().IndexOf("64") > 0); }<br /> }<br /> <br /> //Create a spatial filter on the selected block reference<br /> //create rectangular cliping area by providing the 2 corners<br /> [CommandMethod("NetClip")]<br /> public void NetClip()<br /> {<br />   // required variables<br />   Document doc = Application.DocumentManager.<br />     MdiActiveDocument;<br />   Database db = doc.Database;<br />   Editor ed = doc.Editor;<br />   // select a block reference<br />   PromptEntityOptions peo = new PromptEntityOptions(<br />     "\nSelect a block reference: ");<br />   peo.SetRejectMessage("\nMust be a block reference...");<br />   peo.AddAllowedClass(typeof(BlockReference), true);<br />   PromptEntityResult per = ed.GetEntity(peo);<br /> <br />   if (per.Status != PromptStatus.OK) return;<br />   PromptPointOptions ppo = new PromptPointOptions(<br />     "\nSelect rect clip 1st corner: ");<br />   PromptPointResult ppr1 = ed.GetPoint(ppo);<br /> <br />   if (ppr1.Status != PromptStatus.OK)<br />     return;<br />   PromptCornerOptions pco = new PromptCornerOptions(<br />     "\nSelect rect clip 2nd corner: ", ppr1.Value);<br />   pco.UseDashedLine = true;<br />   PromptPointResult ppr2 = ed.GetCorner(pco);<br />   if (ppr2.Status != PromptStatus.OK)<br />     return;<br />   using (Transaction trans = db.TransactionManager<br />     .StartTransaction())<br />   {<br />     BlockReference bref = trans.GetObject(per.ObjectId,<br />       OpenMode.ForWrite) as BlockReference;<br /> <br />    //Define clip rectangle<br />     Point3d pt3d1 = ppr1.Value.TransformBy(<br />       bref.BlockTransform.Inverse());<br />     Point3d pt3d2 = ppr2.Value.TransformBy(<br />       bref.BlockTransform.Inverse());<br />     Point2dCollection boundary =<br />       GetClipRectangle(pt3d1, pt3d2);<br />     double elevation = 0.0;<br />     SpatialFilter filter = new SpatialFilter();<br />     filter.Definition = new<br />       SpatialFilterDefinition(boundary,<br />       bref.Normal, elevation, 1000, -1000, true);<br />     //P/Invoke AcDbIndexFilterManager::addFilter<br />     int es;<br />     if (is64bits)<br />       es = addFilter64(bref.UnmanagedObject,<br />         filter.UnmanagedObject);<br />     else<br />       es = addFilter32(bref.UnmanagedObject,<br />         filter.UnmanagedObject);<br />     if (es == 0)<br />     {<br />       ed.WriteMessage(<br />         "\nSpatial filter added successfully...");<br />       DrawClipBoundary(boundary, bref,<br />         bref.Normal, elevation);<br />     }<br />     else<br />     {<br />       ed.WriteMessage(<br />         "\nSpatial filter failed:(...Error code:"<br />         + es.ToString());<br />     };<br /> <br />     // need to explicitely close the filter<br />     filter.Close();<br />     trans.Commit();<br />   }<br /> }<br /> // the clip rectangle needs to be provided<br /> // with (lower-left, upper-right) so we may<br /> // need to re-arrange depending on how the<br /> // user selected corners<br /> Point2dCollection GetClipRectangle(<br />   Point3d p1, Point3d p2)<br /> {<br />   Point2dCollection clipRect =<br />     new Point2dCollection();<br />   double minX = p1.X;<br />   double minY = p1.Y;<br />   double maxX = p2.X;<br />   double maxY = p2.Y;<br /> <br />   if (minX > p2.X)<br />   {<br />     minX = p2.X;<br />     maxX = p1.X;<br />   }<br /> <br />   if (minY > p2.Y)<br />   {<br />     minY = p2.Y;<br />     maxY = p1.Y;<br />   }<br /> <br />   clipRect.Add(new Point2d(minX, minY));<br />   clipRect.Add(new Point2d(maxX, maxY));<br />   return clipRect;<br /> }<br /> <br /> //Just an optional method in order to visualize the clip area<br /> <br /> void DrawClipBoundary(<br />   Point2dCollection boundary,<br />   BlockReference bref,<br />   Vector3d Normal,<br />   double elevation)<br /> {<br />   Database db = HostApplicationServices.<br />     WorkingDatabase;<br /> <br />   using (Transaction trans =<br />     db.TransactionManager.StartTransaction())<br />   {<br />     BlockTable bT = trans.GetObject(<br />       db.BlockTableId, OpenMode.ForRead)<br />       as BlockTable;<br />     BlockTableRecord bTR = trans.GetObject(<br />       bT[BlockTableRecord.ModelSpace],<br />       OpenMode.ForWrite)<br />         as BlockTableRecord;<br />     Polyline pline = new Polyline();<br />     pline.Closed = true;<br />     pline.Thickness = 0.0;<br />     pline.SetPropertiesFrom(bref);<br />     pline.Normal = Normal;<br />     pline.Elevation = elevation;<br />     pline.ColorIndex = 1;<br />     pline.AddVertexAt(0,<br />       new Point2d(<br />         boundary[0].X, boundary[0].Y), 0, 0, 0);<br />     pline.AddVertexAt(1,<br />       new Point2d(<br />         boundary[0].X, boundary[1].Y), 0, 0, 0);<br />     pline.AddVertexAt(2,<br />       new Point2d(<br />         boundary[1].X, boundary[1].Y), 0, 0, 0);<br />     pline.AddVertexAt(3,<br />       new Point2d(<br />         boundary[1].X, boundary[0].Y), 0, 0, 0);<br />     pline.TransformBy(bref.BlockTransform);<br />     bTR.AppendEntity(pline);<br />     trans.AddNewlyCreatedDBObject(pline, true);<br />     trans.Commit();<br />   }<br /> }<br />