QGIS API Documentation
3.10.0-A Coruña (6c816b4204)
|
Abstract base class for simple marker symbol layers. More...
#include <qgsmarkersymbollayer.h>
Public Member Functions | |
QgsSimpleMarkerSymbolLayerBase (QgsSimpleMarkerSymbolLayerBase::Shape shape=Circle, double size=DEFAULT_SIMPLEMARKER_SIZE, double angle=DEFAULT_SIMPLEMARKER_ANGLE, QgsSymbol::ScaleMethod scaleMethod=DEFAULT_SCALE_METHOD) | |
Constructor for QgsSimpleMarkerSymbolLayerBase. More... | |
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... | |
void | renderPoint (QPointF point, QgsSymbolRenderContext &context) override |
Renders a marker at the specified point. More... | |
void | setShape (QgsSimpleMarkerSymbolLayerBase::Shape shape) |
Sets the rendered marker shape. More... | |
QgsSimpleMarkerSymbolLayerBase::Shape | shape () const |
Returns the shape for the rendered marker symbol. More... | |
void | startRender (QgsSymbolRenderContext &context) override |
void | stopRender (QgsSymbolRenderContext &context) override |
Public Member Functions inherited from QgsMarkerSymbolLayer | |
QgsMarkerSymbolLayer (const QgsMarkerSymbolLayer &other)=delete | |
QgsMarkerSymbolLayer cannot be copied. More... | |
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... | |
QgsMarkerSymbolLayer & | operator= (const QgsMarkerSymbolLayer &other)=delete |
QgsMarkerSymbolLayer cannot be copied. 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... | |
virtual 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... | |
virtual void | writeSldMarker (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const |
Writes the symbol layer definition as a SLD XML element. More... | |
Public Member Functions inherited from QgsSymbolLayer | |
QgsSymbolLayer (const QgsSymbolLayer &other)=delete | |
QgsSymbolLayer cannot be copied. More... | |
virtual | ~QgsSymbolLayer () |
virtual QgsSymbolLayer * | clone () const =0 |
Shall be reimplemented by subclasses to create a deep copy of the instance. More... | |
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 | layerType () const =0 |
Returns a string that represents this layer type. More... | |
virtual QString | ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const |
QgsSymbolLayer & | operator= (const QgsSymbolLayer &other)=delete |
QgsSymbolLayer cannot be copied. More... | |
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... | |
virtual QgsStringMap | properties () const =0 |
Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. More... | |
int | renderingPass () const |
Specifies the rendering pass in which this symbol layer should be rendered. More... | |
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) |
Specifies the rendering pass in which this symbol layer should be rendered. More... | |
virtual void | setStrokeColor (const QColor &color) |
Set stroke color. More... | |
virtual bool | setSubSymbol (QgsSymbol *symbol) |
Sets layer's subsymbol. takes ownership of the passed symbol. More... | |
virtual QColor | strokeColor () const |
Gets stroke color. 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 QList< QgsSimpleMarkerSymbolLayerBase::Shape > | availableShapes () |
Returns a list of all available shape types. More... | |
static QgsSimpleMarkerSymbolLayerBase::Shape | decodeShape (const QString &name, bool *ok=nullptr) |
Attempts to decode a string representation of a shape name to the corresponding shape. More... | |
static QString | encodeShape (QgsSimpleMarkerSymbolLayerBase::Shape shape) |
Encodes a shape to its string representation. More... | |
static bool | shapeIsFilled (QgsSimpleMarkerSymbolLayerBase::Shape shape) |
Returns true if a symbol shape has a fill. More... | |
Static Public Member Functions inherited from QgsSymbolLayer | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. More... | |
Protected Member Functions | |
void | calculateOffsetAndRotation (QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedRotation, QPointF &offset, double &angle) const |
Calculates the marker offset and rotation. More... | |
double | calculateSize (QgsSymbolRenderContext &context, bool &hasDataDefinedSize) const |
Calculates the desired size of the marker, considering data defined size overrides. More... | |
bool | prepareMarkerPath (Shape symbol) |
Prepares the layer for drawing the specified shape (QPainterPath version) More... | |
bool | prepareMarkerShape (Shape shape) |
Prepares the layer for drawing the specified shape (QPolygonF version) More... | |
bool | shapeToPolygon (Shape shape, QPolygonF &polygon) const |
Creates a polygon representing the specified shape. 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... | |
Protected Attributes | |
QPainterPath | mPath |
Painter path representing shape. If mPolygon is empty then the shape is stored in mPath. More... | |
QPolygonF | mPolygon |
Polygon of points in shape. If polygon is empty then shape is using mPath. More... | |
Shape | mShape |
Symbol shape. More... | |
Protected Attributes inherited from QgsMarkerSymbolLayer | |
double | mAngle = 0 |
Marker rotation angle, in degrees clockwise from north. More... | |
HorizontalAnchorPoint | mHorizontalAnchorPoint = HCenter |
Horizontal anchor point. More... | |
double | mLineAngle = 0 |
Line rotation angle (see setLineAngle() for details) More... | |
QPointF | mOffset |
Marker offset. More... | |
QgsMapUnitScale | mOffsetMapUnitScale |
Offset map unit scale. More... | |
QgsUnitTypes::RenderUnit | mOffsetUnit = QgsUnitTypes::RenderMillimeters |
Offset units. More... | |
QgsSymbol::ScaleMethod | mScaleMethod = QgsSymbol::ScaleDiameter |
Marker size scaling method. More... | |
double | mSize = 2.0 |
Marker size. More... | |
QgsMapUnitScale | mSizeMapUnitScale |
Marker size map unit scale. More... | |
QgsUnitTypes::RenderUnit | mSizeUnit = QgsUnitTypes::RenderMillimeters |
Marker size unit. More... | |
VerticalAnchorPoint | mVerticalAnchorPoint = VCenter |
Vertical anchor point. More... | |
Protected Attributes inherited from QgsSymbolLayer | |
QColor | mColor |
QgsPropertyCollection | mDataDefinedProperties |
bool | mEnabled = true |
True if layer is enabled and should be drawn. More... | |
QgsFields | mFields |
bool | mLocked = false |
std::unique_ptr< QgsPaintEffect > | mPaintEffect |
int | mRenderingPass = 0 |
QgsSymbol::SymbolType | mType |
Additional Inherited Members | |
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... | |
Abstract base class for simple marker symbol layers.
Handles creation of the symbol shapes but leaves the actual drawing of the symbols to subclasses.
Definition at line 43 of file qgsmarkersymbollayer.h.
Marker symbol shapes.
Definition at line 48 of file qgsmarkersymbollayer.h.
QgsSimpleMarkerSymbolLayerBase::QgsSimpleMarkerSymbolLayerBase | ( | QgsSimpleMarkerSymbolLayerBase::Shape | shape = Circle , |
double | size = DEFAULT_SIMPLEMARKER_SIZE , |
||
double | angle = DEFAULT_SIMPLEMARKER_ANGLE , |
||
QgsSymbol::ScaleMethod | scaleMethod = DEFAULT_SCALE_METHOD |
||
) |
Constructor for QgsSimpleMarkerSymbolLayerBase.
shape | symbol shape for markers |
size | symbol size (in mm) |
angle | symbol rotation angle |
scaleMethod | scaling method for data defined scaling |
Definition at line 88 of file qgsmarkersymbollayer.cpp.
|
static |
Returns a list of all available shape types.
Definition at line 59 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.
Reimplemented in QgsSimpleMarkerSymbolLayer.
Definition at line 252 of file qgsmarkersymbollayer.cpp.
|
protected |
Calculates the marker offset and rotation.
context | symbol render context |
scaledSize | size of symbol to render |
hasDataDefinedRotation | will be set to true if marker has data defined rotation |
offset | will be set to calculated marker offset (in painter units) |
angle | will be set to calculated marker angle |
Definition at line 640 of file qgsmarkersymbollayer.cpp.
|
protected |
Calculates the desired size of the marker, considering data defined size overrides.
context | symbol render context |
hasDataDefinedSize | will be set to true if marker uses data defined sizes |
Definition at line 612 of file qgsmarkersymbollayer.cpp.
|
static |
Attempts to decode a string representation of a shape name to the corresponding shape.
name | encoded shape name |
ok | if specified, will be set to true if shape was successfully decoded |
Definition at line 278 of file qgsmarkersymbollayer.cpp.
|
static |
Encodes a shape to its string representation.
shape | shape to encode |
Definition at line 336 of file qgsmarkersymbollayer.cpp.
|
protected |
Prepares the layer for drawing the specified shape (QPainterPath version)
Definition at line 541 of file qgsmarkersymbollayer.cpp.
|
protected |
Prepares the layer for drawing the specified shape (QPolygonF version)
Definition at line 390 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.
Reimplemented in QgsSimpleMarkerSymbolLayer.
Definition at line 174 of file qgsmarkersymbollayer.cpp.
|
inline |
Sets the rendered marker shape.
shape | new marker shape |
Definition at line 108 of file qgsmarkersymbollayer.h.
|
inline |
Returns the shape for the rendered marker symbol.
Definition at line 101 of file qgsmarkersymbollayer.h.
|
static |
Returns true
if a symbol shape has a fill.
shape | shape to test |
true
if shape uses a fill, or false
if shape uses lines only Definition at line 99 of file qgsmarkersymbollayer.cpp.
|
protected |
Creates a polygon representing the specified shape.
shape | shape to create |
polygon | destination polygon for shape |
true
if shape was successfully stored in polygon Definition at line 395 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Reimplemented in QgsFilledMarkerSymbolLayer, and QgsSimpleMarkerSymbolLayer.
Definition at line 133 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Reimplemented in QgsFilledMarkerSymbolLayer.
Definition at line 169 of file qgsmarkersymbollayer.cpp.
|
protected |
Painter path representing shape. If mPolygon is empty then the shape is stored in mPath.
Definition at line 175 of file qgsmarkersymbollayer.h.
|
protected |
Polygon of points in shape. If polygon is empty then shape is using mPath.
Definition at line 172 of file qgsmarkersymbollayer.h.
|
protected |
Symbol shape.
Definition at line 178 of file qgsmarkersymbollayer.h.