QGIS API Documentation
3.0.2-Girona (307d082)
|
#include <qgssymbol.h>
Public Member Functions | |
QgsMarkerSymbol (const QgsSymbolLayerList &layers=QgsSymbolLayerList()) | |
double | angle () const |
Returns the marker angle for the whole symbol. More... | |
QRectF | bounds (QPointF point, QgsRenderContext &context, const QgsFeature &feature=QgsFeature()) const |
Returns the approximate bounding box of the marker symbol, which includes the bounding box of all symbol layers for the symbol. More... | |
QgsMarkerSymbol * | clone () const override |
Get a deep copy of this symbol. More... | |
QgsProperty | dataDefinedAngle () const |
Returns data defined angle for whole symbol (including all symbol layers). More... | |
QgsProperty | dataDefinedSize () const |
Returns data defined size for whole symbol (including all symbol layers). More... | |
void | renderPoint (QPointF point, const QgsFeature *f, QgsRenderContext &context, int layer=-1, bool selected=false) |
ScaleMethod | scaleMethod () |
void | setAngle (double symbolAngle) |
Sets the angle for the whole symbol. More... | |
void | setDataDefinedAngle (const QgsProperty &property) |
Set data defined angle for whole symbol (including all symbol layers). More... | |
void | setDataDefinedSize (const QgsProperty &property) |
Set data defined size for whole symbol (including all symbol layers). More... | |
void | setLineAngle (double lineAngle) |
Sets the line angle modification for the symbol's angle. More... | |
void | setScaleMethod (QgsSymbol::ScaleMethod scaleMethod) |
void | setSize (double size) |
Sets the size for the whole symbol. More... | |
void | setSizeMapUnitScale (const QgsMapUnitScale &scale) |
Sets the size map unit scale for the whole symbol (including all symbol layers). More... | |
void | setSizeUnit (QgsUnitTypes::RenderUnit unit) |
Sets the size units for the whole symbol (including all symbol layers). More... | |
double | size () const |
Returns the size for the whole symbol, which is the maximum size of all marker symbol layers in the symbol. More... | |
QgsMapUnitScale | sizeMapUnitScale () const |
Returns the size map unit scale for the whole symbol. More... | |
QgsUnitTypes::RenderUnit | sizeUnit () const |
Returns the size units for the whole symbol (including all symbol layers). More... | |
Public Member Functions inherited from QgsSymbol | |
virtual | ~QgsSymbol () |
bool | appendSymbolLayer (QgsSymbolLayer *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, QgsSymbolLayer *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... | |
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 utilizes any data defined properties. More... | |
bool | insertSymbolLayer (int index, QgsSymbolLayer *layer) |
Insert symbol layer to specified index Ownership will be transferred. More... | |
const QgsVectorLayer * | layer () const |
QgsMapUnitScale | mapUnitScale () const |
qreal | opacity () const |
Returns the opacity for the symbol. More... | |
QgsUnitTypes::RenderUnit | outputUnit () const |
Returns the units to use for sizes and widths within the symbol. More... | |
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... | |
RenderHints | renderHints () const |
Returns the rendering hint flags for the symbol. 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 | setOpacity (qreal opacity) |
Sets the opacity for the symbol. More... | |
void | setOutputUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units to use for sizes and widths within the symbol. More... | |
void | setRenderHints (RenderHints hints) |
Sets rendering hint flags for the symbol. More... | |
void | startRender (QgsRenderContext &context, const QgsFields &fields=QgsFields()) |
Begins the rendering process for the symbol. More... | |
void | stopRender (QgsRenderContext &context) |
Ends the rendering process. More... | |
QgsSymbolLayer * | symbolLayer (int layer) |
Returns a specific symbol layers contained in the symbol. More... | |
int | symbolLayerCount () const |
Returns total number of symbol layers contained in the symbol. More... | |
QgsSymbolLayerList | symbolLayers () |
Returns list of symbol layers contained in the symbol. More... | |
QgsSymbolRenderContext * | symbolRenderContext () |
Returns the symbol render context. More... | |
QgsSymbolLayer * | 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 QgsRenderContext &context) const |
Return a list of attributes required to render this feature. More... | |
Static Public Member Functions | |
static QgsMarkerSymbol * | createSimple (const QgsStringMap &properties) |
Create a marker symbol with one symbol layer: SimpleMarker with specified properties. More... | |
Static Public Member Functions inherited from QgsSymbol | |
static QgsSymbol * | defaultSymbol (QgsWkbTypes::GeometryType geomType) |
return new default symbol for specified geometry type More... | |
Additional Inherited Members | |
Public Types inherited from QgsSymbol | |
enum | RenderHint { DynamicRotation = 2 } |
Flags controlling behavior of symbols during rendering. More... | |
enum | ScaleMethod { ScaleArea, ScaleDiameter } |
Scale method. More... | |
enum | SymbolType { Marker, Line, Fill, Hybrid } |
Type of the symbol. More... | |
Protected Member Functions inherited from QgsSymbol | |
QgsSymbol (SymbolType type, const QgsSymbolLayerList &layers) | |
QgsSymbolLayerList | cloneLayers () const |
Retrieve a cloned list of all layers that make up this symbol. More... | |
void | renderUsingLayer (QgsSymbolLayer *layer, QgsSymbolRenderContext &context) |
Renders a context using a particular symbol layer without passing in a geometry. More... | |
void | renderVertexMarker (QPointF pt, QgsRenderContext &context, int currentVertexMarkerType, int currentVertexMarkerSize) |
Render editing vertex marker at specified point. More... | |
Static Protected Member Functions inherited from QgsSymbol | |
static QPolygonF | _getLineString (QgsRenderContext &context, const QgsCurve &curve, bool clipToExtent=true) |
Creates a line string in screen coordinates from a QgsCurve in map coordinates. More... | |
static QPointF | _getPoint (QgsRenderContext &context, const QgsPoint &point) |
Creates a point in screen coordinates from a QgsPoint in map coordinates. More... | |
static void | _getPolygon (QPolygonF &pts, QList< QPolygonF > &holes, QgsRenderContext &context, const QgsPolygon &polygon, bool clipToExtent=true) |
Creates a polygon in screen coordinates from a QgsPolygonXYin map coordinates. More... | |
static QPolygonF | _getPolygonRing (QgsRenderContext &context, const QgsCurve &curve, bool clipToExtent) |
Creates a polygon ring in screen coordinates from a QgsCurve in map coordinates. More... | |
Protected Attributes inherited from QgsSymbol | |
bool | mClipFeaturesToExtent = true |
const QgsVectorLayer * | mLayer = nullptr |
QgsSymbolLayerList | mLayers |
qreal | mOpacity = 1.0 |
Symbol opacity (in the range 0 - 1) More... | |
RenderHints | mRenderHints = nullptr |
SymbolType | mType |
Definition at line 611 of file qgssymbol.h.
QgsMarkerSymbol::QgsMarkerSymbol | ( | const QgsSymbolLayerList & | layers = QgsSymbolLayerList() | ) |
Definition at line 1127 of file qgssymbol.cpp.
double QgsMarkerSymbol::angle | ( | ) | const |
Returns the marker angle for the whole symbol.
Note that for symbols with multiple symbol layers, this will correspond just to the angle of the first symbol layer.
Definition at line 1146 of file qgssymbol.cpp.
QRectF QgsMarkerSymbol::bounds | ( | QPointF | point, |
QgsRenderContext & | context, | ||
const QgsFeature & | feature = QgsFeature() |
||
) | const |
Returns the approximate bounding box of the marker symbol, which includes the bounding box of all symbol layers for the symbol.
It is recommended to use this method only between startRender() and stopRender() calls, or data defined rotation and offset will not be correctly calculated.
point | location of rendered point in painter units |
context | render context |
feature | feature being rendered at point (optional). If not specified, the bounds calculation will not include data defined parameters such as offset and rotation |
Definition at line 1517 of file qgssymbol.cpp.
|
overridevirtual |
Get a deep copy of this symbol.
Needs to be reimplemented by subclasses. Ownership is transferred to the caller.
Implements QgsSymbol.
Definition at line 1536 of file qgssymbol.cpp.
|
static |
Create a marker symbol with one symbol layer: SimpleMarker with specified properties.
This is a convenience method for easier creation of marker symbols.
Definition at line 1092 of file qgssymbol.cpp.
QgsProperty QgsMarkerSymbol::dataDefinedAngle | ( | ) | const |
Returns data defined angle for whole symbol (including all symbol layers).
Definition at line 1197 of file qgssymbol.cpp.
QgsProperty QgsMarkerSymbol::dataDefinedSize | ( | ) | const |
Returns data defined size for whole symbol (including all symbol layers).
Definition at line 1379 of file qgssymbol.cpp.
void QgsMarkerSymbol::renderPoint | ( | QPointF | point, |
const QgsFeature * | f, | ||
QgsRenderContext & | context, | ||
int | layer = -1 , |
||
bool | selected = false |
||
) |
Definition at line 1480 of file qgssymbol.cpp.
QgsSymbol::ScaleMethod QgsMarkerSymbol::scaleMethod | ( | ) |
Definition at line 1445 of file qgssymbol.cpp.
void QgsMarkerSymbol::setAngle | ( | double | symbolAngle | ) |
Sets the angle for the whole symbol.
Individual symbol layer sizes will be rotated to maintain their current relative angle to the whole symbol angle.
symbolAngle | new symbol angle |
Definition at line 1134 of file qgssymbol.cpp.
void QgsMarkerSymbol::setDataDefinedAngle | ( | const QgsProperty & | property | ) |
Set data defined angle for whole symbol (including all symbol layers).
Definition at line 1169 of file qgssymbol.cpp.
void QgsMarkerSymbol::setDataDefinedSize | ( | const QgsProperty & | property | ) |
Set data defined size for whole symbol (including all symbol layers).
Definition at line 1343 of file qgssymbol.cpp.
void QgsMarkerSymbol::setLineAngle | ( | double | lineAngle | ) |
Sets the line angle modification for the symbol's angle.
This angle is added to the marker's rotation and data defined rotation before rendering the symbol, and is usually used for orienting symbols to match a line's angle.
lineAngle | Angle in degrees, valid values are between 0 and 360 |
Definition at line 1158 of file qgssymbol.cpp.
void QgsMarkerSymbol::setScaleMethod | ( | QgsSymbol::ScaleMethod | scaleMethod | ) |
Definition at line 1434 of file qgssymbol.cpp.
void QgsMarkerSymbol::setSize | ( | double | size | ) |
Sets the size for the whole symbol.
Individual symbol layer sizes will be scaled to maintain their current relative size to the whole symbol size.
size | new symbol size |
Definition at line 1243 of file qgssymbol.cpp.
void QgsMarkerSymbol::setSizeMapUnitScale | ( | const QgsMapUnitScale & | scale | ) |
Sets the size map unit scale for the whole symbol (including all symbol layers).
scale | map unit scale |
Definition at line 1318 of file qgssymbol.cpp.
void QgsMarkerSymbol::setSizeUnit | ( | QgsUnitTypes::RenderUnit | unit | ) |
Sets the size units for the whole symbol (including all symbol layers).
unit | size units |
Definition at line 1282 of file qgssymbol.cpp.
double QgsMarkerSymbol::size | ( | ) | const |
Returns the size for the whole symbol, which is the maximum size of all marker symbol layers in the symbol.
Definition at line 1266 of file qgssymbol.cpp.
QgsMapUnitScale QgsMarkerSymbol::sizeMapUnitScale | ( | ) | const |
Returns the size map unit scale for the whole symbol.
Note that for symbols with multiple symbol layers, this will correspond just to the map unit scale for the first symbol layer.
Definition at line 1330 of file qgssymbol.cpp.
QgsUnitTypes::RenderUnit QgsMarkerSymbol::sizeUnit | ( | ) | const |
Returns the size units for the whole symbol (including all symbol layers).
Definition at line 1294 of file qgssymbol.cpp.