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++ 程式庫或執行檔獨立使用。請參閱此處以了解入門的簡單切入點。