QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
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 ()
 
 ~QgsImageFillSymbolLayer () override
 
Qgis::SymbolCoordinateReference coordinateReference () const
 Returns the coordinate reference mode for fill which controls how the top left corner of the image fill is positioned relative to the feature. More...
 
Qt::PenStyle dxfPenStyle () const override
 Gets pen style. More...
 
double dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
 Gets line width. More...
 
QgsMapUnitScale mapUnitScale () const override
 
QgsUnitTypes::RenderUnit outputUnit () const override
 Returns the units to use for sizes and widths within the symbol layer. 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 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 setCoordinateReference (Qgis::SymbolCoordinateReference coordinateReference)
 Sets the coordinate reference mode for fill which controls how the top left corner of the image fill is positioned relative to the feature. 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 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 QgsMapUnitScalestrokeWidthMapUnitScale () 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
 
QgsFillSymbolLayeroperator= (const QgsFillSymbolLayer &other)=delete
 QgsFillSymbolLayer cannot be copied. More...
 
virtual void renderPolygon (const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context)=0
 Renders the fill symbol layer for the polygon whose outer ring is defined by points, using the given render context. More...
 
void setAngle (double angle)
 
- 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 QgsSymbolLayerclone () const =0
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
virtual QColor color () const
 Returns the "representative" color of the symbol layer. 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 void drawPreviewIcon (QgsSymbolRenderContext &context, QSize size)=0
 
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 QColor fillColor () const
 Returns the fill color for the symbol layer. More...
 
virtual Qgis::SymbolLayerFlags flags () const
 Returns flags which control the symbol layer's behavior. 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
 Returns true if the symbol layer colors are locked and the layer will ignore any symbol-level color changes. More...
 
virtual QString layerType () const =0
 Returns a string that represents this layer type. More...
 
virtual QgsMapUnitScale mapUnitScale () const
 
virtual QList< QgsSymbolLayerReferencemasks () const
 Returns masks defined by this symbol layer. More...
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
QgsSymbolLayeroperator= (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied. More...
 
virtual QgsUnitTypes::RenderUnit outputUnit () const
 Returns the units to use for sizes and widths within the symbol layer. 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 void prepareMasks (const QgsSymbolRenderContext &context)
 Prepares all mask internal objects according to what is defined in context This should be called prior to calling startRender() method. More...
 
virtual QVariantMap 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)
 Sets the "representative" color for the symbol layer. 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)
 Sets the fill color for the symbol layer. More...
 
void setLocked (bool locked)
 Sets whether the layer's colors are locked. More...
 
virtual void setMapUnitScale (const QgsMapUnitScale &scale)
 
virtual void setOutputUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units to use for sizes and widths within the symbol layer. More...
 
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)
 Sets the stroke color for the symbol layer. 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 startRender (QgsSymbolRenderContext &context)=0
 Called before a set of rendering operations commences on the supplied render context. More...
 
virtual void stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
 Called after the layer has been rendered for a particular feature. More...
 
virtual void stopRender (QgsSymbolRenderContext &context)=0
 Called after a set of rendering operations has finished on the supplied render context. More...
 
virtual QColor strokeColor () const
 Returns the stroke color for the symbol layer. More...
 
virtual QgsSymbolsubSymbol ()
 Returns the symbol's sub symbol, if present. More...
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const
 Saves the symbol layer as SLD. More...
 
Qgis::SymbolType type () const
 
virtual QSet< QString > usedAttributes (const QgsRenderContext &context) const
 Returns the set of attributes referenced by the layer. More...
 
virtual bool usesMapUnits () const
 Returns true if the symbol layer has any components which use map unit based sizes. 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...
 

Protected Member Functions

virtual bool applyBrushTransformFromContext (QgsSymbolRenderContext *context=nullptr) const
 Returns true if the image brush should be transformed using the render context's texture origin. More...
 
virtual void applyDataDefinedSettings (QgsSymbolRenderContext &context)
 Applies data defined settings prior to generating the fill symbol brush. 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 (Qgis::SymbolType type, bool locked=false)
 Constructor for QgsSymbolLayer. More...
 
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 QVariantMap &stringMap)
 Restores older data defined properties from string map. More...
 

Protected Attributes

QBrush mBrush
 
Qgis::SymbolCoordinateReference mCoordinateReference = Qgis::SymbolCoordinateReference::Feature
 
double mNextAngle = 0.0
 
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
QPainterPath mClipPath
 
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
 
Qgis::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 , PropertyPointCount , PropertyRandomSeed , PropertyClipPoints ,
  PropertyDensityArea , PropertyFontFamily , PropertyFontStyle , PropertyDashPatternOffset ,
  PropertyTrimStart , PropertyTrimEnd , PropertyLineStartWidthValue , PropertyLineEndWidthValue ,
  PropertyLineStartColorValue , PropertyLineEndColorValue , PropertyMarkerClipping , PropertyRandomOffsetX ,
  PropertyRandomOffsetY , PropertyLineClipping
}
 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 777 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsImageFillSymbolLayer()

QgsImageFillSymbolLayer::QgsImageFillSymbolLayer ( )

Definition at line 1724 of file qgsfillsymbollayer.cpp.

◆ ~QgsImageFillSymbolLayer()

QgsImageFillSymbolLayer::~QgsImageFillSymbolLayer ( )
overridedefault

Member Function Documentation

◆ applyBrushTransformFromContext()

bool QgsImageFillSymbolLayer::applyBrushTransformFromContext ( QgsSymbolRenderContext context = nullptr) const
protectedvirtual

Returns true if the image brush should be transformed using the render context's texture origin.

Since
QGIS 3.16

Reimplemented in QgsRasterFillSymbolLayer.

Definition at line 1830 of file qgsfillsymbollayer.cpp.

◆ applyDataDefinedSettings()

virtual void QgsImageFillSymbolLayer::applyDataDefinedSettings ( QgsSymbolRenderContext context)
inlineprotectedvirtual

Applies data defined settings prior to generating the fill symbol brush.

Reimplemented in QgsRasterFillSymbolLayer, QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsPointPatternFillSymbolLayer.

Definition at line 857 of file qgsfillsymbollayer.h.

◆ coordinateReference()

Qgis::SymbolCoordinateReference QgsImageFillSymbolLayer::coordinateReference ( ) const
inline

Returns the coordinate reference mode for fill which controls how the top left corner of the image fill is positioned relative to the feature.

Returns
coordinate reference mode
See also
setCoordinateReference
Since
QGIS 3.24

Definition at line 834 of file qgsfillsymbollayer.h.

◆ dxfPenStyle()

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

Gets pen style.

Reimplemented from QgsSymbolLayer.

Definition at line 1808 of file qgsfillsymbollayer.cpp.

◆ dxfWidth()

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

Gets line width.

Reimplemented from QgsSymbolLayer.

Definition at line 1797 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 QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsPointPatternFillSymbolLayer.

Definition at line 1782 of file qgsfillsymbollayer.cpp.

◆ properties()

QVariantMap QgsImageFillSymbolLayer::properties ( ) const
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.

Reimplemented in QgsRasterFillSymbolLayer, QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsPointPatternFillSymbolLayer.

Definition at line 1823 of file qgsfillsymbollayer.cpp.

◆ renderPolygon()

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

Renders the fill symbol layer for the polygon whose outer ring is defined by points, using the given render context.

The rings argument optionally specifies a list of polygon rings to render as holes.

Implements QgsFillSymbolLayer.

Reimplemented in QgsRasterFillSymbolLayer, QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsPointPatternFillSymbolLayer.

Definition at line 1730 of file qgsfillsymbollayer.cpp.

◆ setCoordinateReference()

void QgsImageFillSymbolLayer::setCoordinateReference ( Qgis::SymbolCoordinateReference  coordinateReference)
inline

Sets the coordinate reference mode for fill which controls how the top left corner of the image fill is positioned relative to the feature.

Parameters
coordinateReferencecoordinate reference mode
See also
coordinateReference
Since
QGIS 3.24

Definition at line 825 of file qgsfillsymbollayer.h.

◆ 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 QgsRasterFillSymbolLayer, QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsPointPatternFillSymbolLayer.

Definition at line 1777 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 806 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 791 of file qgsfillsymbollayer.h.

◆ 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 816 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 798 of file qgsfillsymbollayer.h.

Member Data Documentation

◆ mBrush

QBrush QgsImageFillSymbolLayer::mBrush
protected

Definition at line 845 of file qgsfillsymbollayer.h.

◆ mCoordinateReference

Qgis::SymbolCoordinateReference QgsImageFillSymbolLayer::mCoordinateReference = Qgis::SymbolCoordinateReference::Feature
protected

Definition at line 846 of file qgsfillsymbollayer.h.

◆ mNextAngle

double QgsImageFillSymbolLayer::mNextAngle = 0.0
protected

Definition at line 847 of file qgsfillsymbollayer.h.

◆ mStrokeWidth

double QgsImageFillSymbolLayer::mStrokeWidth = 0.0
protected

Stroke width.

Definition at line 850 of file qgsfillsymbollayer.h.

◆ mStrokeWidthMapUnitScale

QgsMapUnitScale QgsImageFillSymbolLayer::mStrokeWidthMapUnitScale
protected

Definition at line 852 of file qgsfillsymbollayer.h.

◆ mStrokeWidthUnit

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

Definition at line 851 of file qgsfillsymbollayer.h.


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