vrshoot
view libs/assimp/assimp/ProgressHandler.hpp @ 0:b2f14e535253
initial commit
| author | John Tsiombikas <nuclear@member.fsf.org> |
|---|---|
| date | Sat, 01 Feb 2014 19:58:19 +0200 |
| parents | |
| children |
line source
1 /*
2 Open Asset Import Library (assimp)
3 ----------------------------------------------------------------------
5 Copyright (c) 2006-2012, assimp team
6 All rights reserved.
8 Redistribution and use of this software in source and binary forms,
9 with or without modification, are permitted provided that the
10 following conditions are met:
12 * Redistributions of source code must retain the above
13 copyright notice, this list of conditions and the
14 following disclaimer.
16 * Redistributions in binary form must reproduce the above
17 copyright notice, this list of conditions and the
18 following disclaimer in the documentation and/or other
19 materials provided with the distribution.
21 * Neither the name of the assimp team, nor the names of its
22 contributors may be used to endorse or promote products
23 derived from this software without specific prior
24 written permission of the assimp team.
26 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 ----------------------------------------------------------------------
39 */
41 /** @file ProgressHandler.h
42 * @brief Abstract base class 'ProgressHandler'.
43 */
44 #ifndef INCLUDED_AI_PROGRESSHANDLER_H
45 #define INCLUDED_AI_PROGRESSHANDLER_H
46 #include "types.h"
47 namespace Assimp {
49 // ------------------------------------------------------------------------------------
50 /** @brief CPP-API: Abstract interface for custom progress report receivers.
51 *
52 * Each #Importer instance maintains its own #ProgressHandler. The default
53 * implementation provided by Assimp doesn't do anything at all. */
54 class ASSIMP_API ProgressHandler
55 : public Intern::AllocateFromAssimpHeap {
56 protected:
57 /** @brief Default constructor */
58 ProgressHandler () {
59 }
60 public:
61 /** @brief Virtual destructor */
62 virtual ~ProgressHandler () {
63 }
65 // -------------------------------------------------------------------
66 /** @brief Progress callback.
67 * @param percentage An estimate of the current loading progress,
68 * in percent. Or -1.f if such an estimate is not available.
69 *
70 * There are restriction on what you may do from within your
71 * implementation of this method: no exceptions may be thrown and no
72 * non-const #Importer methods may be called. It is
73 * not generally possible to predict the number of callbacks
74 * fired during a single import.
75 *
76 * @return Return false to abort loading at the next possible
77 * occasion (loaders and Assimp are generally allowed to perform
78 * all needed cleanup tasks prior to returning control to the
79 * caller). If the loading is aborted, #Importer::ReadFile()
80 * returns always NULL.
81 *
82 * @note Currently, percentage is always -1.f because there is
83 * no reliable way to compute it.
84 * */
85 virtual bool Update(float percentage = -1.f) = 0;
89 }; // !class ProgressHandler
90 // ------------------------------------------------------------------------------------
91 } // Namespace Assimp
93 #endif