QGIS API Documentation
2.18.21-Las Palmas (9fba24a)
|
#include <qgsfillsymbollayerv2.h>
Public Types | |
enum | ShapeburstColorType { SimpleTwoColor, ColorRamp } |
Public Member Functions | |
QgsShapeburstFillSymbolLayerV2 (const QColor &color=DEFAULT_SIMPLEFILL_COLOR, const 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... | |
QgsShapeburstFillSymbolLayerV2 * | 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... | |
QgsVectorColorRampV2 * | 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 |
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 override |
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 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 |
QgsSymbolV2::OutputUnit | offsetUnit () const |
Returns the units used for the offset of the shapeburst fill. More... | |
QgsSymbolV2::OutputUnit | outputUnit () const override |
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 | 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 (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) 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 (QgsSymbolV2::OutputUnit unit) |
Sets the units used for the offset for the shapeburst fill. More... | |
void | setOutputUnit (QgsSymbolV2::OutputUnit unit) override |
void | setUseWholeShape (bool useWholeShape) |
Sets whether the shapeburst fill should be drawn using the entire shape. More... | |
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. More... | |
![]() | |
double | angle () const |
void | drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size) override |
void | setAngle (double angle) |
![]() | |
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 double | dxfAngle (QgsSymbolV2RenderContext &context) const |
get angle More... | |
virtual QColor | dxfBrushColor (QgsSymbolV2RenderContext &context) const |
get brush/fill color More... | |
virtual Qt::BrushStyle | dxfBrushStyle () const |
get brush/fill style More... | |
virtual QColor | dxfColor (QgsSymbolV2RenderContext &context) const |
get color More... | |
virtual QVector< qreal > | dxfCustomDashPattern (QgsSymbolV2::OutputUnit &unit) const |
get dash pattern More... | |
virtual double | dxfOffset (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const |
get offset More... | |
virtual Qt::PenStyle | dxfPenStyle () const |
get pen style More... | |
virtual double | dxfWidth (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const |
get line width More... | |
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 bool | setSubSymbol (QgsSymbolV2 *symbol) |
set layer's subsymbol. takes ownership of the passed symbol More... | |
virtual QgsSymbolV2 * | subSymbol () |
virtual void | toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const |
Writes the SLD element following the SLD v1.1 specs. More... | |
QgsSymbolV2::SymbolType | type () const |
virtual QSet< QString > | usedAttributes () const |
Returns the set of attributes referenced by the layer. More... | |
virtual bool | writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolV2RenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const |
write as DXF More... | |
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 |
![]() | |
double | mAngle |
![]() | |
QColor | mColor |
QMap< QString, QgsDataDefined *> | mDataDefinedProperties |
QgsFields | mFields |
bool | mLocked |
QgsPaintEffect * | mPaintEffect |
int | mRenderingPass |
QgsSymbolV2::SymbolType | mType |
Additional Inherited Members | |
![]() | |
QgsFillSymbolLayerV2 (bool locked=false) | |
void | _renderPolygon (QPainter *p, const QPolygonF &points, const QList< QPolygonF > *rings, QgsSymbolV2RenderContext &context) |
Default method to render polygon. More... | |
![]() | |
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... | |
![]() | |
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 |
Definition at line 313 of file qgsfillsymbollayerv2.h.
Enumerator | |
---|---|
SimpleTwoColor | |
ColorRamp |
Definition at line 317 of file qgsfillsymbollayerv2.h.
QgsShapeburstFillSymbolLayerV2::QgsShapeburstFillSymbolLayerV2 | ( | 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 957 of file qgsfillsymbollayerv2.cpp.
|
virtual |
Definition at line 973 of file qgsfillsymbollayerv2.cpp.
|
inline |
Returns the blur radius, which controls the amount of blurring applied to the fill.
Definition at line 360 of file qgsfillsymbollayerv2.h.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayerV2.
Definition at line 1513 of file qgsfillsymbollayerv2.cpp.
|
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
Definition at line 462 of file qgsfillsymbollayerv2.h.
|
inline |
Returns the color ramp used for the shapeburst fill.
The color ramp is only used if the colorType is set to ShapeburstColorType::ColorRamp
Definition at line 447 of file qgsfillsymbollayerv2.h.
|
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.
Definition at line 432 of file qgsfillsymbollayerv2.h.
|
static |
Definition at line 978 of file qgsfillsymbollayerv2.cpp.
|
inline |
Definition at line 411 of file qgsfillsymbollayerv2.h.
|
inline |
Returns the unit for the maximum distance to shade inside of the shape from the polygon's boundary.
Definition at line 408 of file qgsfillsymbollayerv2.h.
|
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 1531 of file qgsfillsymbollayerv2.cpp.
|
inline |
Returns whether the shapeburst fill is set to ignore polygon interior rings.
Definition at line 476 of file qgsfillsymbollayerv2.h.
|
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 1065 of file qgsfillsymbollayerv2.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 1558 of file qgsfillsymbollayerv2.cpp.
|
inline |
Returns the maximum distance from the shape's boundary which is shaded.
This parameter is only effective if useWholeShape is false.
Definition at line 393 of file qgsfillsymbollayerv2.h.
|
inline |
Returns the offset for the shapeburst fill.
Definition at line 491 of file qgsfillsymbollayerv2.h.
|
inline |
Definition at line 509 of file qgsfillsymbollayerv2.h.
|
inline |
Returns the units used for the offset of the shapeburst fill.
Definition at line 506 of file qgsfillsymbollayerv2.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 1543 of file qgsfillsymbollayerv2.cpp.
|
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 1487 of file qgsfillsymbollayerv2.cpp.
|
overridevirtual |
Implements QgsFillSymbolLayerV2.
Definition at line 1150 of file qgsfillsymbollayerv2.cpp.
|
inline |
Sets the blur radius, which controls the amount of blurring applied to the fill.
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. |
Definition at line 354 of file qgsfillsymbollayerv2.h.
|
inline |
Sets the color for the endpoint of the shapeburst fill.
This color is only used if setColorType is set ShapeburstColorType::SimpleTwoColor.
color2 | QColor to use for endpoint of gradient |
Definition at line 455 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.
ramp | color ramp to use for shapeburst fill |
Definition at line 1070 of file qgsfillsymbollayerv2.cpp.
|
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.
colorType | color type to use for shapeburst fill |
Definition at line 422 of file qgsfillsymbollayerv2.h.
|
inline |
Definition at line 410 of file qgsfillsymbollayerv2.h.
|
inline |
Sets the unit for the maximum distance to shade inside of the shape from the polygon's boundary.
unit | distance unit for the maximum distance |
Definition at line 401 of file qgsfillsymbollayerv2.h.
|
inline |
Sets whether the shapeburst fill should ignore polygon rings when calculating the buffered shading.
ignoreRings | Set to true if buffers should ignore interior rings for polygons. |
Definition at line 470 of file qgsfillsymbollayerv2.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 1552 of file qgsfillsymbollayerv2.cpp.
|
inline |
Sets the maximum distance to shape inside of the shape from the polygon's boundary.
maxDistance | distance from boundary to shade. setUseWholeShape must be set to false for this parameter to take effect. Distance unit is controlled by setDistanceUnit. |
Definition at line 385 of file qgsfillsymbollayerv2.h.
|
inline |
Sets the offset for the shapeburst fill.
offset | QPointF indicating the horizontal/vertical offset amount |
Definition at line 484 of file qgsfillsymbollayerv2.h.
|
inline |
Definition at line 508 of file qgsfillsymbollayerv2.h.
|
inline |
Sets the units used for the offset for the shapeburst fill.
unit | units for fill offset |
Definition at line 499 of file qgsfillsymbollayerv2.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 1537 of file qgsfillsymbollayerv2.cpp.
|
inline |
Sets whether the shapeburst fill should be drawn using the entire shape.
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 |
Definition at line 369 of file qgsfillsymbollayerv2.h.
|
overridevirtual |
Implements QgsSymbolLayerV2.
Definition at line 1135 of file qgsfillsymbollayerv2.cpp.
|
overridevirtual |
Implements QgsSymbolLayerV2.
Definition at line 1145 of file qgsfillsymbollayerv2.cpp.
|
inline |
Returns whether the shapeburst fill is set to cover the entire shape.
Definition at line 376 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 521 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 518 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 529 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 528 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 526 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 525 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 530 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 533 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 524 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 535 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 537 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 536 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 519 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 531 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 523 of file qgsfillsymbollayerv2.h.