engine_web ifc

目录 |网络-ifc 文档 |平台文档|演示 |社区 | npm 包

网络国际金融中心

web-ifc是一个 JavaScript 库，用于以本机速度读取和写入 ifc 文件。 web-ifc是 That Open Company 项目的一部分，旨在降低开发开放式 BIM 应用程序的门槛。

安装

npm install web-ifc

快速设置

 const WebIFC = require ( "web-ifc/web-ifc-api.js" ) ;

// initialize the API
const ifcApi = new WebIFC . IfcAPI ( ) ;

// initialize the library
await ifcApi . Init ( ) ;

// open a model from data
let modelID = ifcApi . OpenModel ( /* IFC data as a string or UInt8Array */ , /* optional settings object */ , ) ;

// the model is now loaded! use modelID to fetch geometry or properties
// checkout examples/usage for some details on how to read/write IFC

// close the model, all memory is freed
ifcApi . CloseModel ( modelID ) ;

有关如何使用 web-ifc 的更多详细信息，请参阅示例。

当前版本

web-ifc 的当前实时版本可在此处获取。使用它可以让您在我们发布之前测试最新的修复。如果您想使用此版本，请下载 zip 文件并将 dist 文件夹的内容手动放入您的 node_modules/web-ifc 文件夹中。即，如果您使用的是 web-ifc-三，那么它将是 node_modules/web-ifc-三/node_modules/web-ifc。请注意，您必须替换 javascript 和 WASM。

要求

这些是构建 web-ifc 所需的要求（仅适用于那些希望构建自己的版本的人）。

1. 节点 v16 或更高版本
2. NPM v7 或更高版本
3. ESCRIPTEN v3.1.44 或更高版本
4. CMAKE v3.18 或更高版本

回归测试

我们在测试/公共文件夹中有一个测试模型库。如果您有想要贡献的模型，请打开 PR。

您可以通过运行npm run regression对所有这些模型运行回归测试。如果任何示例模型几何形状发生更改，它会提醒您。如果更改正确，您可以通过运行npm run regression-update来刷新回归测试。

构建 WASM 模块

设置 emscripten 和构建系统

WASM 库是通过 emscripten 构建的，有关如何设置 emscripten 的信息，请参阅 emscripten 安装指南。之后emsdk_env需要位于您的路径中。

要构建 WASM，您还需要 CMAKE 请参阅此处和（在 Windows 上）MINGW 请参阅此处 - 安装后（并在您的路径中）运行npm run setup-mingw来配置 web-ifc 的环境。

WASM库

运行npm install以安装所有依赖项。

每当打开新终端时运行npm run setup-env ，这将为您设置编译代码所需的 emscripten 环境变量。

运行npm run build-release以构建 wasm 二进制文件和随附的 web-ifc api 的发行版本。它将被放置在./dist中。

如果您希望构建启用调试的 WASM，您可以运行npm run build-debug 。这将使您能够在运行 web-ifc 时更好地检查调试信息。

运行npm run dev以启动带有基本 ifc 文件查看器的开发服务器。

构建文件

以下文件的构建过程 const 的输出：

1. web-ifc.wasm - 在浏览器中运行的 wasm（编译的 C++）
2. web-ifc-mt.wasm - 如果支持多线程，则在浏览器中运行 wasm（编译的 C++）。
3. web-ifc-node.wasm - 在节点中运行的 wasm（编译的 C++）
4. web-ifc-api-node.js - 编译 javascript 包装器，供 wasm 在节点中运行。
5. web-ifc-api-node.d.ts - web-ifc api 的打字稿定义（对于节点）
6. web-ifc-api.js - 编译 javascript 包装器，供 wasm 在浏览器中运行。
7. web-ifc-api.d.ts - 主要 web-ifc API 的打字稿定义
8. ifc-schema.d.ts - IFC 架构的打字稿定义
9. helpers/properties.d.ts - web-ifc API 属性方面的打字稿定义
10. helpers/log.d.ts - web-ifc API 记录器方面的打字稿定义
11. web-ifc-mt.worker.js - Webworker javascript，用于在浏览器中启用多线程。

独立C++

尽管该库的主要重点是通过浏览器/nodejs 中的 WebAssembly 使用，但该项目可以作为 C++ 库或可执行文件独立使用。请参阅此处了解入门的简单切入点。