QGIS API Documentation  2.15.0-Master (13f053b)
qgslinesymbollayerv2.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgslinesymbollayerv2.h
3  ---------------------
4  begin : November 2009
5  copyright : (C) 2009 by Martin Dobias
6  email : wonder dot sk at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSLINESYMBOLLAYERV2_H
17 #define QGSLINESYMBOLLAYERV2_H
18 
19 #include "qgssymbollayerv2.h"
20 
21 #include <QPen>
22 #include <QVector>
23 
24 class QgsExpression;
25 
26 #define DEFAULT_SIMPLELINE_COLOR QColor(0,0,0)
27 #define DEFAULT_SIMPLELINE_WIDTH DEFAULT_LINE_WIDTH
28 #define DEFAULT_SIMPLELINE_PENSTYLE Qt::SolidLine
29 #define DEFAULT_SIMPLELINE_JOINSTYLE Qt::BevelJoin
30 #define DEFAULT_SIMPLELINE_CAPSTYLE Qt::SquareCap
31 
32 
34 {
35  public:
37  double width = DEFAULT_SIMPLELINE_WIDTH,
38  Qt::PenStyle penStyle = DEFAULT_SIMPLELINE_PENSTYLE );
39 
40  // static stuff
41 
42  static QgsSymbolLayerV2* create( const QgsStringMap& properties = QgsStringMap() );
43  static QgsSymbolLayerV2* createFromSld( QDomElement &element );
44 
45  // implemented from base classes
46 
47  QString layerType() const override;
48 
49  void startRender( QgsSymbolV2RenderContext& context ) override;
50 
51  void stopRender( QgsSymbolV2RenderContext& context ) override;
52 
53  void renderPolyline( const QPolygonF& points, QgsSymbolV2RenderContext& context ) override;
54 
55  //overridden so that clip path can be set when using draw inside polygon option
56  void renderPolygonOutline( const QPolygonF& points, QList<QPolygonF>* rings, QgsSymbolV2RenderContext& context ) override;
57 
58  QgsStringMap properties() const override;
59 
60  QgsSimpleLineSymbolLayerV2* clone() const override;
61 
62  void toSld( QDomDocument &doc, QDomElement &element, const QgsStringMap& props ) const override;
63 
64  QString ogrFeatureStyle( double mmScaleFactor, double mapUnitScaleFactor ) const override;
65 
66  void setOutputUnit( QgsSymbolV2::OutputUnit unit ) override;
67  QgsSymbolV2::OutputUnit outputUnit() const override;
68 
69  void setMapUnitScale( const QgsMapUnitScale &scale ) override;
70  QgsMapUnitScale mapUnitScale() const override;
71 
72  double estimateMaxBleed() const override;
73 
74  // new stuff
75 
76  Qt::PenStyle penStyle() const { return mPenStyle; }
77  void setPenStyle( Qt::PenStyle style ) { mPenStyle = style; }
78 
79  Qt::PenJoinStyle penJoinStyle() const { return mPenJoinStyle; }
80  void setPenJoinStyle( Qt::PenJoinStyle style ) { mPenJoinStyle = style; }
81 
82  Qt::PenCapStyle penCapStyle() const { return mPenCapStyle; }
83  void setPenCapStyle( Qt::PenCapStyle style ) { mPenCapStyle = style; }
84 
85  bool useCustomDashPattern() const { return mUseCustomDashPattern; }
86  void setUseCustomDashPattern( bool b ) { mUseCustomDashPattern = b; }
87 
88  void setCustomDashPatternUnit( QgsSymbolV2::OutputUnit unit ) { mCustomDashPatternUnit = unit; }
89  QgsSymbolV2::OutputUnit customDashPatternUnit() const { return mCustomDashPatternUnit; }
90 
91  const QgsMapUnitScale& customDashPatternMapUnitScale() const { return mCustomDashPatternMapUnitScale; }
92  void setCustomDashPatternMapUnitScale( const QgsMapUnitScale& scale ) { mCustomDashPatternMapUnitScale = scale; }
93 
94  QVector<qreal> customDashVector() const { return mCustomDashVector; }
95  void setCustomDashVector( const QVector<qreal>& vector ) { mCustomDashVector = vector; }
96 
97  //Returns true if the line should only be drawn inside the polygon
98  bool drawInsidePolygon() const { return mDrawInsidePolygon; }
99  //Set to true if the line should only be drawn inside the polygon
100  void setDrawInsidePolygon( bool drawInsidePolygon ) { mDrawInsidePolygon = drawInsidePolygon; }
101 
103  Qt::PenStyle dxfPenStyle() const override;
104 
105  double dxfWidth( const QgsDxfExport& e, QgsSymbolV2RenderContext &context ) const override;
106  double dxfOffset( const QgsDxfExport& e, QgsSymbolV2RenderContext& context ) const override;
107  QColor dxfColor( QgsSymbolV2RenderContext &context ) const override;
108 
109  protected:
110  Qt::PenStyle mPenStyle;
111  Qt::PenJoinStyle mPenJoinStyle;
112  Qt::PenCapStyle mPenCapStyle;
115 
116  //use a custom dash dot pattern instead of the predefined ones
120 
123 
125 
126  private:
127  //helper functions for data defined symbology
128  void applyDataDefinedSymbology( QgsSymbolV2RenderContext& context, QPen& pen, QPen& selPen, double& offset );
129  void applySizeScale( QgsSymbolV2RenderContext& context, QPen& pen, QPen& selPen );
130 };
131 
133 
134 #define DEFAULT_MARKERLINE_ROTATE true
135 #define DEFAULT_MARKERLINE_INTERVAL 3
136 
138 {
139  public:
141  double interval = DEFAULT_MARKERLINE_INTERVAL );
142 
144 
149  {
155  CurvePoint
156  };
157 
158  // static stuff
159 
167  static QgsSymbolLayerV2* create( const QgsStringMap& properties = QgsStringMap() );
168 
176  static QgsSymbolLayerV2* createFromSld( QDomElement &element );
177 
178  // implemented from base classes
179 
180  QString layerType() const override;
181 
182  void startRender( QgsSymbolV2RenderContext& context ) override;
183 
184  void stopRender( QgsSymbolV2RenderContext& context ) override;
185 
186  void renderPolyline( const QPolygonF& points, QgsSymbolV2RenderContext& context ) override;
187 
188  void renderPolygonOutline( const QPolygonF& points, QList<QPolygonF>* rings, QgsSymbolV2RenderContext& context ) override;
189 
190  QgsStringMap properties() const override;
191 
192  QgsMarkerLineSymbolLayerV2* clone() const override;
193 
194  void toSld( QDomDocument &doc, QDomElement &element, const QgsStringMap& props ) const override;
195 
196  void setColor( const QColor& color ) override;
197  virtual QColor color() const override;
198 
199  QgsSymbolV2* subSymbol() override;
200  bool setSubSymbol( QgsSymbolV2* symbol ) override;
201 
202  virtual void setWidth( double width ) override;
203  virtual double width() const override;
204 
205  double estimateMaxBleed() const override;
206 
207  // new stuff
208 
214  bool rotateMarker() const { return mRotateMarker; }
215 
219  void setRotateMarker( bool rotate ) { mRotateMarker = rotate; }
220 
224  double interval() const { return mInterval; }
225 
229  void setInterval( double interval ) { mInterval = interval; }
230 
234  Placement placement() const { return mPlacement; }
235 
239  void setPlacement( Placement p ) { mPlacement = p; }
240 
251  double offsetAlongLine() const { return mOffsetAlongLine; }
252 
264  void setOffsetAlongLine( double offsetAlongLine ) { mOffsetAlongLine = offsetAlongLine; }
265 
271  QgsSymbolV2::OutputUnit offsetAlongLineUnit() const { return mOffsetAlongLineUnit; }
272 
278  void setOffsetAlongLineUnit( QgsSymbolV2::OutputUnit unit ) { mOffsetAlongLineUnit = unit; }
279 
283  const QgsMapUnitScale& offsetAlongLineMapUnitScale() const { return mOffsetAlongLineMapUnitScale; }
284 
288  void setOffsetAlongLineMapUnitScale( const QgsMapUnitScale& scale ) { mOffsetAlongLineMapUnitScale = scale; }
289 
290  void setIntervalUnit( QgsSymbolV2::OutputUnit unit ) { mIntervalUnit = unit; }
291  QgsSymbolV2::OutputUnit intervalUnit() const { return mIntervalUnit; }
292 
293  void setIntervalMapUnitScale( const QgsMapUnitScale& scale ) { mIntervalMapUnitScale = scale; }
294  const QgsMapUnitScale& intervalMapUnitScale() const { return mIntervalMapUnitScale; }
295 
296  void setOutputUnit( QgsSymbolV2::OutputUnit unit ) override;
297  QgsSymbolV2::OutputUnit outputUnit() const override;
298 
299  void setMapUnitScale( const QgsMapUnitScale& scale ) override;
300  QgsMapUnitScale mapUnitScale() const override;
301 
302  QSet<QString> usedAttributes() const override;
303 
304  void setDataDefinedProperty( const QString& property, QgsDataDefined* dataDefined ) override;
305 
306 
307  protected:
308 
309  void renderPolylineInterval( const QPolygonF& points, QgsSymbolV2RenderContext& context );
310  void renderPolylineVertex( const QPolygonF& points, QgsSymbolV2RenderContext& context, Placement placement = Vertex );
311  void renderPolylineCentral( const QPolygonF& points, QgsSymbolV2RenderContext& context );
312  double markerAngle( const QPolygonF& points, bool isRing, int vertex );
313 
315  double mInterval;
320  double mOffsetAlongLine; //distance to offset along line before marker is drawn
321  QgsSymbolV2::OutputUnit mOffsetAlongLineUnit; //unit for offset along line
323 
324  private:
325 
336  void renderOffsetVertexAlongLine( const QPolygonF& points, int vertex, double distance, QgsSymbolV2RenderContext &context );
337 };
338 
339 #endif
340 
341 
virtual QSet< QString > usedAttributes() const
Returns the set of attributes referenced by the layer.
void setIntervalUnit(QgsSymbolV2::OutputUnit unit)
QgsSymbolV2::OutputUnit customDashPatternUnit() const
Class for parsing and evaluation of expressions (formerly called "search strings").
QgsSymbolV2::OutputUnit intervalUnit() const
#define DEFAULT_SIMPLELINE_PENSTYLE
#define DEFAULT_MARKERLINE_ROTATE
QgsSymbolV2::OutputUnit offsetAlongLineUnit() const
Returns the unit used for calculating the offset along line for markers.
OutputUnit
The unit of the output.
Definition: qgssymbolv2.h:62
virtual Qt::PenStyle dxfPenStyle() const
get pen style
virtual QgsSymbolLayerV2 * clone() const =0
Shall be reimplemented by subclasses to create a deep copy of the instance.
A container class for data source field mapping or expression.
virtual double width() const
#define DEFAULT_MARKERLINE_INTERVAL
const QgsMapUnitScale & customDashPatternMapUnitScale() const
void setCustomDashPatternUnit(QgsSymbolV2::OutputUnit unit)
Placement
Defines how/where the marker should be placed on the line.
QgsMapUnitScale mCustomDashPatternMapUnitScale
QgsSymbolV2::OutputUnit outputUnit() const override
QVector< qreal > customDashVector() const
const QgsMapUnitScale & intervalMapUnitScale() const
void setPenJoinStyle(Qt::PenJoinStyle style)
void setIntervalMapUnitScale(const QgsMapUnitScale &scale)
QMap< QString, QString > QgsStringMap
Definition: qgis.h:481
Qt::PenStyle penStyle() const
QgsMapUnitScale mOffsetAlongLineMapUnitScale
virtual double estimateMaxBleed() const
Returns the estimated maximum distance which the layer style will bleed outside the drawn shape...
void setOffsetAlongLine(double offsetAlongLine)
Sets the the offset along the line for the marker placement.
virtual void startRender(QgsSymbolV2RenderContext &context)=0
void setInterval(double interval)
The interval between individual markers.
void setDrawInsidePolygon(bool drawInsidePolygon)
void setRotateMarker(bool rotate)
Shall the marker be rotated.
QgsSymbolV2::OutputUnit mIntervalUnit
double offsetAlongLine() const
Returns the offset along the line for the marker placement.
void setOutputUnit(QgsSymbolV2::OutputUnit unit) override
virtual QVector< qreal > dxfCustomDashPattern(QgsSymbolV2::OutputUnit &unit) const
get dash pattern
QVector< qreal > mCustomDashVector
Vector with an even number of entries for the.
#define DEFAULT_SIMPLELINE_WIDTH
virtual void setWidth(double width)
bool rotateMarker() const
Shall the marker be rotated.
virtual QgsStringMap properties() const =0
Should be reimplemented by subclasses to return a string map that contains the configuration informat...
double interval() const
The interval between individual markers.
virtual QColor color() const
The fill color.
void setOffsetAlongLineMapUnitScale(const QgsMapUnitScale &scale)
Sets the map unit scale used for calculating the offset in map units along line for markers...
virtual void renderPolygonOutline(const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolV2RenderContext &context)
void setOffsetAlongLineUnit(QgsSymbolV2::OutputUnit unit)
Sets the unit used for calculating the offset along line for markers.
void setPenCapStyle(Qt::PenCapStyle style)
void setCustomDashVector(const QVector< qreal > &vector)
virtual void renderPolyline(const QPolygonF &points, QgsSymbolV2RenderContext &context)=0
QgsSymbolV2::OutputUnit mCustomDashPatternUnit
virtual QString layerType() const =0
Returns a string that represents this layer type.
virtual QgsSymbolV2 * subSymbol()
#define DEFAULT_SIMPLELINE_COLOR
QgsMapUnitScale mapUnitScale() const override
QgsSymbolV2::OutputUnit mOffsetAlongLineUnit
void setPenStyle(Qt::PenStyle style)
void setMapUnitScale(const QgsMapUnitScale &scale) override
void setPlacement(Placement p)
The placement of the markers.
Struct for storing maximum and minimum scales for measurements in map units.
void setCustomDashPatternMapUnitScale(const QgsMapUnitScale &scale)
virtual QColor dxfColor(QgsSymbolV2RenderContext &context) const
get color
virtual void toSld(QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const
virtual void setColor(const QColor &color)
The fill color.
Placement placement() const
The placement of the markers.
virtual double dxfOffset(const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const
get offset
virtual double dxfWidth(const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const override
get line width
const QgsMapUnitScale & offsetAlongLineMapUnitScale() const
Returns the map unit scale used for calculating the offset in map units along line for markers...
virtual bool setSubSymbol(QgsSymbolV2 *symbol)
set layer&#39;s subsymbol. takes ownership of the passed symbol
virtual void stopRender(QgsSymbolV2RenderContext &context)=0
virtual QString ogrFeatureStyle(double mmScaleFactor, double mapUnitScaleFactor) const
Qt::PenJoinStyle penJoinStyle() const
Qt::PenCapStyle penCapStyle() const
virtual Q_DECL_DEPRECATED void setDataDefinedProperty(const QString &property, const QString &expressionString)
Sets a data defined expression for a property.