fbxprogress.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2012 Autodesk, Inc.
   All rights reserved.
 
   Use of this software is subject to the terms of the Autodesk license agreement
   provided at the time of installation or download, or which otherwise accompanies
   this software in either electronic or hard copy form.
 
****************************************************************************************/

#ifndef _FBXSDK_FILEIO_PROGRESS_H_
#define _FBXSDK_FILEIO_PROGRESS_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/base/fbxstring.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

#define FBXSDK_PROGRESS_UPDATE_THRESHOLD 0.5f

typedef bool (*FbxProgressCallback)(float pPercentage, FbxString pStatus);

class FbxSpinLock;

class FBXSDK_DLL FbxProgress
{
public:
    FbxProgress();
    ~FbxProgress();
    
    void SetTotal(float pTotal);

    void Add(float pDetaWorkload, const FbxString & pStatus);

    void Reset();

    void Complete(const FbxString & pStatus);

    float GetProgress(FbxString & pStatus) const;

    void SetProgressCallback(FbxProgressCallback pCallback);

    void Cancel(bool pIsCanceled)
    {
        mCanceled = pIsCanceled;
    }

    bool IsCanceled() const
    {
        return mCanceled;
    }

#ifndef DOXYGEN_SHOULD_SKIP_THIS

private:
    float GetPercentage() const;
    FbxSpinLock *mLock;
    float mTotal;
    float mCurrent;
    FbxString mStatus;
    float mUpdateThreshold;
    float mLastCallbackProgress;
    FbxProgressCallback mCallback;
    bool mCanceled;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_FILEIO_PROGRESS_H_ */