Click or drag to resize
SoProgressIndicator Class

Class for reporting progress of a task.

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoProgressIndicator

Namespace: OIV.Inventor
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.2.1.0 (10.16.1.0)
Syntax
public class SoProgressIndicator : SoNetBase

The SoProgressIndicator type exposes the following members.

Constructors
  NameDescription
Public methodSoProgressIndicator

Constructor.

Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventOnBeginSubTask

Event raised when a sub-task begins.

Public eventOnBeginTask

Event raised when a task begins.

Public eventOnEndStep

Event raised when a steps ends.

Public eventOnEndSubTask

Event raised when a sub-task ends.

Public eventOnEndTask

Event raised when a task ends.

Top
Remarks

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 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