QGIS API Documentation
3.10.0-A Coruña (6c816b4204)
|
#include <qgsfillsymbollayer.h>
Public Member Functions | |
QgsSimpleFillSymbolLayer (const QColor &color=DEFAULT_SIMPLEFILL_COLOR, Qt::BrushStyle style=DEFAULT_SIMPLEFILL_STYLE, const QColor &strokeColor=DEFAULT_SIMPLEFILL_BORDERCOLOR, Qt::PenStyle strokeStyle=DEFAULT_SIMPLEFILL_BORDERSTYLE, double strokeWidth=DEFAULT_SIMPLEFILL_BORDERWIDTH, Qt::PenJoinStyle penJoinStyle=DEFAULT_SIMPLEFILL_JOINSTYLE) | |
Qt::BrushStyle | brushStyle () const |
QgsSimpleFillSymbolLayer * | clone () const override |
Shall be reimplemented by subclasses to create a deep copy of the instance. More... | |
double | dxfAngle (QgsSymbolRenderContext &context) const override |
Gets angle. More... | |
QColor | dxfBrushColor (QgsSymbolRenderContext &context) const override |
Gets brush/fill color. More... | |
Qt::BrushStyle | dxfBrushStyle () const override |
Gets brush/fill style. More... | |
QColor | dxfColor (QgsSymbolRenderContext &context) const override |
Gets color. More... | |
Qt::PenStyle | dxfPenStyle () const override |
Gets pen style. More... | |
double | dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override |
Gets line width. More... | |
double | estimateMaxBleed (const QgsRenderContext &context) const override |
Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context. 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 |
QPointF | offset () |
const QgsMapUnitScale & | offsetMapUnitScale () const |
QgsUnitTypes::RenderUnit | offsetUnit () const |
Returns the units for the fill's offset. More... | |
QString | ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) 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 |
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 | renderPolygon (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolRenderContext &context) override |
void | setBrushStyle (Qt::BrushStyle style) |
void | setFillColor (const QColor &color) override |
Set fill color. More... | |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setOffset (QPointF offset) |
void | setOffsetMapUnitScale (const QgsMapUnitScale &scale) |
void | setOffsetUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the fill's offset. More... | |
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) |
void | setStrokeColor (const QColor &strokeColor) override |
Set stroke color. More... | |
void | setStrokeStyle (Qt::PenStyle strokeStyle) |
void | setStrokeWidth (double strokeWidth) |
void | setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale) |
void | setStrokeWidthUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the width of the fill's stroke. More... | |
void | startRender (QgsSymbolRenderContext &context) override |
void | stopRender (QgsSymbolRenderContext &context) override |
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 width of the fill's stroke. More... | |
void | toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override |
![]() | |
QgsFillSymbolLayer (const QgsFillSymbolLayer &other)=delete | |
QgsFillSymbolLayer cannot be copied. More... | |
double | angle () const |
void | drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override |
QgsFillSymbolLayer & | operator= (const QgsFillSymbolLayer &other)=delete |
QgsFillSymbolLayer cannot be copied. More... | |
void | setAngle (double angle) |
![]() | |
QgsSymbolLayer (const QgsSymbolLayer &other)=delete | |
QgsSymbolLayer cannot be copied. More... | |
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 QVector< qreal > | dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const |
Gets dash pattern. More... | |
virtual double | dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
Gets offset. More... | |
bool | enabled () const |
Returns true if symbol layer is enabled and will be drawn. 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 |
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 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()) |
static QgsSymbolLayer * | createFromSld (QDomElement &element) |
![]() | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. More... | |
Protected Attributes | |
QBrush | mBrush |
Qt::BrushStyle | mBrushStyle |
QPointF | mOffset |
QgsMapUnitScale | mOffsetMapUnitScale |
QgsUnitTypes::RenderUnit | mOffsetUnit = QgsUnitTypes::RenderMillimeters |
QPen | mPen |
Qt::PenJoinStyle | mPenJoinStyle |
QBrush | mSelBrush |
QPen | mSelPen |
QColor | mStrokeColor |
Qt::PenStyle | mStrokeStyle |
double | mStrokeWidth |
QgsMapUnitScale | mStrokeWidthMapUnitScale |
QgsUnitTypes::RenderUnit | mStrokeWidthUnit = QgsUnitTypes::RenderMillimeters |
![]() | |
double | mAngle = 0.0 |
![]() | |
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 |
Definition at line 39 of file qgsfillsymbollayer.h.
QgsSimpleFillSymbolLayer::QgsSimpleFillSymbolLayer | ( | const QColor & | color = DEFAULT_SIMPLEFILL_COLOR , |
Qt::BrushStyle | style = DEFAULT_SIMPLEFILL_STYLE , |
||
const QColor & | strokeColor = DEFAULT_SIMPLEFILL_BORDERCOLOR , |
||
Qt::PenStyle | strokeStyle = DEFAULT_SIMPLEFILL_BORDERSTYLE , |
||
double | strokeWidth = DEFAULT_SIMPLEFILL_BORDERWIDTH , |
||
Qt::PenJoinStyle | penJoinStyle = DEFAULT_SIMPLEFILL_JOINSTYLE |
||
) |
Definition at line 41 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 73 of file qgsfillsymbollayer.h.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 309 of file qgsfillsymbollayer.cpp.
|
static |
Definition at line 142 of file qgsfillsymbollayer.cpp.
|
static |
Definition at line 368 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Gets angle.
Reimplemented from QgsSymbolLayer.
Definition at line 424 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Gets brush/fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 440 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Gets brush/fill style.
Reimplemented from QgsSymbolLayer.
Definition at line 450 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Gets color.
Reimplemented from QgsSymbolLayer.
Definition at line 413 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Gets pen style.
Reimplemented from QgsSymbolLayer.
Definition at line 435 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Gets line width.
Reimplemented from QgsSymbolLayer.
Definition at line 402 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context.
For example, polygons drawn with an stroke will draw half the width of the stroke outside of the polygon. This amount is estimated, since it may be affected by data defined symbology rules.
Reimplemented from QgsSymbolLayer.
Definition at line 395 of file qgsfillsymbollayer.cpp.
|
inlineoverridevirtual |
Gets fill color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 79 of file qgsfillsymbollayer.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 229 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 74 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 92 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 124 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the fill's offset.
Definition at line 121 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 357 of file qgsfillsymbollayer.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 58 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 88 of file qgsfillsymbollayer.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 292 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Implements QgsFillSymbolLayer.
Definition at line 263 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 74 of file qgsfillsymbollayer.h.
|
inlineoverridevirtual |
Set fill color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 80 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 68 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 91 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 123 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the fill's offset.
unit | offset units |
Definition at line 115 of file qgsfillsymbollayer.h.
|
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 52 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 89 of file qgsfillsymbollayer.h.
|
inlineoverridevirtual |
Set stroke color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 77 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 83 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 86 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 107 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the width of the fill's stroke.
unit | width units |
Definition at line 99 of file qgsfillsymbollayer.h.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 234 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 258 of file qgsfillsymbollayer.cpp.
|
inlineoverridevirtual |
Gets stroke color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 76 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 82 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 85 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 108 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the width of the fill's stroke.
Definition at line 105 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 322 of file qgsfillsymbollayer.cpp.
|
protected |
Definition at line 143 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 145 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 155 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 157 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 156 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 152 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 151 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 144 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 153 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 146 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 147 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 148 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 150 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 149 of file qgsfillsymbollayer.h.