#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsShapeburstFillSymbolLayer:

Public Types
enum	ShapeburstColorType { SimpleTwoColor, ColorRamp }

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

Public Member Functions
	QgsShapeburstFillSymbolLayer (const QColor &color=DEFAULT_SIMPLEFILL_COLOR, const QColor &color2=Qt::white, ShapeburstColorType colorType=SimpleTwoColor, int blurRadius=0, bool useWholeShape=true, double maxDistance=5)

	~QgsShapeburstFillSymbolLayer () override

int	blurRadius () const
	Returns the blur radius, which controls the amount of blurring applied to the fill. More...

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

QColor	color2 () const
	Returns the color used for the endpoint of the shapeburst fill. More...

QgsColorRamp *	colorRamp ()
	Returns the color ramp used for the shapeburst fill. More...

ShapeburstColorType	colorType () const
	Returns the color mode used for the shapeburst fill. More...

const QgsMapUnitScale &	distanceMapUnitScale () const

QgsUnitTypes::RenderUnit	distanceUnit () const
	Returns the unit for the maximum distance to shade inside of the shape from the polygon's boundary. 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	ignoreRings () const
	Returns whether the shapeburst fill is set to ignore polygon interior rings. More...

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

QgsMapUnitScale	mapUnitScale () const override

double	maxDistance () const
	Returns the maximum distance from the shape's boundary which is shaded. More...

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

const QgsMapUnitScale &	offsetMapUnitScale () const

QgsUnitTypes::RenderUnit	offsetUnit () const
	Returns the units used for the offset of the shapeburst fill. More...

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	renderPolygon (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolRenderContext &context) override

void	setBlurRadius (int blurRadius)
	Sets the blur radius, which controls the amount of blurring applied to the fill. More...

void	setColor2 (const QColor &color2)
	Sets the color for the endpoint of the shapeburst fill. More...

void	setColorRamp (QgsColorRamp *ramp)
	Sets the color ramp used to draw the shapeburst fill. More...

void	setColorType (ShapeburstColorType colorType)
	Sets the color mode to use for the shapeburst fill. More...

void	setDistanceMapUnitScale (const QgsMapUnitScale &scale)

void	setDistanceUnit (QgsUnitTypes::RenderUnit unit)
	Sets the unit for the maximum distance to shade inside of the shape from the polygon's boundary. More...

void	setIgnoreRings (bool ignoreRings)
	Sets whether the shapeburst fill should ignore polygon rings when calculating the buffered shading. More...

void	setMapUnitScale (const QgsMapUnitScale &scale) override

void	setMaxDistance (double maxDistance)
	Sets the maximum distance to shape inside of the shape from the polygon's boundary. More...

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

void	setOffsetMapUnitScale (const QgsMapUnitScale &scale)

void	setOffsetUnit (QgsUnitTypes::RenderUnit unit)
	Sets the units used for the offset for the shapeburst fill. More...

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

void	setUseWholeShape (bool useWholeShape)
	Sets whether the shapeburst fill should be drawn using the entire shape. More...

void	startRender (QgsSymbolRenderContext &context) override

void	stopRender (QgsSymbolRenderContext &context) override

bool	useWholeShape () const
	Returns whether the shapeburst fill is set to cover the entire shape. 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 ()

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

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
	get angle More...

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

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

virtual QColor	dxfColor (QgsSymbolRenderContext &context) const
	get color More...

virtual QVector< qreal >	dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const
	get dash pattern More...

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

virtual Qt::PenStyle	dxfPenStyle () const
	get pen style More...

virtual double	dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
	get line width More...

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

virtual QColor	fillColor () const
	Get 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

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

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

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

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

virtual void	setFillColor (const QColor &color)
	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 bool	setSubSymbol (QgsSymbol *symbol)
	set layer's subsymbol. takes ownership of the passed symbol More...

virtual QColor	strokeColor () const
	Get stroke color. More...

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

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

QgsSymbol::SymbolType	type () const

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

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

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

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

Protected Attributes
int	mBlurRadius

QBrush	mBrush

QColor	mColor2

ShapeburstColorType	mColorType

QgsMapUnitScale	mDistanceMapUnitScale

QgsUnitTypes::RenderUnit	mDistanceUnit = QgsUnitTypes::RenderMillimeters

QgsColorRamp *	mGradientRamp = nullptr

bool	mIgnoreRings = false

double	mMaxDistance

QPointF	mOffset

QgsMapUnitScale	mOffsetMapUnitScale

QgsUnitTypes::RenderUnit	mOffsetUnit = QgsUnitTypes::RenderMillimeters

QBrush	mSelBrush

QgsColorRamp *	mTwoColorGradientRamp = nullptr

bool	mUseWholeShape

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

Additional Inherited Members
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...

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

Definition at line 339 of file qgsfillsymbollayer.h.

Member Enumeration Documentation

◆ ShapeburstColorType

enum QgsShapeburstFillSymbolLayer::ShapeburstColorType

Enumerator
SimpleTwoColor
ColorRamp

Definition at line 343 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsShapeburstFillSymbolLayer()

QgsShapeburstFillSymbolLayer::QgsShapeburstFillSymbolLayer	(	const QColor &	color = `DEFAULT_SIMPLEFILL_COLOR`,
		const QColor &	color2 = `Qt::white`,
		ShapeburstColorType	colorType = `SimpleTwoColor`,
		int	blurRadius = `0`,
		bool	useWholeShape = `true`,
		double	maxDistance = `5`
	)

Definition at line 939 of file qgsfillsymbollayer.cpp.

◆ ~QgsShapeburstFillSymbolLayer()

QgsShapeburstFillSymbolLayer::~QgsShapeburstFillSymbolLayer ( )

override

Definition at line 950 of file qgsfillsymbollayer.cpp.

Member Function Documentation

◆ blurRadius()

int QgsShapeburstFillSymbolLayer::blurRadius ( ) const

inline

Returns the blur radius, which controls the amount of blurring applied to the fill.

Returns: Integer representing the radius for fill blur. Higher values indicate a stronger blur. A 0 value indicates that blurring is disabled.

Since: QGIS 2.3

See also: setBlurRadius

Definition at line 389 of file qgsfillsymbollayer.h.

◆ clone()

QgsShapeburstFillSymbolLayer * QgsShapeburstFillSymbolLayer::clone ( ) const

overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 1484 of file qgsfillsymbollayer.cpp.

◆ color2()

QColor QgsShapeburstFillSymbolLayer::color2 ( ) const

inline

Returns the color used for the endpoint of the shapeburst fill.

This color is only used if the colorType is set to ShapeburstColorType::SimpleTwoColor

Returns: a QColor indicating the color of the endpoint of the gradient

Since: QGIS 2.3

See also: setColor2; colorType

Definition at line 509 of file qgsfillsymbollayer.h.

◆ colorRamp()

QgsColorRamp* QgsShapeburstFillSymbolLayer::colorRamp ( )

inline

Returns the color ramp used for the shapeburst fill.

The color ramp is only used if the colorType is set to ShapeburstColorType::ColorRamp

Returns: a QgsColorRamp color ramp

Since: QGIS 2.3

See also: setColorRamp; colorType

Definition at line 491 of file qgsfillsymbollayer.h.

◆ colorType()

ShapeburstColorType QgsShapeburstFillSymbolLayer::colorType ( ) const

inline

Returns the color mode used for the shapeburst fill.

Shapeburst can either be drawn using a QgsColorRamp color ramp or by simply specificing a start and end color.

Returns: current color mode used for the shapeburst fill

Since: QGIS 2.3

See also: setColorType; color; color2; colorRamp

Definition at line 473 of file qgsfillsymbollayer.h.

◆ create()

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

static

Definition at line 955 of file qgsfillsymbollayer.cpp.

◆ distanceMapUnitScale()

const QgsMapUnitScale& QgsShapeburstFillSymbolLayer::distanceMapUnitScale ( ) const

inline

Definition at line 449 of file qgsfillsymbollayer.h.

◆ distanceUnit()

QgsUnitTypes::RenderUnit QgsShapeburstFillSymbolLayer::distanceUnit ( ) const

inline

Returns the unit for the maximum distance to shade inside of the shape from the polygon's boundary.

Returns: distance unit for the maximum distance

Since: QGIS 2.3

See also: maxDistance; setDistanceUnit

Definition at line 446 of file qgsfillsymbollayer.h.

◆ estimateMaxBleed()

double QgsShapeburstFillSymbolLayer::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 1502 of file qgsfillsymbollayer.cpp.

◆ ignoreRings()

bool QgsShapeburstFillSymbolLayer::ignoreRings ( ) const

inline

Returns whether the shapeburst fill is set to ignore polygon interior rings.

Returns: True if the shapeburst fill will ignore interior rings when calculating buffered shading.

Since: QGIS 2.3

See also: setIgnoreRings

Definition at line 526 of file qgsfillsymbollayer.h.

◆ layerType()

QString QgsShapeburstFillSymbolLayer::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 1050 of file qgsfillsymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsShapeburstFillSymbolLayer::mapUnitScale ( ) const

overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 1529 of file qgsfillsymbollayer.cpp.

◆ maxDistance()

double QgsShapeburstFillSymbolLayer::maxDistance ( ) const

inline

Returns the maximum distance from the shape's boundary which is shaded.

This parameter is only effective if useWholeShape is false.

Returns: the maximum distance from the polygon's boundary which is shaded. Distance units are indicated by distanceUnit.

Since: QGIS 2.3

See also: useWholeShape; setMaxDistance; distanceUnit

Definition at line 428 of file qgsfillsymbollayer.h.

◆ offset()

QPointF QgsShapeburstFillSymbolLayer::offset ( ) const

inline

Returns the offset for the shapeburst fill.

Returns: a QPointF indicating the horizontal/vertical offset amount

Since: QGIS 2.3

See also: setOffset; offsetUnit

Definition at line 544 of file qgsfillsymbollayer.h.

◆ offsetMapUnitScale()

const QgsMapUnitScale& QgsShapeburstFillSymbolLayer::offsetMapUnitScale ( ) const

inline

Definition at line 565 of file qgsfillsymbollayer.h.

◆ offsetUnit()

QgsUnitTypes::RenderUnit QgsShapeburstFillSymbolLayer::offsetUnit ( ) const

inline

Returns the units used for the offset of the shapeburst fill.

Returns: units used for the fill offset

Since: QGIS 2.3

See also: offset; setOffsetUnit

Definition at line 562 of file qgsfillsymbollayer.h.

◆ outputUnit()

QgsUnitTypes::RenderUnit QgsShapeburstFillSymbolLayer::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 1514 of file qgsfillsymbollayer.cpp.

◆ properties()

QgsStringMap QgsShapeburstFillSymbolLayer::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 1461 of file qgsfillsymbollayer.cpp.

◆ renderPolygon()

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

overridevirtual

Implements QgsFillSymbolLayer.

Definition at line 1128 of file qgsfillsymbollayer.cpp.

◆ setBlurRadius()

void QgsShapeburstFillSymbolLayer::setBlurRadius ( int blurRadius )

inline

Sets the blur radius, which controls the amount of blurring applied to the fill.

Parameters

blurRadius Radius for fill blur. Values between 0 - 17 are valid, where higher values results in a stronger blur. Set to 0 to disable blur.

Since: QGIS 2.3

See also: blurRadius

Definition at line 381 of file qgsfillsymbollayer.h.

◆ setColor2()

void QgsShapeburstFillSymbolLayer::setColor2 ( const QColor & color2 )

inline

Sets the color for the endpoint of the shapeburst fill.

This color is only used if setColorType is set ShapeburstColorType::SimpleTwoColor.

Parameters

color2 QColor to use for endpoint of gradient

Since: QGIS 2.3

See also: setColorType; color2

Definition at line 500 of file qgsfillsymbollayer.h.

◆ setColorRamp()

void QgsShapeburstFillSymbolLayer::setColorRamp ( QgsColorRamp * ramp )

Sets the color ramp used to draw the shapeburst fill.

Color ramps are only used if setColorType is set ShapeburstColorType::ColorRamp.

Parameters

ramp	color ramp to use for shapeburst fill

Since: QGIS 2.3

See also: setColorType; colorRamp

Definition at line 1055 of file qgsfillsymbollayer.cpp.

◆ setColorType()

void QgsShapeburstFillSymbolLayer::setColorType ( ShapeburstColorType colorType )

inline

Sets the color mode to use for the shapeburst fill.

Shapeburst can either be drawn using a QgsColorRamp color ramp or by simply specificing a start and end color. setColorType is used to specify which mode to use for the fill.

Parameters

colorType color type to use for shapeburst fill

Since: QGIS 2.3

See also: colorType; setColor; setColor2; setColorRamp

Definition at line 461 of file qgsfillsymbollayer.h.

◆ setDistanceMapUnitScale()

void QgsShapeburstFillSymbolLayer::setDistanceMapUnitScale ( const QgsMapUnitScale & scale )

inline

Definition at line 448 of file qgsfillsymbollayer.h.

◆ setDistanceUnit()

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

inline

Sets the unit for the maximum distance to shade inside of the shape from the polygon's boundary.

Parameters

unit	distance unit for the maximum distance

Since: QGIS 2.3

See also: setMaxDistance; distanceUnit

Definition at line 437 of file qgsfillsymbollayer.h.

◆ setIgnoreRings()

void QgsShapeburstFillSymbolLayer::setIgnoreRings ( bool ignoreRings )

inline

Sets whether the shapeburst fill should ignore polygon rings when calculating the buffered shading.

Parameters

ignoreRings Set to true if buffers should ignore interior rings for polygons.

Since: QGIS 2.3

See also: ignoreRings

Definition at line 518 of file qgsfillsymbollayer.h.

◆ setMapUnitScale()

void QgsShapeburstFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale & scale )

overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 1523 of file qgsfillsymbollayer.cpp.

◆ setMaxDistance()

void QgsShapeburstFillSymbolLayer::setMaxDistance ( double maxDistance )

inline

Sets the maximum distance to shape inside of the shape from the polygon's boundary.

Parameters

maxDistance distance from boundary to shade. setUseWholeShape must be set to false for this parameter to take effect. Distance unit is controlled by setDistanceUnit.

Since: QGIS 2.3

See also: maxDistance; setUseWholeShape; setDistanceUnit

Definition at line 418 of file qgsfillsymbollayer.h.

◆ setOffset()

void QgsShapeburstFillSymbolLayer::setOffset ( QPointF offset )

inline

Sets the offset for the shapeburst fill.

Parameters

offset QPointF indicating the horizontal/vertical offset amount

Since: QGIS 2.3

See also: offset; setOffsetUnit

Definition at line 535 of file qgsfillsymbollayer.h.

◆ setOffsetMapUnitScale()

void QgsShapeburstFillSymbolLayer::setOffsetMapUnitScale ( const QgsMapUnitScale & scale )

inline

Definition at line 564 of file qgsfillsymbollayer.h.

◆ setOffsetUnit()

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

inline

Sets the units used for the offset for the shapeburst fill.

Parameters

unit	units for fill offset

Since: QGIS 2.3

See also: setOffset; offsetUnit

Definition at line 553 of file qgsfillsymbollayer.h.

◆ setOutputUnit()

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

unit	output units

See also: outputUnit()

Reimplemented from QgsSymbolLayer.

Definition at line 1508 of file qgsfillsymbollayer.cpp.

◆ setUseWholeShape()

void QgsShapeburstFillSymbolLayer::setUseWholeShape ( bool useWholeShape )

inline

Sets whether the shapeburst fill should be drawn using the entire shape.

Parameters

useWholeShape Set to true if shapeburst should cover entire shape. If false, setMaxDistance is used to calculate how far from the boundary of the shape should be shaded

Since: QGIS 2.3

See also: useWholeShape; setMaxDistance

Definition at line 399 of file qgsfillsymbollayer.h.

◆ startRender()

void QgsShapeburstFillSymbolLayer::startRender ( QgsSymbolRenderContext & context )

overridevirtual

Implements QgsSymbolLayer.

Definition at line 1114 of file qgsfillsymbollayer.cpp.

◆ stopRender()

void QgsShapeburstFillSymbolLayer::stopRender ( QgsSymbolRenderContext & context )

overridevirtual

Implements QgsSymbolLayer.

Definition at line 1123 of file qgsfillsymbollayer.cpp.

◆ useWholeShape()

bool QgsShapeburstFillSymbolLayer::useWholeShape ( ) const

inline

Returns whether the shapeburst fill is set to cover the entire shape.

Returns: True if shapeburst fill will cover the entire shape. If false, shapeburst is drawn to a distance of maxDistance from the polygon's boundary.

Since: QGIS 2.3

See also: setUseWholeShape; maxDistance

Definition at line 408 of file qgsfillsymbollayer.h.

Member Data Documentation

◆ mBlurRadius

int QgsShapeburstFillSymbolLayer::mBlurRadius

protected

Definition at line 577 of file qgsfillsymbollayer.h.

◆ mBrush

QBrush QgsShapeburstFillSymbolLayer::mBrush

protected

Definition at line 574 of file qgsfillsymbollayer.h.

◆ mColor2

QColor QgsShapeburstFillSymbolLayer::mColor2

protected

Definition at line 585 of file qgsfillsymbollayer.h.

◆ mColorType

ShapeburstColorType QgsShapeburstFillSymbolLayer::mColorType

protected

Definition at line 584 of file qgsfillsymbollayer.h.

◆ mDistanceMapUnitScale

QgsMapUnitScale QgsShapeburstFillSymbolLayer::mDistanceMapUnitScale

protected

Definition at line 582 of file qgsfillsymbollayer.h.

◆ mDistanceUnit

QgsUnitTypes::RenderUnit QgsShapeburstFillSymbolLayer::mDistanceUnit = QgsUnitTypes::RenderMillimeters

protected

Definition at line 581 of file qgsfillsymbollayer.h.

◆ mGradientRamp

QgsColorRamp* QgsShapeburstFillSymbolLayer::mGradientRamp = nullptr

protected

Definition at line 586 of file qgsfillsymbollayer.h.

◆ mIgnoreRings

bool QgsShapeburstFillSymbolLayer::mIgnoreRings = false

protected

Definition at line 589 of file qgsfillsymbollayer.h.

◆ mMaxDistance

double QgsShapeburstFillSymbolLayer::mMaxDistance

protected

Definition at line 580 of file qgsfillsymbollayer.h.

◆ mOffset

QPointF QgsShapeburstFillSymbolLayer::mOffset

protected

Definition at line 591 of file qgsfillsymbollayer.h.

◆ mOffsetMapUnitScale

QgsMapUnitScale QgsShapeburstFillSymbolLayer::mOffsetMapUnitScale

protected

Definition at line 593 of file qgsfillsymbollayer.h.

◆ mOffsetUnit

QgsUnitTypes::RenderUnit QgsShapeburstFillSymbolLayer::mOffsetUnit = QgsUnitTypes::RenderMillimeters

protected

Definition at line 592 of file qgsfillsymbollayer.h.

◆ mSelBrush

QBrush QgsShapeburstFillSymbolLayer::mSelBrush

protected

Definition at line 575 of file qgsfillsymbollayer.h.

◆ mTwoColorGradientRamp

QgsColorRamp* QgsShapeburstFillSymbolLayer::mTwoColorGradientRamp = nullptr

protected

Definition at line 587 of file qgsfillsymbollayer.h.

◆ mUseWholeShape

bool QgsShapeburstFillSymbolLayer::mUseWholeShape

protected

Definition at line 579 of file qgsfillsymbollayer.h.

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

/tmp/buildd/qgis-3.0.2+14stretch/src/core/symbology/qgsfillsymbollayer.h
/tmp/buildd/qgis-3.0.2+14stretch/src/core/symbology/qgsfillsymbollayer.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ShapeburstColorType

Constructor & Destructor Documentation

◆ QgsShapeburstFillSymbolLayer()

◆ ~QgsShapeburstFillSymbolLayer()

Member Function Documentation

◆ blurRadius()

◆ clone()

◆ color2()

◆ colorRamp()

◆ colorType()

◆ create()

◆ distanceMapUnitScale()

◆ distanceUnit()

◆ estimateMaxBleed()

◆ ignoreRings()

◆ layerType()

◆ mapUnitScale()

◆ maxDistance()

◆ offset()

◆ offsetMapUnitScale()

◆ offsetUnit()

◆ outputUnit()

◆ properties()

◆ renderPolygon()

◆ setBlurRadius()

◆ setColor2()

◆ setColorRamp()

◆ setColorType()

◆ setDistanceMapUnitScale()

◆ setDistanceUnit()

◆ setIgnoreRings()

◆ setMapUnitScale()

◆ setMaxDistance()

◆ setOffset()

◆ setOffsetMapUnitScale()

◆ setOffsetUnit()

◆ setOutputUnit()

◆ setUseWholeShape()

◆ startRender()

◆ stopRender()

◆ useWholeShape()

Member Data Documentation

◆ mBlurRadius

◆ mBrush

◆ mColor2

◆ mColorType

◆ mDistanceMapUnitScale

◆ mDistanceUnit

◆ mGradientRamp

◆ mIgnoreRings

◆ mMaxDistance

◆ mOffset

◆ mOffsetMapUnitScale

◆ mOffsetUnit

◆ mSelBrush

◆ mTwoColorGradientRamp

◆ mUseWholeShape