CPP-API: Abstract interface for custom progress report receivers. More...
#include <ProgressHandler.hpp>
Inheritance diagram for Assimp::ProgressHandler:
Public Member Functions | |
| virtual | ~ProgressHandler () |
| Virtual destructor. | |
| virtual bool | Update (float percentage=-1.f)=0 |
| Progress callback. More... | |
Protected Member Functions | |
| ProgressHandler () | |
| Default constructor. | |
Detailed Description
CPP-API: Abstract interface for custom progress report receivers.
Each #Importer instance maintains its own ProgressHandler. The default implementation provided by Assimp doesn't do anything at all.
Member Function Documentation
§ Update()
|
pure virtual |
Progress callback.
- Parameters
-
percentage An estimate of the current loading progress, in percent. Or -1.f if such an estimate is not available.
There are restriction on what you may do from within your implementation of this method: no exceptions may be thrown and no non-const #Importer methods may be called. It is not generally possible to predict the number of callbacks fired during a single import.
- Returns
- Return false to abort loading at the next possible occasion (loaders and Assimp are generally allowed to perform all needed cleanup tasks prior to returning control to the caller). If the loading is aborted, #Importer::ReadFile() returns always NULL.
- Note
- Currently, percentage is always -1.f because there is no reliable way to compute it.
The documentation for this class was generated from the following file:
- external/assimp-3.1.1/include/assimp/ProgressHandler.hpp
