#include <qgsfillsymbollayerv2.h>

Inheritance diagram for QgsShapeburstFillSymbolLayerV2:

Public Types
enum	ShapeburstColorType { SimpleTwoColor, ColorRamp }

Public Member Functions
	QgsShapeburstFillSymbolLayerV2 (QColor color=DEFAULT_SIMPLEFILL_COLOR, QColor color2=Qt::white, ShapeburstColorType colorType=SimpleTwoColor, int blurRadius=0, bool useWholeShape=true, double maxDistance=5)
virtual	~QgsShapeburstFillSymbolLayerV2 ()
int	blurRadius () const
	Returns the blur radius, which controls the amount of blurring applied to the fill.
QgsSymbolLayerV2 *	clone () const override
QColor	color2 () const
	Returns the color used for the endpoint of the shapeburst fill.
QgsVectorColorRampV2 *	colorRamp ()
	Returns the color ramp used for the shapeburst fill.
ShapeburstColorType	colorType () const
	Returns the color mode used for the shapeburst fill.
const QgsMapUnitScale &	distanceMapUnitScale () const
QgsSymbolV2::OutputUnit	distanceUnit () const
	Returns the unit for the maximum distance to shade inside of the shape from the polygon's boundary.
double	estimateMaxBleed () const override
	Returns the estimated maximum distance which the layer style will bleed outside the drawn shape.
bool	ignoreRings () const
	Returns whether the shapeburst fill is set to ignore polygon interior rings.
QString	layerType () const override
QgsMapUnitScale	mapUnitScale () const override
double	maxDistance () const
	Returns the maximum distance from the shape's boundary which is shaded.
QPointF	offset () const
	Returns the offset for the shapeburst fill.
const QgsMapUnitScale &	offsetMapUnitScale () const
QgsSymbolV2::OutputUnit	offsetUnit () const
	Returns the units used for the offset of the shapeburst fill.
QgsSymbolV2::OutputUnit	outputUnit () const override
QgsStringMap	properties () const override
void	renderPolygon (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolV2RenderContext &context) override
void	setBlurRadius (int blurRadius)
	Sets the blur radius, which controls the amount of blurring applied to the fill.
void	setColor2 (QColor color2)
	Sets the color for the endpoint of the shapeburst fill.
void	setColorRamp (QgsVectorColorRampV2 *ramp)
	Sets the color ramp used to draw the shapeburst fill.
void	setColorType (ShapeburstColorType colorType)
	Sets the color mode to use for the shapeburst fill.
void	setDistanceMapUnitScale (const QgsMapUnitScale &scale)
void	setDistanceUnit (QgsSymbolV2::OutputUnit unit)
	Sets the unit for the maximum distance to shade inside of the shape from the polygon's boundary.
void	setIgnoreRings (bool ignoreRings)
	Sets whether the shapeburst fill should ignore polygon rings when calculating the buffered shading.
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.
void	setOffset (QPointF offset)
	Sets the offset for the shapeburst fill.
void	setOffsetMapUnitScale (const QgsMapUnitScale &scale)
void	setOffsetUnit (QgsSymbolV2::OutputUnit unit)
	Sets the units used for the offset for the shapeburst fill.
void	setOutputUnit (QgsSymbolV2::OutputUnit unit) override
void	setUseWholeShape (bool useWholeShape)
	Sets whether the shapeburst fill should be drawn using the entire shape.
void	startRender (QgsSymbolV2RenderContext &context) override
void	stopRender (QgsSymbolV2RenderContext &context) override
bool	useWholeShape () const
	Returns whether the shapeburst fill is set to cover the entire shape.
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
virtual const QgsExpression *	dataDefinedProperty (const QString &property) const
virtual QString	dataDefinedPropertyString (const QString &property) const
virtual QColor	dxfBrushColor (const QgsSymbolV2RenderContext &context) const
virtual Qt::BrushStyle	dxfBrushStyle () const
virtual QColor	dxfColor (const QgsSymbolV2RenderContext &context) const
virtual QVector< qreal >	dxfCustomDashPattern (QgsSymbolV2::OutputUnit &unit) const
virtual double	dxfOffset (const QgsDxfExport &e, const QgsSymbolV2RenderContext &context) const
virtual Qt::PenStyle	dxfPenStyle () const
virtual double	dxfWidth (const QgsDxfExport &e, const QgsSymbolV2RenderContext &context) const
virtual QColor	fillColor () const
	Get fill color.
bool	hasDataDefinedProperties () const
bool	isLocked () const
virtual QString	ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
virtual QColor	outlineColor () const
	Get outline color.
virtual void	removeDataDefinedProperties ()
virtual void	removeDataDefinedProperty (const QString &property)
int	renderingPass () const
virtual void	setColor (const QColor &color)
virtual void	setDataDefinedProperty (const QString &property, const QString &expressionString)
virtual void	setFillColor (const QColor &color)
	Set fill color.
void	setLocked (bool locked)
virtual void	setOutlineColor (const QColor &color)
	Set outline color.
void	setRenderingPass (int renderingPass)
virtual bool	setSubSymbol (QgsSymbolV2 *symbol)
virtual QgsSymbolV2 *	subSymbol ()
virtual void	toSld (QDomDocument &doc, QDomElement &element, QgsStringMap props) const
QgsSymbolV2::SymbolType	type () const
virtual QSet< QString >	usedAttributes () const
virtual bool	writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, const QgsSymbolV2RenderContext context, const QgsFeature f, const QPointF &shift=QPointF(0.0, 0.0)) const

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

Protected Attributes
int	mBlurRadius
QBrush	mBrush
QColor	mColor2
ShapeburstColorType	mColorType
QgsMapUnitScale	mDistanceMapUnitScale
QgsSymbolV2::OutputUnit	mDistanceUnit
QgsVectorColorRampV2 *	mGradientRamp
bool	mIgnoreRings
double	mMaxDistance
QPointF	mOffset
QgsMapUnitScale	mOffsetMapUnitScale
QgsSymbolV2::OutputUnit	mOffsetUnit
QBrush	mSelBrush
QgsVectorColorRampV2 *	mTwoColorGradientRamp
bool	mUseWholeShape
Protected Attributes inherited from QgsFillSymbolLayerV2
double	mAngle
Protected Attributes inherited from QgsSymbolLayerV2
QColor	mColor
QMap< QString, QgsExpression * >	mDataDefinedProperties
bool	mLocked
int	mRenderingPass
QgsSymbolV2::SymbolType	mType

Additional Inherited Members
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.
Static Protected Attributes inherited from QgsSymbolLayerV2
static const bool	selectFillBorder = false
static const bool	selectFillStyle = false
static const bool	selectionIsOpaque = true

Detailed Description

Definition at line 301 of file qgsfillsymbollayerv2.h.

Member Enumeration Documentation

enum QgsShapeburstFillSymbolLayerV2::ShapeburstColorType

Enumerator:

SimpleTwoColor
ColorRamp

Definition at line 305 of file qgsfillsymbollayerv2.h.

Constructor & Destructor Documentation

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

Definition at line 943 of file qgsfillsymbollayerv2.cpp.

QgsShapeburstFillSymbolLayerV2::~QgsShapeburstFillSymbolLayerV2 ( )

virtual

Definition at line 960 of file qgsfillsymbollayerv2.cpp.

Member Function Documentation

int QgsShapeburstFillSymbolLayerV2::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.

Note: added in 2.3

See Also: setBlurRadius

Definition at line 348 of file qgsfillsymbollayerv2.h.

QgsSymbolLayerV2 * QgsShapeburstFillSymbolLayerV2::clone ( ) const

overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 1493 of file qgsfillsymbollayerv2.cpp.

QColor QgsShapeburstFillSymbolLayerV2::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

Note: added in 2.3

See Also: setColor2; colorType

Definition at line 450 of file qgsfillsymbollayerv2.h.

QgsVectorColorRampV2* QgsShapeburstFillSymbolLayerV2::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 QgsVectorColorRampV2 color ramp

Note: added in 2.3

See Also: setColorRamp; colorType

Definition at line 435 of file qgsfillsymbollayerv2.h.

ShapeburstColorType QgsShapeburstFillSymbolLayerV2::colorType ( ) const

inline

Returns the color mode used for the shapeburst fill.

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

Returns: current color mode used for the shapeburst fill

Note: added in 2.3

See Also: setColorType; color; color2; colorRamp

Definition at line 420 of file qgsfillsymbollayerv2.h.

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

static

Definition at line 965 of file qgsfillsymbollayerv2.cpp.

const QgsMapUnitScale& QgsShapeburstFillSymbolLayerV2::distanceMapUnitScale ( ) const

inline

Definition at line 399 of file qgsfillsymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsShapeburstFillSymbolLayerV2::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

Note: added in 2.3

See Also: maxDistance; setDistanceUnit

Definition at line 396 of file qgsfillsymbollayerv2.h.

double QgsShapeburstFillSymbolLayerV2::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 QgsSymbolLayerV2.

Definition at line 1510 of file qgsfillsymbollayerv2.cpp.

bool QgsShapeburstFillSymbolLayerV2::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.

Note: added in 2.3

See Also: setIgnoreRings

Definition at line 464 of file qgsfillsymbollayerv2.h.

QString QgsShapeburstFillSymbolLayerV2::layerType ( ) const

overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 1063 of file qgsfillsymbollayerv2.cpp.

QgsMapUnitScale QgsShapeburstFillSymbolLayerV2::mapUnitScale ( ) const

overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 1537 of file qgsfillsymbollayerv2.cpp.

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

Note: added in 2.3

See Also: useWholeShape; setMaxDistance; distanceUnit

Definition at line 381 of file qgsfillsymbollayerv2.h.

QPointF QgsShapeburstFillSymbolLayerV2::offset ( ) const

inline

Returns the offset for the shapeburst fill.

Returns: a QPointF indicating the horizontal/vertical offset amount

Note: added in 2.3

See Also: setOffset; offsetUnit

Definition at line 479 of file qgsfillsymbollayerv2.h.

const QgsMapUnitScale& QgsShapeburstFillSymbolLayerV2::offsetMapUnitScale ( ) const

inline

Definition at line 497 of file qgsfillsymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsShapeburstFillSymbolLayerV2::offsetUnit ( ) const

inline

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

Returns: units used for the fill offset

Note: added in 2.3

See Also: offset; setOffsetUnit

Definition at line 494 of file qgsfillsymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsShapeburstFillSymbolLayerV2::outputUnit ( ) const

overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 1522 of file qgsfillsymbollayerv2.cpp.

QgsStringMap QgsShapeburstFillSymbolLayerV2::properties ( ) const

overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 1467 of file qgsfillsymbollayerv2.cpp.

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

overridevirtual

Implements QgsFillSymbolLayerV2.

Definition at line 1130 of file qgsfillsymbollayerv2.cpp.

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

Note: added in 2.3

See Also: blurRadius

Definition at line 342 of file qgsfillsymbollayerv2.h.

void QgsShapeburstFillSymbolLayerV2::setColor2 ( 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

Note: added in 2.3

See Also: setColorType; color2

Definition at line 443 of file qgsfillsymbollayerv2.h.

void QgsShapeburstFillSymbolLayerV2::setColorRamp ( QgsVectorColorRampV2 * 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

Note: added in 2.3

See Also: setColorType; colorRamp

Definition at line 1068 of file qgsfillsymbollayerv2.cpp.

void QgsShapeburstFillSymbolLayerV2::setColorType ( ShapeburstColorType colorType )

inline

Sets the color mode to use for the shapeburst fill.

Shapeburst can either be drawn using a QgsVectorColorRampV2 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

Note: added in 2.3

See Also: colorType; setColor; setColor2; setColorRamp

Definition at line 410 of file qgsfillsymbollayerv2.h.

void QgsShapeburstFillSymbolLayerV2::setDistanceMapUnitScale ( const QgsMapUnitScale & scale )

inline

Definition at line 398 of file qgsfillsymbollayerv2.h.

void QgsShapeburstFillSymbolLayerV2::setDistanceUnit ( QgsSymbolV2::OutputUnit 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

Note: added in 2.3

See Also: setMaxDistance; distanceUnit

Definition at line 389 of file qgsfillsymbollayerv2.h.

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

Note: added in 2.3

See Also: ignoreRings

Definition at line 458 of file qgsfillsymbollayerv2.h.

void QgsShapeburstFillSymbolLayerV2::setMapUnitScale ( const QgsMapUnitScale & scale )

overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 1531 of file qgsfillsymbollayerv2.cpp.

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

Note: added in 2.3

See Also: maxDistance; setUseWholeShape; setDistanceUnit

Definition at line 373 of file qgsfillsymbollayerv2.h.

void QgsShapeburstFillSymbolLayerV2::setOffset ( QPointF offset )

inline

Sets the offset for the shapeburst fill.

Parameters

offset QPointF indicating the horizontal/vertical offset amount

Note: added in 2.3

See Also: offset; setOffsetUnit

Definition at line 472 of file qgsfillsymbollayerv2.h.

void QgsShapeburstFillSymbolLayerV2::setOffsetMapUnitScale ( const QgsMapUnitScale & scale )

inline

Definition at line 496 of file qgsfillsymbollayerv2.h.

void QgsShapeburstFillSymbolLayerV2::setOffsetUnit ( QgsSymbolV2::OutputUnit unit )

inline

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

Parameters

unit	units for fill offset

Note: added in 2.3

See Also: setOffset; offsetUnit

Definition at line 487 of file qgsfillsymbollayerv2.h.

void QgsShapeburstFillSymbolLayerV2::setOutputUnit ( QgsSymbolV2::OutputUnit unit )

overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 1516 of file qgsfillsymbollayerv2.cpp.

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

Note: added in 2.3

See Also: useWholeShape; setMaxDistance

Definition at line 357 of file qgsfillsymbollayerv2.h.

void QgsShapeburstFillSymbolLayerV2::startRender ( QgsSymbolV2RenderContext & context )

overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 1115 of file qgsfillsymbollayerv2.cpp.

void QgsShapeburstFillSymbolLayerV2::stopRender ( QgsSymbolV2RenderContext & context )

overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 1125 of file qgsfillsymbollayerv2.cpp.

bool QgsShapeburstFillSymbolLayerV2::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.

Note: added in 2.3

See Also: setUseWholeShape; maxDistance

Definition at line 364 of file qgsfillsymbollayerv2.h.

Member Data Documentation

int QgsShapeburstFillSymbolLayerV2::mBlurRadius

protected

Definition at line 509 of file qgsfillsymbollayerv2.h.

QBrush QgsShapeburstFillSymbolLayerV2::mBrush

protected

Definition at line 506 of file qgsfillsymbollayerv2.h.

QColor QgsShapeburstFillSymbolLayerV2::mColor2

protected

Definition at line 517 of file qgsfillsymbollayerv2.h.

ShapeburstColorType QgsShapeburstFillSymbolLayerV2::mColorType

protected

Definition at line 516 of file qgsfillsymbollayerv2.h.

QgsMapUnitScale QgsShapeburstFillSymbolLayerV2::mDistanceMapUnitScale

protected

Definition at line 514 of file qgsfillsymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsShapeburstFillSymbolLayerV2::mDistanceUnit

protected

Definition at line 513 of file qgsfillsymbollayerv2.h.

QgsVectorColorRampV2* QgsShapeburstFillSymbolLayerV2::mGradientRamp

protected

Definition at line 518 of file qgsfillsymbollayerv2.h.

bool QgsShapeburstFillSymbolLayerV2::mIgnoreRings

protected

Definition at line 521 of file qgsfillsymbollayerv2.h.

double QgsShapeburstFillSymbolLayerV2::mMaxDistance

protected

Definition at line 512 of file qgsfillsymbollayerv2.h.

QPointF QgsShapeburstFillSymbolLayerV2::mOffset

protected

Definition at line 523 of file qgsfillsymbollayerv2.h.

QgsMapUnitScale QgsShapeburstFillSymbolLayerV2::mOffsetMapUnitScale

protected

Definition at line 525 of file qgsfillsymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsShapeburstFillSymbolLayerV2::mOffsetUnit

protected

Definition at line 524 of file qgsfillsymbollayerv2.h.

QBrush QgsShapeburstFillSymbolLayerV2::mSelBrush

protected

Definition at line 507 of file qgsfillsymbollayerv2.h.

QgsVectorColorRampV2* QgsShapeburstFillSymbolLayerV2::mTwoColorGradientRamp

protected

Definition at line 519 of file qgsfillsymbollayerv2.h.

bool QgsShapeburstFillSymbolLayerV2::mUseWholeShape

protected

Definition at line 511 of file qgsfillsymbollayerv2.h.

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

/tmp/buildd/qgis-2.8.2+12wheezy/src/core/symbology-ng/qgsfillsymbollayerv2.h
/tmp/buildd/qgis-2.8.2+12wheezy/src/core/symbology-ng/qgsfillsymbollayerv2.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation