vrmlxpy 1.0.0a1

Toolkit for VRML parsing and traversing. Includes a standalone VRML parser library and a conversion library for transforming VRML geometry into geometry format such as STL, with modular C++ backends and Python bindings.

vrmlxpy

Toolkit for VRML parsing and traversing. Includes a standalone VRML parser library and a conversion library for transforming VRML geometry into STL format, with modular C++ backends and Python bindings.

License

This project is licensed under the GNU General Public License v3.0 or later (GPL-3.0-or-later).
See the LICENSE file for details.

Prerequisites

• You need to have the Boost installed on your system. Please follow instructions here.
• Other third part library used is called CGAL. Follow instructions here.
• For Python bindings creation, the solution uses pybind11. See the steps here.
• The project uses Ninja build system. Please follow the installation instructions of this software based on your system vendor.
• It comes naturally that you should have CMake installed on your system as well.
• C++ compiler.

Build

Linux

• You can choose to build the library based on two types of build configurations: Debug

    cmake --preset Debug
  

• or Release.

    cmake --preset Release
  

• After necessary files are generated, you are able to build.

• Note that out/build/Debug in the following command is folder for Debug built, for Release, use out/build/Release.

   cmake --build out/build/Debug
  

Windows

• It is recommended to develop in Visual Studio.
• To open the project, navigate yourself to File - Open - Cmake... and choose the root CMakeLists.txt.
• Visual Studio should handle the process of generating and building the library automatically.

Run C++ executable files

Linux

• If your system has Valgrind installed, you can run the following commands like this:

    valgrind --leak-check=full --show-reachable=yes --track-origins=yes <YOUR PROGRAM>
  

• You can use CTest which is a program that comes with CMake; it handles running the tests for the project.

• Before running the command below, make sure that tests have access to configuration file testConfig.json which should be inside vrmlxpy\out\build\Release\to_geom folder (or vrmlxpy\out\build\Debug\to_geom) as one of the tests uses it. The paths in the configuration file should point to directories with test data.

• Run the following command (once again, note that you might need to exchange Debug with Release if you have built for this type):

   ctest --test-dir out/build/Debug/vrml_proc
  

• You might want to use --verbose for the command above.

Windows

• TODO

Run Python

• To get the idea how to use the library, have a look at example script.

Troubleshooting