1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/libs/assimp/assimp/ProgressHandler.hpp	Sat Feb 01 19:58:19 2014 +0200
     1.3 @@ -0,0 +1,93 @@
     1.4 +/*
     1.5 +Open Asset Import Library (assimp)
     1.6 +----------------------------------------------------------------------
     1.7 +
     1.8 +Copyright (c) 2006-2012, assimp team
     1.9 +All rights reserved.
    1.10 +
    1.11 +Redistribution and use of this software in source and binary forms, 
    1.12 +with or without modification, are permitted provided that the 
    1.13 +following conditions are met:
    1.14 +
    1.15 +* Redistributions of source code must retain the above
    1.16 +  copyright notice, this list of conditions and the
    1.17 +  following disclaimer.
    1.18 +
    1.19 +* Redistributions in binary form must reproduce the above
    1.20 +  copyright notice, this list of conditions and the
    1.21 +  following disclaimer in the documentation and/or other
    1.22 +  materials provided with the distribution.
    1.23 +
    1.24 +* Neither the name of the assimp team, nor the names of its
    1.25 +  contributors may be used to endorse or promote products
    1.26 +  derived from this software without specific prior
    1.27 +  written permission of the assimp team.
    1.28 +
    1.29 +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
    1.30 +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
    1.31 +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    1.32 +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
    1.33 +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    1.34 +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
    1.35 +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    1.36 +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
    1.37 +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
    1.38 +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
    1.39 +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    1.40 +
    1.41 +----------------------------------------------------------------------
    1.42 +*/
    1.43 +
    1.44 +/** @file ProgressHandler.h
    1.45 + *  @brief Abstract base class 'ProgressHandler'.
    1.46 + */
    1.47 +#ifndef INCLUDED_AI_PROGRESSHANDLER_H
    1.48 +#define INCLUDED_AI_PROGRESSHANDLER_H
    1.49 +#include "types.h"
    1.50 +namespace Assimp	{
    1.51 +
    1.52 +// ------------------------------------------------------------------------------------
    1.53 +/** @brief CPP-API: Abstract interface for custom progress report receivers.
    1.54 + *
    1.55 + *  Each #Importer instance maintains its own #ProgressHandler. The default 
    1.56 + *  implementation provided by Assimp doesn't do anything at all. */
    1.57 +class ASSIMP_API ProgressHandler 
    1.58 +	: public Intern::AllocateFromAssimpHeap	{
    1.59 +protected:
    1.60 +	/** @brief	Default constructor	*/
    1.61 +	ProgressHandler () {
    1.62 +	}
    1.63 +public:
    1.64 +	/** @brief	Virtual destructor	*/
    1.65 +	virtual ~ProgressHandler () {
    1.66 +	}
    1.67 +
    1.68 +	// -------------------------------------------------------------------
    1.69 +	/** @brief Progress callback.
    1.70 +	 *  @param percentage An estimate of the current loading progress,
    1.71 +	 *    in percent. Or -1.f if such an estimate is not available.
    1.72 +	 *
    1.73 +	 *  There are restriction on what you may do from within your 
    1.74 +	 *  implementation of this method: no exceptions may be thrown and no
    1.75 +	 *  non-const #Importer methods may be called. It is 
    1.76 +	 *  not generally possible to predict the number of callbacks 
    1.77 +	 *  fired during a single import.
    1.78 +	 *
    1.79 +	 *  @return Return false to abort loading at the next possible
    1.80 +	 *   occasion (loaders and Assimp are generally allowed to perform
    1.81 +	 *   all needed cleanup tasks prior to returning control to the
    1.82 +	 *   caller). If the loading is aborted, #Importer::ReadFile()
    1.83 +	 *   returns always NULL.
    1.84 +	 *
    1.85 +	 *  @note Currently, percentage is always -1.f because there is 
    1.86 +	 *   no reliable way to compute it.
    1.87 +	 *   */
    1.88 +	virtual bool Update(float percentage = -1.f) = 0;
    1.89 +
    1.90 +
    1.91 +
    1.92 +}; // !class ProgressHandler 
    1.93 +// ------------------------------------------------------------------------------------
    1.94 +} // Namespace Assimp
    1.95 +
    1.96 +#endif