QGIS API Documentation
3.6.0-Noosa (5873452)
|
#include <qgsmarkersymbollayer.h>
Public Member Functions | |
QgsFontMarkerSymbolLayer (const QString &fontFamily=DEFAULT_FONTMARKER_FONT, QChar chr=DEFAULT_FONTMARKER_CHR, double pointSize=DEFAULT_FONTMARKER_SIZE, const QColor &color=DEFAULT_FONTMARKER_COLOR, double angle=DEFAULT_FONTMARKER_ANGLE) | |
~QgsFontMarkerSymbolLayer () override | |
QRectF | bounds (QPointF point, QgsSymbolRenderContext &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... | |
QChar | character () const |
Returns the character used when rendering points. More... | |
QgsFontMarkerSymbolLayer * | clone () const override |
Shall be reimplemented by subclasses to create a deep copy of the instance. More... | |
QString | fontFamily () const |
Returns the font family name for the associated font which will be used to render the point. More... | |
QString | layerType () const override |
Returns a string that represents this layer type. More... | |
Qt::PenJoinStyle | penJoinStyle () const |
Returns the stroke join style. More... | |
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, QgsSymbolRenderContext &context) override |
Renders a marker at the specified point. More... | |
void | setCharacter (QChar ch) |
Sets the character used when rendering points. More... | |
void | setFontFamily (const QString &family) |
Sets the font family for the font which will be used to render the point. More... | |
void | setPenJoinStyle (Qt::PenJoinStyle style) |
Sets the stroke join style. More... | |
void | setStrokeColor (const QColor &color) override |
Set stroke color. More... | |
void | setStrokeWidth (double width) |
Set's the marker's stroke width. More... | |
void | setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale) |
Sets the stroke width map unit scale. More... | |
void | setStrokeWidthUnit (QgsUnitTypes::RenderUnit unit) |
Sets the stroke width unit. More... | |
void | startRender (QgsSymbolRenderContext &context) override |
void | stopRender (QgsSymbolRenderContext &context) override |
QColor | strokeColor () const override |
Gets stroke color. More... | |
double | strokeWidth () const |
Returns the marker's stroke width. More... | |
const QgsMapUnitScale & | strokeWidthMapUnitScale () const |
Returns the stroke width map unit scale. More... | |
QgsUnitTypes::RenderUnit | strokeWidthUnit () const |
Returns the stroke width unit. 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 QgsMarkerSymbolLayer | |
double | angle () const |
Returns the rotation angle for the marker, in degrees clockwise from north. More... | |
void | drawPreviewIcon (QgsSymbolRenderContext &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... | |
QgsUnitTypes::RenderUnit | offsetUnit () const |
Returns the units for the symbol's offset. More... | |
QgsUnitTypes::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. More... | |
QgsSymbol::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 (QgsUnitTypes::RenderUnit unit) |
Sets the units for the symbol's offset. More... | |
void | setOutputUnit (QgsUnitTypes::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. More... | |
void | setScaleMethod (QgsSymbol::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 (QgsUnitTypes::RenderUnit 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... | |
QgsUnitTypes::RenderUnit | sizeUnit () const |
Returns the units for the symbol's size. More... | |
void | startRender (QgsSymbolRenderContext &context) override |
void | stopRender (QgsSymbolRenderContext &context) override |
void | toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override |
VerticalAnchorPoint | verticalAnchorPoint () const |
Returns the vertical anchor point for positioning the symbol. More... | |
Public Member Functions inherited from QgsSymbolLayer | |
virtual | ~QgsSymbolLayer () |
virtual QColor | color () const |
The fill color. More... | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the symbol layer's property collection, used for data defined overrides. More... | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the symbol layer's property collection, used for data defined overrides. More... | |
virtual double | dxfAngle (QgsSymbolRenderContext &context) const |
Gets angle. More... | |
virtual QColor | dxfBrushColor (QgsSymbolRenderContext &context) const |
Gets brush/fill color. More... | |
virtual Qt::BrushStyle | dxfBrushStyle () const |
Gets brush/fill style. More... | |
virtual QColor | dxfColor (QgsSymbolRenderContext &context) const |
Gets color. More... | |
virtual QVector< qreal > | dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const |
Gets dash pattern. More... | |
virtual double | dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
Gets offset. More... | |
virtual Qt::PenStyle | dxfPenStyle () const |
Gets pen style. More... | |
virtual double | dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
Gets line width. More... | |
bool | enabled () const |
Returns true if symbol layer is enabled and will be drawn. More... | |
virtual double | estimateMaxBleed (const QgsRenderContext &context) const |
Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context. More... | |
virtual QColor | fillColor () const |
Gets fill color. More... | |
virtual bool | hasDataDefinedProperties () const |
Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. More... | |
virtual bool | isCompatibleWithSymbol (QgsSymbol *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 | prepareExpressions (const QgsSymbolRenderContext &context) |
Prepares all data defined property expressions for evaluation. More... | |
int | renderingPass () const |
virtual void | setColor (const QColor &color) |
The fill color. More... | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the symbol layer's property collection, used for data defined overrides. More... | |
virtual void | setDataDefinedProperty (Property key, const QgsProperty &property) |
Sets a data defined property for the layer. More... | |
void | setEnabled (bool enabled) |
Sets whether symbol layer is enabled and should be drawn. More... | |
virtual void | setFillColor (const QColor &color) |
Set fill color. 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 (QgsSymbol *symbol) |
Sets layer's subsymbol. takes ownership of the passed symbol. More... | |
virtual QgsSymbol * | subSymbol () |
Returns the symbol's sub symbol, if present. More... | |
QgsSymbol::SymbolType | type () const |
virtual QSet< QString > | usedAttributes (const QgsRenderContext &context) const |
Returns the set of attributes referenced by the layer. More... | |
virtual bool | writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const |
write as DXF More... | |
Static Public Member Functions | |
static QgsSymbolLayer * | create (const QgsStringMap &properties=QgsStringMap()) |
Creates a new QgsFontMarkerSymbolLayer from a property map (see properties()) More... | |
static QgsSymbolLayer * | createFromSld (QDomElement &element) |
Creates a new QgsFontMarkerSymbolLayer from an SLD XML element. More... | |
Static Public Member Functions inherited from QgsSymbolLayer | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. More... | |
Additional Inherited Members | |
Public Types inherited from QgsMarkerSymbolLayer | |
enum | HorizontalAnchorPoint { Left, HCenter, Right } |
Symbol horizontal anchor points. More... | |
enum | VerticalAnchorPoint { Top, VCenter, Bottom } |
Symbol vertical anchor points. More... | |
Public Types inherited from QgsSymbolLayer | |
enum | Property { PropertySize = 0, PropertyAngle, PropertyName, PropertyFillColor, PropertyStrokeColor, PropertyStrokeWidth, PropertyStrokeStyle, PropertyOffset, PropertyCharacter, PropertyWidth, PropertyHeight, PropertyPreserveAspectRatio, PropertyFillStyle, PropertyJoinStyle, PropertySecondaryColor, PropertyLineAngle, PropertyLineDistance, PropertyGradientType, PropertyCoordinateMode, PropertyGradientSpread, PropertyGradientReference1X, PropertyGradientReference1Y, PropertyGradientReference2X, PropertyGradientReference2Y, PropertyGradientReference1IsCentroid, PropertyGradientReference2IsCentroid, PropertyBlurRadius, PropertyShapeburstUseWholeShape, PropertyShapeburstMaxDistance, PropertyShapeburstIgnoreRings, PropertyFile, PropertyDistanceX, PropertyDistanceY, PropertyDisplacementX, PropertyDisplacementY, PropertyOpacity, PropertyCustomDash, PropertyCapStyle, PropertyPlacement, PropertyInterval, PropertyOffsetAlongLine, PropertyHorizontalAnchor, PropertyVerticalAnchor, PropertyLayerEnabled, PropertyArrowWidth, PropertyArrowStartWidth, PropertyArrowHeadLength, PropertyArrowHeadThickness, PropertyArrowHeadType, PropertyArrowType } |
Data definable properties. More... | |
Protected Member Functions inherited from QgsMarkerSymbolLayer | |
QgsMarkerSymbolLayer (bool locked=false) | |
Constructor for QgsMarkerSymbolLayer. More... | |
void | markerOffset (QgsSymbolRenderContext &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 (QgsSymbolRenderContext &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 (QgsSymbolRenderContext &context, double width, double height, QgsUnitTypes::RenderUnit widthUnit, QgsUnitTypes::RenderUnit heightUnit, double &offsetX, double &offsetY, const QgsMapUnitScale &widthMapUnitScale, const QgsMapUnitScale &heightMapUnitScale) const |
Protected Member Functions inherited from QgsSymbolLayer | |
QgsSymbolLayer (QgsSymbol::SymbolType type, bool locked=false) | |
void | copyDataDefinedProperties (QgsSymbolLayer *destLayer) const |
Copies all data defined properties of this layer to another symbol layer. More... | |
void | copyPaintEffect (QgsSymbolLayer *destLayer) const |
Copies paint effect of this layer to another symbol layer. More... | |
void | restoreOldDataDefinedProperties (const QgsStringMap &stringMap) |
Restores older data defined properties from string map. More... | |
Static Protected Member Functions inherited from QgsMarkerSymbolLayer | |
static QPointF | _rotatedOffset (QPointF offset, double angle) |
Adjusts a marker offset to account for rotation. More... | |
Static Protected Attributes inherited from QgsSymbolLayer | |
static const bool | SELECT_FILL_BORDER = false |
Whether fill styles for selected features also highlight symbol stroke. More... | |
static const bool | SELECT_FILL_STYLE = false |
Whether fill styles for selected features uses symbol layer style. More... | |
static const bool | SELECTION_IS_OPAQUE = true |
Whether styles for selected features ignore symbol alpha. More... | |
Definition at line 800 of file qgsmarkersymbollayer.h.
QgsFontMarkerSymbolLayer::QgsFontMarkerSymbolLayer | ( | const QString & | fontFamily = DEFAULT_FONTMARKER_FONT , |
QChar | chr = DEFAULT_FONTMARKER_CHR , |
||
double | pointSize = DEFAULT_FONTMARKER_SIZE , |
||
const QColor & | color = DEFAULT_FONTMARKER_COLOR , |
||
double | angle = DEFAULT_FONTMARKER_ANGLE |
||
) |
Definition at line 2926 of file qgsmarkersymbollayer.cpp.
|
override |
Definition at line 2943 of file qgsmarkersymbollayer.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.
Implements QgsMarkerSymbolLayer.
Definition at line 3282 of file qgsmarkersymbollayer.cpp.
|
inline |
Returns the character used when rendering points.
Definition at line 860 of file qgsmarkersymbollayer.h.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 3232 of file qgsmarkersymbollayer.cpp.
|
static |
Creates a new QgsFontMarkerSymbolLayer from a property map (see properties())
Definition at line 2948 of file qgsmarkersymbollayer.cpp.
|
static |
Creates a new QgsFontMarkerSymbolLayer from an SLD XML element.
Definition at line 3319 of file qgsmarkersymbollayer.cpp.
|
inline |
Returns the font family name for the associated font which will be used to render the point.
Definition at line 846 of file qgsmarkersymbollayer.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 QgsSymbolLayer.
Definition at line 2999 of file qgsmarkersymbollayer.cpp.
|
inline |
Returns the stroke join style.
Definition at line 944 of file qgsmarkersymbollayer.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 QgsSymbolLayer.
Definition at line 3209 of file qgsmarkersymbollayer.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 QgsMarkerSymbolLayer.
Definition at line 3120 of file qgsmarkersymbollayer.cpp.
|
inline |
Sets the character used when rendering points.
Definition at line 867 of file qgsmarkersymbollayer.h.
|
inline |
Sets the font family for the font which will be used to render the point.
Definition at line 853 of file qgsmarkersymbollayer.h.
|
inline |
Sets the stroke join style.
Definition at line 953 of file qgsmarkersymbollayer.h.
|
inlineoverridevirtual |
Set stroke color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 870 of file qgsmarkersymbollayer.h.
|
inline |
Set's the marker's stroke width.
Units are set by setStrokeWidthUnit().
Definition at line 892 of file qgsmarkersymbollayer.h.
|
inline |
Sets the stroke width map unit scale.
Definition at line 935 of file qgsmarkersymbollayer.h.
|
inline |
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 3004 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 3026 of file qgsmarkersymbollayer.cpp.
|
inlineoverridevirtual |
Gets stroke color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 869 of file qgsmarkersymbollayer.h.
|
inline |
Returns the marker's stroke width.
Units are retrieved by strokeWidthUnit()
Definition at line 881 of file qgsmarkersymbollayer.h.
|
inline |
Returns the stroke width map unit scale.
Definition at line 924 of file qgsmarkersymbollayer.h.
|
inline |
Returns the stroke width unit.
Definition at line 903 of file qgsmarkersymbollayer.h.
|
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 QgsMarkerSymbolLayer.
Definition at line 3252 of file qgsmarkersymbollayer.cpp.
|
protected |
Definition at line 961 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 964 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 963 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 965 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 959 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 960 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 966 of file qgsmarkersymbollayer.h.