QGIS API Documentation
3.2.0-Bonn (bc43194)
|
#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 |
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... | |
QString | layerType () const override |
Returns a string that represents this layer type. More... | |
double | lineAngle () const |
double | lineWidth () const |
const QgsMapUnitScale & | lineWidthMapUnitScale () const |
QgsUnitTypes::RenderUnit | lineWidthUnit () const |
Returns the units for the line's width. More... | |
QgsMapUnitScale | mapUnitScale () const override |
double | offset () const |
const QgsMapUnitScale & | offsetMapUnitScale () const |
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) |
void | setDistanceUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the distance between lines in the fill pattern. More... | |
void | setLineAngle (double a) |
void | setLineWidth (double w) |
void | setLineWidthMapUnitScale (const QgsMapUnitScale &scale) |
void | setLineWidthUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the line's width. More... | |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setOffset (double offset) |
void | setOffsetMapUnitScale (const QgsMapUnitScale &scale) |
void | setOffsetUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units 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 |
void | stopRender (QgsSymbolRenderContext &context) override |
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, QList< QPolygonF > *rings, QgsSymbolRenderContext &context) override |
void | setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale) |
void | setStrokeWidthUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the symbol's stroke width. More... | |
const QgsMapUnitScale & | strokeWidthMapUnitScale () const |
QgsUnitTypes::RenderUnit | strokeWidthUnit () const |
Returns the units for the symbol's stroke width. More... | |
Public Member Functions inherited from QgsFillSymbolLayer | |
double | angle () const |
void | drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override |
void | setAngle (double angle) |
Public Member Functions inherited from QgsSymbolLayer | |
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 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 |
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 void | setStrokeColor (const QColor &color) |
Set stroke color. 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()) |
static QgsSymbolLayer * | createFromSld (QDomElement &element) |
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 QgsFillSymbolLayer | |
QgsFillSymbolLayer (bool locked=false) | |
void | _renderPolygon (QPainter *p, const QPolygonF &points, const QList< 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... | |
Definition at line 1033 of file qgsfillsymbollayer.h.
QgsLinePatternFillSymbolLayer::QgsLinePatternFillSymbolLayer | ( | ) |
Definition at line 2286 of file qgsfillsymbollayer.cpp.
|
override |
Definition at line 2310 of file qgsfillsymbollayer.cpp.
|
overrideprotectedvirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2890 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 2817 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 2305 of file qgsfillsymbollayer.cpp.
|
static |
Definition at line 2392 of file qgsfillsymbollayer.cpp.
|
static |
Definition at line 2913 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the distance between lines in the fill pattern.
Units are retrieved by distanceUnit().
Definition at line 1075 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1100 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the distance between lines in the fill pattern.
Definition at line 1097 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 2350 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 2498 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 1060 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1078 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1116 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the line's width.
Definition at line 1113 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2381 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 1082 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1132 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the line pattern's offset.
Definition at line 1129 of file qgsfillsymbollayer.h.
QString QgsLinePatternFillSymbolLayer::ogrFeatureStyleWidth | ( | double | widthScaleFactor | ) | const |
Definition at line 2875 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 2363 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 2798 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 2299 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the distance between lines in the fill pattern.
d | distance. Units are specified by setDistanceUnit() |
Definition at line 1068 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1099 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the distance between lines in the fill pattern.
unit | distance units |
Definition at line 1090 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1059 of file qgsfillsymbollayer.h.
void QgsLinePatternFillSymbolLayer::setLineWidth | ( | double | w | ) |
Definition at line 2293 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 1115 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the line's width.
unit | width units |
Definition at line 1107 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2373 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 1081 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1131 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the line pattern's offset.
unit | offset units |
Definition at line 1123 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 2355 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Sets layer's subsymbol. takes ownership of the passed symbol.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2315 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 2780 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 2790 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns the symbol's sub symbol, if present.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2337 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 2829 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 2342 of file qgsfillsymbollayer.cpp.
|
protected |
Definition at line 1154 of file qgsfillsymbollayer.h.
|
protected |
Distance (in mm or map units) between lines.
Definition at line 1147 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1149 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1148 of file qgsfillsymbollayer.h.
|
protected |
Vector line angle in degrees (0 = horizontal, counterclockwise)
Definition at line 1156 of file qgsfillsymbollayer.h.
|
protected |
Line width (in mm or map units)
Definition at line 1151 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1153 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1152 of file qgsfillsymbollayer.h.
|
protected |
Offset perpendicular to line direction.
Definition at line 1158 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1160 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1159 of file qgsfillsymbollayer.h.