SoProgressIndicator Class Reference
[Basics]

Class for reporting progress of a task. More...

#include <Inventor/SoProgressIndicator.h>

List of all members.

Classes
struct	StepEventArg
	Class given to callback when an onEndStep is raised. More...
struct	SubTaskEventArg
	Class given to callback when onBeginSubTask/onEndSubTask are raised. More...
struct	TaskEventArg
	Class given to callback when onBeginTask/onEndTask are raised. More...
Public Member Functions
	SoProgressIndicator ()
virtual	~SoProgressIndicator ()
Public Attributes
SbEventHandler< TaskEventArg & >	onBeginTask
SbEventHandler< TaskEventArg & >	onEndTask
SbEventHandler< SubTaskEventArg & >	onBeginSubTask
SbEventHandler< SubTaskEventArg & >	onEndSubTask
SbEventHandler< StepEventArg & >	onEndStep

---

Detailed Description

Class for reporting progress of a task.

This class notifies the application when a task (for example a long computation) starts, stops and when it is in progress. This is useful, for example, to allow the application to update a progress bar.

Potentially long processes are conceptually divided into sequential tasks, which are divided into subtasks, which may have multiple iteration steps. Not every process uses all of the above. See each specific use of this class for details about the specific process.

See events onBeginTask, onEndTask, onBeginSubTask, onEndSubTask, onEndStep.

Each event has specific arguments: SoProgressIndicator::TaskEventArg, SoProgressIndicator::SubTaskEventArg, SoProgressIndicator::StepEventArg.

Currently used in: SoVolumeRender (setRenderProgress).

SEE ALSO

SoVolumeRender

See related examples:

SimpleLightedVolume

---

Constructor & Destructor Documentation

SoProgressIndicator::SoProgressIndicator

(

)

[inline]

Constructor.

virtual SoProgressIndicator::~SoProgressIndicator

(

)

[inline, virtual]

---

Member Data Documentation

SbEventHandler<SubTaskEventArg&> SoProgressIndicator::onBeginSubTask

Event raised when a sub-task begins.

SbEventHandler<TaskEventArg&> SoProgressIndicator::onBeginTask

Event raised when a task begins.

SbEventHandler<StepEventArg&> SoProgressIndicator::onEndStep

Event raised when a steps ends.

A step is inside a SubTask(Begin/End).

SbEventHandler<SubTaskEventArg&> SoProgressIndicator::onEndSubTask

Event raised when a sub-task ends.

SbEventHandler<TaskEventArg&> SoProgressIndicator::onEndTask

Event raised when a task ends.

---

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

• Inventor/SoProgressIndicator.h