Package com.openinventor.inventor
Class SoProgressIndicator
- java.lang.Object
-
- com.openinventor.inventor.Inventor
-
- com.openinventor.inventor.SoProgressIndicator
-
public class SoProgressIndicator extends Inventor
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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SoProgressIndicator.StepEventArg
Class given to callback when an onEndStep is raised.static class
SoProgressIndicator.SubTaskEventArg
Class given to callback when onBeginSubTask/onEndSubTask are raised.static class
SoProgressIndicator.TaskEventArg
Class given to callback when onBeginTask/onEndTask are raised.-
Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
Inventor.ConstructorCommand
-
-
Field Summary
Fields Modifier and Type Field Description SbEventHandler<SoProgressIndicator.SubTaskEventArg>
onBeginSubTask
Event raised when a sub-task begins.SbEventHandler<SoProgressIndicator.TaskEventArg>
onBeginTask
Event raised when a task begins.SbEventHandler<SoProgressIndicator.StepEventArg>
onEndStep
Event raised when a steps ends.SbEventHandler<SoProgressIndicator.SubTaskEventArg>
onEndSubTask
Event raised when a sub-task ends.SbEventHandler<SoProgressIndicator.TaskEventArg>
onEndTask
Event raised when a task ends.-
Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle
-
-
Constructor Summary
Constructors Constructor Description SoProgressIndicator()
Constructor.
-
Method Summary
-
Methods inherited from class com.openinventor.inventor.Inventor
dispose, getNativeResourceHandle
-
-
-
-
Field Detail
-
onBeginTask
public final SbEventHandler<SoProgressIndicator.TaskEventArg> onBeginTask
Event raised when a task begins.
-
onEndTask
public final SbEventHandler<SoProgressIndicator.TaskEventArg> onEndTask
Event raised when a task ends.
-
onBeginSubTask
public final SbEventHandler<SoProgressIndicator.SubTaskEventArg> onBeginSubTask
Event raised when a sub-task begins.
-
onEndSubTask
public final SbEventHandler<SoProgressIndicator.SubTaskEventArg> onEndSubTask
Event raised when a sub-task ends.
-
onEndStep
public final SbEventHandler<SoProgressIndicator.StepEventArg> onEndStep
Event raised when a steps ends. A step is inside a SubTask(Begin/End).
-
-