QGIS API Documentation
2.18.21-Las Palmas (9fba24a)
|
#include <qgsfillsymbollayerv2.h>
Public Types | |
enum | GradientColorType { SimpleTwoColor, ColorRamp } |
enum | GradientCoordinateMode { Feature, Viewport } |
enum | GradientSpread { Pad, Reflect, Repeat } |
enum | GradientType { Linear, Radial, Conical } |
Public Member Functions | |
QgsGradientFillSymbolLayerV2 (const QColor &color=DEFAULT_SIMPLEFILL_COLOR, const QColor &color2=Qt::white, GradientColorType gradientColorType=SimpleTwoColor, GradientType gradientType=Linear, GradientCoordinateMode coordinateMode=Feature, GradientSpread gradientSpread=Pad) | |
virtual | ~QgsGradientFillSymbolLayerV2 () |
QgsGradientFillSymbolLayerV2 * | clone () const override |
Shall be reimplemented by subclasses to create a deep copy of the instance. More... | |
QColor | color2 () const |
Color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor. More... | |
QgsVectorColorRampV2 * | colorRamp () |
Color ramp used for the gradient fill, only used if the gradient color type is set to ColorRamp. More... | |
GradientCoordinateMode | coordinateMode () const |
Coordinate mode for gradient. More... | |
double | estimateMaxBleed () const override |
Returns the estimated maximum distance which the layer style will bleed outside the drawn shape. More... | |
GradientColorType | gradientColorType () const |
Gradient color mode, controls how gradient color stops are created. More... | |
GradientSpread | gradientSpread () const |
Gradient spread mode. More... | |
GradientType | gradientType () const |
Type of gradient, eg linear or radial. More... | |
QString | layerType () const override |
Returns a string that represents this layer type. More... | |
QgsMapUnitScale | mapUnitScale () const override |
QPointF | offset () const |
const QgsMapUnitScale & | offsetMapUnitScale () const |
QgsSymbolV2::OutputUnit | offsetUnit () const |
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... | |
QPointF | referencePoint1 () const |
bool | referencePoint1IsCentroid () const |
QPointF | referencePoint2 () const |
bool | referencePoint2IsCentroid () const |
void | renderPolygon (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolV2RenderContext &context) override |
void | setColor2 (const QColor &color2) |
void | setColorRamp (QgsVectorColorRampV2 *ramp) |
void | setCoordinateMode (GradientCoordinateMode coordinateMode) |
void | setGradientColorType (GradientColorType gradientColorType) |
void | setGradientSpread (GradientSpread gradientSpread) |
void | setGradientType (GradientType gradientType) |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setOffset (QPointF offset) |
Offset for gradient fill. More... | |
void | setOffsetMapUnitScale (const QgsMapUnitScale &scale) |
void | setOffsetUnit (QgsSymbolV2::OutputUnit unit) |
Units for gradient fill offset. More... | |
void | setOutputUnit (QgsSymbolV2::OutputUnit unit) override |
void | setReferencePoint1 (QPointF referencePoint) |
Starting point of gradient fill, in the range [0,0] - [1,1]. More... | |
void | setReferencePoint1IsCentroid (bool isCentroid) |
Sets the starting point of the gradient to be the feature centroid. More... | |
void | setReferencePoint2 (QPointF referencePoint) |
End point of gradient fill, in the range [0,0] - [1,1]. More... | |
void | setReferencePoint2IsCentroid (bool isCentroid) |
Sets the end point of the gradient to be the feature centroid. More... | |
void | startRender (QgsSymbolV2RenderContext &context) override |
void | stopRender (QgsSymbolV2RenderContext &context) override |
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 |
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 | |
QBrush | mBrush |
QColor | mColor2 |
GradientCoordinateMode | mCoordinateMode |
GradientColorType | mGradientColorType |
QgsVectorColorRampV2 * | mGradientRamp |
GradientSpread | mGradientSpread |
GradientType | mGradientType |
QPointF | mOffset |
QgsMapUnitScale | mOffsetMapUnitScale |
QgsSymbolV2::OutputUnit | mOffsetUnit |
QPointF | mReferencePoint1 |
bool | mReferencePoint1IsCentroid |
QPointF | mReferencePoint2 |
bool | mReferencePoint2IsCentroid |
QBrush | mSelBrush |
Protected Attributes inherited from QgsFillSymbolLayerV2 | |
double | mAngle |
Protected Attributes inherited from QgsSymbolLayerV2 | |
QColor | mColor |
QMap< QString, QgsDataDefined *> | mDataDefinedProperties |
QgsFields | mFields |
bool | mLocked |
QgsPaintEffect * | mPaintEffect |
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 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 Protected Attributes inherited from QgsSymbolLayerV2 | |
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 158 of file qgsfillsymbollayerv2.h.
Enumerator | |
---|---|
SimpleTwoColor | |
ColorRamp |
Definition at line 162 of file qgsfillsymbollayerv2.h.
Enumerator | |
---|---|
Feature | |
Viewport |
Definition at line 175 of file qgsfillsymbollayerv2.h.
Enumerator | |
---|---|
Pad | |
Reflect | |
Repeat |
Definition at line 181 of file qgsfillsymbollayerv2.h.
Enumerator | |
---|---|
Linear | |
Radial | |
Conical |
Definition at line 168 of file qgsfillsymbollayerv2.h.
QgsGradientFillSymbolLayerV2::QgsGradientFillSymbolLayerV2 | ( | const QColor & | color = DEFAULT_SIMPLEFILL_COLOR , |
const QColor & | color2 = Qt::white , |
||
GradientColorType | gradientColorType = SimpleTwoColor , |
||
GradientType | gradientType = Linear , |
||
GradientCoordinateMode | coordinateMode = Feature , |
||
GradientSpread | gradientSpread = Pad |
||
) |
Definition at line 471 of file qgsfillsymbollayerv2.cpp.
|
virtual |
Definition at line 489 of file qgsfillsymbollayerv2.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayerV2.
Definition at line 911 of file qgsfillsymbollayerv2.cpp.
|
inline |
Color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor.
Definition at line 231 of file qgsfillsymbollayerv2.h.
|
inline |
Color ramp used for the gradient fill, only used if the gradient color type is set to ColorRamp.
Definition at line 227 of file qgsfillsymbollayerv2.h.
|
inline |
Coordinate mode for gradient.
Controls how the gradient stops are positioned.
Definition at line 235 of file qgsfillsymbollayerv2.h.
|
static |
Definition at line 494 of file qgsfillsymbollayerv2.cpp.
|
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 929 of file qgsfillsymbollayerv2.cpp.
|
inline |
Gradient color mode, controls how gradient color stops are created.
Definition at line 223 of file qgsfillsymbollayerv2.h.
|
inline |
Gradient spread mode.
Controls how the gradient behaves outside of the predefined stops
Definition at line 239 of file qgsfillsymbollayerv2.h.
|
inline |
Type of gradient, eg linear or radial.
Definition at line 219 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 576 of file qgsfillsymbollayerv2.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 950 of file qgsfillsymbollayerv2.cpp.
|
inline |
Definition at line 260 of file qgsfillsymbollayerv2.h.
|
inline |
Definition at line 267 of file qgsfillsymbollayerv2.h.
|
inline |
Definition at line 264 of file qgsfillsymbollayerv2.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 940 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 886 of file qgsfillsymbollayerv2.cpp.
|
inline |
Definition at line 244 of file qgsfillsymbollayerv2.h.
|
inline |
Definition at line 248 of file qgsfillsymbollayerv2.h.
|
inline |
Definition at line 252 of file qgsfillsymbollayerv2.h.
|
inline |
Definition at line 256 of file qgsfillsymbollayerv2.h.
|
overridevirtual |
Implements QgsFillSymbolLayerV2.
Definition at line 857 of file qgsfillsymbollayerv2.cpp.
|
inline |
Definition at line 232 of file qgsfillsymbollayerv2.h.
void QgsGradientFillSymbolLayerV2::setColorRamp | ( | QgsVectorColorRampV2 * | ramp | ) |
Definition at line 570 of file qgsfillsymbollayerv2.cpp.
|
inline |
Definition at line 236 of file qgsfillsymbollayerv2.h.
|
inline |
Definition at line 224 of file qgsfillsymbollayerv2.h.
|
inline |
Definition at line 240 of file qgsfillsymbollayerv2.h.
|
inline |
Definition at line 220 of file qgsfillsymbollayerv2.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 945 of file qgsfillsymbollayerv2.cpp.
|
inline |
Offset for gradient fill.
Definition at line 259 of file qgsfillsymbollayerv2.h.
|
inline |
Definition at line 266 of file qgsfillsymbollayerv2.h.
|
inline |
Units for gradient fill offset.
Definition at line 263 of file qgsfillsymbollayerv2.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayerV2.
Definition at line 935 of file qgsfillsymbollayerv2.cpp.
|
inline |
Starting point of gradient fill, in the range [0,0] - [1,1].
Definition at line 243 of file qgsfillsymbollayerv2.h.
|
inline |
Sets the starting point of the gradient to be the feature centroid.
Definition at line 247 of file qgsfillsymbollayerv2.h.
|
inline |
End point of gradient fill, in the range [0,0] - [1,1].
Definition at line 251 of file qgsfillsymbollayerv2.h.
|
inline |
Sets the end point of the gradient to be the feature centroid.
Definition at line 255 of file qgsfillsymbollayerv2.h.
|
overridevirtual |
Implements QgsSymbolLayerV2.
Definition at line 842 of file qgsfillsymbollayerv2.cpp.
|
overridevirtual |
Implements QgsSymbolLayerV2.
Definition at line 852 of file qgsfillsymbollayerv2.cpp.
|
protected |
Definition at line 276 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 280 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 283 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 279 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 281 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 284 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 282 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 291 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 293 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 292 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 286 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 287 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 288 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 289 of file qgsfillsymbollayerv2.h.
|
protected |
Definition at line 277 of file qgsfillsymbollayerv2.h.