QGIS API Documentation
2.14.0-Essen
|
#include <qgssymbolv2.h>
Public Types | |
enum | OutputUnit { MM = 0, MapUnit, Mixed, Pixel, Percentage } |
The unit of the output. More... | |
typedef QList< OutputUnit > | OutputUnitList |
enum | RenderHint { DataDefinedSizeScale = 1, DataDefinedRotation = 2 } |
enum | ScaleMethod { ScaleArea, ScaleDiameter } |
Scale method. More... | |
enum | SymbolType { Marker, Line, Fill, Hybrid } |
Type of the symbol. More... | |
Public Member Functions | |
virtual | ~QgsSymbolV2 () |
qreal | alpha () const |
Get alpha transparency 1 for opaque, 0 for invisible. More... | |
bool | appendSymbolLayer (QgsSymbolLayerV2 *layer) |
Append symbol layer at the end of the list Ownership will be transferred. More... | |
QImage | asImage (QSize size, QgsRenderContext *customContext=nullptr) |
Generate symbol as image. More... | |
QImage | bigSymbolPreviewImage (QgsExpressionContext *expressionContext=nullptr) |
Returns a large (roughly 100x100 pixel) preview image for the symbol. More... | |
bool | changeSymbolLayer (int index, QgsSymbolLayerV2 *layer) |
delete layer at specified index and set a new one More... | |
bool | clipFeaturesToExtent () const |
Returns whether features drawn by the symbol will be clipped to the render context's extent. More... | |
virtual QgsSymbolV2 * | clone () const =0 |
QColor | color () const |
bool | deleteSymbolLayer (int index) |
delete symbol layer at specified index More... | |
void | drawPreviewIcon (QPainter *painter, QSize size, QgsRenderContext *customContext=nullptr) |
Draw icon of the symbol that occupyies area given by size using the painter. More... | |
QString | dump () const |
void | exportImage (const QString &path, const QString &format, QSize size) |
export symbol as image format. PNG and SVG supported More... | |
bool | hasDataDefinedProperties () const |
Returns whether the symbol utilises any data defined properties. More... | |
bool | insertSymbolLayer (int index, QgsSymbolLayerV2 *layer) |
Insert symbol layer to specified index Ownership will be transferred. More... | |
const QgsVectorLayer * | layer () const |
QgsMapUnitScale | mapUnitScale () const |
QgsSymbolV2::OutputUnit | outputUnit () const |
void | renderFeature (const QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false, int currentVertexMarkerType=0, int currentVertexMarkerSize=0) |
Render a feature. More... | |
int | renderHints () const |
void | setAlpha (qreal alpha) |
Set alpha transparency 1 for opaque, 0 for invisible. More... | |
void | setClipFeaturesToExtent (bool clipFeaturesToExtent) |
Sets whether features drawn by the symbol should be clipped to the render context's extent. More... | |
void | setColor (const QColor &color) |
void | setLayer (const QgsVectorLayer *layer) |
void | setMapUnitScale (const QgsMapUnitScale &scale) |
void | setOutputUnit (QgsSymbolV2::OutputUnit u) |
void | setRenderHints (int hints) |
void | startRender (QgsRenderContext &context, const QgsFields *fields=nullptr) |
void | stopRender (QgsRenderContext &context) |
QgsSymbolLayerV2 * | symbolLayer (int layer) |
Returns a specific symbol layers contained in the symbol. More... | |
int | symbolLayerCount () |
Returns total number of symbol layers contained in the symbol. More... | |
QgsSymbolLayerV2List | symbolLayers () |
Returns list of symbol layers contained in the symbol. More... | |
QgsSymbolV2RenderContext * | symbolRenderContext () |
Returns the symbol render context. More... | |
QgsSymbolLayerV2 * | takeSymbolLayer (int index) |
Remove symbol layer from the list and return pointer to it. More... | |
void | toSld (QDomDocument &doc, QDomElement &element, QgsStringMap props) const |
SymbolType | type () const |
QSet< QString > | usedAttributes () const |
Return a list of attributes required to render this feature. More... | |
Static Public Member Functions | |
static QgsSymbolV2 * | defaultSymbol (QGis::GeometryType geomType) |
return new default symbol for specified geometry type More... | |
Protected Member Functions | |
QgsSymbolV2 (SymbolType type, const QgsSymbolLayerV2List &layers) | |
QgsSymbolLayerV2List | cloneLayers () const |
Retrieve a cloned list of all layers that make up this symbol. More... | |
Q_DECL_DEPRECATED bool | isSymbolLayerCompatible (SymbolType layerType) |
check whether a symbol layer type can be used within the symbol (marker-marker, line-line, fill-fill/line) More... | |
void | renderUsingLayer (QgsSymbolLayerV2 *layer, QgsSymbolV2RenderContext &context) |
Renders a context using a particular symbol layer without passing in a geometry. More... | |
Static Protected Member Functions | |
static QgsConstWkbPtr | _getLineString (QPolygonF &pts, QgsRenderContext &context, QgsConstWkbPtr wkb, bool clipToExtent=true) |
Creates a line string in screen coordinates from a wkb string in map coordinates. More... | |
static void | _getPoint (QPointF &pt, QgsRenderContext &context, const QgsPointV2 *point) |
Creates a point in screen coordinates from a QgsPointV2 in map coordinates. More... | |
static QgsConstWkbPtr | _getPoint (QPointF &pt, QgsRenderContext &context, QgsConstWkbPtr wkb) |
Creates a point in screen coordinates from a wkb string in map coordinates. More... | |
static QgsConstWkbPtr | _getPolygon (QPolygonF &pts, QList< QPolygonF > &holes, QgsRenderContext &context, QgsConstWkbPtr wkb, bool clipToExtent=true) |
Creates a polygon in screen coordinates from a wkb string in map coordinates. More... | |
Protected Attributes | |
qreal | mAlpha |
Symbol opacity (in the range 0 - 1) More... | |
bool | mClipFeaturesToExtent |
const QgsVectorLayer * | mLayer |
QgsSymbolLayerV2List | mLayers |
int | mRenderHints |
SymbolType | mType |
Friends | |
class | QgsFeatureRendererV2 |
Definition at line 52 of file qgssymbolv2.h.
typedef QList<OutputUnit> QgsSymbolV2::OutputUnitList |
Definition at line 71 of file qgssymbolv2.h.
The unit of the output.
Definition at line 62 of file qgssymbolv2.h.
Enumerator | |
---|---|
DataDefinedSizeScale | |
DataDefinedRotation |
Definition at line 93 of file qgssymbolv2.h.
Scale method.
Enumerator | |
---|---|
ScaleArea |
Calculate scale by the area. |
ScaleDiameter |
Calculate scale by the diameter. |
Definition at line 87 of file qgssymbolv2.h.
Type of the symbol.
Enumerator | |
---|---|
Marker |
Marker symbol. |
Line |
Line symbol. |
Fill |
Fill symbol. |
Hybrid |
Hybrid symbol. |
Definition at line 76 of file qgssymbolv2.h.
|
virtual |
Definition at line 254 of file qgssymbolv2.cpp.
|
protected |
Definition at line 84 of file qgssymbolv2.cpp.
|
staticprotected |
Creates a line string in screen coordinates from a wkb string in map coordinates.
Definition at line 126 of file qgssymbolv2.cpp.
|
inlinestaticprotected |
Creates a point in screen coordinates from a QgsPointV2 in map coordinates.
Definition at line 261 of file qgssymbolv2.h.
|
staticprotected |
Creates a point in screen coordinates from a wkb string in map coordinates.
Definition at line 109 of file qgssymbolv2.cpp.
|
staticprotected |
Creates a polygon in screen coordinates from a wkb string in map coordinates.
Definition at line 181 of file qgssymbolv2.cpp.
|
inline |
Get alpha transparency 1 for opaque, 0 for invisible.
Definition at line 200 of file qgssymbolv2.h.
bool QgsSymbolV2::appendSymbolLayer | ( | QgsSymbolLayerV2 * | layer | ) |
Append symbol layer at the end of the list Ownership will be transferred.
layer | The layer to add |
Definition at line 408 of file qgssymbolv2.cpp.
QImage QgsSymbolV2::asImage | ( | QSize | size, |
QgsRenderContext * | customContext = nullptr |
||
) |
Generate symbol as image.
Definition at line 549 of file qgssymbolv2.cpp.
QImage QgsSymbolV2::bigSymbolPreviewImage | ( | QgsExpressionContext * | expressionContext = nullptr | ) |
Returns a large (roughly 100x100 pixel) preview image for the symbol.
expressionContext | optional expression context, for evaluation of data defined symbol properties |
Definition at line 563 of file qgssymbolv2.cpp.
bool QgsSymbolV2::changeSymbolLayer | ( | int | index, |
QgsSymbolLayerV2 * | layer | ||
) |
delete layer at specified index and set a new one
Definition at line 438 of file qgssymbolv2.cpp.
|
inline |
Returns whether features drawn by the symbol will be clipped to the render context's extent.
If this option is enabled then features which are partially outside the extent will be clipped. This speeds up rendering of the feature, but may have undesirable side effects for certain symbol types.
Definition at line 225 of file qgssymbolv2.h.
|
pure virtual |
Implemented in QgsFillSymbolV2, QgsLineSymbolV2, and QgsMarkerSymbolV2.
|
protected |
Retrieve a cloned list of all layers that make up this symbol.
Ownership is transferred to the caller.
Definition at line 646 of file qgssymbolv2.cpp.
QColor QgsSymbolV2::color | ( | void | ) | const |
Definition at line 490 of file qgssymbolv2.cpp.
|
static |
return new default symbol for specified geometry type
Definition at line 322 of file qgssymbolv2.cpp.
bool QgsSymbolV2::deleteSymbolLayer | ( | int | index | ) |
delete symbol layer at specified index
Definition at line 418 of file qgssymbolv2.cpp.
void QgsSymbolV2::drawPreviewIcon | ( | QPainter * | painter, |
QSize | size, | ||
QgsRenderContext * | customContext = nullptr |
||
) |
Draw icon of the symbol that occupyies area given by size using the painter.
Optionally custom context may be given in order to get rendering of symbols that use map units right.
Definition at line 501 of file qgssymbolv2.cpp.
QString QgsSymbolV2::dump | ( | void | ) | const |
Definition at line 607 of file qgssymbolv2.cpp.
export symbol as image format. PNG and SVG supported
Definition at line 529 of file qgssymbolv2.cpp.
bool QgsSymbolV2::hasDataDefinedProperties | ( | ) | const |
Returns whether the symbol utilises any data defined properties.
Definition at line 697 of file qgssymbolv2.cpp.
bool QgsSymbolV2::insertSymbolLayer | ( | int | index, |
QgsSymbolLayerV2 * | layer | ||
) |
Insert symbol layer to specified index Ownership will be transferred.
index | The index at which the layer should be added |
layer | The symbol layer to add |
Definition at line 395 of file qgssymbolv2.cpp.
|
protected |
check whether a symbol layer type can be used within the symbol (marker-marker, line-line, fill-fill/line)
Definition at line 385 of file qgssymbolv2.cpp.
|
inline |
Definition at line 241 of file qgssymbolv2.h.
QgsMapUnitScale QgsSymbolV2::mapUnitScale | ( | ) | const |
Definition at line 282 of file qgssymbolv2.cpp.
QgsSymbolV2::OutputUnit QgsSymbolV2::outputUnit | ( | ) | const |
Definition at line 261 of file qgssymbolv2.cpp.
void QgsSymbolV2::renderFeature | ( | const QgsFeature & | feature, |
QgsRenderContext & | context, | ||
int | layer = -1 , |
||
bool | selected = false , |
||
bool | drawVertexMarker = false , |
||
int | currentVertexMarkerType = 0 , |
||
int | currentVertexMarkerSize = 0 |
||
) |
Render a feature.
Definition at line 707 of file qgssymbolv2.cpp.
|
inline |
Definition at line 205 of file qgssymbolv2.h.
|
protected |
Renders a context using a particular symbol layer without passing in a geometry.
This is used as fallback, if the symbol being rendered is not compatible with the specified layer. In such a case, this method can be called and will call the layer's rendering method anyway but the geometry passed to the layer will be empty. This is required for layers that generate their own geometry from other information in the rendering context.
Definition at line 659 of file qgssymbolv2.cpp.
|
inline |
Set alpha transparency 1 for opaque, 0 for invisible.
Definition at line 202 of file qgssymbolv2.h.
|
inline |
Sets whether features drawn by the symbol should be clipped to the render context's extent.
If this option is enabled then features which are partially outside the extent will be clipped. This speeds up rendering of the feature, but may have undesirable side effects for certain symbol types.
clipFeaturesToExtent | set to true to enable clipping (defaults to true) |
Definition at line 215 of file qgssymbolv2.h.
void QgsSymbolV2::setColor | ( | const QColor & | color | ) |
Definition at line 481 of file qgssymbolv2.cpp.
|
inline |
Definition at line 240 of file qgssymbolv2.h.
void QgsSymbolV2::setMapUnitScale | ( | const QgsMapUnitScale & | scale | ) |
Definition at line 314 of file qgssymbolv2.cpp.
void QgsSymbolV2::setOutputUnit | ( | QgsSymbolV2::OutputUnit | u | ) |
Definition at line 306 of file qgssymbolv2.cpp.
|
inline |
Definition at line 204 of file qgssymbolv2.h.
void QgsSymbolV2::startRender | ( | QgsRenderContext & | context, |
const QgsFields * | fields = nullptr |
||
) |
Definition at line 454 of file qgssymbolv2.cpp.
void QgsSymbolV2::stopRender | ( | QgsRenderContext & | context | ) |
Definition at line 469 of file qgssymbolv2.cpp.
QgsSymbolLayerV2 * QgsSymbolV2::symbolLayer | ( | int | layer | ) |
Returns a specific symbol layers contained in the symbol.
layer | layer number |
Definition at line 379 of file qgssymbolv2.cpp.
|
inline |
Returns total number of symbol layers contained in the symbol.
Definition at line 131 of file qgssymbolv2.h.
|
inline |
Returns list of symbol layers contained in the symbol.
Definition at line 114 of file qgssymbolv2.h.
QgsSymbolV2RenderContext * QgsSymbolV2::symbolRenderContext | ( | ) |
Returns the symbol render context.
Only valid between startRender and stopRender calls.
Definition at line 940 of file qgssymbolv2.cpp.
QgsSymbolLayerV2 * QgsSymbolV2::takeSymbolLayer | ( | int | index | ) |
Remove symbol layer from the list and return pointer to it.
Ownership is handed to the caller.
index | The index of the layer to remove |
Definition at line 429 of file qgssymbolv2.cpp.
void QgsSymbolV2::toSld | ( | QDomDocument & | doc, |
QDomElement & | element, | ||
QgsStringMap | props | ||
) | const |
Definition at line 633 of file qgssymbolv2.cpp.
|
inline |
Definition at line 104 of file qgssymbolv2.h.
Return a list of attributes required to render this feature.
This should include any attributes required by the symbology including the ones required by expressions.
Definition at line 683 of file qgssymbolv2.cpp.
|
friend |
Definition at line 54 of file qgssymbolv2.h.
|
protected |
Symbol opacity (in the range 0 - 1)
Definition at line 322 of file qgssymbolv2.h.
|
protected |
Definition at line 325 of file qgssymbolv2.h.
|
protected |
Definition at line 327 of file qgssymbolv2.h.
|
protected |
Definition at line 319 of file qgssymbolv2.h.
|
protected |
Definition at line 324 of file qgssymbolv2.h.
|
protected |
Definition at line 318 of file qgssymbolv2.h.