QGIS API Documentation
2.14.0-Essen
|
#include <qgslinesymbollayerv2.h>
Public Types | |
enum | Placement { Interval, Vertex, LastVertex, FirstVertex, CentralPoint, CurvePoint } |
Defines how/where the marker should be placed on the line. More... | |
Public Member Functions | |
QgsMarkerLineSymbolLayerV2 (bool rotateMarker=DEFAULT_MARKERLINE_ROTATE, double interval=DEFAULT_MARKERLINE_INTERVAL) | |
~QgsMarkerLineSymbolLayerV2 () | |
QgsMarkerLineSymbolLayerV2 * | clone () const override |
Shall be reimplemented by subclasses to create a deep copy of the instance. More... | |
double | estimateMaxBleed () const override |
Returns the estimated maximum distance which the layer style will bleed outside the drawn shape. More... | |
double | interval () const |
The interval between individual markers. More... | |
const QgsMapUnitScale & | intervalMapUnitScale () const |
QgsSymbolV2::OutputUnit | intervalUnit () const |
QString | layerType () const override |
Returns a string that represents this layer type. More... | |
QgsMapUnitScale | mapUnitScale () const override |
double | offsetAlongLine () const |
Returns the offset along the line for the marker placement. More... | |
const QgsMapUnitScale & | offsetAlongLineMapUnitScale () const |
Returns the map unit scale used for calculating the offset in map units along line for markers. More... | |
QgsSymbolV2::OutputUnit | offsetAlongLineUnit () const |
Returns the unit used for calculating the offset along line for markers. More... | |
QgsSymbolV2::OutputUnit | outputUnit () const override |
Placement | placement () const |
The placement of the markers. More... | |
QgsStringMap | properties () const override |
Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. More... | |
void | renderPolygonOutline (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolV2RenderContext &context) override |
void | renderPolyline (const QPolygonF &points, QgsSymbolV2RenderContext &context) override |
bool | rotateMarker () const |
Shall the marker be rotated. More... | |
void | setColor (const QColor &color) override |
The fill color. More... | |
void | setDataDefinedProperty (const QString &property, QgsDataDefined *dataDefined) override |
Sets a data defined property for the layer. More... | |
void | setInterval (double interval) |
The interval between individual markers. More... | |
void | setIntervalMapUnitScale (const QgsMapUnitScale &scale) |
void | setIntervalUnit (QgsSymbolV2::OutputUnit unit) |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setOffsetAlongLine (double offsetAlongLine) |
Sets the the offset along the line for the marker placement. More... | |
void | setOffsetAlongLineMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale used for calculating the offset in map units along line for markers. More... | |
void | setOffsetAlongLineUnit (QgsSymbolV2::OutputUnit unit) |
Sets the unit used for calculating the offset along line for markers. More... | |
void | setOutputUnit (QgsSymbolV2::OutputUnit unit) override |
void | setPlacement (Placement p) |
The placement of the markers. More... | |
void | setRotateMarker (bool rotate) |
Shall the marker be rotated. More... | |
bool | setSubSymbol (QgsSymbolV2 *symbol) override |
set layer's subsymbol. takes ownership of the passed symbol More... | |
virtual void | setWidth (double width) override |
void | startRender (QgsSymbolV2RenderContext &context) override |
void | stopRender (QgsSymbolV2RenderContext &context) override |
QgsSymbolV2 * | subSymbol () override |
void | toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override |
QSet< QString > | usedAttributes () const override |
Returns the set of attributes referenced by the layer. More... | |
virtual double | width () const override |
Public Member Functions inherited from QgsLineSymbolLayerV2 | |
void | drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size) override |
virtual double | dxfWidth (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const override |
QgsMapUnitScale | mapUnitScale () const override |
double | offset () const |
const QgsMapUnitScale & | offsetMapUnitScale () const |
QgsSymbolV2::OutputUnit | offsetUnit () const |
QgsSymbolV2::OutputUnit | outputUnit () const override |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setOffset (double offset) |
void | setOffsetMapUnitScale (const QgsMapUnitScale &scale) |
void | setOffsetUnit (QgsSymbolV2::OutputUnit unit) |
void | setOutputUnit (QgsSymbolV2::OutputUnit unit) override |
void | setWidthMapUnitScale (const QgsMapUnitScale &scale) |
void | setWidthUnit (QgsSymbolV2::OutputUnit unit) |
const QgsMapUnitScale & | widthMapUnitScale () const |
QgsSymbolV2::OutputUnit | widthUnit () const |
Public Member Functions inherited from QgsSymbolLayerV2 | |
virtual | ~QgsSymbolLayerV2 () |
virtual QColor | color () const |
The fill color. More... | |
virtual Q_DECL_DEPRECATED const QgsExpression * | dataDefinedProperty (const QString &property) const |
Returns a data defined expression for a property, if set. More... | |
virtual Q_DECL_DEPRECATED QString | dataDefinedPropertyString (const QString &property) const |
Returns a data defined expression for a property, if set. More... | |
virtual QColor | dxfBrushColor (QgsSymbolV2RenderContext &context) const |
virtual Qt::BrushStyle | dxfBrushStyle () const |
virtual QColor | dxfColor (QgsSymbolV2RenderContext &context) const |
virtual QVector< qreal > | dxfCustomDashPattern (QgsSymbolV2::OutputUnit &unit) const |
virtual double | dxfOffset (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const |
virtual Qt::PenStyle | dxfPenStyle () const |
virtual Q_DECL_DEPRECATED QVariant | evaluateDataDefinedProperty (const QString &property, const QgsFeature *feature, const QVariant &defaultVal=QVariant(), bool *ok=nullptr) const |
Evaluates the matching data defined property and returns the calculated value. More... | |
virtual QVariant | evaluateDataDefinedProperty (const QString &property, const QgsSymbolV2RenderContext &context, const QVariant &defaultVal=QVariant(), bool *ok=nullptr) const |
Evaluates the matching data defined property and returns the calculated value. More... | |
virtual QColor | fillColor () const |
Get fill color. More... | |
virtual QgsDataDefined * | getDataDefinedProperty (const QString &property) const |
Returns the data defined property corresponding to the specified property key. More... | |
virtual bool | hasDataDefinedProperties () const |
Checks whether the layer has any associated data defined properties. More... | |
virtual bool | hasDataDefinedProperty (const QString &property) const |
Checks whether the layer has a matching data defined property and if that property is currently actived. More... | |
virtual bool | isCompatibleWithSymbol (QgsSymbolV2 *symbol) const |
Returns if the layer can be used below the specified symbol. More... | |
bool | isLocked () const |
virtual QString | ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const |
virtual QColor | outlineColor () const |
Get outline color. More... | |
QgsPaintEffect * | paintEffect () const |
Returns the current paint effect for the layer. More... | |
virtual void | removeDataDefinedProperties () |
Removes all data defined properties from the layer and deletes associated objects. More... | |
virtual void | removeDataDefinedProperty (const QString &property) |
Removes a data defined property from the layer. More... | |
int | renderingPass () const |
virtual Q_DECL_DEPRECATED void | setDataDefinedProperty (const QString &property, const QString &expressionString) |
Sets a data defined expression for a property. More... | |
virtual void | setFillColor (const QColor &color) |
Set fill color. More... | |
void | setLocked (bool locked) |
virtual void | setOutlineColor (const QColor &color) |
Set outline color. More... | |
void | setPaintEffect (QgsPaintEffect *effect) |
Sets the current paint effect for the layer. More... | |
void | setRenderingPass (int renderingPass) |
QgsSymbolV2::SymbolType | type () const |
virtual bool | writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolV2RenderContext *context, const QgsFeature *f, QPointF shift=QPointF(0.0, 0.0)) const |
Static Public Member Functions | |
static QgsSymbolLayerV2 * | create (const QgsStringMap &properties=QgsStringMap()) |
Create a new MarkerLineSymbolLayerV2. More... | |
static QgsSymbolLayerV2 * | createFromSld (QDomElement &element) |
Create a new MarkerLineSymbolLayerV2 from SLD. More... | |
Protected Member Functions | |
double | markerAngle (const QPolygonF &points, bool isRing, int vertex) |
void | renderPolylineCentral (const QPolygonF &points, QgsSymbolV2RenderContext &context) |
void | renderPolylineInterval (const QPolygonF &points, QgsSymbolV2RenderContext &context) |
void | renderPolylineVertex (const QPolygonF &points, QgsSymbolV2RenderContext &context, Placement placement=Vertex) |
Protected Member Functions inherited from QgsLineSymbolLayerV2 | |
QgsLineSymbolLayerV2 (bool locked=false) | |
Protected Member Functions inherited from QgsSymbolLayerV2 | |
QgsSymbolLayerV2 (QgsSymbolV2::SymbolType type, bool locked=false) | |
void | copyDataDefinedProperties (QgsSymbolLayerV2 *destLayer) const |
Copies all data defined properties of this layer to another symbol layer. More... | |
void | copyPaintEffect (QgsSymbolLayerV2 *destLayer) const |
Copies paint effect of this layer to another symbol layer. More... | |
virtual Q_DECL_DEPRECATED QgsExpression * | expression (const QString &property) const |
Returns the data defined expression associated with a property. More... | |
virtual Q_DECL_DEPRECATED void | prepareExpressions (const QgsFields *fields, double scale=-1.0) |
Prepares all data defined property expressions for evaluation. More... | |
virtual void | prepareExpressions (const QgsSymbolV2RenderContext &context) |
Prepares all data defined property expressions for evaluation. More... | |
void | restoreDataDefinedProperties (const QgsStringMap &stringMap) |
Restores all data defined properties from string map. More... | |
void | saveDataDefinedProperties (QgsStringMap &stringMap) const |
Saves all data defined properties to a string map. More... | |
Protected Attributes | |
double | mInterval |
QgsMapUnitScale | mIntervalMapUnitScale |
QgsSymbolV2::OutputUnit | mIntervalUnit |
QgsMarkerSymbolV2 * | mMarker |
double | mOffsetAlongLine |
QgsMapUnitScale | mOffsetAlongLineMapUnitScale |
QgsSymbolV2::OutputUnit | mOffsetAlongLineUnit |
Placement | mPlacement |
bool | mRotateMarker |
Protected Attributes inherited from QgsLineSymbolLayerV2 | |
double | mOffset |
QgsMapUnitScale | mOffsetMapUnitScale |
QgsSymbolV2::OutputUnit | mOffsetUnit |
double | mWidth |
QgsMapUnitScale | mWidthMapUnitScale |
QgsSymbolV2::OutputUnit | mWidthUnit |
Protected Attributes inherited from QgsSymbolLayerV2 | |
QColor | mColor |
QMap< QString, QgsDataDefined * > | mDataDefinedProperties |
QgsFields | mFields |
bool | mLocked |
QgsPaintEffect * | mPaintEffect |
int | mRenderingPass |
QgsSymbolV2::SymbolType | mType |
Definition at line 137 of file qgslinesymbollayerv2.h.
Defines how/where the marker should be placed on the line.
Enumerator | |
---|---|
Interval | |
Vertex | |
LastVertex | |
FirstVertex | |
CentralPoint | |
CurvePoint |
Definition at line 148 of file qgslinesymbollayerv2.h.
QgsMarkerLineSymbolLayerV2::QgsMarkerLineSymbolLayerV2 | ( | bool | rotateMarker = DEFAULT_MARKERLINE_ROTATE , |
double | interval = DEFAULT_MARKERLINE_INTERVAL |
||
) |
Definition at line 716 of file qgslinesymbollayerv2.cpp.
QgsMarkerLineSymbolLayerV2::~QgsMarkerLineSymbolLayerV2 | ( | ) |
Definition at line 729 of file qgslinesymbollayerv2.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayerV2.
Definition at line 1360 of file qgslinesymbollayerv2.cpp.
|
static |
Create a new MarkerLineSymbolLayerV2.
properties | A property map to deserialize saved information from properties() |
Definition at line 734 of file qgslinesymbollayerv2.cpp.
|
static |
Create a new MarkerLineSymbolLayerV2 from SLD.
element | An SLD XML DOM element |
Definition at line 1453 of file qgslinesymbollayerv2.cpp.
|
overridevirtual |
Returns the estimated maximum distance which the layer style will bleed outside the drawn shape.
Eg, polygons drawn with an outline will draw half the width of the outline outside of the polygon. This amount is estimated, since it may be affected by data defined symbology rules.
Reimplemented from QgsSymbolLayerV2.
Definition at line 1590 of file qgslinesymbollayerv2.cpp.
|
inline |
The interval between individual markers.
Definition at line 223 of file qgslinesymbollayerv2.h.
|
inline |
Definition at line 293 of file qgslinesymbollayerv2.h.
|
inline |
Definition at line 290 of file qgslinesymbollayerv2.h.
|
overridevirtual |
Returns a string that represents this layer type.
Used for serialization. Should match with the string used to register this symbol layer in the registry.
Implements QgsSymbolLayerV2.
Definition at line 801 of file qgslinesymbollayerv2.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 1571 of file qgslinesymbollayerv2.cpp.
|
protected |
Definition at line 1128 of file qgslinesymbollayerv2.cpp.
|
inline |
Returns the offset along the line for the marker placement.
For Interval placements, this is the distance between the start of the line and the first marker. For FirstVertex and LastVertex placements, this is the distance between the marker and the start of the line or the end of the line respectively. This setting has no effect for Vertex or CentralPoint placements.
Definition at line 250 of file qgslinesymbollayerv2.h.
|
inline |
Returns the map unit scale used for calculating the offset in map units along line for markers.
Definition at line 282 of file qgslinesymbollayerv2.h.
|
inline |
Returns the unit used for calculating the offset along line for markers.
Definition at line 270 of file qgslinesymbollayerv2.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 1553 of file qgslinesymbollayerv2.cpp.
|
inline |
The placement of the markers.
Definition at line 233 of file qgslinesymbollayerv2.h.
|
overridevirtual |
Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer.
This is used to serialize a symbol layer perstistently.
Implements QgsSymbolLayerV2.
Definition at line 1311 of file qgslinesymbollayerv2.cpp.
|
overridevirtual |
Reimplemented from QgsLineSymbolLayerV2.
Definition at line 908 of file qgslinesymbollayerv2.cpp.
|
overridevirtual |
Implements QgsLineSymbolLayerV2.
Definition at line 835 of file qgslinesymbollayerv2.cpp.
|
protected |
Definition at line 1262 of file qgslinesymbollayerv2.cpp.
|
protected |
Definition at line 932 of file qgslinesymbollayerv2.cpp.
|
protected |
Definition at line 1017 of file qgslinesymbollayerv2.cpp.
|
inline |
Shall the marker be rotated.
Definition at line 213 of file qgslinesymbollayerv2.h.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayerV2.
Definition at line 806 of file qgslinesymbollayerv2.cpp.
|
overridevirtual |
Sets a data defined property for the layer.
property | unique property key. Any existing data defined with the same key will be deleted and overridden. |
dataDefined | data defined object to associate with property key. Ownership is transferred to the layer. |
Reimplemented from QgsSymbolLayerV2.
Definition at line 1531 of file qgslinesymbollayerv2.cpp.
|
inline |
The interval between individual markers.
Definition at line 228 of file qgslinesymbollayerv2.h.
|
inline |
Definition at line 292 of file qgslinesymbollayerv2.h.
|
inline |
Definition at line 289 of file qgslinesymbollayerv2.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 1563 of file qgslinesymbollayerv2.cpp.
|
inline |
Sets the the offset along the line for the marker placement.
For Interval placements, this is the distance between the start of the line and the first marker. For FirstVertex and LastVertex placements, this is the distance between the marker and the start of the line or the end of the line respectively. This setting has no effect for Vertex or CentralPoint placements.
offsetAlongLine | Distance to offset markers along the line. The offset unit is set via setOffsetAlongLineUnit. |
Definition at line 263 of file qgslinesymbollayerv2.h.
|
inline |
Sets the map unit scale used for calculating the offset in map units along line for markers.
scale | Offset along line map unit scale. |
Definition at line 287 of file qgslinesymbollayerv2.h.
|
inline |
Sets the unit used for calculating the offset along line for markers.
unit | Offset along line unit type. |
Definition at line 277 of file qgslinesymbollayerv2.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 1545 of file qgslinesymbollayerv2.cpp.
|
inline |
The placement of the markers.
Definition at line 238 of file qgslinesymbollayerv2.h.
|
inline |
Shall the marker be rotated.
Definition at line 218 of file qgslinesymbollayerv2.h.
|
overridevirtual |
set layer's subsymbol. takes ownership of the passed symbol
Reimplemented from QgsSymbolLayerV2.
Definition at line 1346 of file qgslinesymbollayerv2.cpp.
|
overridevirtual |
Reimplemented from QgsLineSymbolLayerV2.
Definition at line 1526 of file qgslinesymbollayerv2.cpp.
|
overridevirtual |
Implements QgsSymbolLayerV2.
Definition at line 812 of file qgslinesymbollayerv2.cpp.
|
overridevirtual |
Implements QgsSymbolLayerV2.
Definition at line 830 of file qgslinesymbollayerv2.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 1341 of file qgslinesymbollayerv2.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 1378 of file qgslinesymbollayerv2.cpp.
Returns the set of attributes referenced by the layer.
This includes attributes required by any data defined properties associated with the layer.
Reimplemented from QgsSymbolLayerV2.
Definition at line 1582 of file qgslinesymbollayerv2.cpp.
|
overridevirtual |
Reimplemented from QgsLineSymbolLayerV2.
Definition at line 1540 of file qgslinesymbollayerv2.cpp.
|
protected |
Definition at line 314 of file qgslinesymbollayerv2.h.
|
protected |
Definition at line 316 of file qgslinesymbollayerv2.h.
|
protected |
Definition at line 315 of file qgslinesymbollayerv2.h.
|
protected |
Definition at line 317 of file qgslinesymbollayerv2.h.
|
protected |
Definition at line 319 of file qgslinesymbollayerv2.h.
|
protected |
Definition at line 321 of file qgslinesymbollayerv2.h.
|
protected |
Definition at line 320 of file qgslinesymbollayerv2.h.
|
protected |
Definition at line 318 of file qgslinesymbollayerv2.h.
|
protected |
Definition at line 313 of file qgslinesymbollayerv2.h.