-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsmaprenderer.sip
228 lines (166 loc) · 6.59 KB
/
qgsmaprenderer.sip
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
/** Labeling engine interface.
* \note Added in QGIS v1.4
*/
class QgsLabelingEngineInterface
{
%TypeHeaderCode
#include <qgsmaprenderer.h>
%End
public:
virtual ~QgsLabelingEngineInterface();
//! called when we're going to start with rendering
virtual void init( QgsMapRenderer* mr ) = 0;
//! called to find out whether the layer is used for labeling
virtual bool willUseLayer( QgsVectorLayer* layer ) = 0;
//! called when starting rendering of a layer
//! @note: this method was added in version 1.6
virtual int prepareLayer( QgsVectorLayer* layer, QSet<int>& attrIndices, QgsRenderContext& ctx ) = 0;
//! called for every feature
virtual void registerFeature( QgsVectorLayer* layer, QgsFeature& feat, const QgsRenderContext& context = QgsRenderContext() ) = 0;
//! called when the map is drawn and labels should be placed
virtual void drawLabeling( QgsRenderContext& context ) = 0;
//! called when we're done with rendering
virtual void exit() = 0;
//! return infos about labels at a given (map) position
//! @note: this method was added in version 1.7
virtual QList<QgsLabelPosition> labelsAtPosition( const QgsPoint& p )= 0;
//! called when passing engine among map renderers
virtual QgsLabelingEngineInterface* clone() = 0;
};
struct QgsLabelPosition
{
%TypeHeaderCode
#include <qgsmaprenderer.h>
%End
QgsLabelPosition( int id, double r, const QVector< QgsPoint >& corners, const QgsRectangle& rect, double w, double h, const QString& layer, bool upside_down );
QgsLabelPosition();
int featureId;
double rotation;
QVector< QgsPoint > cornerPoints;
QgsRectangle labelRect;
double width;
double height;
QString layerID;
bool upsideDown;
};
/**
* \class QgsMapRenderer
* \brief Class for rendering map layer set
*
*/
class QgsMapRenderer : QObject
{
%TypeHeaderCode
#include <qgsmaprenderer.h>
%End
public:
/**Output units for pen width and point marker width/height*/
enum OutputUnits
{
Millimeters,
Pixels
//MAP_UNITS probably supported in future versions
};
//! constructor
QgsMapRenderer();
//! destructor
~QgsMapRenderer();
//! starts rendering
void render(QPainter* painter);
//! sets extent and checks whether suitable (returns false if not)
bool setExtent(const QgsRectangle& extent);
//! returns current extent
QgsRectangle extent() const;
const QgsMapToPixel* coordinateTransform();
double scale() const;
/**Sets scale for scale based visibility. Normally, the scale is calculated automatically. This
function is only used to force a preview scale (e.g. for print composer)*/
void setScale( double scale );
double mapUnitsPerPixel() const;
int width() const;
int height() const;
//! Recalculate the map scale
void updateScale();
QgsDistanceArea* distanceArea() /Deprecated/;
QGis::UnitType mapUnits() const;
void setMapUnits(QGis::UnitType u);
//! sets whether map image will be for overview
void enableOverviewMode(bool isOverview = true);
void setOutputSize(QSize size, int dpi);
void setOutputSize( QSizeF size, double dpi );
//!accessor for output dpi
double outputDpi();
//!accessor for output size
QSize outputSize();
QSizeF outputSizeF();
//! transform extent in layer's CRS to extent in output CRS
QgsRectangle layerExtentToOutputExtent(QgsMapLayer* theLayer, QgsRectangle extent);
//! transform coordinates from layer's CRS to output CRS
QgsPoint layerToMapCoordinates(QgsMapLayer* theLayer, QgsPoint point);
//! transform coordinates from output CRS to layer's CRS
QgsPoint mapToLayerCoordinates(QgsMapLayer* theLayer, QgsPoint point);
//! transform rect's coordinates from output CRS to layer's CRS
QgsRectangle mapToLayerCoordinates(QgsMapLayer* theLayer, QgsRectangle rect);
//! sets whether to use projections for this layer set
void setProjectionsEnabled(bool enabled);
//! returns true if projections are enabled for this layer set
bool hasCrsTransformEnabled();
/** sets destination coordinate reference system
* @note deprecated by qgis 1.7
* @see setDestinationCrs
*/
void setDestinationSrs( const QgsCoordinateReferenceSystem& srs ) /Deprecated/;
/** returns CRS of destination coordinate reference system
* @note deprecated by qgis 1.7
* @see destinationCrs
*/
const QgsCoordinateReferenceSystem& destinationSrs() /Deprecated/;
//! sets destination coordinate reference system
void setDestinationCrs( const QgsCoordinateReferenceSystem& crs );
//! returns CRS of destination coordinate reference system
const QgsCoordinateReferenceSystem& destinationCrs();
void setOutputUnits( OutputUnits u );
OutputUnits outputUnits() const;
//! returns current extent of layer set
QgsRectangle fullExtent();
//! returns current layer set
QStringList& layerSet();
//! change current layer set
void setLayerSet(const QStringList& layers);
//! updates extent of the layer set
void updateFullExtent();
//! read settings
bool readXML(QDomNode & theNode);
//! write settings
bool writeXML(QDomNode & theNode, QDomDocument & theDoc);
//! Accessor for render context
QgsRenderContext* rendererContext();
//! Labeling engine (NULL if there's no custom engine)
//! \note Added in QGIS v1.4
QgsLabelingEngineInterface* labelingEngine();
//! Set labeling engine. Previous engine (if any) is deleted.
//! Takes ownership of the engine.
//! Added in QGIS v1.4
void setLabelingEngine(QgsLabelingEngineInterface* iface /Transfer/);
signals:
void drawingProgress(int current, int total);
void hasCrsTransformEnabled(bool flag);
void destinationSrsChanged();
void updateMap();
void mapUnitsChanged();
//! emitted when layer's draw() returned FALSE
void drawError(QgsMapLayer*);
public slots:
//! called by signal from layer current being drawn
void onDrawingProgress(int current, int total);
protected:
//! adjust extent to fit the pixmap size
void adjustExtentToSize();
/** Convenience function to project an extent into the layer source
* CRS, but also split it into two extents if it crosses
* the +/- 180 degree line. Modifies the given extent to be in the
* source CRS coordinates, and if it was split, returns true, and
* also sets the contents of the r2 parameter
*/
bool splitLayersExtent(QgsMapLayer* layer, QgsRectangle& extent, QgsRectangle& r2);
};