fbxprogress.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2013 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>

typedef bool (*FbxProgressCallback)(void* pArgs, float pPercentage, const char* pStatus);

#ifndef FBXSDK_ENV_WINRT
    class FbxSpinLock;
#endif

class FBXSDK_DLL FbxProgress
{
public:
    void SetProgressCallback(FbxProgressCallback pCallback, void* pArgs=NULL);

    void SetTotal(float pTotal);

    void SetThreshold(float pThreshold);

    void Update(float pDelta, const char* pStatus=NULL);

    void Reset();

    float GetProgress(FbxString* pStatus=NULL);

    void Complete(const char* pStatus=NULL);

    void Cancel();

    inline bool IsCanceled() const { return mCanceled; }

/*****************************************************************************************************************************
** WARNING! Anything beyond these lines is for internal use, may not be documented and is subject to change without notice! **
*****************************************************************************************************************************/
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    FbxProgress();
    ~FbxProgress();

private:
    void Acquire();
    void Release();
    float GetPercent() const;
    bool ExecuteCallback() const;

#ifndef FBXSDK_ENV_WINRT
    FbxSpinLock*        mLock;
#endif
    float               mCurrent;
    float               mPrevious;
    float               mTotal;
    float               mThreshold;
    FbxString           mStatus;
    FbxProgressCallback mCallback;
    void*               mCallbackArgs;
    bool                mCanceled;
#endif /* !DOXYGEN_SHOULD_SKIP_THIS *****************************************************************************************/
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_FILEIO_PROGRESS_H_ */