Inhaltsverzeichnis | Web-IFC-Dokumentation | Plattformdokumentation | Demo | Gemeinschaft | npm-Paket
web-ifc ist eine Javascript-Bibliothek zum Lesen und Schreiben von IFC-Dateien mit nativer Geschwindigkeit. web-ifc ist Teil des That Open Company-Projekts, dessen Ziel es ist, die Schwelle für die Entwicklung offener BIM-Anwendungen zu senken.
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 ) ;
Weitere Informationen zur Verwendung von web-ifc finden Sie in den Beispielen.
Der aktuelle Live-Build von web-ifc ist hier verfügbar. Auf diese Weise können Sie die neuesten Fixes testen, bevor wir eine Veröffentlichung veröffentlichen. Wenn Sie diese Version verwenden möchten, laden Sie die ZIP-Datei herunter und platzieren Sie den Inhalt des dist-Ordners manuell in Ihrem node_modules/web-ifc-Ordner. Das heißt, wenn Sie web-ifc-drei verwenden, lautet es „node_modules/web-ifc-drei/node_modules/web-ifc“. Bitte beachten Sie, dass Sie das Javascript und das WASM ersetzen müssen.
Dies sind die Voraussetzungen, die zum Erstellen von Web-IFC erforderlich sind (nur für diejenigen, die ihre eigene Version erstellen möchten).
Wir haben eine Bibliothek mit Testmodellen im Ordner „tests/public“. Wenn Sie ein Modell haben, zu dem Sie beitragen möchten, eröffnen Sie bitte eine PR.
Sie können Regressionstests für alle diese Modelle ausführen, indem Sie npm run regression
ausführen. Sie erhalten eine Warnung, wenn sich die Geometrie des Beispielmodells geändert hat. Wenn die Änderung korrekt ist, können Sie die Regressionstests aktualisieren, indem Sie npm run regression-update
ausführen.
Die WASM-Bibliothek wird über emscripten erstellt. Informationen zum Einrichten von emscripten finden Sie im Installationshandbuch für emscripten. Anschließend muss sich emsdk_env
in Ihrem Pfad befinden.
Zum Erstellen des WASM benötigen Sie außerdem CMAKE (siehe hier) und (unter Windows) MINGW (siehe hier) – sobald es installiert ist (und in Ihrem Pfad), führen Sie npm run setup-mingw
um die Umgebung für Web-IFC zu konfigurieren.
Führen Sie npm install
aus, um alle Abhängigkeiten zu installieren.
Führen Sie npm run setup-env
aus, wenn Sie ein neues Terminal öffnen. Dadurch werden die erforderlichen Emscripten-Umgebungsvariablen eingerichtet, damit Sie Code kompilieren können.
Führen Sie npm run build-release
aus, um eine Release-Version der Wasm-Binärdatei und der zugehörigen Web-IFC-API zu erstellen. Es wird in ./dist
platziert.
Wenn Sie das WASM mit aktiviertem Debugging erstellen möchten, können Sie npm run build-debug
ausführen. Dadurch können Sie Debugging-Informationen beim Ausführen von web-ifc besser prüfen.
Führen Sie npm run dev
aus, um einen Entwicklungsserver mit einem einfachen IFC-Datei-Viewer zu starten.
Die Ausgabe des Build-Prozesses besteht aus den folgenden Dateien:
Obwohl der Hauptfokus der Bibliothek auf der Verwendung über WebAssembly im Browser/nodejs liegt, kann das Projekt eigenständig als C++-Bibliothek oder ausführbare Datei verwendet werden. Hier finden Sie einen einfachen Einstiegspunkt für den Einstieg.