QGIS API Documentation 3.39.0-Master (bca3cdb6021)
|
Feedback object tailored for raster block reading. More...
#include <qgsrasterinterface.h>
Public Member Functions | |
QgsRasterBlockFeedback (QObject *parent=nullptr) | |
Construct a new raster block feedback object. | |
void | appendError (const QString &error) |
Appends an error message to the stored list of errors. | |
QStringList | errors () const |
Returns a list of any errors encountered while retrieving the raster block. | |
bool | isPreviewOnly () const |
Whether the raster provider should return only data that are already available without waiting for full result. | |
virtual void | onNewData () |
May be emitted by raster data provider to indicate that some partial data are available and a new preview image may be produced. | |
QgsRenderContext | renderContext () const |
Returns the render context of the associated block reading. | |
bool | renderPartialOutput () const |
Whether our painter is drawing to a temporary image used just by this layer. | |
void | setPreviewOnly (bool preview) |
set flag whether the block request is for preview purposes only | |
void | setRenderContext (const QgsRenderContext &renderContext) |
Sets the render context of the associated block reading. | |
void | setRenderPartialOutput (bool enable) |
Set whether our painter is drawing to a temporary image used just by this layer. | |
Public Member Functions inherited from QgsFeedback | |
QgsFeedback (QObject *parent=nullptr) | |
Construct a feedback object. | |
bool | isCanceled () const |
Tells whether the operation has been canceled already. | |
unsigned long long | processedCount () const |
Returns the current processed objects count reported by the feedback object. | |
double | progress () const |
Returns the current progress reported by the feedback object. | |
void | setProcessedCount (unsigned long long processedCount) |
Sets the current processed objects count for the feedback object. | |
void | setProgress (double progress) |
Sets the current progress for the feedback object. | |
Additional Inherited Members | |
Public Slots inherited from QgsFeedback | |
void | cancel () |
Tells the internal routines that the current operation should be canceled. This should be run by the main thread. | |
Signals inherited from QgsFeedback | |
void | canceled () |
Internal routines can connect to this signal if they use event loop. | |
void | processedCountChanged (unsigned long long processedCount) |
Emitted when the feedback object reports a change in the number of processed objects. | |
void | progressChanged (double progress) |
Emitted when the feedback object reports a progress change. | |
Feedback object tailored for raster block reading.
Definition at line 41 of file qgsrasterinterface.h.
|
inline |
Construct a new raster block feedback object.
Definition at line 47 of file qgsrasterinterface.h.
|
inline |
Appends an error message to the stored list of errors.
Should be called whenever an error is encountered while retrieving a raster block.
Definition at line 87 of file qgsrasterinterface.h.
|
inline |
Returns a list of any errors encountered while retrieving the raster block.
Definition at line 95 of file qgsrasterinterface.h.
|
inline |
Whether the raster provider should return only data that are already available without waiting for full result.
By default this flag is not enabled.
Definition at line 60 of file qgsrasterinterface.h.
|
inlinevirtual |
May be emitted by raster data provider to indicate that some partial data are available and a new preview image may be produced.
Definition at line 53 of file qgsrasterinterface.h.
QgsRenderContext QgsRasterBlockFeedback::renderContext | ( | ) | const |
Returns the render context of the associated block reading.
Definition at line 657 of file qgsrasterinterface.cpp.
|
inline |
Whether our painter is drawing to a temporary image used just by this layer.
Definition at line 72 of file qgsrasterinterface.h.
|
inline |
set flag whether the block request is for preview purposes only
Definition at line 66 of file qgsrasterinterface.h.
void QgsRasterBlockFeedback::setRenderContext | ( | const QgsRenderContext & | renderContext | ) |
Sets the render context of the associated block reading.
Definition at line 662 of file qgsrasterinterface.cpp.
|
inline |
Set whether our painter is drawing to a temporary image used just by this layer.
Definition at line 78 of file qgsrasterinterface.h.