engine_web ifc

Daftar Isi | dokumentasi web-ifc | dokumentasi platform | demo | komunitas | paket npm

web IFC

web-ifc adalah perpustakaan javascript untuk membaca dan menulis file ifc, dengan kecepatan asli. web-ifc adalah bagian dari proyek That Open Company, yang bertujuan untuk menurunkan ambang batas pengembangan aplikasi BIM terbuka.

Memasang

npm install web-ifc

Pengaturan cepat

 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 ) ;

Lihat contoh untuk detail lebih lanjut tentang cara menggunakan web-ifc.

Pembuatan Saat Ini

Versi web-ifc langsung saat ini tersedia di sini. Menggunakan ini memungkinkan Anda menguji perbaikan terbaru sebelum kami membuat rilis. Jika Anda ingin menggunakan versi ini, unduh file zip dan tempatkan isi folder dist secara manual ke dalam folder node_modules/web-ifc Anda. Yaitu jika Anda menggunakan web-ifc-three maka itu akan menjadi node_modules/web-ifc-three/node_modules/web-ifc. Harap dicatat Anda harus mengganti javascript dan WASM.

Persyaratan

Ini adalah persyaratan yang diperlukan untuk membangun web-ifc (hanya bagi mereka yang ingin membuat versinya sendiri).

1. Node v16 atau lebih baru
2. NPM v7 atau lebih baru
3. EMSCRIPTEN v3.1.44 atau lebih baru
4. CMAKE v3.18 atau lebih baru

Pengujian Regresi

Kami memiliki perpustakaan model pengujian di folder tes/publik. Jika Anda memiliki model yang ingin Anda sumbangkan, silakan buka PR.

Anda dapat menjalankan uji regresi pada semua model ini dengan menjalankan npm run regression . Ini akan mengingatkan Anda jika ada geometri model sampel yang berubah. Jika perubahannya benar, Anda dapat menyegarkan pengujian regresi dengan menjalankan npm run regression-update .

Membangun modul WASM

Menyiapkan emscripten dan membangun sistem

Library WASM dibangun melalui emscripten, silakan lihat panduan instalasi emscripten untuk informasi cara mengatur emscripten. Setelah itu emsdk_env harus berada di jalur Anda.

Untuk membangun WASM Anda juga memerlukan CMAKE lihat di sini dan (di windows) MINGW lihat di sini - setelah diinstal (dan sesuai jalur Anda) jalankan npm run setup-mingw untuk mengonfigurasi lingkungan untuk web-ifc.

perpustakaan WASM

Jalankan npm install untuk menginstal semua dependensi.

Jalankan npm run setup-env setiap kali Anda membuka terminal baru, ini akan menyiapkan variabel lingkungan emscripten yang diperlukan agar Anda dapat mengkompilasi kode.

Jalankan npm run build-release untuk membuat versi rilis biner wasm dan api web-ifc yang menyertainya. Itu akan ditempatkan di ./dist .

Jika Anda ingin membangun WASM dengan debugging diaktifkan, Anda dapat menjalankan npm run build-debug . Ini akan memungkinkan Anda memeriksa informasi debug dengan lebih baik saat menjalankan web-ifc.

Jalankan npm run dev untuk meluncurkan server pengembangan dengan penampil file ifc dasar.

Bangun File

Output dari proses build terdiri dari file-file berikut:

1. web-ifc.wasm - Wasm (dikompilasi C++) untuk dijalankan di browser
2. web-ifc-mt.wasm - Wasm (dikompilasi C++) untuk dijalankan di browser jika multi-threading didukung.
3. web-ifc-node.wasm - Wasm (dikompilasi C++) untuk dijalankan di node
4. web-ifc-api-node.js - Kompilasi javascript wrapper agar wasm dapat dijalankan di node.
5. web-ifc-api-node.d.ts - Definisi skrip untuk api web-ifc (untuk node)
6. web-ifc-api.js - Kompilasi javascript wrapper agar wasm dapat dijalankan di browser.
7. web-ifc-api.d.ts - Definisi skrip untuk API web-ifc utama
8. ifc-schema.d.ts - Definisi skrip untuk skema IFC
9. helpers/properties.d.ts - Definisi skrip untuk aspek properti API web-ifc
10. helpers/log.d.ts - Definisi skrip untuk aspek logger API web-ifc
11. web-ifc-mt.worker.js - Javascript webworker untuk mengaktifkan multi-threading di browser.

Berdiri sendiri C++

Meskipun fokus utama perpustakaan adalah untuk digunakan melalui WebAssembly di browser/nodejs, proyek ini dapat digunakan secara mandiri sebagai perpustakaan c++ atau dapat dieksekusi. Lihat di sini untuk titik masuk sederhana untuk memulai.