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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/effects/qgscoloreffect.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsColorEffect : QgsPaintEffect /NoDefaultCtors/
{
%Docstring(signature="appended")
A paint effect which alters the colors (e.g., brightness, contrast) in a
source picture.
.. versionadded:: 2.9
%End
%TypeHeaderCode
#include "qgscoloreffect.h"
%End
public:
static QgsPaintEffect *create( const QVariantMap &map ) /Factory/;
%Docstring
Creates a new QgsColorEffect effect from a properties string map.
:param map: encoded properties string map
:return: new QgsColorEffect
%End
QgsColorEffect();
virtual QString type() const;
virtual QVariantMap properties() const;
virtual void readProperties( const QVariantMap &props );
virtual QgsColorEffect *clone() const /Factory/;
void setBrightness( int brightness );
%Docstring
Sets the brightness modification for the effect.
:param brightness: Valid values are between -255 and 255, where 0 represents
no change, negative values indicate darkening and positive values indicate
lightening
.. seealso:: :py:func:`setBrightness`
%End
int brightness() const;
%Docstring
Returns the brightness modification for the effect.
:return: brightness value. Values are between -255 and 255, where 0 represents
no change, negative values indicate darkening and positive values indicate
lightening
.. seealso:: :py:func:`setBrightness`
%End
void setContrast( int contrast );
%Docstring
Sets the contrast modification for the effect.
:param contrast: Valid values are between -100 and 100, where 0 represents
no change, negative values indicate less contrast and positive values indicate
greater contrast
.. seealso:: :py:func:`setContrast`
%End
int contrast() const;
%Docstring
Returns the contrast modification for the effect.
:return: contrast value. Values are between -100 and 100, where 0 represents
no change, negative values indicate less contrast and positive values indicate
greater contrast
.. seealso:: :py:func:`setContrast`
%End
void setSaturation( double saturation );
%Docstring
Sets the saturation modification for the effect.
:param saturation: Valid values are between 0 and 2.0, where 1.0 represents
no change, 0.0 represents totally desaturated (grayscale), and positive values indicate
greater saturation
.. seealso:: :py:func:`saturation`
%End
double saturation() const;
%Docstring
Returns the saturation modification for the effect.
:return: saturation value. Values are between 0 and 2.0, where 1.0 represents
no change, 0.0 represents totally desaturated (grayscale), and positive values indicate
greater saturation
.. seealso:: :py:func:`setSaturation`
%End
void setGrayscaleMode( QgsImageOperation::GrayscaleMode grayscaleMode );
%Docstring
Sets whether the effect should convert a picture to grayscale.
:param grayscaleMode: method for grayscale conversion
.. seealso:: :py:func:`grayscaleMode`
%End
QgsImageOperation::GrayscaleMode grayscaleMode() const;
%Docstring
Returns whether the effect will convert a picture to grayscale.
:return: method for grayscale conversion
.. seealso:: :py:func:`setGrayscaleMode`
%End
void setColorizeOn( bool colorizeOn );
%Docstring
Sets whether the effect should colorize a picture.
:param colorizeOn: set to ``True`` to enable colorization
.. seealso:: :py:func:`colorizeOn`
.. seealso:: :py:func:`setColorizeColor`
.. seealso:: :py:func:`setColorizeStrength`
%End
bool colorizeOn() const;
%Docstring
Returns whether the effect will colorize a picture.
:return: ``True`` if colorization is enabled
.. seealso:: :py:func:`setColorizeOn`
.. seealso:: :py:func:`colorizeColor`
.. seealso:: :py:func:`colorizeStrength`
%End
void setColorizeColor( const QColor &colorizeColor );
%Docstring
Sets the color used for colorizing a picture. This is only used if
:py:func:`~QgsColorEffect.setColorizeOn` is set to ``True``.
:param colorizeColor: colorization color
.. seealso:: :py:func:`colorizeColor`
.. seealso:: :py:func:`setColorizeOn`
.. seealso:: :py:func:`setColorizeStrength`
%End
QColor colorizeColor() const;
%Docstring
Returns the color used for colorizing a picture. This is only used if
:py:func:`~QgsColorEffect.colorizeOn` is set to ``True``.
:return: colorization color
.. seealso:: :py:func:`setColorizeColor`
.. seealso:: :py:func:`colorizeOn`
.. seealso:: :py:func:`colorizeStrength`
%End
void setColorizeStrength( int colorizeStrength );
%Docstring
Sets the strength for colorizing a picture. This is only used if
:py:func:`~QgsColorEffect.setColorizeOn` is set to ``True``.
:param colorizeStrength: colorization strength, between 0 and 100
.. seealso:: :py:func:`colorizeStrength`
.. seealso:: :py:func:`setColorizeOn`
.. seealso:: :py:func:`setColorizeColor`
%End
int colorizeStrength() const;
%Docstring
Returns the strength used for colorizing a picture. This is only used if
:py:func:`~QgsColorEffect.setColorizeOn` is set to ``True``.
:return: colorization strength, between 0 and 100
.. seealso:: :py:func:`setColorizeStrength`
.. seealso:: :py:func:`colorizeOn`
.. seealso:: :py:func:`colorizeColor`
%End
void setOpacity( const double opacity );
%Docstring
Sets the ``opacity`` for the effect.
:param opacity: double between 0 and 1 inclusive, where 0 is fully transparent
and 1 is fully opaque
.. seealso:: :py:func:`opacity`
%End
double opacity() const;
%Docstring
Returns the opacity for the effect.
:return: opacity value between 0 and 1 inclusive, where 0 is fully transparent
and 1 is fully opaque.
.. seealso:: :py:func:`setOpacity`
%End
void setBlendMode( const QPainter::CompositionMode mode );
%Docstring
Sets the blend mode for the effect
:param mode: blend mode used for drawing the effect on to a destination
paint device
.. seealso:: :py:func:`blendMode`
%End
QPainter::CompositionMode blendMode() const;
%Docstring
Returns the blend mode for the effect
:return: blend mode used for drawing the effect on to a destination
paint device
.. seealso:: :py:func:`setBlendMode`
%End
protected:
virtual void draw( QgsRenderContext &context );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/effects/qgscoloreffect.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
|
