QGIS API Documentation
3.18.1-Zürich (202f1bf7e5)
|
A symbol layer for rendering objects with major and minor axis (e.g. More...
#include <qgsellipsesymbollayer.h>
Public Member Functions | |
QgsEllipseSymbolLayer () | |
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... | |
QgsEllipseSymbolLayer * | clone () const override |
Shall be reimplemented by subclasses to create a deep copy of the instance. More... | |
QColor | fillColor () const override |
Gets fill color. More... | |
QString | layerType () const override |
Returns a string that represents this layer type. More... | |
QgsMapUnitScale | mapUnitScale () const override |
QgsUnitTypes::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. More... | |
Qt::PenJoinStyle | penJoinStyle () const |
Gets stroke join style. More... | |
QVariantMap | 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 | setFillColor (const QColor &c) override |
Set fill color. More... | |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setOutputUnit (QgsUnitTypes::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. More... | |
void | setPenJoinStyle (Qt::PenJoinStyle style) |
Set stroke join style. More... | |
void | setSize (double size) override |
Sets the symbol size. More... | |
void | setStrokeColor (const QColor &c) override |
Set stroke color. More... | |
void | setStrokeStyle (Qt::PenStyle strokeStyle) |
void | setStrokeWidth (double w) |
void | setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale) |
void | setStrokeWidthUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the symbol's stroke width. More... | |
void | setSymbolHeight (double h) |
void | setSymbolHeightMapUnitScale (const QgsMapUnitScale &scale) |
void | setSymbolHeightUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the symbol's height. More... | |
void | setSymbolName (const QString &name) |
void | setSymbolWidth (double w) |
void | setSymbolWidthMapUnitScale (const QgsMapUnitScale &scale) |
void | setSymbolWidthUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the symbol's width. More... | |
void | startRender (QgsSymbolRenderContext &context) override |
Called before a set of rendering operations commences on the supplied render context. More... | |
void | stopRender (QgsSymbolRenderContext &context) override |
Called after a set of rendering operations has finished on the supplied render context. More... | |
QColor | strokeColor () const override |
Gets stroke color. More... | |
Qt::PenStyle | strokeStyle () const |
double | strokeWidth () const |
const QgsMapUnitScale & | strokeWidthMapUnitScale () const |
QgsUnitTypes::RenderUnit | strokeWidthUnit () const |
Returns the units for the symbol's stroke width. More... | |
double | symbolHeight () const |
const QgsMapUnitScale & | symbolHeightMapUnitScale () const |
QgsUnitTypes::RenderUnit | symbolHeightUnit () const |
Returns the units for the symbol's height. More... | |
QString | symbolName () const |
double | symbolWidth () const |
const QgsMapUnitScale & | symbolWidthMapUnitScale () const |
QgsUnitTypes::RenderUnit | symbolWidthUnit () const |
Returns the units for the symbol's width. More... | |
void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override |
Saves the symbol layer as SLD. More... | |
bool | usesMapUnits () const override |
Returns true if the symbol layer has any components which use map unit based sizes. More... | |
bool | writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const override |
write as DXF More... | |
void | writeSldMarker (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override |
Writes the symbol layer definition as a SLD XML element. More... | |
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... | |
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 |
Called before a set of rendering operations commences on the supplied render context. More... | |
void | stopRender (QgsSymbolRenderContext &context) override |
Called after a set of rendering operations has finished on the supplied render context. More... | |
void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override |
Saves the symbol layer as SLD. More... | |
VerticalAnchorPoint | verticalAnchorPoint () const |
Returns the vertical anchor point for positioning the symbol. More... | |
Public Member Functions inherited from QgsSymbolLayer | |
QgsSymbolLayer (const QgsSymbolLayer &other)=delete | |
QgsSymbolLayer cannot be copied. More... | |
virtual | ~QgsSymbolLayer () |
virtual bool | canCauseArtifactsBetweenAdjacentTiles () const |
Returns true if the symbol layer rendering can cause visible artifacts across a single feature when the feature is rendered as a series of adjacent map tiles each containing a portion of the feature's geometry. 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 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 QgsSymbolLayerReferenceList | masks () const |
Returns masks defined by this symbol layer. 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... | |
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... | |
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 bool | setSubSymbol (QgsSymbol *symbol) |
Sets layer's subsymbol. takes ownership of the passed symbol. More... | |
virtual void | startFeatureRender (const QgsFeature &feature, QgsRenderContext &context) |
Called before the layer will be rendered for a particular feature. More... | |
virtual void | stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context) |
Called after the layer has been rendered for a particular feature. 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... | |
Static Public Member Functions | |
static QgsSymbolLayer * | create (const QVariantMap &properties=QVariantMap()) |
Creates the symbol layer. More... | |
static QgsSymbolLayer * | createFromSld (QDomElement &element) |
Static Public Member Functions inherited from QgsSymbolLayer | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. More... | |
A symbol layer for rendering objects with major and minor axis (e.g.
ellipse, rectangle, etc).
Definition at line 31 of file qgsellipsesymbollayer.h.
QgsEllipseSymbolLayer::QgsEllipseSymbolLayer | ( | ) |
Definition at line 31 of file qgsellipsesymbollayer.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 695 of file qgsellipsesymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 344 of file qgsellipsesymbollayer.cpp.
|
static |
Creates the symbol layer.
Definition at line 46 of file qgsellipsesymbollayer.cpp.
|
static |
Definition at line 444 of file qgsellipsesymbollayer.cpp.
|
inlineoverridevirtual |
Gets fill color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 82 of file qgsellipsesymbollayer.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 309 of file qgsellipsesymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 684 of file qgsellipsesymbollayer.cpp.
|
overridevirtual |
Returns the units to use for sizes and widths within the symbol layer.
Individual symbol layer subclasses will interpret this in different ways, e.g., a marker symbol layer may use it to specify the units for the marker size, while a line symbol layer may use it to specify the units for the line width.
Reimplemented from QgsSymbolLayer.
Definition at line 658 of file qgsellipsesymbollayer.cpp.
|
inline |
|
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 500 of file qgsellipsesymbollayer.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 169 of file qgsellipsesymbollayer.cpp.
|
inlineoverridevirtual |
Set fill color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 81 of file qgsellipsesymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 676 of file qgsellipsesymbollayer.cpp.
|
overridevirtual |
Sets the units to use for sizes and widths within the symbol layer.
Individual symbol layer subclasses will interpret this in different ways, e.g., a marker symbol layer may use it to specify the units for the marker size, while a line symbol layer may use it to specify the units for the line width.
unit | output units |
Reimplemented from QgsSymbolLayer.
Definition at line 650 of file qgsellipsesymbollayer.cpp.
|
inline |
|
overridevirtual |
Sets the symbol size.
size | symbol size. Units are specified by sizeUnit(). |
Reimplemented from QgsMarkerSymbolLayer.
Definition at line 623 of file qgsellipsesymbollayer.cpp.
|
inlineoverridevirtual |
Set stroke color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 84 of file qgsellipsesymbollayer.h.
|
inline |
Definition at line 64 of file qgsellipsesymbollayer.h.
|
inline |
Definition at line 78 of file qgsellipsesymbollayer.h.
|
inline |
Definition at line 136 of file qgsellipsesymbollayer.h.
|
inline |
Sets the units for the symbol's stroke width.
unit | symbol units |
Definition at line 128 of file qgsellipsesymbollayer.h.
void QgsEllipseSymbolLayer::setSymbolHeight | ( | double | h | ) |
Definition at line 644 of file qgsellipsesymbollayer.cpp.
|
inline |
Definition at line 120 of file qgsellipsesymbollayer.h.
|
inline |
Sets the units for the symbol's height.
unit | symbol units |
Definition at line 111 of file qgsellipsesymbollayer.h.
|
inline |
Definition at line 52 of file qgsellipsesymbollayer.h.
void QgsEllipseSymbolLayer::setSymbolWidth | ( | double | w | ) |
Definition at line 638 of file qgsellipsesymbollayer.cpp.
|
inline |
Definition at line 102 of file qgsellipsesymbollayer.h.
|
inline |
Sets the units for the symbol's width.
unit | symbol units |
Definition at line 93 of file qgsellipsesymbollayer.h.
|
overridevirtual |
Called before a set of rendering operations commences on the supplied render context.
This is always followed by a call to stopRender() after all rendering operations have been completed.
Subclasses can use this method to prepare for a set of rendering operations, e.g. by pre-evaluating paths or images to render, and performing other one-time optimisations.
Implements QgsSymbolLayer.
Definition at line 314 of file qgsellipsesymbollayer.cpp.
|
overridevirtual |
Called after a set of rendering operations has finished on the supplied render context.
This is always preceded by a call to startRender() before all rendering operations are commenced.
Subclasses can use this method to cleanup after a set of rendering operations.
Implements QgsSymbolLayer.
Definition at line 340 of file qgsellipsesymbollayer.cpp.
|
inlineoverridevirtual |
Gets stroke color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 85 of file qgsellipsesymbollayer.h.
|
inline |
Definition at line 63 of file qgsellipsesymbollayer.h.
|
inline |
Definition at line 79 of file qgsellipsesymbollayer.h.
|
inline |
Definition at line 137 of file qgsellipsesymbollayer.h.
|
inline |
Returns the units for the symbol's stroke width.
Definition at line 134 of file qgsellipsesymbollayer.h.
|
inline |
Definition at line 61 of file qgsellipsesymbollayer.h.
|
inline |
Definition at line 121 of file qgsellipsesymbollayer.h.
|
inline |
Returns the units for the symbol's height.
Definition at line 118 of file qgsellipsesymbollayer.h.
|
inline |
Definition at line 53 of file qgsellipsesymbollayer.h.
|
inline |
Definition at line 58 of file qgsellipsesymbollayer.h.
|
inline |
Definition at line 103 of file qgsellipsesymbollayer.h.
|
inline |
Returns the units for the symbol's width.
Definition at line 100 of file qgsellipsesymbollayer.h.
|
overridevirtual |
Saves the symbol layer as SLD.
Reimplemented from QgsSymbolLayer.
Definition at line 374 of file qgsellipsesymbollayer.cpp.
|
overridevirtual |
Returns true
if the symbol layer has any components which use map unit based sizes.
Reimplemented from QgsSymbolLayer.
Definition at line 668 of file qgsellipsesymbollayer.cpp.
|
overridevirtual |
write as DXF
Reimplemented from QgsSymbolLayer.
Definition at line 757 of file qgsellipsesymbollayer.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 QgsMarkerSymbolLayer.
Definition at line 387 of file qgsellipsesymbollayer.cpp.