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