-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgspalettedrasterrenderer.sip.in
173 lines (118 loc) · 4.82 KB
/
qgspalettedrasterrenderer.sip.in
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/************************************************************************
* 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;
virtual void toSld( QDomDocument &doc, QDomElement &element, const QgsStringMap &props = QgsStringMap() ) 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 *
************************************************************************/