STK::ProgressHandler Class Reference

#include <StkProgressHandler.h>

Public Member Functions
virtual bool	update (float percentage)

Detailed Description

ProgressHandler - Generic progress handler interface. This handler will be called at regular intervals during time consuming operations.

Member Function Documentation

update()

bool ProgressHandler::update ( float  percentage )

virtual

Called at regular intervals to update the progress. The return value of the method can be used to implement a cancel mechanism for the operation.

The default implementation simply logs the progress at DEBUG level.

Parameters

percentage

A number between 0 and 1 indicating how far the task has progressed.

Returns

true if the operation should continue, false if the operation should be canceled.

---

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

• Native/SilentToolkit/StkCore/StkProgressHandler.h
• Native/SilentToolkit/StkCore/StkProgressHandler.cpp