TOC | documentación web-ifc | documentación de la plataforma | demostración | comunidad | paquete npm
web-ifc es una biblioteca javascript para leer y escribir archivos ifc, a velocidades nativas. web-ifc forma parte del proyecto That Open Company, cuyo objetivo es reducir el umbral para el desarrollo de aplicaciones BIM abiertas.
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 ) ;
Consulte los ejemplos para obtener más detalles sobre cómo utilizar web-ifc.
La versión actual en vivo de web-ifc está disponible aquí. Usar esto le permite probar las correcciones más recientes antes de realizar un lanzamiento. Si desea utilizar esta versión, descargue el archivo zip y coloque el contenido de la carpeta dist manualmente en su carpeta node_modules/web-ifc. Es decir, si está utilizando web-ifc-tres, entonces será node_modules/web-ifc-tres/node_modules/web-ifc. Tenga en cuenta que debe reemplazar javascript y WASM.
Estos son los requisitos necesarios para construir web-ifc (solo para aquellos que deseen construir su propia versión).
Tenemos una biblioteca de modelos de prueba en la carpeta tests/public. Si tiene un modelo con el que le gustaría contribuir, abra un PR.
Puede ejecutar pruebas de regresión en todos estos modelos ejecutando npm run regression
. Le avisará si alguna parte de la geometría del modelo de muestra ha cambiado. Si el cambio es correcto, puede actualizar las pruebas de regresión ejecutando npm run regression-update
.
La biblioteca WASM se crea a través de emscripten; consulte la guía de instalación de emscripten para obtener información sobre cómo configurar emscripten. Luego, emsdk_env
debe estar en su camino.
Para compilar WASM, también necesita CMAKE (ver aquí) y (en Windows) MINGW (ver aquí). Una vez instalado (y en su ruta), ejecute npm run setup-mingw
para configurar el entorno para web-ifc.
Ejecute npm install
para instalar todas las dependencias.
Ejecute npm run setup-env
cada vez que abra una nueva terminal, esto configurará las variables de entorno emscripten necesarias para que pueda compilar el código.
Ejecute npm run build-release
para crear una versión de lanzamiento del binario wasm y la API web-ifc que lo acompaña. Se colocará en ./dist
.
Si desea compilar WASM con la depuración habilitada, puede ejecutar npm run build-debug
. Esto le permitirá inspeccionar mejor la información de depuración cuando ejecute web-ifc.
Ejecute npm run dev
para iniciar un servidor de desarrollo con un visor de archivos ifc básico.
El resultado del proceso de compilación consta de los siguientes archivos:
Aunque el objetivo principal de la biblioteca es usarse a través de WebAssembly en el navegador/nodejs, el proyecto se puede usar de forma independiente como una biblioteca de C++ o como ejecutable. Consulte aquí un punto de entrada sencillo para comenzar.