# Changelog

## v3.5.0

For F3D users:

- Created an Android version
- Moved macOS binary package to macOS 14 framework.
- Added support for writing multiple images when using `--output` with a file containing animations
- Added a `--display-depth` option to display the depth image
- Added a `--checkerboard` option to display a checkerboard texture to check UVs
- Added a `--scene-hierarchy` option and interactive bind (`Shift+H`) to show a hierarchy widget that let enabling/disabling actor visibility
- Added a `--normal-glyphs` option to show normals as arrow glyphs
- Added a `--notifications` option and interactive bind (`Ctrl+K`) to enable/disable notifications, which shows a widget whenever an interactive bind is pressed
- Added a `--dpi-aware` option to rescale font automatically on HiDPI screens (Windows only)
- Added a `webifc` plugin to add support for .ifc files
- Added a `pdal` plugin to add support for many point cloud formats, including .las and .laz
- Added support for jumping to keyframes using `jump_to_keyframe` command
- Added support for CPU sorting for gaussian splat (`--blending=sort_cpu`), which enable gaussian splats on macOS
- Added support for images formats (.png, .jpg, .hdr, .exr, ...)
- Added a 2D interaction mode (`--interaction-style=2d`), used by default for images
- Added a `--font-color` option to set the font color
- Added a `print_config_info` command to print info about the current config file in use
- Added new arguments to `set_camera` command: `back`, `bottom`, and `left`
- Added stream and pipe support, eg: `cat file.glb | f3d -`
- Added more point sprites types, eg: `cross`, `circle`, and more
- Added support for rendering non-PBR format as PBR
- Added a searchbar on the cheatsheet
- Added support for f3d colors in options (eg: `f3d_white`)
- Improved temporal anti aliasing performance and correctness
- Improved shell completions by reworking the whole CLI option system
- Improved alembic animation performance
- Fixed documentation issues
- Fixed a potential segfault when parsing colors in options
- Fixed a crash with certain .vrml files
- Fixed an issue with axes grid not properly centered on data
- Deprecated `--interaction-trackball` in favor of `--interaction-style=trackball`

For libf3d users:

- Reworked the Qt/QML example from scratch in order to make it work properly
- Reworked java and python binding for the `scene` `add` and `addBuffer` API
- Added missing interaction modifiers in examples
- Added an API to recover animation keyframes
- Added an API to recover animation names
- Added (partial) exception support to the C bindings
- Added webp support to our npm package
- Added `ui.font_color` option to set the font color
- Added `render.effect.display_depth` option to display the depth image
- Added `model.checkerboard.enable` option to display a checkerboard texture to check UVs
- Added a `ui.scene_hierarchy` option to show a hierarchy widget that let enabling/disabling actor visibility
- Added a `model.normal_glyphs.enable` option to show normals as arrow glyphs
- Added a `ui.font_color` option to set the font color
- Added a `interactor.style` option to control interaction style, including `2d` mode
- Added a `ui.notifications.enable` and `ui.notifications.show_bindings` options to enable/disable notifications and bindings, which shows a widget whenever an interactive bind is pressed
- Added a `ui.dpi_aware` option to rescale font automatically on HiDPI screens (Windows only)
- Deprecated `interactor.trackball` option in favor of `interactor.style`

For F3D packagers:

- Updated all vendored dependencies
- Updated all external dependencies in CI and shipping system
- Added a new optional dependency: `clip`, to enable with `F3D_MODULE_CLIP` CMake option, no effect for now
- Added a new optional dependency: `web-ifc`, to enable with `F3D_PLUGIN_BUILD_WEBIFC` CMake option, add the `webifc` plugin
- Added a new optional dependency: `pdal`, through VTK IOPDAL module, to enable with `F3D_PLUGIN_BUILD_PDAL` CMake option, add the `pdal` plugin
- Fixed an issue on FreeBSD with the logic to detect exectuble using sysproc

For Web viewer users:

- Used the stream feature from the libf3d for drastic performance improvements
- Removed support for non-stream supporting formats
- Added .3mf and .dxf support
- Added .ifc support

## v3.4.1

For F3D users:

- BEHAVIOR CHANGE: Changed the behavior of gaussian point sprites, it now require the use of `--point-sprites-absolute-size`
- BEHAVIOR CHANGE: Changed the default configuration for alembic to NOT display scalar by default
- Added a CLI option to control if point sprites should be scaled or not: `--point-sprites-absolute-size`
- Added HDRI filename display CLI option and interaction (`Shift+N`)
- Added progress support to QuakeMDL importer
- Added point sprites modes switch interaction (`O`)
- Added console auto completion for all libf3d options with a domain and filepath
- Added support for Alembic XForm animation
- Added an interaction to play animation backward: `Ctrl+Shift+Space`
- Added a console command to play animation backward: `toggle_animation_backward`
- Added support for importing Alembic file with curves
- Added a `jump_to_frame` command
- Added axes and grid color configuration with a CLI option `--x/y/z-color`
- Added proper support for composite data
- Added an interaction to change the up direction `Ctrl+Y` and `Ctrl+Z` and dynamic up support
- Improved the documentation on https://f3d.app
- Improved style of progress and animation bar to fit F3D style
- Improved color logging
- Reduced VRAM usage of antialiasing and HDRI rendering
- Fixed an issue where the camera would reset after volume rendering
- Fixed multiple issue with temporal anti-aliasing
- Fixed an issue with parsing `none` CLI options
- Fixed small issues with the event loop
- Fixed a blending issue with external rendering context
- Fixed an issue with display of `Ctrl+Shift+` bindings
- Fixed many memory issues in QuakeMDL reader
- Fixed an issue with elevation and azimuth options
- Fixed a small display issue in the cheatsheet
- Deprecated `--anti-aliasing-mode` in favor of simply `--anti-aliasing`
- Deprecated `--point-sprites-type` in favor of simply `--point-sprites`
- MacOS: Fixed a native window focus issues
- MacOS: Added a native file menu

For libf3d users:

- Added HDRI filename display option `ui.hdri_filename`
- Added an option to control if point sprites should be scaled or not `model.point_sprites.absolute_size`
- Added x/y/z axis color options `ui.x/y/z_color` to control the color of the axis widget and grid
- Added a `interactor::requestStop` API for asynchronous loop stopping
- Added a `log` API to forward log instead of displaying them
- Added C bindings
- Fixed potential crash when using `interactor::trigger*` methods
- python: Added many libf3d usage examples
- python: Removed Python 3.9 wheel support
- python: Fixed stubs for better auto completion
- python: Fixed multiples tests that were not run
- python: Fixed an issue when setting a double option from ints
- python: Created a dedicated helper repository: https://github.com/f3d-app/python-f3d-extras
- wasm: Added typescript support
- java: Improved the bindings to cover almost the whole API
- examples: Completely reworked the examples with new and details examples in C++
- examples: Added a complete Qt6 examples
- examples: Added a complete Qml examples
- examples: Added a complete Fltk examples
- examples: Added C example
- examples: Added Java example

For F3D packagers:

- Removed compatibility with VTK v9.2.6 and older. VTK v9.3.0 is the new minimum version.
- Added `F3D_BINDINGS_C` CMake option to build the C bindings, no dependencies

For Web viewer users:

- Added support for gaussian splatting
- Added console support
- Improved color theme

## v3.3.0

For F3D users:

- Created a F3D web application based on WebAssembly: https://f3d.app/viewer
- **BEHAVIOR CHANGE**: Added a CLI option `--recursive-dir-add` to control if directory should be added recursively, off by default
- Complete rework of the cheatsheet with for a nicer, cleaner look
- [Linux] Added support for using F3D offscreen without GLX lib being present on the system
- Added support for identifying non-supported files and not loading them at all
- Added support for skipping unsupported files when loading multiple files
- Added `--remove-empty-file-groups` to control if scene without files should be removed
- Added `--watch` support for yet-to-exists files
- Added a `remove_current_file_group` command
- Added `--axes-grid` CLI option to show grid axes
- Added an bind `Ctrl+X` to control the visibility of grid axes
- Added proper parsing for transform2D options
- Added `--multi-file-regex` CLI option to group files based on their names
- Added autocompletion in interactive console
- Added a `help` command to print information about commands
- Added support for SPZ v3 format
- Added `--backdrop-opacity` to control the UI backdrop opacity
- Added support for .webp image and textures
- Added support for GroupSkin for .mdl format
- Added temporal anti aliasing support `--antialiasing-mode=taa`
- Improve dropzone visuals
- Improved `print_scene_info` output
- Improved UI consistency
- Improved rendering performance slightly
- Reworked the website from scratch which now support documentation versioning
- Removed support for comments in interactive console for better color parsing
- Fixed and improved many documentations issues
- Fixed an issue with `--watch` when file is failing to load
- Fixed missing frame in .mdl animations
- Fixed a potential crash when graphic libraries are not found
- Fixed an issue with the scalar bar not being continuous

For libf3d users:

- Created a npm package to implement libf3d app for the web
- Added event forwarding in order to implement interactions easily with _external_ engines
- Added `ui.drop_zone.custom_binds` option to control the bindings visible in drop zone
- Added `ui.backdrop.opacity` to control the UI backdrop opacity

For F3D packagers:

- F3D does not use libglx directly anymore when using VTK > 9.5
- F3D v3.3.0 will be the last version of F3D supporting vtk v9.2.6, VTK v9.3.1 will be required for the next release

## v3.2.0

For F3D users:

- Added support for VTKHDF format, including AMR datasets
- Added support for SPZ and PLY gaussian splatting format
- Added a `--base-ior` option to control index of refraction
- Added a `--multi-file-mode=dir` option mode to create file groups based on the folder organization
- Added spherical harmonics support for gaussian splatting (SPZ and PLY)
- Added a QuakeMDL reader option: `-DQuakeMDL.skin_index` to select skin to load
- Added support for reading EXR texture in USD format
- Added support for selection multiple animations using `--animation-indices=1,2,3`
- Added a `--colormap-discretization` option to control scalar rendering discretization
- Added glob support to configuration file
- Added a `--textures-transform` option to set a transform on textures
- Added listing of more exodus extensions `.e`, `.g` and `.exo`
- Added a minimal console, open by pressing `:`
- Added `increase_opacity` and `decrease_opacity` commands and bindings (`Ctrl+P` and `Shift+P`)
- Added a `--force-reader` option to select the reader to use, even with the wrong extension
- Added a binding to switch verbose level by pressing `Shift+V`
- Added netcdf format support
- Added `elevation_camera` and `azimuth_camera` commands
- Added a `elevation_camera` binding (`2` and `8`)
- Improved documentation
- Improved logging
- Improved camera management on special locations like looking straight down
- Changed UI style to fit with new F3D design
- Fixed multiple issues with coloring while skinning or morphing
- Fixed an issue with normals in the QuakeMDL importer
- Fixed a wobbling issue when rotating the camera
- Fixed an issue where `--verbose=quiet` was not respected
- Fixed multiple UI issues
- Fixed an infamous crash on Windows when username has a special character in it
- Fixed an issue where configuration file loading order was not respected
- Fixed an issue where optional option were not kept when changing file group
- Fixed a crash when using `Ctrl+O` but then selecting no files
- Fixed an issue with colinear camera and Up vector
- Deprecated `--animation-index` option

For libf3d users:

- Added `scene.animation.indices` to select multiple animations
- Added `model.material.base_ior` to control index of refraction
- Added `model.scivis.discretization` to control scalar rendering discretization
- Added `model.textures_transform` to set a transform on textures
- Added `scene.force_reader` to force a specific reader to be used
- Added streaming support to Splat reader (not exposed yet)
- Improved camera API and default values
- Improved python stubs
- Fixed `help(f3d)`
- Deprecated `scene.animation.index` option

For F3D packagers:

- Fixed a missing include in vtkF3DQuakeMDLImporter
- Fixed a configuration issue against assimp 6.0
- Removed `f3d_PREFIX_DIR` and rely on `PACKAGE_PREFIX_DIR` instead
- Renamed `F3D_PLUGIN_BUILD_EXODUS` into `F3D_PLUGIN_BUILD_HDF`
- Added a few new VTK module dependencies

## v3.1.0

For F3D users:

- Added support for reading Quake MDL files
- Added support supersampling anti aliasing and enable it for thumbnails
- Added support for displaying metadata with assimp formats (FBX and more)
- Added support for `--up` vector to be any direction
- Added support for parsing color options with syntax: `#ff00ff`, `hsv(240 , 100% , 100%)` and more
- Added support for parsing direction options with syntax: `+X`, `-z+y` and more
- Added support for parsing path options with syntax: `~/path/to/../to/relative/file.ext`
- Added support for parsing colormap options with syntax: `val, color, val, color,....`
- Added bind to increase opacity (`Ctrl+P`) and decrease opacity (`Shift+P`)
- Added report of config file locations being checked
- Added support for imperative (force) option in configuration files
- Added XDG support for cache location
- Added support for history and command action in console
- Added a `remove_file_groups` command
- Added `increase_opacity` and `decrease_opacity` commands
- Added `alias` command to create aliases of other commands
- Added support for setting and resetting libf3d options from CLI using `--define` and `--reset`
- Added many reader specific options that can be controlled using `--define`
- Added PWA support to F3DWeb
- Added support for url-params in F3DWeb
- Improved documentation
- Changed report of Unset value to `Unset` instead of `N/A` in cheatsheet
- Changed dropzone to be implemented using ImGui
- Fixed an issue where scalar bar and axis displayed on top of console
- Fixed zsh completion
- Fixed multiple OBJ related loading issues
- Fixed multiple assimp related loading issues
- Fixed crashes when opening PLY files
- Fixed a crash when opening multiple USD files
- Fixed cheatsheet location
- Fixed final-shader to only be applied on VTK rendering
- Fixed an issue when using camera shortcut and then interacting
- Fixed config file location on macOS
- Fixed multiple issues where exceptions would result in errors
- Removed skip frame logic with animations after fixes in VTK

For libf3d users:

- Added parsing/formatting for `color_t`
- Added parsing/formatting for `direction_t`
- Added parsing/formatting for `std::filesystem::path`
- Added parsing/formatting for `colormap_t`
- Changed color options to use actual type `color_t`
- Changed direction options to use actual type `direction_t`
- Changed path options to use actual type `std::filesystem::path`. Note that path should now be collapsed.
- Changed colormap_t options to use actual type `colormap_t`

For F3D packagers:

- Fixed compatibility with FreeBSD
- Fixed reproducible build for man generation

For F3D plugin developers:

- Added support for reader specific options

## v3.0.0

For F3D users:

- BREAKING CHANGE: [Configuration files](https://f3d.app/docs/next/user/CONFIGURATION_FILE) have changed syntax
- BREAKING CHANGE: Removed all deprecated options
- BREAKING CHANGE: `--scalars` have been split into `--scalar-coloring` and `--coloring-array` CLI options
- BREAKING CHANGE: `=` must be used for CLI Options, `--option value` is not supported anymore
- BREAKING CHANGE: Removed `geometry-only` and `group-geometries` and added `multi-file-mode` option for more flexible loading of multiple files
- BREAKING CHANGE: There is no headless specific binary release anymore, just use the standard binary with `--rendering-backend=egl`
- BREAKING CHANGE: `--dry-run` has been renamed `--no-config`
- BREAKING CHANGE: `Esc` to quit the app has been changed to `Ctrl+Q`
- BREAKING CHANGE: `--animation-frame-rate` has been replaced by `--frame-rate`
- BREAKING CHANGE: Renamed `--bg-color` into `--background-color`
- BREAKING CHANGE: Renamed `--comp` into `--coloring-component`
- BREAKING CHANGE: Removed the `?` interaction to dump info, use [commands](https://f3d.app/docs/next/user/COMMANDS) instead
- BREAKING CHANGE: Renamed `--progress` into `--loading-progress`
- BREAKING CHANGE: Renamed `--cells` into `--coloring-by-cells`
- BREAKING CHANGE: Renamed `--range` into `--coloring-range`
- BREAKING CHANGE: Renamed `--bar` into `--coloring-scalar-bar`
- BREAKING CHANGE: Renamed `--inverse` into `--volume-inverse`
- BREAKING CHANGE: Renamed `--samples` into `--raytracing-samples`
- BREAKING CHANGE: Renamed `--denoise` into `--raytracing-denoise`
- BREAKING CHANGE: Renamed `--ref` into `--reference` and `--ref-threshold` into `--reference-threshold`
- BREAKING CHANGE: Renamed `--readers-list` into `--list-readers`
- BREAKING CHANGE: F3D binary release is now built with GCC9
- Changed the logo!
- Reworked the UI using ImGui
- Added support for specifying interactions in config files, [see doc](https://f3d.app/docs/next/user/CONFIGURATION_FILE#bindings)
- Added a `--command-script` CLI option
- Added a tiny file dialog, just press `Ctrl+O`
- Added support for armature visualization with `--armature` CLI option (glTF only)
- Added support for keeping camera position when switching files, just press `Ctrl+Arrow`
- Added a ImGui based console to input [commands](https://f3d.app/docs/next/user/COMMANDS) by pressing `Esc`
- Added a "Save minimal screenshot" interaction by pressing `Shift+F12`
- Added error reporting when loading a file failed for some reason
- Added missing config file for .brep files
- Added support for .xbf files
- Added `--input` CLI option
- Added support for libf3d option in configuration files
- Added support for parsing option based on their type, see [the doc](https://f3d.app/docs/next/user/PARSING)
- Added a `--rendering-backend` option to select the rendering backend, including headless
- Added an interaction to rotate camera 90 degrees by pressing 4/6
- Added an interaction to drop only HDRI (Shift+Drop) and an interaction to drop only 3D files (Ctrl+Drop)
- Added a `--list-bindings` CLI option
- Added a `--list-rendering-backends` CLI option
- Added compatibility with [VFX CY2025](https://vfxplatform.com/)
- Added commands to print info about scene, coloring, mesh and options
- Added command to clear the console
- Added support for expanding tilda (`~`) into `HOME` when inputting any path
- Reworked CLI option parsing to avoid parsing issues
- Improved `--list-readers` CLI option output
- Improved image comparison algorithm
- Improved options suggestion in the command line
- Improved many features in F3DWeb as well as adding OCCT and Draco support
- Improved the webassembly bindings
- Improved the documentation
- Improved python bindings
- Improved startup performance
- Improved scalar range handling with animation
- Fixed a crash when opening a glTF file with no textures
- Fixed an option priority issue with `--help`
- Fixed a crash with invalid `--animation-index` and assimp
- Fixed an issue where the window displayed an empty filename
- Fixed an issue where the window resolution was reset when changing file
- Fixed an issue when resetting the camera and using `--camera-index`
- Fixed an issue with `--camera-index` being overridden by other camera options
- Fixed an issue when loading a time value outside of the range
- Fixed issues with screenshot templating
- Fixed an issue with grid rendering on main axes
- Fixed an issue where color-bar would show when not needed
- Fixed an issue with glTF file using URI
- Fixed `--help` invalid output
- Fixed a small issue with F3D dialog being incorrectly named on macOS
- Fixed an issue where file where open two times on macOS

For libf3d users:

- BREAKING CHANGE: All deprecated methods have been removed
- BREAKING CHANGE: `engine::libInformation` members have been changed
- BREAKING CHANGE: `options` API has been rewritten from scratch, see the doc
- BREAKING CHANGE: `options` many options are now optional
- BREAKING CHANGE: `loader` API has been replaced by a new class: `scene`
- BREAKING CHANGE: `engine` creation API has been rewritten from scratch and a `context` class has been added.
- BREAKING CHANGE: `interactor`: `setKeyPressCallBack`, `setDropFilesCallBack` and `timerCallback` have been removed
- BREAKING CHANGE: `camera` API has been reworked
- BREAKING CHANGE: `image::compare` API has been changed
- BREAKING CHANGE: libf3d API is now using C++17, `nodiscard`, `std::filesystem` and `std::string_view` are now used whenever it makes sense
- BREAKING CHANGE: Removed support for python 3.8
- Added an `interactor::command*` API that lets user control the libf3d behavior more finely
- Added an `interactor::binding*` API that lets user control how the libf3d respond to interactions
- Added an `scene::loadAnimationTime` API to select animation time to load
- Added `interactor::start` arg to control an event loop time and a event loop callback
- Added python stubs for autocompletion and IDE integration
- Added support for python 3.13
- Fixed an issue with instanciang multiple engines
- Added an `utils::collapsePath`
- Fixed an issue with HiDPI when using the libf3d on Windows

For F3D packagers:

- BREAKING CHANGE: Removed compatibility with older version of VTK. VTK v9.2.6 is now required.
- Added a new CMake options to build python stubs: `F3D_BINDINGS_PYTHON_GENERATE_STUBS`
- Added a new optional but internally provided dependency: tinyfiledialogs
- Modified dmon dependency to be optional
- `F3D_LINUX_APPLICATION_LINK_FILESYSTEM` has been renamed `F3D_LINUX_LINK_FILESYSTEM` and is now OFF by default

For F3D plugin developers:

- Added a vtkF3DImporter and vtkF3DGLTFImporter for easier subclassing

## v2.5.1

For F3D packagers:

- Added compatibility with VTK v9.4.0

## v2.5.0

For F3D users:

- Added a Webassembly version available online: https://f3d.app/viewer
- Added a "neutral" tone mapping feature
- Added an screenshot feature when pressing F12, with its dedicated option, `--screenshot-filename`
- Added a `--final-shader` option to customize post-processing.
- Added a `--grid-color` option to set the color of the grid
- Added a `--animation-progress` option to control if the animation progress bar should be shown
- Added a `--backface-type` option to control backface visibility
- Added a concept of filename [template](https://f3d.app/docs/next/user/OPTIONS#filename-templating) for saving screenshots and outputs
- Added native menus for macOS
- Improved documentation all around
- Reworked config file logic to avoid duplicating of the default config
- Fixed a long standing issue with FBX skinning animation
- Fixed zsh completion
- Fixed an opacity blending issue
- Fixed a crash when dropping a HDRI while playing an animation
- Fixed a focus issue on macOS
- Fixed a high DPI issue on Windows

For libf3d users:

- Added an API to control camera pan and zoom
- Added a tkinter python example
- Exposed log level in the python API

For F3D packagers:

- Fixed compatibility with CMake 3.29.1
- Fixed compatibility with OCCT 7_8_0
- Fixed build reproducibility by removing a path from the binary

## v2.4.0

For F3D users:

- Added a new option `--point-type` used to specify how to display points sprites
- Added support for 3D Gaussians Splatting in binary `.splat` format
- Added ability to cycle through available animations by pressing `W` hotkey
- Added display of current animation name within cheatsheet
- Added orthographic camera projection option (`--camera-orthographic`) and binding (`5`)
- Added proper continuous integration for MacOS ARM64
- Added support for glTF Draco encoded file
- Added support for dark title bar on Windows
- Added support for colormap presets, using `--colormap-file` option
- Added a option to reload file automatically when changed on disk (`--watch`)
- Added support for streaming output images to stdout, using `-` filename
- Added animation support to Alembic plugin
- Improved OCCT plugin (STEP and IGES files) performance drastically
- Improved config file parsing so that it is parsed in file order
- Fixed an issue with blur circle of confusion
- Fixed an issue with the grid being clipped
- Fixed an issue with STEP file coloring
- Fixed an issue when time range was not starting at zero
- Fixed an issue when record file does not exist
- Fixed an issue when using `--no-render` and `--hdri`
- Fixed an issue with the Windows thumbnailer with process never properly killed
- Fixed an issue where OCCT would output to terminal
- Fixed an issue with FISH completion

For libf3d users:

- Added a new option `model.point-sprites.type` used to specify how to display points (only if `model.point-sprites.enable` is true)
- Added a `image::toTerminalText` method to print image to terminal text
- Added an `image` metadata API
- Added a `vtkext` module for plugin developer, see the [documentation](https://f3d.app/docs/next/libf3d/PLUGINS)
- Added a new f3d component to find_package of, `pluginsdk`, require to build plugins against F3D

For F3D packagers:

- Added a CMake report at the end of configuration
- Added a new cmake installation component, `plugin_sdk`, needed to compile external plugin against F3D
- Added a new cmake installation component, `colormaps`, needed for the colormap feature
- Fixed multiple issue with static (`BUILD_SHARED_LIBS=OFF`) build
- Fixed a compilation issue with gcc14
- Fixed a compilation issue with OCCT 7.8.0

## v2.3.0

For F3D users:

- Added `--animation-autoplay` option (libf3d: `scene.animation.autoplay`) to automatically start animation on file load
- Added an experimental `vdb` plugin in order to read .vdb files using OpenVDB
- Added an `usd` plugin in order to read .usd files using OpenUSD
- Added .3mf and .x files support in the `assimp` plugin
- Added a small margin between the model and the grid to avoid potential z-fighting
- Added VTK output to the log when using `--verbose=debug` for easier debug
- Reworked the `alembic` plugin to read Texture Coordinates and Normals for .abc files
- Improved the reading of EXR files using multi-threading for better performance when loading HDRIs
- Improved the documentation on https://f3d.app
- Improved general logging in order to make it easier to understand issues with file and options
- Fixed potential crashes when reading `assimp` plugin file formats
- Fixed `--grid-absolute` for off-center models
- Fixed an issue with thumbnail generation showing the log window
- Fixed many interaction issues on non-Qwerty keyboard layout
- Fixed handling of filenames containing commas
- Fixed an issue on Windows where the log window would appear on top of F3D window
- Fixed crashes with specific .obj file
- Fixed an issue with incorrect return code when using headless mode or incorrect options
- Fixed dependency issue with the headless .deb binary release
- Fixed a crash when using a file with more than 254 bones (Requires OpenGL 4.3)
- Fixed an issue with Unicode filenames on the title bar on Windows
- Fixed an issue where focal point picking would generate error messages
- 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
- Changed the default configuration file so that translucency support is enabled by default
- Deprecated `--quiet`, use `--verbose=quiet` instead
- Deprecated `--input`, use positional argument instead

For libf3d users:

- Added `scene.animation.autoplay` option
- Added a `f3d::image::saveBuffer` API to save an image as a file format in memory
- Fixed the default name of the window

For F3D packagers:

- Added a new optional dependency, OpenUSD. Enable with `F3D_PLUGIN_BUILD_USD` CMake option
- Added a new optional dependency through VTK, OpenVDB. Enable with `F3D_PLUGIN_BUILD_VDB` CMake option
- Added a new CMake option to control the link against libatomic. Control with `F3D_LINUX_LIBRARY_LINK_ATOMIC`
- Added two new packages to the list, OpenMandriva and Mageia

## 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