vrProgressService

class vrProgressService

(Inherits vrBaseService)

Reports the progress of a currently running operation.

Only some long running operations will report there progress through this service

Summary

Functions:

• cancelOperation()

Signals:

• operationFinished(canceled)
• operationStarted(state)
• progressChanged(progress)
• stateChanged(state)

Functions

vrProgressService.cancelOperation()

Cancels the currently running opertation.

Signals

vrProgressService.operationFinished(canceled)

An operation that reports its progress has finished.

Parameters:canceled (bool) – If True, the operation has been manually canceled

vrProgressService.operationStarted(state)

An operation that reports its progress has started.

Parameters:state (string) – An optional description of the current operation

vrProgressService.progressChanged(progress)

The progress value has changed.

Parameters:progress (float) – A value from 0 to 1

vrProgressService.stateChanged(state)

The operation state has changed.

Parameters:state (string) – The state of the running operation