QGIS API Documentation  3.9.0-Master (224899f119)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsImageFillSymbolLayer Class Reference

Base class for polygon renderers generating texture images. More...

#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsImageFillSymbolLayer:
Inheritance graph
[legend]

Public Member Functions

 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...
 
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...
 
QgsMapUnitScale mapUnitScale () const override
 
QgsUnitTypes::RenderUnit outputUnit () const override
 Returns the units to use for sizes and widths within the symbol layer. More...
 
void renderPolygon (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolRenderContext &context) override
 
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 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...
 
bool setSubSymbol (QgsSymbol *symbol) override
 Sets layer's subsymbol. takes ownership of the passed symbol. More...
 
const QgsMapUnitScalestrokeWidthMapUnitScale () const
 Returns the stroke width map unit scale. More...
 
QgsUnitTypes::RenderUnit strokeWidthUnit () const
 Returns the units for the symbol's stroke width. More...
 
QgsSymbolsubSymbol () override
 Returns the symbol's sub symbol, if present. More...
 
QSet< QString > usedAttributes (const QgsRenderContext &context) const override
 Returns the set of attributes referenced by the layer. 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
 
QgsFillSymbolLayeroperator= (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 ()
 
virtual QgsSymbolLayerclone () const =0
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
virtual QColor color () const
 The fill color. More...
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the symbol layer's property collection, used for data defined overrides. More...
 
const QgsPropertyCollectiondataDefinedProperties () 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 layerType () const =0
 Returns a string that represents this layer type. More...
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
QgsSymbolLayeroperator= (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied. More...
 
QgsPaintEffectpaintEffect () 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 void startRender (QgsSymbolRenderContext &context)=0
 
virtual void stopRender (QgsSymbolRenderContext &context)=0
 
virtual QColor strokeColor () const
 Gets stroke color. More...
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const
 
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...
 

Protected Member Functions

virtual void applyDataDefinedSettings (QgsSymbolRenderContext &context)
 
- 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...
 

Protected Attributes

QBrush mBrush
 
double mNextAngle = 0.0
 
std::unique_ptr< QgsLineSymbolmStroke
 Custom stroke. More...
 
double mStrokeWidth = 0.0
 Stroke width. More...
 
QgsMapUnitScale mStrokeWidthMapUnitScale
 
QgsUnitTypes::RenderUnit mStrokeWidthUnit = QgsUnitTypes::RenderMillimeters
 
- Protected Attributes inherited from QgsFillSymbolLayer
double mAngle = 0.0
 
- 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< QgsPaintEffectmPaintEffect
 
int mRenderingPass = 0
 
QgsSymbol::SymbolType mType
 

Additional Inherited Members

- Public Types inherited from QgsSymbolLayer
enum  Property {
  PropertySize = 0, PropertyAngle, PropertyName, PropertyFillColor,
  PropertyStrokeColor, PropertyStrokeWidth, PropertyStrokeStyle, PropertyOffset,
  PropertyCharacter, PropertyWidth, PropertyHeight, PropertyPreserveAspectRatio,
  PropertyFillStyle, PropertyJoinStyle, PropertySecondaryColor, PropertyLineAngle,
  PropertyLineDistance, PropertyGradientType, PropertyCoordinateMode, PropertyGradientSpread,
  PropertyGradientReference1X, PropertyGradientReference1Y, PropertyGradientReference2X, PropertyGradientReference2Y,
  PropertyGradientReference1IsCentroid, PropertyGradientReference2IsCentroid, PropertyBlurRadius, PropertyShapeburstUseWholeShape,
  PropertyShapeburstMaxDistance, PropertyShapeburstIgnoreRings, PropertyFile, PropertyDistanceX,
  PropertyDistanceY, PropertyDisplacementX, PropertyDisplacementY, PropertyOpacity,
  PropertyCustomDash, PropertyCapStyle, PropertyPlacement, PropertyInterval,
  PropertyOffsetAlongLine, PropertyAverageAngleLength, PropertyHorizontalAnchor, PropertyVerticalAnchor,
  PropertyLayerEnabled, PropertyArrowWidth, PropertyArrowStartWidth, PropertyArrowHeadLength,
  PropertyArrowHeadThickness, PropertyArrowHeadType, PropertyArrowType, PropertyOffsetX,
  PropertyOffsetY
}
 Data definable properties. More...
 
- Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the symbol layer property definitions. 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...
 

Detailed Description

Base class for polygon renderers generating texture images.

Definition at line 631 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsImageFillSymbolLayer()

QgsImageFillSymbolLayer::QgsImageFillSymbolLayer ( )

Definition at line 1555 of file qgsfillsymbollayer.cpp.

Member Function Documentation

◆ applyDataDefinedSettings()

virtual void QgsImageFillSymbolLayer::applyDataDefinedSettings ( QgsSymbolRenderContext context)
inlineprotectedvirtual

◆ dxfColor()

QColor QgsImageFillSymbolLayer::dxfColor ( QgsSymbolRenderContext context) const
overridevirtual

Gets color.

Reimplemented from QgsSymbolLayer.

Definition at line 1683 of file qgsfillsymbollayer.cpp.

◆ dxfPenStyle()

Qt::PenStyle QgsImageFillSymbolLayer::dxfPenStyle ( ) const
overridevirtual

Gets pen style.

Reimplemented from QgsSymbolLayer.

Definition at line 1693 of file qgsfillsymbollayer.cpp.

◆ dxfWidth()

double QgsImageFillSymbolLayer::dxfWidth ( const QgsDxfExport e,
QgsSymbolRenderContext context 
) const
overridevirtual

Gets line width.

Reimplemented from QgsSymbolLayer.

Definition at line 1672 of file qgsfillsymbollayer.cpp.

◆ estimateMaxBleed()

double QgsImageFillSymbolLayer::estimateMaxBleed ( const QgsRenderContext context) const
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.

Reimplemented in QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsRasterFillSymbolLayer.

Definition at line 1662 of file qgsfillsymbollayer.cpp.

◆ hasDataDefinedProperties()

bool QgsImageFillSymbolLayer::hasDataDefinedProperties ( ) const
overridevirtual

Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties.

Since
QGIS 3.4.5

Reimplemented from QgsSymbolLayer.

Reimplemented in QgsPointPatternFillSymbolLayer, and QgsLinePatternFillSymbolLayer.

Definition at line 1716 of file qgsfillsymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsImageFillSymbolLayer::mapUnitScale ( ) const
overridevirtual

◆ outputUnit()

QgsUnitTypes::RenderUnit QgsImageFillSymbolLayer::outputUnit ( ) const
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.

Returns
output unit, or QgsUnitTypes::RenderUnknownUnit if the symbol layer contains mixed units
See also
setOutputUnit()

Reimplemented from QgsSymbolLayer.

Reimplemented in QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsSVGFillSymbolLayer.

Definition at line 1647 of file qgsfillsymbollayer.cpp.

◆ renderPolygon()

void QgsImageFillSymbolLayer::renderPolygon ( const QPolygonF &  points,
QList< QPolygonF > *  rings,
QgsSymbolRenderContext context 
)
overridevirtual

Implements QgsFillSymbolLayer.

Reimplemented in QgsRasterFillSymbolLayer.

Definition at line 1560 of file qgsfillsymbollayer.cpp.

◆ setMapUnitScale()

void QgsImageFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

◆ setOutputUnit()

void QgsImageFillSymbolLayer::setOutputUnit ( QgsUnitTypes::RenderUnit  unit)
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.

Parameters
unitoutput units
See also
outputUnit()

Reimplemented from QgsSymbolLayer.

Reimplemented in QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsSVGFillSymbolLayer.

Definition at line 1642 of file qgsfillsymbollayer.cpp.

◆ setStrokeWidthMapUnitScale()

void QgsImageFillSymbolLayer::setStrokeWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Sets the stroke width map unit scale.

See also
strokeWidthMapUnitScale()
setStrokeWidthUnit()

Definition at line 661 of file qgsfillsymbollayer.h.

◆ setStrokeWidthUnit()

void QgsImageFillSymbolLayer::setStrokeWidthUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the units fo the symbol's stroke width.

See also
strokeWidthUnit()
setStrokeWidthMapUnitScale()

Definition at line 646 of file qgsfillsymbollayer.h.

◆ setSubSymbol()

bool QgsImageFillSymbolLayer::setSubSymbol ( QgsSymbol symbol)
overridevirtual

Sets layer's subsymbol. takes ownership of the passed symbol.

Reimplemented from QgsSymbolLayer.

Reimplemented in QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsRasterFillSymbolLayer.

Definition at line 1617 of file qgsfillsymbollayer.cpp.

◆ strokeWidthMapUnitScale()

const QgsMapUnitScale& QgsImageFillSymbolLayer::strokeWidthMapUnitScale ( ) const
inline

Returns the stroke width map unit scale.

See also
setStrokeWidthMapUnitScale()
strokeWidthUnit()
Since
QGIS 2.16

Definition at line 671 of file qgsfillsymbollayer.h.

◆ strokeWidthUnit()

QgsUnitTypes::RenderUnit QgsImageFillSymbolLayer::strokeWidthUnit ( ) const
inline

Returns the units for the symbol's stroke width.

See also
setStrokeWidthUnit()
strokeWidthMapUnitScale()

Definition at line 653 of file qgsfillsymbollayer.h.

◆ subSymbol()

QgsSymbol* QgsImageFillSymbolLayer::subSymbol ( )
inlineoverridevirtual

Returns the symbol's sub symbol, if present.

Reimplemented from QgsSymbolLayer.

Reimplemented in QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsRasterFillSymbolLayer.

Definition at line 638 of file qgsfillsymbollayer.h.

◆ usedAttributes()

QSet< QString > QgsImageFillSymbolLayer::usedAttributes ( const QgsRenderContext context) const
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 QgsSymbolLayer.

Reimplemented in QgsPointPatternFillSymbolLayer, and QgsLinePatternFillSymbolLayer.

Definition at line 1708 of file qgsfillsymbollayer.cpp.

Member Data Documentation

◆ mBrush

QBrush QgsImageFillSymbolLayer::mBrush
protected

Definition at line 685 of file qgsfillsymbollayer.h.

◆ mNextAngle

double QgsImageFillSymbolLayer::mNextAngle = 0.0
protected

Definition at line 686 of file qgsfillsymbollayer.h.

◆ mStroke

std::unique_ptr< QgsLineSymbol > QgsImageFillSymbolLayer::mStroke
protected

Custom stroke.

Definition at line 694 of file qgsfillsymbollayer.h.

◆ mStrokeWidth

double QgsImageFillSymbolLayer::mStrokeWidth = 0.0
protected

Stroke width.

Definition at line 689 of file qgsfillsymbollayer.h.

◆ mStrokeWidthMapUnitScale

QgsMapUnitScale QgsImageFillSymbolLayer::mStrokeWidthMapUnitScale
protected

Definition at line 691 of file qgsfillsymbollayer.h.

◆ mStrokeWidthUnit

QgsUnitTypes::RenderUnit QgsImageFillSymbolLayer::mStrokeWidthUnit = QgsUnitTypes::RenderMillimeters
protected

Definition at line 690 of file qgsfillsymbollayer.h.


The documentation for this class was generated from the following files: