FbxProgress Class Reference

#include <fbxprogress.h>

Class Description

Class for progress reporting.

Definition at line 31 of file fbxprogress.h.

Public Member Functions
void	SetProgressCallback (FbxProgressCallback pCallback, void *pArgs=((void *) 0))
	Register a callback function for progress reporting in single thread mode. More...
void	SetTotal (float pTotal)
	Set the total amount of workload needed to complete the progress. More...
void	SetThreshold (float pThreshold)
	Set the threshold at which the progress callback should be called. More...
void	Update (float pDelta, const char *pStatus=((void *) 0))
	Update current progress with recent workload. More...
void	Reset ()
	Reset the progress status percentage and status string. More...
float	GetProgress (FbxString *pStatus=((void *) 0))
	Retrieve the progress status. More...
void	Complete (const char *pStatus=((void *) 0))
	Set the progress status to completed. More...
void	Cancel ()
	Cancel this progress. More...
bool	IsCanceled () const
	Query whether user canceled this progress. More...

Member Function Documentation

SetProgressCallback()

void SetProgressCallback	(	FbxProgressCallback	pCallback,
		void *	pArgs = ((void *) 0)
	)

Register a callback function for progress reporting in single thread mode.

Parameters

pCallback	Pointer of the callback function.
pArgs	Pointer to the optional arguments passed to the callback function.

SetTotal()

void SetTotal

(

float

pTotal

)

Set the total amount of workload needed to complete the progress.

Parameters

pTotal

Total amount of workload.

Remarks

The default total is 100.0.

SetThreshold()

void SetThreshold

(

float

pThreshold

)

Set the threshold at which the progress callback should be called.

Parameters

pThreshold

The threshold value, between 0.0 and 100.0, that triggers the callback.

Remarks

The default threshold is 1.0, meaning that every 1% the callback is triggered.

Update()

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

Update current progress with recent workload.

Parameters

pDelta	Delta amount of workload progressed so far.
pStatus	Optional current progress status string.

Remarks

If a callback is set, it will be called upon caling this function.

Reset()

void Reset

(

)

Reset the progress status percentage and status string.

GetProgress()

float GetProgress

(

FbxString *

pStatus = ((void *) 0)

)

Retrieve the progress status.

Parameters

pStatus

Optional current progress status string.

Returns

The current progress percentage.

Complete()

void Complete

(

const char *

pStatus = ((void *) 0)

)

Set the progress status to completed.

Parameters

pStatus

Optional current progress status string.

Cancel()

void Cancel

(

)

Cancel this progress.

IsCanceled()

bool IsCanceled ( ) const

inline

Query whether user canceled this progress.

Definition at line 71 of file fbxprogress.h.

{ return mCanceled; }

---

The documentation for this class was generated from the following file:

• fbxsdk/fileio/fbxprogress.h