RevitAPI之FilteredElementCollector的基本应用
程序员文章站
2022-06-11 08:10:50
...
FilteredElementCollector即是收集器。它用来迭代以及过滤元素,它有三种构造方式,见表:
1)通用方法WherePasses(),在收集器中应用单一的ElementFilter。该方法可以在结果中重复使用来增加不同的过滤器(filter)。
2)快捷方法,不需要传初始化过滤器对象的易于使用的方法,相当于常用过滤器filter 的快捷键。比如OfClass(),OfCategoryId(),OwnedByView()。
3)并集、交集等运算方法,比如UnionWith()和IntersectWith()。
这些方法返回收集器本身,并允许不同的过滤器链式调用。
FilteredElementCollector的应用实例:
向收集器设置完必须的的过滤器之后,就可以获取符合条件的元素了,可以使用以下几种获取:
1)获取元素ID或者元素本身的迭代器。
2)获取符合过滤器条件的元素ID或者元素本身的集合。
3)获取符合过滤器条件的第一个元素ID或者元素本身。当只需要唯一一个符合条件的元素时,这种方式很有用,因为不用再去遍历所有符合条件的元素了。
1) foreach语法支持
FilteredElementCollector支持foreach语法:
2) LINQ支持
FilteredElementCollector类对元素实现IEnumerable接口,因此,可以对这个类使用 LINQ査洵语句和操作。
LINQ实例:
构造函数 |
描述 |
FilteredElementCollector(Document document) |
迭代会从文档里所有的元素进行。 |
FilteredElementCollector(Document document, ICollection<ElementId> elcmentlds) |
迭代会在一个文档和ElementId集合中进行 |
FilteredElementCollector( Document document, Elementld viewld) |
传入一个文挡和一个视图,迭代会在视图中所见的元素中进行 |
注意:初次创建该对象的时候,是没有应用任何的过滤器的,如果这时试图从该对象中迭代或者获取元素列表,会有异常抛出。
1)通用方法WherePasses(),在收集器中应用单一的ElementFilter。该方法可以在结果中重复使用来增加不同的过滤器(filter)。
2)快捷方法,不需要传初始化过滤器对象的易于使用的方法,相当于常用过滤器filter 的快捷键。比如OfClass(),OfCategoryId(),OwnedByView()。
3)并集、交集等运算方法,比如UnionWith()和IntersectWith()。
这些方法返回收集器本身,并允许不同的过滤器链式调用。
FilteredElementCollector的应用实例:
FilteredElementCollector collection = new FilteredElementCollector(RevitDoc);
ElementFilter filter = new ElementCategoryFilter(BuiltInCategory.OST_StackedWalls); collection.OfClass(typeof (Wall) ).WherePasses(filter);
ICollection< Elementld> foundIds = collection.ToElementIds();
向收集器设置完必须的的过滤器之后,就可以获取符合条件的元素了,可以使用以下几种获取:
1)获取元素ID或者元素本身的迭代器。
2)获取符合过滤器条件的元素ID或者元素本身的集合。
3)获取符合过滤器条件的第一个元素ID或者元素本身。当只需要唯一一个符合条件的元素时,这种方式很有用,因为不用再去遍历所有符合条件的元素了。
1) foreach语法支持
FilteredElementCollector支持foreach语法:
FilteredElementCollector collector = new FilteredElementCollector(m_doc);
// 查询并遍历文档中所有的Level
collector.WherePasses(new
ElementCategoryFilter(BuiltInCategory.OST_Levels)).WhereElementIsNotElementType();
foreach(Level level in collector)
{
TaskDialog.Show("Level Name", level.Name);
}
2) LINQ支持
FilteredElementCollector类对元素实现IEnumerable接口,因此,可以对这个类使用 LINQ査洵语句和操作。
LINQ实例:
FilteredElementCollector collector = new FilteredElementCollector(m_doc);
// 首先使用一个内建的过滤器来减少后面使用LINQ查询的元素数量
collector.WherePasses(new ElementCategoryFilter(BuiltInCategory.OST_Levels));
// LINQ查询:找到名字为"Level 1"的标高
var levelElements = from element in collector
where element.Name == "Level 1"
select element;
List<Autodesk.Revit.DB.Element> levels = levelElements.ToList<Autodesk.Revit.DB.Element>();
ElementId level1Id = levels[0].Id;
=========【更多高级应用请关注公众号】========
==================================