Assimp
v3.1.1 (June 2014)
|
CPP-API: Abstract interface for custom progress report receivers. More...
Public Member Functions | |
virtual bool | Update (float percentage=-1.f)=0 |
Progress callback. | |
virtual void | UpdateFileRead (int currentStep, int numberOfSteps) |
Progress callback for file loading steps. | |
virtual void | UpdatePostProcess (int currentStep, int numberOfSteps) |
Progress callback for post-processing steps. | |
virtual | ~ProgressHandler () |
Virtual destructor. | |
Protected Member Functions | |
ProgressHandler () | |
Default constructor. |
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.
Assimp::ProgressHandler::ProgressHandler | ( | ) | [inline, protected] |
Default constructor.
virtual Assimp::ProgressHandler::~ProgressHandler | ( | ) | [inline, virtual] |
Virtual destructor.
virtual bool Assimp::ProgressHandler::Update | ( | float | percentage = -1.f | ) | [pure virtual] |
Progress callback.
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.
virtual void Assimp::ProgressHandler::UpdateFileRead | ( | int | currentStep, |
int | numberOfSteps | ||
) | [inline, virtual] |
Progress callback for file loading steps.
numberOfSteps | The number of total post-processing steps |
currentStep | The index of the current post-processing step that will run, or equal to numberOfSteps if all of them has finished. This number is always strictly monotone increasing, although not necessarily linearly. |
virtual void Assimp::ProgressHandler::UpdatePostProcess | ( | int | currentStep, |
int | numberOfSteps | ||
) | [inline, virtual] |
Progress callback for post-processing steps.
numberOfSteps | The number of total post-processing steps |
currentStep | The index of the current post-processing step that will run, or equal to numberOfSteps if all of them has finished. This number is always strictly monotone increasing, although not necessarily linearly. |