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

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

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

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	selectionIsOpaque = true
static const bool	selectFillBorder = false
static const bool	selectFillStyle = false

Member Enumeration Documentation

enum QgsShapeburstFillSymbolLayerV2::ShapeburstColorType

Enumerator:

SimpleTwoColor
ColorRamp

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`
	)

QgsShapeburstFillSymbolLayerV2::~QgsShapeburstFillSymbolLayerV2 ( )

virtual

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

QgsSymbolLayerV2 * QgsShapeburstFillSymbolLayerV2::clone ( ) const

virtual

Implements QgsSymbolLayerV2.

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

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

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

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

static

const QgsMapUnitScale& QgsShapeburstFillSymbolLayerV2::distanceMapUnitScale ( ) const

inline

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

double QgsShapeburstFillSymbolLayerV2::estimateMaxBleed ( ) const

virtual

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.

double 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

QString QgsShapeburstFillSymbolLayerV2::layerType ( ) const

virtual

Implements QgsSymbolLayerV2.

QgsMapUnitScale QgsShapeburstFillSymbolLayerV2::mapUnitScale ( ) const

virtual

Reimplemented from QgsSymbolLayerV2.

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

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

const QgsMapUnitScale& QgsShapeburstFillSymbolLayerV2::offsetMapUnitScale ( ) const

inline

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

QgsSymbolV2::OutputUnit QgsShapeburstFillSymbolLayerV2::outputUnit ( ) const

virtual

Reimplemented from QgsSymbolLayerV2.

QgsStringMap QgsShapeburstFillSymbolLayerV2::properties ( ) const

virtual

Implements QgsSymbolLayerV2.

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

virtual

Implements QgsFillSymbolLayerV2.

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

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

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

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

void QgsShapeburstFillSymbolLayerV2::setDistanceMapUnitScale ( const QgsMapUnitScale & scale )

inline

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

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

void QgsShapeburstFillSymbolLayerV2::setMapUnitScale ( const QgsMapUnitScale & scale )

virtual

Reimplemented from QgsSymbolLayerV2.

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

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

void QgsShapeburstFillSymbolLayerV2::setOffsetMapUnitScale ( const QgsMapUnitScale & scale )

inline

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

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

virtual

Reimplemented from QgsSymbolLayerV2.

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

void QgsShapeburstFillSymbolLayerV2::startRender ( QgsSymbolV2RenderContext & context )

virtual

Implements QgsSymbolLayerV2.

void QgsShapeburstFillSymbolLayerV2::stopRender ( QgsSymbolV2RenderContext & context )

virtual

Implements QgsSymbolLayerV2.

double 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

Member Data Documentation

int QgsShapeburstFillSymbolLayerV2::mBlurRadius

protected

QBrush QgsShapeburstFillSymbolLayerV2::mBrush

protected

QColor QgsShapeburstFillSymbolLayerV2::mColor2

protected

ShapeburstColorType QgsShapeburstFillSymbolLayerV2::mColorType

protected

QgsMapUnitScale QgsShapeburstFillSymbolLayerV2::mDistanceMapUnitScale

protected

QgsSymbolV2::OutputUnit QgsShapeburstFillSymbolLayerV2::mDistanceUnit

protected

QgsVectorColorRampV2* QgsShapeburstFillSymbolLayerV2::mGradientRamp

protected

bool QgsShapeburstFillSymbolLayerV2::mIgnoreRings

protected

double QgsShapeburstFillSymbolLayerV2::mMaxDistance

protected

QPointF QgsShapeburstFillSymbolLayerV2::mOffset

protected

QgsMapUnitScale QgsShapeburstFillSymbolLayerV2::mOffsetMapUnitScale

protected

QgsSymbolV2::OutputUnit QgsShapeburstFillSymbolLayerV2::mOffsetUnit

protected

QBrush QgsShapeburstFillSymbolLayerV2::mSelBrush

protected

QgsVectorColorRampV2* QgsShapeburstFillSymbolLayerV2::mTwoColorGradientRamp

protected

bool QgsShapeburstFillSymbolLayerV2::mUseWholeShape

protected

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

/tmp/buildd/qgis-2.6.0+wheezy1/src/core/symbology-ng/qgsfillsymbollayerv2.h
/tmp/buildd/qgis-2.6.0+wheezy1/src/core/symbology-ng/qgsfillsymbollayerv2.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation