| name | xbim |
| description | xBIM Toolkit 是 .NET 平台开源 BIM(建筑信息模型)开发框架,提供 IFC2x3/IFC4 读写、几何处理(基于 OCCT)、COBie 数据交换、Web 可视化(xbim-viewer / WexBIM),是 .NET 生态中最完整的开源 BIM 解决方案。 |
| tags | ["bim","ifc","dotnet","csharp","geometry","occ"] |
项目地址: https://github.com/xBimTeam/XbimEssentials
几何引擎: https://github.com/xBimTeam/XbimGeometry
Web 查看器: https://github.com/xBimTeam/XbimWebUI
官方文档: https://docs.xbim.net/
许可证: CDDL-1.0
概述
xBIM 模块矩阵:
| 包 | 用途 |
|---|
Xbim.Common | 基础接口 |
Xbim.Ifc / Xbim.Ifc2x3 / Xbim.Ifc4 / Xbim.Ifc4x3 | IFC 实体类与读写(最新 Essentials v6.0.x 支持 IFC4x3_ADD2) |
Xbim.IO.Esent / Xbim.IO.MemoryModel | 磁盘 / 内存模型 |
Xbim.Geometry.Engine | 基于 OCCT 的几何引擎(C++/CLI) |
Xbim.ModelGeometry.Scene | 几何场景生成(用于可视化) |
Xbim.WeXplorer (WexBIM 文件) | WebGL 查看器格式 |
Xbim.CobieLiteUk | COBie 数据交换 |
Xbim.Presentation | WPF 三维展示 |
安装
dotnet add package Xbim.Essentials
dotnet add package Xbim.Geometry
dotnet add package Xbim.WindowsUI
Linux/macOS:使用 Xbim.Geometry 受限;可改用 Xbim.Essentials 仅做模型解析。Xbim.Essentials(当前 v6.0.x)多目标 .NET 6 / .NET 8。
打开 IFC
using Xbim.Ifc;
using Xbim.Ifc4.Interfaces;
using var model = IfcStore.Open("project.ifc");
foreach (var w in model.Instances.OfType<IIfcWall>())
Console.WriteLine($"{w.GlobalId} {w.Name}");
IfcStore 同时支持 .ifc/.ifczip/.ifcxml;亦可保存 .xbim(Esent 数据库)作为高速缓存。
修改并保存
using var model = IfcStore.Open("a.ifc", null, null);
using (var txn = model.BeginTransaction("rename walls"))
{
foreach (var w in model.Instances.OfType<IIfcWall>())
w.Name = "WALL_" + w.GlobalId;
txn.Commit();
}
model.SaveAs("b.ifc");
model.SaveAs("b.ifczip");
model.SaveAs("b.xbim");
创建新 IFC 模型
using Xbim.Ifc;
using Xbim.Ifc4.MeasureResource;
using Xbim.IO;
var ed = new XbimEditorCredentials {
ApplicationFullName = "MyApp", ApplicationIdentifier = "MyApp",
EditorsOrganisationName = "Org", EditorsFamilyName = "Doe",
EditorsGivenName = "John"
};
using var model = IfcStore.Create(ed, IfcSchemaVersion.Ifc4, XbimStoreType.InMemoryModel);
using (var txn = model.BeginTransaction("init"))
{
var project = model.Instances.New<Xbim.Ifc4.Kernel.IfcProject>(p => p.Name = "Project");
txn.Commit();
}
model.SaveAs("new.ifc");
几何处理与可视化
using Xbim.Ifc;
using Xbim.ModelGeometry.Scene;
using var model = IfcStore.Open("a.ifc");
var ctx = new Xbim3DModelContext(model);
ctx.CreateContext();
foreach (var inst in model.Instances.OfType<IIfcProduct>())
{
var rep = ctx.ShapeInstancesOf(inst);
foreach (var si in rep)
{
}
}
输出 WexBIM(用于 Web 查看器):
using var s = File.OpenWrite("a.wexbim");
using var bw = new BinaryWriter(s);
ctx.Write(bw);
前端用 xbim-viewer 加载。
查询常用 IFC 实体
foreach (var b in model.Instances.OfType<IIfcBuilding>()) { }
foreach (var s in model.Instances.OfType<IIfcBuildingStorey>()) { }
foreach (var w in model.Instances.OfType<IIfcWall>()) { }
foreach (var d in model.Instances.OfType<IIfcDoor>()) { }
foreach (var p in model.Instances.OfType<IIfcSpace>()) { }
foreach (var pset in model.Instances.OfType<IIfcPropertySet>())
foreach (var p in pset.HasProperties.OfType<IIfcPropertySingleValue>())
Console.WriteLine($"{pset.Name}.{p.Name} = {p.NominalValue}");
空间结构遍历
var project = model.Instances.OfType<IIfcProject>().FirstOrDefault();
foreach (var rel in project.IsDecomposedBy)
foreach (var site in rel.RelatedObjects.OfType<IIfcSite>())
foreach (var br in site.IsDecomposedBy)
foreach (var bld in br.RelatedObjects.OfType<IIfcBuilding>())
Console.WriteLine(bld.Name);
COBie 输出(资产数据)
using Xbim.CobieLiteUk;
using Xbim.IO.CobieLiteUk;
var facility = model.ToCobieLiteUkAsync().Result;
facility.WriteJson("out.json");
facility.WriteXml("out.xml");
facility.WriteXls("out.xlsx", out _);
性能优化
- 大文件先缓存为
.xbim(Esent):
IfcStore.Open("big.ifc", null, ifcDatabaseSizeThreshHold: 0)
- 几何解析昂贵,构建
Xbim3DModelContext 后缓存
- 关闭不需要的实体类型:在
CreateContext 中过滤
- 多线程:
Xbim3DModelContext.MaxThreads = N
- WPF 展示用
Xbim.Presentation 控件,不要直接绑定大模型
常见问题
| 问题 | 解决 |
|---|
Xbim.Geometry.Engine.Interop.dll 加载失败 | 缺 VC++ 运行时;目标平台必须是 x64 |
| 几何精度异常 | 设置 ModelFactors;用 OCCT ShapeFix |
| Linux 上几何 | 使用 .NET 几何引擎(受限),或迁移至 Xbim.WebUI |
| 模型大于 2GB | 切换为 Esent 后端,分批处理 |
AI 使用建议
- 推荐工作流模式:AI 助手应遵循 xBIM 的核心流程——
IfcStore.Open("project.ifc") 读取 → model.BeginTransaction("name") 修改 → txn.Commit() → model.SaveAs("out.ifc") 保存。大文件先缓存为 .xbim(Esent 数据库)加速后续操作。几何处理仅在 Windows x64 上可用。
- 关键注意事项:①
Xbim.Geometry.Engine 依赖 VC++ 运行时,仅 Windows x64 可用,Linux 仅做模型解析;② 模型大于 2GB 应使用 Esent 后端(IfcStore.Open(file, null, ifcDatabaseSizeThreshHold: 0));③ Xbim3DModelContext 几何解析昂贵,构建后应缓存;④ 事务修改需在 BeginTransaction/Commit 内完成。
- 常用代码模式:读取 IFC:
IfcStore.Open("project.ifc") → 遍历 model.Instances.OfType<IIfcWall>() → 修改属性 → 保存。创建模型:IfcStore.Create(ed, IfcSchemaVersion.Ifc4, XbimStoreType.InMemoryModel) → model.BeginTransaction() → model.Instances.New<T>() → txn.Commit() → model.SaveAs("new.ifc")。
相关技能
典型工作流
工作流一:IFC 模型读取与属性提取
IfcStore.Open("building.ifc") 打开 IFC 文件
- 按类型遍历实体:
model.Instances.OfType<IIfcWall>() / <IIfcDoor>() / <IIfcSpace>()
- 提取属性集:
model.Instances.OfType<IIfcPropertySet>() → pset.HasProperties.OfType<IIfcPropertySingleValue>()
- 遍历空间结构:
IIfcProject → IsDecomposedBy → IIfcSite → IIfcBuilding → IIfcBuildingStorey
- 生成 COBie 数据:
model.ToCobieLiteUkAsync().Result.WriteXls("out.xlsx")
- 导出 Web 可视化:
Xbim3DModelContext → ctx.Write(bw) 生成 .wexbim 文件
工作流二:程序化创建 IFC 模型
- 创建
XbimEditorCredentials 设置作者信息
IfcStore.Create(ed, IfcSchemaVersion.Ifc4, XbimStoreType.InMemoryModel) 创建空模型
model.BeginTransaction("init") 开始事务
- 使用
model.Instances.New<IfcProject>() / New<IfcSite>() / New<IfcBuilding>() 构建空间结构
- 添加墙/梁/柱/板等建筑元素,设置属性
txn.Commit() → model.SaveAs("new.ifc") 保存
参考资源