nuclear@0: /* nuclear@0: Open Asset Import Library (assimp) nuclear@0: ---------------------------------------------------------------------- nuclear@0: nuclear@0: Copyright (c) 2006-2018, assimp team nuclear@0: nuclear@0: nuclear@0: All rights reserved. nuclear@0: nuclear@0: Redistribution and use of this software in source and binary forms, nuclear@0: with or without modification, are permitted provided that the nuclear@0: following conditions are met: nuclear@0: nuclear@0: * Redistributions of source code must retain the above nuclear@0: copyright notice, this list of conditions and the nuclear@0: following disclaimer. nuclear@0: nuclear@0: * Redistributions in binary form must reproduce the above nuclear@0: copyright notice, this list of conditions and the nuclear@0: following disclaimer in the documentation and/or other nuclear@0: materials provided with the distribution. nuclear@0: nuclear@0: * Neither the name of the assimp team, nor the names of its nuclear@0: contributors may be used to endorse or promote products nuclear@0: derived from this software without specific prior nuclear@0: written permission of the assimp team. nuclear@0: nuclear@0: THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS nuclear@0: "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT nuclear@0: LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR nuclear@0: A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT nuclear@0: OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, nuclear@0: SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT nuclear@0: LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, nuclear@0: DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY nuclear@0: THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT nuclear@0: (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE nuclear@0: OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. nuclear@0: nuclear@0: ---------------------------------------------------------------------- nuclear@0: */ nuclear@0: nuclear@0: /** @file ProgressHandler.hpp nuclear@0: * @brief Abstract base class 'ProgressHandler'. nuclear@0: */ nuclear@0: #pragma once nuclear@0: #ifndef AI_PROGRESSHANDLER_H_INC nuclear@0: #define AI_PROGRESSHANDLER_H_INC nuclear@0: nuclear@0: #include "types.h" nuclear@0: nuclear@0: namespace Assimp { nuclear@0: nuclear@0: // ------------------------------------------------------------------------------------ nuclear@0: /** @brief CPP-API: Abstract interface for custom progress report receivers. nuclear@0: * nuclear@0: * Each #Importer instance maintains its own #ProgressHandler. The default nuclear@0: * implementation provided by Assimp doesn't do anything at all. */ nuclear@0: class ASSIMP_API ProgressHandler nuclear@0: #ifndef SWIG nuclear@0: : public Intern::AllocateFromAssimpHeap nuclear@0: #endif nuclear@0: { nuclear@0: protected: nuclear@0: /// @brief Default constructor nuclear@0: ProgressHandler () AI_NO_EXCEPT { nuclear@0: // empty nuclear@0: } nuclear@0: nuclear@0: public: nuclear@0: /// @brief Virtual destructor. nuclear@0: virtual ~ProgressHandler () { nuclear@0: } nuclear@0: nuclear@0: // ------------------------------------------------------------------- nuclear@0: /** @brief Progress callback. nuclear@0: * @param percentage An estimate of the current loading progress, nuclear@0: * in percent. Or -1.f if such an estimate is not available. nuclear@0: * nuclear@0: * There are restriction on what you may do from within your nuclear@0: * implementation of this method: no exceptions may be thrown and no nuclear@0: * non-const #Importer methods may be called. It is nuclear@0: * not generally possible to predict the number of callbacks nuclear@0: * fired during a single import. nuclear@0: * nuclear@0: * @return Return false to abort loading at the next possible nuclear@0: * occasion (loaders and Assimp are generally allowed to perform nuclear@0: * all needed cleanup tasks prior to returning control to the nuclear@0: * caller). If the loading is aborted, #Importer::ReadFile() nuclear@0: * returns always NULL. nuclear@0: * */ nuclear@0: virtual bool Update(float percentage = -1.f) = 0; nuclear@0: nuclear@0: // ------------------------------------------------------------------- nuclear@0: /** @brief Progress callback for file loading steps nuclear@0: * @param numberOfSteps The number of total post-processing nuclear@0: * steps nuclear@0: * @param currentStep The index of the current post-processing nuclear@0: * step that will run, or equal to numberOfSteps if all of nuclear@0: * them has finished. This number is always strictly monotone nuclear@0: * increasing, although not necessarily linearly. nuclear@0: * nuclear@0: * @note This is currently only used at the start and the end nuclear@0: * of the file parsing. nuclear@0: * */ nuclear@0: virtual void UpdateFileRead(int currentStep /*= 0*/, int numberOfSteps /*= 0*/) { nuclear@0: float f = numberOfSteps ? currentStep / (float)numberOfSteps : 1.0f; nuclear@0: Update( f * 0.5f ); nuclear@0: } nuclear@0: nuclear@0: // ------------------------------------------------------------------- nuclear@0: /** @brief Progress callback for post-processing steps nuclear@0: * @param numberOfSteps The number of total post-processing nuclear@0: * steps nuclear@0: * @param currentStep The index of the current post-processing nuclear@0: * step that will run, or equal to numberOfSteps if all of nuclear@0: * them has finished. This number is always strictly monotone nuclear@0: * increasing, although not necessarily linearly. nuclear@0: * */ nuclear@0: virtual void UpdatePostProcess(int currentStep /*= 0*/, int numberOfSteps /*= 0*/) { nuclear@0: float f = numberOfSteps ? currentStep / (float)numberOfSteps : 1.0f; nuclear@0: Update( f * 0.5f + 0.5f ); nuclear@0: } nuclear@0: nuclear@0: nuclear@0: // ------------------------------------------------------------------- nuclear@0: /** @brief Progress callback for export steps. nuclear@0: * @param numberOfSteps The number of total processing nuclear@0: * steps nuclear@0: * @param currentStep The index of the current post-processing nuclear@0: * step that will run, or equal to numberOfSteps if all of nuclear@0: * them has finished. This number is always strictly monotone nuclear@0: * increasing, although not necessarily linearly. nuclear@0: * */ nuclear@0: virtual void UpdateFileWrite(int currentStep /*= 0*/, int numberOfSteps /*= 0*/) { nuclear@0: float f = numberOfSteps ? currentStep / (float)numberOfSteps : 1.0f; nuclear@0: Update(f * 0.5f); nuclear@0: } nuclear@0: }; // !class ProgressHandler nuclear@0: nuclear@0: // ------------------------------------------------------------------------------------ nuclear@0: nuclear@0: } // Namespace Assimp nuclear@0: nuclear@0: #endif // AI_PROGRESSHANDLER_H_INC