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

#include <qgsfillsymbollayerv2.h>

Inheritance diagram for QgsRasterFillSymbolLayer:

Public Types
enum	FillCoordinateMode { Feature, Viewport }

Public Member Functions
	QgsRasterFillSymbolLayer (const QString &imageFilePath=QString())

	~QgsRasterFillSymbolLayer ()

double	alpha () const
	The opacity for the raster image used in the fill. More...

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

FillCoordinateMode	coordinateMode () const
	Coordinate mode for fill. More...

virtual double	estimateMaxBleed () const override
	Returns the estimated maximum distance which the layer style will bleed outside the drawn shape. More...

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

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

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

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

QgsSymbolV2::OutputUnit	offsetUnit () const
	Returns the units for the fill's offset. 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	renderPolygon (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolV2RenderContext &context) override

void	setAlpha (const double alpha)
	Sets the opacity for the raster image used in the fill. More...

void	setCoordinateMode (const FillCoordinateMode mode)
	Set the coordinate mode for fill. More...

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

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

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

void	setOffsetUnit (const QgsSymbolV2::OutputUnit unit)
	Sets the units for the fill's offset. More...

virtual bool	setSubSymbol (QgsSymbolV2 *symbol) override
	set layer's subsymbol. takes ownership of the passed symbol More...

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

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

void	setWidthUnit (const QgsSymbolV2::OutputUnit unit)
	Sets the units for the image's width. More...

void	startRender (QgsSymbolV2RenderContext &context) override

void	stopRender (QgsSymbolV2RenderContext &context) override

virtual QgsSymbolV2 *	subSymbol () override

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

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

QgsSymbolV2::OutputUnit	widthUnit () const
	Returns the units for the image's width. More...

Public Member Functions inherited from QgsImageFillSymbolLayer
	QgsImageFillSymbolLayer ()

virtual	~QgsImageFillSymbolLayer ()

virtual QColor	dxfColor (QgsSymbolV2RenderContext &context) const override

virtual Qt::PenStyle	dxfPenStyle () const override

virtual double	dxfWidth (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const override

QgsMapUnitScale	mapUnitScale () const override

const QgsMapUnitScale &	outlineWidthMapUnitScale () const

QgsSymbolV2::OutputUnit	outlineWidthUnit () const

QgsSymbolV2::OutputUnit	outputUnit () const override

void	setMapUnitScale (const QgsMapUnitScale &scale) override

void	setOutlineWidthMapUnitScale (const QgsMapUnitScale &scale)

void	setOutlineWidthUnit (QgsSymbolV2::OutputUnit unit)

void	setOutputUnit (QgsSymbolV2::OutputUnit unit) override

QSet< QString >	usedAttributes () const override
	Returns the set of attributes referenced by the layer. More...

Public Member Functions inherited from QgsFillSymbolLayerV2
double	angle () const

void	drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size) override

void	setAngle (double angle)

Public Member Functions inherited from QgsSymbolLayerV2
virtual	~QgsSymbolLayerV2 ()

virtual QColor	color () const
	The fill color. More...

virtual Q_DECL_DEPRECATED const QgsExpression *	dataDefinedProperty (const QString &property) const
	Returns a data defined expression for a property, if set. More...

virtual Q_DECL_DEPRECATED QString	dataDefinedPropertyString (const QString &property) const
	Returns a data defined expression for a property, if set. More...

virtual QColor	dxfBrushColor (QgsSymbolV2RenderContext &context) const

virtual Qt::BrushStyle	dxfBrushStyle () const

virtual QVector< qreal >	dxfCustomDashPattern (QgsSymbolV2::OutputUnit &unit) const

virtual double	dxfOffset (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const

virtual Q_DECL_DEPRECATED QVariant	evaluateDataDefinedProperty (const QString &property, const QgsFeature feature, const QVariant &defaultVal=QVariant(), bool ok=nullptr) const
	Evaluates the matching data defined property and returns the calculated value. More...

virtual QVariant	evaluateDataDefinedProperty (const QString &property, const QgsSymbolV2RenderContext &context, const QVariant &defaultVal=QVariant(), bool *ok=nullptr) const
	Evaluates the matching data defined property and returns the calculated value. More...

virtual QColor	fillColor () const
	Get fill color. More...

virtual QgsDataDefined *	getDataDefinedProperty (const QString &property) const
	Returns the data defined property corresponding to the specified property key. More...

virtual bool	hasDataDefinedProperties () const
	Checks whether the layer has any associated data defined properties. More...

virtual bool	hasDataDefinedProperty (const QString &property) const
	Checks whether the layer has a matching data defined property and if that property is currently actived. More...

virtual bool	isCompatibleWithSymbol (QgsSymbolV2 *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

virtual QColor	outlineColor () const
	Get outline color. More...

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

virtual void	removeDataDefinedProperties ()
	Removes all data defined properties from the layer and deletes associated objects. More...

virtual void	removeDataDefinedProperty (const QString &property)
	Removes a data defined property from the layer. More...

int	renderingPass () const

virtual void	setColor (const QColor &color)
	The fill color. More...

virtual Q_DECL_DEPRECATED void	setDataDefinedProperty (const QString &property, const QString &expressionString)
	Sets a data defined expression for a property. More...

virtual void	setDataDefinedProperty (const QString &property, QgsDataDefined *dataDefined)
	Sets a data defined property for the layer. More...

virtual void	setFillColor (const QColor &color)
	Set fill color. More...

void	setLocked (bool locked)

virtual void	setOutlineColor (const QColor &color)
	Set outline color. More...

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

void	setRenderingPass (int renderingPass)

virtual void	toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const

QgsSymbolV2::SymbolType	type () const

virtual bool	writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolV2RenderContext context, const QgsFeature f, QPointF shift=QPointF(0.0, 0.0)) const

Static Public Member Functions
static QgsSymbolLayerV2 *	create (const QgsStringMap &properties=QgsStringMap())

Protected Member Functions
void	applyDataDefinedSettings (QgsSymbolV2RenderContext &context) override

Protected Member Functions inherited from QgsFillSymbolLayerV2
	QgsFillSymbolLayerV2 (bool locked=false)

void	_renderPolygon (QPainter p, const QPolygonF &points, const QList< QPolygonF > rings, QgsSymbolV2RenderContext &context)
	Default method to render polygon. More...

Protected Member Functions inherited from QgsSymbolLayerV2
	QgsSymbolLayerV2 (QgsSymbolV2::SymbolType type, bool locked=false)

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

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

virtual Q_DECL_DEPRECATED QgsExpression *	expression (const QString &property) const
	Returns the data defined expression associated with a property. More...

virtual Q_DECL_DEPRECATED void	prepareExpressions (const QgsFields *fields, double scale=-1.0)
	Prepares all data defined property expressions for evaluation. More...

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

void	restoreDataDefinedProperties (const QgsStringMap &stringMap)
	Restores all data defined properties from string map. More...

void	saveDataDefinedProperties (QgsStringMap &stringMap) const
	Saves all data defined properties to a string map. More...

Protected Attributes
double	mAlpha

FillCoordinateMode	mCoordinateMode

QString	mImageFilePath
	Path to the image file. More...

QPointF	mOffset

QgsMapUnitScale	mOffsetMapUnitScale

QgsSymbolV2::OutputUnit	mOffsetUnit

double	mWidth

QgsMapUnitScale	mWidthMapUnitScale

QgsSymbolV2::OutputUnit	mWidthUnit

Protected Attributes inherited from QgsImageFillSymbolLayer
QBrush	mBrush

double	mNextAngle

QgsLineSymbolV2 *	mOutline
	Custom outline. More...

double	mOutlineWidth
	Outline width. More...

QgsMapUnitScale	mOutlineWidthMapUnitScale

QgsSymbolV2::OutputUnit	mOutlineWidthUnit

Protected Attributes inherited from QgsFillSymbolLayerV2
double	mAngle

Protected Attributes inherited from QgsSymbolLayerV2
QColor	mColor

QMap< QString, QgsDataDefined * >	mDataDefinedProperties

QgsFields	mFields

bool	mLocked

QgsPaintEffect *	mPaintEffect

int	mRenderingPass

QgsSymbolV2::SymbolType	mType

Additional Inherited Members
Static Protected Attributes inherited from QgsSymbolLayerV2
static const QString	EXPR_ALPHA

static const QString	EXPR_ANGLE

static const QString	EXPR_BLUR_RADIUS

static const QString	EXPR_BORDER_COLOR

static const QString	EXPR_BORDER_STYLE

static const QString	EXPR_CAPSTYLE

static const QString	EXPR_CHAR

static const QString	EXPR_COLOR

static const QString	EXPR_COLOR2

static const QString	EXPR_COLOR_BORDER

static const QString	EXPR_COORDINATE_MODE

static const QString	EXPR_CUSTOMDASH

static const QString	EXPR_DISPLACEMENT_X

static const QString	EXPR_DISPLACEMENT_Y

static const QString	EXPR_DISTANCE

static const QString	EXPR_DISTANCE_X

static const QString	EXPR_DISTANCE_Y

static const QString	EXPR_FILE

static const QString	EXPR_FILL

static const QString	EXPR_FILL_COLOR

static const QString	EXPR_FILL_STYLE

static const QString	EXPR_GRADIENT_TYPE

static const QString	EXPR_HEIGHT

static const QString	EXPR_HORIZONTAL_ANCHOR_POINT

static const QString	EXPR_IGNORE_RINGS

static const QString	EXPR_INTERVAL

static const QString	EXPR_JOIN_STYLE

static const QString	EXPR_JOINSTYLE

static const QString	EXPR_LINE_STYLE

static const QString	EXPR_LINEANGLE

static const QString	EXPR_LINEWIDTH

static const QString	EXPR_MAX_DISTANCE

static const QString	EXPR_NAME

static const QString	EXPR_OFFSET

static const QString	EXPR_OFFSET_ALONG_LINE

static const QString	EXPR_OUTLINE

static const QString	EXPR_OUTLINE_COLOR

static const QString	EXPR_OUTLINE_STYLE

static const QString	EXPR_OUTLINE_WIDTH

static const QString	EXPR_PLACEMENT

static const QString	EXPR_REFERENCE1_ISCENTROID

static const QString	EXPR_REFERENCE1_X

static const QString	EXPR_REFERENCE1_Y

static const QString	EXPR_REFERENCE2_ISCENTROID

static const QString	EXPR_REFERENCE2_X

static const QString	EXPR_REFERENCE2_Y

static const QString	EXPR_ROTATION

static const QString	EXPR_SIZE

static const QString	EXPR_SPREAD

static const QString	EXPR_SVG_FILE

static const QString	EXPR_SVG_FILL_COLOR

static const QString	EXPR_SVG_OUTLINE_COLOR

static const QString	EXPR_SVG_OUTLINE_WIDTH

static const QString	EXPR_SYMBOL_NAME

static const QString	EXPR_USE_WHOLE_SHAPE

static const QString	EXPR_VERTICAL_ANCHOR_POINT

static const QString	EXPR_WIDTH

static const QString	EXPR_WIDTH_BORDER

static const bool	selectFillBorder = false

static const bool	selectFillStyle = false

static const bool	selectionIsOpaque = true

Detailed Description

A class for filling symbols with a repeated raster image.

Note: Added in version 2.7

Definition at line 596 of file qgsfillsymbollayerv2.h.

Member Enumeration Documentation

enum QgsRasterFillSymbolLayer::FillCoordinateMode

Enumerator
Feature
Viewport

Definition at line 600 of file qgsfillsymbollayerv2.h.

Constructor & Destructor Documentation

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

Definition at line 3536 of file qgsfillsymbollayerv2.cpp.

QgsRasterFillSymbolLayer::~QgsRasterFillSymbolLayer ( )

Definition at line 3548 of file qgsfillsymbollayerv2.cpp.

Member Function Documentation

double QgsRasterFillSymbolLayer::alpha ( ) const

inline

The opacity for the raster image used in the fill.

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

See also: setAlpha

Definition at line 657 of file qgsfillsymbollayerv2.h.

void QgsRasterFillSymbolLayer::applyDataDefinedSettings ( QgsSymbolV2RenderContext & context )

overrideprotectedvirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 3720 of file qgsfillsymbollayerv2.cpp.

QgsRasterFillSymbolLayer * QgsRasterFillSymbolLayer::clone ( ) const

overridevirtual

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

Implements QgsSymbolLayerV2.

Definition at line 3683 of file qgsfillsymbollayerv2.cpp.

FillCoordinateMode 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 646 of file qgsfillsymbollayerv2.h.

QgsSymbolLayerV2 * QgsRasterFillSymbolLayer::create ( const QgsStringMap & properties = QgsStringMap() )

static

Definition at line 3553 of file qgsfillsymbollayerv2.cpp.

double QgsRasterFillSymbolLayer::estimateMaxBleed ( ) const

overridevirtual

Returns the estimated maximum distance which the layer style will bleed outside the drawn shape.

Eg, polygons drawn with an outline will draw half the width of the outline outside of the polygon. This amount is estimated, since it may be affected by data defined symbology rules.

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 3700 of file qgsfillsymbollayerv2.cpp.

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 633 of file qgsfillsymbollayerv2.h.

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 QgsSymbolLayerV2.

Definition at line 3620 of file qgsfillsymbollayerv2.cpp.

QPointF QgsRasterFillSymbolLayer::offset ( ) const

inline

Returns the offset for the fill.

Returns: offset for fill

See also: setOffset; offsetUnit; offsetMapUnitScale

Definition at line 672 of file qgsfillsymbollayerv2.h.

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 702 of file qgsfillsymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsRasterFillSymbolLayer::offsetUnit ( ) const

inline

Returns the units for the fill's offset.

Returns: units for offset

See also: setOffsetUnit; offset; offsetMapUnitScale

Definition at line 687 of file qgsfillsymbollayerv2.h.

QgsStringMap 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.

Implements QgsSymbolLayerV2.

Definition at line 3665 of file qgsfillsymbollayerv2.cpp.

void QgsRasterFillSymbolLayer::renderPolygon	(	const QPolygonF &	points,
		QList< QPolygonF > *	rings,
		QgsSymbolV2RenderContext &	context
	)

overridevirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 3625 of file qgsfillsymbollayerv2.cpp.

void QgsRasterFillSymbolLayer::setAlpha ( const double alpha )

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

Parameters

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

See also: alpha

Definition at line 3715 of file qgsfillsymbollayerv2.cpp.

void QgsRasterFillSymbolLayer::setCoordinateMode ( const FillCoordinateMode 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 3710 of file qgsfillsymbollayerv2.cpp.

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 3705 of file qgsfillsymbollayerv2.cpp.

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 665 of file qgsfillsymbollayerv2.h.

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 695 of file qgsfillsymbollayerv2.h.

void QgsRasterFillSymbolLayer::setOffsetUnit ( const QgsSymbolV2::OutputUnit unit )

inline

Sets the units for the fill's offset.

Parameters

unit	units for offset

See also: offsetUnit; setOffset; setOffsetMapUnitScale

Definition at line 680 of file qgsfillsymbollayerv2.h.

bool QgsRasterFillSymbolLayer::setSubSymbol ( QgsSymbolV2 * symbol )

overridevirtual

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

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 3614 of file qgsfillsymbollayerv2.cpp.

void QgsRasterFillSymbolLayer::setWidth ( const double width )

inline

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

The image's height will also be scaled to maintain the image's aspect ratio.

Parameters

width width for scaling the image

See also: width; setWidthUnit; setWidthMapUnitScale

Definition at line 711 of file qgsfillsymbollayerv2.h.

void QgsRasterFillSymbolLayer::setWidthMapUnitScale ( const QgsMapUnitScale & scale )

inline

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

Parameters

scale map unit scale for width

See also: widthMapUnitScale; setWidth; setWidthUnit

Definition at line 742 of file qgsfillsymbollayerv2.h.

void QgsRasterFillSymbolLayer::setWidthUnit ( const QgsSymbolV2::OutputUnit unit )

inline

Sets the units for the image's width.

Parameters

unit	units for width

See also: widthUnit; setWidth; setWidthMapUnitScale

Definition at line 727 of file qgsfillsymbollayerv2.h.

void QgsRasterFillSymbolLayer::startRender ( QgsSymbolV2RenderContext & context )

overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 3654 of file qgsfillsymbollayerv2.cpp.

void QgsRasterFillSymbolLayer::stopRender ( QgsSymbolV2RenderContext & context )

overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 3660 of file qgsfillsymbollayerv2.cpp.

virtual QgsSymbolV2* QgsRasterFillSymbolLayer::subSymbol ( )

inlineoverridevirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 621 of file qgsfillsymbollayerv2.h.

double QgsRasterFillSymbolLayer::width ( ) const

inline

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

The image's height is scaled to maintain the image's aspect ratio.

Returns: width used for scaling the image

See also: setWidth; widthUnit; widthMapUnitScale

Definition at line 719 of file qgsfillsymbollayerv2.h.

const QgsMapUnitScale& QgsRasterFillSymbolLayer::widthMapUnitScale ( ) const

inline

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

Returns: map unit scale for width

See also: setWidthMapUnitScale; width; widthUnit

Definition at line 749 of file qgsfillsymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsRasterFillSymbolLayer::widthUnit ( ) const

inline

Returns the units for the image's width.

Returns: units for width

See also: setWidthUnit; width; widthMapUnitScale

Definition at line 734 of file qgsfillsymbollayerv2.h.

Member Data Documentation

double QgsRasterFillSymbolLayer::mAlpha

protected

Definition at line 756 of file qgsfillsymbollayerv2.h.

FillCoordinateMode QgsRasterFillSymbolLayer::mCoordinateMode

protected

Definition at line 755 of file qgsfillsymbollayerv2.h.

QString QgsRasterFillSymbolLayer::mImageFilePath

protected

Path to the image file.

Definition at line 754 of file qgsfillsymbollayerv2.h.

QPointF QgsRasterFillSymbolLayer::mOffset

protected

Definition at line 758 of file qgsfillsymbollayerv2.h.

QgsMapUnitScale QgsRasterFillSymbolLayer::mOffsetMapUnitScale

protected

Definition at line 760 of file qgsfillsymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsRasterFillSymbolLayer::mOffsetUnit

protected

Definition at line 759 of file qgsfillsymbollayerv2.h.

double QgsRasterFillSymbolLayer::mWidth

protected

Definition at line 762 of file qgsfillsymbollayerv2.h.

QgsMapUnitScale QgsRasterFillSymbolLayer::mWidthMapUnitScale

protected

Definition at line 764 of file qgsfillsymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsRasterFillSymbolLayer::mWidthUnit

protected

Definition at line 763 of file qgsfillsymbollayerv2.h.

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

/tmp/buildd/qgis-2.14.0+99unstable/src/core/symbology-ng/qgsfillsymbollayerv2.h
/tmp/buildd/qgis-2.14.0+99unstable/src/core/symbology-ng/qgsfillsymbollayerv2.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation