miniassimp

annotate include/miniassimp/ProgressHandler.hpp @ 0:879c81d94345

find changesets by author, revision, files, or words in the commit message
initial commit
author John Tsiombikas <nuclear@member.fsf.org>
date Mon, 28 Jan 2019 18:19:26 +0200
parents
children
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-2018, assimp team
nuclear@0 6
nuclear@0 7
nuclear@0 8 All rights reserved.
nuclear@0 9
nuclear@0 10 Redistribution and use of this software in source and binary forms,
nuclear@0 11 with or without modification, are permitted provided that the
nuclear@0 12 following conditions are met:
nuclear@0 13
nuclear@0 14 * Redistributions of source code must retain the above
nuclear@0 15 copyright notice, this list of conditions and the
nuclear@0 16 following disclaimer.
nuclear@0 17
nuclear@0 18 * Redistributions in binary form must reproduce the above
nuclear@0 19 copyright notice, this list of conditions and the
nuclear@0 20 following disclaimer in the documentation and/or other
nuclear@0 21 materials provided with the distribution.
nuclear@0 22
nuclear@0 23 * Neither the name of the assimp team, nor the names of its
nuclear@0 24 contributors may be used to endorse or promote products
nuclear@0 25 derived from this software without specific prior
nuclear@0 26 written permission of the assimp team.
nuclear@0 27
nuclear@0 28 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
nuclear@0 29 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
nuclear@0 30 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
nuclear@0 31 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
nuclear@0 32 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
nuclear@0 33 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
nuclear@0 34 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
nuclear@0 35 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
nuclear@0 36 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
nuclear@0 37 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
nuclear@0 38 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
nuclear@0 39
nuclear@0 40 ----------------------------------------------------------------------
nuclear@0 41 */
nuclear@0 42
nuclear@0 43 /** @file ProgressHandler.hpp
nuclear@0 44 * @brief Abstract base class 'ProgressHandler'.
nuclear@0 45 */
nuclear@0 46 #pragma once
nuclear@0 47 #ifndef AI_PROGRESSHANDLER_H_INC
nuclear@0 48 #define AI_PROGRESSHANDLER_H_INC
nuclear@0 49
nuclear@0 50 #include "types.h"
nuclear@0 51
nuclear@0 52 namespace Assimp {
nuclear@0 53
nuclear@0 54 // ------------------------------------------------------------------------------------
nuclear@0 55 /** @brief CPP-API: Abstract interface for custom progress report receivers.
nuclear@0 56 *
nuclear@0 57 * Each #Importer instance maintains its own #ProgressHandler. The default
nuclear@0 58 * implementation provided by Assimp doesn't do anything at all. */
nuclear@0 59 class ASSIMP_API ProgressHandler
nuclear@0 60 #ifndef SWIG
nuclear@0 61 : public Intern::AllocateFromAssimpHeap
nuclear@0 62 #endif
nuclear@0 63 {
nuclear@0 64 protected:
nuclear@0 65 /// @brief Default constructor
nuclear@0 66 ProgressHandler () AI_NO_EXCEPT {
nuclear@0 67 // empty
nuclear@0 68 }
nuclear@0 69
nuclear@0 70 public:
nuclear@0 71 /// @brief Virtual destructor.
nuclear@0 72 virtual ~ProgressHandler () {
nuclear@0 73 }
nuclear@0 74
nuclear@0 75 // -------------------------------------------------------------------
nuclear@0 76 /** @brief Progress callback.
nuclear@0 77 * @param percentage An estimate of the current loading progress,
nuclear@0 78 * in percent. Or -1.f if such an estimate is not available.
nuclear@0 79 *
nuclear@0 80 * There are restriction on what you may do from within your
nuclear@0 81 * implementation of this method: no exceptions may be thrown and no
nuclear@0 82 * non-const #Importer methods may be called. It is
nuclear@0 83 * not generally possible to predict the number of callbacks
nuclear@0 84 * fired during a single import.
nuclear@0 85 *
nuclear@0 86 * @return Return false to abort loading at the next possible
nuclear@0 87 * occasion (loaders and Assimp are generally allowed to perform
nuclear@0 88 * all needed cleanup tasks prior to returning control to the
nuclear@0 89 * caller). If the loading is aborted, #Importer::ReadFile()
nuclear@0 90 * returns always NULL.
nuclear@0 91 * */
nuclear@0 92 virtual bool Update(float percentage = -1.f) = 0;
nuclear@0 93
nuclear@0 94 // -------------------------------------------------------------------
nuclear@0 95 /** @brief Progress callback for file loading steps
nuclear@0 96 * @param numberOfSteps The number of total post-processing
nuclear@0 97 * steps
nuclear@0 98 * @param currentStep The index of the current post-processing
nuclear@0 99 * step that will run, or equal to numberOfSteps if all of
nuclear@0 100 * them has finished. This number is always strictly monotone
nuclear@0 101 * increasing, although not necessarily linearly.
nuclear@0 102 *
nuclear@0 103 * @note This is currently only used at the start and the end
nuclear@0 104 * of the file parsing.
nuclear@0 105 * */
nuclear@0 106 virtual void UpdateFileRead(int currentStep /*= 0*/, int numberOfSteps /*= 0*/) {
nuclear@0 107 float f = numberOfSteps ? currentStep / (float)numberOfSteps : 1.0f;
nuclear@0 108 Update( f * 0.5f );
nuclear@0 109 }
nuclear@0 110
nuclear@0 111 // -------------------------------------------------------------------
nuclear@0 112 /** @brief Progress callback for post-processing steps
nuclear@0 113 * @param numberOfSteps The number of total post-processing
nuclear@0 114 * steps
nuclear@0 115 * @param currentStep The index of the current post-processing
nuclear@0 116 * step that will run, or equal to numberOfSteps if all of
nuclear@0 117 * them has finished. This number is always strictly monotone
nuclear@0 118 * increasing, although not necessarily linearly.
nuclear@0 119 * */
nuclear@0 120 virtual void UpdatePostProcess(int currentStep /*= 0*/, int numberOfSteps /*= 0*/) {
nuclear@0 121 float f = numberOfSteps ? currentStep / (float)numberOfSteps : 1.0f;
nuclear@0 122 Update( f * 0.5f + 0.5f );
nuclear@0 123 }
nuclear@0 124
nuclear@0 125
nuclear@0 126 // -------------------------------------------------------------------
nuclear@0 127 /** @brief Progress callback for export steps.
nuclear@0 128 * @param numberOfSteps The number of total processing
nuclear@0 129 * steps
nuclear@0 130 * @param currentStep The index of the current post-processing
nuclear@0 131 * step that will run, or equal to numberOfSteps if all of
nuclear@0 132 * them has finished. This number is always strictly monotone
nuclear@0 133 * increasing, although not necessarily linearly.
nuclear@0 134 * */
nuclear@0 135 virtual void UpdateFileWrite(int currentStep /*= 0*/, int numberOfSteps /*= 0*/) {
nuclear@0 136 float f = numberOfSteps ? currentStep / (float)numberOfSteps : 1.0f;
nuclear@0 137 Update(f * 0.5f);
nuclear@0 138 }
nuclear@0 139 }; // !class ProgressHandler
nuclear@0 140
nuclear@0 141 // ------------------------------------------------------------------------------------
nuclear@0 142
nuclear@0 143 } // Namespace Assimp
nuclear@0 144
nuclear@0 145 #endif // AI_PROGRESSHANDLER_H_INC