QGIS API Documentation
2.18.21-Las Palmas (9fba24a)
|
#include <qgsmarkersymbollayerv2.h>
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... | |
QgsSvgMarkerSymbolLayerV2 * | clone () 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 QgsMapUnitScale & | outlineWidthMapUnitScale () 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 |
Renders a marker at the specified point. More... | |
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, QPointF shift=QPointF(0.0, 0.0)) const override |
write as DXF More... | |
void | writeSldMarker (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override |
Writes the symbol layer definition as a SLD XML element. More... | |
Public Member Functions inherited from QgsMarkerSymbolLayerV2 | |
double | angle () const |
Returns the rotation angle for the marker, in degrees clockwise from north. More... | |
void | drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size) override |
HorizontalAnchorPoint | horizontalAnchorPoint () const |
Returns the horizontal anchor point for positioning the symbol. More... | |
QgsMapUnitScale | mapUnitScale () const override |
QPointF | offset () const |
Returns the marker's offset, which is the horizontal and vertical displacement which the rendered marker will have from the original feature's geometry. More... | |
const QgsMapUnitScale & | offsetMapUnitScale () const |
Returns the map unit scale for the symbol's offset. More... | |
QgsSymbolV2::OutputUnit | offsetUnit () const |
Returns the units for the symbol's offset. More... | |
QgsSymbolV2::OutputUnit | outputUnit () const override |
QgsSymbolV2::ScaleMethod | scaleMethod () const |
Returns the method to use for scaling the marker's size. More... | |
void | setAngle (double angle) |
Sets the rotation angle for the marker. More... | |
void | setHorizontalAnchorPoint (HorizontalAnchorPoint h) |
Sets the horizontal anchor point for positioning the symbol. More... | |
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) |
Sets the marker's offset, which is the horizontal and vertical displacement which the rendered marker should have from the original feature's geometry. More... | |
void | setOffsetMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the symbol's offset. More... | |
void | setOffsetUnit (QgsSymbolV2::OutputUnit unit) |
Sets the units for the symbol's offset. More... | |
void | setOutputUnit (QgsSymbolV2::OutputUnit unit) override |
void | setScaleMethod (QgsSymbolV2::ScaleMethod scaleMethod) |
Sets the method to use for scaling the marker's size. More... | |
void | setSize (double size) |
Sets the symbol size. More... | |
void | setSizeMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the symbol's size. More... | |
void | setSizeUnit (QgsSymbolV2::OutputUnit unit) |
Sets the units for the symbol's size. More... | |
void | setVerticalAnchorPoint (VerticalAnchorPoint v) |
Sets the vertical anchor point for positioning the symbol. More... | |
double | size () const |
Returns the symbol size. More... | |
const QgsMapUnitScale & | sizeMapUnitScale () const |
Returns the map unit scale for the symbol's size. More... | |
QgsSymbolV2::OutputUnit | sizeUnit () const |
Returns the units for the symbol's size. More... | |
void | startRender (QgsSymbolV2RenderContext &context) override |
virtual void | toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override |
Writes the SLD element following the SLD v1.1 specs. More... | |
VerticalAnchorPoint | verticalAnchorPoint () const |
Returns the vertical anchor point for positioning the symbol. More... | |
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 double | dxfAngle (QgsSymbolV2RenderContext &context) const |
get angle More... | |
virtual QColor | dxfBrushColor (QgsSymbolV2RenderContext &context) const |
get brush/fill color More... | |
virtual Qt::BrushStyle | dxfBrushStyle () const |
get brush/fill style More... | |
virtual QColor | dxfColor (QgsSymbolV2RenderContext &context) const |
get color More... | |
virtual QVector< qreal > | dxfCustomDashPattern (QgsSymbolV2::OutputUnit &unit) const |
get dash pattern More... | |
virtual double | dxfOffset (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const |
get offset More... | |
virtual Qt::PenStyle | dxfPenStyle () const |
get pen style More... | |
virtual double | dxfWidth (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const |
get line width More... | |
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 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 |
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 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 QgsSymbolV2 * | subSymbol () |
QgsSymbolV2::SymbolType | type () const |
virtual QSet< QString > | usedAttributes () const |
Returns the set of attributes referenced by the layer. More... | |
Static Public Member Functions | |
static QgsSymbolLayerV2 * | create (const QgsStringMap &properties=QgsStringMap()) |
static QgsSymbolLayerV2 * | createFromSld (QDomElement &element) |
Additional Inherited Members | |
Public Types inherited from QgsMarkerSymbolLayerV2 | |
enum | HorizontalAnchorPoint { Left, HCenter, Right } |
Symbol horizontal anchor points. More... | |
enum | VerticalAnchorPoint { Top, VCenter, Bottom } |
Symbol vertical anchor points. More... | |
Protected Member Functions inherited from QgsMarkerSymbolLayerV2 | |
QgsMarkerSymbolLayerV2 (bool locked=false) | |
Constructor for QgsMarkerSymbolLayerV2. More... | |
void | markerOffset (QgsSymbolV2RenderContext &context, double &offsetX, double &offsetY) const |
Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point. More... | |
void | markerOffset (QgsSymbolV2RenderContext &context, double width, double height, double &offsetX, double &offsetY) const |
Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point. More... | |
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 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... | |
Static Protected Member Functions inherited from QgsMarkerSymbolLayerV2 | |
static QPointF | _rotatedOffset (QPointF offset, double angle) |
Adjusts a marker offset to account for rotation. 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 |
Definition at line 483 of file qgsmarkersymbollayerv2.h.
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 1753 of file qgsmarkersymbollayerv2.cpp.
|
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.
Reimplemented from QgsMarkerSymbolLayerV2.
Definition at line 2435 of file qgsmarkersymbollayerv2.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayerV2.
Definition at line 2183 of file qgsmarkersymbollayerv2.cpp.
|
static |
Definition at line 1767 of file qgsmarkersymbollayerv2.cpp.
|
static |
Definition at line 2263 of file qgsmarkersymbollayerv2.cpp.
|
inlineoverridevirtual |
Get fill color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayerV2.
Definition at line 515 of file qgsmarkersymbollayerv2.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 1943 of file qgsmarkersymbollayerv2.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 2225 of file qgsmarkersymbollayerv2.cpp.
|
inlineoverridevirtual |
Get outline color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayerV2.
Definition at line 518 of file qgsmarkersymbollayerv2.h.
|
inline |
Definition at line 521 of file qgsmarkersymbollayerv2.h.
|
inline |
Definition at line 528 of file qgsmarkersymbollayerv2.h.
|
inline |
Definition at line 525 of file qgsmarkersymbollayerv2.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 2209 of file qgsmarkersymbollayerv2.cpp.
|
inline |
Definition at line 512 of file qgsmarkersymbollayerv2.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 2159 of file qgsmarkersymbollayerv2.cpp.
|
overridevirtual |
Renders a marker at the specified point.
Derived classes must implement this to handle drawing the point.
point | position at which to render point, in painter units |
context | symbol render context |
Implements QgsMarkerSymbolLayerV2.
Definition at line 1960 of file qgsmarkersymbollayerv2.cpp.
|
inlineoverridevirtual |
Set fill color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayerV2.
Definition at line 516 of file qgsmarkersymbollayerv2.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 2219 of file qgsmarkersymbollayerv2.cpp.
|
inlineoverridevirtual |
Set outline color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayerV2.
Definition at line 519 of file qgsmarkersymbollayerv2.h.
|
inline |
Definition at line 522 of file qgsmarkersymbollayerv2.h.
|
inline |
Definition at line 527 of file qgsmarkersymbollayerv2.h.
|
inline |
Definition at line 524 of file qgsmarkersymbollayerv2.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 2203 of file qgsmarkersymbollayerv2.cpp.
void QgsSvgMarkerSymbolLayerV2::setPath | ( | const QString & | path | ) |
Definition at line 1898 of file qgsmarkersymbollayerv2.cpp.
|
overridevirtual |
Implements QgsSymbolLayerV2.
Definition at line 1948 of file qgsmarkersymbollayerv2.cpp.
|
overridevirtual |
Implements QgsSymbolLayerV2.
Definition at line 1955 of file qgsmarkersymbollayerv2.cpp.
|
overridevirtual |
write as DXF
Reimplemented from QgsSymbolLayerV2.
Definition at line 2307 of file qgsmarkersymbollayerv2.cpp.
|
overridevirtual |
Writes the symbol layer definition as a SLD XML element.
doc | XML document |
element | parent XML element |
props | symbol layer definition (see properties()) |
Reimplemented from QgsMarkerSymbolLayerV2.
Definition at line 2234 of file qgsmarkersymbollayerv2.cpp.
|
protected |
Definition at line 545 of file qgsmarkersymbollayerv2.h.
|
protected |
Definition at line 546 of file qgsmarkersymbollayerv2.h.
|
protected |
Definition at line 548 of file qgsmarkersymbollayerv2.h.
|
protected |
Definition at line 547 of file qgsmarkersymbollayerv2.h.
|
protected |
Definition at line 541 of file qgsmarkersymbollayerv2.h.