A symbol fill consisting of repeated parallel lines. More...

#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsLinePatternFillSymbolLayer:

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

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)
	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
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())
	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 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...

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, PropertyHorizontalAnchor, PropertyVerticalAnchor, PropertyLayerEnabled, PropertyArrowWidth, PropertyArrowStartWidth, PropertyArrowHeadLength, PropertyArrowHeadThickness, PropertyArrowHeadType, PropertyArrowType }
	Data definable properties. More...

Protected Attributes inherited from QgsImageFillSymbolLayer
QBrush	mBrush

double	mNextAngle = 0.0

std::unique_ptr< QgsLineSymbol >	mStroke
	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 if layer is enabled and should be drawn. More...

QgsFields	mFields

bool	mLocked

QgsPaintEffect *	mPaintEffect = nullptr

int	mRenderingPass

QgsSymbol::SymbolType	mType

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

A symbol fill consisting of repeated parallel lines.

Definition at line 1201 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

QgsLinePatternFillSymbolLayer::QgsLinePatternFillSymbolLayer ( )

Definition at line 2284 of file qgsfillsymbollayer.cpp.

QgsLinePatternFillSymbolLayer::~QgsLinePatternFillSymbolLayer ( )

override

Definition at line 2308 of file qgsfillsymbollayer.cpp.

Member Function Documentation

void QgsLinePatternFillSymbolLayer::applyDataDefinedSettings ( QgsSymbolRenderContext & context )

overrideprotectedvirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 2907 of file qgsfillsymbollayer.cpp.

QgsLinePatternFillSymbolLayer * QgsLinePatternFillSymbolLayer::clone ( ) const

overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 2834 of file qgsfillsymbollayer.cpp.

QColor QgsLinePatternFillSymbolLayer::color ( ) const

overridevirtual

The fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 2303 of file qgsfillsymbollayer.cpp.

QgsSymbolLayer * QgsLinePatternFillSymbolLayer::create ( const QgsStringMap & properties = QgsStringMap() )

static

Creates a new QgsLinePatternFillSymbolLayer from a properties map.

The caller takes ownership of the returned object.

Definition at line 2399 of file qgsfillsymbollayer.cpp.

QgsSymbolLayer * QgsLinePatternFillSymbolLayer::createFromSld ( QDomElement & element )

static

Creates a new QgsLinePatternFillSymbolLayer from a SLD element.

The caller takes ownership of the returned object.

Definition at line 2930 of file qgsfillsymbollayer.cpp.

double QgsLinePatternFillSymbolLayer::distance ( ) const

inline

Returns the distance between lines in the fill pattern.

Units are retrieved by distanceUnit().

See also: setDistance(); distanceUnit()

Definition at line 1260 of file qgsfillsymbollayer.h.

const QgsMapUnitScale& QgsLinePatternFillSymbolLayer::distanceMapUnitScale ( ) const

inline

Returns the map unit scale for the pattern's line distance.

See also: setDistanceMapUnitScale(); distance(); distanceUnit()

Definition at line 1339 of file qgsfillsymbollayer.h.

QgsUnitTypes::RenderUnit QgsLinePatternFillSymbolLayer::distanceUnit ( ) const

inline

Returns the units for the distance between lines in the fill pattern.

See also: setDistanceUnit(); distance()

Definition at line 1321 of file qgsfillsymbollayer.h.

double QgsLinePatternFillSymbolLayer::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 QgsImageFillSymbolLayer.

Definition at line 2357 of file qgsfillsymbollayer.cpp.

bool QgsLinePatternFillSymbolLayer::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 QgsImageFillSymbolLayer.

Definition at line 2348 of file qgsfillsymbollayer.cpp.

QString QgsLinePatternFillSymbolLayer::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 2505 of file qgsfillsymbollayer.cpp.

double QgsLinePatternFillSymbolLayer::lineAngle ( ) const

inline

Returns the angle for the parallel lines used to fill the symbol.

Angles are in degrees, clockwise from North.

See also: setLineAngle()

Definition at line 1245 of file qgsfillsymbollayer.h.

double QgsLinePatternFillSymbolLayer::lineWidth ( ) const

inline

Returns the width of the line subsymbol used to render the parallel lines in the fill.

See also: setLineWidth()

Definition at line 1276 of file qgsfillsymbollayer.h.

const QgsMapUnitScale& QgsLinePatternFillSymbolLayer::lineWidthMapUnitScale ( ) const

inline

Returns the map unit scale for the pattern's line width.

See also: setLineWidthMapUnitScale(); lineWidth(); lineWidthUnit()

Definition at line 1371 of file qgsfillsymbollayer.h.

QgsUnitTypes::RenderUnit QgsLinePatternFillSymbolLayer::lineWidthUnit ( ) const

inline

Returns the units for the line's width.

See also: setLineWidthUnit()

Definition at line 1353 of file qgsfillsymbollayer.h.

QgsMapUnitScale QgsLinePatternFillSymbolLayer::mapUnitScale ( ) const

overridevirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 2388 of file qgsfillsymbollayer.cpp.

double QgsLinePatternFillSymbolLayer::offset ( ) const

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().

See also: setOffset(); offsetUnit(); offsetMapUnitScale()

Definition at line 1305 of file qgsfillsymbollayer.h.

const QgsMapUnitScale& QgsLinePatternFillSymbolLayer::offsetMapUnitScale ( ) const

inline

Returns the map unit scale for the pattern's line offset.

See also: setOffsetMapUnitScale(); offset(); offsetUnit()

Definition at line 1403 of file qgsfillsymbollayer.h.

QgsUnitTypes::RenderUnit QgsLinePatternFillSymbolLayer::offsetUnit ( ) const

inline

Returns the units for the line pattern's offset.

See also: setOffsetUnit()

Definition at line 1385 of file qgsfillsymbollayer.h.

QString QgsLinePatternFillSymbolLayer::ogrFeatureStyleWidth ( double widthScaleFactor ) const

Definition at line 2892 of file qgsfillsymbollayer.cpp.

QgsUnitTypes::RenderUnit QgsLinePatternFillSymbolLayer::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 QgsImageFillSymbolLayer.

Definition at line 2370 of file qgsfillsymbollayer.cpp.

QgsStringMap QgsLinePatternFillSymbolLayer::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 2815 of file qgsfillsymbollayer.cpp.

void QgsLinePatternFillSymbolLayer::setColor ( const QColor & color )

overridevirtual

The fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 2297 of file qgsfillsymbollayer.cpp.

void QgsLinePatternFillSymbolLayer::setDistance ( double d )

inline

Sets the distance between lines in the fill pattern.

Parameters

d	distance. Units are specified by setDistanceUnit()

See also: distance(); setDistanceUnit()

Definition at line 1253 of file qgsfillsymbollayer.h.

void QgsLinePatternFillSymbolLayer::setDistanceMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the map unit scale for the pattern's line distance.

See also: distanceMapUnitScale(); setDistance(); setDistanceUnit()

Definition at line 1330 of file qgsfillsymbollayer.h.

void QgsLinePatternFillSymbolLayer::setDistanceUnit ( QgsUnitTypes::RenderUnit unit )

inline

Sets the unit for the distance between lines in the fill pattern.

See also: distanceUnit(); setDistance()

Definition at line 1313 of file qgsfillsymbollayer.h.

void QgsLinePatternFillSymbolLayer::setLineAngle ( double a )

inline

Sets the angle for the parallel lines used to fill the symbol.

Angles are in degrees, clockwise from North.

See also: lineAngle()

Definition at line 1236 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.

See also: lineWidth()

Definition at line 2291 of file qgsfillsymbollayer.cpp.

void QgsLinePatternFillSymbolLayer::setLineWidthMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the map unit scale for the pattern's line width.

See also: lineWidthMapUnitScale(); setLineWidth(); setLineWidthUnit()

Definition at line 1362 of file qgsfillsymbollayer.h.

void QgsLinePatternFillSymbolLayer::setLineWidthUnit ( QgsUnitTypes::RenderUnit unit )

inline

Sets the unit for the line's width.

See also: lineWidthUnit()

Definition at line 1346 of file qgsfillsymbollayer.h.

void QgsLinePatternFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale & scale )

overridevirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 2380 of file qgsfillsymbollayer.cpp.

void QgsLinePatternFillSymbolLayer::setOffset ( double offset )

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().

See also: offset(); setOffsetUnit(); setOffsetMapUnitScale()

Definition at line 1292 of file qgsfillsymbollayer.h.

void QgsLinePatternFillSymbolLayer::setOffsetMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the map unit scale for the pattern's line offset.

See also: offsetMapUnitScale(); setOffset(); setOffsetUnit()

Definition at line 1394 of file qgsfillsymbollayer.h.

void QgsLinePatternFillSymbolLayer::setOffsetUnit ( QgsUnitTypes::RenderUnit unit )

inline

Sets the unit for the line pattern's offset.

See also: offsetUnit()

Definition at line 1378 of file qgsfillsymbollayer.h.

void QgsLinePatternFillSymbolLayer::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