Class for reporting progress of a task. More...
#include <Inventor/SoProgressIndicator.h>
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 () | |
Constructor. | |
virtual | ~SoProgressIndicator () |
Public Attributes | |
SbEventHandler< TaskEventArg & > | onBeginTask |
Event raised when a task begins. | |
SbEventHandler< TaskEventArg & > | onEndTask |
Event raised when a task ends. | |
SbEventHandler< SubTaskEventArg & > | onBeginSubTask |
Event raised when a sub-task begins. | |
SbEventHandler< SubTaskEventArg & > | onEndSubTask |
Event raised when a sub-task ends. | |
SbEventHandler< StepEventArg & > | onEndStep |
Event raised when a steps ends. | |
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).
Definition at line 52 of file SoProgressIndicator.h.
|
inline |
Constructor.
Definition at line 59 of file SoProgressIndicator.h.
|
inlinevirtual |
Definition at line 61 of file SoProgressIndicator.h.
SbEventHandler<SubTaskEventArg&> SoProgressIndicator::onBeginSubTask |
Event raised when a sub-task begins.
Definition at line 176 of file SoProgressIndicator.h.
SbEventHandler<TaskEventArg&> SoProgressIndicator::onBeginTask |
Event raised when a task begins.
Definition at line 166 of file SoProgressIndicator.h.
SbEventHandler<StepEventArg&> SoProgressIndicator::onEndStep |
Event raised when a steps ends.
A step is inside a SubTask(Begin/End).
Definition at line 187 of file SoProgressIndicator.h.
SbEventHandler<SubTaskEventArg&> SoProgressIndicator::onEndSubTask |
Event raised when a sub-task ends.
Definition at line 181 of file SoProgressIndicator.h.
SbEventHandler<TaskEventArg&> SoProgressIndicator::onEndTask |
Event raised when a task ends.
Definition at line 171 of file SoProgressIndicator.h.