QGIS API Documentation  2.14.0-Essen
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
QgsSimpleLineSymbolLayerV2 Class Reference

#include <qgslinesymbollayerv2.h>

Inheritance diagram for QgsSimpleLineSymbolLayerV2:
Inheritance graph
[legend]

Public Member Functions

 QgsSimpleLineSymbolLayerV2 (const QColor &color=DEFAULT_SIMPLELINE_COLOR, double width=DEFAULT_SIMPLELINE_WIDTH, Qt::PenStyle penStyle=DEFAULT_SIMPLELINE_PENSTYLE)
 
QgsSimpleLineSymbolLayerV2clone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
const QgsMapUnitScalecustomDashPatternMapUnitScale () const
 
QgsSymbolV2::OutputUnit customDashPatternUnit () const
 
QVector< qreal > customDashVector () const
 
bool drawInsidePolygon () const
 
QColor dxfColor (QgsSymbolV2RenderContext &context) const override
 
QVector< qreal > dxfCustomDashPattern (QgsSymbolV2::OutputUnit &unit) const override
 
double dxfOffset (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const override
 
Qt::PenStyle dxfPenStyle () const override
 
double dxfWidth (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const override
 
double estimateMaxBleed () const override
 Returns the estimated maximum distance which the layer style will bleed outside the drawn shape. More...
 
QString layerType () const override
 Returns a string that represents this layer type. More...
 
QgsMapUnitScale mapUnitScale () const override
 
QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const override
 
QgsSymbolV2::OutputUnit outputUnit () const override
 
Qt::PenCapStyle penCapStyle () const
 
Qt::PenJoinStyle penJoinStyle () const
 
Qt::PenStyle penStyle () const
 
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
 
void setCustomDashPatternMapUnitScale (const QgsMapUnitScale &scale)
 
void setCustomDashPatternUnit (QgsSymbolV2::OutputUnit unit)
 
void setCustomDashVector (const QVector< qreal > &vector)
 
void setDrawInsidePolygon (bool drawInsidePolygon)
 
void setMapUnitScale (const QgsMapUnitScale &scale) override
 
void setOutputUnit (QgsSymbolV2::OutputUnit unit) override
 
void setPenCapStyle (Qt::PenCapStyle style)
 
void setPenJoinStyle (Qt::PenJoinStyle style)
 
void setPenStyle (Qt::PenStyle style)
 
void setUseCustomDashPattern (bool b)
 
void startRender (QgsSymbolV2RenderContext &context) override
 
void stopRender (QgsSymbolV2RenderContext &context) override
 
void toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override
 
bool useCustomDashPattern () const
 
- Public Member Functions inherited from QgsLineSymbolLayerV2
void drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size) override
 
QgsMapUnitScale mapUnitScale () const override
 
double offset () const
 
const QgsMapUnitScaleoffsetMapUnitScale () 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
 
virtual void setWidth (double width)
 
void setWidthMapUnitScale (const QgsMapUnitScale &scale)
 
void setWidthUnit (QgsSymbolV2::OutputUnit unit)
 
virtual double width () const
 
const QgsMapUnitScalewidthMapUnitScale () 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 QgsExpressiondataDefinedProperty (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 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 QgsDataDefinedgetDataDefinedProperty (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 QColor outlineColor () const
 Get outline color. More...
 
QgsPaintEffectpaintEffect () 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 void setColor (const QColor &color)
 The fill color. More...
 
virtual Q_DECL_DEPRECATED void setDataDefinedProperty (const QString &property, const QString &expressionString)
 Sets a data defined expression for a property. More...
 
virtual void setDataDefinedProperty (const QString &property, QgsDataDefined *dataDefined)
 Sets a data defined property for the layer. 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)
 
virtual bool setSubSymbol (QgsSymbolV2 *symbol)
 set layer's subsymbol. takes ownership of the passed symbol More...
 
virtual QgsSymbolV2subSymbol ()
 
QgsSymbolV2::SymbolType type () const
 
virtual QSet< QStringusedAttributes () const
 Returns the set of attributes referenced by the layer. More...
 
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 QgsSymbolLayerV2create (const QgsStringMap &properties=QgsStringMap())
 
static QgsSymbolLayerV2createFromSld (QDomElement &element)
 

Protected Attributes

QgsMapUnitScale mCustomDashPatternMapUnitScale
 
QgsSymbolV2::OutputUnit mCustomDashPatternUnit
 
QVector< qreal > mCustomDashVector
 Vector with an even number of entries for the. More...
 
bool mDrawInsidePolygon
 
QPen mPen
 
Qt::PenCapStyle mPenCapStyle
 
Qt::PenJoinStyle mPenJoinStyle
 
Qt::PenStyle mPenStyle
 
QPen mSelPen
 
bool mUseCustomDashPattern
 
- 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
 
QgsPaintEffectmPaintEffect
 
int mRenderingPass
 
QgsSymbolV2::SymbolType mType
 

Additional Inherited Members

- 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 QgsExpressionexpression (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...
 
- Static Protected Attributes inherited from QgsSymbolLayerV2
static const QString EXPR_ALPHA
 
static const QString EXPR_ANGLE
 
static const QString EXPR_BLUR_RADIUS
 
static const QString EXPR_BORDER_COLOR
 
static const QString EXPR_BORDER_STYLE
 
static const QString EXPR_CAPSTYLE
 
static const QString EXPR_CHAR
 
static const QString EXPR_COLOR
 
static const QString EXPR_COLOR2
 
static const QString EXPR_COLOR_BORDER
 
static const QString EXPR_COORDINATE_MODE
 
static const QString EXPR_CUSTOMDASH
 
static const QString EXPR_DISPLACEMENT_X
 
static const QString EXPR_DISPLACEMENT_Y
 
static const QString EXPR_DISTANCE
 
static const QString EXPR_DISTANCE_X
 
static const QString EXPR_DISTANCE_Y
 
static const QString EXPR_FILE
 
static const QString EXPR_FILL
 
static const QString EXPR_FILL_COLOR
 
static const QString EXPR_FILL_STYLE
 
static const QString EXPR_GRADIENT_TYPE
 
static const QString EXPR_HEIGHT
 
static const QString EXPR_HORIZONTAL_ANCHOR_POINT
 
static const QString EXPR_IGNORE_RINGS
 
static const QString EXPR_INTERVAL
 
static const QString EXPR_JOIN_STYLE
 
static const QString EXPR_JOINSTYLE
 
static const QString EXPR_LINE_STYLE
 
static const QString EXPR_LINEANGLE
 
static const QString EXPR_LINEWIDTH
 
static const QString EXPR_MAX_DISTANCE
 
static const QString EXPR_NAME
 
static const QString EXPR_OFFSET
 
static const QString EXPR_OFFSET_ALONG_LINE
 
static const QString EXPR_OUTLINE
 
static const QString EXPR_OUTLINE_COLOR
 
static const QString EXPR_OUTLINE_STYLE
 
static const QString EXPR_OUTLINE_WIDTH
 
static const QString EXPR_PLACEMENT
 
static const QString EXPR_REFERENCE1_ISCENTROID
 
static const QString EXPR_REFERENCE1_X
 
static const QString EXPR_REFERENCE1_Y
 
static const QString EXPR_REFERENCE2_ISCENTROID
 
static const QString EXPR_REFERENCE2_X
 
static const QString EXPR_REFERENCE2_Y
 
static const QString EXPR_ROTATION
 
static const QString EXPR_SIZE
 
static const QString EXPR_SPREAD
 
static const QString EXPR_SVG_FILE
 
static const QString EXPR_SVG_FILL_COLOR
 
static const QString EXPR_SVG_OUTLINE_COLOR
 
static const QString EXPR_SVG_OUTLINE_WIDTH
 
static const QString EXPR_SYMBOL_NAME
 
static const QString EXPR_USE_WHOLE_SHAPE
 
static const QString EXPR_VERTICAL_ANCHOR_POINT
 
static const QString EXPR_WIDTH
 
static const QString EXPR_WIDTH_BORDER
 
static const bool selectFillBorder = false
 
static const bool selectFillStyle = false
 
static const bool selectionIsOpaque = true
 

Detailed Description

Definition at line 33 of file qgslinesymbollayerv2.h.

Constructor & Destructor Documentation

QgsSimpleLineSymbolLayerV2::QgsSimpleLineSymbolLayerV2 ( const QColor color = DEFAULT_SIMPLELINE_COLOR,
double  width = DEFAULT_SIMPLELINE_WIDTH,
Qt::PenStyle  penStyle = DEFAULT_SIMPLELINE_PENSTYLE 
)

Definition at line 34 of file qgslinesymbollayerv2.cpp.

Member Function Documentation

QgsSimpleLineSymbolLayerV2 * QgsSimpleLineSymbolLayerV2::clone ( ) const
overridevirtual

Shall be reimplemented by subclasses to create a deep copy of the instance.

Implements QgsSymbolLayerV2.

Definition at line 375 of file qgslinesymbollayerv2.cpp.

QgsSymbolLayerV2 * QgsSimpleLineSymbolLayerV2::create ( const QgsStringMap properties = QgsStringMap())
static

Definition at line 84 of file qgslinesymbollayerv2.cpp.

QgsSymbolLayerV2 * QgsSimpleLineSymbolLayerV2::createFromSld ( QDomElement element)
static

Definition at line 440 of file qgslinesymbollayerv2.cpp.

const QgsMapUnitScale& QgsSimpleLineSymbolLayerV2::customDashPatternMapUnitScale ( ) const
inline

Definition at line 91 of file qgslinesymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsSimpleLineSymbolLayerV2::customDashPatternUnit ( ) const
inline

Definition at line 89 of file qgslinesymbollayerv2.h.

QVector<qreal> QgsSimpleLineSymbolLayerV2::customDashVector ( ) const
inline

Definition at line 94 of file qgslinesymbollayerv2.h.

bool QgsSimpleLineSymbolLayerV2::drawInsidePolygon ( ) const
inline

Definition at line 98 of file qgslinesymbollayerv2.h.

QColor QgsSimpleLineSymbolLayerV2::dxfColor ( QgsSymbolV2RenderContext context) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 625 of file qgslinesymbollayerv2.cpp.

QVector< qreal > QgsSimpleLineSymbolLayerV2::dxfCustomDashPattern ( QgsSymbolV2::OutputUnit unit) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 597 of file qgslinesymbollayerv2.cpp.

double QgsSimpleLineSymbolLayerV2::dxfOffset ( const QgsDxfExport e,
QgsSymbolV2RenderContext context 
) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 638 of file qgslinesymbollayerv2.cpp.

Qt::PenStyle QgsSimpleLineSymbolLayerV2::dxfPenStyle ( ) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 603 of file qgslinesymbollayerv2.cpp.

double QgsSimpleLineSymbolLayerV2::dxfWidth ( const QgsDxfExport e,
QgsSymbolV2RenderContext context 
) const
overridevirtual

Reimplemented from QgsLineSymbolLayerV2.

Definition at line 608 of file qgslinesymbollayerv2.cpp.

double QgsSimpleLineSymbolLayerV2::estimateMaxBleed ( ) const
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 584 of file qgslinesymbollayerv2.cpp.

QString QgsSimpleLineSymbolLayerV2::layerType ( ) const
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 184 of file qgslinesymbollayerv2.cpp.

QgsMapUnitScale QgsSimpleLineSymbolLayerV2::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 73 of file qgslinesymbollayerv2.cpp.

QString QgsSimpleLineSymbolLayerV2::ogrFeatureStyle ( double  mmScaleFactor,
double  mapUnitScaleFactor 
) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 425 of file qgslinesymbollayerv2.cpp.

QgsSymbolV2::OutputUnit QgsSimpleLineSymbolLayerV2::outputUnit ( ) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 55 of file qgslinesymbollayerv2.cpp.

Qt::PenCapStyle QgsSimpleLineSymbolLayerV2::penCapStyle ( ) const
inline

Definition at line 82 of file qgslinesymbollayerv2.h.

Qt::PenJoinStyle QgsSimpleLineSymbolLayerV2::penJoinStyle ( ) const
inline

Definition at line 79 of file qgslinesymbollayerv2.h.

Qt::PenStyle QgsSimpleLineSymbolLayerV2::penStyle ( ) const
inline

Definition at line 76 of file qgslinesymbollayerv2.h.

QgsStringMap QgsSimpleLineSymbolLayerV2::properties ( ) const
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 353 of file qgslinesymbollayerv2.cpp.

void QgsSimpleLineSymbolLayerV2::renderPolygonOutline ( const QPolygonF points,
QList< QPolygonF > *  rings,
QgsSymbolV2RenderContext context 
)
overridevirtual

Reimplemented from QgsLineSymbolLayerV2.

Definition at line 241 of file qgslinesymbollayerv2.cpp.

void QgsSimpleLineSymbolLayerV2::renderPolyline ( const QPolygonF points,
QgsSymbolV2RenderContext context 
)
overridevirtual

Implements QgsLineSymbolLayerV2.

Definition at line 288 of file qgslinesymbollayerv2.cpp.

void QgsSimpleLineSymbolLayerV2::setCustomDashPatternMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 92 of file qgslinesymbollayerv2.h.

void QgsSimpleLineSymbolLayerV2::setCustomDashPatternUnit ( QgsSymbolV2::OutputUnit  unit)
inline

Definition at line 88 of file qgslinesymbollayerv2.h.

void QgsSimpleLineSymbolLayerV2::setCustomDashVector ( const QVector< qreal > &  vector)
inline

Definition at line 95 of file qgslinesymbollayerv2.h.

void QgsSimpleLineSymbolLayerV2::setDrawInsidePolygon ( bool  drawInsidePolygon)
inline

Definition at line 100 of file qgslinesymbollayerv2.h.

void QgsSimpleLineSymbolLayerV2::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 65 of file qgslinesymbollayerv2.cpp.

void QgsSimpleLineSymbolLayerV2::setOutputUnit ( QgsSymbolV2::OutputUnit  unit)
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 47 of file qgslinesymbollayerv2.cpp.

void QgsSimpleLineSymbolLayerV2::setPenCapStyle ( Qt::PenCapStyle  style)
inline

Definition at line 83 of file qgslinesymbollayerv2.h.

void QgsSimpleLineSymbolLayerV2::setPenJoinStyle ( Qt::PenJoinStyle  style)
inline

Definition at line 80 of file qgslinesymbollayerv2.h.

void QgsSimpleLineSymbolLayerV2::setPenStyle ( Qt::PenStyle  style)
inline

Definition at line 77 of file qgslinesymbollayerv2.h.

void QgsSimpleLineSymbolLayerV2::setUseCustomDashPattern ( bool  b)
inline

Definition at line 86 of file qgslinesymbollayerv2.h.

void QgsSimpleLineSymbolLayerV2::startRender ( QgsSymbolV2RenderContext context)
overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 189 of file qgslinesymbollayerv2.cpp.

void QgsSimpleLineSymbolLayerV2::stopRender ( QgsSymbolV2RenderContext context)
overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 236 of file qgslinesymbollayerv2.cpp.

void QgsSimpleLineSymbolLayerV2::toSld ( QDomDocument doc,
QDomElement element,
const QgsStringMap props 
) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 395 of file qgslinesymbollayerv2.cpp.

bool QgsSimpleLineSymbolLayerV2::useCustomDashPattern ( ) const
inline

Definition at line 85 of file qgslinesymbollayerv2.h.

Member Data Documentation

QgsMapUnitScale QgsSimpleLineSymbolLayerV2::mCustomDashPatternMapUnitScale
protected

Definition at line 119 of file qgslinesymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsSimpleLineSymbolLayerV2::mCustomDashPatternUnit
protected

Definition at line 118 of file qgslinesymbollayerv2.h.

QVector<qreal> QgsSimpleLineSymbolLayerV2::mCustomDashVector
protected

Vector with an even number of entries for the.

Definition at line 122 of file qgslinesymbollayerv2.h.

bool QgsSimpleLineSymbolLayerV2::mDrawInsidePolygon
protected

Definition at line 124 of file qgslinesymbollayerv2.h.

QPen QgsSimpleLineSymbolLayerV2::mPen
protected

Definition at line 113 of file qgslinesymbollayerv2.h.

Qt::PenCapStyle QgsSimpleLineSymbolLayerV2::mPenCapStyle
protected

Definition at line 112 of file qgslinesymbollayerv2.h.

Qt::PenJoinStyle QgsSimpleLineSymbolLayerV2::mPenJoinStyle
protected

Definition at line 111 of file qgslinesymbollayerv2.h.

Qt::PenStyle QgsSimpleLineSymbolLayerV2::mPenStyle
protected

Definition at line 110 of file qgslinesymbollayerv2.h.

QPen QgsSimpleLineSymbolLayerV2::mSelPen
protected

Definition at line 114 of file qgslinesymbollayerv2.h.

bool QgsSimpleLineSymbolLayerV2::mUseCustomDashPattern
protected

Definition at line 117 of file qgslinesymbollayerv2.h.


The documentation for this class was generated from the following files: