engine_web-ifc

<p align="center"> <a href="https://thatopen.com/">TOC</a> | <a href="https://thatopen.github.io/engine_web-ifc/docs">web-ifc 文档</a> | <a href="https://docs.thatopen.com/intro">平台文档</a> | <a href="https://thatopen.github.io/engine_web-ifc/demo">演示</a> | <a href="https://people.thatopen.com/">社区</a> | <a href="https://www.npmjs.com/package/web-ifc">npm 包</a> </p>

<h1>Web IFC <img src="https://thatopen.github.io/engine_components/resources/favicon.ico" width="32"/></h1>

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

状态

尽管 web-ifc 已经相当稳定和快速，但在 ifc 支持成熟之前，它仍处于预 alpha 状态。目前支持的 ifc 元素列表或对不同 ifc 类型的支持级别是未记录的进行中工作。

根据您的模型，web-ifc 可能快速且正确，或者缓慢且存在问题。如果您的模型无法按预期工作，请提出问题并附上模型（如果可能），或联系我们，我们可以讨论如何保密地传递模型。

安装

npm install web-ifc

快速设置

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

// 初始化 API
const ifcApi = new WebIFC.IfcAPI();

// 初始化库
await ifcApi.Init();

// 从数据打开模型
let modelID = ifcApi.OpenModel(/* IFC 数据作为字符串或 UInt8Array */, /* 可选设置对象 */, );

// 模型现已加载！使用 modelID 获取几何图形或属性
// 查看 examples/usage 以了解如何读取/写入 IFC 的一些详细信息

// 关闭模型，释放所有内存
ifcApi.CloseModel(modelID);

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

当前构建版本

web-ifc 的当前在线构建版本可在 此处 获取。使用此版本可让您在我们发布正式版本之前测试最新的修复。如果您希望使用此版本，请下载 zip 文件并手动将 dist 文件夹的内容放入您的 node_modules/web-ifc 文件夹中。例如，如果您使用的是 web-ifc-three，则应放在 node_modules/web-ifc-three/node_modules/web-ifc 中。请注意，您必须同时替换 JavaScript 和 WASM 文件。

要求

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

1. Node v16 或更高版本
2. NPM v7 或更高版本
3. EMSCRIPTEN v3.1.44 或更高版本
4. CMAKE v3.18 或更高版本

回归测试

我们在 tests/public 文件夹中有一个测试模型库。如果您有想要贡献的模型，请提交 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 文件查看器的开发服务器。

构建文件

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

1. web-ifc.wasm - 在浏览器中运行的 wasm（编译后的 C++）
2. web-ifc-mt.wasm - 如果支持多线程，在浏览器中运行的 wasm（编译后的 C++）
3. web-ifc-node.wasm - 在 node 中运行的 wasm（编译后的 C++）
4. web-ifc-api-node.js - 在 node 中运行的 wasm 的编译 JavaScript 包装器
5. web-ifc-api-node.d.ts - web-ifc api 的 TypeScript 定义（适用于 node）
6. web-ifc-api.js - 在浏览器中运行的 wasm 的编译 JavaScript 包装器
7. web-ifc-api.d.ts - 主要 web-ifc API 的 TypeScript 定义
8. ifc-schema.d.ts - IFC 架构的 TypeScript 定义
9. helpers/properties.d.ts - web-ifc API 属性方面的 TypeScript 定义
10. helpers/log.d.ts - web-ifc API 日志记录方面的 TypeScript 定义
11. web-ifc-mt.worker.js - 启用浏览器中多线程的 Web Worker JavaScript

独立 C++

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