Revit二次开发 - 过滤器
2.2选择过滤
2.2.1 选择过滤器
在Revit中，经常需要通过鼠标选择一个或多个构件，Revit API 提供的方法:
uiDoc.Selection.PickObject(ObjectType.Element, "选择一个构件");
选择多个或者框选，API提供的的方法：
uiDoc.Selection.PickObjects(ObjectType.Element, "选择多个");
但是，有时候只需要选择某种类型的构件，比如只选择墙或楼板，限制选择的类型，从而可以避免一些误选的情况发生。为了实现这样的效果，API 提供了选择过滤器ISelectionFilter。
创建一个选择过滤器：
public class WallSelectionFilter : ISelectionFilter
{
public bool AllowElement(Element elem)
{
//添加过滤的条件，允许被选中，返回True，反之，不被选中
return true;
}
public bool AllowReference(Reference reference, XYZ position)
{
//添加过滤的条件，允许被选中，返回True，反之，不被选中
return true;
}
}
综合案例：实现只能选择多个墙，其他类型的构件不能被选中。实现代码如下：
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Autodesk.Revit.DB;
using Autodesk.Revit.UI;
using Autodesk.Revit.Attributes;
using Autodesk.Revit.UI.Selection;
namespace RevitDemo
{
[Transaction(TransactionMode.Manual)]
public class TestCommand : IExternalCommand
{
public Result Execute(ExternalCommandData commandData, ref string message, ElementSet elements)
{
UIDocument uiDoc = commandData.Application.ActiveUIDocument;
Document document = uiDoc.Document;
//创建一个选择过滤器
WallSelectionFilter wallSelectionFilter = new WallSelectionFilter();
//通过鼠标选择墙
List<Reference> referenceList = uiDoc.Selection.PickObjects(ObjectType.Element, wallSelectionFilter, "选择多个墙").ToList();
//得到选中的墙
foreach (Reference reference in referenceList)
{
Wall wall = document.GetElement(reference) as Wall;
}
return Result.Succeeded;
}
}
public class WallSelectionFilter : ISelectionFilter
{
//该方法中，添加选择判断
public bool AllowElement(Element elem)
{
//判断选择将要选择的元素，如果是Wall, 返回True， 表示鼠标可以选中
if (elem is Wall)
{
return true;
}
return false;
}
//该方法通常返回True就可以了。 在选择几何对象时候：点，线，面 可以通过该方法过滤是否选中
//或则链接对象，比如CAD图纸，链接模型
public bool AllowReference(Reference reference, XYZ position)
{
return true;
}
}
}
2.2.2 元素过滤器
Revit建模项目中，成果交付时往往需要检查模型是否符合设计，有这样的一个需求：检查门窗的信息是否正确，门窗的开关方式是否正确。这样的需求在模型中检查的过程是很繁重的，还会出现错漏的情况。针对这个的需求，可以通过把门窗所在的墙用特殊的颜色标记出来，在检查模型的时候就可以很容易查找门窗的位置。解决这个需求的大概思路：通过Revit API 的元素过滤器，得到模型的门和窗，通过门窗找到其所在墙，接着改变墙的颜色。
首先，需要一个元素过滤收集器FilteredElementCollector，用来设置查询和过滤得到特定的元素， 创建过滤收集器代码：
FilteredElementCollector collector = new FilteredElementCollector(document);
接着，通过过滤器来过滤模型中的特定元素，API中提供的过滤器有很多，常用的过滤器有：ElementCategoryFilter、ElementClassFilter。
创建ElementCategoryFilter过滤器，通过Lookup工具，查看窗的Category属性为：OST_Windows， 其实现的代码：
ElementCategoryFilter windowCategoryFilter = new ElementCategoryFilter(BuiltInCategory.OST_Windows);
需要注意是：ElementCategoryFilter过滤器筛选得到族类型和族实例。
那么还要通过ElementClassFilte过滤器进一步筛选，过滤得到窗的族实例，其中窗的族实例为：FamilyInstance。
ElementClassFilter familyInstanceClassFilter = new ElementClassFilter(typeof(FamilyInstance));
然后，通过FilteredElementCollector（元素过滤收集器）的WherePasses()的方法设置过滤器，得到需要过滤的特定元素。实现的代码：
List<Element> elementList = collector.WherePasses(windowCategoryFilter).WherePasses(familyInstanceClassFilter).ToElements().ToList();
针对上述的代码，会发现一个问题：如果要设置多个过滤器，用WherePasses()方法就显得代码很臃肿。API中实现同样的效果可以有多种方式。使用如下的代码实现：
collector.OfCategory(BuiltInCategory.OST_Windows);
collector.OfClass(typeof(FamilyInstance));
List<Element> elementList = collector.ToElements().ToList();
还可以通过逻辑过滤器来实现，API中提供的逻辑过滤器有：LogicalAndFilter，LogicalOrFilter。实现的代码：
//逻辑与过滤器
LogicalAndFilter logicalAndFilter = new LogicalAndFilter(windowCategoryFilter, familyInstanceClassFilter);
//设置过滤器，得到过滤的元素
List<Element> elementList = collector.WherePasses(logicalAndFilter).ToElements().ToList();
综合案例：实现窗所在的墙标记为特殊的颜色，其代码：
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Autodesk.Revit.DB;
using Autodesk.Revit.UI;
using Autodesk.Revit.Attributes;
using Autodesk.Revit.UI.Selection;
namespace RevitDemo
{
[Transaction(TransactionMode.Manual)]
public class TestCommand : IExternalCommand
{
public Result Execute(ExternalCommandData commandData, ref string message, ElementSet elements)
{
UIDocument uiDoc = commandData.Application.ActiveUIDocument;
Document document = uiDoc.Document;
//创建元素过滤收集器
FilteredElementCollector collector = new FilteredElementCollector(document);
//创建Category过滤器
ElementCategoryFilter windowCategoryFilter = new ElementCategoryFilter(BuiltInCategory.OST_Windows);
//创建Class过滤器
ElementClassFilter familyInstanceClassFilter = new ElementClassFilter(typeof(FamilyInstance));
//设置过滤器，得到过滤的元素
List<Element> elementList = collector.WherePasses(windowCategoryFilter).WherePasses(familyInstanceClassFilter).ToElements().ToList();
foreach (FamilyInstance window in elementList)
{
Element element = window.Host;
if (element is Wall)
{
Wall wall = element as Wall;
//修改墙的颜色
}
}
return Result.Succeeded;
}
}
}
