1e93280f47
This commit adds two classes: * ProgressTracker * ProgressScope The first is for users to implement, and to instantiate when they desire to get informed about the overall progress. The second is to be added to all functions that may take a considerable amount of time, such that they can report back how far along they are. These are much more convenient to use than the existing ProgressHandler. ProgressScope is designed such that it only requires "local knowledge" about upcoming and finished work. Scopes are nested and combined to form the final global progress. The active ProgressTracker is stored in a thread_local pointer. This is a consicius decision since in assimp there is often no 'context' passed through. The ProgressTracker may be needed anywhere, and it would be tedious and a huge change to pass it through to every function. Therefore, using a thread_local variable makes it accessible everywhere, without a major interface change. Since assimmp is single-threaded, but may be run in parallel on multiple threads, a thread_local is a good trade-off, in my opinion. This change only adds few uses of ProgressScope, to generally show how it would be used. Also for our use cases these where the most pressing places to add progress reporting, so this already covers loading from FBX files pretty well. |
||
|---|---|---|
| .github | ||
| cmake-modules | ||
| code | ||
| contrib | ||
| doc | ||
| fuzz | ||
| include/assimp | ||
| packaging | ||
| port | ||
| samples | ||
| scripts | ||
| test | ||
| tools | ||
| .clang-format | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| BUILDBINARIES_EXAMPLE.bat | ||
| Build.md | ||
| CHANGES | ||
| CMakeLists.txt | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| CREDITS | ||
| CodeConventions.md | ||
| Dockerfile | ||
| INSTALL | ||
| LICENSE | ||
| Readme.md | ||
| SECURITY.md | ||
| assimp.pc.in | ||
| revision.h.in | ||
Readme.md
Open Asset Import Library (assimp)
Open Asset Import Library is a library to load various 3d file formats into a shared, in-memory format. It supports more than 40 file formats for import and a growing selection of file formats for export.
Current project status
APIs are provided for C and C++. There are various bindings to other languages (C#, Java, Python, Delphi, D). Assimp also runs on Android and iOS. Additionally, assimp features various mesh post processing tools: normals and tangent space generation, triangulation, vertex cache locality optimization, removal of degenerate primitives and duplicate vertices, sorting by primitive type, merging of redundant materials and many more.
Latest Doc's
Please check the latest documents at Asset-Importer-Lib-Doc.
Prebuild binaries
Please check our Itchi Projectspace
If you want to check our Model-Database, use the following repo: https://github.com/assimp/assimp-mdb
Communities
- Ask a question at The Assimp-Discussion Board
- Ask on Assimp-Community on Reddit
- Ask on StackOverflow with the assimp-tag.
- Nothing has worked? File a question or an issue-report at The Assimp-Issue Tracker
And we also have a Gitter-channel:Gitter
Supported file formats
You can find the complete list of supported file-formats here
Building
Take a look into the https://github.com/assimp/assimp/blob/master/Build.md file. We are available in vcpkg, and our build system is CMake; if you used CMake before there is a good chance you know what to do.
Ports
- Android
- Python
- .NET
- Pascal
- Javascript (Alpha)
- Javascript/Node.js Interface
- Unity 3d Plugin
- Unreal Engine Plugin
- JVM Full jvm port (current status)
- HAXE-Port The Assimp-HAXE-port.
- Rust
Other tools
open3mod is a powerful 3D model viewer based on Assimp's import and export abilities.
Repository structure
Open Asset Import Library is implemented in C++. The directory structure looks like:
/code Source code
/contrib Third-party libraries
/doc Documentation (doxysource and pre-compiled docs)
/fuzz Contains the test-code for the Google-Fuzzer project
/include Public header C and C++ header files
/scripts Scripts used to generate the loading code for some formats
/port Ports to other languages and scripts to maintain those.
/test Unit- and regression tests, test suite of models
/tools Tools (old assimp viewer, command line `assimp`)
/samples A small number of samples to illustrate possible use-cases for Assimp
The source code is organized in the following way:
code/Common The base implementation for importers and the infrastructure
code/CApi Special implementations which are only used for the C-API
code/Geometry A collection of geometry tools
code/Material The material system
code/PBR An exporter for physical based models
code/PostProcessing The post-processing steps
code/AssetLib/<FormatName> Implementation for import and export for the format
Contributing
Contributions to assimp are highly appreciated. The easiest way to get involved is to submit
a pull request with your changes against the main repository's master branch.
Contributors
Code Contributors
This project exists thanks to all the people who contribute. [Contribute].
Financial Contributors
Become a financial contributor and help us sustain our community. [Contribute]
Individuals
Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]
License
Our license is based on the modified, 3-clause BSD-License.
An informal summary is: do whatever you want, but include Assimp's license text with your product -
and don't sue us if our code doesn't work. Note that, unlike LGPLed code, you may link statically to Assimp.
For the legal details, see the LICENSE file.
Why this name
Sorry, we're germans :-), no english native speakers ...