QGIS API Documentation
3.0.2-Girona (307d082)
|
#include <qgsfillsymbollayer.h>
Public Member Functions | |
QgsGradientFillSymbolLayer (const QColor &color=DEFAULT_SIMPLEFILL_COLOR, const QColor &color2=Qt::white, GradientColorType gradientColorType=SimpleTwoColor, GradientType gradientType=Linear, GradientCoordinateMode coordinateMode=Feature, GradientSpread gradientSpread=Pad) | |
~QgsGradientFillSymbolLayer () override | |
QgsGradientFillSymbolLayer * | 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... | |
QgsColorRamp * | colorRamp () |
Returns the color ramp used for the gradient fill. More... | |
GradientCoordinateMode | coordinateMode () const |
Coordinate mode for gradient. Controls how the gradient stops are positioned. More... | |
double | estimateMaxBleed (const QgsRenderContext &context) const override |
Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context. More... | |
GradientColorType | gradientColorType () const |
Gradient color mode, controls how gradient color stops are created. More... | |
GradientSpread | gradientSpread () const |
Gradient spread mode. Controls how the gradient behaves outside of the predefined stops. More... | |
GradientType | gradientType () const |
Type of gradient, e.g., 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 |
QgsUnitTypes::RenderUnit | offsetUnit () const |
QgsUnitTypes::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. More... | |
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, QgsSymbolRenderContext &context) override |
void | setColor2 (const QColor &color2) |
void | setColorRamp (QgsColorRamp *ramp) |
Sets the color ramp used for the gradient fill. More... | |
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 (QgsUnitTypes::RenderUnit unit) |
Units for gradient fill offset. More... | |
void | setOutputUnit (QgsUnitTypes::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. More... | |
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 (QgsSymbolRenderContext &context) override |
void | stopRender (QgsSymbolRenderContext &context) override |
Public Member Functions inherited from QgsFillSymbolLayer | |
double | angle () const |
void | drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override |
void | setAngle (double angle) |
Public Member Functions inherited from QgsSymbolLayer | |
virtual | ~QgsSymbolLayer () |
virtual QColor | color () const |
The fill color. More... | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the symbol layer's property collection, used for data defined overrides. More... | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the symbol layer's property collection, used for data defined overrides. More... | |
virtual double | dxfAngle (QgsSymbolRenderContext &context) const |
get angle More... | |
virtual QColor | dxfBrushColor (QgsSymbolRenderContext &context) const |
get brush/fill color More... | |
virtual Qt::BrushStyle | dxfBrushStyle () const |
get brush/fill style More... | |
virtual QColor | dxfColor (QgsSymbolRenderContext &context) const |
get color More... | |
virtual QVector< qreal > | dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const |
get dash pattern More... | |
virtual double | dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
get offset More... | |
virtual Qt::PenStyle | dxfPenStyle () const |
get pen style More... | |
virtual double | dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
get line width More... | |
bool | enabled () const |
Returns true if symbol layer is enabled and will be drawn. More... | |
virtual QColor | fillColor () const |
Get fill color. More... | |
virtual bool | isCompatibleWithSymbol (QgsSymbol *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 |
QgsPaintEffect * | paintEffect () const |
Returns the current paint effect for the layer. More... | |
virtual void | prepareExpressions (const QgsSymbolRenderContext &context) |
Prepares all data defined property expressions for evaluation. More... | |
int | renderingPass () const |
virtual void | setColor (const QColor &color) |
The fill color. More... | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the symbol layer's property collection, used for data defined overrides. More... | |
virtual void | setDataDefinedProperty (Property key, const QgsProperty &property) |
Sets a data defined property for the layer. More... | |
void | setEnabled (bool enabled) |
Sets whether symbol layer is enabled and should be drawn. More... | |
virtual void | setFillColor (const QColor &color) |
Set fill color. More... | |
void | setLocked (bool locked) |
void | setPaintEffect (QgsPaintEffect *effect) |
Sets the current paint effect for the layer. More... | |
void | setRenderingPass (int renderingPass) |
virtual void | setStrokeColor (const QColor &color) |
Set stroke color. More... | |
virtual bool | setSubSymbol (QgsSymbol *symbol) |
set layer's subsymbol. takes ownership of the passed symbol More... | |
virtual QColor | strokeColor () const |
Get stroke color. More... | |
virtual QgsSymbol * | subSymbol () |
Returns the symbol's sub symbol, if present. More... | |
virtual void | toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const |
QgsSymbol::SymbolType | type () const |
virtual QSet< QString > | usedAttributes (const QgsRenderContext &context) const |
Returns the set of attributes referenced by the layer. More... | |
virtual bool | writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const |
write as DXF More... | |
Static Public Member Functions | |
static QgsSymbolLayer * | create (const QgsStringMap &properties=QgsStringMap()) |
Static Public Member Functions inherited from QgsSymbolLayer | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. More... | |
Protected Attributes | |
QBrush | mBrush |
QColor | mColor2 |
GradientCoordinateMode | mCoordinateMode |
GradientColorType | mGradientColorType |
QgsColorRamp * | mGradientRamp = nullptr |
GradientSpread | mGradientSpread |
GradientType | mGradientType |
QPointF | mOffset |
QgsMapUnitScale | mOffsetMapUnitScale |
QgsUnitTypes::RenderUnit | mOffsetUnit = QgsUnitTypes::RenderMillimeters |
QPointF | mReferencePoint1 |
bool | mReferencePoint1IsCentroid = false |
QPointF | mReferencePoint2 |
bool | mReferencePoint2IsCentroid = false |
QBrush | mSelBrush |
Protected Attributes inherited from QgsFillSymbolLayer | |
double | mAngle = 0.0 |
Protected Attributes inherited from QgsSymbolLayer | |
QColor | mColor |
QgsPropertyCollection | mDataDefinedProperties |
bool | mEnabled |
True if layer is enabled and should be drawn. More... | |
QgsFields | mFields |
bool | mLocked |
QgsPaintEffect * | mPaintEffect = nullptr |
int | mRenderingPass |
QgsSymbol::SymbolType | mType |
Additional Inherited Members | |
Protected Member Functions inherited from QgsFillSymbolLayer | |
QgsFillSymbolLayer (bool locked=false) | |
void | _renderPolygon (QPainter *p, const QPolygonF &points, const QList< QPolygonF > *rings, QgsSymbolRenderContext &context) |
Default method to render polygon. More... | |
Protected Member Functions inherited from QgsSymbolLayer | |
QgsSymbolLayer (QgsSymbol::SymbolType type, bool locked=false) | |
void | copyDataDefinedProperties (QgsSymbolLayer *destLayer) const |
Copies all data defined properties of this layer to another symbol layer. More... | |
void | copyPaintEffect (QgsSymbolLayer *destLayer) const |
Copies paint effect of this layer to another symbol layer. More... | |
void | restoreOldDataDefinedProperties (const QgsStringMap &stringMap) |
Restores older data defined properties from string map. More... | |
Static Protected Attributes inherited from QgsSymbolLayer | |
static const bool | SELECT_FILL_BORDER = false |
Whether fill styles for selected features also highlight symbol stroke. More... | |
static const bool | SELECT_FILL_STYLE = false |
Whether fill styles for selected features uses symbol layer style. More... | |
static const bool | SELECTION_IS_OPAQUE = true |
Whether styles for selected features ignore symbol alpha. More... | |
Definition at line 170 of file qgsfillsymbollayer.h.
Enumerator | |
---|---|
SimpleTwoColor | |
ColorRamp |
Definition at line 174 of file qgsfillsymbollayer.h.
Enumerator | |
---|---|
Feature | |
Viewport |
Definition at line 187 of file qgsfillsymbollayer.h.
Enumerator | |
---|---|
Pad | |
Reflect | |
Repeat |
Definition at line 193 of file qgsfillsymbollayer.h.
Enumerator | |
---|---|
Linear | |
Radial | |
Conical |
Definition at line 180 of file qgsfillsymbollayer.h.
QgsGradientFillSymbolLayer::QgsGradientFillSymbolLayer | ( | 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 455 of file qgsfillsymbollayer.cpp.
|
override |
Definition at line 469 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 893 of file qgsfillsymbollayer.cpp.
|
inline |
Color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor.
Definition at line 256 of file qgsfillsymbollayer.h.
|
inline |
Returns the color ramp used for the gradient fill.
This is only used if the gradient color type is set to ColorRamp.
Definition at line 244 of file qgsfillsymbollayer.h.
|
inline |
Coordinate mode for gradient. Controls how the gradient stops are positioned.
Definition at line 260 of file qgsfillsymbollayer.h.
|
static |
Definition at line 474 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context.
For example, polygons drawn with an stroke will draw half the width of the stroke outside of the polygon. This amount is estimated, since it may be affected by data defined symbology rules.
Reimplemented from QgsSymbolLayer.
Definition at line 911 of file qgsfillsymbollayer.cpp.
|
inline |
Gradient color mode, controls how gradient color stops are created.
Definition at line 235 of file qgsfillsymbollayer.h.
|
inline |
Gradient spread mode. Controls how the gradient behaves outside of the predefined stops.
Definition at line 264 of file qgsfillsymbollayer.h.
|
inline |
Type of gradient, e.g., linear or radial.
Definition at line 231 of file qgsfillsymbollayer.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 QgsSymbolLayer.
Definition at line 564 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 932 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 285 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 292 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 289 of file qgsfillsymbollayer.h.
|
overridevirtual |
Returns the units to use for sizes and widths within the symbol layer.
Individual symbol layer subclasses will interpret this in different ways, e.g., a marker symbol layer may use it to specify the units for the marker size, while a line symbol layer may use it to specify the units for the line width.
Reimplemented from QgsSymbolLayer.
Definition at line 922 of file qgsfillsymbollayer.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 QgsSymbolLayer.
Definition at line 869 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 269 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 273 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 277 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 281 of file qgsfillsymbollayer.h.
|
overridevirtual |
Implements QgsFillSymbolLayer.
Definition at line 840 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 257 of file qgsfillsymbollayer.h.
void QgsGradientFillSymbolLayer::setColorRamp | ( | QgsColorRamp * | ramp | ) |
Sets the color ramp used for the gradient fill.
This is only used if the gradient color type is set to ColorRamp.
ramp | color ramp. Ownership is transferred. |
Definition at line 558 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 261 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 236 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 265 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 232 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 927 of file qgsfillsymbollayer.cpp.
|
inline |
Offset for gradient fill.
Definition at line 284 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 291 of file qgsfillsymbollayer.h.
|
inline |
Units for gradient fill offset.
Definition at line 288 of file qgsfillsymbollayer.h.
|
overridevirtual |
Sets the units to use for sizes and widths within the symbol layer.
Individual symbol layer subclasses will interpret this in different ways, e.g., a marker symbol layer may use it to specify the units for the marker size, while a line symbol layer may use it to specify the units for the line width.
unit | output units |
Reimplemented from QgsSymbolLayer.
Definition at line 917 of file qgsfillsymbollayer.cpp.
|
inline |
Starting point of gradient fill, in the range [0,0] - [1,1].
Definition at line 268 of file qgsfillsymbollayer.h.
|
inline |
Sets the starting point of the gradient to be the feature centroid.
Definition at line 272 of file qgsfillsymbollayer.h.
|
inline |
End point of gradient fill, in the range [0,0] - [1,1].
Definition at line 276 of file qgsfillsymbollayer.h.
|
inline |
Sets the end point of the gradient to be the feature centroid.
Definition at line 280 of file qgsfillsymbollayer.h.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 827 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 835 of file qgsfillsymbollayer.cpp.
|
protected |
Definition at line 301 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 305 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 308 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 304 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 306 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 309 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 307 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 316 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 318 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 317 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 311 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 312 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 313 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 314 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 302 of file qgsfillsymbollayer.h.