Add a jekyll based documentation

CHANGELOG.md

@@ -0,0 +1,239 @@
+---
+layout: default
+title: Changelog
+nav_order: 6
+---
+
+# Changelog
+
+## 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 poping 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 environnement 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 Developpers:
+- 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
+- dekstop 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 [email protected].
+* NixOS now contains a f3d package, 1.1.0 should come soon, thanks to [email protected].
+
+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

GALLERY.md

@@ -0,0 +1,76 @@
+---
+layout: default
+title: Gallery
+nav_order: 1
+---
+
+# Gallery
+
+Examples renderings with their associated command lines.
+Images and videos displayed below use public datasets, you can download them [here](https://drive.google.com/file/d/1iRh0OeJjMjjaBDLG6b_iJSkC_Jt_YQuo/view?usp=sharing).
+
+<video src='https://user-images.githubusercontent.com/3129530/194735274-395839e9-e2cb-4a47-83b9-5c6987640032.webm' autoplay="autoplay" loop="loop" width="700"></video>
+
+*Animated realistic rendering*: `f3d gearbox/scene.gltf --hdri=future_parking_2k.hdr -uqxtgas`
+
+<video src='https://user-images.githubusercontent.com/3129530/194734947-f34bc377-8ee4-472a-b130-30ce9e86facf.webm' autoplay="autoplay" loop="loop" width="700"></video>
+
+*Animated, skinned and morphed rendering*: `f3d dota/scene.gltf --hdri=future_parking_2k.hdr -uqxtgas`
+
+<video src='https://user-images.githubusercontent.com/3129530/194735269-b62216e6-33da-484c-9f0d-39befc8253bf.webm' autoplay="autoplay" loop="loop" width="700"></video>
+
+*Animated scientific visualization rendering*: `f3d can.ex2 -xtgans --up=+Z --scalars=VEL`
+
+<img src="https://user-images.githubusercontent.com/3129530/194735272-5bcd3e7c-a333-41f5-8066-9b0bec9885e8.png" width="700">
+
+*Direct scalars rendering of a point cloud*: `f3d Carola_PointCloud.ply --point-size=0 --comp=-2 -so --up=+Z --hdri=venice_sunset_8k.hdr`
+
+<img src="https://user-images.githubusercontent.com/3129530/194735378-b8be4df2-e030-4d13-b12f-24806cbb385b.png" width="700">
+
+*Raytraced CAD assembly*: `f3d 202.vtp -xtgans -rd --samples=10 --range=-2,9`
+
+<img src="https://user-images.githubusercontent.com/3129530/194735377-127fa5d8-ece5-40c7-8176-672279ebdacc.png" width="700">
+
+*Volume rendering of a security bag scan*: `f3d backpack.vti -vmn --range=300,1000 --colormap=0,0,0,0,1,1,1,1`
+
+<img src="https://user-images.githubusercontent.com/3129530/194735376-3a476643-00d6-4cfc-9a88-e0dd33658564.png" width="700">
+
+*Realistic rendering #1*: `f3d DamagedHelmet.glb --hdri=lebombo_4k.hdr -tuqap`
+
+<img src="https://user-images.githubusercontent.com/3129530/194735416-3f386437-456c-4145-9b5e-6bb6451d7e9a.png" width="700">
+
+*Showcase of interactive widgets*: `f3d dragon.vtu -xtganse --comp=0`
+
+<img src="https://user-images.githubusercontent.com/3129530/194735370-4d1f067c-704c-4118-9d94-c1adf4039c39.png" width="700">
+
+*Metallic Rendering of a STEP file*: `f3d eta_asm.stp –hdri=future_parking_2k.hdr -uqxtga –up=+Z –metallic=1 –roughness=0.6 –color=0.98,0.90,0.59`
+
+<img src="https://user-images.githubusercontent.com/3129530/194735366-e79a8d45-8b76-4a65-9445-4a0ca1b63876.png" width="700">
+
+*Rendering of a FBX file*: `f3d zeldaPosed001.fbx –hdri=hikers_cave_2k.hdr -uqxtga`
+
+<img src="https://user-images.githubusercontent.com/3129530/194735363-d2be23bb-90b6-4e90-941d-14b6dc24b476.png" width="700">
+
+*Realistic rendering #2*: `f3d FlightHelmet.glb --hdri=lebombo_4k.hdr -tuqap`
+
+<img src="https://user-images.githubusercontent.com/3129530/194735361-7e827d8e-531a-4938-b608-18825a9574f8.png" width="700">
+
+*Visualization of a CFD velocity field*: `f3d single-pin.vtp -xtbgans --range=-2,8 --colormap=0,0.3,0.7,0,0.7,0,0.1,1,1,0.8,0.8,0`
+
+<img src="https://user-images.githubusercontent.com/3129530/194735354-486999dd-3c57-4ab1-a9ad-b8e97bac0da0.png" width="700">
+
+*Volume rendering of a medical skull scan*: `f3d skull.vti -vxbt --range=40,200`
+
+<img src="https://user-images.githubusercontent.com/3129530/194735348-7dd14922-f546-4f54-8bc2-b6602617c4cc.png" width="700">
+
+*Point cloud rendering using sprites*: `f3d pointCloud.vtp -o --point-size=0.2 --colormap=0,0,0.8,0,0.4,0.9,0,0,0.8,0.9,0.9,0,1,0.5,0.5,1`
+
+## Acknowledgments
+
+- Bristleback DOTA Fan-Art by [Nikolay_Tsys](https://sketchfab.com/Tolst).
+- SY Carola (point cloud) by [Scottish Maritime Museum](https://sketchfab.com/ScottishMaritimeMuseum)
+- Gearbox Animation by [DZHUSI ØNE](https://sketchfab.com/dzhusione)
+- Watch movement by [Greg Brown](https://grabcad.com/greg.brown)
+- Zelda - Breath Of The Wild by [theStoff](https://sketchfab.com/theStoff)
+- Venice Sunset HDRI and Hiker’s Cave HDRI by [Greg Zaal](https://polyhaven.com/hdris?a=Greg%20Zaal)
+- Future Parking HDRI by [Sergej Majboroda](https://polyhaven.com/hdris?a=Sergej%20Majboroda)

LICENSE.md

@@ -0,0 +1,39 @@
+---
+layout: default
+title: License
+parent: Licenses
+nav_order: 0
+---
+
+BSD 3-Clause License
+
+```
+Copyright 2019-2021 Kitware SAS
+Copyright 2021-2022 Michael Migliore, Mathieu Westphal
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```