QGIS API Documentation  2.13.0-Master
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
QgsSvgMarkerSymbolLayerV2 Class Reference

#include <qgsmarkersymbollayerv2.h>

Inheritance diagram for QgsSvgMarkerSymbolLayerV2:
Inheritance graph
[legend]

Public Member Functions

 QgsSvgMarkerSymbolLayerV2 (const QString &name=DEFAULT_SVGMARKER_NAME, double size=DEFAULT_SVGMARKER_SIZE, double angle=DEFAULT_SVGMARKER_ANGLE, QgsSymbolV2::ScaleMethod scaleMethod=DEFAULT_SCALE_METHOD)
 
QRectF bounds (QPointF point, QgsSymbolV2RenderContext &context) override
 Returns the approximate bounding box of the marker symbol layer, taking into account any data defined overrides and offsets which are set for the marker layer. More...
 
QgsSvgMarkerSymbolLayerV2clone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
QColor fillColor () const override
 Get fill color. More...
 
QString layerType () const override
 Returns a string that represents this layer type. More...
 
QgsMapUnitScale mapUnitScale () const override
 
QColor outlineColor () const override
 Get outline color. More...
 
double outlineWidth () const
 
const QgsMapUnitScaleoutlineWidthMapUnitScale () const
 
QgsSymbolV2::OutputUnit outlineWidthUnit () const
 
QgsSymbolV2::OutputUnit outputUnit () const override
 
QString path () 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 renderPoint (QPointF point, QgsSymbolV2RenderContext &context) override
 
void setFillColor (const QColor &color) override
 Set fill color. More...
 
void setMapUnitScale (const QgsMapUnitScale &scale) override
 
void setOutlineColor (const QColor &c) override
 Set outline color. More...
 
void setOutlineWidth (double w)
 
void setOutlineWidthMapUnitScale (const QgsMapUnitScale &scale)
 
void setOutlineWidthUnit (QgsSymbolV2::OutputUnit unit)
 
void setOutputUnit (QgsSymbolV2::OutputUnit unit) override
 
void setPath (const QString &path)
 
void startRender (QgsSymbolV2RenderContext &context) override
 
void stopRender (QgsSymbolV2RenderContext &context) override
 
bool writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolV2RenderContext *context, const QgsFeature *f, QPointF shift=QPointF(0.0, 0.0)) const override
 
void writeSldMarker (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override
 
- Public Member Functions inherited from QgsMarkerSymbolLayerV2
double angle () const
 
void drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size) override
 
HorizontalAnchorPoint horizontalAnchorPoint () const
 
QgsMapUnitScale mapUnitScale () const override
 
QPointF offset () const
 
const QgsMapUnitScaleoffsetMapUnitScale () const
 
QgsSymbolV2::OutputUnit offsetUnit () const
 
QgsSymbolV2::OutputUnit outputUnit () const override
 
QgsSymbolV2::ScaleMethod scaleMethod () const
 
void setAngle (double angle)
 
void setHorizontalAnchorPoint (HorizontalAnchorPoint h)
 
void setLineAngle (double lineAngle)
 Sets the line angle modification for the symbol's angle. More...
 
void setMapUnitScale (const QgsMapUnitScale &scale) override
 
void setOffset (QPointF offset)
 
void setOffsetMapUnitScale (const QgsMapUnitScale &scale)
 
void setOffsetUnit (QgsSymbolV2::OutputUnit unit)
 
void setOutputUnit (QgsSymbolV2::OutputUnit unit) override
 
void setScaleMethod (QgsSymbolV2::ScaleMethod scaleMethod)
 
void setSize (double size)
 
void setSizeMapUnitScale (const QgsMapUnitScale &scale)
 
void setSizeUnit (QgsSymbolV2::OutputUnit unit)
 
void setVerticalAnchorPoint (VerticalAnchorPoint v)
 
double size () const
 
const QgsMapUnitScalesizeMapUnitScale () const
 
QgsSymbolV2::OutputUnit sizeUnit () const
 
void startRender (QgsSymbolV2RenderContext &context) override
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override
 
VerticalAnchorPoint verticalAnchorPoint () 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 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 double dxfWidth (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const
 
virtual double estimateMaxBleed () const
 Returns the estimated maximum distance which the layer style will bleed outside the drawn shape. More...
 
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 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 QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
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...
 
void setLocked (bool locked)
 
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...
 

Static Public Member Functions

static QgsSymbolLayerV2create (const QgsStringMap &properties=QgsStringMap())
 
static QgsSymbolLayerV2createFromSld (QDomElement &element)
 

Protected Attributes

QColor mOutlineColor
 
double mOutlineWidth
 
QgsMapUnitScale mOutlineWidthMapUnitScale
 
QgsSymbolV2::OutputUnit mOutlineWidthUnit
 
QString mPath
 
- Protected Attributes inherited from QgsMarkerSymbolLayerV2
double mAngle
 
HorizontalAnchorPoint mHorizontalAnchorPoint
 
double mLineAngle
 
QPointF mOffset
 
QgsMapUnitScale mOffsetMapUnitScale
 
QgsSymbolV2::OutputUnit mOffsetUnit
 
QgsSymbolV2::ScaleMethod mScaleMethod
 
double mSize
 
QgsMapUnitScale mSizeMapUnitScale
 
QgsSymbolV2::OutputUnit mSizeUnit
 
VerticalAnchorPoint mVerticalAnchorPoint
 
- Protected Attributes inherited from QgsSymbolLayerV2
QColor mColor
 
QMap< QString, QgsDataDefined * > mDataDefinedProperties
 
QgsFields mFields
 
bool mLocked
 
QgsPaintEffectmPaintEffect
 
int mRenderingPass
 
QgsSymbolV2::SymbolType mType
 

Additional Inherited Members

- Public Types inherited from QgsMarkerSymbolLayerV2
enum  HorizontalAnchorPoint { Left, HCenter, Right }
 
enum  VerticalAnchorPoint { Top, VCenter, Bottom }
 
- Protected Member Functions inherited from QgsMarkerSymbolLayerV2
 QgsMarkerSymbolLayerV2 (bool locked=false)
 
void markerOffset (QgsSymbolV2RenderContext &context, double &offsetX, double &offsetY) const
 
void markerOffset (QgsSymbolV2RenderContext &context, double width, double height, double &offsetX, double &offsetY) const
 
void markerOffset (QgsSymbolV2RenderContext &context, double width, double height, QgsSymbolV2::OutputUnit widthUnit, QgsSymbolV2::OutputUnit heightUnit, double &offsetX, double &offsetY, const QgsMapUnitScale &widthMapUnitScale, const QgsMapUnitScale &heightMapUnitScale) const
 
- 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 Member Functions inherited from QgsMarkerSymbolLayerV2
static QPointF _rotatedOffset (QPointF offset, double angle)
 
- 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 151 of file qgsmarkersymbollayerv2.h.

Constructor & Destructor Documentation

QgsSvgMarkerSymbolLayerV2::QgsSvgMarkerSymbolLayerV2 ( const QString name = DEFAULT_SVGMARKER_NAME,
double  size = DEFAULT_SVGMARKER_SIZE,
double  angle = DEFAULT_SVGMARKER_ANGLE,
QgsSymbolV2::ScaleMethod  scaleMethod = DEFAULT_SCALE_METHOD 
)

Definition at line 1116 of file qgsmarkersymbollayerv2.cpp.

Member Function Documentation

QRectF QgsSvgMarkerSymbolLayerV2::bounds ( QPointF  point,
QgsSymbolV2RenderContext context 
)
overridevirtual

Returns the approximate bounding box of the marker symbol layer, taking into account any data defined overrides and offsets which are set for the marker layer.

Returns
approximate symbol bounds, in painter units
Note
added in QGIS 2.14
this method will become pure virtual in QGIS 3.0

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 1789 of file qgsmarkersymbollayerv2.cpp.

QgsSvgMarkerSymbolLayerV2 * QgsSvgMarkerSymbolLayerV2::clone ( ) const
overridevirtual

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

Implements QgsSymbolLayerV2.

Definition at line 1539 of file qgsmarkersymbollayerv2.cpp.

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

Definition at line 1130 of file qgsmarkersymbollayerv2.cpp.

QgsSymbolLayerV2 * QgsSvgMarkerSymbolLayerV2::createFromSld ( QDomElement element)
static

Definition at line 1617 of file qgsmarkersymbollayerv2.cpp.

QColor QgsSvgMarkerSymbolLayerV2::fillColor ( ) const
inlineoverridevirtual

Get fill color.

Supported by marker and fill layers.

Note
added in 2.1

Reimplemented from QgsSymbolLayerV2.

Definition at line 183 of file qgsmarkersymbollayerv2.h.

QString QgsSvgMarkerSymbolLayerV2::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 1306 of file qgsmarkersymbollayerv2.cpp.

QgsMapUnitScale QgsSvgMarkerSymbolLayerV2::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 1581 of file qgsmarkersymbollayerv2.cpp.

QColor QgsSvgMarkerSymbolLayerV2::outlineColor ( ) const
inlineoverridevirtual

Get outline color.

Supported by marker and fill layers.

Note
added in 2.1

Reimplemented from QgsSymbolLayerV2.

Definition at line 186 of file qgsmarkersymbollayerv2.h.

double QgsSvgMarkerSymbolLayerV2::outlineWidth ( ) const
inline

Definition at line 189 of file qgsmarkersymbollayerv2.h.

const QgsMapUnitScale& QgsSvgMarkerSymbolLayerV2::outlineWidthMapUnitScale ( ) const
inline

Definition at line 196 of file qgsmarkersymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsSvgMarkerSymbolLayerV2::outlineWidthUnit ( ) const
inline

Definition at line 193 of file qgsmarkersymbollayerv2.h.

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

Reimplemented from QgsSymbolLayerV2.

Definition at line 1565 of file qgsmarkersymbollayerv2.cpp.

QString QgsSvgMarkerSymbolLayerV2::path ( ) const
inline

Definition at line 180 of file qgsmarkersymbollayerv2.h.

QgsStringMap QgsSvgMarkerSymbolLayerV2::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 1515 of file qgsmarkersymbollayerv2.cpp.

void QgsSvgMarkerSymbolLayerV2::renderPoint ( QPointF  point,
QgsSymbolV2RenderContext context 
)
overridevirtual

Implements QgsMarkerSymbolLayerV2.

Definition at line 1323 of file qgsmarkersymbollayerv2.cpp.

void QgsSvgMarkerSymbolLayerV2::setFillColor ( const QColor color)
inlineoverridevirtual

Set fill color.

Supported by marker and fill layers.

Note
added in 2.1

Reimplemented from QgsSymbolLayerV2.

Definition at line 184 of file qgsmarkersymbollayerv2.h.

void QgsSvgMarkerSymbolLayerV2::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 1575 of file qgsmarkersymbollayerv2.cpp.

void QgsSvgMarkerSymbolLayerV2::setOutlineColor ( const QColor color)
inlineoverridevirtual

Set outline color.

Supported by marker and fill layers.

Note
added in 2.1

Reimplemented from QgsSymbolLayerV2.

Definition at line 187 of file qgsmarkersymbollayerv2.h.

void QgsSvgMarkerSymbolLayerV2::setOutlineWidth ( double  w)
inline

Definition at line 190 of file qgsmarkersymbollayerv2.h.

void QgsSvgMarkerSymbolLayerV2::setOutlineWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 195 of file qgsmarkersymbollayerv2.h.

void QgsSvgMarkerSymbolLayerV2::setOutlineWidthUnit ( QgsSymbolV2::OutputUnit  unit)
inline

Definition at line 192 of file qgsmarkersymbollayerv2.h.

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

Reimplemented from QgsSymbolLayerV2.

Definition at line 1559 of file qgsmarkersymbollayerv2.cpp.

void QgsSvgMarkerSymbolLayerV2::setPath ( const QString path)

Definition at line 1261 of file qgsmarkersymbollayerv2.cpp.

void QgsSvgMarkerSymbolLayerV2::startRender ( QgsSymbolV2RenderContext context)
overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 1311 of file qgsmarkersymbollayerv2.cpp.

void QgsSvgMarkerSymbolLayerV2::stopRender ( QgsSymbolV2RenderContext context)
overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 1318 of file qgsmarkersymbollayerv2.cpp.

bool QgsSvgMarkerSymbolLayerV2::writeDxf ( QgsDxfExport e,
double  mmMapUnitScaleFactor,
const QString layerName,
QgsSymbolV2RenderContext context,
const QgsFeature f,
QPointF  shift = QPointF( 0.0, 0.0 ) 
) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 1657 of file qgsmarkersymbollayerv2.cpp.

void QgsSvgMarkerSymbolLayerV2::writeSldMarker ( QDomDocument doc,
QDomElement element,
const QgsStringMap props 
) const
overridevirtual

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 1590 of file qgsmarkersymbollayerv2.cpp.

Member Data Documentation

QColor QgsSvgMarkerSymbolLayerV2::mOutlineColor
protected

Definition at line 213 of file qgsmarkersymbollayerv2.h.

double QgsSvgMarkerSymbolLayerV2::mOutlineWidth
protected

Definition at line 214 of file qgsmarkersymbollayerv2.h.

QgsMapUnitScale QgsSvgMarkerSymbolLayerV2::mOutlineWidthMapUnitScale
protected

Definition at line 216 of file qgsmarkersymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsSvgMarkerSymbolLayerV2::mOutlineWidthUnit
protected

Definition at line 215 of file qgsmarkersymbollayerv2.h.

QString QgsSvgMarkerSymbolLayerV2::mPath
protected

Definition at line 209 of file qgsmarkersymbollayerv2.h.


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