neuray API Programmer's Manual

mi::neuraylib::IProgress_callback Class Reference

[Rendering and Picking]

Description

Abstract interface to report progress of a long-running operation back to the caller. Typically, an instance of this interface is passed to methods triggering long-running operations. The operation can now regularly call the progress() method of this instance to provide information about the progress of the operation to the caller.

For example, an instance of this interface can be passed to mi::neuraylib::IRender_context::render() and mi::neuraylib::IRender_context::render_async().

Note:

Instances of this interface should not be created on the stack, since this might lead to premature destruction of such instances while still being in use by the .

Public Member Functions

virtual void progress( Float64 value, const char* area, const char* message) =0
The callback method that provides the progress information. More...

Member Functions

virtual void mi::​neuraylib::​IProgress_callback::progress( Float64 value, const char* area, const char* message) [pure virtual]

The callback method that provides the progress information. It can be called at any time from any thread.

Note:
You must not call any of following methods from within the callback:

Parameters

value
This is some value which gives information about how much the work progressed. The interpretation depends on the area string. In some areas it might be a percentage, in some it might be an absolute value.
area
This describes the area where progress has been made.
message
This is a free form message which might be present and gives additional information about the progress in text form.