A class for filling symbols with a repeated raster image. More...

#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsRasterFillSymbolLayer:

[legend]

Public Member Functions
	QgsRasterFillSymbolLayer (const QString &imageFilePath=QString())
	Constructor for QgsRasterFillSymbolLayer, using a raster fill from the specified imageFilePath.

	~QgsRasterFillSymbolLayer () override

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

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

Qgis::SymbolCoordinateReference	coordinateMode () const
	Coordinate mode for fill.

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.

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

double	height () const
	Returns the height used for scaling the image used in the fill.

QString	imageFilePath () const
	The path to the raster image used for the fill.

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

QPointF	offset () const
	Returns the offset for the fill.

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.

double	opacity () const
	Returns the opacity for the raster image used in the fill.

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	setCoordinateMode (Qgis::SymbolCoordinateReference mode)
	Set the coordinate mode for fill.

void	setHeight (double height)
	Sets the height for scaling the image.

void	setImageFilePath (const QString &imagePath)
	Sets the path to the raster image used for the fill.

void	setOffset (QPointF offset)
	Sets the offset for the fill.

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

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

void	setOpacity (double opacity)
	Sets the opacity for the raster image used in the fill.

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

void	setSizeMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale for the image's width and height.

void	setSizeUnit (Qgis::RenderUnit unit)
	Sets the unit for the image's width and height.

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

void	setWidth (double width)
	Sets the width for scaling the image used in the fill.

Q_DECL_DEPRECATED void	setWidthMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale for the image's width.

Q_DECL_DEPRECATED void	setWidthUnit (Qgis::RenderUnit unit)
	Sets the unit for the image's width.

const QgsMapUnitScale &	sizeMapUnitScale () const
	Returns the map unit scale for the image's width and height.

Qgis::RenderUnit	sizeUnit () const
	Returns the units for the image's width and height.

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.

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

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

double	width () const
	Returns the width used for scaling the image used in the fill.

Q_DECL_DEPRECATED const QgsMapUnitScale &	widthMapUnitScale () const
	Returns the map unit scale for the image's width.

Q_DECL_DEPRECATED Qgis::RenderUnit	widthUnit () const
	Returns the units for the image's width.

Public Member Functions inherited from QgsImageFillSymbolLayer
	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.

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

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

QgsMapUnitScale	mapUnitScale () const override

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

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.

void	setMapUnitScale (const QgsMapUnitScale &scale) override

void	setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale)
	Sets the stroke width map unit scale.

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

const QgsMapUnitScale &	strokeWidthMapUnitScale () const
	Returns the stroke width map unit scale.

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

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.

virtual QImage	toTiledPatternImage () const
	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.

Public Member Functions inherited from QgsSymbolLayer
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.

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 double	dxfAngle (QgsSymbolRenderContext &context) const
	Gets angle.

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

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

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

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 QColor	fillColor () const
	Returns the fill color for the symbol layer.

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.

virtual QString	ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const

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.

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

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 void	setStrokeColor (const QColor &color)
	Sets the stroke color for the symbol layer.

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 QColor	strokeColor () const
	Returns the stroke color for the symbol layer.

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

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 QgsRasterFillSymbolLayer from a properties map.

static QgsSymbolLayer *	createFromSld (QDomElement &element)
	Creates a new QgsRasterFillSymbolLayer from a SLD element.

static void	resolvePaths (QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving)
	Turns relative paths in properties map to absolute when reading and vice versa when writing.

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

Protected Member Functions
bool	applyBrushTransformFromContext (QgsSymbolRenderContext *context=nullptr) const override
	Returns `true` if the image brush should be transformed using the render context's texture origin.

void	applyDataDefinedSettings (QgsSymbolRenderContext &context) override
	Applies data defined settings prior to generating the fill symbol brush.

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 (const QgsSymbolLayer &other)

	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.

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 Attributes inherited from QgsImageFillSymbolLayer
QBrush	mBrush

Qgis::SymbolCoordinateReference	mCoordinateReference = Qgis::SymbolCoordinateReference::Feature

double	mNextAngle = 0.0

double	mStrokeWidth = 0.0
	Stroke width.

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.

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

A class for filling symbols with a repeated raster image.

Definition at line 855 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsRasterFillSymbolLayer()

QgsRasterFillSymbolLayer::QgsRasterFillSymbolLayer ( const QString & imageFilePath = QString() )

Constructor for QgsRasterFillSymbolLayer, using a raster fill from the specified imageFilePath.

Definition at line 5103 of file qgsfillsymbollayer.cpp.

◆ ~QgsRasterFillSymbolLayer()

QgsRasterFillSymbolLayer::~QgsRasterFillSymbolLayer ( )

overridedefault

Member Function Documentation

◆ applyBrushTransformFromContext()

bool QgsRasterFillSymbolLayer::applyBrushTransformFromContext ( QgsSymbolRenderContext * context = nullptr ) const

overrideprotectedvirtual

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

Since: QGIS 3.16

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 5420 of file qgsfillsymbollayer.cpp.

◆ applyDataDefinedSettings()

void QgsRasterFillSymbolLayer::applyDataDefinedSettings ( QgsSymbolRenderContext & context )

overrideprotectedvirtual

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

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 5363 of file qgsfillsymbollayer.cpp.

◆ clone()

QgsRasterFillSymbolLayer * QgsRasterFillSymbolLayer::clone ( ) const

overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 5306 of file qgsfillsymbollayer.cpp.

◆ color()

QColor QgsRasterFillSymbolLayer::color ( ) const

overridevirtual

Returns the "representative" color of the symbol layer.

Depending on the symbol layer type, this will have different meaning. For instance, a line symbol layer will generally return the stroke color of the layer, while a fill symbol layer will return the "fill" color instead of stroke.

Some symbol layer types will return an invalid QColor if they have no representative color associated (e.g. raster image based symbol layers).

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

Reimplemented from QgsSymbolLayer.

Definition at line 5336 of file qgsfillsymbollayer.cpp.

◆ coordinateMode()

Qgis::SymbolCoordinateReference QgsRasterFillSymbolLayer::coordinateMode ( ) const

inline

Coordinate mode for fill.

Controls how the top left corner of the image fill is positioned relative to the feature.

Returns: coordinate mode

See also: setCoordinateMode

Definition at line 931 of file qgsfillsymbollayer.h.

◆ create()

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

static

Creates a new QgsRasterFillSymbolLayer from a properties map.

The caller takes ownership of the returned object.

Definition at line 5113 of file qgsfillsymbollayer.cpp.

◆ createFromSld()

QgsSymbolLayer * QgsRasterFillSymbolLayer::createFromSld ( QDomElement & element )

static

Creates a new QgsRasterFillSymbolLayer from a SLD element.

The caller takes ownership of the returned object.

Since: QGIS 3.30

Definition at line 5179 of file qgsfillsymbollayer.cpp.

◆ estimateMaxBleed()

double QgsRasterFillSymbolLayer::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 5325 of file qgsfillsymbollayer.cpp.

◆ flags()

Qgis::SymbolLayerFlags QgsRasterFillSymbolLayer::flags ( ) const

overridevirtual

Returns flags which control the symbol layer's behavior.

Since: QGIS 3.22

Reimplemented from QgsSymbolLayer.

Definition at line 5234 of file qgsfillsymbollayer.cpp.

◆ height()

double QgsRasterFillSymbolLayer::height ( ) const

inline

Returns the height used for scaling the image used in the fill.

If the height is 0 then the height will be calculated automatically based on the image's width().

See also: width(); setHeight()

Since: QGIS 3.36

Definition at line 1049 of file qgsfillsymbollayer.h.

◆ imageFilePath()

QString QgsRasterFillSymbolLayer::imageFilePath ( ) const

inline

The path to the raster image used for the fill.

Returns: path to image file

See also: setImageFilePath

Definition at line 915 of file qgsfillsymbollayer.h.

◆ layerType()

QString QgsRasterFillSymbolLayer::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 5229 of file qgsfillsymbollayer.cpp.

◆ offset()

QPointF QgsRasterFillSymbolLayer::offset ( ) const

inline

Returns the offset for the fill.

Returns: offset for fill

See also: setOffset; offsetUnit; offsetMapUnitScale

Definition at line 963 of file qgsfillsymbollayer.h.

◆ offsetMapUnitScale()

const QgsMapUnitScale & QgsRasterFillSymbolLayer::offsetMapUnitScale ( ) const

inline

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

Returns: map unit scale for offset

See also: setOffsetMapUnitScale; offset; offsetUnit

Definition at line 999 of file qgsfillsymbollayer.h.

◆ offsetUnit()

Qgis::RenderUnit QgsRasterFillSymbolLayer::offsetUnit ( ) const

inline

Returns the units for the fill's offset.

Returns: units for offset

See also: setOffsetUnit; offset; offsetMapUnitScale

Definition at line 981 of file qgsfillsymbollayer.h.

◆ opacity()

double QgsRasterFillSymbolLayer::opacity ( ) const

inline

Returns the opacity for the raster image used in the fill.

Returns: opacity value between 0 (fully transparent) and 1 (fully opaque)

See also: setOpacity()

Definition at line 945 of file qgsfillsymbollayer.h.

◆ properties()

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

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 5287 of file qgsfillsymbollayer.cpp.

◆ renderPolygon()

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

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 5239 of file qgsfillsymbollayer.cpp.

◆ resolvePaths()

void QgsRasterFillSymbolLayer::resolvePaths	(	QVariantMap &	properties,
		const QgsPathResolver &	pathResolver,
		bool	saving
	)

static

Turns relative paths in properties map to absolute when reading and vice versa when writing.

Used internally when reading/writing symbols.

Definition at line 5211 of file qgsfillsymbollayer.cpp.

◆ setCoordinateMode()

void QgsRasterFillSymbolLayer::setCoordinateMode ( Qgis::SymbolCoordinateReference mode )

Set the coordinate mode for fill.

Controls how the top left corner of the image fill is positioned relative to the feature.

Parameters

mode	coordinate mode

See also: coordinateMode

Definition at line 5353 of file qgsfillsymbollayer.cpp.

◆ setHeight()

void QgsRasterFillSymbolLayer::setHeight ( double height )

inline

Sets the height for scaling the image.

If height is 0 then the height will be calculated automatically based on the image's width().

See also: setWidth(); height(); width()

Since: QGIS 3.36

Definition at line 1037 of file qgsfillsymbollayer.h.

◆ setImageFilePath()

void QgsRasterFillSymbolLayer::setImageFilePath ( const QString & imagePath )

Sets the path to the raster image used for the fill.

Parameters

imagePath path to image file

See also: imageFilePath

Definition at line 5348 of file qgsfillsymbollayer.cpp.

◆ setOffset()

void QgsRasterFillSymbolLayer::setOffset ( QPointF offset )

inline

Sets the offset for the fill.

Parameters

offset offset for fill

See also: offset; setOffsetUnit; setOffsetMapUnitScale

Definition at line 954 of file qgsfillsymbollayer.h.

◆ setOffsetMapUnitScale()

void QgsRasterFillSymbolLayer::setOffsetMapUnitScale ( const QgsMapUnitScale & scale )

inline

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

Parameters

scale map unit scale for offset

See also: offsetMapUnitScale; setOffset; setOffsetUnit

Definition at line 990 of file qgsfillsymbollayer.h.

◆ setOffsetUnit()

void QgsRasterFillSymbolLayer::setOffsetUnit ( const Qgis::RenderUnit unit )

inline

Sets the units for the fill's offset.

Parameters

unit	units for offset

See also: offsetUnit; setOffset; setOffsetMapUnitScale

Definition at line 972 of file qgsfillsymbollayer.h.

◆ setOpacity()

void QgsRasterFillSymbolLayer::setOpacity ( double opacity )

Sets the opacity for the raster image used in the fill.

Parameters

opacity opacity value between 0 (fully transparent) and 1 (fully opaque)

See also: opacity()

Definition at line 5358 of file qgsfillsymbollayer.cpp.

◆ setOutputUnit()

void QgsRasterFillSymbolLayer::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 QgsImageFillSymbolLayer.

Definition at line 5341 of file qgsfillsymbollayer.cpp.

◆ setSizeMapUnitScale()

void QgsRasterFillSymbolLayer::setSizeMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the map unit scale for the image's width and height.

See also: sizeMapUnitScale(); setWidth(); setHeight(); setSizeUnit()

Since: QGIS 3.36

Definition at line 1117 of file qgsfillsymbollayer.h.

◆ setSizeUnit()

void QgsRasterFillSymbolLayer::setSizeUnit ( Qgis::RenderUnit unit )

inline

Sets the unit for the image's width and height.

See also: widthUnit(); setWidth(); setWidthMapUnitScale()

Since: QGIS 3.36

Definition at line 1071 of file qgsfillsymbollayer.h.

◆ setSubSymbol()

bool QgsRasterFillSymbolLayer::setSubSymbol ( QgsSymbol * symbol )

overridevirtual

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

Reimplemented from QgsSymbolLayer.

Definition at line 5223 of file qgsfillsymbollayer.cpp.

◆ setWidth()

void QgsRasterFillSymbolLayer::setWidth ( double width )

inline

Sets the width for scaling the image used in the fill.

If width is 0 then the width will be calculated automatically based on the image's height().

See also: width(); height(); setHeight(); setSizeUnit(); setSizeMapUnitScale()

Definition at line 1012 of file qgsfillsymbollayer.h.

◆ setWidthMapUnitScale()

Q_DECL_DEPRECATED void QgsRasterFillSymbolLayer::setWidthMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the map unit scale for the image's width.

See also: widthMapUnitScale(); setWidth(); setWidthUnit()

Deprecated:: QGIS 3.40. Use setSizeMapUnitScale() instead.

Definition at line 1105 of file qgsfillsymbollayer.h.

◆ setWidthUnit()

Q_DECL_DEPRECATED void QgsRasterFillSymbolLayer::setWidthUnit ( Qgis::RenderUnit unit )

inline

Sets the unit for the image's width.

See also: widthUnit(); setWidth(); setWidthMapUnitScale()

Deprecated:: QGIS 3.40. Use setSizeUnit() instead.

Definition at line 1060 of file qgsfillsymbollayer.h.

◆ sizeMapUnitScale()

const QgsMapUnitScale & QgsRasterFillSymbolLayer::sizeMapUnitScale ( ) const

inline

Returns the map unit scale for the image's width and height.

See also: setSizeMapUnitScale(); width(); height(); sizeUnit()

Since: QGIS 3.36

Definition at line 1140 of file qgsfillsymbollayer.h.

◆ sizeUnit()

Qgis::RenderUnit QgsRasterFillSymbolLayer::sizeUnit ( ) const

inline

Returns the units for the image's width and height.

See also: setSizeUnit(); width(); height(); sizeMapUnitScale()

Since: QGIS 3.36

Definition at line 1094 of file qgsfillsymbollayer.h.

◆ startRender()

void QgsRasterFillSymbolLayer::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 5277 of file qgsfillsymbollayer.cpp.

◆ stopRender()

void QgsRasterFillSymbolLayer::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 5282 of file qgsfillsymbollayer.cpp.

◆ subSymbol()

QgsSymbol * QgsRasterFillSymbolLayer::subSymbol ( )

inlineoverridevirtual

Returns the symbol's sub symbol, if present.

Reimplemented from QgsSymbolLayer.

Definition at line 900 of file qgsfillsymbollayer.h.

◆ usesMapUnits()

bool QgsRasterFillSymbolLayer::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 5330 of file qgsfillsymbollayer.cpp.

◆ width()

double QgsRasterFillSymbolLayer::width ( ) const

inline

Returns the width used for scaling the image used in the fill.

If the width is 0 then the width will be calculated automatically based on the image's height().

See also: height(); setWidth(); sizeUnit(); sizeMapUnitScale()

Definition at line 1024 of file qgsfillsymbollayer.h.

◆ widthMapUnitScale()

Q_DECL_DEPRECATED const QgsMapUnitScale & QgsRasterFillSymbolLayer::widthMapUnitScale ( ) const

inline

Returns the map unit scale for the image's width.

See also: setWidthMapUnitScale(); width(); widthUnit()

Deprecated:: QGIS 3.40. Use sizeMapUnitScale() instead.

Definition at line 1128 of file qgsfillsymbollayer.h.

◆ widthUnit()

Q_DECL_DEPRECATED Qgis::RenderUnit QgsRasterFillSymbolLayer::widthUnit ( ) const

inline

Returns the units for the image's width.

See also: setWidthUnit(); width(); widthMapUnitScale()

Deprecated:: QGIS 3.40. Use sizeUnit() instead.

Definition at line 1082 of file qgsfillsymbollayer.h.

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

/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/symbology/qgsfillsymbollayer.h
/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/symbology/qgsfillsymbollayer.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsRasterFillSymbolLayer()

◆ ~QgsRasterFillSymbolLayer()

Member Function Documentation

◆ applyBrushTransformFromContext()

◆ applyDataDefinedSettings()

◆ clone()

◆ color()

◆ coordinateMode()

◆ create()

◆ createFromSld()

◆ estimateMaxBleed()

◆ flags()

◆ height()

◆ imageFilePath()

◆ layerType()

◆ offset()

◆ offsetMapUnitScale()

◆ offsetUnit()

◆ opacity()

◆ properties()

◆ renderPolygon()

◆ resolvePaths()

◆ setCoordinateMode()

◆ setHeight()

◆ setImageFilePath()

◆ setOffset()

◆ setOffsetMapUnitScale()

◆ setOffsetUnit()

◆ setOpacity()

◆ setOutputUnit()

◆ setSizeMapUnitScale()

◆ setSizeUnit()

◆ setSubSymbol()

◆ setWidth()

◆ setWidthMapUnitScale()

◆ setWidthUnit()

◆ sizeMapUnitScale()

◆ sizeUnit()

◆ startRender()

◆ stopRender()

◆ subSymbol()

◆ usesMapUnits()

◆ width()

◆ widthMapUnitScale()

◆ widthUnit()