-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgstransformeffect.sip.in
328 lines (208 loc) · 7.16 KB
/
qgstransformeffect.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
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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/effects/qgstransformeffect.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsTransformEffect : QgsPaintEffect /NoDefaultCtors/
{
%Docstring
A paint effect which applies transformations (such as move,
scale and rotate) to a picture.
.. versionadded:: 2.9
%End
%TypeHeaderCode
#include "qgstransformeffect.h"
%End
public:
static QgsPaintEffect *create( const QVariantMap &map ) /Factory/;
%Docstring
Creates a new QgsTransformEffect effect from a properties string map.
:param map: encoded properties string map
:return: new QgsTransformEffect
%End
QgsTransformEffect();
%Docstring
Constructor for QgsTransformEffect.
%End
virtual QString type() const;
virtual QVariantMap properties() const;
virtual void readProperties( const QVariantMap &props );
virtual QgsTransformEffect *clone() const /Factory/;
void setTranslateX( const double translateX );
%Docstring
Sets the transform x translation.
:param translateX: distance to translate along the x axis
.. seealso:: :py:func:`translateX`
.. seealso:: :py:func:`setTranslateY`
.. seealso:: :py:func:`setTranslateUnit`
.. seealso:: :py:func:`setTranslateMapUnitScale`
%End
double translateX() const;
%Docstring
Returns the transform x translation.
:return: X distance translated along the x axis
.. seealso:: :py:func:`setTranslateX`
.. seealso:: :py:func:`translateY`
.. seealso:: :py:func:`translateUnit`
.. seealso:: :py:func:`translateMapUnitScale`
%End
void setTranslateY( const double translateY );
%Docstring
Sets the transform y translation.
:param translateY: distance to translate along the y axis
.. seealso:: :py:func:`translateY`
.. seealso:: :py:func:`setTranslateX`
.. seealso:: :py:func:`setTranslateUnit`
.. seealso:: :py:func:`setTranslateMapUnitScale`
%End
double translateY() const;
%Docstring
Returns the transform y translation.
:return: Y distance translated along the y axis
.. seealso:: :py:func:`setTranslateY`
.. seealso:: :py:func:`translateX`
.. seealso:: :py:func:`translateUnit`
.. seealso:: :py:func:`translateMapUnitScale`
%End
void setTranslateUnit( const QgsUnitTypes::RenderUnit unit );
%Docstring
Sets the units used for the transform translation.
:param unit: units for translation
.. seealso:: :py:func:`translateUnit`
.. seealso:: :py:func:`setTranslateX`
.. seealso:: :py:func:`setTranslateY`
.. seealso:: :py:func:`setTranslateMapUnitScale`
%End
QgsUnitTypes::RenderUnit translateUnit() const;
%Docstring
Returns the units used for the transform translation.
:return: units for translation
.. seealso:: :py:func:`setTranslateUnit`
.. seealso:: :py:func:`translateX`
.. seealso:: :py:func:`translateY`
.. seealso:: :py:func:`translateMapUnitScale`
%End
void setTranslateMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the map unit scale used for the transform translation.
:param scale: map unit scale for translation
.. seealso:: :py:func:`translateMapUnitScale`
.. seealso:: :py:func:`setTranslateX`
.. seealso:: :py:func:`setTranslateY`
.. seealso:: :py:func:`setTranslateUnit`
%End
const QgsMapUnitScale &translateMapUnitScale() const;
%Docstring
Returns the map unit scale used for the transform translation.
:return: map unit scale for translation
.. seealso:: :py:func:`setTranslateMapUnitScale`
.. seealso:: :py:func:`translateX`
.. seealso:: :py:func:`translateY`
.. seealso:: :py:func:`translateUnit`
%End
void setScaleX( const double scaleX );
%Docstring
Sets the x axis scaling factor.
:param scaleX: factor to scale x axis by, where 1.0 = no scaling
.. seealso:: :py:func:`scaleX`
.. seealso:: :py:func:`setScaleY`
%End
double scaleX() const;
%Docstring
Returns the x axis scaling factor.
:return: x axis scaling factor, where 1.0 = no scaling
.. seealso:: :py:func:`setScaleX`
.. seealso:: :py:func:`scaleY`
%End
void setScaleY( const double scaleY );
%Docstring
Sets the y axis scaling factor.
:param scaleY: factor to scale y axis by, where 1.0 = no scaling
.. seealso:: :py:func:`scaleX`
%End
double scaleY() const;
%Docstring
Returns the y axis scaling factor.
:return: y axis scaling factor, where 1.0 = no scaling
.. seealso:: :py:func:`setScaleY`
.. seealso:: :py:func:`scaleX`
%End
void setRotation( const double rotation );
%Docstring
Sets the transform ``rotation``, in degrees clockwise.
.. seealso:: :py:func:`rotation`
%End
double rotation() const;
%Docstring
Returns the transform rotation, in degrees clockwise.
.. seealso:: :py:func:`setRotation`
%End
void setShearX( const double shearX );
%Docstring
Sets the x axis shearing factor.
:param shearX: x axis shearing
.. seealso:: :py:func:`shearX`
.. seealso:: :py:func:`setShearY`
%End
double shearX() const;
%Docstring
Returns the x axis shearing factor.
:return: x axis shearing
.. seealso:: :py:func:`setShearX`
.. seealso:: :py:func:`shearY`
%End
void setShearY( const double shearY );
%Docstring
Sets the y axis shearing factor.
:param shearY: y axis shearing
.. seealso:: :py:func:`shearY`
.. seealso:: :py:func:`setShearX`
%End
double shearY() const;
%Docstring
Returns the y axis shearing factor.
:return: y axis shearing
.. seealso:: :py:func:`setShearY`
.. seealso:: :py:func:`shearX`
%End
void setReflectX( const bool reflectX );
%Docstring
Sets whether to reflect along the x-axis
:param reflectX: ``True`` to reflect horizontally
.. seealso:: :py:func:`reflectX`
.. seealso:: :py:func:`setReflectY`
%End
bool reflectX() const;
%Docstring
Returns whether transform will be reflected along the x-axis
:return: ``True`` if transform will reflect horizontally
.. seealso:: :py:func:`setReflectX`
.. seealso:: :py:func:`reflectY`
%End
void setReflectY( const bool reflectY );
%Docstring
Sets whether to reflect along the y-axis
:param reflectY: ``True`` to reflect horizontally
.. seealso:: :py:func:`reflectY`
.. seealso:: :py:func:`setReflectX`
%End
bool reflectY() const;
%Docstring
Returns whether transform will be reflected along the y-axis
:return: ``True`` if transform will reflect horizontally
.. seealso:: :py:func:`setReflectY`
.. seealso:: :py:func:`reflectX`
%End
protected:
virtual void draw( QgsRenderContext &context );
virtual QRectF boundingRect( const QRectF &rect, const QgsRenderContext &context ) const;
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/effects/qgstransformeffect.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/