INoSignalCheckProgress Class Reference

An alternative progress reporting interface to class RendProgressCallback, which does not process the window message queue. More...

#include <INoSignalCheckProgress.h>

Public Member Functions
virtual void	UpdateProgress (int done, int total)=0
	Reports a progress update. More...

Detailed Description

An alternative progress reporting interface to class RendProgressCallback, which does not process the window message queue.

Production rendering typically reports progress through RendProgressCallback::Progress(), a method which processes the window message queue in order to update the progress bar and determine wheter the user has pressed the cancel button. This behaviour is sometimes undesirable. When updating a scene for ActiveShade, processing the window message queue while reporting progress may cause user interactions to be processed as well - and this may interfere with the scene update. In such cases, this interface should be used.

To retrieve a pointer to this interface, perform a dynamic_cast on a RendProgressCallback:

RendProgressCallback* progress_callback = ...;
INoSignalCheckProgress* no_signals_progress_callback = dynamic_cast<INoSignalCheckProgress*>(progress_callback);

Member Function Documentation

UpdateProgress()

virtual void UpdateProgress ( int  done, int  total  )

pure virtual

Reports a progress update.

Parameters

done	The number of steps which are currently done.
total	The total number of steps to be perform.