| SoProgressIndicator Class |
Class for reporting progress of a task.
Inheritance HierarchyNamespace: OIV.Inventor
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.1.1.0 (2024.1.1)
SyntaxThe SoProgressIndicator type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoProgressIndicator | Constructor. |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | OnBeginSubTask | Event raised when a sub-task begins. |
| OnBeginTask | Event raised when a task begins. |
| OnEndStep | Event raised when a steps ends. |
| OnEndSubTask | Event raised when a sub-task ends. |
| OnEndTask | Event raised when a task ends. |
RemarksThis 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 OIV.Inventor.SoProgressIndicator.onBeginTask, OIV.Inventor.SoProgressIndicator.onEndTask, OIV.Inventor.SoProgressIndicator.onBeginSubTask, OIV.Inventor.SoProgressIndicator.onEndSubTask, OIV.Inventor.SoProgressIndicator.onEndStep.
Each event has specific arguments: OIV.Inventor.SoProgressIndicator.TaskEventArg, OIV.Inventor.SoProgressIndicator.SubTaskEventArg, OIV.Inventor.SoProgressIndicator.StepEventArg.
Currently used in: OIV.VolumeViz.Nodes.SoVolumeRender (setRenderProgress).
See Also