QGIS/python/core/raster/qgsrasteriterator.sip
Denis Rouzaud b119744773 replace cancelling, cancelled and cancellation by canceling, canceled and cancelation, respectively (#4000)
* replace cancelling and cancelled by canceling and canceled, respectively

see https://github.com/qgis/qgis3_UIX_discussion/issues/19

* replace cancellation by cancelation
2017-01-16 22:27:14 +01:00

43 lines
1.5 KiB
Plaintext

class QgsRasterIterator
{
%TypeHeaderCode
#include <qgsrasteriterator.h>
%End
public:
QgsRasterIterator( QgsRasterInterface* input );
/** Start reading of raster band. Raster data can then be retrieved by calling readNextRasterPart until it returns false.
@param bandNumber number of raster band to read
@param nCols number of columns
@param nRows number of rows
@param extent area to read
@param feedback optional raster feedback object for cancelation/preview. Added in QGIS 3.0.
*/
void startRasterRead( int bandNumber, int nCols, int nRows, const QgsRectangle& extent, QgsRasterBlockFeedback* feedback = nullptr );
/** Fetches next part of raster data, caller takes ownership of the block and
caller should delete the block.
@param bandNumber band to read
@param nCols number of columns on output device
@param nRows number of rows on output device
@param block address of block pointer
@param topLeftCol top left column
@param topLeftRow top left row
@return false if the last part was already returned*/
bool readNextRasterPart( int bandNumber,
int& nCols, int& nRows,
QgsRasterBlock **block,
int& topLeftCol, int& topLeftRow );
void stopRasterRead( int bandNumber );
const QgsRasterInterface* input() const;
void setMaximumTileWidth( int w );
int maximumTileWidth() const;
void setMaximumTileHeight( int h );
int maximumTileHeight() const;
};