QGIS API Documentation
3.16.0-Hannover (43b64b13f3)
|
A symbol fill consisting of repeated parallel lines. More...
#include <qgsfillsymbollayer.h>
Public Member Functions | |
QgsLinePatternFillSymbolLayer () | |
~QgsLinePatternFillSymbolLayer () override | |
QgsLinePatternFillSymbolLayer * | clone () const override |
Shall be reimplemented by subclasses to create a deep copy of the instance. More... | |
QColor | color () const override |
The fill color. More... | |
double | distance () const |
Returns the distance between lines in the fill pattern. More... | |
const QgsMapUnitScale & | distanceMapUnitScale () const |
Returns the map unit scale for the pattern's line distance. More... | |
QgsUnitTypes::RenderUnit | distanceUnit () const |
Returns the units for the distance between lines in the fill pattern. 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... | |
bool | hasDataDefinedProperties () const override |
Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. More... | |
QString | layerType () const override |
Returns a string that represents this layer type. More... | |
double | lineAngle () const |
Returns the angle for the parallel lines used to fill the symbol. More... | |
double | lineWidth () const |
Returns the width of the line subsymbol used to render the parallel lines in the fill. More... | |
const QgsMapUnitScale & | lineWidthMapUnitScale () const |
Returns the map unit scale for the pattern's line width. More... | |
QgsUnitTypes::RenderUnit | lineWidthUnit () const |
Returns the units for the line's width. More... | |
QgsMapUnitScale | mapUnitScale () const override |
double | offset () const |
Returns the offset distance for lines within the fill, which is the distance to offset the parallel lines from their normal position. More... | |
const QgsMapUnitScale & | offsetMapUnitScale () const |
Returns the map unit scale for the pattern's line offset. More... | |
QgsUnitTypes::RenderUnit | offsetUnit () const |
Returns the units for the line pattern's offset. More... | |
QString | ogrFeatureStyleWidth (double widthScaleFactor) const |
QgsUnitTypes::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. 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 | setColor (const QColor &c) override |
The fill color. More... | |
void | setDistance (double d) |
Sets the distance between lines in the fill pattern. More... | |
void | setDistanceMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the pattern's line distance. More... | |
void | setDistanceUnit (QgsUnitTypes::RenderUnit unit) |
Sets the unit for the distance between lines in the fill pattern. More... | |
void | setLineAngle (double a) |
Sets the angle for the parallel lines used to fill the symbol. More... | |
void | setLineWidth (double w) |
Sets the width of the line subsymbol used to render the parallel lines in the fill. More... | |
void | setLineWidthMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the pattern's line width. More... | |
void | setLineWidthUnit (QgsUnitTypes::RenderUnit unit) |
Sets the unit for the line's width. More... | |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setOffset (double offset) |
Sets the offset distance for lines within the fill, which is the distance to offset the parallel lines from their normal position. More... | |
void | setOffsetMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the pattern's line offset. More... | |
void | setOffsetUnit (QgsUnitTypes::RenderUnit unit) |
Sets the unit for the line pattern's offset. More... | |
void | setOutputUnit (QgsUnitTypes::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. More... | |
bool | setSubSymbol (QgsSymbol *symbol) override |
Sets layer's subsymbol. takes ownership of the passed symbol. 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... | |
QgsSymbol * | subSymbol () override |
Returns the symbol's sub symbol, if present. More... | |
void | toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override |
QSet< QString > | usedAttributes (const QgsRenderContext &context) const override |
Returns the set of attributes referenced by the layer. More... | |
Public Member Functions inherited from QgsImageFillSymbolLayer | |
QgsImageFillSymbolLayer () | |
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... | |
void | renderPolygon (const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context) override |
Renders the fill symbol layer for the polygon whose outer ring is defined by points, using the given render context. More... | |
void | setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale) |
Sets the stroke width map unit scale. More... | |
void | setStrokeWidthUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units fo the symbol's stroke width. More... | |
const QgsMapUnitScale & | strokeWidthMapUnitScale () const |
Returns the stroke width map unit scale. More... | |
QgsUnitTypes::RenderUnit | strokeWidthUnit () const |
Returns the units for the symbol's stroke width. More... | |
Public Member Functions inherited from QgsFillSymbolLayer | |
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) |
Public Member Functions inherited from QgsSymbolLayer | |
QgsSymbolLayer (const QgsSymbolLayer &other)=delete | |
QgsSymbolLayer cannot be copied. More... | |
virtual | ~QgsSymbolLayer () |
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 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 QColor | fillColor () const |
Gets fill color. 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... | |
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 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 QColor | strokeColor () const |
Gets stroke color. More... | |
QgsSymbol::SymbolType | type () const |
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 QgsLinePatternFillSymbolLayer from a properties map. More... | |
static QgsSymbolLayer * | createFromSld (QDomElement &element) |
Creates a new QgsLinePatternFillSymbolLayer from a SLD element. More... | |
Static Public Member Functions inherited from QgsSymbolLayer | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. More... | |
Protected Member Functions | |
void | applyDataDefinedSettings (QgsSymbolRenderContext &context) override |
Protected Member Functions inherited from QgsImageFillSymbolLayer | |
virtual bool | applyBrushTransformFromContext () const |
Returns true if the image brush should be transformed using the render context's texture origin. More... | |
Protected Member Functions inherited from QgsFillSymbolLayer | |
QgsFillSymbolLayer (bool locked=false) | |
void | _renderPolygon (QPainter *p, const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context) |
Default method to render polygon. More... | |
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... | |
A symbol fill consisting of repeated parallel lines.
Definition at line 1291 of file qgsfillsymbollayer.h.
QgsLinePatternFillSymbolLayer::QgsLinePatternFillSymbolLayer | ( | ) |
Definition at line 2362 of file qgsfillsymbollayer.cpp.
|
override |
Definition at line 2386 of file qgsfillsymbollayer.cpp.
|
overrideprotectedvirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2985 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 2912 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 2381 of file qgsfillsymbollayer.cpp.
|
static |
Creates a new QgsLinePatternFillSymbolLayer from a properties map.
The caller takes ownership of the returned object.
Definition at line 2477 of file qgsfillsymbollayer.cpp.
|
static |
Creates a new QgsLinePatternFillSymbolLayer from a SLD element.
The caller takes ownership of the returned object.
Definition at line 3008 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the distance between lines in the fill pattern.
Units are retrieved by distanceUnit().
Definition at line 1350 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the pattern's line distance.
Definition at line 1429 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the distance between lines in the fill pattern.
Definition at line 1411 of file qgsfillsymbollayer.h.
|
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 QgsImageFillSymbolLayer.
Definition at line 2435 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns true
if the symbol layer (or any of its sub-symbols) contains data defined properties.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2426 of file qgsfillsymbollayer.cpp.
|
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 2583 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the angle for the parallel lines used to fill the symbol.
Angles are in degrees, clockwise from North.
Definition at line 1335 of file qgsfillsymbollayer.h.
|
inline |
Returns the width of the line subsymbol used to render the parallel lines in the fill.
Definition at line 1366 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the pattern's line width.
Definition at line 1461 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the line's width.
Definition at line 1443 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2466 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the offset distance for lines within the fill, which is the distance to offset the parallel lines from their normal position.
Units are retrieved via offsetUnit().
Definition at line 1395 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the pattern's line offset.
Definition at line 1493 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the line pattern's offset.
Definition at line 1475 of file qgsfillsymbollayer.h.
QString QgsLinePatternFillSymbolLayer::ogrFeatureStyleWidth | ( | double | widthScaleFactor | ) | const |
Definition at line 2970 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 QgsImageFillSymbolLayer.
Definition at line 2448 of file qgsfillsymbollayer.cpp.
|
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 2893 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 2375 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the distance between lines in the fill pattern.
d | distance. Units are specified by setDistanceUnit() |
Definition at line 1343 of file qgsfillsymbollayer.h.
|
inline |
Sets the map unit scale for the pattern's line distance.
Definition at line 1420 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit for the distance between lines in the fill pattern.
Definition at line 1403 of file qgsfillsymbollayer.h.
|
inline |
Sets the angle for the parallel lines used to fill the symbol.
Angles are in degrees, clockwise from North.
Definition at line 1326 of file qgsfillsymbollayer.h.
void QgsLinePatternFillSymbolLayer::setLineWidth | ( | double | w | ) |
Sets the width of the line subsymbol used to render the parallel lines in the fill.
Definition at line 2369 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the map unit scale for the pattern's line width.
Definition at line 1452 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit for the line's width.
Definition at line 1436 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2458 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the offset distance for lines within the fill, which is the distance to offset the parallel lines from their normal position.
Units are specified via setOffsetUnit().
Definition at line 1382 of file qgsfillsymbollayer.h.
|
inline |
Sets the map unit scale for the pattern's line offset.
Definition at line 1484 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit for the line pattern's offset.
Definition at line 1468 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 QgsImageFillSymbolLayer.
Definition at line 2440 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Sets layer's subsymbol. takes ownership of the passed symbol.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2391 of file qgsfillsymbollayer.cpp.
|
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 2875 of file qgsfillsymbollayer.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 2885 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns the symbol's sub symbol, if present.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2413 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 2924 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns the set of attributes referenced by the layer.
This includes attributes required by any data defined properties associated with the layer.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2418 of file qgsfillsymbollayer.cpp.