engine_web ifc

оглавление | веб-документация IFC | документация по платформе | демо | сообщество | пакет НПМ

Веб МФК

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-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 или новее

Регрессионное тестирование

У нас есть библиотека тестовых моделей в папкеtests/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.

библиотека ВАСМ

Запустите npm install чтобы установить все зависимости.

Запускайте npm run setup-env всякий раз, когда вы открываете новый терминал, это установит необходимые переменные среды emscripten для компиляции кода.

Запустите npm run build-release чтобы собрать финальную версию двоичного файла wasm и сопутствующего API web-ifc. Он будет помещен в ./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 — скомпилированная оболочка javascript для запуска Wasm в узле.
5. web-ifc-api-node.d.ts — определения Typescript для API web-ifc (для узла)
6. web-ifc-api.js — скомпилированная оболочка JavaScript для запуска Wasm в браузере.
7. web-ifc-api.d.ts — определения машинописного текста для основного API веб-ifc.
8. ifc-schema.d.ts — определения машинописного текста для схемы IFC.
9. helpers/properties.d.ts — определения Typescript для аспекта свойств API web-ifc.
10. helpers/log.d.ts — определения машинописных сценариев для аспекта журнала API web-ifc.
11. web-ifc-mt.worker.js — JavaScript Webworker для включения многопоточности в браузере.

Автономный C++

Хотя основное назначение библиотеки — использование через WebAssembly в браузере/nodejs, проект можно использовать автономно как библиотеку C++ или исполняемый файл. Здесь вы найдете простую точку входа, чтобы начать работу.