kfbxprogress.h

Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXIO_KFBXPROGRESS_H
00005 #define FBXFILESDK_KFBXIO_KFBXPROGRESS_H
00006 
00007 /**************************************************************************************
00008 
00009  Copyright (C) 2009 Autodesk, Inc. and/or its licensors.
00010  All Rights Reserved.
00011 
00012  The coded instructions, statements, computer programs, and/or related material 
00013  (collectively the "Data") in these files contain unpublished information 
00014  proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
00015  Canada and United States of America federal copyright law and by international 
00016  treaties. 
00017  
00018  The Data may not be disclosed or distributed to third parties, in whole or in
00019  part, without the prior written consent of Autodesk, Inc. ("Autodesk").
00020 
00021  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
00022  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
00023  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
00024  BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
00025  NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
00026  WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
00027  OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
00028  
00029  IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
00030  OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
00031  OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
00032  SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
00033  OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
00034  HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
00035  FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
00036  ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
00037  WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
00038  OR DAMAGE. 
00039 
00040 **************************************************************************************/
00041 #include <fbxfilesdk/fbxfilesdk_def.h>
00042 
00043 // FBX includes
00044 #include <fbxfilesdk/components/kbaselib/klib/kstring.h>
00045 
00046 // FBX namespace
00047 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00048 
00049 typedef void (*KFbxProgressCallback)(float pPercentage, KString pStatus);
00050 #define KFBX_PROGRESS_UPDATE_THRESHOLD 0.5f
00051 
00052 class KMpFastLock;
00053 
00057 class KFBX_DLL KFbxProgress
00058 {
00059 public:
00060     KFbxProgress();
00061     ~KFbxProgress();
00062     
00066     void SetTotal(float pTotal);
00067 
00072     void Add(float pDetaWorkload, const KString & pStatus);
00073 
00075     void Reset();
00076 
00080     void Compete(const KString & pStatus);
00081 
00086     float GetProgress(KString & pStatus) const;
00087 
00091     void SetProgressCallback(KFbxProgressCallback pCallback);
00092 
00093 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00094 
00095 private:
00096     float GetPercentage() const;
00097     KMpFastLock *mLock;
00098     float mTotal;
00099     float mCurrent;
00100     KString mStatus;
00101     float mUpdateThreshold;
00102     float mLastCallbackProgress;
00103     KFbxProgressCallback mCallback;
00104 
00105 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00106 
00107 };
00108 
00109 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00110 
00111 #endif // FBXFILESDK_KFBXIO_KFBXPROGRESS_H