QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
QgsShapeburstFillSymbolLayerV2 Class Reference

#include <qgsfillsymbollayerv2.h>

Inheritance diagram for QgsShapeburstFillSymbolLayerV2:
Inheritance graph
[legend]

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. More...
 
QgsSymbolLayerV2clone () const
 
QColor color2 () const
 Returns the color used for the endpoint of the shapeburst fill. More...
 
QgsVectorColorRampV2colorRamp ()
 Returns the color ramp used for the shapeburst fill. More...
 
ShapeburstColorType colorType () const
 Returns the color mode used for the shapeburst fill. More...
 
const QgsMapUnitScaledistanceMapUnitScale () const
 
QgsSymbolV2::OutputUnit distanceUnit () const
 Returns the unit for the maximum distance to shade inside of the shape from the polygon's boundary. More...
 
double estimateMaxBleed () const
 Returns the estimated maximum distance which the layer style will bleed outside the drawn shape. More...
 
bool ignoreRings () const
 Returns whether the shapeburst fill is set to ignore polygon interior rings. More...
 
QString layerType () const
 
QgsMapUnitScale mapUnitScale () const
 
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 QgsMapUnitScaleoffsetMapUnitScale () const
 
QgsSymbolV2::OutputUnit offsetUnit () const
 Returns the units used for the offset of the shapeburst fill. More...
 
QgsSymbolV2::OutputUnit outputUnit () const
 
QgsStringMap properties () const
 
void renderPolygon (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolV2RenderContext &context)
 
void setBlurRadius (int blurRadius)
 Sets the blur radius, which controls the amount of blurring applied to the fill. More...
 
void setColor2 (QColor color2)
 Sets the color for the endpoint of the shapeburst fill. More...
 
void setColorRamp (QgsVectorColorRampV2 *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 (QgsSymbolV2::OutputUnit 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)
 
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 (QgsSymbolV2::OutputUnit unit)
 Sets the units used for the offset for the shapeburst fill. More...
 
void setOutputUnit (QgsSymbolV2::OutputUnit unit)
 
void setUseWholeShape (bool useWholeShape)
 Sets whether the shapeburst fill should be drawn using the entire shape. More...
 
void startRender (QgsSymbolV2RenderContext &context)
 
void stopRender (QgsSymbolV2RenderContext &context)
 
bool useWholeShape () const
 Returns whether the shapeburst fill is set to cover the entire shape. More...
 
- Public Member Functions inherited from QgsFillSymbolLayerV2
double angle () const
 
void drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size)
 
void setAngle (double angle)
 
- Public Member Functions inherited from QgsSymbolLayerV2
virtual ~QgsSymbolLayerV2 ()
 
virtual QColor color () const
 
virtual const QgsExpressiondataDefinedProperty (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 Qt::PenStyle dxfPenStyle () const
 
virtual double dxfWidth (const QgsDxfExport &e, const QgsSymbolV2RenderContext &context) const
 
virtual QColor fillColor () const
 Get fill color. More...
 
bool hasDataDefinedProperties () const
 
bool isLocked () const
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
virtual QColor outlineColor () const
 Get outline color. More...
 
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. More...
 
void setLocked (bool locked)
 
virtual void setOutlineColor (const QColor &color)
 Set outline color. More...
 
void setRenderingPass (int renderingPass)
 
virtual bool setSubSymbol (QgsSymbolV2 *symbol)
 
virtual QgsSymbolV2subSymbol ()
 
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 QgsSymbolLayerV2create (const QgsStringMap &properties=QgsStringMap())
 

Protected Attributes

int mBlurRadius
 
QBrush mBrush
 
QColor mColor2
 
ShapeburstColorType mColorType
 
QgsMapUnitScale mDistanceMapUnitScale
 
QgsSymbolV2::OutputUnit mDistanceUnit
 
QgsVectorColorRampV2mGradientRamp
 
bool mIgnoreRings
 
double mMaxDistance
 
QPointF mOffset
 
QgsMapUnitScale mOffsetMapUnitScale
 
QgsSymbolV2::OutputUnit mOffsetUnit
 
QBrush mSelBrush
 
QgsVectorColorRampV2mTwoColorGradientRamp
 
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. More...
 
- Protected Member Functions inherited from QgsSymbolLayerV2
 QgsSymbolLayerV2 (QgsSymbolV2::SymbolType type, bool locked=false)
 
void copyDataDefinedProperties (QgsSymbolLayerV2 *destLayer) const
 Copies data defined properties of this layer to another symbol layer. More...
 
virtual QgsExpressionexpression (const QString &property) const
 
virtual void prepareExpressions (const QgsFields *fields, double scale=-1.0)
 
void saveDataDefinedProperties (QgsStringMap &stringMap) const
 Saves data defined properties to string map. More...
 
- 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 306 of file qgsfillsymbollayerv2.h.

Member Enumeration Documentation

Enumerator
SimpleTwoColor 
ColorRamp 

Definition at line 310 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 907 of file qgsfillsymbollayerv2.cpp.

QgsShapeburstFillSymbolLayerV2::~QgsShapeburstFillSymbolLayerV2 ( )
virtual

Definition at line 924 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 353 of file qgsfillsymbollayerv2.h.

QgsSymbolLayerV2 * QgsShapeburstFillSymbolLayerV2::clone ( ) const
virtual

Implements QgsSymbolLayerV2.

Definition at line 1438 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 455 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 440 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 425 of file qgsfillsymbollayerv2.h.

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

Definition at line 929 of file qgsfillsymbollayerv2.cpp.

const QgsMapUnitScale& QgsShapeburstFillSymbolLayerV2::distanceMapUnitScale ( ) const
inline

Definition at line 404 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 401 of file qgsfillsymbollayerv2.h.

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.

Definition at line 1455 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 469 of file qgsfillsymbollayerv2.h.

QString QgsShapeburstFillSymbolLayerV2::layerType ( ) const
virtual

Implements QgsSymbolLayerV2.

Definition at line 1027 of file qgsfillsymbollayerv2.cpp.

QgsMapUnitScale QgsShapeburstFillSymbolLayerV2::mapUnitScale ( ) const
virtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 1482 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 386 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 484 of file qgsfillsymbollayerv2.h.

const QgsMapUnitScale& QgsShapeburstFillSymbolLayerV2::offsetMapUnitScale ( ) const
inline

Definition at line 502 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 499 of file qgsfillsymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsShapeburstFillSymbolLayerV2::outputUnit ( ) const
virtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 1467 of file qgsfillsymbollayerv2.cpp.

QgsStringMap QgsShapeburstFillSymbolLayerV2::properties ( ) const
virtual

Implements QgsSymbolLayerV2.

Definition at line 1412 of file qgsfillsymbollayerv2.cpp.

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

Implements QgsFillSymbolLayerV2.

Definition at line 1094 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
blurRadiusRadius 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 347 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
color2QColor to use for endpoint of gradient
Note
added in 2.3
See also
setColorType
color2

Definition at line 448 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
rampcolor ramp to use for shapeburst fill
Note
added in 2.3
See also
setColorType
colorRamp

Definition at line 1032 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
colorTypecolor type to use for shapeburst fill
Note
added in 2.3
See also
colorType
setColor
setColor2
setColorRamp

Definition at line 415 of file qgsfillsymbollayerv2.h.

void QgsShapeburstFillSymbolLayerV2::setDistanceMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 403 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
unitdistance unit for the maximum distance
Note
added in 2.3
See also
setMaxDistance
distanceUnit

Definition at line 394 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
ignoreRingsSet to true if buffers should ignore interior rings for polygons.
Note
added in 2.3
See also
ignoreRings

Definition at line 463 of file qgsfillsymbollayerv2.h.

void QgsShapeburstFillSymbolLayerV2::setMapUnitScale ( const QgsMapUnitScale scale)
virtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 1476 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
maxDistancedistance 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 378 of file qgsfillsymbollayerv2.h.

void QgsShapeburstFillSymbolLayerV2::setOffset ( QPointF  offset)
inline

Sets the offset for the shapeburst fill.

Parameters
offsetQPointF indicating the horizontal/vertical offset amount
Note
added in 2.3
See also
offset
setOffsetUnit

Definition at line 477 of file qgsfillsymbollayerv2.h.

void QgsShapeburstFillSymbolLayerV2::setOffsetMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 501 of file qgsfillsymbollayerv2.h.

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

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

Parameters
unitunits for fill offset
Note
added in 2.3
See also
setOffset
offsetUnit

Definition at line 492 of file qgsfillsymbollayerv2.h.

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

Reimplemented from QgsSymbolLayerV2.

Definition at line 1461 of file qgsfillsymbollayerv2.cpp.

void QgsShapeburstFillSymbolLayerV2::setUseWholeShape ( bool  useWholeShape)
inline

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

Parameters
useWholeShapeSet 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 362 of file qgsfillsymbollayerv2.h.

void QgsShapeburstFillSymbolLayerV2::startRender ( QgsSymbolV2RenderContext context)
virtual

Implements QgsSymbolLayerV2.

Definition at line 1079 of file qgsfillsymbollayerv2.cpp.

void QgsShapeburstFillSymbolLayerV2::stopRender ( QgsSymbolV2RenderContext context)
virtual

Implements QgsSymbolLayerV2.

Definition at line 1089 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 369 of file qgsfillsymbollayerv2.h.

Member Data Documentation

int QgsShapeburstFillSymbolLayerV2::mBlurRadius
protected

Definition at line 514 of file qgsfillsymbollayerv2.h.

QBrush QgsShapeburstFillSymbolLayerV2::mBrush
protected

Definition at line 511 of file qgsfillsymbollayerv2.h.

QColor QgsShapeburstFillSymbolLayerV2::mColor2
protected

Definition at line 522 of file qgsfillsymbollayerv2.h.

ShapeburstColorType QgsShapeburstFillSymbolLayerV2::mColorType
protected

Definition at line 521 of file qgsfillsymbollayerv2.h.

QgsMapUnitScale QgsShapeburstFillSymbolLayerV2::mDistanceMapUnitScale
protected

Definition at line 519 of file qgsfillsymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsShapeburstFillSymbolLayerV2::mDistanceUnit
protected

Definition at line 518 of file qgsfillsymbollayerv2.h.

QgsVectorColorRampV2* QgsShapeburstFillSymbolLayerV2::mGradientRamp
protected

Definition at line 523 of file qgsfillsymbollayerv2.h.

bool QgsShapeburstFillSymbolLayerV2::mIgnoreRings
protected

Definition at line 526 of file qgsfillsymbollayerv2.h.

double QgsShapeburstFillSymbolLayerV2::mMaxDistance
protected

Definition at line 517 of file qgsfillsymbollayerv2.h.

QPointF QgsShapeburstFillSymbolLayerV2::mOffset
protected

Definition at line 528 of file qgsfillsymbollayerv2.h.

QgsMapUnitScale QgsShapeburstFillSymbolLayerV2::mOffsetMapUnitScale
protected

Definition at line 530 of file qgsfillsymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsShapeburstFillSymbolLayerV2::mOffsetUnit
protected

Definition at line 529 of file qgsfillsymbollayerv2.h.

QBrush QgsShapeburstFillSymbolLayerV2::mSelBrush
protected

Definition at line 512 of file qgsfillsymbollayerv2.h.

QgsVectorColorRampV2* QgsShapeburstFillSymbolLayerV2::mTwoColorGradientRamp
protected

Definition at line 524 of file qgsfillsymbollayerv2.h.

bool QgsShapeburstFillSymbolLayerV2::mUseWholeShape
protected

Definition at line 516 of file qgsfillsymbollayerv2.h.


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