diff --git a/assets/js/search-data.json b/assets/js/search-data.json
index 75e7797954..ac7ad2a3e4 100644
--- a/assets/js/search-data.json
+++ b/assets/js/search-data.json
@@ -29,7 +29,7 @@
   },"4": {
     "doc": "Changelog",
     "title": "Changelog",
-    "content": "# Changelog ## Ongoing development For F3D users: - Added `--animation-autoplay` option (libf3d: `scene.animation.autoplay`) to automatically start animation on file load. - Added an experimental VDB reader for .vdb files using OpenVDB - Changed `--verbose` into a string based option, eg: `--verbose=quiet` or `--verbose=debug`. `--verbose` is still supported. - Changed `--no-render` behavior so that it doesn't impact verbosity anymore - Deprecated `--quiet`, use `--verbose=quiet` instead. - Reading EXR files is now multi-threaded and much faster. - Translucency support is now enabled by default. - A small margin is added between the model and the grid to avoid potential z-fighting. - Add X files support (part of `assimp` plugin) - Fix potential crashes when reading `assimp` plugin file format For libf3d users: - Added `scene.animation.autoplay` option. - Added a `f3d::image::saveBuffer` API to save an image as a file format in memory. For F3D packagers: - Added a new optional dependency through VTK, OpenVDB ## v2.2.1 For F3D users: - Added a native Apple Silicon release package - Added new options `hdri-file`, `hdri-ambient`, `hdri-skybox` to have more control on the HDRI behavior - Added a default HDRI used when providing no `hdri-file` - Added bindings to toggle HDRI ambient lighting (`F`) and HDRI skybox (`J`) - Added bindings to move the camera to standard locations: `1`: Front, `3`: Right, `7`: Top, `9`: Isometric - Added [Open CASCADE BRep format](https://dev.opencascade.org/doc/overview/html/specification__brep_format.html) to the OCCT plugin. - Fixed an infamous issue when the Windows thumbnailer always steal the focus - Fixed an issue with the binary release when opening draco files - Fixed an issue with matcap textures - Fixed an issue with HDRI lighting - Fixed an issue with HDRI lighting when dropping HDRI after a model - Fixed an issue where invalid option would not show on Windows - Fixed an issue where previously loaded file would stay visible - Fixed an issue when loading invalid EXR file as HDRI - Fixed cheatsheet menu rendering under 'Drop File Instructor' - Fixed raytracing rendering issues - Improved cheatsheet menu contrast for any background color - Improved overall text contrast for any background color - Improved performance when changing model and using a HDRI - Improved HDRI cache performance - Deprecated `hdri` option For libf3d users: - Reworked image API to support many file formats to read (EXR, HDR) and write (PNG, JPG, TIF, BMP) - Added `render.hdri.file`, `render.hdri.ambient`, `render.background.skybox` options. - Deprecated `render.background.hdri` in favor of new options above - Deprecated previous image API - Add `loader::loadGeometry` allowing loading geometry from memory buffers For developers: - Added a deprecation framework - Removed `F3D_TESTING_ENABLE_HDRI_TESTS` cmake option and merged it with `F3D_TESTING_ENABLE_LONG_TIMEOUT_TESTS` - Added a Getting Started guide for beginners developers For F3D packagers: - Fixed compatibility with FreeBSD ## v2.1.0 For F3D users: - Reworked Animation support and added many animation related options - Added `--camera-direction` and `--camera-zoom-factor` and use it in default config file - Added `--texture-matcap` option to load a MatCap texture - Added support for opening HDRI background with Drop - Added .exr support for HDRI and textures - Improved HDRI caching performance - Added a EGL headless binary release - Added typo suggestion when failing to use the right option name - Added `--invert-zoom` option (libf3d: `interactor.invert-zoom`) to invert zoom direction with right-click on mouse - Added support for keeping camera position when reloading a file with `UP` key - Added a `--grid-absolute` option (libf3d: `render.grid.absolute`) to position the grid instead of being below the model - Added a \"Drop Zone\" when starting F3D without loading a file - Added coloring support for STEP files in binary release - Fixed an issue on Windows where the error window would popup even with `--quiet` - Fixed an issue with 16 bit and 32 bit textures with assimp plugin - Fixed an issue on Windows where errors where not visible - Fixed an HDRI issue on reload - Fixed a crash when with the progress bar on reloading a file - Fixed an issue where certain options from config file would be ignored - Fixed a crash with many GLTF files when an array does not have a name - Fixed an issue where dropping a duplicate file would change the loaded file instead of not doing anything - Fixed an issue when loading an unsupported file - Fixed an issue with VRML files - Improved config file for .ply files - Improved config file regex so that they are case-insensitive - Improved `--up` option to support no sign and better validation - Improved F3D version reporting about itself and VTK (`--version`) - Improved documentation, testing, help - Excluded TIFF format from Windows Thumbnailer - Changed the automatic camera position to a version more close to the data - Reduced size of binary release by a factor of two For developers: - Added vcpkg support for dependency installation For F3D packagers: - Added a `F3D_PLUGIN_OCCT_COLORING_SUPPORT` CMake variable to control if this feature is compiled, default is ON - Added `SONAME` support - Added a `F3D_PLUGINS_INSTALL_DIR` CMake variable to control where to install plugins - Added a new module: `F3D_MODULE_EXR` that depends on openexr - Added support to use external `cxxopts` and external `nlohmann-json` - Fixed a link issue with VTK modules - Fixed a `@loader_path` issue on MacOS - Added support for `CMAKE_INSTALL_*DIR` variables on installation - Added support for building against a EGL enabled VTK - Fixed a compilation issue with VTK master Contributors: @DeveloperPaul123 @topazus @bkmgit @snoyer @Meakk @mwestphal ## v2.0.0 For F3D users: - Removed `--fullscreen` options completely - Added a `--position` option to set the position of the F3D window - Added a `--light-intensity` option and associated bindings - Improved fish and zsh completion - Added a new interaction to center the camera on the point under the cursor using *middle* mouse button - Added HDRi caching for improved performance - Added scene bounding box to the dump interaction - Reworked lighting for fullscene format files - Improved grid rendering and customization greatly with new options - Improved HDRi blur performance and customization - Added support for reading config file directory instead of a single file - Changed config file location on Windows - PostFX option names have been changed - Added an interaction (down arrow) to load all files from the directory containing the current file - Added a `--group-geometries` option to load multiple default scene file into a single render window For libf3d users: - Reworked loader API from scratch - Fixed an issue with engine creation in the Python bindings - Fixed an issue with image Python bindings - Improved libf3d examples - Added experimental javascript bindings based on webassembly/emscriptem - Added dynamic support for all `model` options - Added plugin SDK to create your own plugins for any file format For F3D packagers: - Added plugins support for true optional dependencies - Added a `F3D_APPLICATION_LINK_FILESYSTEM` CMake option to control if F3D should link explicitly against libstdc++fs - Removed most of `F3D_INSTALL_` options with the switch to a component-based approach - Removed installation of useless static libs from VTKExtensions (needs VTK master) - Fixed RPATH of F3D for system using lib64 instead of lib - Many CMake option name changed - Fixed data license to use only permissive license for F3D testing data - Removed packaging support from F3D Contributors: @snoyer @mzf-guest @CharlesGueunet @myd7349 @allemangD @Meakk @mwestphal ## v1.3.1 - Fix raytracing support - Fix macOS window positioning Contributors: @mwestphal @Meakk ## v1.3.0 Main new features and fixes: - Introducing an alpha version of the libf3d, see below for more information - Added a --font-file option - Added support for Alembic file format (.abc). Geometry only. Thanks a lot @nyue. - Fixed many HDRI issues - Fixed an important drag and drop issue on linux Other fixes: - Fixed many doc and UI typos - Fixed shell completion - Fixed multiple issue with image comparison - Fixed an issue with --line-width and --point-size with full scene formats - Fixed an issue with translucent object and RGBA texture - Fixed issues with a few specific .gltf files - Fixed a window title issue on MacOS - Fixed multiple issues with the output window on Windows - Fixed issues with file association and thumbnails on Windows - Fixed a small issue with the cheatsheet not appearing in some cases - Fixed an issue with certain .obj files - Fixed a clipping issue when setting camera position - Removed fullscreen hotkey For F3D developers: - Updated cxxopts to 3.0.0 - Now using json.hpp for parsing json config file - Better reproducible build support - Improved CI with coverage, sanitizer, dedicated actions for dependencies - Complete rework of the architecture to separate F3D, the application, the libf3d (see below) and a VTKExtensions layer. - Improved unit testing by adding test in the libf3d and VTKExtensions layer For libf3d users: - Introducing an alpha version of the libf3d! - The libf3d is a C++ library to open and render 3D meshes, it is of course used by F3D and supports python bindings - More info available in README_libf3d.md Binary Release Information: - The binary release is **not** built with raytracing support - This binary release is built with assimp 5.1.2, animation for assimp formats is not working well Contributors: @schuhumi @herrriehm @rafcon-dev @mzf-guest @nyue @jpouderoux @Meakk @mwestphal ## v1.2.1 Bug fixes and features: - Fixed a build issue on MacOS - Fixed a critical issue with the Windows Thumbnailer that could crash explorer.exe - Fixed the --quiet option so that it actually quiets VTK errors and warnings - Fixed an issue with output window popping up at each log on Windows - Added a `.deb` package for Linux Debian-based distros For Packagers: - LFS file have been added in source code release, this seems to be retroactive, so hash of previous releases may have changed - Flatpack org name has been fixed Contributors: @Meakk @mwestphal @jpouderoux ## v1.2.0 Main New Features: - Added STEP and IGES file format support thanks to @Open-Cascade-SAS /[OCCT](https://github.com/Open-Cascade-SAS/OCCT) (thanks @drtrigon) - Added FBX, DAE, OFF, and DXF file format support thanks to @assimp /[assimp](https://github.com/assimp/assimp) - Added thumbnail support with many linux file managers - Added thumbnail support on Windows - Added desktop environment integration in linux - Added scalar and scalar component looping Other New Features: - Added support for KHR_materials_unlit with glTF files (thanks @spiraloid) - Added option for selecting camera `--camera-index` (thanks @spiraloid) - Added coloring the to Windows error output window - Added a man entry on Linux - Added a `--config` option to select a config file to load instead of using default location - Added a `--quiet` option - Added `--camera-azimuth` and `--camera-elevation` options (thanks @tatsuya-s) - Added a metainfo.xml file (thanks @kevinsmia1939) Issue Fixes: - Fixed an issue with opening files with accented char in the name on Windows (thanks @shankarsivarajan) - Fixed HDRI orientation with --up option (thanks @truhlikfredy) - Fixed an issue with point cloud rendering - Fixed a crash on exit on Windows - Fixed an issue with fullscreen window size on Windows - Fixed offscreen rendering (`--output` and `--ref` ) to actually use offscreen rendering - Fixed a memory leak when no rendering is performed (thanks @CharlesGueunet) - Fixed a rendering issue with certain GPU drivers - Fixed tone mapping with background opacity - Fixed non-working drag and drop implementation in VTK (thanks @msbit) - Fixed a potential sorting issue when opening a folder - Fixed a crash with unsupported glTF files in VTK For Developers: - Full rework of the CI framework, including coverage report support - Full rework of the testing framework - Separation of vtkF3DRenderer in two classes - Separation of f3d executable into a libf3d library and f3d executable to support windows thumbnails For Packagers: - New CMake options to select file to install, all documented and starting with F3D_ - mime types file can be installed, make sure to trigger update-mime-databse - desktop file can be installed, make sure to trigger update-desktop-database Packagers: AndnoVember @jokersus @kevinsmia1939 @yurivict @bcdarwin @mzf-guest @Meakk @mwestphal Binary Release Information: - The binary release is **not** built with raytracing support - This binary release is built with assimp 5.1.2, animation for assimp formats is not working well Contributors: @CharlesGueunet @kevinsmia1939 @mzf-guest @jpouderoux @Meakk @mwestphal ## v1.1.1 A patch release dedicated to package managers that makes F3D v1.1 compatible with vtk v9.1.0 - Fix a render pass build issue with vtk 9.1.0 - Fix a renderer build issue with vtk 9.1.0 Contributors: @Meakk @mwestphal ## v1.1.0 New Important Features: * **Added direct scalars color rendering mode**, see doc. * **Added a turntable interactor** and made it default. The previous interactor can still be used using a dedicated option. Thanks @orangebowlerhat @filip.sund and @jjomier for your suggestions. * **Added animation support** for glTF and Exodus files. Press space for playing the animation. * Added animation related option, --animation-index, only for glTF when using the full scene. New Readers and format compatibility features: * Added skinning and morphing support with glTF files. * Added TIFF format support. Thanks @proudot for your suggestion. * Added exodus format support. Thanks @gvernon for your suggestion. * Added support for OBJ with color directly inside of it instead of using a .mtl file. Thanks @Chenge321 for your suggestion. Quality of life features: * Added a hotkey (UP) to reload current file, thanks @caioaao. * Improved Alpha blending performance, thanks @paul.lafoix. * Changed the progress bar to a more nice looking one and made it appears only if loading takes time. Thanks @finetjul for the suggestion. * Improved logging mechanism with color on all OS and a dedicated output window on windows. * Added a warning when using RayTracing but it is not available. Fixes: * Fixed an issue with skybox and edges. * Fixed a crash when an array had no name. * Fixed a window naming issue on OSX. * Fixed a symlink issue. * Fixed a coloring issue with dataset containing only cell data. Packaging: * Upgraded the AUR f3d package to 1.1.0 : https://aur.archlinux.org/packages/f3d. * Added a Brew f3d 1.1.0 package : https://formulae.brew.sh/formula/f3d. * FreeBSD now contains a f3d 1.1.0 package, thanks to yuri@freebsd.org. * NixOS now contains a f3d package, 1.1.0 should come soon, thanks to bcdarwin@gmail.com. How to support F3D: * Use the software. * Share it with anyone interested. * Star us on github: https://github.com/kitware/F3D. Note: Binaries have no raytracing support. Contributors: @Meakk @mwestphal ## v1.0.1 - VisualStudio Runtime is now included into the windows release - Ensure VTK compatibility - Improve STL binary reader performances - Fix default configuration issues - Add support for Window icon on all OSes Note: Binaries have no raytracing support. Contributors: @Meakk @mwestphal ## v1.0.0 - Documentation - Online documentation based on Hexo (https://kitware.github.io/F3D/) - Rendering - Add volume rendering for 3D images - HDRI support (skyboxes, HDR files, Filmic tone mapping) - Point sprites for displaying point clouds - Color map customization (default one changed to “inferno”) - Interface - Drag&Drop files support - Supports opening of several files (or folder), use left/right arrow to navigate - Scalars field handling improvements - Cheat Sheet - Interactive hotkeys have been reworked - File association on Windows and OSX - Fullscreen mode - No background mode (useful when saving image to a PNG file with alpha channel) - Command line - Camera configuration - Metadata (field data) display - File name display - No render mode (useful to read information in the file) - Shell completion (supports bash, zsh, fish) - New readers - CityGML - PTS - Packages - Default config provide Note: Binaries have no raytracing support. Contributors: @Meakk @mwestphal @hlngrandmontagne Paul Lafoix ## v0.1.1 - Fixes `--version` and `--help` crash Contributors: @Meakk @mwestphal @jpouderoux ## v0.1.0 First release! Contributors: @Meakk @mwestphal @jpouderoux ",
+    "content": "# Changelog ## Ongoing development For F3D users: - Added `--animation-autoplay` option (libf3d: `scene.animation.autoplay`) to automatically start animation on file load. - Added an experimental VDB reader for .vdb files using OpenVDB - Changed `--verbose` into a string based option, eg: `--verbose=quiet` or `--verbose=debug`. `--verbose` is still supported. - Changed `--no-render` behavior so that it doesn't impact verbosity anymore - Deprecated `--quiet`, use `--verbose=quiet` instead. - Reading EXR files is now multi-threaded and much faster. - Translucency support is now enabled by default. - A small margin is added between the model and the grid to avoid potential z-fighting. - Add 3MF and X files support (part of `assimp` plugin) - Fix potential crashes when reading `assimp` plugin file format For libf3d users: - Added `scene.animation.autoplay` option. - Added a `f3d::image::saveBuffer` API to save an image as a file format in memory. For F3D packagers: - Added a new optional dependency through VTK, OpenVDB ## v2.2.1 For F3D users: - Added a native Apple Silicon release package - Added new options `hdri-file`, `hdri-ambient`, `hdri-skybox` to have more control on the HDRI behavior - Added a default HDRI used when providing no `hdri-file` - Added bindings to toggle HDRI ambient lighting (`F`) and HDRI skybox (`J`) - Added bindings to move the camera to standard locations: `1`: Front, `3`: Right, `7`: Top, `9`: Isometric - Added [Open CASCADE BRep format](https://dev.opencascade.org/doc/overview/html/specification__brep_format.html) to the OCCT plugin. - Fixed an infamous issue when the Windows thumbnailer always steal the focus - Fixed an issue with the binary release when opening draco files - Fixed an issue with matcap textures - Fixed an issue with HDRI lighting - Fixed an issue with HDRI lighting when dropping HDRI after a model - Fixed an issue where invalid option would not show on Windows - Fixed an issue where previously loaded file would stay visible - Fixed an issue when loading invalid EXR file as HDRI - Fixed cheatsheet menu rendering under 'Drop File Instructor' - Fixed raytracing rendering issues - Improved cheatsheet menu contrast for any background color - Improved overall text contrast for any background color - Improved performance when changing model and using a HDRI - Improved HDRI cache performance - Deprecated `hdri` option For libf3d users: - Reworked image API to support many file formats to read (EXR, HDR) and write (PNG, JPG, TIF, BMP) - Added `render.hdri.file`, `render.hdri.ambient`, `render.background.skybox` options. - Deprecated `render.background.hdri` in favor of new options above - Deprecated previous image API - Add `loader::loadGeometry` allowing loading geometry from memory buffers For developers: - Added a deprecation framework - Removed `F3D_TESTING_ENABLE_HDRI_TESTS` cmake option and merged it with `F3D_TESTING_ENABLE_LONG_TIMEOUT_TESTS` - Added a Getting Started guide for beginners developers For F3D packagers: - Fixed compatibility with FreeBSD ## v2.1.0 For F3D users: - Reworked Animation support and added many animation related options - Added `--camera-direction` and `--camera-zoom-factor` and use it in default config file - Added `--texture-matcap` option to load a MatCap texture - Added support for opening HDRI background with Drop - Added .exr support for HDRI and textures - Improved HDRI caching performance - Added a EGL headless binary release - Added typo suggestion when failing to use the right option name - Added `--invert-zoom` option (libf3d: `interactor.invert-zoom`) to invert zoom direction with right-click on mouse - Added support for keeping camera position when reloading a file with `UP` key - Added a `--grid-absolute` option (libf3d: `render.grid.absolute`) to position the grid instead of being below the model - Added a \"Drop Zone\" when starting F3D without loading a file - Added coloring support for STEP files in binary release - Fixed an issue on Windows where the error window would popup even with `--quiet` - Fixed an issue with 16 bit and 32 bit textures with assimp plugin - Fixed an issue on Windows where errors where not visible - Fixed an HDRI issue on reload - Fixed a crash when with the progress bar on reloading a file - Fixed an issue where certain options from config file would be ignored - Fixed a crash with many GLTF files when an array does not have a name - Fixed an issue where dropping a duplicate file would change the loaded file instead of not doing anything - Fixed an issue when loading an unsupported file - Fixed an issue with VRML files - Improved config file for .ply files - Improved config file regex so that they are case-insensitive - Improved `--up` option to support no sign and better validation - Improved F3D version reporting about itself and VTK (`--version`) - Improved documentation, testing, help - Excluded TIFF format from Windows Thumbnailer - Changed the automatic camera position to a version more close to the data - Reduced size of binary release by a factor of two For developers: - Added vcpkg support for dependency installation For F3D packagers: - Added a `F3D_PLUGIN_OCCT_COLORING_SUPPORT` CMake variable to control if this feature is compiled, default is ON - Added `SONAME` support - Added a `F3D_PLUGINS_INSTALL_DIR` CMake variable to control where to install plugins - Added a new module: `F3D_MODULE_EXR` that depends on openexr - Added support to use external `cxxopts` and external `nlohmann-json` - Fixed a link issue with VTK modules - Fixed a `@loader_path` issue on MacOS - Added support for `CMAKE_INSTALL_*DIR` variables on installation - Added support for building against a EGL enabled VTK - Fixed a compilation issue with VTK master Contributors: @DeveloperPaul123 @topazus @bkmgit @snoyer @Meakk @mwestphal ## v2.0.0 For F3D users: - Removed `--fullscreen` options completely - Added a `--position` option to set the position of the F3D window - Added a `--light-intensity` option and associated bindings - Improved fish and zsh completion - Added a new interaction to center the camera on the point under the cursor using *middle* mouse button - Added HDRi caching for improved performance - Added scene bounding box to the dump interaction - Reworked lighting for fullscene format files - Improved grid rendering and customization greatly with new options - Improved HDRi blur performance and customization - Added support for reading config file directory instead of a single file - Changed config file location on Windows - PostFX option names have been changed - Added an interaction (down arrow) to load all files from the directory containing the current file - Added a `--group-geometries` option to load multiple default scene file into a single render window For libf3d users: - Reworked loader API from scratch - Fixed an issue with engine creation in the Python bindings - Fixed an issue with image Python bindings - Improved libf3d examples - Added experimental javascript bindings based on webassembly/emscriptem - Added dynamic support for all `model` options - Added plugin SDK to create your own plugins for any file format For F3D packagers: - Added plugins support for true optional dependencies - Added a `F3D_APPLICATION_LINK_FILESYSTEM` CMake option to control if F3D should link explicitly against libstdc++fs - Removed most of `F3D_INSTALL_` options with the switch to a component-based approach - Removed installation of useless static libs from VTKExtensions (needs VTK master) - Fixed RPATH of F3D for system using lib64 instead of lib - Many CMake option name changed - Fixed data license to use only permissive license for F3D testing data - Removed packaging support from F3D Contributors: @snoyer @mzf-guest @CharlesGueunet @myd7349 @allemangD @Meakk @mwestphal ## v1.3.1 - Fix raytracing support - Fix macOS window positioning Contributors: @mwestphal @Meakk ## v1.3.0 Main new features and fixes: - Introducing an alpha version of the libf3d, see below for more information - Added a --font-file option - Added support for Alembic file format (.abc). Geometry only. Thanks a lot @nyue. - Fixed many HDRI issues - Fixed an important drag and drop issue on linux Other fixes: - Fixed many doc and UI typos - Fixed shell completion - Fixed multiple issue with image comparison - Fixed an issue with --line-width and --point-size with full scene formats - Fixed an issue with translucent object and RGBA texture - Fixed issues with a few specific .gltf files - Fixed a window title issue on MacOS - Fixed multiple issues with the output window on Windows - Fixed issues with file association and thumbnails on Windows - Fixed a small issue with the cheatsheet not appearing in some cases - Fixed an issue with certain .obj files - Fixed a clipping issue when setting camera position - Removed fullscreen hotkey For F3D developers: - Updated cxxopts to 3.0.0 - Now using json.hpp for parsing json config file - Better reproducible build support - Improved CI with coverage, sanitizer, dedicated actions for dependencies - Complete rework of the architecture to separate F3D, the application, the libf3d (see below) and a VTKExtensions layer. - Improved unit testing by adding test in the libf3d and VTKExtensions layer For libf3d users: - Introducing an alpha version of the libf3d! - The libf3d is a C++ library to open and render 3D meshes, it is of course used by F3D and supports python bindings - More info available in README_libf3d.md Binary Release Information: - The binary release is **not** built with raytracing support - This binary release is built with assimp 5.1.2, animation for assimp formats is not working well Contributors: @schuhumi @herrriehm @rafcon-dev @mzf-guest @nyue @jpouderoux @Meakk @mwestphal ## v1.2.1 Bug fixes and features: - Fixed a build issue on MacOS - Fixed a critical issue with the Windows Thumbnailer that could crash explorer.exe - Fixed the --quiet option so that it actually quiets VTK errors and warnings - Fixed an issue with output window popping up at each log on Windows - Added a `.deb` package for Linux Debian-based distros For Packagers: - LFS file have been added in source code release, this seems to be retroactive, so hash of previous releases may have changed - Flatpack org name has been fixed Contributors: @Meakk @mwestphal @jpouderoux ## v1.2.0 Main New Features: - Added STEP and IGES file format support thanks to @Open-Cascade-SAS /[OCCT](https://github.com/Open-Cascade-SAS/OCCT) (thanks @drtrigon) - Added FBX, DAE, OFF, and DXF file format support thanks to @assimp /[assimp](https://github.com/assimp/assimp) - Added thumbnail support with many linux file managers - Added thumbnail support on Windows - Added desktop environment integration in linux - Added scalar and scalar component looping Other New Features: - Added support for KHR_materials_unlit with glTF files (thanks @spiraloid) - Added option for selecting camera `--camera-index` (thanks @spiraloid) - Added coloring the to Windows error output window - Added a man entry on Linux - Added a `--config` option to select a config file to load instead of using default location - Added a `--quiet` option - Added `--camera-azimuth` and `--camera-elevation` options (thanks @tatsuya-s) - Added a metainfo.xml file (thanks @kevinsmia1939) Issue Fixes: - Fixed an issue with opening files with accented char in the name on Windows (thanks @shankarsivarajan) - Fixed HDRI orientation with --up option (thanks @truhlikfredy) - Fixed an issue with point cloud rendering - Fixed a crash on exit on Windows - Fixed an issue with fullscreen window size on Windows - Fixed offscreen rendering (`--output` and `--ref` ) to actually use offscreen rendering - Fixed a memory leak when no rendering is performed (thanks @CharlesGueunet) - Fixed a rendering issue with certain GPU drivers - Fixed tone mapping with background opacity - Fixed non-working drag and drop implementation in VTK (thanks @msbit) - Fixed a potential sorting issue when opening a folder - Fixed a crash with unsupported glTF files in VTK For Developers: - Full rework of the CI framework, including coverage report support - Full rework of the testing framework - Separation of vtkF3DRenderer in two classes - Separation of f3d executable into a libf3d library and f3d executable to support windows thumbnails For Packagers: - New CMake options to select file to install, all documented and starting with F3D_ - mime types file can be installed, make sure to trigger update-mime-databse - desktop file can be installed, make sure to trigger update-desktop-database Packagers: AndnoVember @jokersus @kevinsmia1939 @yurivict @bcdarwin @mzf-guest @Meakk @mwestphal Binary Release Information: - The binary release is **not** built with raytracing support - This binary release is built with assimp 5.1.2, animation for assimp formats is not working well Contributors: @CharlesGueunet @kevinsmia1939 @mzf-guest @jpouderoux @Meakk @mwestphal ## v1.1.1 A patch release dedicated to package managers that makes F3D v1.1 compatible with vtk v9.1.0 - Fix a render pass build issue with vtk 9.1.0 - Fix a renderer build issue with vtk 9.1.0 Contributors: @Meakk @mwestphal ## v1.1.0 New Important Features: * **Added direct scalars color rendering mode**, see doc. * **Added a turntable interactor** and made it default. The previous interactor can still be used using a dedicated option. Thanks @orangebowlerhat @filip.sund and @jjomier for your suggestions. * **Added animation support** for glTF and Exodus files. Press space for playing the animation. * Added animation related option, --animation-index, only for glTF when using the full scene. New Readers and format compatibility features: * Added skinning and morphing support with glTF files. * Added TIFF format support. Thanks @proudot for your suggestion. * Added exodus format support. Thanks @gvernon for your suggestion. * Added support for OBJ with color directly inside of it instead of using a .mtl file. Thanks @Chenge321 for your suggestion. Quality of life features: * Added a hotkey (UP) to reload current file, thanks @caioaao. * Improved Alpha blending performance, thanks @paul.lafoix. * Changed the progress bar to a more nice looking one and made it appears only if loading takes time. Thanks @finetjul for the suggestion. * Improved logging mechanism with color on all OS and a dedicated output window on windows. * Added a warning when using RayTracing but it is not available. Fixes: * Fixed an issue with skybox and edges. * Fixed a crash when an array had no name. * Fixed a window naming issue on OSX. * Fixed a symlink issue. * Fixed a coloring issue with dataset containing only cell data. Packaging: * Upgraded the AUR f3d package to 1.1.0 : https://aur.archlinux.org/packages/f3d. * Added a Brew f3d 1.1.0 package : https://formulae.brew.sh/formula/f3d. * FreeBSD now contains a f3d 1.1.0 package, thanks to yuri@freebsd.org. * NixOS now contains a f3d package, 1.1.0 should come soon, thanks to bcdarwin@gmail.com. How to support F3D: * Use the software. * Share it with anyone interested. * Star us on github: https://github.com/kitware/F3D. Note: Binaries have no raytracing support. Contributors: @Meakk @mwestphal ## v1.0.1 - VisualStudio Runtime is now included into the windows release - Ensure VTK compatibility - Improve STL binary reader performances - Fix default configuration issues - Add support for Window icon on all OSes Note: Binaries have no raytracing support. Contributors: @Meakk @mwestphal ## v1.0.0 - Documentation - Online documentation based on Hexo (https://kitware.github.io/F3D/) - Rendering - Add volume rendering for 3D images - HDRI support (skyboxes, HDR files, Filmic tone mapping) - Point sprites for displaying point clouds - Color map customization (default one changed to “inferno”) - Interface - Drag&Drop files support - Supports opening of several files (or folder), use left/right arrow to navigate - Scalars field handling improvements - Cheat Sheet - Interactive hotkeys have been reworked - File association on Windows and OSX - Fullscreen mode - No background mode (useful when saving image to a PNG file with alpha channel) - Command line - Camera configuration - Metadata (field data) display - File name display - No render mode (useful to read information in the file) - Shell completion (supports bash, zsh, fish) - New readers - CityGML - PTS - Packages - Default config provide Note: Binaries have no raytracing support. Contributors: @Meakk @mwestphal @hlngrandmontagne Paul Lafoix ## v0.1.1 - Fixes `--version` and `--help` crash Contributors: @Meakk @mwestphal @jpouderoux ## v0.1.0 First release! Contributors: @Meakk @mwestphal @jpouderoux ",
     "url": "/doc/CHANGELOG.html",
     
     "relUrl": "/doc/CHANGELOG.html"
@@ -50,7 +50,7 @@
   },"7": {
     "doc": "Build",
     "title": "Build",
-    "content": "# Build guide F3D uses a CMake based build system, so building F3D just requires installing needed dependencies, configuring and building. If you are not used to such processes please take a look at our [getting started guide](/doc/dev/GETTING_STARTED.html). ## Dependencies * [CMake](https://cmake.org) >= 3.1. * [VTK](https://vtk.org) >= 9.0.0 (9.2.6 recommended). * A C++17 compiler. * A CMake-compatible build system (Visual Studio, XCode, Ninja, Make, etc.). * Optionally, [Assimp](https://www.assimp.org/) >= 5.0. * Optionally, Open CASCADE [OCCT](https://dev.opencascade.org/) >= 7.5.2. * Optionally, [Alembic](http://www.alembic.io/) >= 1.7. * Optionally, [OpenUSD](https://openusd.org/release/index.html) >= 23.05. * Optionally, [OpenVDB](https://www.openvdb.org/download/) >= 10.0.0, enable `IOOpenVDB` VTK module. * Optionally, [Draco](https://google.github.io/draco/) >= 1.5. * Optionally, [Python](https://www.python.org/) >= 3.6 and [pybind11](https://github.com/pybind/pybind11) >= 2.2. * Optionally, [Java](https://www.java.com) >= 18. * Optionally, [OpenEXR](https://openexr.com/en/latest/) >= 3.0. ## VTK compatibility As stated in the dependencies, F3D is compatible with VTK >= 9.0.0, however, many features are only available in certain conditions. We suggest using VTK 9.2.6 with RenderingRayTracing, RenderingExternal, IOExodus and IOOpenVDB modules enabled in order to get as many features as possible in F3D. ## Configuration and building Configure and generate the project with CMake, then build the software using your build system. Here is some CMake options of interest: * `F3D_BUILD_APPLICATION`: Build the F3D executable. * `BUILD_TESTING`: Enable the [tests](/doc/dev/TESTING.html). * `F3D_MACOS_BUNDLE`: On macOS, build a `.app` bundle. * `F3D_WINDOWS_GUI`: On Windows, build a Win32 application (without console). * `F3D_WINDOWS_BUILD_SHELL_THUMBNAILS_EXTENSION`: On Windows, build the shell thumbnails extension. * `F3D_PLUGINS_STATIC_BUILD`: Build all plugins as static library (embedded into `libf3d`) and automatically loaded by the application. Incompatible with `F3D_MACOS_BUNDLE`. Some modules, plugins and bindings depending on external libraries can be optionally enabled with the following CMake variables: * `F3D_MODULE_RAYTRACING`: Support for raytracing rendering. Requires that VTK has been built with `OSPRay` and `VTK_MODULE_ENABLE_VTK_RenderingRayTracing` turned on. Disabled by default. * `F3D_MODULE_EXTERNAL_RENDERING`: Support for external render window. Requires that VTK has been built with `VTK_MODULE_ENABLE_VTK_RenderingExternal` turned on. Disabled by default. * `F3D_MODULE_EXR`: Support for OpenEXR images. Requires `OpenEXR`. Disabled by default. * `F3D_PLUGIN_BUILD_EXODUS`: Support for ExodusII (.ex2) file format. Requires that VTK has been built with `IOExodus` module (and `hdf5`). Enabled by default. * `F3D_PLUGIN_BUILD_OCCT`: Support for STEP, IGES and BREP file formats. Requires `OpenCASCADE`. Disabled by default. * `F3D_PLUGIN_BUILD_ASSIMP`: Support for FBX, DAE, OFF, DXF and X file formats. Requires `Assimp`. Disabled by default. * `F3D_PLUGIN_BUILD_ALEMBIC`: Support for ABC file format. Requires `Alembic`. Disabled by default. * `F3D_PLUGIN_BUILD_DRACO`: Support for DRC file format. Requires `Draco`. Disabled by default. * `F3D_PLUGIN_BUILD_USD`: Support for USD file format. Requires `OpenUSD`. Disabled by default. * `F3D_PLUGIN_BUILD_VDB`: Support for VDB file format. Requires that VTK has been built with `IOOpenVDB` module (and `OpenVDB`). Disabled by default. * `F3D_BINDINGS_PYTHON`: Generate python bindings (requires `Python` and `pybind11`). Disabled by default. * `F3D_BINDINGS_JAVA`: Generate java bindings (requires `Java` and `JNI`). Disabled by default. ## VCPKG It's possible to use VCPKG to automatically build dependencies. A manifest file `vcpkg.json` is available at your convenience. Please read [VCPKG documentation](https://vcpkg.io/en/getting-started.html). Basically, just install VCPKG, and configure F3D using `-DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake` option. ## Installing Installation can be done through CMake, by running the following command: ``` cmake --install ${your_build_dir} ``` Individual components can also be installed by specifying the component name: ``` cmake --install ${your_build_dir} --component ${component_name} ``` Here is the list of all the components: Name|Installed by default|Operating system|Description ------|------|------|------ `application`|YES|ALL|F3D application `configuration`|NO|ALL|Default configuration files, `config` and `thumbnail`. `library`|YES|ALL|libf3d library binaries `plugin`|YES|ALL|libf3d plugins `dependencies`|NO|ALL|libf3d runtime dependencies. Can be used to create a self-contained and relocatable package. System libraries are excluded. `sdk`|NO|ALL|libf3d SDK (headers and CMake config files) `licenses`|YES|ALL|F3D and third party licenses `documentation`|YES|Linux|`man` documentation `shellext`|YES|Windows/Linux|Desktop integration `python`|YES|ALL|Python bindings `java`|YES|ALL|Java bindings `mimetypes`|NO|Linux|Plugins mimetype XML files for integration with Freedesktop `assets`|YES|Linux|Assets for integration with Freedesktop ",
+    "content": "# Build guide F3D uses a CMake based build system, so building F3D just requires installing needed dependencies, configuring and building. If you are not used to such processes please take a look at our [getting started guide](/doc/dev/GETTING_STARTED.html). ## Dependencies * [CMake](https://cmake.org) >= 3.1. * [VTK](https://vtk.org) >= 9.0.0 (9.2.6 recommended). * A C++17 compiler. * A CMake-compatible build system (Visual Studio, XCode, Ninja, Make, etc.). * Optionally, [Assimp](https://www.assimp.org/) >= 5.0. * Optionally, Open CASCADE [OCCT](https://dev.opencascade.org/) >= 7.5.2. * Optionally, [Alembic](http://www.alembic.io/) >= 1.7. * Optionally, [OpenUSD](https://openusd.org/release/index.html) >= 23.05. * Optionally, [OpenVDB](https://www.openvdb.org/download/) >= 10.0.0, enable `IOOpenVDB` VTK module. * Optionally, [Draco](https://google.github.io/draco/) >= 1.5. * Optionally, [Python](https://www.python.org/) >= 3.6 and [pybind11](https://github.com/pybind/pybind11) >= 2.2. * Optionally, [Java](https://www.java.com) >= 18. * Optionally, [OpenEXR](https://openexr.com/en/latest/) >= 3.0. ## VTK compatibility As stated in the dependencies, F3D is compatible with VTK >= 9.0.0, however, many features are only available in certain conditions. We suggest using VTK 9.2.6 with RenderingRayTracing, RenderingExternal, IOExodus and IOOpenVDB modules enabled in order to get as many features as possible in F3D. ## Configuration and building Configure and generate the project with CMake, then build the software using your build system. Here is some CMake options of interest: * `F3D_BUILD_APPLICATION`: Build the F3D executable. * `BUILD_TESTING`: Enable the [tests](/doc/dev/TESTING.html). * `F3D_MACOS_BUNDLE`: On macOS, build a `.app` bundle. * `F3D_WINDOWS_GUI`: On Windows, build a Win32 application (without console). * `F3D_WINDOWS_BUILD_SHELL_THUMBNAILS_EXTENSION`: On Windows, build the shell thumbnails extension. * `F3D_PLUGINS_STATIC_BUILD`: Build all plugins as static library (embedded into `libf3d`) and automatically loaded by the application. Incompatible with `F3D_MACOS_BUNDLE`. Some modules, plugins and bindings depending on external libraries can be optionally enabled with the following CMake variables: * `F3D_MODULE_RAYTRACING`: Support for raytracing rendering. Requires that VTK has been built with `OSPRay` and `VTK_MODULE_ENABLE_VTK_RenderingRayTracing` turned on. Disabled by default. * `F3D_MODULE_EXTERNAL_RENDERING`: Support for external render window. Requires that VTK has been built with `VTK_MODULE_ENABLE_VTK_RenderingExternal` turned on. Disabled by default. * `F3D_MODULE_EXR`: Support for OpenEXR images. Requires `OpenEXR`. Disabled by default. * `F3D_PLUGIN_BUILD_EXODUS`: Support for ExodusII (.ex2) file format. Requires that VTK has been built with `IOExodus` module (and `hdf5`). Enabled by default. * `F3D_PLUGIN_BUILD_OCCT`: Support for STEP, IGES and BREP file formats. Requires `OpenCASCADE`. Disabled by default. * `F3D_PLUGIN_BUILD_ASSIMP`: Support for FBX, DAE, OFF, DXF, X and 3MF file formats. Requires `Assimp`. Disabled by default. * `F3D_PLUGIN_BUILD_ALEMBIC`: Support for ABC file format. Requires `Alembic`. Disabled by default. * `F3D_PLUGIN_BUILD_DRACO`: Support for DRC file format. Requires `Draco`. Disabled by default. * `F3D_PLUGIN_BUILD_USD`: Support for USD file format. Requires `OpenUSD`. Disabled by default. * `F3D_PLUGIN_BUILD_VDB`: Support for VDB file format. Requires that VTK has been built with `IOOpenVDB` module (and `OpenVDB`). Disabled by default. * `F3D_BINDINGS_PYTHON`: Generate python bindings (requires `Python` and `pybind11`). Disabled by default. * `F3D_BINDINGS_JAVA`: Generate java bindings (requires `Java` and `JNI`). Disabled by default. ## VCPKG It's possible to use VCPKG to automatically build dependencies. A manifest file `vcpkg.json` is available at your convenience. Please read [VCPKG documentation](https://vcpkg.io/en/getting-started.html). Basically, just install VCPKG, and configure F3D using `-DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake` option. ## Installing Installation can be done through CMake, by running the following command: ``` cmake --install ${your_build_dir} ``` Individual components can also be installed by specifying the component name: ``` cmake --install ${your_build_dir} --component ${component_name} ``` Here is the list of all the components: Name|Installed by default|Operating system|Description ------|------|------|------ `application`|YES|ALL|F3D application `configuration`|NO|ALL|Default configuration files, `config` and `thumbnail`. `library`|YES|ALL|libf3d library binaries `plugin`|YES|ALL|libf3d plugins `dependencies`|NO|ALL|libf3d runtime dependencies. Can be used to create a self-contained and relocatable package. System libraries are excluded. `sdk`|NO|ALL|libf3d SDK (headers and CMake config files) `licenses`|YES|ALL|F3D and third party licenses `documentation`|YES|Linux|`man` documentation `shellext`|YES|Windows/Linux|Desktop integration `python`|YES|ALL|Python bindings `java`|YES|ALL|Java bindings `mimetypes`|NO|Linux|Plugins mimetype XML files for integration with Freedesktop `assets`|YES|Linux|Assets for integration with Freedesktop ",
     "url": "/doc/dev/BUILD.html",
     
     "relUrl": "/doc/dev/BUILD.html"
@@ -162,7 +162,7 @@
   },"23": {
     "doc": "Limitations and Troubleshooting",
     "title": "Limitations and Troubleshooting",
-    "content": "# Limitations Here is a non exhaustive list of F3D limitations: * No support for specifying manual lighting in the default scene apart from using `--light-intensity` option. * Multiblock (.vtm, .gml) support is partial, non-surfacic data will be converted into surfaces. * Animation support with full scene data format require VTK >= 9.0.20201016. * Full drag and drop support require VTK >= 9.0.20210620 * Drag and drop interaction cannot be recorded nor played back. * Volume rendering and HDRI support requires a decent GPU. * The `--camera-zoom-factor` option require VTK >= 9.3.0 ## Assimp FBX, DAE, OFF, DXF and X file formats rely on [Assimp](https://github.com/assimp/assimp) library. It comes with some known limitations: - PBR materials are not supported for FBX file format. - Complex animations are not working very well with Assimp 5.1, it's recommended to use Assimp 5.0 for this use case. - Only one animation can be shown at a time, showing all animations is not supported yet. - Some files can be empty, crash, or show artifacts. - DXF support is very limited: only files with polylines and 3D faces are displayed. ## Alembic ABC file formats rely on [Alembic](https://github.com/alembic/alembic) library. It comes with some known limitations: - Supports only simple polygonal geometry. - Does not support ArbGeomParam feature in Alembic. - Does not support Subdivision Meshes. - Does not support Materials. - Does not support Animations. ## USD USD file formats rely on [OpenUSD](https://github.com/PixarAnimationStudios/OpenUSD) library. It comes with some known limitations: - Skinning is slow and baked on the CPU. - Does not support Face-varying attributes. - The `usd` plugin is not shipped in the python wheels yet. ## VDB VDB file formats rely on [OpenVDB](https://github.com/AcademySoftwareFoundation/openvdb) and VTK libraries. It currently comes with some known limitations: - VDB Grid files are opened with a hard-coded 0.1 sampling rate. - The `vdb` plugin is not shipped in the python wheels yet. # Troubleshooting ## General > I have built F3D with raytracing support but the denoiser is not working. Make sure that VTK has been built with *OpenImageDenoise* support (`VTKOSPRAY_ENABLE_DENOISER` option). > My model shows up all wrong, with inverted surfaces everywhere. Your data probably contains some translucent data for some reason, turn on translucency support by pressing `P` or using the `-p` command line option. ## Linux > I have a link error related to `stdc++fs` not found. With some C++ STD library version, explicit linking to `stdc++fs` is not supported. We provide a CMake option `F3D_LINUX_APPLICATION_LINK_FILESYSTEM` that you can set to `OFF` to workaround this issue. > I have a link error related to undefined reference to symbol of `libatomic`. The GCC flag `-latomic` is not being added automatically with specific architectures, like `armel` and `RISCV64`. We provide a CMake option `F3D_LINUX_LIBRARY_LINK_ATOMIC` that you can set to `ON` to workaround this issue. > Thumbnails are not working in my file manager. * Check that your file manager supports the thumbnailer mechanism. * Check that you have updated your mime type database. * If all fails, remove your `.cache` user dir and check that `pcmanfm` thumbnails are working. * If they are working, then it is an issue specific to your file manager (see below for a potential work around). * If only a few format have working thumbnails, then it is an issue with the mime types database. * If no formats have working thumbnails, then it is an issue with the `f3d-plugin-xxx.thumbnailer` files. * If only big file do not have thumbnails, this is intended, you can modify this behavior in the `thumbnail.d/10_global.json` configuration folder using the `max-size` option. Some file managers (eg: Nautilus) are using sandboxing for thumbnails, which the F3D standard binary release does not support as it needs access to the Xorg server to render anything. In that case, you want to use the headless version of F3D that rely on EGL instead of Xorg, available in the [releases page](https://github.com/f3d-app/f3d/releases). If you use the portable archive, make sure to extract it somewhere the sandboxing system has access to, eg: Nautilus uses `bwrap` and gives it access to `/usr` but not to `/opt`. ## Windows > Using the portable binary release, I'm unable to run F3D because Windows warns about a security risk F3D is not signed by Microsoft yet so Windows shows this warning. Just click on the \"more\" button to be able to run F3D. > After installing F3D or registering the shell extension, my explorer is broken. Unregister the shell extension by running: ``` cd C:\\path\\to\\f3d\\bin\\ regsvr32 /u F3DShellExtension.dll ``` > I use F3D in a VM, the application fails to launch. OpenGL applications like F3D can have issues when launched from Windows Server or from a guest Windows because the access to the GPU is restricted. You can try to use a software implementation of OpenGL, called [Mesa](https://github.com/pal1000/mesa-dist-win/releases). * Download the latest `release-msvc`. * copy `x64/opengl32.dll`, `libgallium_wgl.dll` and `x64/libglapi.dll` in the same folder as `f3d.exe`. * set the environment variable `MESA_GL_VERSION_OVERRIDE` to 4.5. * run `f3d.exe`. > I run f3d from the command prompt and my Unicode characters are not displayed properly. Set the codepage to UTF-8, run `chcp 65001`. > When I install F3D, I can't add F3D to the path and the installer complains that: `PATH too long installer unable to modify PATH!`. There are too many entry in your PATH environment variable, remove the ones you do not use. > When I try to update F3D, the installer fails with: `Error opening file for writing: F3DShellExtension.dll` Your previous F3D installation is current being used to generate thumbnails, wait for a bit or reboot your computer before updating again. ## macOS > I'm unable to use the binary release, macOS complains the file is invalid or corrupted Our macOS binary package are not signed, to work around this, you can simply run the following command: ``` xattr -cr /Applications/F3D.app ``` Then F3D should work as expected. > Using the silicon binary release, I cannot find the raytracing feature or open exodus files F3D raytracing and exodus plugin are not working on macOS silicon yet, see this [issue](https://github.com/f3d-app/f3d/issues/976). > I'm unable to get coloring right with step files F3D on macOS does not support coloring on cells because of a [VTK issue](https://gitlab.kitware.com/vtk/vtk/-/issues/18969). ## Python > I can't find `usd` and `vdb` plugins after installing f3d with pip The `usd` and `vdb` plugins are not shipped in the python wheels for now, you can compile F3D yourself with them though. > Raytracing does not work after installing f3d with pip F3D raytracing feature is not shipped in the python wheels for now, you can compile F3D yourself with it though. ",
+    "content": "# Limitations Here is a non exhaustive list of F3D limitations: * No support for specifying manual lighting in the default scene apart from using `--light-intensity` option. * Multiblock (.vtm, .gml) support is partial, non-surfacic data will be converted into surfaces. * Animation support with full scene data format require VTK >= 9.0.20201016. * Full drag and drop support require VTK >= 9.0.20210620 * Drag and drop interaction cannot be recorded nor played back. * Volume rendering and HDRI support requires a decent GPU. * The `--camera-zoom-factor` option require VTK >= 9.3.0 ## Assimp FBX, DAE, OFF, DXF, X and 3MF file formats rely on [Assimp](https://github.com/assimp/assimp) library. It comes with some known limitations: - PBR materials are not supported for FBX file format. - Complex animations are not working very well with Assimp 5.1, it's recommended to use Assimp 5.0 for this use case. - Only one animation can be shown at a time, showing all animations is not supported yet. - Some files can be empty, crash, or show artifacts. - DXF support is very limited: only files with polylines and 3D faces are displayed. - 3MF files may crash at exit (issue in Assimp: https://github.com/assimp/assimp/issues/5328) - Only support RBGA 8-bits embedded textures ## Alembic ABC file formats rely on [Alembic](https://github.com/alembic/alembic) library. It comes with some known limitations: - Supports only simple polygonal geometry. - Does not support ArbGeomParam feature in Alembic. - Does not support Subdivision Meshes. - Does not support Materials. - Does not support Animations. ## USD USD file formats rely on [OpenUSD](https://github.com/PixarAnimationStudios/OpenUSD) library. It comes with some known limitations: - Skinning is slow and baked on the CPU. - Does not support Face-varying attributes. - The `usd` plugin is not shipped in the python wheels yet. ## VDB VDB file formats rely on [OpenVDB](https://github.com/AcademySoftwareFoundation/openvdb) and VTK libraries. It currently comes with some known limitations: - VDB Grid files are opened with a hard-coded 0.1 sampling rate. - The `vdb` plugin is not shipped in the python wheels yet. # Troubleshooting ## General > I have built F3D with raytracing support but the denoiser is not working. Make sure that VTK has been built with *OpenImageDenoise* support (`VTKOSPRAY_ENABLE_DENOISER` option). > My model shows up all wrong, with inverted surfaces everywhere. Your data probably contains some translucent data for some reason, turn on translucency support by pressing `P` or using the `-p` command line option. ## Linux > I have a link error related to `stdc++fs` not found. With some C++ STD library version, explicit linking to `stdc++fs` is not supported. We provide a CMake option `F3D_LINUX_APPLICATION_LINK_FILESYSTEM` that you can set to `OFF` to workaround this issue. > I have a link error related to undefined reference to symbol of `libatomic`. The GCC flag `-latomic` is not being added automatically with specific architectures, like `armel` and `RISCV64`. We provide a CMake option `F3D_LINUX_LIBRARY_LINK_ATOMIC` that you can set to `ON` to workaround this issue. > Thumbnails are not working in my file manager. * Check that your file manager supports the thumbnailer mechanism. * Check that you have updated your mime type database. * If all fails, remove your `.cache` user dir and check that `pcmanfm` thumbnails are working. * If they are working, then it is an issue specific to your file manager (see below for a potential work around). * If only a few format have working thumbnails, then it is an issue with the mime types database. * If no formats have working thumbnails, then it is an issue with the `f3d-plugin-xxx.thumbnailer` files. * If only big file do not have thumbnails, this is intended, you can modify this behavior in the `thumbnail.d/10_global.json` configuration folder using the `max-size` option. Some file managers (eg: Nautilus) are using sandboxing for thumbnails, which the F3D standard binary release does not support as it needs access to the Xorg server to render anything. In that case, you want to use the headless version of F3D that rely on EGL instead of Xorg, available in the [releases page](https://github.com/f3d-app/f3d/releases). If you use the portable archive, make sure to extract it somewhere the sandboxing system has access to, eg: Nautilus uses `bwrap` and gives it access to `/usr` but not to `/opt`. ## Windows > Using the portable binary release, I'm unable to run F3D because Windows warns about a security risk F3D is not signed by Microsoft yet so Windows shows this warning. Just click on the \"more\" button to be able to run F3D. > After installing F3D or registering the shell extension, my explorer is broken. Unregister the shell extension by running: ``` cd C:\\path\\to\\f3d\\bin\\ regsvr32 /u F3DShellExtension.dll ``` > I use F3D in a VM, the application fails to launch. OpenGL applications like F3D can have issues when launched from Windows Server or from a guest Windows because the access to the GPU is restricted. You can try to use a software implementation of OpenGL, called [Mesa](https://github.com/pal1000/mesa-dist-win/releases). * Download the latest `release-msvc`. * copy `x64/opengl32.dll`, `libgallium_wgl.dll` and `x64/libglapi.dll` in the same folder as `f3d.exe`. * set the environment variable `MESA_GL_VERSION_OVERRIDE` to 4.5. * run `f3d.exe`. > I run f3d from the command prompt and my Unicode characters are not displayed properly. Set the codepage to UTF-8, run `chcp 65001`. > When I install F3D, I can't add F3D to the path and the installer complains that: `PATH too long installer unable to modify PATH!`. There are too many entry in your PATH environment variable, remove the ones you do not use. > When I try to update F3D, the installer fails with: `Error opening file for writing: F3DShellExtension.dll` Your previous F3D installation is current being used to generate thumbnails, wait for a bit or reboot your computer before updating again. ## macOS > I'm unable to use the binary release, macOS complains the file is invalid or corrupted Our macOS binary package are not signed, to work around this, you can simply run the following command: ``` xattr -cr /Applications/F3D.app ``` Then F3D should work as expected. > Using the silicon binary release, I cannot find the raytracing feature or open exodus files F3D raytracing and exodus plugin are not working on macOS silicon yet, see this [issue](https://github.com/f3d-app/f3d/issues/976). > I'm unable to get coloring right with step files F3D on macOS does not support coloring on cells because of a [VTK issue](https://gitlab.kitware.com/vtk/vtk/-/issues/18969). ## Python > I can't find `usd` and `vdb` plugins after installing f3d with pip The `usd` and `vdb` plugins are not shipped in the python wheels for now, you can compile F3D yourself with them though. > Raytracing does not work after installing f3d with pip F3D raytracing feature is not shipped in the python wheels for now, you can compile F3D yourself with it though. ",
     "url": "/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html",
     
     "relUrl": "/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html"
@@ -183,7 +183,7 @@
   },"26": {
     "doc": "Usage",
     "title": "Usage",
-    "content": "# Usage Once F3D has been [installed](/doc/user/INSTALLATION.html), you should be able to open any [supported file](#supported-file-formats), by either: * Using F3D automatically, from your file manager, by directly opening a file. * Running F3D and then dragging and dropping files into it to open them. * By running F3D from the terminal with a set of command-line [options](/doc/user/OPTIONS.html). * As a [thumbnailer](/doc/user/DESKTOP_INTEGRATION.html) for all supported file formats with certain file managers. ## Supported file formats Here is the list of supported file formats: * **.vtk** : the legacy VTK format * **.vt[p\\|u\\|r\\|i\\|s\\|m]** : XML based VTK formats * **.ply** : Polygon File format * **.stl** : Standard Triangle Language format * **.dcm** : DICOM file format * **.nrrd/.nhrd** : \"nearly raw raster data\" file format * **.mhd/.mha** : MetaHeader MetaIO file format * **.tif/.tiff** : TIFF 2D/3D file format * **.ex2/.e/.exo/.g** : Exodus 2 file format * **.gml** : CityGML file format * **.pts** : Point Cloud file format * **.step/.stp** : CAD STEP exchange ISO format * **.iges/.igs** : CAD Initial Graphics Exchange Specification format * **.brep** : Open CASCADE BRep format * **.abc** : Alembic format * **.vdb** : VDB format (experimental) * **.obj** : Wavefront OBJ file format (full scene and default scene) * **.gltf/.glb** : GL Transmission Format (full scene and default scene) * **.3ds** : Autodesk 3D Studio file format (full scene) * **.wrl** : VRML file format (full scene) * **.fbx** : Autodesk Filmbox (full scene) * **.dae** : COLLADA (full scene) * **.off** : Object File Format (full scene) * **.dxf** : Drawing Exchange Format (full scene) * **.x** : DirectX Format (full scene) ## Scene construction The **full scene** formats (.gltf/.glb, .3ds, .wrl, .obj, .fbx, .dae, .off) contain not only *geometry*, but also some scene information like *lights*, *cameras*, *actors* in the scene, as well as *texture* properties. By default, all this information will be loaded from the file and displayed. Use the `--geometry-only` [options](/doc/user/OPTIONS.html) to modify this behavior. For file formats that do not support it, **a default scene** is created. ## Animations F3D can play animations for a number of file formats (.ex2/.e/.exo/.g, .gltf/.glb, .fbx, .dae, .x) if the file contains an animation. It is possible to select the animation to play using `--animation-index`, or to play all animations at once using `--animation-index=-1` (.gltf/.glb only). When F3D play an animation, it assumes the time unit is in seconds to show accurate speed of animation. Use `--animation-speed-factor` if an adjustment is needed. By default, F3D will try update the scene 60 times per seconds, use `--animation-frame-rate` to change that if needed. ## Plugins If you installed F3D using a package manager, it's possible that the packager chose to bundle the plugins in different packages or to list plugin dependencies as optional dependencies to reduce the reduce the number of dependencies of the main package. In this case, in order to open a file that requires a plugin, you will have to make sure all needed dependencies are installed and specify which plugin you want to load in order to be able to open this file. You can either use the `--load-plugins` option or add a line in the [configuration file](/doc/user/CONFIGURATION_FILE.html), if not already. Several plugins can be specified by giving a comma-separated list. Here is the list of plugins provided officially by F3D: - **alembic**: ABC support - **assimp**: FBX, DAE, OFF, DXF and X support - **draco**: DRC support - **exodus**: EX2 support - **occt**: STEP and IGES support - **usd**: USD, USDA, UDSC and USDZ support - **vdb**: VDB support (experimental) > Note: If you downloaded the binaries from the Release page, it's not necessary to specify manually the plugins above, all of them are loaded automatically. Here is how the plugins are searched (by precedence order): 1. Search the static plugins 2. Consider the option given is a full path 3. Search in the paths specified in `F3D_PLUGINS_PATH` environment variable 4. Search in a directory relative to the F3D application: `../lib` 5. Rely on OS specific paths (e.g. `LD_LIBRARY_PATH` on Linux or `DYLD_LIBRARY_PATH` on macOS) You can also try plugins maintained by the community. If you have created a plugin and would like it to be listed here, please submit a pull request. - **Abaqus**: ODB support by @YangShen398 ([repository](https://github.com/YangShen398/F3D-ODB-Reader-Plugin)) ",
+    "content": "# Usage Once F3D has been [installed](/doc/user/INSTALLATION.html), you should be able to open any [supported file](#supported-file-formats), by either: * Using F3D automatically, from your file manager, by directly opening a file. * Running F3D and then dragging and dropping files into it to open them. * By running F3D from the terminal with a set of command-line [options](/doc/user/OPTIONS.html). * As a [thumbnailer](/doc/user/DESKTOP_INTEGRATION.html) for all supported file formats with certain file managers. ## Supported file formats Here is the list of supported file formats: * **.vtk** : the legacy VTK format * **.vt[p\\|u\\|r\\|i\\|s\\|m]** : XML based VTK formats * **.ply** : Polygon File format * **.stl** : Standard Triangle Language format * **.dcm** : DICOM file format * **.nrrd/.nhrd** : \"nearly raw raster data\" file format * **.mhd/.mha** : MetaHeader MetaIO file format * **.tif/.tiff** : TIFF 2D/3D file format * **.ex2/.e/.exo/.g** : Exodus 2 file format * **.gml** : CityGML file format * **.pts** : Point Cloud file format * **.step/.stp** : CAD STEP exchange ISO format * **.iges/.igs** : CAD Initial Graphics Exchange Specification format * **.brep** : Open CASCADE BRep format * **.abc** : Alembic format * **.vdb** : VDB format (experimental) * **.obj** : Wavefront OBJ file format (full scene and default scene) * **.gltf/.glb** : GL Transmission Format (full scene and default scene) * **.3ds** : Autodesk 3D Studio file format (full scene) * **.wrl** : VRML file format (full scene) * **.fbx** : Autodesk Filmbox (full scene) * **.dae** : COLLADA (full scene) * **.off** : Object File Format (full scene) * **.dxf** : Drawing Exchange Format (full scene) * **.x** : DirectX Format (full scene) * **.3mf** : 3D Manufacturing Format (full scene) ## Scene construction The **full scene** formats (.gltf/.glb, .3ds, .wrl, .obj, .fbx, .dae, .off, .x, .3mf) contain not only *geometry*, but also some scene information like *lights*, *cameras*, *actors* in the scene, as well as *texture* properties. By default, all this information will be loaded from the file and displayed. Use the `--geometry-only` [options](/doc/user/OPTIONS.html) to modify this behavior. For file formats that do not support it, **a default scene** is created. ## Animations F3D can play animations for a number of file formats (.ex2/.e/.exo/.g, .gltf/.glb, .fbx, .dae, .x) if the file contains an animation. It is possible to select the animation to play using `--animation-index`, or to play all animations at once using `--animation-index=-1` (.gltf/.glb only). When F3D play an animation, it assumes the time unit is in seconds to show accurate speed of animation. Use `--animation-speed-factor` if an adjustment is needed. By default, F3D will try update the scene 60 times per seconds, use `--animation-frame-rate` to change that if needed. ## Plugins If you installed F3D using a package manager, it's possible that the packager chose to bundle the plugins in different packages or to list plugin dependencies as optional dependencies to reduce the reduce the number of dependencies of the main package. In this case, in order to open a file that requires a plugin, you will have to make sure all needed dependencies are installed and specify which plugin you want to load in order to be able to open this file. You can either use the `--load-plugins` option or add a line in the [configuration file](/doc/user/CONFIGURATION_FILE.html), if not already. Several plugins can be specified by giving a comma-separated list. Here is the list of plugins provided officially by F3D: - **alembic**: ABC support - **assimp**: FBX, DAE, OFF, DXF, X and 3MF support - **draco**: DRC support - **exodus**: EX2 support - **occt**: STEP and IGES support - **usd**: USD, USDA, UDSC and USDZ support - **vdb**: VDB support (experimental) > Note: If you downloaded the binaries from the Release page, it's not necessary to specify manually the plugins above, all of them are loaded automatically. Here is how the plugins are searched (by precedence order): 1. Search the static plugins 2. Consider the option given is a full path 3. Search in the paths specified in `F3D_PLUGINS_PATH` environment variable 4. Search in a directory relative to the F3D application: `../lib` 5. Rely on OS specific paths (e.g. `LD_LIBRARY_PATH` on Linux or `DYLD_LIBRARY_PATH` on macOS) You can also try plugins maintained by the community. If you have created a plugin and would like it to be listed here, please submit a pull request. - **Abaqus**: ODB support by @YangShen398 ([repository](https://github.com/YangShen398/F3D-ODB-Reader-Plugin)) ",
     "url": "/doc/user/USAGE.html",
     
     "relUrl": "/doc/user/USAGE.html"
diff --git a/doc/CHANGELOG.html b/doc/CHANGELOG.html
index 3549e29565..82558ddc04 100644
--- a/doc/CHANGELOG.html
+++ b/doc/CHANGELOG.html
@@ -1 +1 @@
-<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <link rel="stylesheet" href="/assets/css/just-the-docs-default.css"> <link rel="stylesheet" href="/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet"> <style id="jtd-nav-activation"> .site-nav > ul.nav-list:first-child > li:not(:nth-child(7)) > a, .site-nav > ul.nav-list:first-child > li > ul > li > a, .site-nav > ul.nav-list:first-child > li > ul > li > ul > li > a { background-image: none; } .site-nav > ul.nav-list:not(:first-child) a, .site-nav li.external a { background-image: none; } .site-nav > ul.nav-list:first-child > li:nth-child(7) > a { font-weight: 600; text-decoration: none; }.site-nav > ul.nav-list:first-child > li:nth-child(7) > button svg { transform: rotate(-90deg); }.site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(7) > ul.nav-list { display: block; } </style> <script async src="https://www.googletagmanager.com/gtag/js?id=G-ZCWEYB9KVG"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-ZCWEYB9KVG', { 'anonymize_ip': true }); </script> <script src="/assets/js/vendor/lunr.min.js"></script> <script src="/assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- Begin Jekyll SEO tag v2.8.0 --> <title>Changelog | F3D</title> <meta name="generator" content="Jekyll v3.9.3" /> <meta property="og:title" content="Changelog" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="F3D - Fast and minimalist 3D viewer" /> <meta property="og:description" content="F3D - Fast and minimalist 3D viewer" /> <link rel="canonical" href="https://f3d.app//doc/CHANGELOG.html" /> <meta property="og:url" content="https://f3d.app//doc/CHANGELOG.html" /> <meta property="og:site_name" content="F3D" /> <meta property="og:image" content="https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png" /> <meta property="og:image:height" content="1200" /> <meta property="og:image:width" content="630" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary_large_image" /> <meta property="twitter:image" content="https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png" /> <meta property="twitter:title" content="Changelog" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","description":"F3D - Fast and minimalist 3D viewer","headline":"Changelog","image":{"height":1200,"width":630,"url":"https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png","@type":"imageObject"},"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://f3d.app//resources/logotype.svg"}},"url":"https://f3d.app//doc/CHANGELOG.html"}</script> <!-- End Jekyll SEO tag --> <link rel="shortcut icon" href="https://raw.githubusercontent.com/f3d-app/f3d/master/resources/logo.ico" type="image/x-icon"> </head> <body> <a class="skip-to-main" href="#main-content">Skip to main content</a> <svg xmlns="http://www.w3.org/2000/svg" class="d-none"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE --> <symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link"> <title id="svg-external-link-title">(external link)</title> <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"> <title>Document</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"> <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"> <title>Search</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol> <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md --> <symbol id="svg-copy" viewBox="0 0 16 16"> <title>Copy</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16"> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/> <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/> </svg> </symbol> <symbol id="svg-copied" viewBox="0 0 16 16"> <title>Copied</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16"> <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/> </svg> </symbol> </svg> <div class="side-bar"> <div class="site-header" role="banner"> <a href="/" class="site-title lh-tight"> <div class="site-logo" role="img" aria-label="F3D"></div> </a> <button id="menu-button" class="site-button btn-reset" aria-label="Toggle menu" aria-pressed="false"> <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg> </button> </div> <nav aria-label="Main" id="site-nav" class="site-nav"> <ul class="nav-list"><li class="nav-list-item"><a href="/" class="nav-list-link">Home</a></li><li class="nav-list-item"><a href="/doc/GALLERY.html" class="nav-list-link">Gallery</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in User Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/user/README_USER.html" class="nav-list-link">User Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/user/USAGE.html" class="nav-list-link">Usage</a></li><li class="nav-list-item"><a href="/doc/user/INSTALLATION.html" class="nav-list-link">Installation</a></li><li class="nav-list-item"><a href="/doc/user/OPTIONS.html" class="nav-list-link">Options</a></li><li class="nav-list-item"><a href="/doc/user/INTERACTIONS.html" class="nav-list-link">Interactions</a></li><li class="nav-list-item"><a href="/doc/user/CONFIGURATION_FILE.html" class="nav-list-link">Configuration File</a></li><li class="nav-list-item"><a href="/doc/user/DESKTOP_INTEGRATION.html" class="nav-list-link">Desktop Integration</a></li><li class="nav-list-item"><a href="/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html" class="nav-list-link">Limitations and Troubleshooting</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in libf3d Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/libf3d/README_LIBF3D.html" class="nav-list-link">libf3d Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/libf3d/OVERVIEW.html" class="nav-list-link">Overview</a></li><li class="nav-list-item"><a href="/doc/libf3d/CLASSES.html" class="nav-list-link">Classes Introduction</a></li><li class="nav-list-item"><a href="/doc/libf3d/OPTIONS.html" class="nav-list-link">Options</a></li><li class="nav-list-item"><a href="/doc/libf3d/BINDINGS.html" class="nav-list-link">Bindings</a></li><li class="nav-list-item"><a href="/doc/libf3d/PLUGINS.html" class="nav-list-link">Plugin SDK</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Developer Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/dev/README_DEV.html" class="nav-list-link">Developer Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/dev/GETTING_STARTED.html" class="nav-list-link">Getting Started</a></li><li class="nav-list-item"><a href="/doc/dev/BUILD.html" class="nav-list-link">Build</a></li><li class="nav-list-item"><a href="/doc/dev/TESTING.html" class="nav-list-link">Testing</a></li><li class="nav-list-item"><a href="/CONTRIBUTING.html" class="nav-list-link">Contribute</a></li><li class="nav-list-item"><a href="/doc/dev/GENERATE.html" class="nav-list-link">Generate</a></li><li class="nav-list-item"><a href="/doc/dev/CODING_STYLE.html" class="nav-list-link">Coding Style</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Licenses category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/_licenses.html" class="nav-list-link">Licenses</a><ul class="nav-list"><li class="nav-list-item"><a href="/LICENSE.html" class="nav-list-link">License</a></li><li class="nav-list-item"><a href="/doc/THIRD_PARTY_LICENSES.html" class="nav-list-link">Third Party Licenses</a></li></ul></li><li class="nav-list-item"><a href="/doc/CHANGELOG.html" class="nav-list-link">Changelog</a></li></ul> <ul class="nav-list"><li class="nav-list-item external"> <a href="https://f3d.app/doc/user/INSTALLATION.html" class="nav-list-link external" > Download F3D <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg> </a> </li><li class="nav-list-item external"> <a href="https://github.com/f3d-app/f3d" class="nav-list-link external" > GitHub repository <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg> </a> </li></ul> </nav> <footer class="site-footer"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </footer> </div> <div class="main" id="top"> <div id="main-header" class="main-header"> <div class="search" role="search"> <div class="search-input-wrap"> <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search F3D" aria-label="Search F3D" autocomplete="off"> <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label> </div> <div id="search-results" class="search-results"></div> </div> <nav aria-label="Auxiliary" class="aux-nav"> <ul class="aux-nav-list"> <li class="aux-nav-list-item"> <a href="//github.com/f3d-app/f3d" class="site-button" target="_blank" rel="noopener noreferrer" > <img src="https://user-images.githubusercontent.com/3129530/197903476-11d9c41d-73b0-461f-93e8-c8c00c680e6e.png" width="30px"> </a> </li> </ul> </nav> </div> <div class="main-content-wrap"> <div id="main-content" class="main-content"> <main> <h1 id="changelog"> <a href="#changelog" class="anchor-heading" aria-labelledby="changelog"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Changelog </h1> <h2 id="ongoing-development"> <a href="#ongoing-development" class="anchor-heading" aria-labelledby="ongoing-development"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Ongoing development </h2> <p>For F3D users:</p> <ul> <li>Added <code class="language-plaintext highlighter-rouge">--animation-autoplay</code> option (libf3d: <code class="language-plaintext highlighter-rouge">scene.animation.autoplay</code>) to automatically start animation on file load.</li> <li>Added an experimental VDB reader for .vdb files using OpenVDB</li> <li>Changed <code class="language-plaintext highlighter-rouge">--verbose</code> into a string based option, eg: <code class="language-plaintext highlighter-rouge">--verbose=quiet</code> or <code class="language-plaintext highlighter-rouge">--verbose=debug</code>. <code class="language-plaintext highlighter-rouge">--verbose</code> is still supported.</li> <li>Changed <code class="language-plaintext highlighter-rouge">--no-render</code> behavior so that it doesn’t impact verbosity anymore</li> <li>Deprecated <code class="language-plaintext highlighter-rouge">--quiet</code>, use <code class="language-plaintext highlighter-rouge">--verbose=quiet</code> instead.</li> <li>Reading EXR files is now multi-threaded and much faster.</li> <li>Translucency support is now enabled by default.</li> <li>A small margin is added between the model and the grid to avoid potential z-fighting.</li> <li>Add X files support (part of <code class="language-plaintext highlighter-rouge">assimp</code> plugin)</li> <li>Fix potential crashes when reading <code class="language-plaintext highlighter-rouge">assimp</code> plugin file format</li> </ul> <p>For libf3d users:</p> <ul> <li>Added <code class="language-plaintext highlighter-rouge">scene.animation.autoplay</code> option.</li> <li>Added a <code class="language-plaintext highlighter-rouge">f3d::image::saveBuffer</code> API to save an image as a file format in memory.</li> </ul> <p>For F3D packagers:</p> <ul> <li>Added a new optional dependency through VTK, OpenVDB</li> </ul> <h2 id="v221"> <a href="#v221" class="anchor-heading" aria-labelledby="v221"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v2.2.1 </h2> <p>For F3D users:</p> <ul> <li>Added a native Apple Silicon release package</li> <li>Added new options <code class="language-plaintext highlighter-rouge">hdri-file</code>, <code class="language-plaintext highlighter-rouge">hdri-ambient</code>, <code class="language-plaintext highlighter-rouge">hdri-skybox</code> to have more control on the HDRI behavior</li> <li>Added a default HDRI used when providing no <code class="language-plaintext highlighter-rouge">hdri-file</code></li> <li>Added bindings to toggle HDRI ambient lighting (<code class="language-plaintext highlighter-rouge">F</code>) and HDRI skybox (<code class="language-plaintext highlighter-rouge">J</code>)</li> <li>Added bindings to move the camera to standard locations: <code class="language-plaintext highlighter-rouge">1</code>: Front, <code class="language-plaintext highlighter-rouge">3</code>: Right, <code class="language-plaintext highlighter-rouge">7</code>: Top, <code class="language-plaintext highlighter-rouge">9</code>: Isometric</li> <li>Added <a href="https://dev.opencascade.org/doc/overview/html/specification__brep_format.html">Open CASCADE BRep format</a> to the OCCT plugin.</li> <li>Fixed an infamous issue when the Windows thumbnailer always steal the focus</li> <li>Fixed an issue with the binary release when opening draco files</li> <li>Fixed an issue with matcap textures</li> <li>Fixed an issue with HDRI lighting</li> <li>Fixed an issue with HDRI lighting when dropping HDRI after a model</li> <li>Fixed an issue where invalid option would not show on Windows</li> <li>Fixed an issue where previously loaded file would stay visible</li> <li>Fixed an issue when loading invalid EXR file as HDRI</li> <li>Fixed cheatsheet menu rendering under ‘Drop File Instructor’</li> <li>Fixed raytracing rendering issues</li> <li>Improved cheatsheet menu contrast for any background color</li> <li>Improved overall text contrast for any background color</li> <li>Improved performance when changing model and using a HDRI</li> <li>Improved HDRI cache performance</li> <li>Deprecated <code class="language-plaintext highlighter-rouge">hdri</code> option</li> </ul> <p>For libf3d users:</p> <ul> <li>Reworked image API to support many file formats to read (EXR, HDR) and write (PNG, JPG, TIF, BMP)</li> <li>Added <code class="language-plaintext highlighter-rouge">render.hdri.file</code>, <code class="language-plaintext highlighter-rouge">render.hdri.ambient</code>, <code class="language-plaintext highlighter-rouge">render.background.skybox</code> options.</li> <li>Deprecated <code class="language-plaintext highlighter-rouge">render.background.hdri</code> in favor of new options above</li> <li>Deprecated previous image API</li> <li>Add <code class="language-plaintext highlighter-rouge">loader::loadGeometry</code> allowing loading geometry from memory buffers</li> </ul> <p>For developers:</p> <ul> <li>Added a deprecation framework</li> <li>Removed <code class="language-plaintext highlighter-rouge">F3D_TESTING_ENABLE_HDRI_TESTS</code> cmake option and merged it with <code class="language-plaintext highlighter-rouge">F3D_TESTING_ENABLE_LONG_TIMEOUT_TESTS</code></li> <li>Added a Getting Started guide for beginners developers</li> </ul> <p>For F3D packagers:</p> <ul> <li>Fixed compatibility with FreeBSD</li> </ul> <h2 id="v210"> <a href="#v210" class="anchor-heading" aria-labelledby="v210"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v2.1.0 </h2> <p>For F3D users:</p> <ul> <li>Reworked Animation support and added many animation related options</li> <li>Added <code class="language-plaintext highlighter-rouge">--camera-direction</code> and <code class="language-plaintext highlighter-rouge">--camera-zoom-factor</code> and use it in default config file</li> <li>Added <code class="language-plaintext highlighter-rouge">--texture-matcap</code> option to load a MatCap texture</li> <li>Added support for opening HDRI background with Drop</li> <li>Added .exr support for HDRI and textures</li> <li>Improved HDRI caching performance</li> <li>Added a EGL headless binary release</li> <li>Added typo suggestion when failing to use the right option name</li> <li>Added <code class="language-plaintext highlighter-rouge">--invert-zoom</code> option (libf3d: <code class="language-plaintext highlighter-rouge">interactor.invert-zoom</code>) to invert zoom direction with right-click on mouse</li> <li>Added support for keeping camera position when reloading a file with <code class="language-plaintext highlighter-rouge">UP</code> key</li> <li>Added a <code class="language-plaintext highlighter-rouge">--grid-absolute</code> option (libf3d: <code class="language-plaintext highlighter-rouge">render.grid.absolute</code>) to position the grid instead of being below the model</li> <li>Added a “Drop Zone” when starting F3D without loading a file</li> <li>Added coloring support for STEP files in binary release</li> <li>Fixed an issue on Windows where the error window would popup even with <code class="language-plaintext highlighter-rouge">--quiet</code></li> <li>Fixed an issue with 16 bit and 32 bit textures with assimp plugin</li> <li>Fixed an issue on Windows where errors where not visible</li> <li>Fixed an HDRI issue on reload</li> <li>Fixed a crash when with the progress bar on reloading a file</li> <li>Fixed an issue where certain options from config file would be ignored</li> <li>Fixed a crash with many GLTF files when an array does not have a name</li> <li>Fixed an issue where dropping a duplicate file would change the loaded file instead of not doing anything</li> <li>Fixed an issue when loading an unsupported file</li> <li>Fixed an issue with VRML files</li> <li>Improved config file for .ply files</li> <li>Improved config file regex so that they are case-insensitive</li> <li>Improved <code class="language-plaintext highlighter-rouge">--up</code> option to support no sign and better validation</li> <li>Improved F3D version reporting about itself and VTK (<code class="language-plaintext highlighter-rouge">--version</code>)</li> <li>Improved documentation, testing, help</li> <li>Excluded TIFF format from Windows Thumbnailer</li> <li>Changed the automatic camera position to a version more close to the data</li> <li>Reduced size of binary release by a factor of two</li> </ul> <p>For developers:</p> <ul> <li>Added vcpkg support for dependency installation</li> </ul> <p>For F3D packagers:</p> <ul> <li>Added a <code class="language-plaintext highlighter-rouge">F3D_PLUGIN_OCCT_COLORING_SUPPORT</code> CMake variable to control if this feature is compiled, default is ON</li> <li>Added <code class="language-plaintext highlighter-rouge">SONAME</code> support</li> <li>Added a <code class="language-plaintext highlighter-rouge">F3D_PLUGINS_INSTALL_DIR</code> CMake variable to control where to install plugins</li> <li>Added a new module: <code class="language-plaintext highlighter-rouge">F3D_MODULE_EXR</code> that depends on openexr</li> <li>Added support to use external <code class="language-plaintext highlighter-rouge">cxxopts</code> and external <code class="language-plaintext highlighter-rouge">nlohmann-json</code></li> <li>Fixed a link issue with VTK modules</li> <li>Fixed a <code class="language-plaintext highlighter-rouge">@loader_path</code> issue on MacOS</li> <li>Added support for <code class="language-plaintext highlighter-rouge">CMAKE_INSTALL_*DIR</code> variables on installation</li> <li>Added support for building against a EGL enabled VTK</li> <li>Fixed a compilation issue with VTK master</li> </ul> <p>Contributors: @DeveloperPaul123 @topazus @bkmgit @snoyer @Meakk @mwestphal</p> <h2 id="v200"> <a href="#v200" class="anchor-heading" aria-labelledby="v200"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v2.0.0 </h2> <p>For F3D users:</p> <ul> <li>Removed <code class="language-plaintext highlighter-rouge">--fullscreen</code> options completely</li> <li>Added a <code class="language-plaintext highlighter-rouge">--position</code> option to set the position of the F3D window</li> <li>Added a <code class="language-plaintext highlighter-rouge">--light-intensity</code> option and associated bindings</li> <li>Improved fish and zsh completion</li> <li>Added a new interaction to center the camera on the point under the cursor using <em>middle</em> mouse button</li> <li>Added HDRi caching for improved performance</li> <li>Added scene bounding box to the dump interaction</li> <li>Reworked lighting for fullscene format files</li> <li>Improved grid rendering and customization greatly with new options</li> <li>Improved HDRi blur performance and customization</li> <li>Added support for reading config file directory instead of a single file</li> <li>Changed config file location on Windows</li> <li>PostFX option names have been changed</li> <li>Added an interaction (down arrow) to load all files from the directory containing the current file</li> <li>Added a <code class="language-plaintext highlighter-rouge">--group-geometries</code> option to load multiple default scene file into a single render window</li> </ul> <p>For libf3d users:</p> <ul> <li>Reworked loader API from scratch</li> <li>Fixed an issue with engine creation in the Python bindings</li> <li>Fixed an issue with image Python bindings</li> <li>Improved libf3d examples</li> <li>Added experimental javascript bindings based on webassembly/emscriptem</li> <li>Added dynamic support for all <code class="language-plaintext highlighter-rouge">model</code> options</li> <li>Added plugin SDK to create your own plugins for any file format</li> </ul> <p>For F3D packagers:</p> <ul> <li>Added plugins support for true optional dependencies</li> <li>Added a <code class="language-plaintext highlighter-rouge">F3D_APPLICATION_LINK_FILESYSTEM</code> CMake option to control if F3D should link explicitly against libstdc++fs</li> <li>Removed most of <code class="language-plaintext highlighter-rouge">F3D_INSTALL_</code> options with the switch to a component-based approach</li> <li>Removed installation of useless static libs from VTKExtensions (needs VTK master)</li> <li>Fixed RPATH of F3D for system using lib64 instead of lib</li> <li>Many CMake option name changed</li> <li>Fixed data license to use only permissive license for F3D testing data</li> <li>Removed packaging support from F3D</li> </ul> <p>Contributors: @snoyer @mzf-guest @CharlesGueunet @myd7349 @allemangD @Meakk @mwestphal</p> <h2 id="v131"> <a href="#v131" class="anchor-heading" aria-labelledby="v131"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v1.3.1 </h2> <ul> <li>Fix raytracing support</li> <li>Fix macOS window positioning</li> </ul> <p>Contributors: @mwestphal @Meakk</p> <h2 id="v130"> <a href="#v130" class="anchor-heading" aria-labelledby="v130"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v1.3.0 </h2> <p>Main new features and fixes:</p> <ul> <li>Introducing an alpha version of the libf3d, see below for more information</li> <li>Added a –font-file option</li> <li>Added support for Alembic file format (.abc). Geometry only. Thanks a lot @nyue.</li> <li>Fixed many HDRI issues</li> <li>Fixed an important drag and drop issue on linux</li> </ul> <p>Other fixes:</p> <ul> <li>Fixed many doc and UI typos</li> <li>Fixed shell completion</li> <li>Fixed multiple issue with image comparison</li> <li>Fixed an issue with –line-width and –point-size with full scene formats</li> <li>Fixed an issue with translucent object and RGBA texture</li> <li>Fixed issues with a few specific .gltf files</li> <li>Fixed a window title issue on MacOS</li> <li>Fixed multiple issues with the output window on Windows</li> <li>Fixed issues with file association and thumbnails on Windows</li> <li>Fixed a small issue with the cheatsheet not appearing in some cases</li> <li>Fixed an issue with certain .obj files</li> <li>Fixed a clipping issue when setting camera position</li> <li>Removed fullscreen hotkey</li> </ul> <p>For F3D developers:</p> <ul> <li>Updated cxxopts to 3.0.0</li> <li>Now using json.hpp for parsing json config file</li> <li>Better reproducible build support</li> <li>Improved CI with coverage, sanitizer, dedicated actions for dependencies</li> <li>Complete rework of the architecture to separate F3D, the application, the libf3d (see below) and a VTKExtensions layer.</li> <li>Improved unit testing by adding test in the libf3d and VTKExtensions layer</li> </ul> <p>For libf3d users:</p> <ul> <li>Introducing an alpha version of the libf3d!</li> <li>The libf3d is a C++ library to open and render 3D meshes, it is of course used by F3D and supports python bindings</li> <li>More info available in README_libf3d.md</li> </ul> <p>Binary Release Information:</p> <ul> <li>The binary release is <strong>not</strong> built with raytracing support</li> <li>This binary release is built with assimp 5.1.2, animation for assimp formats is not working well</li> </ul> <p>Contributors: @schuhumi @herrriehm @rafcon-dev @mzf-guest @nyue @jpouderoux @Meakk @mwestphal</p> <h2 id="v121"> <a href="#v121" class="anchor-heading" aria-labelledby="v121"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v1.2.1 </h2> <p>Bug fixes and features:</p> <ul> <li>Fixed a build issue on MacOS</li> <li>Fixed a critical issue with the Windows Thumbnailer that could crash explorer.exe</li> <li>Fixed the –quiet option so that it actually quiets VTK errors and warnings</li> <li>Fixed an issue with output window popping up at each log on Windows</li> <li>Added a <code class="language-plaintext highlighter-rouge">.deb</code> package for Linux Debian-based distros</li> </ul> <p>For Packagers:</p> <ul> <li>LFS file have been added in source code release, this seems to be retroactive, so hash of previous releases may have changed</li> <li>Flatpack org name has been fixed</li> </ul> <p>Contributors: @Meakk @mwestphal @jpouderoux</p> <h2 id="v120"> <a href="#v120" class="anchor-heading" aria-labelledby="v120"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v1.2.0 </h2> <p>Main New Features:</p> <ul> <li>Added STEP and IGES file format support thanks to @Open-Cascade-SAS /<a href="https://github.com/Open-Cascade-SAS/OCCT">OCCT</a> (thanks @drtrigon)</li> <li>Added FBX, DAE, OFF, and DXF file format support thanks to @assimp /<a href="https://github.com/assimp/assimp">assimp</a></li> <li>Added thumbnail support with many linux file managers</li> <li>Added thumbnail support on Windows</li> <li>Added desktop environment integration in linux</li> <li>Added scalar and scalar component looping</li> </ul> <p>Other New Features:</p> <ul> <li>Added support for KHR_materials_unlit with glTF files (thanks @spiraloid)</li> <li>Added option for selecting camera <code class="language-plaintext highlighter-rouge">--camera-index</code> (thanks @spiraloid)</li> <li>Added coloring the to Windows error output window</li> <li>Added a man entry on Linux</li> <li>Added a <code class="language-plaintext highlighter-rouge">--config</code> option to select a config file to load instead of using default location</li> <li>Added a <code class="language-plaintext highlighter-rouge">--quiet</code> option</li> <li>Added <code class="language-plaintext highlighter-rouge">--camera-azimuth</code> and <code class="language-plaintext highlighter-rouge">--camera-elevation</code> options (thanks @tatsuya-s)</li> <li>Added a metainfo.xml file (thanks @kevinsmia1939)</li> </ul> <p>Issue Fixes:</p> <ul> <li>Fixed an issue with opening files with accented char in the name on Windows (thanks @shankarsivarajan)</li> <li>Fixed HDRI orientation with –up option (thanks @truhlikfredy)</li> <li>Fixed an issue with point cloud rendering</li> <li>Fixed a crash on exit on Windows</li> <li>Fixed an issue with fullscreen window size on Windows</li> <li>Fixed offscreen rendering (<code class="language-plaintext highlighter-rouge">--output</code> and <code class="language-plaintext highlighter-rouge">--ref</code> ) to actually use offscreen rendering</li> <li>Fixed a memory leak when no rendering is performed (thanks @CharlesGueunet)</li> <li>Fixed a rendering issue with certain GPU drivers</li> <li>Fixed tone mapping with background opacity</li> <li>Fixed non-working drag and drop implementation in VTK (thanks @msbit)</li> <li>Fixed a potential sorting issue when opening a folder</li> <li>Fixed a crash with unsupported glTF files in VTK</li> </ul> <p>For Developers:</p> <ul> <li>Full rework of the CI framework, including coverage report support</li> <li>Full rework of the testing framework</li> <li>Separation of vtkF3DRenderer in two classes</li> <li>Separation of f3d executable into a libf3d library and f3d executable to support windows thumbnails</li> </ul> <p>For Packagers:</p> <ul> <li>New CMake options to select file to install, all documented and starting with F3D_</li> <li>mime types file can be installed, make sure to trigger update-mime-databse</li> <li>desktop file can be installed, make sure to trigger update-desktop-database</li> </ul> <p>Packagers: AndnoVember @jokersus @kevinsmia1939 @yurivict @bcdarwin @mzf-guest @Meakk @mwestphal</p> <p>Binary Release Information:</p> <ul> <li>The binary release is <strong>not</strong> built with raytracing support</li> <li>This binary release is built with assimp 5.1.2, animation for assimp formats is not working well</li> </ul> <p>Contributors: @CharlesGueunet @kevinsmia1939 @mzf-guest @jpouderoux @Meakk @mwestphal</p> <h2 id="v111"> <a href="#v111" class="anchor-heading" aria-labelledby="v111"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v1.1.1 </h2> <p>A patch release dedicated to package managers that makes F3D v1.1 compatible with vtk v9.1.0</p> <ul> <li>Fix a render pass build issue with vtk 9.1.0</li> <li>Fix a renderer build issue with vtk 9.1.0</li> </ul> <p>Contributors: @Meakk @mwestphal</p> <h2 id="v110"> <a href="#v110" class="anchor-heading" aria-labelledby="v110"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v1.1.0 </h2> <p>New Important Features:</p> <ul> <li><strong>Added direct scalars color rendering mode</strong>, see doc.</li> <li><strong>Added a turntable interactor</strong> and made it default. The previous interactor can still be used using a dedicated option. Thanks @orangebowlerhat @filip.sund and @jjomier for your suggestions.</li> <li><strong>Added animation support</strong> for glTF and Exodus files. Press space for playing the animation.</li> <li>Added animation related option, –animation-index, only for glTF when using the full scene.</li> </ul> <p>New Readers and format compatibility features:</p> <ul> <li>Added skinning and morphing support with glTF files.</li> <li>Added TIFF format support. Thanks @proudot for your suggestion.</li> <li>Added exodus format support. Thanks @gvernon for your suggestion.</li> <li>Added support for OBJ with color directly inside of it instead of using a .mtl file. Thanks @Chenge321 for your suggestion.</li> </ul> <p>Quality of life features:</p> <ul> <li>Added a hotkey (UP) to reload current file, thanks @caioaao.</li> <li>Improved Alpha blending performance, thanks @paul.lafoix.</li> <li>Changed the progress bar to a more nice looking one and made it appears only if loading takes time. Thanks @finetjul for the suggestion.</li> <li>Improved logging mechanism with color on all OS and a dedicated output window on windows.</li> <li>Added a warning when using RayTracing but it is not available.</li> </ul> <p>Fixes:</p> <ul> <li>Fixed an issue with skybox and edges.</li> <li>Fixed a crash when an array had no name.</li> <li>Fixed a window naming issue on OSX.</li> <li>Fixed a symlink issue.</li> <li>Fixed a coloring issue with dataset containing only cell data.</li> </ul> <p>Packaging:</p> <ul> <li>Upgraded the AUR f3d package to 1.1.0 : https://aur.archlinux.org/packages/f3d.</li> <li>Added a Brew f3d 1.1.0 package : https://formulae.brew.sh/formula/f3d.</li> <li>FreeBSD now contains a f3d 1.1.0 package, thanks to yuri@freebsd.org.</li> <li>NixOS now contains a f3d package, 1.1.0 should come soon, thanks to bcdarwin@gmail.com.</li> </ul> <p>How to support F3D:</p> <ul> <li>Use the software.</li> <li>Share it with anyone interested.</li> <li>Star us on github: https://github.com/kitware/F3D.</li> </ul> <p>Note: Binaries have no raytracing support.</p> <p>Contributors: @Meakk @mwestphal</p> <h2 id="v101"> <a href="#v101" class="anchor-heading" aria-labelledby="v101"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v1.0.1 </h2> <ul> <li>VisualStudio Runtime is now included into the windows release</li> <li>Ensure VTK compatibility</li> <li>Improve STL binary reader performances</li> <li>Fix default configuration issues</li> <li>Add support for Window icon on all OSes</li> </ul> <p>Note: Binaries have no raytracing support.</p> <p>Contributors: @Meakk @mwestphal</p> <h2 id="v100"> <a href="#v100" class="anchor-heading" aria-labelledby="v100"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v1.0.0 </h2> <ul> <li>Documentation <ul> <li>Online documentation based on Hexo (https://kitware.github.io/F3D/)</li> </ul> </li> <li>Rendering <ul> <li>Add volume rendering for 3D images</li> <li>HDRI support (skyboxes, HDR files, Filmic tone mapping)</li> <li>Point sprites for displaying point clouds</li> <li>Color map customization (default one changed to “inferno”)</li> </ul> </li> <li>Interface <ul> <li>Drag&amp;Drop files support</li> <li>Supports opening of several files (or folder), use left/right arrow to navigate</li> <li>Scalars field handling improvements</li> <li>Cheat Sheet</li> <li>Interactive hotkeys have been reworked</li> <li>File association on Windows and OSX</li> <li>Fullscreen mode</li> <li>No background mode (useful when saving image to a PNG file with alpha channel)</li> </ul> </li> <li>Command line <ul> <li>Camera configuration</li> <li>Metadata (field data) display</li> <li>File name display</li> <li>No render mode (useful to read information in the file)</li> <li>Shell completion (supports bash, zsh, fish)</li> </ul> </li> <li>New readers <ul> <li>CityGML</li> <li>PTS</li> </ul> </li> <li>Packages <ul> <li>Default config provide</li> </ul> </li> </ul> <p>Note: Binaries have no raytracing support.</p> <p>Contributors: @Meakk @mwestphal @hlngrandmontagne Paul Lafoix</p> <h2 id="v011"> <a href="#v011" class="anchor-heading" aria-labelledby="v011"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v0.1.1 </h2> <ul> <li>Fixes <code class="language-plaintext highlighter-rouge">--version</code> and <code class="language-plaintext highlighter-rouge">--help</code> crash</li> </ul> <p>Contributors: @Meakk @mwestphal @jpouderoux</p> <h2 id="v010"> <a href="#v010" class="anchor-heading" aria-labelledby="v010"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v0.1.0 </h2> <p>First release!</p> <p>Contributors: @Meakk @mwestphal @jpouderoux</p> </main> </div> </div> <div class="search-overlay"></div> </div> </body> </html>
+<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <link rel="stylesheet" href="/assets/css/just-the-docs-default.css"> <link rel="stylesheet" href="/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet"> <style id="jtd-nav-activation"> .site-nav > ul.nav-list:first-child > li:not(:nth-child(7)) > a, .site-nav > ul.nav-list:first-child > li > ul > li > a, .site-nav > ul.nav-list:first-child > li > ul > li > ul > li > a { background-image: none; } .site-nav > ul.nav-list:not(:first-child) a, .site-nav li.external a { background-image: none; } .site-nav > ul.nav-list:first-child > li:nth-child(7) > a { font-weight: 600; text-decoration: none; }.site-nav > ul.nav-list:first-child > li:nth-child(7) > button svg { transform: rotate(-90deg); }.site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(7) > ul.nav-list { display: block; } </style> <script async src="https://www.googletagmanager.com/gtag/js?id=G-ZCWEYB9KVG"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-ZCWEYB9KVG', { 'anonymize_ip': true }); </script> <script src="/assets/js/vendor/lunr.min.js"></script> <script src="/assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- Begin Jekyll SEO tag v2.8.0 --> <title>Changelog | F3D</title> <meta name="generator" content="Jekyll v3.9.3" /> <meta property="og:title" content="Changelog" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="F3D - Fast and minimalist 3D viewer" /> <meta property="og:description" content="F3D - Fast and minimalist 3D viewer" /> <link rel="canonical" href="https://f3d.app//doc/CHANGELOG.html" /> <meta property="og:url" content="https://f3d.app//doc/CHANGELOG.html" /> <meta property="og:site_name" content="F3D" /> <meta property="og:image" content="https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png" /> <meta property="og:image:height" content="1200" /> <meta property="og:image:width" content="630" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary_large_image" /> <meta property="twitter:image" content="https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png" /> <meta property="twitter:title" content="Changelog" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","description":"F3D - Fast and minimalist 3D viewer","headline":"Changelog","image":{"height":1200,"width":630,"url":"https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png","@type":"imageObject"},"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://f3d.app//resources/logotype.svg"}},"url":"https://f3d.app//doc/CHANGELOG.html"}</script> <!-- End Jekyll SEO tag --> <link rel="shortcut icon" href="https://raw.githubusercontent.com/f3d-app/f3d/master/resources/logo.ico" type="image/x-icon"> </head> <body> <a class="skip-to-main" href="#main-content">Skip to main content</a> <svg xmlns="http://www.w3.org/2000/svg" class="d-none"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE --> <symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link"> <title id="svg-external-link-title">(external link)</title> <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"> <title>Document</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"> <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"> <title>Search</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol> <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md --> <symbol id="svg-copy" viewBox="0 0 16 16"> <title>Copy</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16"> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/> <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/> </svg> </symbol> <symbol id="svg-copied" viewBox="0 0 16 16"> <title>Copied</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16"> <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/> </svg> </symbol> </svg> <div class="side-bar"> <div class="site-header" role="banner"> <a href="/" class="site-title lh-tight"> <div class="site-logo" role="img" aria-label="F3D"></div> </a> <button id="menu-button" class="site-button btn-reset" aria-label="Toggle menu" aria-pressed="false"> <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg> </button> </div> <nav aria-label="Main" id="site-nav" class="site-nav"> <ul class="nav-list"><li class="nav-list-item"><a href="/" class="nav-list-link">Home</a></li><li class="nav-list-item"><a href="/doc/GALLERY.html" class="nav-list-link">Gallery</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in User Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/user/README_USER.html" class="nav-list-link">User Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/user/USAGE.html" class="nav-list-link">Usage</a></li><li class="nav-list-item"><a href="/doc/user/INSTALLATION.html" class="nav-list-link">Installation</a></li><li class="nav-list-item"><a href="/doc/user/OPTIONS.html" class="nav-list-link">Options</a></li><li class="nav-list-item"><a href="/doc/user/INTERACTIONS.html" class="nav-list-link">Interactions</a></li><li class="nav-list-item"><a href="/doc/user/CONFIGURATION_FILE.html" class="nav-list-link">Configuration File</a></li><li class="nav-list-item"><a href="/doc/user/DESKTOP_INTEGRATION.html" class="nav-list-link">Desktop Integration</a></li><li class="nav-list-item"><a href="/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html" class="nav-list-link">Limitations and Troubleshooting</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in libf3d Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/libf3d/README_LIBF3D.html" class="nav-list-link">libf3d Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/libf3d/OVERVIEW.html" class="nav-list-link">Overview</a></li><li class="nav-list-item"><a href="/doc/libf3d/CLASSES.html" class="nav-list-link">Classes Introduction</a></li><li class="nav-list-item"><a href="/doc/libf3d/OPTIONS.html" class="nav-list-link">Options</a></li><li class="nav-list-item"><a href="/doc/libf3d/BINDINGS.html" class="nav-list-link">Bindings</a></li><li class="nav-list-item"><a href="/doc/libf3d/PLUGINS.html" class="nav-list-link">Plugin SDK</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Developer Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/dev/README_DEV.html" class="nav-list-link">Developer Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/dev/GETTING_STARTED.html" class="nav-list-link">Getting Started</a></li><li class="nav-list-item"><a href="/doc/dev/BUILD.html" class="nav-list-link">Build</a></li><li class="nav-list-item"><a href="/doc/dev/TESTING.html" class="nav-list-link">Testing</a></li><li class="nav-list-item"><a href="/CONTRIBUTING.html" class="nav-list-link">Contribute</a></li><li class="nav-list-item"><a href="/doc/dev/GENERATE.html" class="nav-list-link">Generate</a></li><li class="nav-list-item"><a href="/doc/dev/CODING_STYLE.html" class="nav-list-link">Coding Style</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Licenses category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/_licenses.html" class="nav-list-link">Licenses</a><ul class="nav-list"><li class="nav-list-item"><a href="/LICENSE.html" class="nav-list-link">License</a></li><li class="nav-list-item"><a href="/doc/THIRD_PARTY_LICENSES.html" class="nav-list-link">Third Party Licenses</a></li></ul></li><li class="nav-list-item"><a href="/doc/CHANGELOG.html" class="nav-list-link">Changelog</a></li></ul> <ul class="nav-list"><li class="nav-list-item external"> <a href="https://f3d.app/doc/user/INSTALLATION.html" class="nav-list-link external" > Download F3D <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg> </a> </li><li class="nav-list-item external"> <a href="https://github.com/f3d-app/f3d" class="nav-list-link external" > GitHub repository <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg> </a> </li></ul> </nav> <footer class="site-footer"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </footer> </div> <div class="main" id="top"> <div id="main-header" class="main-header"> <div class="search" role="search"> <div class="search-input-wrap"> <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search F3D" aria-label="Search F3D" autocomplete="off"> <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label> </div> <div id="search-results" class="search-results"></div> </div> <nav aria-label="Auxiliary" class="aux-nav"> <ul class="aux-nav-list"> <li class="aux-nav-list-item"> <a href="//github.com/f3d-app/f3d" class="site-button" target="_blank" rel="noopener noreferrer" > <img src="https://user-images.githubusercontent.com/3129530/197903476-11d9c41d-73b0-461f-93e8-c8c00c680e6e.png" width="30px"> </a> </li> </ul> </nav> </div> <div class="main-content-wrap"> <div id="main-content" class="main-content"> <main> <h1 id="changelog"> <a href="#changelog" class="anchor-heading" aria-labelledby="changelog"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Changelog </h1> <h2 id="ongoing-development"> <a href="#ongoing-development" class="anchor-heading" aria-labelledby="ongoing-development"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Ongoing development </h2> <p>For F3D users:</p> <ul> <li>Added <code class="language-plaintext highlighter-rouge">--animation-autoplay</code> option (libf3d: <code class="language-plaintext highlighter-rouge">scene.animation.autoplay</code>) to automatically start animation on file load.</li> <li>Added an experimental VDB reader for .vdb files using OpenVDB</li> <li>Changed <code class="language-plaintext highlighter-rouge">--verbose</code> into a string based option, eg: <code class="language-plaintext highlighter-rouge">--verbose=quiet</code> or <code class="language-plaintext highlighter-rouge">--verbose=debug</code>. <code class="language-plaintext highlighter-rouge">--verbose</code> is still supported.</li> <li>Changed <code class="language-plaintext highlighter-rouge">--no-render</code> behavior so that it doesn’t impact verbosity anymore</li> <li>Deprecated <code class="language-plaintext highlighter-rouge">--quiet</code>, use <code class="language-plaintext highlighter-rouge">--verbose=quiet</code> instead.</li> <li>Reading EXR files is now multi-threaded and much faster.</li> <li>Translucency support is now enabled by default.</li> <li>A small margin is added between the model and the grid to avoid potential z-fighting.</li> <li>Add 3MF and X files support (part of <code class="language-plaintext highlighter-rouge">assimp</code> plugin)</li> <li>Fix potential crashes when reading <code class="language-plaintext highlighter-rouge">assimp</code> plugin file format</li> </ul> <p>For libf3d users:</p> <ul> <li>Added <code class="language-plaintext highlighter-rouge">scene.animation.autoplay</code> option.</li> <li>Added a <code class="language-plaintext highlighter-rouge">f3d::image::saveBuffer</code> API to save an image as a file format in memory.</li> </ul> <p>For F3D packagers:</p> <ul> <li>Added a new optional dependency through VTK, OpenVDB</li> </ul> <h2 id="v221"> <a href="#v221" class="anchor-heading" aria-labelledby="v221"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v2.2.1 </h2> <p>For F3D users:</p> <ul> <li>Added a native Apple Silicon release package</li> <li>Added new options <code class="language-plaintext highlighter-rouge">hdri-file</code>, <code class="language-plaintext highlighter-rouge">hdri-ambient</code>, <code class="language-plaintext highlighter-rouge">hdri-skybox</code> to have more control on the HDRI behavior</li> <li>Added a default HDRI used when providing no <code class="language-plaintext highlighter-rouge">hdri-file</code></li> <li>Added bindings to toggle HDRI ambient lighting (<code class="language-plaintext highlighter-rouge">F</code>) and HDRI skybox (<code class="language-plaintext highlighter-rouge">J</code>)</li> <li>Added bindings to move the camera to standard locations: <code class="language-plaintext highlighter-rouge">1</code>: Front, <code class="language-plaintext highlighter-rouge">3</code>: Right, <code class="language-plaintext highlighter-rouge">7</code>: Top, <code class="language-plaintext highlighter-rouge">9</code>: Isometric</li> <li>Added <a href="https://dev.opencascade.org/doc/overview/html/specification__brep_format.html">Open CASCADE BRep format</a> to the OCCT plugin.</li> <li>Fixed an infamous issue when the Windows thumbnailer always steal the focus</li> <li>Fixed an issue with the binary release when opening draco files</li> <li>Fixed an issue with matcap textures</li> <li>Fixed an issue with HDRI lighting</li> <li>Fixed an issue with HDRI lighting when dropping HDRI after a model</li> <li>Fixed an issue where invalid option would not show on Windows</li> <li>Fixed an issue where previously loaded file would stay visible</li> <li>Fixed an issue when loading invalid EXR file as HDRI</li> <li>Fixed cheatsheet menu rendering under ‘Drop File Instructor’</li> <li>Fixed raytracing rendering issues</li> <li>Improved cheatsheet menu contrast for any background color</li> <li>Improved overall text contrast for any background color</li> <li>Improved performance when changing model and using a HDRI</li> <li>Improved HDRI cache performance</li> <li>Deprecated <code class="language-plaintext highlighter-rouge">hdri</code> option</li> </ul> <p>For libf3d users:</p> <ul> <li>Reworked image API to support many file formats to read (EXR, HDR) and write (PNG, JPG, TIF, BMP)</li> <li>Added <code class="language-plaintext highlighter-rouge">render.hdri.file</code>, <code class="language-plaintext highlighter-rouge">render.hdri.ambient</code>, <code class="language-plaintext highlighter-rouge">render.background.skybox</code> options.</li> <li>Deprecated <code class="language-plaintext highlighter-rouge">render.background.hdri</code> in favor of new options above</li> <li>Deprecated previous image API</li> <li>Add <code class="language-plaintext highlighter-rouge">loader::loadGeometry</code> allowing loading geometry from memory buffers</li> </ul> <p>For developers:</p> <ul> <li>Added a deprecation framework</li> <li>Removed <code class="language-plaintext highlighter-rouge">F3D_TESTING_ENABLE_HDRI_TESTS</code> cmake option and merged it with <code class="language-plaintext highlighter-rouge">F3D_TESTING_ENABLE_LONG_TIMEOUT_TESTS</code></li> <li>Added a Getting Started guide for beginners developers</li> </ul> <p>For F3D packagers:</p> <ul> <li>Fixed compatibility with FreeBSD</li> </ul> <h2 id="v210"> <a href="#v210" class="anchor-heading" aria-labelledby="v210"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v2.1.0 </h2> <p>For F3D users:</p> <ul> <li>Reworked Animation support and added many animation related options</li> <li>Added <code class="language-plaintext highlighter-rouge">--camera-direction</code> and <code class="language-plaintext highlighter-rouge">--camera-zoom-factor</code> and use it in default config file</li> <li>Added <code class="language-plaintext highlighter-rouge">--texture-matcap</code> option to load a MatCap texture</li> <li>Added support for opening HDRI background with Drop</li> <li>Added .exr support for HDRI and textures</li> <li>Improved HDRI caching performance</li> <li>Added a EGL headless binary release</li> <li>Added typo suggestion when failing to use the right option name</li> <li>Added <code class="language-plaintext highlighter-rouge">--invert-zoom</code> option (libf3d: <code class="language-plaintext highlighter-rouge">interactor.invert-zoom</code>) to invert zoom direction with right-click on mouse</li> <li>Added support for keeping camera position when reloading a file with <code class="language-plaintext highlighter-rouge">UP</code> key</li> <li>Added a <code class="language-plaintext highlighter-rouge">--grid-absolute</code> option (libf3d: <code class="language-plaintext highlighter-rouge">render.grid.absolute</code>) to position the grid instead of being below the model</li> <li>Added a “Drop Zone” when starting F3D without loading a file</li> <li>Added coloring support for STEP files in binary release</li> <li>Fixed an issue on Windows where the error window would popup even with <code class="language-plaintext highlighter-rouge">--quiet</code></li> <li>Fixed an issue with 16 bit and 32 bit textures with assimp plugin</li> <li>Fixed an issue on Windows where errors where not visible</li> <li>Fixed an HDRI issue on reload</li> <li>Fixed a crash when with the progress bar on reloading a file</li> <li>Fixed an issue where certain options from config file would be ignored</li> <li>Fixed a crash with many GLTF files when an array does not have a name</li> <li>Fixed an issue where dropping a duplicate file would change the loaded file instead of not doing anything</li> <li>Fixed an issue when loading an unsupported file</li> <li>Fixed an issue with VRML files</li> <li>Improved config file for .ply files</li> <li>Improved config file regex so that they are case-insensitive</li> <li>Improved <code class="language-plaintext highlighter-rouge">--up</code> option to support no sign and better validation</li> <li>Improved F3D version reporting about itself and VTK (<code class="language-plaintext highlighter-rouge">--version</code>)</li> <li>Improved documentation, testing, help</li> <li>Excluded TIFF format from Windows Thumbnailer</li> <li>Changed the automatic camera position to a version more close to the data</li> <li>Reduced size of binary release by a factor of two</li> </ul> <p>For developers:</p> <ul> <li>Added vcpkg support for dependency installation</li> </ul> <p>For F3D packagers:</p> <ul> <li>Added a <code class="language-plaintext highlighter-rouge">F3D_PLUGIN_OCCT_COLORING_SUPPORT</code> CMake variable to control if this feature is compiled, default is ON</li> <li>Added <code class="language-plaintext highlighter-rouge">SONAME</code> support</li> <li>Added a <code class="language-plaintext highlighter-rouge">F3D_PLUGINS_INSTALL_DIR</code> CMake variable to control where to install plugins</li> <li>Added a new module: <code class="language-plaintext highlighter-rouge">F3D_MODULE_EXR</code> that depends on openexr</li> <li>Added support to use external <code class="language-plaintext highlighter-rouge">cxxopts</code> and external <code class="language-plaintext highlighter-rouge">nlohmann-json</code></li> <li>Fixed a link issue with VTK modules</li> <li>Fixed a <code class="language-plaintext highlighter-rouge">@loader_path</code> issue on MacOS</li> <li>Added support for <code class="language-plaintext highlighter-rouge">CMAKE_INSTALL_*DIR</code> variables on installation</li> <li>Added support for building against a EGL enabled VTK</li> <li>Fixed a compilation issue with VTK master</li> </ul> <p>Contributors: @DeveloperPaul123 @topazus @bkmgit @snoyer @Meakk @mwestphal</p> <h2 id="v200"> <a href="#v200" class="anchor-heading" aria-labelledby="v200"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v2.0.0 </h2> <p>For F3D users:</p> <ul> <li>Removed <code class="language-plaintext highlighter-rouge">--fullscreen</code> options completely</li> <li>Added a <code class="language-plaintext highlighter-rouge">--position</code> option to set the position of the F3D window</li> <li>Added a <code class="language-plaintext highlighter-rouge">--light-intensity</code> option and associated bindings</li> <li>Improved fish and zsh completion</li> <li>Added a new interaction to center the camera on the point under the cursor using <em>middle</em> mouse button</li> <li>Added HDRi caching for improved performance</li> <li>Added scene bounding box to the dump interaction</li> <li>Reworked lighting for fullscene format files</li> <li>Improved grid rendering and customization greatly with new options</li> <li>Improved HDRi blur performance and customization</li> <li>Added support for reading config file directory instead of a single file</li> <li>Changed config file location on Windows</li> <li>PostFX option names have been changed</li> <li>Added an interaction (down arrow) to load all files from the directory containing the current file</li> <li>Added a <code class="language-plaintext highlighter-rouge">--group-geometries</code> option to load multiple default scene file into a single render window</li> </ul> <p>For libf3d users:</p> <ul> <li>Reworked loader API from scratch</li> <li>Fixed an issue with engine creation in the Python bindings</li> <li>Fixed an issue with image Python bindings</li> <li>Improved libf3d examples</li> <li>Added experimental javascript bindings based on webassembly/emscriptem</li> <li>Added dynamic support for all <code class="language-plaintext highlighter-rouge">model</code> options</li> <li>Added plugin SDK to create your own plugins for any file format</li> </ul> <p>For F3D packagers:</p> <ul> <li>Added plugins support for true optional dependencies</li> <li>Added a <code class="language-plaintext highlighter-rouge">F3D_APPLICATION_LINK_FILESYSTEM</code> CMake option to control if F3D should link explicitly against libstdc++fs</li> <li>Removed most of <code class="language-plaintext highlighter-rouge">F3D_INSTALL_</code> options with the switch to a component-based approach</li> <li>Removed installation of useless static libs from VTKExtensions (needs VTK master)</li> <li>Fixed RPATH of F3D for system using lib64 instead of lib</li> <li>Many CMake option name changed</li> <li>Fixed data license to use only permissive license for F3D testing data</li> <li>Removed packaging support from F3D</li> </ul> <p>Contributors: @snoyer @mzf-guest @CharlesGueunet @myd7349 @allemangD @Meakk @mwestphal</p> <h2 id="v131"> <a href="#v131" class="anchor-heading" aria-labelledby="v131"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v1.3.1 </h2> <ul> <li>Fix raytracing support</li> <li>Fix macOS window positioning</li> </ul> <p>Contributors: @mwestphal @Meakk</p> <h2 id="v130"> <a href="#v130" class="anchor-heading" aria-labelledby="v130"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v1.3.0 </h2> <p>Main new features and fixes:</p> <ul> <li>Introducing an alpha version of the libf3d, see below for more information</li> <li>Added a –font-file option</li> <li>Added support for Alembic file format (.abc). Geometry only. Thanks a lot @nyue.</li> <li>Fixed many HDRI issues</li> <li>Fixed an important drag and drop issue on linux</li> </ul> <p>Other fixes:</p> <ul> <li>Fixed many doc and UI typos</li> <li>Fixed shell completion</li> <li>Fixed multiple issue with image comparison</li> <li>Fixed an issue with –line-width and –point-size with full scene formats</li> <li>Fixed an issue with translucent object and RGBA texture</li> <li>Fixed issues with a few specific .gltf files</li> <li>Fixed a window title issue on MacOS</li> <li>Fixed multiple issues with the output window on Windows</li> <li>Fixed issues with file association and thumbnails on Windows</li> <li>Fixed a small issue with the cheatsheet not appearing in some cases</li> <li>Fixed an issue with certain .obj files</li> <li>Fixed a clipping issue when setting camera position</li> <li>Removed fullscreen hotkey</li> </ul> <p>For F3D developers:</p> <ul> <li>Updated cxxopts to 3.0.0</li> <li>Now using json.hpp for parsing json config file</li> <li>Better reproducible build support</li> <li>Improved CI with coverage, sanitizer, dedicated actions for dependencies</li> <li>Complete rework of the architecture to separate F3D, the application, the libf3d (see below) and a VTKExtensions layer.</li> <li>Improved unit testing by adding test in the libf3d and VTKExtensions layer</li> </ul> <p>For libf3d users:</p> <ul> <li>Introducing an alpha version of the libf3d!</li> <li>The libf3d is a C++ library to open and render 3D meshes, it is of course used by F3D and supports python bindings</li> <li>More info available in README_libf3d.md</li> </ul> <p>Binary Release Information:</p> <ul> <li>The binary release is <strong>not</strong> built with raytracing support</li> <li>This binary release is built with assimp 5.1.2, animation for assimp formats is not working well</li> </ul> <p>Contributors: @schuhumi @herrriehm @rafcon-dev @mzf-guest @nyue @jpouderoux @Meakk @mwestphal</p> <h2 id="v121"> <a href="#v121" class="anchor-heading" aria-labelledby="v121"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v1.2.1 </h2> <p>Bug fixes and features:</p> <ul> <li>Fixed a build issue on MacOS</li> <li>Fixed a critical issue with the Windows Thumbnailer that could crash explorer.exe</li> <li>Fixed the –quiet option so that it actually quiets VTK errors and warnings</li> <li>Fixed an issue with output window popping up at each log on Windows</li> <li>Added a <code class="language-plaintext highlighter-rouge">.deb</code> package for Linux Debian-based distros</li> </ul> <p>For Packagers:</p> <ul> <li>LFS file have been added in source code release, this seems to be retroactive, so hash of previous releases may have changed</li> <li>Flatpack org name has been fixed</li> </ul> <p>Contributors: @Meakk @mwestphal @jpouderoux</p> <h2 id="v120"> <a href="#v120" class="anchor-heading" aria-labelledby="v120"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v1.2.0 </h2> <p>Main New Features:</p> <ul> <li>Added STEP and IGES file format support thanks to @Open-Cascade-SAS /<a href="https://github.com/Open-Cascade-SAS/OCCT">OCCT</a> (thanks @drtrigon)</li> <li>Added FBX, DAE, OFF, and DXF file format support thanks to @assimp /<a href="https://github.com/assimp/assimp">assimp</a></li> <li>Added thumbnail support with many linux file managers</li> <li>Added thumbnail support on Windows</li> <li>Added desktop environment integration in linux</li> <li>Added scalar and scalar component looping</li> </ul> <p>Other New Features:</p> <ul> <li>Added support for KHR_materials_unlit with glTF files (thanks @spiraloid)</li> <li>Added option for selecting camera <code class="language-plaintext highlighter-rouge">--camera-index</code> (thanks @spiraloid)</li> <li>Added coloring the to Windows error output window</li> <li>Added a man entry on Linux</li> <li>Added a <code class="language-plaintext highlighter-rouge">--config</code> option to select a config file to load instead of using default location</li> <li>Added a <code class="language-plaintext highlighter-rouge">--quiet</code> option</li> <li>Added <code class="language-plaintext highlighter-rouge">--camera-azimuth</code> and <code class="language-plaintext highlighter-rouge">--camera-elevation</code> options (thanks @tatsuya-s)</li> <li>Added a metainfo.xml file (thanks @kevinsmia1939)</li> </ul> <p>Issue Fixes:</p> <ul> <li>Fixed an issue with opening files with accented char in the name on Windows (thanks @shankarsivarajan)</li> <li>Fixed HDRI orientation with –up option (thanks @truhlikfredy)</li> <li>Fixed an issue with point cloud rendering</li> <li>Fixed a crash on exit on Windows</li> <li>Fixed an issue with fullscreen window size on Windows</li> <li>Fixed offscreen rendering (<code class="language-plaintext highlighter-rouge">--output</code> and <code class="language-plaintext highlighter-rouge">--ref</code> ) to actually use offscreen rendering</li> <li>Fixed a memory leak when no rendering is performed (thanks @CharlesGueunet)</li> <li>Fixed a rendering issue with certain GPU drivers</li> <li>Fixed tone mapping with background opacity</li> <li>Fixed non-working drag and drop implementation in VTK (thanks @msbit)</li> <li>Fixed a potential sorting issue when opening a folder</li> <li>Fixed a crash with unsupported glTF files in VTK</li> </ul> <p>For Developers:</p> <ul> <li>Full rework of the CI framework, including coverage report support</li> <li>Full rework of the testing framework</li> <li>Separation of vtkF3DRenderer in two classes</li> <li>Separation of f3d executable into a libf3d library and f3d executable to support windows thumbnails</li> </ul> <p>For Packagers:</p> <ul> <li>New CMake options to select file to install, all documented and starting with F3D_</li> <li>mime types file can be installed, make sure to trigger update-mime-databse</li> <li>desktop file can be installed, make sure to trigger update-desktop-database</li> </ul> <p>Packagers: AndnoVember @jokersus @kevinsmia1939 @yurivict @bcdarwin @mzf-guest @Meakk @mwestphal</p> <p>Binary Release Information:</p> <ul> <li>The binary release is <strong>not</strong> built with raytracing support</li> <li>This binary release is built with assimp 5.1.2, animation for assimp formats is not working well</li> </ul> <p>Contributors: @CharlesGueunet @kevinsmia1939 @mzf-guest @jpouderoux @Meakk @mwestphal</p> <h2 id="v111"> <a href="#v111" class="anchor-heading" aria-labelledby="v111"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v1.1.1 </h2> <p>A patch release dedicated to package managers that makes F3D v1.1 compatible with vtk v9.1.0</p> <ul> <li>Fix a render pass build issue with vtk 9.1.0</li> <li>Fix a renderer build issue with vtk 9.1.0</li> </ul> <p>Contributors: @Meakk @mwestphal</p> <h2 id="v110"> <a href="#v110" class="anchor-heading" aria-labelledby="v110"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v1.1.0 </h2> <p>New Important Features:</p> <ul> <li><strong>Added direct scalars color rendering mode</strong>, see doc.</li> <li><strong>Added a turntable interactor</strong> and made it default. The previous interactor can still be used using a dedicated option. Thanks @orangebowlerhat @filip.sund and @jjomier for your suggestions.</li> <li><strong>Added animation support</strong> for glTF and Exodus files. Press space for playing the animation.</li> <li>Added animation related option, –animation-index, only for glTF when using the full scene.</li> </ul> <p>New Readers and format compatibility features:</p> <ul> <li>Added skinning and morphing support with glTF files.</li> <li>Added TIFF format support. Thanks @proudot for your suggestion.</li> <li>Added exodus format support. Thanks @gvernon for your suggestion.</li> <li>Added support for OBJ with color directly inside of it instead of using a .mtl file. Thanks @Chenge321 for your suggestion.</li> </ul> <p>Quality of life features:</p> <ul> <li>Added a hotkey (UP) to reload current file, thanks @caioaao.</li> <li>Improved Alpha blending performance, thanks @paul.lafoix.</li> <li>Changed the progress bar to a more nice looking one and made it appears only if loading takes time. Thanks @finetjul for the suggestion.</li> <li>Improved logging mechanism with color on all OS and a dedicated output window on windows.</li> <li>Added a warning when using RayTracing but it is not available.</li> </ul> <p>Fixes:</p> <ul> <li>Fixed an issue with skybox and edges.</li> <li>Fixed a crash when an array had no name.</li> <li>Fixed a window naming issue on OSX.</li> <li>Fixed a symlink issue.</li> <li>Fixed a coloring issue with dataset containing only cell data.</li> </ul> <p>Packaging:</p> <ul> <li>Upgraded the AUR f3d package to 1.1.0 : https://aur.archlinux.org/packages/f3d.</li> <li>Added a Brew f3d 1.1.0 package : https://formulae.brew.sh/formula/f3d.</li> <li>FreeBSD now contains a f3d 1.1.0 package, thanks to yuri@freebsd.org.</li> <li>NixOS now contains a f3d package, 1.1.0 should come soon, thanks to bcdarwin@gmail.com.</li> </ul> <p>How to support F3D:</p> <ul> <li>Use the software.</li> <li>Share it with anyone interested.</li> <li>Star us on github: https://github.com/kitware/F3D.</li> </ul> <p>Note: Binaries have no raytracing support.</p> <p>Contributors: @Meakk @mwestphal</p> <h2 id="v101"> <a href="#v101" class="anchor-heading" aria-labelledby="v101"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v1.0.1 </h2> <ul> <li>VisualStudio Runtime is now included into the windows release</li> <li>Ensure VTK compatibility</li> <li>Improve STL binary reader performances</li> <li>Fix default configuration issues</li> <li>Add support for Window icon on all OSes</li> </ul> <p>Note: Binaries have no raytracing support.</p> <p>Contributors: @Meakk @mwestphal</p> <h2 id="v100"> <a href="#v100" class="anchor-heading" aria-labelledby="v100"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v1.0.0 </h2> <ul> <li>Documentation <ul> <li>Online documentation based on Hexo (https://kitware.github.io/F3D/)</li> </ul> </li> <li>Rendering <ul> <li>Add volume rendering for 3D images</li> <li>HDRI support (skyboxes, HDR files, Filmic tone mapping)</li> <li>Point sprites for displaying point clouds</li> <li>Color map customization (default one changed to “inferno”)</li> </ul> </li> <li>Interface <ul> <li>Drag&amp;Drop files support</li> <li>Supports opening of several files (or folder), use left/right arrow to navigate</li> <li>Scalars field handling improvements</li> <li>Cheat Sheet</li> <li>Interactive hotkeys have been reworked</li> <li>File association on Windows and OSX</li> <li>Fullscreen mode</li> <li>No background mode (useful when saving image to a PNG file with alpha channel)</li> </ul> </li> <li>Command line <ul> <li>Camera configuration</li> <li>Metadata (field data) display</li> <li>File name display</li> <li>No render mode (useful to read information in the file)</li> <li>Shell completion (supports bash, zsh, fish)</li> </ul> </li> <li>New readers <ul> <li>CityGML</li> <li>PTS</li> </ul> </li> <li>Packages <ul> <li>Default config provide</li> </ul> </li> </ul> <p>Note: Binaries have no raytracing support.</p> <p>Contributors: @Meakk @mwestphal @hlngrandmontagne Paul Lafoix</p> <h2 id="v011"> <a href="#v011" class="anchor-heading" aria-labelledby="v011"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v0.1.1 </h2> <ul> <li>Fixes <code class="language-plaintext highlighter-rouge">--version</code> and <code class="language-plaintext highlighter-rouge">--help</code> crash</li> </ul> <p>Contributors: @Meakk @mwestphal @jpouderoux</p> <h2 id="v010"> <a href="#v010" class="anchor-heading" aria-labelledby="v010"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> v0.1.0 </h2> <p>First release!</p> <p>Contributors: @Meakk @mwestphal @jpouderoux</p> </main> </div> </div> <div class="search-overlay"></div> </div> </body> </html>
diff --git a/doc/CHANGELOG.md b/doc/CHANGELOG.md
index 1403d8b9a9..451198f33d 100644
--- a/doc/CHANGELOG.md
+++ b/doc/CHANGELOG.md
@@ -11,7 +11,7 @@ For F3D users:
  - Reading EXR files is now multi-threaded and much faster.
  - Translucency support is now enabled by default.
  - A small margin is added between the model and the grid to avoid potential z-fighting.
- - Add X files support (part of `assimp` plugin)
+ - Add 3MF and X files support (part of `assimp` plugin)
  - Fix potential crashes when reading `assimp` plugin file format
 
 For libf3d users:
diff --git a/doc/dev/BUILD.html b/doc/dev/BUILD.html
index 063a363828..bef8ffa492 100644
--- a/doc/dev/BUILD.html
+++ b/doc/dev/BUILD.html
@@ -1,3 +1,3 @@
-<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <link rel="stylesheet" href="/assets/css/just-the-docs-default.css"> <link rel="stylesheet" href="/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet"> <style id="jtd-nav-activation"> .site-nav > ul.nav-list:first-child > li > a, .site-nav > ul.nav-list:first-child > li > ul > li:not(:nth-child(2)) > a, .site-nav > ul.nav-list:first-child > li > ul > li > ul > li > a { background-image: none; } .site-nav > ul.nav-list:not(:first-child) a, .site-nav li.external a { background-image: none; } .site-nav > ul.nav-list:first-child > li:nth-child(5) > ul > li:nth-child(2) > a { font-weight: 600; text-decoration: none; }.site-nav > ul.nav-list:first-child > li:nth-child(5) > button svg, .site-nav > ul.nav-list:first-child > li:nth-child(5) > ul > li:nth-child(2) > button svg { transform: rotate(-90deg); }.site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(5) > ul.nav-list, .site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(5) > ul.nav-list > li.nav-list-item:nth-child(2) > ul.nav-list { display: block; } </style> <script async src="https://www.googletagmanager.com/gtag/js?id=G-ZCWEYB9KVG"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-ZCWEYB9KVG', { 'anonymize_ip': true }); </script> <script src="/assets/js/vendor/lunr.min.js"></script> <script src="/assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- Begin Jekyll SEO tag v2.8.0 --> <title>Build | F3D</title> <meta name="generator" content="Jekyll v3.9.3" /> <meta property="og:title" content="Build" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="F3D - Fast and minimalist 3D viewer" /> <meta property="og:description" content="F3D - Fast and minimalist 3D viewer" /> <link rel="canonical" href="https://f3d.app//doc/dev/BUILD.html" /> <meta property="og:url" content="https://f3d.app//doc/dev/BUILD.html" /> <meta property="og:site_name" content="F3D" /> <meta property="og:image" content="https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png" /> <meta property="og:image:height" content="1200" /> <meta property="og:image:width" content="630" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary_large_image" /> <meta property="twitter:image" content="https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png" /> <meta property="twitter:title" content="Build" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","description":"F3D - Fast and minimalist 3D viewer","headline":"Build","image":{"height":1200,"width":630,"url":"https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png","@type":"imageObject"},"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://f3d.app//resources/logotype.svg"}},"url":"https://f3d.app//doc/dev/BUILD.html"}</script> <!-- End Jekyll SEO tag --> <link rel="shortcut icon" href="https://raw.githubusercontent.com/f3d-app/f3d/master/resources/logo.ico" type="image/x-icon"> </head> <body> <a class="skip-to-main" href="#main-content">Skip to main content</a> <svg xmlns="http://www.w3.org/2000/svg" class="d-none"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE --> <symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link"> <title id="svg-external-link-title">(external link)</title> <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"> <title>Document</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"> <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"> <title>Search</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol> <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md --> <symbol id="svg-copy" viewBox="0 0 16 16"> <title>Copy</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16"> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/> <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/> </svg> </symbol> <symbol id="svg-copied" viewBox="0 0 16 16"> <title>Copied</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16"> <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/> </svg> </symbol> </svg> <div class="side-bar"> <div class="site-header" role="banner"> <a href="/" class="site-title lh-tight"> <div class="site-logo" role="img" aria-label="F3D"></div> </a> <button id="menu-button" class="site-button btn-reset" aria-label="Toggle menu" aria-pressed="false"> <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg> </button> </div> <nav aria-label="Main" id="site-nav" class="site-nav"> <ul class="nav-list"><li class="nav-list-item"><a href="/" class="nav-list-link">Home</a></li><li class="nav-list-item"><a href="/doc/GALLERY.html" class="nav-list-link">Gallery</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in User Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/user/README_USER.html" class="nav-list-link">User Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/user/USAGE.html" class="nav-list-link">Usage</a></li><li class="nav-list-item"><a href="/doc/user/INSTALLATION.html" class="nav-list-link">Installation</a></li><li class="nav-list-item"><a href="/doc/user/OPTIONS.html" class="nav-list-link">Options</a></li><li class="nav-list-item"><a href="/doc/user/INTERACTIONS.html" class="nav-list-link">Interactions</a></li><li class="nav-list-item"><a href="/doc/user/CONFIGURATION_FILE.html" class="nav-list-link">Configuration File</a></li><li class="nav-list-item"><a href="/doc/user/DESKTOP_INTEGRATION.html" class="nav-list-link">Desktop Integration</a></li><li class="nav-list-item"><a href="/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html" class="nav-list-link">Limitations and Troubleshooting</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in libf3d Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/libf3d/README_LIBF3D.html" class="nav-list-link">libf3d Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/libf3d/OVERVIEW.html" class="nav-list-link">Overview</a></li><li class="nav-list-item"><a href="/doc/libf3d/CLASSES.html" class="nav-list-link">Classes Introduction</a></li><li class="nav-list-item"><a href="/doc/libf3d/OPTIONS.html" class="nav-list-link">Options</a></li><li class="nav-list-item"><a href="/doc/libf3d/BINDINGS.html" class="nav-list-link">Bindings</a></li><li class="nav-list-item"><a href="/doc/libf3d/PLUGINS.html" class="nav-list-link">Plugin SDK</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Developer Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/dev/README_DEV.html" class="nav-list-link">Developer Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/dev/GETTING_STARTED.html" class="nav-list-link">Getting Started</a></li><li class="nav-list-item"><a href="/doc/dev/BUILD.html" class="nav-list-link">Build</a></li><li class="nav-list-item"><a href="/doc/dev/TESTING.html" class="nav-list-link">Testing</a></li><li class="nav-list-item"><a href="/CONTRIBUTING.html" class="nav-list-link">Contribute</a></li><li class="nav-list-item"><a href="/doc/dev/GENERATE.html" class="nav-list-link">Generate</a></li><li class="nav-list-item"><a href="/doc/dev/CODING_STYLE.html" class="nav-list-link">Coding Style</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Licenses category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/_licenses.html" class="nav-list-link">Licenses</a><ul class="nav-list"><li class="nav-list-item"><a href="/LICENSE.html" class="nav-list-link">License</a></li><li class="nav-list-item"><a href="/doc/THIRD_PARTY_LICENSES.html" class="nav-list-link">Third Party Licenses</a></li></ul></li><li class="nav-list-item"><a href="/doc/CHANGELOG.html" class="nav-list-link">Changelog</a></li></ul> <ul class="nav-list"><li class="nav-list-item external"> <a href="https://f3d.app/doc/user/INSTALLATION.html" class="nav-list-link external" > Download F3D <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg> </a> </li><li class="nav-list-item external"> <a href="https://github.com/f3d-app/f3d" class="nav-list-link external" > GitHub repository <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg> </a> </li></ul> </nav> <footer class="site-footer"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </footer> </div> <div class="main" id="top"> <div id="main-header" class="main-header"> <div class="search" role="search"> <div class="search-input-wrap"> <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search F3D" aria-label="Search F3D" autocomplete="off"> <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label> </div> <div id="search-results" class="search-results"></div> </div> <nav aria-label="Auxiliary" class="aux-nav"> <ul class="aux-nav-list"> <li class="aux-nav-list-item"> <a href="//github.com/f3d-app/f3d" class="site-button" target="_blank" rel="noopener noreferrer" > <img src="https://user-images.githubusercontent.com/3129530/197903476-11d9c41d-73b0-461f-93e8-c8c00c680e6e.png" width="30px"> </a> </li> </ul> </nav> </div> <div class="main-content-wrap"> <nav aria-label="Breadcrumb" class="breadcrumb-nav"> <ol class="breadcrumb-nav-list"> <li class="breadcrumb-nav-list-item"><a href="/doc/dev/README_DEV.html">Developer Documentation</a></li> <li class="breadcrumb-nav-list-item"><span>Build</span></li> </ol> </nav> <div id="main-content" class="main-content"> <main> <h1 id="build-guide"> <a href="#build-guide" class="anchor-heading" aria-labelledby="build-guide"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Build guide </h1> <p>F3D uses a CMake based build system, so building F3D just requires installing needed dependencies, configuring and building. If you are not used to such processes please take a look at our <a href="/doc/dev/GETTING_STARTED.html">getting started guide</a>.</p> <h2 id="dependencies"> <a href="#dependencies" class="anchor-heading" aria-labelledby="dependencies"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Dependencies </h2> <ul> <li><a href="https://cmake.org">CMake</a> &gt;= 3.1.</li> <li><a href="https://vtk.org">VTK</a> &gt;= 9.0.0 (9.2.6 recommended).</li> <li>A C++17 compiler.</li> <li>A CMake-compatible build system (Visual Studio, XCode, Ninja, Make, etc.).</li> <li>Optionally, <a href="https://www.assimp.org/">Assimp</a> &gt;= 5.0.</li> <li>Optionally, Open CASCADE <a href="https://dev.opencascade.org/">OCCT</a> &gt;= 7.5.2.</li> <li>Optionally, <a href="http://www.alembic.io/">Alembic</a> &gt;= 1.7.</li> <li>Optionally, <a href="https://openusd.org/release/index.html">OpenUSD</a> &gt;= 23.05.</li> <li>Optionally, <a href="https://www.openvdb.org/download/">OpenVDB</a> &gt;= 10.0.0, enable <code class="language-plaintext highlighter-rouge">IOOpenVDB</code> VTK module.</li> <li>Optionally, <a href="https://google.github.io/draco/">Draco</a> &gt;= 1.5.</li> <li>Optionally, <a href="https://www.python.org/">Python</a> &gt;= 3.6 and <a href="https://github.com/pybind/pybind11">pybind11</a> &gt;= 2.2.</li> <li>Optionally, <a href="https://www.java.com">Java</a> &gt;= 18.</li> <li>Optionally, <a href="https://openexr.com/en/latest/">OpenEXR</a> &gt;= 3.0.</li> </ul> <h2 id="vtk-compatibility"> <a href="#vtk-compatibility" class="anchor-heading" aria-labelledby="vtk-compatibility"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> VTK compatibility </h2> <p>As stated in the dependencies, F3D is compatible with VTK &gt;= 9.0.0, however, many features are only available in certain conditions. We suggest using VTK 9.2.6 with RenderingRayTracing, RenderingExternal, IOExodus and IOOpenVDB modules enabled in order to get as many features as possible in F3D.</p> <h2 id="configuration-and-building"> <a href="#configuration-and-building" class="anchor-heading" aria-labelledby="configuration-and-building"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Configuration and building </h2> <p>Configure and generate the project with CMake, then build the software using your build system.</p> <p>Here is some CMake options of interest:</p> <ul> <li><code class="language-plaintext highlighter-rouge">F3D_BUILD_APPLICATION</code>: Build the F3D executable.</li> <li><code class="language-plaintext highlighter-rouge">BUILD_TESTING</code>: Enable the <a href="/doc/dev/TESTING.html">tests</a>.</li> <li><code class="language-plaintext highlighter-rouge">F3D_MACOS_BUNDLE</code>: On macOS, build a <code class="language-plaintext highlighter-rouge">.app</code> bundle.</li> <li><code class="language-plaintext highlighter-rouge">F3D_WINDOWS_GUI</code>: On Windows, build a Win32 application (without console).</li> <li><code class="language-plaintext highlighter-rouge">F3D_WINDOWS_BUILD_SHELL_THUMBNAILS_EXTENSION</code>: On Windows, build the shell thumbnails extension.</li> <li><code class="language-plaintext highlighter-rouge">F3D_PLUGINS_STATIC_BUILD</code>: Build all plugins as static library (embedded into <code class="language-plaintext highlighter-rouge">libf3d</code>) and automatically loaded by the application. Incompatible with <code class="language-plaintext highlighter-rouge">F3D_MACOS_BUNDLE</code>.</li> </ul> <p>Some modules, plugins and bindings depending on external libraries can be optionally enabled with the following CMake variables:</p> <ul> <li><code class="language-plaintext highlighter-rouge">F3D_MODULE_RAYTRACING</code>: Support for raytracing rendering. Requires that VTK has been built with <code class="language-plaintext highlighter-rouge">OSPRay</code> and <code class="language-plaintext highlighter-rouge">VTK_MODULE_ENABLE_VTK_RenderingRayTracing</code> turned on. Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_MODULE_EXTERNAL_RENDERING</code>: Support for external render window. Requires that VTK has been built with <code class="language-plaintext highlighter-rouge">VTK_MODULE_ENABLE_VTK_RenderingExternal</code> turned on. Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_MODULE_EXR</code>: Support for OpenEXR images. Requires <code class="language-plaintext highlighter-rouge">OpenEXR</code>. Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_PLUGIN_BUILD_EXODUS</code>: Support for ExodusII (.ex2) file format. Requires that VTK has been built with <code class="language-plaintext highlighter-rouge">IOExodus</code> module (and <code class="language-plaintext highlighter-rouge">hdf5</code>). Enabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_PLUGIN_BUILD_OCCT</code>: Support for STEP, IGES and BREP file formats. Requires <code class="language-plaintext highlighter-rouge">OpenCASCADE</code>. Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_PLUGIN_BUILD_ASSIMP</code>: Support for FBX, DAE, OFF, DXF and X file formats. Requires <code class="language-plaintext highlighter-rouge">Assimp</code>. Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_PLUGIN_BUILD_ALEMBIC</code>: Support for ABC file format. Requires <code class="language-plaintext highlighter-rouge">Alembic</code>. Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_PLUGIN_BUILD_DRACO</code>: Support for DRC file format. Requires <code class="language-plaintext highlighter-rouge">Draco</code>. Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_PLUGIN_BUILD_USD</code>: Support for USD file format. Requires <code class="language-plaintext highlighter-rouge">OpenUSD</code>. Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_PLUGIN_BUILD_VDB</code>: Support for VDB file format. Requires that VTK has been built with <code class="language-plaintext highlighter-rouge">IOOpenVDB</code> module (and <code class="language-plaintext highlighter-rouge">OpenVDB</code>). Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_BINDINGS_PYTHON</code>: Generate python bindings (requires <code class="language-plaintext highlighter-rouge">Python</code> and <code class="language-plaintext highlighter-rouge">pybind11</code>). Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_BINDINGS_JAVA</code>: Generate java bindings (requires <code class="language-plaintext highlighter-rouge">Java</code> and <code class="language-plaintext highlighter-rouge">JNI</code>). Disabled by default.</li> </ul> <h2 id="vcpkg"> <a href="#vcpkg" class="anchor-heading" aria-labelledby="vcpkg"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> VCPKG </h2> <p>It’s possible to use VCPKG to automatically build dependencies. A manifest file <code class="language-plaintext highlighter-rouge">vcpkg.json</code> is available at your convenience. Please read <a href="https://vcpkg.io/en/getting-started.html">VCPKG documentation</a>.<br /> Basically, just install VCPKG, and configure F3D using <code class="language-plaintext highlighter-rouge">-DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake</code> option.</p> <h2 id="installing"> <a href="#installing" class="anchor-heading" aria-labelledby="installing"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Installing </h2> <p>Installation can be done through CMake, by running the following command:</p> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>cmake --install ${your_build_dir}
+<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <link rel="stylesheet" href="/assets/css/just-the-docs-default.css"> <link rel="stylesheet" href="/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet"> <style id="jtd-nav-activation"> .site-nav > ul.nav-list:first-child > li > a, .site-nav > ul.nav-list:first-child > li > ul > li:not(:nth-child(2)) > a, .site-nav > ul.nav-list:first-child > li > ul > li > ul > li > a { background-image: none; } .site-nav > ul.nav-list:not(:first-child) a, .site-nav li.external a { background-image: none; } .site-nav > ul.nav-list:first-child > li:nth-child(5) > ul > li:nth-child(2) > a { font-weight: 600; text-decoration: none; }.site-nav > ul.nav-list:first-child > li:nth-child(5) > button svg, .site-nav > ul.nav-list:first-child > li:nth-child(5) > ul > li:nth-child(2) > button svg { transform: rotate(-90deg); }.site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(5) > ul.nav-list, .site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(5) > ul.nav-list > li.nav-list-item:nth-child(2) > ul.nav-list { display: block; } </style> <script async src="https://www.googletagmanager.com/gtag/js?id=G-ZCWEYB9KVG"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-ZCWEYB9KVG', { 'anonymize_ip': true }); </script> <script src="/assets/js/vendor/lunr.min.js"></script> <script src="/assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- Begin Jekyll SEO tag v2.8.0 --> <title>Build | F3D</title> <meta name="generator" content="Jekyll v3.9.3" /> <meta property="og:title" content="Build" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="F3D - Fast and minimalist 3D viewer" /> <meta property="og:description" content="F3D - Fast and minimalist 3D viewer" /> <link rel="canonical" href="https://f3d.app//doc/dev/BUILD.html" /> <meta property="og:url" content="https://f3d.app//doc/dev/BUILD.html" /> <meta property="og:site_name" content="F3D" /> <meta property="og:image" content="https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png" /> <meta property="og:image:height" content="1200" /> <meta property="og:image:width" content="630" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary_large_image" /> <meta property="twitter:image" content="https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png" /> <meta property="twitter:title" content="Build" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","description":"F3D - Fast and minimalist 3D viewer","headline":"Build","image":{"height":1200,"width":630,"url":"https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png","@type":"imageObject"},"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://f3d.app//resources/logotype.svg"}},"url":"https://f3d.app//doc/dev/BUILD.html"}</script> <!-- End Jekyll SEO tag --> <link rel="shortcut icon" href="https://raw.githubusercontent.com/f3d-app/f3d/master/resources/logo.ico" type="image/x-icon"> </head> <body> <a class="skip-to-main" href="#main-content">Skip to main content</a> <svg xmlns="http://www.w3.org/2000/svg" class="d-none"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE --> <symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link"> <title id="svg-external-link-title">(external link)</title> <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"> <title>Document</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"> <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"> <title>Search</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol> <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md --> <symbol id="svg-copy" viewBox="0 0 16 16"> <title>Copy</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16"> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/> <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/> </svg> </symbol> <symbol id="svg-copied" viewBox="0 0 16 16"> <title>Copied</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16"> <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/> </svg> </symbol> </svg> <div class="side-bar"> <div class="site-header" role="banner"> <a href="/" class="site-title lh-tight"> <div class="site-logo" role="img" aria-label="F3D"></div> </a> <button id="menu-button" class="site-button btn-reset" aria-label="Toggle menu" aria-pressed="false"> <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg> </button> </div> <nav aria-label="Main" id="site-nav" class="site-nav"> <ul class="nav-list"><li class="nav-list-item"><a href="/" class="nav-list-link">Home</a></li><li class="nav-list-item"><a href="/doc/GALLERY.html" class="nav-list-link">Gallery</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in User Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/user/README_USER.html" class="nav-list-link">User Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/user/USAGE.html" class="nav-list-link">Usage</a></li><li class="nav-list-item"><a href="/doc/user/INSTALLATION.html" class="nav-list-link">Installation</a></li><li class="nav-list-item"><a href="/doc/user/OPTIONS.html" class="nav-list-link">Options</a></li><li class="nav-list-item"><a href="/doc/user/INTERACTIONS.html" class="nav-list-link">Interactions</a></li><li class="nav-list-item"><a href="/doc/user/CONFIGURATION_FILE.html" class="nav-list-link">Configuration File</a></li><li class="nav-list-item"><a href="/doc/user/DESKTOP_INTEGRATION.html" class="nav-list-link">Desktop Integration</a></li><li class="nav-list-item"><a href="/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html" class="nav-list-link">Limitations and Troubleshooting</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in libf3d Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/libf3d/README_LIBF3D.html" class="nav-list-link">libf3d Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/libf3d/OVERVIEW.html" class="nav-list-link">Overview</a></li><li class="nav-list-item"><a href="/doc/libf3d/CLASSES.html" class="nav-list-link">Classes Introduction</a></li><li class="nav-list-item"><a href="/doc/libf3d/OPTIONS.html" class="nav-list-link">Options</a></li><li class="nav-list-item"><a href="/doc/libf3d/BINDINGS.html" class="nav-list-link">Bindings</a></li><li class="nav-list-item"><a href="/doc/libf3d/PLUGINS.html" class="nav-list-link">Plugin SDK</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Developer Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/dev/README_DEV.html" class="nav-list-link">Developer Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/dev/GETTING_STARTED.html" class="nav-list-link">Getting Started</a></li><li class="nav-list-item"><a href="/doc/dev/BUILD.html" class="nav-list-link">Build</a></li><li class="nav-list-item"><a href="/doc/dev/TESTING.html" class="nav-list-link">Testing</a></li><li class="nav-list-item"><a href="/CONTRIBUTING.html" class="nav-list-link">Contribute</a></li><li class="nav-list-item"><a href="/doc/dev/GENERATE.html" class="nav-list-link">Generate</a></li><li class="nav-list-item"><a href="/doc/dev/CODING_STYLE.html" class="nav-list-link">Coding Style</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Licenses category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/_licenses.html" class="nav-list-link">Licenses</a><ul class="nav-list"><li class="nav-list-item"><a href="/LICENSE.html" class="nav-list-link">License</a></li><li class="nav-list-item"><a href="/doc/THIRD_PARTY_LICENSES.html" class="nav-list-link">Third Party Licenses</a></li></ul></li><li class="nav-list-item"><a href="/doc/CHANGELOG.html" class="nav-list-link">Changelog</a></li></ul> <ul class="nav-list"><li class="nav-list-item external"> <a href="https://f3d.app/doc/user/INSTALLATION.html" class="nav-list-link external" > Download F3D <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg> </a> </li><li class="nav-list-item external"> <a href="https://github.com/f3d-app/f3d" class="nav-list-link external" > GitHub repository <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg> </a> </li></ul> </nav> <footer class="site-footer"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </footer> </div> <div class="main" id="top"> <div id="main-header" class="main-header"> <div class="search" role="search"> <div class="search-input-wrap"> <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search F3D" aria-label="Search F3D" autocomplete="off"> <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label> </div> <div id="search-results" class="search-results"></div> </div> <nav aria-label="Auxiliary" class="aux-nav"> <ul class="aux-nav-list"> <li class="aux-nav-list-item"> <a href="//github.com/f3d-app/f3d" class="site-button" target="_blank" rel="noopener noreferrer" > <img src="https://user-images.githubusercontent.com/3129530/197903476-11d9c41d-73b0-461f-93e8-c8c00c680e6e.png" width="30px"> </a> </li> </ul> </nav> </div> <div class="main-content-wrap"> <nav aria-label="Breadcrumb" class="breadcrumb-nav"> <ol class="breadcrumb-nav-list"> <li class="breadcrumb-nav-list-item"><a href="/doc/dev/README_DEV.html">Developer Documentation</a></li> <li class="breadcrumb-nav-list-item"><span>Build</span></li> </ol> </nav> <div id="main-content" class="main-content"> <main> <h1 id="build-guide"> <a href="#build-guide" class="anchor-heading" aria-labelledby="build-guide"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Build guide </h1> <p>F3D uses a CMake based build system, so building F3D just requires installing needed dependencies, configuring and building. If you are not used to such processes please take a look at our <a href="/doc/dev/GETTING_STARTED.html">getting started guide</a>.</p> <h2 id="dependencies"> <a href="#dependencies" class="anchor-heading" aria-labelledby="dependencies"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Dependencies </h2> <ul> <li><a href="https://cmake.org">CMake</a> &gt;= 3.1.</li> <li><a href="https://vtk.org">VTK</a> &gt;= 9.0.0 (9.2.6 recommended).</li> <li>A C++17 compiler.</li> <li>A CMake-compatible build system (Visual Studio, XCode, Ninja, Make, etc.).</li> <li>Optionally, <a href="https://www.assimp.org/">Assimp</a> &gt;= 5.0.</li> <li>Optionally, Open CASCADE <a href="https://dev.opencascade.org/">OCCT</a> &gt;= 7.5.2.</li> <li>Optionally, <a href="http://www.alembic.io/">Alembic</a> &gt;= 1.7.</li> <li>Optionally, <a href="https://openusd.org/release/index.html">OpenUSD</a> &gt;= 23.05.</li> <li>Optionally, <a href="https://www.openvdb.org/download/">OpenVDB</a> &gt;= 10.0.0, enable <code class="language-plaintext highlighter-rouge">IOOpenVDB</code> VTK module.</li> <li>Optionally, <a href="https://google.github.io/draco/">Draco</a> &gt;= 1.5.</li> <li>Optionally, <a href="https://www.python.org/">Python</a> &gt;= 3.6 and <a href="https://github.com/pybind/pybind11">pybind11</a> &gt;= 2.2.</li> <li>Optionally, <a href="https://www.java.com">Java</a> &gt;= 18.</li> <li>Optionally, <a href="https://openexr.com/en/latest/">OpenEXR</a> &gt;= 3.0.</li> </ul> <h2 id="vtk-compatibility"> <a href="#vtk-compatibility" class="anchor-heading" aria-labelledby="vtk-compatibility"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> VTK compatibility </h2> <p>As stated in the dependencies, F3D is compatible with VTK &gt;= 9.0.0, however, many features are only available in certain conditions. We suggest using VTK 9.2.6 with RenderingRayTracing, RenderingExternal, IOExodus and IOOpenVDB modules enabled in order to get as many features as possible in F3D.</p> <h2 id="configuration-and-building"> <a href="#configuration-and-building" class="anchor-heading" aria-labelledby="configuration-and-building"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Configuration and building </h2> <p>Configure and generate the project with CMake, then build the software using your build system.</p> <p>Here is some CMake options of interest:</p> <ul> <li><code class="language-plaintext highlighter-rouge">F3D_BUILD_APPLICATION</code>: Build the F3D executable.</li> <li><code class="language-plaintext highlighter-rouge">BUILD_TESTING</code>: Enable the <a href="/doc/dev/TESTING.html">tests</a>.</li> <li><code class="language-plaintext highlighter-rouge">F3D_MACOS_BUNDLE</code>: On macOS, build a <code class="language-plaintext highlighter-rouge">.app</code> bundle.</li> <li><code class="language-plaintext highlighter-rouge">F3D_WINDOWS_GUI</code>: On Windows, build a Win32 application (without console).</li> <li><code class="language-plaintext highlighter-rouge">F3D_WINDOWS_BUILD_SHELL_THUMBNAILS_EXTENSION</code>: On Windows, build the shell thumbnails extension.</li> <li><code class="language-plaintext highlighter-rouge">F3D_PLUGINS_STATIC_BUILD</code>: Build all plugins as static library (embedded into <code class="language-plaintext highlighter-rouge">libf3d</code>) and automatically loaded by the application. Incompatible with <code class="language-plaintext highlighter-rouge">F3D_MACOS_BUNDLE</code>.</li> </ul> <p>Some modules, plugins and bindings depending on external libraries can be optionally enabled with the following CMake variables:</p> <ul> <li><code class="language-plaintext highlighter-rouge">F3D_MODULE_RAYTRACING</code>: Support for raytracing rendering. Requires that VTK has been built with <code class="language-plaintext highlighter-rouge">OSPRay</code> and <code class="language-plaintext highlighter-rouge">VTK_MODULE_ENABLE_VTK_RenderingRayTracing</code> turned on. Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_MODULE_EXTERNAL_RENDERING</code>: Support for external render window. Requires that VTK has been built with <code class="language-plaintext highlighter-rouge">VTK_MODULE_ENABLE_VTK_RenderingExternal</code> turned on. Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_MODULE_EXR</code>: Support for OpenEXR images. Requires <code class="language-plaintext highlighter-rouge">OpenEXR</code>. Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_PLUGIN_BUILD_EXODUS</code>: Support for ExodusII (.ex2) file format. Requires that VTK has been built with <code class="language-plaintext highlighter-rouge">IOExodus</code> module (and <code class="language-plaintext highlighter-rouge">hdf5</code>). Enabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_PLUGIN_BUILD_OCCT</code>: Support for STEP, IGES and BREP file formats. Requires <code class="language-plaintext highlighter-rouge">OpenCASCADE</code>. Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_PLUGIN_BUILD_ASSIMP</code>: Support for FBX, DAE, OFF, DXF, X and 3MF file formats. Requires <code class="language-plaintext highlighter-rouge">Assimp</code>. Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_PLUGIN_BUILD_ALEMBIC</code>: Support for ABC file format. Requires <code class="language-plaintext highlighter-rouge">Alembic</code>. Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_PLUGIN_BUILD_DRACO</code>: Support for DRC file format. Requires <code class="language-plaintext highlighter-rouge">Draco</code>. Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_PLUGIN_BUILD_USD</code>: Support for USD file format. Requires <code class="language-plaintext highlighter-rouge">OpenUSD</code>. Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_PLUGIN_BUILD_VDB</code>: Support for VDB file format. Requires that VTK has been built with <code class="language-plaintext highlighter-rouge">IOOpenVDB</code> module (and <code class="language-plaintext highlighter-rouge">OpenVDB</code>). Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_BINDINGS_PYTHON</code>: Generate python bindings (requires <code class="language-plaintext highlighter-rouge">Python</code> and <code class="language-plaintext highlighter-rouge">pybind11</code>). Disabled by default.</li> <li><code class="language-plaintext highlighter-rouge">F3D_BINDINGS_JAVA</code>: Generate java bindings (requires <code class="language-plaintext highlighter-rouge">Java</code> and <code class="language-plaintext highlighter-rouge">JNI</code>). Disabled by default.</li> </ul> <h2 id="vcpkg"> <a href="#vcpkg" class="anchor-heading" aria-labelledby="vcpkg"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> VCPKG </h2> <p>It’s possible to use VCPKG to automatically build dependencies. A manifest file <code class="language-plaintext highlighter-rouge">vcpkg.json</code> is available at your convenience. Please read <a href="https://vcpkg.io/en/getting-started.html">VCPKG documentation</a>.<br /> Basically, just install VCPKG, and configure F3D using <code class="language-plaintext highlighter-rouge">-DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake</code> option.</p> <h2 id="installing"> <a href="#installing" class="anchor-heading" aria-labelledby="installing"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Installing </h2> <p>Installation can be done through CMake, by running the following command:</p> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>cmake --install ${your_build_dir}
 </code></pre></div></div> <p>Individual components can also be installed by specifying the component name:</p> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>cmake --install ${your_build_dir} --component ${component_name}
 </code></pre></div></div> <p>Here is the list of all the components:</p> <div class="table-wrapper"><table> <thead> <tr> <th>Name</th> <th>Installed by default</th> <th>Operating system</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code class="language-plaintext highlighter-rouge">application</code></td> <td>YES</td> <td>ALL</td> <td>F3D application</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">configuration</code></td> <td>NO</td> <td>ALL</td> <td>Default configuration files, <code class="language-plaintext highlighter-rouge">config</code> and <code class="language-plaintext highlighter-rouge">thumbnail</code>.</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">library</code></td> <td>YES</td> <td>ALL</td> <td>libf3d library binaries</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">plugin</code></td> <td>YES</td> <td>ALL</td> <td>libf3d plugins</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">dependencies</code></td> <td>NO</td> <td>ALL</td> <td>libf3d runtime dependencies. Can be used to create a self-contained and relocatable package. System libraries are excluded.</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">sdk</code></td> <td>NO</td> <td>ALL</td> <td>libf3d SDK (headers and CMake config files)</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">licenses</code></td> <td>YES</td> <td>ALL</td> <td>F3D and third party licenses</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">documentation</code></td> <td>YES</td> <td>Linux</td> <td><code class="language-plaintext highlighter-rouge">man</code> documentation</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">shellext</code></td> <td>YES</td> <td>Windows/Linux</td> <td>Desktop integration</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">python</code></td> <td>YES</td> <td>ALL</td> <td>Python bindings</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">java</code></td> <td>YES</td> <td>ALL</td> <td>Java bindings</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">mimetypes</code></td> <td>NO</td> <td>Linux</td> <td>Plugins mimetype XML files for integration with Freedesktop</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">assets</code></td> <td>YES</td> <td>Linux</td> <td>Assets for integration with Freedesktop</td> </tr> </tbody> </table></div> </main> </div> </div> <div class="search-overlay"></div> </div> </body> </html>
diff --git a/doc/dev/BUILD.md b/doc/dev/BUILD.md
index fe27673c0c..2f94abdb68 100644
--- a/doc/dev/BUILD.md
+++ b/doc/dev/BUILD.md
@@ -44,7 +44,7 @@ Some modules, plugins and bindings depending on external libraries can be option
 * `F3D_MODULE_EXR`: Support for OpenEXR images. Requires `OpenEXR`. Disabled by default.
 * `F3D_PLUGIN_BUILD_EXODUS`: Support for ExodusII (.ex2) file format. Requires that VTK has been built with `IOExodus` module (and `hdf5`). Enabled by default.
 * `F3D_PLUGIN_BUILD_OCCT`: Support for STEP, IGES and BREP file formats. Requires `OpenCASCADE`. Disabled by default.
-* `F3D_PLUGIN_BUILD_ASSIMP`: Support for FBX, DAE, OFF, DXF and X file formats. Requires `Assimp`. Disabled by default.
+* `F3D_PLUGIN_BUILD_ASSIMP`: Support for FBX, DAE, OFF, DXF, X and 3MF file formats. Requires `Assimp`. Disabled by default.
 * `F3D_PLUGIN_BUILD_ALEMBIC`: Support for ABC file format. Requires `Alembic`. Disabled by default.
 * `F3D_PLUGIN_BUILD_DRACO`: Support for DRC file format. Requires `Draco`. Disabled by default.
 * `F3D_PLUGIN_BUILD_USD`: Support for USD file format. Requires `OpenUSD`. Disabled by default.
diff --git a/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html b/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html
index 49cca63102..537dd60c49 100644
--- a/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html
+++ b/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <link rel="stylesheet" href="/assets/css/just-the-docs-default.css"> <link rel="stylesheet" href="/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet"> <style id="jtd-nav-activation"> .site-nav > ul.nav-list:first-child > li > a, .site-nav > ul.nav-list:first-child > li > ul > li:not(:nth-child(7)) > a, .site-nav > ul.nav-list:first-child > li > ul > li > ul > li > a { background-image: none; } .site-nav > ul.nav-list:not(:first-child) a, .site-nav li.external a { background-image: none; } .site-nav > ul.nav-list:first-child > li:nth-child(3) > ul > li:nth-child(7) > a { font-weight: 600; text-decoration: none; }.site-nav > ul.nav-list:first-child > li:nth-child(3) > button svg, .site-nav > ul.nav-list:first-child > li:nth-child(3) > ul > li:nth-child(7) > button svg { transform: rotate(-90deg); }.site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(3) > ul.nav-list, .site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(3) > ul.nav-list > li.nav-list-item:nth-child(7) > ul.nav-list { display: block; } </style> <script async src="https://www.googletagmanager.com/gtag/js?id=G-ZCWEYB9KVG"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-ZCWEYB9KVG', { 'anonymize_ip': true }); </script> <script src="/assets/js/vendor/lunr.min.js"></script> <script src="/assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- Begin Jekyll SEO tag v2.8.0 --> <title>Limitations and Troubleshooting | F3D</title> <meta name="generator" content="Jekyll v3.9.3" /> <meta property="og:title" content="Limitations and Troubleshooting" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="F3D - Fast and minimalist 3D viewer" /> <meta property="og:description" content="F3D - Fast and minimalist 3D viewer" /> <link rel="canonical" href="https://f3d.app//doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html" /> <meta property="og:url" content="https://f3d.app//doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html" /> <meta property="og:site_name" content="F3D" /> <meta property="og:image" content="https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png" /> <meta property="og:image:height" content="1200" /> <meta property="og:image:width" content="630" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary_large_image" /> <meta property="twitter:image" content="https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png" /> <meta property="twitter:title" content="Limitations and Troubleshooting" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","description":"F3D - Fast and minimalist 3D viewer","headline":"Limitations and Troubleshooting","image":{"height":1200,"width":630,"url":"https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png","@type":"imageObject"},"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://f3d.app//resources/logotype.svg"}},"url":"https://f3d.app//doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html"}</script> <!-- End Jekyll SEO tag --> <link rel="shortcut icon" href="https://raw.githubusercontent.com/f3d-app/f3d/master/resources/logo.ico" type="image/x-icon"> </head> <body> <a class="skip-to-main" href="#main-content">Skip to main content</a> <svg xmlns="http://www.w3.org/2000/svg" class="d-none"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE --> <symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link"> <title id="svg-external-link-title">(external link)</title> <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"> <title>Document</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"> <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"> <title>Search</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol> <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md --> <symbol id="svg-copy" viewBox="0 0 16 16"> <title>Copy</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16"> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/> <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/> </svg> </symbol> <symbol id="svg-copied" viewBox="0 0 16 16"> <title>Copied</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16"> <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/> </svg> </symbol> </svg> <div class="side-bar"> <div class="site-header" role="banner"> <a href="/" class="site-title lh-tight"> <div class="site-logo" role="img" aria-label="F3D"></div> </a> <button id="menu-button" class="site-button btn-reset" aria-label="Toggle menu" aria-pressed="false"> <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg> </button> </div> <nav aria-label="Main" id="site-nav" class="site-nav"> <ul class="nav-list"><li class="nav-list-item"><a href="/" class="nav-list-link">Home</a></li><li class="nav-list-item"><a href="/doc/GALLERY.html" class="nav-list-link">Gallery</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in User Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/user/README_USER.html" class="nav-list-link">User Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/user/USAGE.html" class="nav-list-link">Usage</a></li><li class="nav-list-item"><a href="/doc/user/INSTALLATION.html" class="nav-list-link">Installation</a></li><li class="nav-list-item"><a href="/doc/user/OPTIONS.html" class="nav-list-link">Options</a></li><li class="nav-list-item"><a href="/doc/user/INTERACTIONS.html" class="nav-list-link">Interactions</a></li><li class="nav-list-item"><a href="/doc/user/CONFIGURATION_FILE.html" class="nav-list-link">Configuration File</a></li><li class="nav-list-item"><a href="/doc/user/DESKTOP_INTEGRATION.html" class="nav-list-link">Desktop Integration</a></li><li class="nav-list-item"><a href="/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html" class="nav-list-link">Limitations and Troubleshooting</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in libf3d Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/libf3d/README_LIBF3D.html" class="nav-list-link">libf3d Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/libf3d/OVERVIEW.html" class="nav-list-link">Overview</a></li><li class="nav-list-item"><a href="/doc/libf3d/CLASSES.html" class="nav-list-link">Classes Introduction</a></li><li class="nav-list-item"><a href="/doc/libf3d/OPTIONS.html" class="nav-list-link">Options</a></li><li class="nav-list-item"><a href="/doc/libf3d/BINDINGS.html" class="nav-list-link">Bindings</a></li><li class="nav-list-item"><a href="/doc/libf3d/PLUGINS.html" class="nav-list-link">Plugin SDK</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Developer Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/dev/README_DEV.html" class="nav-list-link">Developer Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/dev/GETTING_STARTED.html" class="nav-list-link">Getting Started</a></li><li class="nav-list-item"><a href="/doc/dev/BUILD.html" class="nav-list-link">Build</a></li><li class="nav-list-item"><a href="/doc/dev/TESTING.html" class="nav-list-link">Testing</a></li><li class="nav-list-item"><a href="/CONTRIBUTING.html" class="nav-list-link">Contribute</a></li><li class="nav-list-item"><a href="/doc/dev/GENERATE.html" class="nav-list-link">Generate</a></li><li class="nav-list-item"><a href="/doc/dev/CODING_STYLE.html" class="nav-list-link">Coding Style</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Licenses category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/_licenses.html" class="nav-list-link">Licenses</a><ul class="nav-list"><li class="nav-list-item"><a href="/LICENSE.html" class="nav-list-link">License</a></li><li class="nav-list-item"><a href="/doc/THIRD_PARTY_LICENSES.html" class="nav-list-link">Third Party Licenses</a></li></ul></li><li class="nav-list-item"><a href="/doc/CHANGELOG.html" class="nav-list-link">Changelog</a></li></ul> <ul class="nav-list"><li class="nav-list-item external"> <a href="https://f3d.app/doc/user/INSTALLATION.html" class="nav-list-link external" > Download F3D <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg> </a> </li><li class="nav-list-item external"> <a href="https://github.com/f3d-app/f3d" class="nav-list-link external" > GitHub repository <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg> </a> </li></ul> </nav> <footer class="site-footer"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </footer> </div> <div class="main" id="top"> <div id="main-header" class="main-header"> <div class="search" role="search"> <div class="search-input-wrap"> <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search F3D" aria-label="Search F3D" autocomplete="off"> <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label> </div> <div id="search-results" class="search-results"></div> </div> <nav aria-label="Auxiliary" class="aux-nav"> <ul class="aux-nav-list"> <li class="aux-nav-list-item"> <a href="//github.com/f3d-app/f3d" class="site-button" target="_blank" rel="noopener noreferrer" > <img src="https://user-images.githubusercontent.com/3129530/197903476-11d9c41d-73b0-461f-93e8-c8c00c680e6e.png" width="30px"> </a> </li> </ul> </nav> </div> <div class="main-content-wrap"> <nav aria-label="Breadcrumb" class="breadcrumb-nav"> <ol class="breadcrumb-nav-list"> <li class="breadcrumb-nav-list-item"><a href="/doc/user/README_USER.html">User Documentation</a></li> <li class="breadcrumb-nav-list-item"><span>Limitations and Troubleshooting</span></li> </ol> </nav> <div id="main-content" class="main-content"> <main> <h1 id="limitations"> <a href="#limitations" class="anchor-heading" aria-labelledby="limitations"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Limitations </h1> <p>Here is a non exhaustive list of F3D limitations:</p> <ul> <li>No support for specifying manual lighting in the default scene apart from using <code class="language-plaintext highlighter-rouge">--light-intensity</code> option.</li> <li>Multiblock (.vtm, .gml) support is partial, non-surfacic data will be converted into surfaces.</li> <li>Animation support with full scene data format require VTK &gt;= 9.0.20201016.</li> <li>Full drag and drop support require VTK &gt;= 9.0.20210620</li> <li>Drag and drop interaction cannot be recorded nor played back.</li> <li>Volume rendering and HDRI support requires a decent GPU.</li> <li>The <code class="language-plaintext highlighter-rouge">--camera-zoom-factor</code> option require VTK &gt;= 9.3.0</li> </ul> <h2 id="assimp"> <a href="#assimp" class="anchor-heading" aria-labelledby="assimp"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Assimp </h2> <p>FBX, DAE, OFF, DXF and X file formats rely on <a href="https://github.com/assimp/assimp">Assimp</a> library. It comes with some known limitations:</p> <ul> <li>PBR materials are not supported for FBX file format.</li> <li>Complex animations are not working very well with Assimp 5.1, it’s recommended to use Assimp 5.0 for this use case.</li> <li>Only one animation can be shown at a time, showing all animations is not supported yet.</li> <li>Some files can be empty, crash, or show artifacts.</li> <li>DXF support is very limited: only files with polylines and 3D faces are displayed.</li> </ul> <h2 id="alembic"> <a href="#alembic" class="anchor-heading" aria-labelledby="alembic"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Alembic </h2> <p>ABC file formats rely on <a href="https://github.com/alembic/alembic">Alembic</a> library. It comes with some known limitations:</p> <ul> <li>Supports only simple polygonal geometry.</li> <li>Does not support ArbGeomParam feature in Alembic.</li> <li>Does not support Subdivision Meshes.</li> <li>Does not support Materials.</li> <li>Does not support Animations.</li> </ul> <h2 id="usd"> <a href="#usd" class="anchor-heading" aria-labelledby="usd"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> USD </h2> <p>USD file formats rely on <a href="https://github.com/PixarAnimationStudios/OpenUSD">OpenUSD</a> library. It comes with some known limitations:</p> <ul> <li>Skinning is slow and baked on the CPU.</li> <li>Does not support Face-varying attributes.</li> <li>The <code class="language-plaintext highlighter-rouge">usd</code> plugin is not shipped in the python wheels yet.</li> </ul> <h2 id="vdb"> <a href="#vdb" class="anchor-heading" aria-labelledby="vdb"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> VDB </h2> <p>VDB file formats rely on <a href="https://github.com/AcademySoftwareFoundation/openvdb">OpenVDB</a> and VTK libraries. It currently comes with some known limitations:</p> <ul> <li>VDB Grid files are opened with a hard-coded 0.1 sampling rate.</li> <li>The <code class="language-plaintext highlighter-rouge">vdb</code> plugin is not shipped in the python wheels yet.</li> </ul> <h1 id="troubleshooting"> <a href="#troubleshooting" class="anchor-heading" aria-labelledby="troubleshooting"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Troubleshooting </h1> <h2 id="general"> <a href="#general" class="anchor-heading" aria-labelledby="general"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> General </h2> <blockquote> <p>I have built F3D with raytracing support but the denoiser is not working.</p> </blockquote> <p>Make sure that VTK has been built with <em>OpenImageDenoise</em> support (<code class="language-plaintext highlighter-rouge">VTKOSPRAY_ENABLE_DENOISER</code> option).</p> <blockquote> <p>My model shows up all wrong, with inverted surfaces everywhere.</p> </blockquote> <p>Your data probably contains some translucent data for some reason, turn on translucency support by pressing <code class="language-plaintext highlighter-rouge">P</code> or using the <code class="language-plaintext highlighter-rouge">-p</code> command line option.</p> <h2 id="linux"> <a href="#linux" class="anchor-heading" aria-labelledby="linux"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Linux </h2> <blockquote> <p>I have a link error related to <code class="language-plaintext highlighter-rouge">stdc++fs</code> not found.</p> </blockquote> <p>With some C++ STD library version, explicit linking to <code class="language-plaintext highlighter-rouge">stdc++fs</code> is not supported. We provide a CMake option <code class="language-plaintext highlighter-rouge">F3D_LINUX_APPLICATION_LINK_FILESYSTEM</code> that you can set to <code class="language-plaintext highlighter-rouge">OFF</code> to workaround this issue.</p> <blockquote> <p>I have a link error related to undefined reference to symbol of <code class="language-plaintext highlighter-rouge">libatomic</code>.</p> </blockquote> <p>The GCC flag <code class="language-plaintext highlighter-rouge">-latomic</code> is not being added automatically with specific architectures, like <code class="language-plaintext highlighter-rouge">armel</code> and <code class="language-plaintext highlighter-rouge">RISCV64</code>. We provide a CMake option <code class="language-plaintext highlighter-rouge">F3D_LINUX_LIBRARY_LINK_ATOMIC</code> that you can set to <code class="language-plaintext highlighter-rouge">ON</code> to workaround this issue.</p> <blockquote> <p>Thumbnails are not working in my file manager.</p> </blockquote> <ul> <li>Check that your file manager supports the thumbnailer mechanism.</li> <li>Check that you have updated your mime type database.</li> <li>If all fails, remove your <code class="language-plaintext highlighter-rouge">.cache</code> user dir and check that <code class="language-plaintext highlighter-rouge">pcmanfm</code> thumbnails are working.</li> <li>If they are working, then it is an issue specific to your file manager (see below for a potential work around).</li> <li>If only a few format have working thumbnails, then it is an issue with the mime types database.</li> <li>If no formats have working thumbnails, then it is an issue with the <code class="language-plaintext highlighter-rouge">f3d-plugin-xxx.thumbnailer</code> files.</li> <li>If only big file do not have thumbnails, this is intended, you can modify this behavior in the <code class="language-plaintext highlighter-rouge">thumbnail.d/10_global.json</code> configuration folder using the <code class="language-plaintext highlighter-rouge">max-size</code> option.</li> </ul> <p>Some file managers (eg: Nautilus) are using sandboxing for thumbnails, which the F3D standard binary release does not support as it needs access to the Xorg server to render anything. In that case, you want to use the headless version of F3D that rely on EGL instead of Xorg, available in the <a href="https://github.com/f3d-app/f3d/releases">releases page</a>. If you use the portable archive, make sure to extract it somewhere the sandboxing system has access to, eg: Nautilus uses <code class="language-plaintext highlighter-rouge">bwrap</code> and gives it access to <code class="language-plaintext highlighter-rouge">/usr</code> but not to <code class="language-plaintext highlighter-rouge">/opt</code>.</p> <h2 id="windows"> <a href="#windows" class="anchor-heading" aria-labelledby="windows"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Windows </h2> <blockquote> <p>Using the portable binary release, I’m unable to run F3D because Windows warns about a security risk</p> </blockquote> <p>F3D is not signed by Microsoft yet so Windows shows this warning. Just click on the “more” button to be able to run F3D.</p> <blockquote> <p>After installing F3D or registering the shell extension, my explorer is broken.</p> </blockquote> <p>Unregister the shell extension by running:</p> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>cd C:\path\to\f3d\bin\
+<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <link rel="stylesheet" href="/assets/css/just-the-docs-default.css"> <link rel="stylesheet" href="/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet"> <style id="jtd-nav-activation"> .site-nav > ul.nav-list:first-child > li > a, .site-nav > ul.nav-list:first-child > li > ul > li:not(:nth-child(7)) > a, .site-nav > ul.nav-list:first-child > li > ul > li > ul > li > a { background-image: none; } .site-nav > ul.nav-list:not(:first-child) a, .site-nav li.external a { background-image: none; } .site-nav > ul.nav-list:first-child > li:nth-child(3) > ul > li:nth-child(7) > a { font-weight: 600; text-decoration: none; }.site-nav > ul.nav-list:first-child > li:nth-child(3) > button svg, .site-nav > ul.nav-list:first-child > li:nth-child(3) > ul > li:nth-child(7) > button svg { transform: rotate(-90deg); }.site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(3) > ul.nav-list, .site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(3) > ul.nav-list > li.nav-list-item:nth-child(7) > ul.nav-list { display: block; } </style> <script async src="https://www.googletagmanager.com/gtag/js?id=G-ZCWEYB9KVG"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-ZCWEYB9KVG', { 'anonymize_ip': true }); </script> <script src="/assets/js/vendor/lunr.min.js"></script> <script src="/assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- Begin Jekyll SEO tag v2.8.0 --> <title>Limitations and Troubleshooting | F3D</title> <meta name="generator" content="Jekyll v3.9.3" /> <meta property="og:title" content="Limitations and Troubleshooting" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="F3D - Fast and minimalist 3D viewer" /> <meta property="og:description" content="F3D - Fast and minimalist 3D viewer" /> <link rel="canonical" href="https://f3d.app//doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html" /> <meta property="og:url" content="https://f3d.app//doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html" /> <meta property="og:site_name" content="F3D" /> <meta property="og:image" content="https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png" /> <meta property="og:image:height" content="1200" /> <meta property="og:image:width" content="630" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary_large_image" /> <meta property="twitter:image" content="https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png" /> <meta property="twitter:title" content="Limitations and Troubleshooting" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","description":"F3D - Fast and minimalist 3D viewer","headline":"Limitations and Troubleshooting","image":{"height":1200,"width":630,"url":"https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png","@type":"imageObject"},"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://f3d.app//resources/logotype.svg"}},"url":"https://f3d.app//doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html"}</script> <!-- End Jekyll SEO tag --> <link rel="shortcut icon" href="https://raw.githubusercontent.com/f3d-app/f3d/master/resources/logo.ico" type="image/x-icon"> </head> <body> <a class="skip-to-main" href="#main-content">Skip to main content</a> <svg xmlns="http://www.w3.org/2000/svg" class="d-none"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE --> <symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link"> <title id="svg-external-link-title">(external link)</title> <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"> <title>Document</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"> <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"> <title>Search</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol> <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md --> <symbol id="svg-copy" viewBox="0 0 16 16"> <title>Copy</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16"> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/> <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/> </svg> </symbol> <symbol id="svg-copied" viewBox="0 0 16 16"> <title>Copied</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16"> <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/> </svg> </symbol> </svg> <div class="side-bar"> <div class="site-header" role="banner"> <a href="/" class="site-title lh-tight"> <div class="site-logo" role="img" aria-label="F3D"></div> </a> <button id="menu-button" class="site-button btn-reset" aria-label="Toggle menu" aria-pressed="false"> <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg> </button> </div> <nav aria-label="Main" id="site-nav" class="site-nav"> <ul class="nav-list"><li class="nav-list-item"><a href="/" class="nav-list-link">Home</a></li><li class="nav-list-item"><a href="/doc/GALLERY.html" class="nav-list-link">Gallery</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in User Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/user/README_USER.html" class="nav-list-link">User Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/user/USAGE.html" class="nav-list-link">Usage</a></li><li class="nav-list-item"><a href="/doc/user/INSTALLATION.html" class="nav-list-link">Installation</a></li><li class="nav-list-item"><a href="/doc/user/OPTIONS.html" class="nav-list-link">Options</a></li><li class="nav-list-item"><a href="/doc/user/INTERACTIONS.html" class="nav-list-link">Interactions</a></li><li class="nav-list-item"><a href="/doc/user/CONFIGURATION_FILE.html" class="nav-list-link">Configuration File</a></li><li class="nav-list-item"><a href="/doc/user/DESKTOP_INTEGRATION.html" class="nav-list-link">Desktop Integration</a></li><li class="nav-list-item"><a href="/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html" class="nav-list-link">Limitations and Troubleshooting</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in libf3d Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/libf3d/README_LIBF3D.html" class="nav-list-link">libf3d Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/libf3d/OVERVIEW.html" class="nav-list-link">Overview</a></li><li class="nav-list-item"><a href="/doc/libf3d/CLASSES.html" class="nav-list-link">Classes Introduction</a></li><li class="nav-list-item"><a href="/doc/libf3d/OPTIONS.html" class="nav-list-link">Options</a></li><li class="nav-list-item"><a href="/doc/libf3d/BINDINGS.html" class="nav-list-link">Bindings</a></li><li class="nav-list-item"><a href="/doc/libf3d/PLUGINS.html" class="nav-list-link">Plugin SDK</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Developer Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/dev/README_DEV.html" class="nav-list-link">Developer Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/dev/GETTING_STARTED.html" class="nav-list-link">Getting Started</a></li><li class="nav-list-item"><a href="/doc/dev/BUILD.html" class="nav-list-link">Build</a></li><li class="nav-list-item"><a href="/doc/dev/TESTING.html" class="nav-list-link">Testing</a></li><li class="nav-list-item"><a href="/CONTRIBUTING.html" class="nav-list-link">Contribute</a></li><li class="nav-list-item"><a href="/doc/dev/GENERATE.html" class="nav-list-link">Generate</a></li><li class="nav-list-item"><a href="/doc/dev/CODING_STYLE.html" class="nav-list-link">Coding Style</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Licenses category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/_licenses.html" class="nav-list-link">Licenses</a><ul class="nav-list"><li class="nav-list-item"><a href="/LICENSE.html" class="nav-list-link">License</a></li><li class="nav-list-item"><a href="/doc/THIRD_PARTY_LICENSES.html" class="nav-list-link">Third Party Licenses</a></li></ul></li><li class="nav-list-item"><a href="/doc/CHANGELOG.html" class="nav-list-link">Changelog</a></li></ul> <ul class="nav-list"><li class="nav-list-item external"> <a href="https://f3d.app/doc/user/INSTALLATION.html" class="nav-list-link external" > Download F3D <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg> </a> </li><li class="nav-list-item external"> <a href="https://github.com/f3d-app/f3d" class="nav-list-link external" > GitHub repository <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg> </a> </li></ul> </nav> <footer class="site-footer"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </footer> </div> <div class="main" id="top"> <div id="main-header" class="main-header"> <div class="search" role="search"> <div class="search-input-wrap"> <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search F3D" aria-label="Search F3D" autocomplete="off"> <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label> </div> <div id="search-results" class="search-results"></div> </div> <nav aria-label="Auxiliary" class="aux-nav"> <ul class="aux-nav-list"> <li class="aux-nav-list-item"> <a href="//github.com/f3d-app/f3d" class="site-button" target="_blank" rel="noopener noreferrer" > <img src="https://user-images.githubusercontent.com/3129530/197903476-11d9c41d-73b0-461f-93e8-c8c00c680e6e.png" width="30px"> </a> </li> </ul> </nav> </div> <div class="main-content-wrap"> <nav aria-label="Breadcrumb" class="breadcrumb-nav"> <ol class="breadcrumb-nav-list"> <li class="breadcrumb-nav-list-item"><a href="/doc/user/README_USER.html">User Documentation</a></li> <li class="breadcrumb-nav-list-item"><span>Limitations and Troubleshooting</span></li> </ol> </nav> <div id="main-content" class="main-content"> <main> <h1 id="limitations"> <a href="#limitations" class="anchor-heading" aria-labelledby="limitations"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Limitations </h1> <p>Here is a non exhaustive list of F3D limitations:</p> <ul> <li>No support for specifying manual lighting in the default scene apart from using <code class="language-plaintext highlighter-rouge">--light-intensity</code> option.</li> <li>Multiblock (.vtm, .gml) support is partial, non-surfacic data will be converted into surfaces.</li> <li>Animation support with full scene data format require VTK &gt;= 9.0.20201016.</li> <li>Full drag and drop support require VTK &gt;= 9.0.20210620</li> <li>Drag and drop interaction cannot be recorded nor played back.</li> <li>Volume rendering and HDRI support requires a decent GPU.</li> <li>The <code class="language-plaintext highlighter-rouge">--camera-zoom-factor</code> option require VTK &gt;= 9.3.0</li> </ul> <h2 id="assimp"> <a href="#assimp" class="anchor-heading" aria-labelledby="assimp"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Assimp </h2> <p>FBX, DAE, OFF, DXF, X and 3MF file formats rely on <a href="https://github.com/assimp/assimp">Assimp</a> library. It comes with some known limitations:</p> <ul> <li>PBR materials are not supported for FBX file format.</li> <li>Complex animations are not working very well with Assimp 5.1, it’s recommended to use Assimp 5.0 for this use case.</li> <li>Only one animation can be shown at a time, showing all animations is not supported yet.</li> <li>Some files can be empty, crash, or show artifacts.</li> <li>DXF support is very limited: only files with polylines and 3D faces are displayed.</li> <li>3MF files may crash at exit (issue in Assimp: https://github.com/assimp/assimp/issues/5328)</li> <li>Only support RBGA 8-bits embedded textures</li> </ul> <h2 id="alembic"> <a href="#alembic" class="anchor-heading" aria-labelledby="alembic"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Alembic </h2> <p>ABC file formats rely on <a href="https://github.com/alembic/alembic">Alembic</a> library. It comes with some known limitations:</p> <ul> <li>Supports only simple polygonal geometry.</li> <li>Does not support ArbGeomParam feature in Alembic.</li> <li>Does not support Subdivision Meshes.</li> <li>Does not support Materials.</li> <li>Does not support Animations.</li> </ul> <h2 id="usd"> <a href="#usd" class="anchor-heading" aria-labelledby="usd"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> USD </h2> <p>USD file formats rely on <a href="https://github.com/PixarAnimationStudios/OpenUSD">OpenUSD</a> library. It comes with some known limitations:</p> <ul> <li>Skinning is slow and baked on the CPU.</li> <li>Does not support Face-varying attributes.</li> <li>The <code class="language-plaintext highlighter-rouge">usd</code> plugin is not shipped in the python wheels yet.</li> </ul> <h2 id="vdb"> <a href="#vdb" class="anchor-heading" aria-labelledby="vdb"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> VDB </h2> <p>VDB file formats rely on <a href="https://github.com/AcademySoftwareFoundation/openvdb">OpenVDB</a> and VTK libraries. It currently comes with some known limitations:</p> <ul> <li>VDB Grid files are opened with a hard-coded 0.1 sampling rate.</li> <li>The <code class="language-plaintext highlighter-rouge">vdb</code> plugin is not shipped in the python wheels yet.</li> </ul> <h1 id="troubleshooting"> <a href="#troubleshooting" class="anchor-heading" aria-labelledby="troubleshooting"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Troubleshooting </h1> <h2 id="general"> <a href="#general" class="anchor-heading" aria-labelledby="general"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> General </h2> <blockquote> <p>I have built F3D with raytracing support but the denoiser is not working.</p> </blockquote> <p>Make sure that VTK has been built with <em>OpenImageDenoise</em> support (<code class="language-plaintext highlighter-rouge">VTKOSPRAY_ENABLE_DENOISER</code> option).</p> <blockquote> <p>My model shows up all wrong, with inverted surfaces everywhere.</p> </blockquote> <p>Your data probably contains some translucent data for some reason, turn on translucency support by pressing <code class="language-plaintext highlighter-rouge">P</code> or using the <code class="language-plaintext highlighter-rouge">-p</code> command line option.</p> <h2 id="linux"> <a href="#linux" class="anchor-heading" aria-labelledby="linux"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Linux </h2> <blockquote> <p>I have a link error related to <code class="language-plaintext highlighter-rouge">stdc++fs</code> not found.</p> </blockquote> <p>With some C++ STD library version, explicit linking to <code class="language-plaintext highlighter-rouge">stdc++fs</code> is not supported. We provide a CMake option <code class="language-plaintext highlighter-rouge">F3D_LINUX_APPLICATION_LINK_FILESYSTEM</code> that you can set to <code class="language-plaintext highlighter-rouge">OFF</code> to workaround this issue.</p> <blockquote> <p>I have a link error related to undefined reference to symbol of <code class="language-plaintext highlighter-rouge">libatomic</code>.</p> </blockquote> <p>The GCC flag <code class="language-plaintext highlighter-rouge">-latomic</code> is not being added automatically with specific architectures, like <code class="language-plaintext highlighter-rouge">armel</code> and <code class="language-plaintext highlighter-rouge">RISCV64</code>. We provide a CMake option <code class="language-plaintext highlighter-rouge">F3D_LINUX_LIBRARY_LINK_ATOMIC</code> that you can set to <code class="language-plaintext highlighter-rouge">ON</code> to workaround this issue.</p> <blockquote> <p>Thumbnails are not working in my file manager.</p> </blockquote> <ul> <li>Check that your file manager supports the thumbnailer mechanism.</li> <li>Check that you have updated your mime type database.</li> <li>If all fails, remove your <code class="language-plaintext highlighter-rouge">.cache</code> user dir and check that <code class="language-plaintext highlighter-rouge">pcmanfm</code> thumbnails are working.</li> <li>If they are working, then it is an issue specific to your file manager (see below for a potential work around).</li> <li>If only a few format have working thumbnails, then it is an issue with the mime types database.</li> <li>If no formats have working thumbnails, then it is an issue with the <code class="language-plaintext highlighter-rouge">f3d-plugin-xxx.thumbnailer</code> files.</li> <li>If only big file do not have thumbnails, this is intended, you can modify this behavior in the <code class="language-plaintext highlighter-rouge">thumbnail.d/10_global.json</code> configuration folder using the <code class="language-plaintext highlighter-rouge">max-size</code> option.</li> </ul> <p>Some file managers (eg: Nautilus) are using sandboxing for thumbnails, which the F3D standard binary release does not support as it needs access to the Xorg server to render anything. In that case, you want to use the headless version of F3D that rely on EGL instead of Xorg, available in the <a href="https://github.com/f3d-app/f3d/releases">releases page</a>. If you use the portable archive, make sure to extract it somewhere the sandboxing system has access to, eg: Nautilus uses <code class="language-plaintext highlighter-rouge">bwrap</code> and gives it access to <code class="language-plaintext highlighter-rouge">/usr</code> but not to <code class="language-plaintext highlighter-rouge">/opt</code>.</p> <h2 id="windows"> <a href="#windows" class="anchor-heading" aria-labelledby="windows"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Windows </h2> <blockquote> <p>Using the portable binary release, I’m unable to run F3D because Windows warns about a security risk</p> </blockquote> <p>F3D is not signed by Microsoft yet so Windows shows this warning. Just click on the “more” button to be able to run F3D.</p> <blockquote> <p>After installing F3D or registering the shell extension, my explorer is broken.</p> </blockquote> <p>Unregister the shell extension by running:</p> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>cd C:\path\to\f3d\bin\
 regsvr32 /u F3DShellExtension.dll
 </code></pre></div></div> <blockquote> <p>I use F3D in a VM, the application fails to launch.</p> </blockquote> <p>OpenGL applications like F3D can have issues when launched from Windows Server or from a guest Windows because the access to the GPU is restricted. You can try to use a software implementation of OpenGL, called <a href="https://github.com/pal1000/mesa-dist-win/releases">Mesa</a>.</p> <ul> <li>Download the latest <code class="language-plaintext highlighter-rouge">release-msvc</code>.</li> <li>copy <code class="language-plaintext highlighter-rouge">x64/opengl32.dll</code>, <code class="language-plaintext highlighter-rouge">libgallium_wgl.dll</code> and <code class="language-plaintext highlighter-rouge">x64/libglapi.dll</code> in the same folder as <code class="language-plaintext highlighter-rouge">f3d.exe</code>.</li> <li>set the environment variable <code class="language-plaintext highlighter-rouge">MESA_GL_VERSION_OVERRIDE</code> to 4.5.</li> <li>run <code class="language-plaintext highlighter-rouge">f3d.exe</code>.</li> </ul> <blockquote> <p>I run f3d from the command prompt and my Unicode characters are not displayed properly.</p> </blockquote> <p>Set the codepage to UTF-8, run <code class="language-plaintext highlighter-rouge">chcp 65001</code>.</p> <blockquote> <p>When I install F3D, I can’t add F3D to the path and the installer complains that: <code class="language-plaintext highlighter-rouge">PATH too long installer unable to modify PATH!</code>.</p> </blockquote> <p>There are too many entry in your PATH environment variable, remove the ones you do not use.</p> <blockquote> <p>When I try to update F3D, the installer fails with: <code class="language-plaintext highlighter-rouge">Error opening file for writing: F3DShellExtension.dll</code></p> </blockquote> <p>Your previous F3D installation is current being used to generate thumbnails, wait for a bit or reboot your computer before updating again.</p> <h2 id="macos"> <a href="#macos" class="anchor-heading" aria-labelledby="macos"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> macOS </h2> <blockquote> <p>I’m unable to use the binary release, macOS complains the file is invalid or corrupted</p> </blockquote> <p>Our macOS binary package are not signed, to work around this, you can simply run the following command:</p> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>xattr -cr /Applications/F3D.app
 </code></pre></div></div> <p>Then F3D should work as expected.</p> <blockquote> <p>Using the silicon binary release, I cannot find the raytracing feature or open exodus files</p> </blockquote> <p>F3D raytracing and exodus plugin are not working on macOS silicon yet, see this <a href="https://github.com/f3d-app/f3d/issues/976">issue</a>.</p> <blockquote> <p>I’m unable to get coloring right with step files</p> </blockquote> <p>F3D on macOS does not support coloring on cells because of a <a href="https://gitlab.kitware.com/vtk/vtk/-/issues/18969">VTK issue</a>.</p> <h2 id="python"> <a href="#python" class="anchor-heading" aria-labelledby="python"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Python </h2> <blockquote> <p>I can’t find <code class="language-plaintext highlighter-rouge">usd</code> and <code class="language-plaintext highlighter-rouge">vdb</code> plugins after installing f3d with pip</p> </blockquote> <p>The <code class="language-plaintext highlighter-rouge">usd</code> and <code class="language-plaintext highlighter-rouge">vdb</code> plugins are not shipped in the python wheels for now, you can compile F3D yourself with them though.</p> <blockquote> <p>Raytracing does not work after installing f3d with pip</p> </blockquote> <p>F3D raytracing feature is not shipped in the python wheels for now, you can compile F3D yourself with it though.</p> </main> </div> </div> <div class="search-overlay"></div> </div> </body> </html>
diff --git a/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.md b/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.md
index ca5dacdf70..afd71c108c 100644
--- a/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.md
+++ b/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.md
@@ -11,12 +11,14 @@ Here is a non exhaustive list of F3D limitations:
 * The `--camera-zoom-factor` option require VTK >= 9.3.0
 
 ## Assimp
-FBX, DAE, OFF, DXF and X file formats rely on [Assimp](https://github.com/assimp/assimp) library. It comes with some known limitations:
+FBX, DAE, OFF, DXF, X and 3MF file formats rely on [Assimp](https://github.com/assimp/assimp) library. It comes with some known limitations:
 - PBR materials are not supported for FBX file format.
 - Complex animations are not working very well with Assimp 5.1, it's recommended to use Assimp 5.0 for this use case.
 - Only one animation can be shown at a time, showing all animations is not supported yet.
 - Some files can be empty, crash, or show artifacts.
 - DXF support is very limited: only files with polylines and 3D faces are displayed.
+- 3MF files may crash at exit (issue in Assimp: https://github.com/assimp/assimp/issues/5328)
+- Only support RBGA 8-bits embedded textures
 
 ## Alembic
 ABC file formats rely on [Alembic](https://github.com/alembic/alembic) library. It comes with some known limitations:
diff --git a/doc/user/USAGE.html b/doc/user/USAGE.html
index 4dfadf22e6..32f869370a 100644
--- a/doc/user/USAGE.html
+++ b/doc/user/USAGE.html
@@ -1 +1 @@
-<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <link rel="stylesheet" href="/assets/css/just-the-docs-default.css"> <link rel="stylesheet" href="/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet"> <style id="jtd-nav-activation"> .site-nav > ul.nav-list:first-child > li > a, .site-nav > ul.nav-list:first-child > li > ul > li:not(:nth-child(1)) > a, .site-nav > ul.nav-list:first-child > li > ul > li > ul > li > a { background-image: none; } .site-nav > ul.nav-list:not(:first-child) a, .site-nav li.external a { background-image: none; } .site-nav > ul.nav-list:first-child > li:nth-child(3) > ul > li:nth-child(1) > a { font-weight: 600; text-decoration: none; }.site-nav > ul.nav-list:first-child > li:nth-child(3) > button svg, .site-nav > ul.nav-list:first-child > li:nth-child(3) > ul > li:nth-child(1) > button svg { transform: rotate(-90deg); }.site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(3) > ul.nav-list, .site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(3) > ul.nav-list > li.nav-list-item:nth-child(1) > ul.nav-list { display: block; } </style> <script async src="https://www.googletagmanager.com/gtag/js?id=G-ZCWEYB9KVG"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-ZCWEYB9KVG', { 'anonymize_ip': true }); </script> <script src="/assets/js/vendor/lunr.min.js"></script> <script src="/assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- Begin Jekyll SEO tag v2.8.0 --> <title>Usage | F3D</title> <meta name="generator" content="Jekyll v3.9.3" /> <meta property="og:title" content="Usage" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="F3D - Fast and minimalist 3D viewer" /> <meta property="og:description" content="F3D - Fast and minimalist 3D viewer" /> <link rel="canonical" href="https://f3d.app//doc/user/USAGE.html" /> <meta property="og:url" content="https://f3d.app//doc/user/USAGE.html" /> <meta property="og:site_name" content="F3D" /> <meta property="og:image" content="https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png" /> <meta property="og:image:height" content="1200" /> <meta property="og:image:width" content="630" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary_large_image" /> <meta property="twitter:image" content="https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png" /> <meta property="twitter:title" content="Usage" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","description":"F3D - Fast and minimalist 3D viewer","headline":"Usage","image":{"height":1200,"width":630,"url":"https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png","@type":"imageObject"},"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://f3d.app//resources/logotype.svg"}},"url":"https://f3d.app//doc/user/USAGE.html"}</script> <!-- End Jekyll SEO tag --> <link rel="shortcut icon" href="https://raw.githubusercontent.com/f3d-app/f3d/master/resources/logo.ico" type="image/x-icon"> </head> <body> <a class="skip-to-main" href="#main-content">Skip to main content</a> <svg xmlns="http://www.w3.org/2000/svg" class="d-none"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE --> <symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link"> <title id="svg-external-link-title">(external link)</title> <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"> <title>Document</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"> <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"> <title>Search</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol> <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md --> <symbol id="svg-copy" viewBox="0 0 16 16"> <title>Copy</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16"> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/> <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/> </svg> </symbol> <symbol id="svg-copied" viewBox="0 0 16 16"> <title>Copied</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16"> <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/> </svg> </symbol> </svg> <div class="side-bar"> <div class="site-header" role="banner"> <a href="/" class="site-title lh-tight"> <div class="site-logo" role="img" aria-label="F3D"></div> </a> <button id="menu-button" class="site-button btn-reset" aria-label="Toggle menu" aria-pressed="false"> <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg> </button> </div> <nav aria-label="Main" id="site-nav" class="site-nav"> <ul class="nav-list"><li class="nav-list-item"><a href="/" class="nav-list-link">Home</a></li><li class="nav-list-item"><a href="/doc/GALLERY.html" class="nav-list-link">Gallery</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in User Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/user/README_USER.html" class="nav-list-link">User Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/user/USAGE.html" class="nav-list-link">Usage</a></li><li class="nav-list-item"><a href="/doc/user/INSTALLATION.html" class="nav-list-link">Installation</a></li><li class="nav-list-item"><a href="/doc/user/OPTIONS.html" class="nav-list-link">Options</a></li><li class="nav-list-item"><a href="/doc/user/INTERACTIONS.html" class="nav-list-link">Interactions</a></li><li class="nav-list-item"><a href="/doc/user/CONFIGURATION_FILE.html" class="nav-list-link">Configuration File</a></li><li class="nav-list-item"><a href="/doc/user/DESKTOP_INTEGRATION.html" class="nav-list-link">Desktop Integration</a></li><li class="nav-list-item"><a href="/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html" class="nav-list-link">Limitations and Troubleshooting</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in libf3d Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/libf3d/README_LIBF3D.html" class="nav-list-link">libf3d Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/libf3d/OVERVIEW.html" class="nav-list-link">Overview</a></li><li class="nav-list-item"><a href="/doc/libf3d/CLASSES.html" class="nav-list-link">Classes Introduction</a></li><li class="nav-list-item"><a href="/doc/libf3d/OPTIONS.html" class="nav-list-link">Options</a></li><li class="nav-list-item"><a href="/doc/libf3d/BINDINGS.html" class="nav-list-link">Bindings</a></li><li class="nav-list-item"><a href="/doc/libf3d/PLUGINS.html" class="nav-list-link">Plugin SDK</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Developer Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/dev/README_DEV.html" class="nav-list-link">Developer Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/dev/GETTING_STARTED.html" class="nav-list-link">Getting Started</a></li><li class="nav-list-item"><a href="/doc/dev/BUILD.html" class="nav-list-link">Build</a></li><li class="nav-list-item"><a href="/doc/dev/TESTING.html" class="nav-list-link">Testing</a></li><li class="nav-list-item"><a href="/CONTRIBUTING.html" class="nav-list-link">Contribute</a></li><li class="nav-list-item"><a href="/doc/dev/GENERATE.html" class="nav-list-link">Generate</a></li><li class="nav-list-item"><a href="/doc/dev/CODING_STYLE.html" class="nav-list-link">Coding Style</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Licenses category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/_licenses.html" class="nav-list-link">Licenses</a><ul class="nav-list"><li class="nav-list-item"><a href="/LICENSE.html" class="nav-list-link">License</a></li><li class="nav-list-item"><a href="/doc/THIRD_PARTY_LICENSES.html" class="nav-list-link">Third Party Licenses</a></li></ul></li><li class="nav-list-item"><a href="/doc/CHANGELOG.html" class="nav-list-link">Changelog</a></li></ul> <ul class="nav-list"><li class="nav-list-item external"> <a href="https://f3d.app/doc/user/INSTALLATION.html" class="nav-list-link external" > Download F3D <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg> </a> </li><li class="nav-list-item external"> <a href="https://github.com/f3d-app/f3d" class="nav-list-link external" > GitHub repository <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg> </a> </li></ul> </nav> <footer class="site-footer"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </footer> </div> <div class="main" id="top"> <div id="main-header" class="main-header"> <div class="search" role="search"> <div class="search-input-wrap"> <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search F3D" aria-label="Search F3D" autocomplete="off"> <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label> </div> <div id="search-results" class="search-results"></div> </div> <nav aria-label="Auxiliary" class="aux-nav"> <ul class="aux-nav-list"> <li class="aux-nav-list-item"> <a href="//github.com/f3d-app/f3d" class="site-button" target="_blank" rel="noopener noreferrer" > <img src="https://user-images.githubusercontent.com/3129530/197903476-11d9c41d-73b0-461f-93e8-c8c00c680e6e.png" width="30px"> </a> </li> </ul> </nav> </div> <div class="main-content-wrap"> <nav aria-label="Breadcrumb" class="breadcrumb-nav"> <ol class="breadcrumb-nav-list"> <li class="breadcrumb-nav-list-item"><a href="/doc/user/README_USER.html">User Documentation</a></li> <li class="breadcrumb-nav-list-item"><span>Usage</span></li> </ol> </nav> <div id="main-content" class="main-content"> <main> <h1 id="usage"> <a href="#usage" class="anchor-heading" aria-labelledby="usage"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Usage </h1> <p>Once F3D has been <a href="/doc/user/INSTALLATION.html">installed</a>, you should be able to open any <a href="#supported-file-formats">supported file</a>, by either:</p> <ul> <li>Using F3D automatically, from your file manager, by directly opening a file.</li> <li>Running F3D and then dragging and dropping files into it to open them.</li> <li>By running F3D from the terminal with a set of command-line <a href="/doc/user/OPTIONS.html">options</a>.</li> <li>As a <a href="/doc/user/DESKTOP_INTEGRATION.html">thumbnailer</a> for all supported file formats with certain file managers.</li> </ul> <h2 id="supported-file-formats"> <a href="#supported-file-formats" class="anchor-heading" aria-labelledby="supported-file-formats"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Supported file formats </h2> <p>Here is the list of supported file formats:</p> <ul> <li><strong>.vtk</strong> : the legacy VTK format</li> <li><strong>.vt[p|u|r|i|s|m]</strong> : XML based VTK formats</li> <li><strong>.ply</strong> : Polygon File format</li> <li><strong>.stl</strong> : Standard Triangle Language format</li> <li><strong>.dcm</strong> : DICOM file format</li> <li><strong>.nrrd/.nhrd</strong> : “nearly raw raster data” file format</li> <li><strong>.mhd/.mha</strong> : MetaHeader MetaIO file format</li> <li><strong>.tif/.tiff</strong> : TIFF 2D/3D file format</li> <li><strong>.ex2/.e/.exo/.g</strong> : Exodus 2 file format</li> <li><strong>.gml</strong> : CityGML file format</li> <li><strong>.pts</strong> : Point Cloud file format</li> <li><strong>.step/.stp</strong> : CAD STEP exchange ISO format</li> <li><strong>.iges/.igs</strong> : CAD Initial Graphics Exchange Specification format</li> <li><strong>.brep</strong> : Open CASCADE BRep format</li> <li><strong>.abc</strong> : Alembic format</li> <li><strong>.vdb</strong> : VDB format (experimental)</li> <li><strong>.obj</strong> : Wavefront OBJ file format (full scene and default scene)</li> <li><strong>.gltf/.glb</strong> : GL Transmission Format (full scene and default scene)</li> <li><strong>.3ds</strong> : Autodesk 3D Studio file format (full scene)</li> <li><strong>.wrl</strong> : VRML file format (full scene)</li> <li><strong>.fbx</strong> : Autodesk Filmbox (full scene)</li> <li><strong>.dae</strong> : COLLADA (full scene)</li> <li><strong>.off</strong> : Object File Format (full scene)</li> <li><strong>.dxf</strong> : Drawing Exchange Format (full scene)</li> <li><strong>.x</strong> : DirectX Format (full scene)</li> </ul> <h2 id="scene-construction"> <a href="#scene-construction" class="anchor-heading" aria-labelledby="scene-construction"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Scene construction </h2> <p>The <strong>full scene</strong> formats (.gltf/.glb, .3ds, .wrl, .obj, .fbx, .dae, .off) contain not only <em>geometry</em>, but also some scene information like <em>lights</em>, <em>cameras</em>, <em>actors</em> in the scene, as well as <em>texture</em> properties. By default, all this information will be loaded from the file and displayed. Use the <code class="language-plaintext highlighter-rouge">--geometry-only</code> <a href="/doc/user/OPTIONS.html">options</a> to modify this behavior. For file formats that do not support it, <strong>a default scene</strong> is created.</p> <h2 id="animations"> <a href="#animations" class="anchor-heading" aria-labelledby="animations"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Animations </h2> <p>F3D can play animations for a number of file formats (.ex2/.e/.exo/.g, .gltf/.glb, .fbx, .dae, .x) if the file contains an animation. It is possible to select the animation to play using <code class="language-plaintext highlighter-rouge">--animation-index</code>, or to play all animations at once using <code class="language-plaintext highlighter-rouge">--animation-index=-1</code> (.gltf/.glb only). When F3D play an animation, it assumes the time unit is in seconds to show accurate speed of animation. Use <code class="language-plaintext highlighter-rouge">--animation-speed-factor</code> if an adjustment is needed. By default, F3D will try update the scene 60 times per seconds, use <code class="language-plaintext highlighter-rouge">--animation-frame-rate</code> to change that if needed.</p> <h2 id="plugins"> <a href="#plugins" class="anchor-heading" aria-labelledby="plugins"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Plugins </h2> <p>If you installed F3D using a package manager, it’s possible that the packager chose to bundle the plugins in different packages or to list plugin dependencies as optional dependencies to reduce the reduce the number of dependencies of the main package. In this case, in order to open a file that requires a plugin, you will have to make sure all needed dependencies are installed and specify which plugin you want to load in order to be able to open this file. You can either use the <code class="language-plaintext highlighter-rouge">--load-plugins</code> option or add a line in the <a href="/doc/user/CONFIGURATION_FILE.html">configuration file</a>, if not already. Several plugins can be specified by giving a comma-separated list.<br /> Here is the list of plugins provided officially by F3D:</p> <ul> <li><strong>alembic</strong>: ABC support</li> <li><strong>assimp</strong>: FBX, DAE, OFF, DXF and X support</li> <li><strong>draco</strong>: DRC support</li> <li><strong>exodus</strong>: EX2 support</li> <li><strong>occt</strong>: STEP and IGES support</li> <li><strong>usd</strong>: USD, USDA, UDSC and USDZ support</li> <li><strong>vdb</strong>: VDB support (experimental)</li> </ul> <blockquote> <p>Note: If you downloaded the binaries from the Release page, it’s not necessary to specify manually the plugins above, all of them are loaded automatically.</p> </blockquote> <p>Here is how the plugins are searched (by precedence order):</p> <ol> <li>Search the static plugins</li> <li>Consider the option given is a full path</li> <li>Search in the paths specified in <code class="language-plaintext highlighter-rouge">F3D_PLUGINS_PATH</code> environment variable</li> <li>Search in a directory relative to the F3D application: <code class="language-plaintext highlighter-rouge">../lib</code></li> <li>Rely on OS specific paths (e.g. <code class="language-plaintext highlighter-rouge">LD_LIBRARY_PATH</code> on Linux or <code class="language-plaintext highlighter-rouge">DYLD_LIBRARY_PATH</code> on macOS)</li> </ol> <p>You can also try plugins maintained by the community. If you have created a plugin and would like it to be listed here, please submit a pull request.</p> <ul> <li><strong>Abaqus</strong>: ODB support by @YangShen398 (<a href="https://github.com/YangShen398/F3D-ODB-Reader-Plugin">repository</a>)</li> </ul> </main> </div> </div> <div class="search-overlay"></div> </div> </body> </html>
+<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <link rel="stylesheet" href="/assets/css/just-the-docs-default.css"> <link rel="stylesheet" href="/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet"> <style id="jtd-nav-activation"> .site-nav > ul.nav-list:first-child > li > a, .site-nav > ul.nav-list:first-child > li > ul > li:not(:nth-child(1)) > a, .site-nav > ul.nav-list:first-child > li > ul > li > ul > li > a { background-image: none; } .site-nav > ul.nav-list:not(:first-child) a, .site-nav li.external a { background-image: none; } .site-nav > ul.nav-list:first-child > li:nth-child(3) > ul > li:nth-child(1) > a { font-weight: 600; text-decoration: none; }.site-nav > ul.nav-list:first-child > li:nth-child(3) > button svg, .site-nav > ul.nav-list:first-child > li:nth-child(3) > ul > li:nth-child(1) > button svg { transform: rotate(-90deg); }.site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(3) > ul.nav-list, .site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(3) > ul.nav-list > li.nav-list-item:nth-child(1) > ul.nav-list { display: block; } </style> <script async src="https://www.googletagmanager.com/gtag/js?id=G-ZCWEYB9KVG"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-ZCWEYB9KVG', { 'anonymize_ip': true }); </script> <script src="/assets/js/vendor/lunr.min.js"></script> <script src="/assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- Begin Jekyll SEO tag v2.8.0 --> <title>Usage | F3D</title> <meta name="generator" content="Jekyll v3.9.3" /> <meta property="og:title" content="Usage" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="F3D - Fast and minimalist 3D viewer" /> <meta property="og:description" content="F3D - Fast and minimalist 3D viewer" /> <link rel="canonical" href="https://f3d.app//doc/user/USAGE.html" /> <meta property="og:url" content="https://f3d.app//doc/user/USAGE.html" /> <meta property="og:site_name" content="F3D" /> <meta property="og:image" content="https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png" /> <meta property="og:image:height" content="1200" /> <meta property="og:image:width" content="630" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary_large_image" /> <meta property="twitter:image" content="https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png" /> <meta property="twitter:title" content="Usage" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","description":"F3D - Fast and minimalist 3D viewer","headline":"Usage","image":{"height":1200,"width":630,"url":"https://user-images.githubusercontent.com/3129530/201317344-092db03d-8616-45b9-b606-30d22cda2eff.png","@type":"imageObject"},"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://f3d.app//resources/logotype.svg"}},"url":"https://f3d.app//doc/user/USAGE.html"}</script> <!-- End Jekyll SEO tag --> <link rel="shortcut icon" href="https://raw.githubusercontent.com/f3d-app/f3d/master/resources/logo.ico" type="image/x-icon"> </head> <body> <a class="skip-to-main" href="#main-content">Skip to main content</a> <svg xmlns="http://www.w3.org/2000/svg" class="d-none"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE --> <symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link"> <title id="svg-external-link-title">(external link)</title> <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"> <title>Document</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"> <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"> <title>Search</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol> <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md --> <symbol id="svg-copy" viewBox="0 0 16 16"> <title>Copy</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16"> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/> <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/> </svg> </symbol> <symbol id="svg-copied" viewBox="0 0 16 16"> <title>Copied</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16"> <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/> </svg> </symbol> </svg> <div class="side-bar"> <div class="site-header" role="banner"> <a href="/" class="site-title lh-tight"> <div class="site-logo" role="img" aria-label="F3D"></div> </a> <button id="menu-button" class="site-button btn-reset" aria-label="Toggle menu" aria-pressed="false"> <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg> </button> </div> <nav aria-label="Main" id="site-nav" class="site-nav"> <ul class="nav-list"><li class="nav-list-item"><a href="/" class="nav-list-link">Home</a></li><li class="nav-list-item"><a href="/doc/GALLERY.html" class="nav-list-link">Gallery</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in User Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/user/README_USER.html" class="nav-list-link">User Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/user/USAGE.html" class="nav-list-link">Usage</a></li><li class="nav-list-item"><a href="/doc/user/INSTALLATION.html" class="nav-list-link">Installation</a></li><li class="nav-list-item"><a href="/doc/user/OPTIONS.html" class="nav-list-link">Options</a></li><li class="nav-list-item"><a href="/doc/user/INTERACTIONS.html" class="nav-list-link">Interactions</a></li><li class="nav-list-item"><a href="/doc/user/CONFIGURATION_FILE.html" class="nav-list-link">Configuration File</a></li><li class="nav-list-item"><a href="/doc/user/DESKTOP_INTEGRATION.html" class="nav-list-link">Desktop Integration</a></li><li class="nav-list-item"><a href="/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html" class="nav-list-link">Limitations and Troubleshooting</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in libf3d Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/libf3d/README_LIBF3D.html" class="nav-list-link">libf3d Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/libf3d/OVERVIEW.html" class="nav-list-link">Overview</a></li><li class="nav-list-item"><a href="/doc/libf3d/CLASSES.html" class="nav-list-link">Classes Introduction</a></li><li class="nav-list-item"><a href="/doc/libf3d/OPTIONS.html" class="nav-list-link">Options</a></li><li class="nav-list-item"><a href="/doc/libf3d/BINDINGS.html" class="nav-list-link">Bindings</a></li><li class="nav-list-item"><a href="/doc/libf3d/PLUGINS.html" class="nav-list-link">Plugin SDK</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Developer Documentation category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/doc/dev/README_DEV.html" class="nav-list-link">Developer Documentation</a><ul class="nav-list"><li class="nav-list-item"><a href="/doc/dev/GETTING_STARTED.html" class="nav-list-link">Getting Started</a></li><li class="nav-list-item"><a href="/doc/dev/BUILD.html" class="nav-list-link">Build</a></li><li class="nav-list-item"><a href="/doc/dev/TESTING.html" class="nav-list-link">Testing</a></li><li class="nav-list-item"><a href="/CONTRIBUTING.html" class="nav-list-link">Contribute</a></li><li class="nav-list-item"><a href="/doc/dev/GENERATE.html" class="nav-list-link">Generate</a></li><li class="nav-list-item"><a href="/doc/dev/CODING_STYLE.html" class="nav-list-link">Coding Style</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Licenses category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/_licenses.html" class="nav-list-link">Licenses</a><ul class="nav-list"><li class="nav-list-item"><a href="/LICENSE.html" class="nav-list-link">License</a></li><li class="nav-list-item"><a href="/doc/THIRD_PARTY_LICENSES.html" class="nav-list-link">Third Party Licenses</a></li></ul></li><li class="nav-list-item"><a href="/doc/CHANGELOG.html" class="nav-list-link">Changelog</a></li></ul> <ul class="nav-list"><li class="nav-list-item external"> <a href="https://f3d.app/doc/user/INSTALLATION.html" class="nav-list-link external" > Download F3D <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg> </a> </li><li class="nav-list-item external"> <a href="https://github.com/f3d-app/f3d" class="nav-list-link external" > GitHub repository <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg> </a> </li></ul> </nav> <footer class="site-footer"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </footer> </div> <div class="main" id="top"> <div id="main-header" class="main-header"> <div class="search" role="search"> <div class="search-input-wrap"> <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search F3D" aria-label="Search F3D" autocomplete="off"> <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label> </div> <div id="search-results" class="search-results"></div> </div> <nav aria-label="Auxiliary" class="aux-nav"> <ul class="aux-nav-list"> <li class="aux-nav-list-item"> <a href="//github.com/f3d-app/f3d" class="site-button" target="_blank" rel="noopener noreferrer" > <img src="https://user-images.githubusercontent.com/3129530/197903476-11d9c41d-73b0-461f-93e8-c8c00c680e6e.png" width="30px"> </a> </li> </ul> </nav> </div> <div class="main-content-wrap"> <nav aria-label="Breadcrumb" class="breadcrumb-nav"> <ol class="breadcrumb-nav-list"> <li class="breadcrumb-nav-list-item"><a href="/doc/user/README_USER.html">User Documentation</a></li> <li class="breadcrumb-nav-list-item"><span>Usage</span></li> </ol> </nav> <div id="main-content" class="main-content"> <main> <h1 id="usage"> <a href="#usage" class="anchor-heading" aria-labelledby="usage"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Usage </h1> <p>Once F3D has been <a href="/doc/user/INSTALLATION.html">installed</a>, you should be able to open any <a href="#supported-file-formats">supported file</a>, by either:</p> <ul> <li>Using F3D automatically, from your file manager, by directly opening a file.</li> <li>Running F3D and then dragging and dropping files into it to open them.</li> <li>By running F3D from the terminal with a set of command-line <a href="/doc/user/OPTIONS.html">options</a>.</li> <li>As a <a href="/doc/user/DESKTOP_INTEGRATION.html">thumbnailer</a> for all supported file formats with certain file managers.</li> </ul> <h2 id="supported-file-formats"> <a href="#supported-file-formats" class="anchor-heading" aria-labelledby="supported-file-formats"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Supported file formats </h2> <p>Here is the list of supported file formats:</p> <ul> <li><strong>.vtk</strong> : the legacy VTK format</li> <li><strong>.vt[p|u|r|i|s|m]</strong> : XML based VTK formats</li> <li><strong>.ply</strong> : Polygon File format</li> <li><strong>.stl</strong> : Standard Triangle Language format</li> <li><strong>.dcm</strong> : DICOM file format</li> <li><strong>.nrrd/.nhrd</strong> : “nearly raw raster data” file format</li> <li><strong>.mhd/.mha</strong> : MetaHeader MetaIO file format</li> <li><strong>.tif/.tiff</strong> : TIFF 2D/3D file format</li> <li><strong>.ex2/.e/.exo/.g</strong> : Exodus 2 file format</li> <li><strong>.gml</strong> : CityGML file format</li> <li><strong>.pts</strong> : Point Cloud file format</li> <li><strong>.step/.stp</strong> : CAD STEP exchange ISO format</li> <li><strong>.iges/.igs</strong> : CAD Initial Graphics Exchange Specification format</li> <li><strong>.brep</strong> : Open CASCADE BRep format</li> <li><strong>.abc</strong> : Alembic format</li> <li><strong>.vdb</strong> : VDB format (experimental)</li> <li><strong>.obj</strong> : Wavefront OBJ file format (full scene and default scene)</li> <li><strong>.gltf/.glb</strong> : GL Transmission Format (full scene and default scene)</li> <li><strong>.3ds</strong> : Autodesk 3D Studio file format (full scene)</li> <li><strong>.wrl</strong> : VRML file format (full scene)</li> <li><strong>.fbx</strong> : Autodesk Filmbox (full scene)</li> <li><strong>.dae</strong> : COLLADA (full scene)</li> <li><strong>.off</strong> : Object File Format (full scene)</li> <li><strong>.dxf</strong> : Drawing Exchange Format (full scene)</li> <li><strong>.x</strong> : DirectX Format (full scene)</li> <li><strong>.3mf</strong> : 3D Manufacturing Format (full scene)</li> </ul> <h2 id="scene-construction"> <a href="#scene-construction" class="anchor-heading" aria-labelledby="scene-construction"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Scene construction </h2> <p>The <strong>full scene</strong> formats (.gltf/.glb, .3ds, .wrl, .obj, .fbx, .dae, .off, .x, .3mf) contain not only <em>geometry</em>, but also some scene information like <em>lights</em>, <em>cameras</em>, <em>actors</em> in the scene, as well as <em>texture</em> properties. By default, all this information will be loaded from the file and displayed. Use the <code class="language-plaintext highlighter-rouge">--geometry-only</code> <a href="/doc/user/OPTIONS.html">options</a> to modify this behavior. For file formats that do not support it, <strong>a default scene</strong> is created.</p> <h2 id="animations"> <a href="#animations" class="anchor-heading" aria-labelledby="animations"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Animations </h2> <p>F3D can play animations for a number of file formats (.ex2/.e/.exo/.g, .gltf/.glb, .fbx, .dae, .x) if the file contains an animation. It is possible to select the animation to play using <code class="language-plaintext highlighter-rouge">--animation-index</code>, or to play all animations at once using <code class="language-plaintext highlighter-rouge">--animation-index=-1</code> (.gltf/.glb only). When F3D play an animation, it assumes the time unit is in seconds to show accurate speed of animation. Use <code class="language-plaintext highlighter-rouge">--animation-speed-factor</code> if an adjustment is needed. By default, F3D will try update the scene 60 times per seconds, use <code class="language-plaintext highlighter-rouge">--animation-frame-rate</code> to change that if needed.</p> <h2 id="plugins"> <a href="#plugins" class="anchor-heading" aria-labelledby="plugins"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Plugins </h2> <p>If you installed F3D using a package manager, it’s possible that the packager chose to bundle the plugins in different packages or to list plugin dependencies as optional dependencies to reduce the reduce the number of dependencies of the main package. In this case, in order to open a file that requires a plugin, you will have to make sure all needed dependencies are installed and specify which plugin you want to load in order to be able to open this file. You can either use the <code class="language-plaintext highlighter-rouge">--load-plugins</code> option or add a line in the <a href="/doc/user/CONFIGURATION_FILE.html">configuration file</a>, if not already. Several plugins can be specified by giving a comma-separated list.<br /> Here is the list of plugins provided officially by F3D:</p> <ul> <li><strong>alembic</strong>: ABC support</li> <li><strong>assimp</strong>: FBX, DAE, OFF, DXF, X and 3MF support</li> <li><strong>draco</strong>: DRC support</li> <li><strong>exodus</strong>: EX2 support</li> <li><strong>occt</strong>: STEP and IGES support</li> <li><strong>usd</strong>: USD, USDA, UDSC and USDZ support</li> <li><strong>vdb</strong>: VDB support (experimental)</li> </ul> <blockquote> <p>Note: If you downloaded the binaries from the Release page, it’s not necessary to specify manually the plugins above, all of them are loaded automatically.</p> </blockquote> <p>Here is how the plugins are searched (by precedence order):</p> <ol> <li>Search the static plugins</li> <li>Consider the option given is a full path</li> <li>Search in the paths specified in <code class="language-plaintext highlighter-rouge">F3D_PLUGINS_PATH</code> environment variable</li> <li>Search in a directory relative to the F3D application: <code class="language-plaintext highlighter-rouge">../lib</code></li> <li>Rely on OS specific paths (e.g. <code class="language-plaintext highlighter-rouge">LD_LIBRARY_PATH</code> on Linux or <code class="language-plaintext highlighter-rouge">DYLD_LIBRARY_PATH</code> on macOS)</li> </ol> <p>You can also try plugins maintained by the community. If you have created a plugin and would like it to be listed here, please submit a pull request.</p> <ul> <li><strong>Abaqus</strong>: ODB support by @YangShen398 (<a href="https://github.com/YangShen398/F3D-ODB-Reader-Plugin">repository</a>)</li> </ul> </main> </div> </div> <div class="search-overlay"></div> </div> </body> </html>
diff --git a/doc/user/USAGE.md b/doc/user/USAGE.md
index 5f5e03a043..1b2affe5ae 100644
--- a/doc/user/USAGE.md
+++ b/doc/user/USAGE.md
@@ -36,10 +36,11 @@ Here is the list of supported file formats:
 * **.off** : Object File Format (full scene)
 * **.dxf** : Drawing Exchange Format (full scene)
 * **.x** : DirectX Format (full scene)
+* **.3mf** : 3D Manufacturing Format (full scene)
 
 ## Scene construction
 
-The **full scene** formats (.gltf/.glb, .3ds, .wrl, .obj, .fbx, .dae, .off) contain not only *geometry*, 
+The **full scene** formats (.gltf/.glb, .3ds, .wrl, .obj, .fbx, .dae, .off, .x, .3mf) contain not only *geometry*, 
 but also some scene information like *lights*, *cameras*, *actors* in the scene, as well as *texture* properties.
 By default, all this information will be loaded from the file and displayed. Use the `--geometry-only` [options](OPTIONS.md)
 to modify this behavior. For file formats that do not support it, **a default scene** is created.
@@ -58,7 +59,7 @@ In this case, in order to open a file that requires a plugin, you will have to m
 Here is the list of plugins provided officially by F3D:
 
 - **alembic**: ABC support
-- **assimp**: FBX, DAE, OFF, DXF and X support
+- **assimp**: FBX, DAE, OFF, DXF, X and 3MF support
 - **draco**: DRC support
 - **exodus**: EX2 support
 - **occt**: STEP and IGES support
diff --git a/resources/BundleInfo.plist.in b/resources/BundleInfo.plist.in
index 4806c84502..c996a8f168 100644
--- a/resources/BundleInfo.plist.in
+++ b/resources/BundleInfo.plist.in
@@ -339,6 +339,19 @@
 					<string>x</string>
 				</array>
 			</dict>
+			<!-- 3MF -->
+			<dict>
+				<key>CFBundleTypeName</key>
+				<string>3D Manufacturing Format</string>
+				<key>CFBundleTypeRole</key>
+				<string>Viewer</string>
+				<key>LSIsAppleDefaultForType</key>
+				<true/>
+				<key>CFBundleTypeExtensions</key>
+				<array>
+					<string>3mf</string>
+				</array>
+			</dict>
 			<!-- OFF -->
 			<dict>
 				<key>CFBundleTypeName</key>