IfcPlusPlus

From FreeCAD Documentation
Revision as of 13:29, 6 September 2020 by David69 (talk | contribs) (Created page with "=== Installation des bibliothèques compilées ===")
Other languages:

Description

IFC++ ou IfcPlusPlus est une bibliothèque C++ open source (licence MIT) du projet IfcQuery pour la lecture, l'écriture et la visualisation de fichiers IFC .

La bibliothèque IFC++ peut être utilisée à des fins générales et comprend également un exemple d'application de visualisation IFC. Cette visionneuse est basée sur Qt 5 et OpenSceneGraph (OSG) et peut charger de gros fichiers IFC très rapidement. Elle peut donc être utilisée pour comparer les performances d'autres visionneuses IFC, comme Blender et FreeCAD, qui utilisent en interne la bibliothèque IfcOpenShell.

L'exemple de visionneuse IFC inclus dans la distribution source des bibliothèques IfcQuery/IFC ++.

Remarque: dans l'usage courant, les noms "IfcQuery", "IFC++" et "IfcPlusPlus" peuvent être utilisés de manière interchangeable pour désigner la même chose, la bibliothèque C++, ou plus spécifiquement le visualiseur IFC gratuit.

Installation

La distribution IFC++ est fournie sous forme de code source, donc pour utiliser la bibliothèque et le visualiseur, le code doit être compilé.

IFC ++ est développé principalement sur une plate-forme Windows aussi il inclut des fichiers solution (.snl) et projet (.vcxproj) pour compiler la bibliothèque dynamique IfcPlusPlus.dll à l'aide de Visual Studio. Une bibliothèque statique libIfcPlusPlus.a peut également être produite pour Linux en utilisant CMake.

Remarque: il existe un visualiseur plus complet qui utilise des bibliothèques IFC++ précompilées destinées à Windows. Cette visionneuse est gratuite mais n'est pas open source. Il est disponible en téléchargeant le package SimpleViewerExampleQt.zip depuis http://www.ifcquery.com/ et en exécutant SimpleViewerExampleQt.exe. Ce visualiseur est autonome, tout ce dont il a besoin pour s'exécuter est inclus dans l'archive .zip.

Compilation sous Windows

Suivez les instructions du dépôt officiel ifcplusplus.

Compilation sous Linux

Les instructions générales sont les suivantes:

  1. Récupérez le code source d'IFC ++ depuis son dépôt principal.
  2. Rassemblez toutes les dépendances pour la compilation, y compris un compilateur C++, CMake et Make, et les fichiers de développement pour Boost, Qt 5, ainsi que la bibliothèque OpenSceneGraph (OSG) pour la visualisation.
  3. Exécutez cmake pour générer un Makefile, puis démarrez la compilation en exécutant make.
  4. Installez les bibliothèques libIfcPlusPlus.a et libcarve.so dans le chemin de bibliothèque approprié afin qu'elles soient trouvées par le visualiseur d'exemples IFC++.

Prérequis

Dans une distribution basée sur Debian/Ubuntu, obtenir les fichiers de développement requis est généralement simple.

sudo apt install git cmake gcc g++ libboost-all-dev
sudo apt install qt5-qmake qtbase5-dev qttools5-dev libqt5widgets5 libqt5opengl5-dev

Obtenez le code source du projet et placez-le dans un répertoire personnalisé auquel vous avez un accès en écriture complet.

git clone https://github.com/ifcquery/ifcplusplus ifcplusplus-source

OpenSceneGraph

OpenSceneGraph (OSG) est une collection de bibliothèques C++ qui utilise OpenGL pour la visualisation 3D. Elle il peut être utilisée dans les jeux, la réalité virtuelle, la visualisation scientifique et la modélisation.

sudo apt install libopenscenegraph-3.4-dev

Si les fichiers sont trop anciens dans votre distribution, vous pouvez également compiler les bibliothèques vous-même. La procédure est décrite dans le dépôt principal, openscenegraph/OpenSceneGraph. La compilation est simple, bien que vous puissiez avoir besoin de diverses dépendances telles que Qt 5, Freetype, Inventor, OpenEXR, COLLADA, ZLIB, GDAL, FFmpeg, Gstreamer, SDL, Cairo et Poppler.

git clone https://github.com/openscenegraph/OpenSceneGraph OpenSceneGraph-source

mkdir -p OpenSceneGraph-build
cd OpenSceneGraph-build
cmake ../OpenSceneGraph-source

make -j 3
sudo make install

Carve

Carve est une bibliothèque C++ Géométrie Solide Constructive (CSG) conçue pour effectuer des opérations booléennes entre deux maillages polygonaux arbitraires. Avec la bibliothèque IFC++, libIfcPlusPlus.a, Carve est utilisé par le visualiseur d'exemples IFC++ pour ouvrir et afficher les fichiers IFC.

  • Dépôt d'origine: carve, GPL2, de 2009 à 2011.
  • Nouveau dépôt: folded / carve, à partir de 2011; le projet est passé à la licence MIT à partir d'octobre 2015.

Le projet étant désormais sous licence MIT, des copies des fichiers source Carve sont désormais incluses dans le référentiel IFC++. Cela signifie que lors de la compilation IFC++, libcarve.so sera également compilé. Cette bibliothèque doit être disponible dans le système pour que la visionneuse d'exemples IFC++ fonctionne correctement.

Configuration de CMake

Il est recommandé d'effectuer la configuration et la compilation dans un répertoire build spécifique séparé du répertoire source.

mkdir -p ifcplusplus-build
cd ifcplusplus-build

cmake ../ifcplusplus-source/

Par défaut, le type de compilation est Release mais il peut également être défini sur Debug.

cmake -DCMAKE_BUILD_TYPE=Debug ../ifcplusplus-source/

Compilation réelle

S'il n'y avait pas de message d'erreur lors de la configuration avec CMake, un Makefile aurait dû être créé dans le répertoire build, vous pouvez donc procéder à la compilation des bibliothèques en exécutant make.

make -j N

N est le nombre de processeurs que vous attribuez au processus de compilation; choisissez au moins un de moins que le nombre total de cœurs de processeur dont vous disposez.

Test de la compilation dans le répertoire build

Si la compilation réussit, vous devriez avoir un sous-répertoire Release/ avec les bibliothèques nouvellement compilées.

Release/libcarve.so
Release/libIfcPlusPlus.a
Release/SimpleViewerExample

Vous pouvez lancer l'exécutable SimpleViewerExample avec un fichier IFC comme entrée.

Release/SimpleViewerExample IfcOpenHouse.ifc

Si le type de build a été défini sur Debug, alors les bibliothèques compilées apparaîtront dans le sous-répertoire Debug/ à la place.

Installation des bibliothèques compilées

If the compilation doesn't report any errors, you may run make install to copy the headers, compiled libraries, and binaries to their corresponding installation directories.

sudo make install

By default, the CMAKE_INSTALL_PREFIX is /usr/local/, so all compiled files will be placed under this directory, which normally requires elevated privileges.

/usr/local/bin/SimpleViewerExample
/usr/local/lib/libcarve.so
/usr/local/lib/libIfcPlusPlus.a
/usr/local/include/carve/*.{h, hpp}
/usr/local/include/ifcpp/geometry/*.h
/usr/local/include/ifcpp/geometry/Carve/*.h
/usr/local/include/ifcpp/geometry/OCC/*.h
/usr/local/include/ifcpp/IFC4/*.h
/usr/local/include/ifcpp/IFC4/include/*.h
/usr/local/include/ifcpp/model/*.h
/usr/local/include/ifcpp/reader/*.h
/usr/local/include/ifcpp/writer/*.h
/usr/local/share/IFCPP/cmake/*.cmake

Library path

Once SimpleViewerExample is placed in /usr/local/bin, the executable will be available in the entire system. However, in certain platforms libcarve.so may not be found if it is installed in the default /usr/local/lib directory.

SimpleViewerExample: error while loading shared libraries: libcarve.so: cannot open shared object file: No such file or directory

If this is the case, it may be enough to update the cache of the ld.so library loader by calling ldconfig:

sudo ldconfig

Or you may have to move the library to the correct directory first:

sudo mkdir -p /usr/local/lib/x86_64-linux-gnu/
sudo mv /usr/local/lib/libcarve.so /usr/local/lib/x86_64-linux-gnu/libcarve.so
sudo ldconfig

Alternatively, you may set the LD_LIBRARY_PATH variable to the directory containing libcarve.so, before launching the executable:

LD_LIBRARY_PATH=/usr/local/lib SimpleViewerExample

To make this effect persistent, this environmental variable can be set in the shell resource file, for example, .bashrc, so that it is propagated to all terminal instances on startup:

export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH

Removing the compiled libraries

To remove the installed libraries, just remove the corresponding files that were installed.

sudo rm -rf /usr/local/bin/SimpleViewerExample
sudo rm -rf /usr/local/lib/libcarve.so
sudo rm -rf /usr/local/lib/libIfcPlusPlus.a
sudo rm -rf /usr/local/include/carve
sudo rm -rf /usr/local/include/ifcpp
sudo rm -rf /usr/local/share/IFCPP/cmake/

Fixes for Linux

The IFC++ library is developed by its author on a Windows system. This means that even if the code depends on multiplatform libraries like Boost, Qt, and OpenSceneGraph, the code is mostly tested to compile and run on Windows. Nevertheless, over the years other developers have provided fixes to the project so that IFC++ can be compiled and run on Linux distributions.

In particular, a fork of the main project is maintained with small fixes to compile and run better in Debian.

If the code of the official repository does not work or seems to have issues in Linux, try following the same compilation instructions but using the sources from this alternative repository. This repository is often some commits behind the main distribution, but it aims to remain up to date, and at the same time provide some Linux specific fixes. These improvements are normally submitted back to the main repository in order to make the official branch compile on Linux without issues.

The main developer of IFC++ does not support Linux directly, so Linux developers should be prepared to troubleshoot problems, fix them, and submit patches when using IFC++ in Linux.

Invisible icons

For the SimpleViewerExample, there are two buttons in the main interface which are invisible if the custom style sheet is not found.

QIODevice::read (QFile, ":styles.css"): device not open

The style must be included in the CMake configuration in the section devoted to the Qt libraries:

# ifcplusplus-source/examples/SimpleViewerExampleQt/CMakeLists.txt
...
ADD_DEFINITIONS(${Qt5Widgets_DEFINITIONS})

SET(viewer_dir ${IFCPP_SOURCE_DIR}/examples/SimpleViewerExampleQt)
SET(RESOURCES ${viewer_dir}/Resources/ifcplusplus.qrc)
QT5_ADD_RESOURCES(SimpleViewerExample_RESOURCES_RCC ${RESOURCES})

More information