Renders polygons using a single fill and stroke color. More...

#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsSimpleFillSymbolLayer:

[legend]

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)

	~QgsSimpleFillSymbolLayer () override

Qt::BrushStyle	brushStyle () const

QgsSimpleFillSymbolLayer *	clone () const override
	Shall be reimplemented by subclasses to create a deep copy of the instance.

double	dxfAngle (QgsSymbolRenderContext &context) const override
	Gets angle.

QColor	dxfBrushColor (QgsSymbolRenderContext &context) const override
	Gets brush/fill color.

Qt::BrushStyle	dxfBrushStyle () const override
	Gets brush/fill style.

QColor	dxfColor (QgsSymbolRenderContext &context) const override
	Gets color.

Qt::PenStyle	dxfPenStyle () const override
	Gets pen style.

double	dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
	Gets line width.

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.

QColor	fillColor () const override
	Returns the fill color for the symbol layer.

Qgis::SymbolLayerFlags	flags () const override
	Returns flags which control the symbol layer's behavior.

QString	layerType () const override
	Returns a string that represents this layer type.

QgsMapUnitScale	mapUnitScale () const override

QPointF	offset () const
	Returns the offset by which polygons will be translated during rendering.

const QgsMapUnitScale &	offsetMapUnitScale () const
	Returns the map unit scale for the fill's offset.

Qgis::RenderUnit	offsetUnit () const
	Returns the units for the fill's offset.

QString	ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const override

Qgis::RenderUnit	outputUnit () const override
	Returns the units to use for sizes and widths within the symbol layer.

Qt::PenJoinStyle	penJoinStyle () const

QVariantMap	properties () const override
	Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer.

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.

void	setBrushStyle (Qt::BrushStyle style)

void	setFillColor (const QColor &color) override
	Sets the fill color for the symbol layer.

void	setMapUnitScale (const QgsMapUnitScale &scale) override

void	setOffset (QPointF offset)
	Sets an offset by which polygons will be translated during rendering.

void	setOffsetMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale for the fill's offset.

void	setOffsetUnit (Qgis::RenderUnit unit)
	Sets the unit for the fill's offset.

void	setOutputUnit (Qgis::RenderUnit unit) override
	Sets the units to use for sizes and widths within the symbol layer.

void	setPenJoinStyle (Qt::PenJoinStyle style)

void	setStrokeColor (const QColor &strokeColor) override
	Sets the stroke color for the symbol layer.

void	setStrokeStyle (Qt::PenStyle strokeStyle)

void	setStrokeWidth (double strokeWidth)

void	setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale)

void	setStrokeWidthUnit (Qgis::RenderUnit unit)
	Sets the units for the width of the fill's stroke.

void	startRender (QgsSymbolRenderContext &context) override
	Called before a set of rendering operations commences on the supplied render context.

void	stopRender (QgsSymbolRenderContext &context) override
	Called after a set of rendering operations has finished on the supplied render context.

QColor	strokeColor () const override
	Returns the stroke color for the symbol layer.

Qt::PenStyle	strokeStyle () const

double	strokeWidth () const

const QgsMapUnitScale &	strokeWidthMapUnitScale () const

Qgis::RenderUnit	strokeWidthUnit () const
	Returns the units for the width of the fill's stroke.

void	toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override
	Saves the symbol layer as SLD.

QImage	toTiledPatternImage () const override
	Renders the symbol layer as an image that can be used as a seamless pattern fill for polygons, this method is used by SLD export to generate image tiles for ExternalGraphic polygon fills.

bool	usesMapUnits () const override
	Returns `true` if the symbol layer has any components which use map unit based sizes.

Public Member Functions inherited from QgsFillSymbolLayer
	QgsFillSymbolLayer (const QgsFillSymbolLayer &other)=delete

double	angle () const
	Returns the rotation angle of the fill symbol, in degrees clockwise.

void	drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override

QgsFillSymbolLayer &	operator= (const QgsFillSymbolLayer &other)=delete

void	setAngle (double angle)
	Sets the rotation angle of the pattern, in degrees clockwise.

Public Member Functions inherited from QgsSymbolLayer
	QgsSymbolLayer (const QgsSymbolLayer &other)=delete

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.

virtual QColor	color () const
	Returns the "representative" color of the symbol layer.

QgsPropertyCollection &	dataDefinedProperties ()
	Returns a reference to the symbol layer's property collection, used for data defined overrides.

const QgsPropertyCollection &	dataDefinedProperties () const
	Returns a reference to the symbol layer's property collection, used for data defined overrides.

virtual QVector< qreal >	dxfCustomDashPattern (Qgis::RenderUnit &unit) const
	Gets dash pattern.

virtual double	dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
	Gets offset.

virtual double	dxfSize (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
	Gets marker size.

bool	enabled () const
	Returns `true` if symbol layer is enabled and will be drawn.

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

QString	id () const
	Returns symbol layer identifier This id is unique in the whole project.

bool	installMasks (QgsRenderContext &context, bool recursive, const QRectF &rect=QRectF())
	When rendering, install masks on context painter.

virtual bool	isCompatibleWithSymbol (QgsSymbol *symbol) const
	Returns if the layer can be used below the specified symbol.

bool	isLocked () const
	Returns `true` if the symbol layer colors are locked and the layer will ignore any symbol-level color changes.

virtual QList< QgsSymbolLayerReference >	masks () const
	Returns masks defined by this symbol layer.

QgsSymbolLayer &	operator= (const QgsSymbolLayer &other)=delete

QgsPaintEffect *	paintEffect () const
	Returns the current paint effect for the layer.

virtual void	prepareExpressions (const QgsSymbolRenderContext &context)
	Prepares all data defined property expressions for evaluation.

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.

int	renderingPass () const
	Specifies the rendering pass in which this symbol layer should be rendered.

virtual void	setColor (const QColor &color)
	Sets the "representative" color for the symbol layer.

void	setDataDefinedProperties (const QgsPropertyCollection &collection)
	Sets the symbol layer's property collection, used for data defined overrides.

virtual void	setDataDefinedProperty (Property key, const QgsProperty &property)
	Sets a data defined property for the layer.

void	setEnabled (bool enabled)
	Sets whether symbol layer is enabled and should be drawn.

void	setId (const QString &id)
	Set symbol layer identifier This id has to be unique in the whole project.

void	setLocked (bool locked)
	Sets whether the layer's colors are locked.

void	setPaintEffect (QgsPaintEffect *effect)
	Sets the current paint effect for the layer.

void	setRenderingPass (int renderingPass)
	Specifies the rendering pass in which this symbol layer should be rendered.

virtual bool	setSubSymbol (QgsSymbol *symbol)
	Sets layer's subsymbol. takes ownership of the passed symbol.

void	setUserFlags (Qgis::SymbolLayerUserFlags flags)
	Sets user-controlled flags which control the symbol layer's behavior.

virtual void	startFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
	Called before the layer will be rendered for a particular feature.

virtual void	stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
	Called after the layer has been rendered for a particular feature.

virtual QgsSymbol *	subSymbol ()
	Returns the symbol's sub symbol, if present.

Qgis::SymbolType	type () const

virtual QSet< QString >	usedAttributes (const QgsRenderContext &context) const
	Returns the set of attributes referenced by the layer.

Qgis::SymbolLayerUserFlags	userFlags () const
	Returns user-controlled flags which control the symbol layer's behavior.

virtual bool	writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const
	write as DXF

Static Public Member Functions
static QgsSymbolLayer *	create (const QVariantMap &properties=QVariantMap())
	Creates a new QgsSimpleFillSymbolLayer using the specified properties map containing symbol properties (see properties()).

static QgsSymbolLayer *	createFromSld (QDomElement &element)

Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinition &	propertyDefinitions ()
	Returns the symbol layer property definitions.

Protected Attributes
QBrush	mBrush

Qt::BrushStyle	mBrushStyle

QPointF	mOffset

QgsMapUnitScale	mOffsetMapUnitScale

Qgis::RenderUnit	mOffsetUnit = Qgis::RenderUnit::Millimeters

QPen	mPen

Qt::PenJoinStyle	mPenJoinStyle

QBrush	mSelBrush

QPen	mSelPen

QColor	mStrokeColor

Qt::PenStyle	mStrokeStyle

double	mStrokeWidth

QgsMapUnitScale	mStrokeWidthMapUnitScale

Qgis::RenderUnit	mStrokeWidthUnit = Qgis::RenderUnit::Millimeters

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.

QgsFields	mFields

QString	mId

bool	mLocked = false

std::unique_ptr< QgsPaintEffect >	mPaintEffect

int	mRenderingPass = 0

Qgis::SymbolType	mType

Qgis::SymbolLayerUserFlags	mUserFlags
	User controlled flags.

Additional Inherited Members
Public Types inherited from QgsSymbolLayer
enum class	Property : int { Size = 0 , Angle , Name , FillColor , StrokeColor , StrokeWidth , StrokeStyle , Offset , Character , Width , Height , PreserveAspectRatio , FillStyle , JoinStyle , SecondaryColor , LineAngle , LineDistance , GradientType , CoordinateMode , GradientSpread , GradientReference1X , GradientReference1Y , GradientReference2X , GradientReference2Y , GradientReference1IsCentroid , GradientReference2IsCentroid , BlurRadius , ShapeburstUseWholeShape , ShapeburstMaxDistance , ShapeburstIgnoreRings , File , DistanceX , DistanceY , DisplacementX , DisplacementY , Opacity , CustomDash , CapStyle , Placement , Interval , OffsetAlongLine , AverageAngleLength , HorizontalAnchor , VerticalAnchor , LayerEnabled , ArrowWidth , ArrowStartWidth , ArrowHeadLength , ArrowHeadThickness , ArrowHeadType , ArrowType , OffsetX , OffsetY , PointCount , RandomSeed , ClipPoints , DensityArea , FontFamily , FontStyle , DashPatternOffset , TrimStart , TrimEnd , LineStartWidthValue , LineEndWidthValue , LineStartColorValue , LineEndColorValue , MarkerClipping , RandomOffsetX , RandomOffsetY , LineClipping , SkipMultiples , ShowMarker }
	Data definable properties. 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.

Protected Member Functions inherited from QgsSymbolLayer
	QgsSymbolLayer (Qgis::SymbolType type, bool locked=false)
	Constructor for QgsSymbolLayer.

void	copyDataDefinedProperties (QgsSymbolLayer *destLayer) const
	Copies all data defined properties of this layer to another symbol layer.

void	copyPaintEffect (QgsSymbolLayer *destLayer) const
	Copies paint effect of this layer to another symbol layer.

void	removeMasks (QgsRenderContext &context, bool recursive)
	When rendering, remove previously installed masks from context painter if recursive is `true` masks are removed recursively for all children symbol layers.

void	restoreOldDataDefinedProperties (const QVariantMap &stringMap)
	Restores older data defined properties from string map.

bool	shouldRenderUsingSelectionColor (const QgsSymbolRenderContext &context) const
	Returns `true` if the symbol layer should be rendered using the selection color from the render context.

Static Protected Attributes inherited from QgsSymbolLayer
static const bool	SELECT_FILL_BORDER = false
	Whether fill styles for selected features also highlight symbol stroke.

static const bool	SELECT_FILL_STYLE = false
	Whether fill styles for selected features uses symbol layer style.

static const bool	SELECTION_IS_OPAQUE = true
	Whether styles for selected features ignore symbol alpha.

Detailed Description

Renders polygons using a single fill and stroke color.

Definition at line 44 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsSimpleFillSymbolLayer()

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 53 of file qgsfillsymbollayer.cpp.

◆ ~QgsSimpleFillSymbolLayer()

QgsSimpleFillSymbolLayer::~QgsSimpleFillSymbolLayer ( )

overridedefault

Member Function Documentation

◆ brushStyle()

Qt::BrushStyle QgsSimpleFillSymbolLayer::brushStyle ( ) const

inline

Definition at line 79 of file qgsfillsymbollayer.h.

◆ clone()

QgsSimpleFillSymbolLayer * QgsSimpleFillSymbolLayer::clone ( ) const

overridevirtual

Shall be reimplemented by subclasses to create a deep copy of the instance.

Implements QgsSymbolLayer.

Definition at line 377 of file qgsfillsymbollayer.cpp.

◆ create()

QgsSymbolLayer * QgsSimpleFillSymbolLayer::create ( const QVariantMap & properties = QVariantMap() )

static

Creates a new QgsSimpleFillSymbolLayer using the specified properties map containing symbol properties (see properties()).

Caller takes ownership of the returned symbol layer.

Definition at line 169 of file qgsfillsymbollayer.cpp.

◆ createFromSld()

QgsSymbolLayer * QgsSimpleFillSymbolLayer::createFromSld ( QDomElement & element )

static

Definition at line 484 of file qgsfillsymbollayer.cpp.

◆ dxfAngle()

double QgsSimpleFillSymbolLayer::dxfAngle ( QgsSymbolRenderContext & context ) const

overridevirtual

Gets angle.

Reimplemented from QgsSymbolLayer.

Definition at line 542 of file qgsfillsymbollayer.cpp.

◆ dxfBrushColor()

QColor QgsSimpleFillSymbolLayer::dxfBrushColor ( QgsSymbolRenderContext & context ) const

overridevirtual

Gets brush/fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 558 of file qgsfillsymbollayer.cpp.

◆ dxfBrushStyle()

Qt::BrushStyle QgsSimpleFillSymbolLayer::dxfBrushStyle ( ) const

overridevirtual

Gets brush/fill style.

Reimplemented from QgsSymbolLayer.

Definition at line 568 of file qgsfillsymbollayer.cpp.

◆ dxfColor()

QColor QgsSimpleFillSymbolLayer::dxfColor ( QgsSymbolRenderContext & context ) const

overridevirtual

Gets color.

Reimplemented from QgsSymbolLayer.

Definition at line 531 of file qgsfillsymbollayer.cpp.

◆ dxfPenStyle()

Qt::PenStyle QgsSimpleFillSymbolLayer::dxfPenStyle ( ) const

overridevirtual

Gets pen style.

Reimplemented from QgsSymbolLayer.

Definition at line 553 of file qgsfillsymbollayer.cpp.

◆ dxfWidth()

double QgsSimpleFillSymbolLayer::dxfWidth	(	const QgsDxfExport &	e,
		QgsSymbolRenderContext &	context
	)		const

overridevirtual

Gets line width.

Reimplemented from QgsSymbolLayer.

Definition at line 520 of file qgsfillsymbollayer.cpp.

◆ estimateMaxBleed()

double QgsSimpleFillSymbolLayer::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.

Definition at line 513 of file qgsfillsymbollayer.cpp.

◆ fillColor()

QColor QgsSimpleFillSymbolLayer::fillColor ( ) const

inlineoverridevirtual

Returns the fill color for the symbol layer.

This property is not supported by all symbol layer types, only those with a fill component. Symbol layers without a fill component will return an invalid QColor.

See also: setFillColor(); color(); strokeColor()

Reimplemented from QgsSymbolLayer.

Definition at line 84 of file qgsfillsymbollayer.h.

◆ flags()

Qgis::SymbolLayerFlags QgsSimpleFillSymbolLayer::flags ( ) const

overridevirtual

Returns flags which control the symbol layer's behavior.

Since: QGIS 3.22

Reimplemented from QgsSymbolLayer.

Definition at line 261 of file qgsfillsymbollayer.cpp.

◆ layerType()

QString QgsSimpleFillSymbolLayer::layerType ( ) const

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 256 of file qgsfillsymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsSimpleFillSymbolLayer::mapUnitScale ( ) const

overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 94 of file qgsfillsymbollayer.cpp.

◆ offset()

QPointF QgsSimpleFillSymbolLayer::offset ( ) const

inline

Returns the offset by which polygons will be translated during rendering.

Units are specified by offsetUnit().

See also: setOffset(); offsetUnit()

Definition at line 114 of file qgsfillsymbollayer.h.

◆ offsetMapUnitScale()

const QgsMapUnitScale & QgsSimpleFillSymbolLayer::offsetMapUnitScale ( ) const

inline

Returns the map unit scale for the fill's offset.

See also: offset(); setOffsetMapUnitScale()

Definition at line 158 of file qgsfillsymbollayer.h.

◆ offsetUnit()

Qgis::RenderUnit QgsSimpleFillSymbolLayer::offsetUnit ( ) const

inline

Returns the units for the fill's offset.

See also: setOffsetUnit(); offset()

Definition at line 144 of file qgsfillsymbollayer.h.

◆ ogrFeatureStyle()

QString QgsSimpleFillSymbolLayer::ogrFeatureStyle	(	double	mmScaleFactor,
		double	mapUnitScaleFactor
	)		const

overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 473 of file qgsfillsymbollayer.cpp.

◆ outputUnit()

Qgis::RenderUnit QgsSimpleFillSymbolLayer::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.

Definition at line 72 of file qgsfillsymbollayer.cpp.

◆ penJoinStyle()

Qt::PenJoinStyle QgsSimpleFillSymbolLayer::penJoinStyle ( ) const

inline

Definition at line 93 of file qgsfillsymbollayer.h.

◆ properties()

QVariantMap QgsSimpleFillSymbolLayer::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.

Definition at line 360 of file qgsfillsymbollayer.cpp.

◆ renderPolygon()

void QgsSimpleFillSymbolLayer::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.

Definition at line 296 of file qgsfillsymbollayer.cpp.

◆ setBrushStyle()

void QgsSimpleFillSymbolLayer::setBrushStyle ( Qt::BrushStyle style )

inline

Definition at line 80 of file qgsfillsymbollayer.h.

◆ setFillColor()

void QgsSimpleFillSymbolLayer::setFillColor ( const QColor & color )

inlineoverridevirtual

Sets the fill color for the symbol layer.

This property is not supported by all symbol layer types, only those with a fill component.

See also: fillColor(); setColor(); setStrokeColor()

Reimplemented from QgsSymbolLayer.

Definition at line 85 of file qgsfillsymbollayer.h.

◆ setMapUnitScale()

void QgsSimpleFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale & scale )

overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 88 of file qgsfillsymbollayer.cpp.

◆ setOffset()

void QgsSimpleFillSymbolLayer::setOffset ( QPointF offset )

inline

Sets an offset by which polygons will be translated during rendering.

Units are specified by offsetUnit().

See also: offset(); setOffsetUnit()

Definition at line 104 of file qgsfillsymbollayer.h.

◆ setOffsetMapUnitScale()

void QgsSimpleFillSymbolLayer::setOffsetMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the map unit scale for the fill's offset.

See also: setOffset(); offsetMapUnitScale()

Definition at line 151 of file qgsfillsymbollayer.h.

◆ setOffsetUnit()

void QgsSimpleFillSymbolLayer::setOffsetUnit ( Qgis::RenderUnit unit )

inline

Sets the unit for the fill's offset.

See also: offset(); offsetUnit()

Definition at line 137 of file qgsfillsymbollayer.h.

◆ setOutputUnit()

void QgsSimpleFillSymbolLayer::setOutputUnit ( Qgis::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

unit	output units

See also: outputUnit()

Reimplemented from QgsSymbolLayer.

Definition at line 66 of file qgsfillsymbollayer.cpp.

◆ setPenJoinStyle()

void QgsSimpleFillSymbolLayer::setPenJoinStyle ( Qt::PenJoinStyle style )

inline

Definition at line 94 of file qgsfillsymbollayer.h.

◆ setStrokeColor()

void QgsSimpleFillSymbolLayer::setStrokeColor ( const QColor & color )

inlineoverridevirtual

Sets the stroke color for the symbol layer.

This property is not supported by all symbol layer types, only those with a stroke component.

See also: strokeColor(); setColor(); setFillColor()

Reimplemented from QgsSymbolLayer.

Definition at line 83 of file qgsfillsymbollayer.h.

◆ setStrokeStyle()

void QgsSimpleFillSymbolLayer::setStrokeStyle ( Qt::PenStyle strokeStyle )

inline

Definition at line 88 of file qgsfillsymbollayer.h.

◆ setStrokeWidth()

void QgsSimpleFillSymbolLayer::setStrokeWidth ( double strokeWidth )

inline

Definition at line 91 of file qgsfillsymbollayer.h.

◆ setStrokeWidthMapUnitScale()

void QgsSimpleFillSymbolLayer::setStrokeWidthMapUnitScale ( const QgsMapUnitScale & scale )

inline

Definition at line 129 of file qgsfillsymbollayer.h.

◆ setStrokeWidthUnit()

void QgsSimpleFillSymbolLayer::setStrokeWidthUnit ( Qgis::RenderUnit unit )

inline

Sets the units for the width of the fill's stroke.

Parameters

unit	width units

See also: strokeWidthUnit()

Definition at line 121 of file qgsfillsymbollayer.h.

◆ startRender()

void QgsSimpleFillSymbolLayer::startRender ( QgsSymbolRenderContext & context )

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.

See also: startFeatureRender(); stopRender()

Implements QgsSymbolLayer.

Definition at line 266 of file qgsfillsymbollayer.cpp.

◆ stopRender()

void QgsSimpleFillSymbolLayer::stopRender ( QgsSymbolRenderContext & context )

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.

See also: startRender(); stopFeatureRender()

Implements QgsSymbolLayer.

Definition at line 291 of file qgsfillsymbollayer.cpp.

◆ strokeColor()

QColor QgsSimpleFillSymbolLayer::strokeColor ( ) const

inlineoverridevirtual

Returns the stroke color for the symbol layer.

This property is not supported by all symbol layer types, only those with a stroke component. Symbol layers without a stroke component will return an invalid QColor.

See also: setStrokeColor(); color(); fillColor()

Reimplemented from QgsSymbolLayer.

Definition at line 82 of file qgsfillsymbollayer.h.

◆ strokeStyle()

Qt::PenStyle QgsSimpleFillSymbolLayer::strokeStyle ( ) const

inline

Definition at line 87 of file qgsfillsymbollayer.h.

◆ strokeWidth()

double QgsSimpleFillSymbolLayer::strokeWidth ( ) const

inline

Definition at line 90 of file qgsfillsymbollayer.h.

◆ strokeWidthMapUnitScale()

const QgsMapUnitScale & QgsSimpleFillSymbolLayer::strokeWidthMapUnitScale ( ) const

inline

Definition at line 130 of file qgsfillsymbollayer.h.

◆ strokeWidthUnit()

Qgis::RenderUnit QgsSimpleFillSymbolLayer::strokeWidthUnit ( ) const

inline

Returns the units for the width of the fill's stroke.

See also: setStrokeWidthUnit()

Definition at line 127 of file qgsfillsymbollayer.h.

◆ toSld()

void QgsSimpleFillSymbolLayer::toSld	(	QDomDocument &	doc,
		QDomElement &	element,
		const QVariantMap &	props
	)		const

overridevirtual

Saves the symbol layer as SLD.

Reimplemented from QgsSymbolLayer.

Definition at line 390 of file qgsfillsymbollayer.cpp.

◆ toTiledPatternImage()

QImage QgsSimpleFillSymbolLayer::toTiledPatternImage ( ) const

overridevirtual

Renders the symbol layer as an image that can be used as a seamless pattern fill for polygons, this method is used by SLD export to generate image tiles for ExternalGraphic polygon fills.

The default implementation returns a null image.

Returns: the tile image (not necessarily a square) or a null image if not implemented.

Since: QGIS 3.30

Reimplemented from QgsFillSymbolLayer.

Definition at line 573 of file qgsfillsymbollayer.cpp.

◆ usesMapUnits()

bool QgsSimpleFillSymbolLayer::usesMapUnits ( ) const

overridevirtual

Returns true if the symbol layer has any components which use map unit based sizes.

Since: QGIS 3.18

Reimplemented from QgsSymbolLayer.

Definition at line 82 of file qgsfillsymbollayer.cpp.

Member Data Documentation

◆ mBrush

QBrush QgsSimpleFillSymbolLayer::mBrush

protected

Definition at line 179 of file qgsfillsymbollayer.h.

◆ mBrushStyle

Qt::BrushStyle QgsSimpleFillSymbolLayer::mBrushStyle

protected

Definition at line 181 of file qgsfillsymbollayer.h.

◆ mOffset

QPointF QgsSimpleFillSymbolLayer::mOffset

protected

Definition at line 191 of file qgsfillsymbollayer.h.

◆ mOffsetMapUnitScale

QgsMapUnitScale QgsSimpleFillSymbolLayer::mOffsetMapUnitScale

protected

Definition at line 193 of file qgsfillsymbollayer.h.

◆ mOffsetUnit

Qgis::RenderUnit QgsSimpleFillSymbolLayer::mOffsetUnit = Qgis::RenderUnit::Millimeters

protected

Definition at line 192 of file qgsfillsymbollayer.h.

◆ mPen

QPen QgsSimpleFillSymbolLayer::mPen

protected

Definition at line 188 of file qgsfillsymbollayer.h.

◆ mPenJoinStyle

Qt::PenJoinStyle QgsSimpleFillSymbolLayer::mPenJoinStyle

protected

Definition at line 187 of file qgsfillsymbollayer.h.

◆ mSelBrush

QBrush QgsSimpleFillSymbolLayer::mSelBrush

protected

Definition at line 180 of file qgsfillsymbollayer.h.

◆ mSelPen

QPen QgsSimpleFillSymbolLayer::mSelPen

protected

Definition at line 189 of file qgsfillsymbollayer.h.

◆ mStrokeColor

QColor QgsSimpleFillSymbolLayer::mStrokeColor

protected

Definition at line 182 of file qgsfillsymbollayer.h.

◆ mStrokeStyle

Qt::PenStyle QgsSimpleFillSymbolLayer::mStrokeStyle

protected

Definition at line 183 of file qgsfillsymbollayer.h.

◆ mStrokeWidth

double QgsSimpleFillSymbolLayer::mStrokeWidth

protected

Definition at line 184 of file qgsfillsymbollayer.h.

◆ mStrokeWidthMapUnitScale

QgsMapUnitScale QgsSimpleFillSymbolLayer::mStrokeWidthMapUnitScale

protected

Definition at line 186 of file qgsfillsymbollayer.h.

◆ mStrokeWidthUnit

Qgis::RenderUnit QgsSimpleFillSymbolLayer::mStrokeWidthUnit = Qgis::RenderUnit::Millimeters

protected

Definition at line 185 of file qgsfillsymbollayer.h.

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

/build/qgis-3.41.0+git20241116+25ec5511245+99sid/src/core/symbology/qgsfillsymbollayer.h
/build/qgis-3.41.0+git20241116+25ec5511245+99sid/src/core/symbology/qgsfillsymbollayer.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsSimpleFillSymbolLayer()

◆ ~QgsSimpleFillSymbolLayer()

Member Function Documentation

◆ brushStyle()

◆ clone()

◆ create()

◆ createFromSld()

◆ dxfAngle()

◆ dxfBrushColor()

◆ dxfBrushStyle()

◆ dxfColor()

◆ dxfPenStyle()

◆ dxfWidth()

◆ estimateMaxBleed()

◆ fillColor()

◆ flags()

◆ layerType()

◆ mapUnitScale()

◆ offset()

◆ offsetMapUnitScale()

◆ offsetUnit()

◆ ogrFeatureStyle()

◆ outputUnit()

◆ penJoinStyle()

◆ properties()

◆ renderPolygon()

◆ setBrushStyle()

◆ setFillColor()

◆ setMapUnitScale()

◆ setOffset()

◆ setOffsetMapUnitScale()

◆ setOffsetUnit()

◆ setOutputUnit()

◆ setPenJoinStyle()

◆ setStrokeColor()

◆ setStrokeStyle()

◆ setStrokeWidth()

◆ setStrokeWidthMapUnitScale()

◆ setStrokeWidthUnit()

◆ startRender()

◆ stopRender()

◆ strokeColor()

◆ strokeStyle()

◆ strokeWidth()

◆ strokeWidthMapUnitScale()

◆ strokeWidthUnit()

◆ toSld()

◆ toTiledPatternImage()

◆ usesMapUnits()

Member Data Documentation

◆ mBrush

◆ mBrushStyle

◆ mOffset

◆ mOffsetMapUnitScale

◆ mOffsetUnit

◆ mPen

◆ mPenJoinStyle

◆ mSelBrush

◆ mSelPen

◆ mStrokeColor

◆ mStrokeStyle

◆ mStrokeWidth

◆ mStrokeWidthMapUnitScale

◆ mStrokeWidthUnit