engine_web ifc

目次 | web-ifc ドキュメント |プラットフォームのドキュメント |デモ |コミュニティ | npmパッケージ

ウェブ IFC

web-ifcは、ネイティブ速度で ifc ファイルを読み書きするための JavaScript ライブラリです。 web-ifc は、オープン BIM アプリケーション開発の敷居を下げることを目的とした That Open Company プロジェクトの一部です。

インストール

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-three を使用している場合は、node_modules/web-ifc-three/node_modules/web-ifc になります。 JavaScript と WASM を置き換える必要があることに注意してください。

要件

これらは、web-ifc を構築するために必要な要件です (独自のバージョンを構築したい場合のみ)。

1. ノードv16以降
2. NPM v7 以降
3. EMSCRIPTEN v3.1.44 以降
4. CMAKE v3.18 以降

回帰テスト

testing/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 - ノードで実行する wasm (コンパイルされた C++)
4. web-ifc-api-node.js - ノードで実行する wasm 用のコンパイルされた JavaScript ラッパー。
5. web-ifc-api-node.d.ts - web-ifc API の Typescript 定義 (ノード用)
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 - ブラウザーでマルチスレッドを有効にする Webworker JavaScript。

スタンドアロン C++

このライブラリの主な焦点は、ブラウザ/nodejs で WebAssembly を通じて使用することですが、プロジェクトは C++ ライブラリまたは実行可能ファイルとしてスタンドアロンで使用できます。開始するための簡単なエントリ ポイントについては、ここを参照してください。