mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-25 00:58:06 -05:00
171 lines
4.7 KiB
Plaintext
171 lines
4.7 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/raster/qgspalettedrasterrenderer.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class QgsPalettedRasterRenderer: QgsRasterRenderer
|
|
{
|
|
%Docstring
|
|
Renderer for paletted raster images.
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgspalettedrasterrenderer.h"
|
|
%End
|
|
public:
|
|
|
|
struct Class
|
|
{
|
|
Class( int value, const QColor &color = QColor(), const QString &label = QString() );
|
|
%Docstring
|
|
Constructor for Class
|
|
%End
|
|
|
|
int value;
|
|
|
|
QColor color;
|
|
QString label;
|
|
};
|
|
|
|
typedef QList< QgsPalettedRasterRenderer::Class > ClassData;
|
|
|
|
QgsPalettedRasterRenderer( QgsRasterInterface *input, int bandNumber, const ClassData &classes );
|
|
%Docstring
|
|
Constructor for QgsPalettedRasterRenderer.
|
|
%End
|
|
|
|
|
|
virtual QgsPalettedRasterRenderer *clone() const /Factory/;
|
|
|
|
%Docstring
|
|
QgsPalettedRasterRenderer cannot be copied. Use clone() instead.
|
|
%End
|
|
static QgsRasterRenderer *create( const QDomElement &elem, QgsRasterInterface *input ) /Factory/;
|
|
|
|
virtual QgsRasterBlock *block( int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback = 0 ) /Factory/;
|
|
|
|
|
|
int nColors() const;
|
|
%Docstring
|
|
Returns number of colors
|
|
%End
|
|
|
|
ClassData classes() const;
|
|
%Docstring
|
|
Returns a map of value to classes (colors) used by the renderer.
|
|
%End
|
|
|
|
QString label( int idx ) const;
|
|
%Docstring
|
|
Returns optional category label
|
|
|
|
.. versionadded:: 2.1
|
|
%End
|
|
|
|
void setLabel( int idx, const QString &label );
|
|
%Docstring
|
|
Set category label
|
|
|
|
.. versionadded:: 2.1
|
|
%End
|
|
|
|
int band() const;
|
|
%Docstring
|
|
Returns the raster band used for rendering the raster.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
virtual void writeXml( QDomDocument &doc, QDomElement &parentElem ) const;
|
|
|
|
|
|
virtual void legendSymbologyItems( QList< QPair< QString, QColor > > &symbolItems /Out/ ) const;
|
|
|
|
|
|
virtual QList<int> usesBands() const;
|
|
|
|
|
|
void setSourceColorRamp( QgsColorRamp *ramp /Transfer/ );
|
|
%Docstring
|
|
Set the source color ``ramp``. Ownership is transferred to the renderer.
|
|
|
|
.. seealso:: :py:func:`sourceColorRamp`
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
QgsColorRamp *sourceColorRamp() const;
|
|
%Docstring
|
|
Gets the source color ramp
|
|
|
|
.. seealso:: :py:func:`setSourceColorRamp`
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
static QgsPalettedRasterRenderer::ClassData colorTableToClassData( const QList<QgsColorRampShader::ColorRampItem> &table );
|
|
%Docstring
|
|
Converts a raster color ``table`` to paletted renderer class data.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
static QgsPalettedRasterRenderer::ClassData classDataFromString( const QString &string );
|
|
%Docstring
|
|
Converts a ``string`` containing a color table or class data to to paletted renderer class data.
|
|
|
|
.. seealso:: :py:func:`classDataFromFile`
|
|
|
|
.. seealso:: :py:func:`classDataToString`
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
static QgsPalettedRasterRenderer::ClassData classDataFromFile( const QString &path );
|
|
%Docstring
|
|
Opens a color table file and returns corresponding paletted renderer class data.
|
|
|
|
.. seealso:: :py:func:`classDataFromString`
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
static QString classDataToString( const QgsPalettedRasterRenderer::ClassData &classes );
|
|
%Docstring
|
|
Converts classes to a string representation, using the .clr/gdal color table file format.
|
|
|
|
.. seealso:: :py:func:`classDataFromString`
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
static QgsPalettedRasterRenderer::ClassData classDataFromRaster( QgsRasterInterface *raster, int bandNumber, QgsColorRamp *ramp = 0,
|
|
QgsRasterBlockFeedback *feedback = 0 );
|
|
%Docstring
|
|
Generates class data from a ``raster``, for the specified ``bandNumber``. An optional
|
|
color ``ramp`` can be specified to automatically assign colors from the ramp.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
private:
|
|
QgsPalettedRasterRenderer( const QgsPalettedRasterRenderer & );
|
|
const QgsPalettedRasterRenderer &operator=( const QgsPalettedRasterRenderer & );
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/raster/qgspalettedrasterrenderer.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|