QGIS API Documentation 3.29.0-Master (8c80f25a4f)
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
QgsSimpleFillSymbolLayer Class Reference

#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsSimpleFillSymbolLayer:
Inheritance graph
[legend]

Public Member Functions

 QgsSimpleFillSymbolLayer (const QColor &color=DEFAULT_SIMPLEFILL_COLOR, Qt::BrushStyle style=DEFAULT_SIMPLEFILL_STYLE, const QColor &strokeColor=DEFAULT_SIMPLEFILL_BORDERCOLOR, Qt::PenStyle strokeStyle=DEFAULT_SIMPLEFILL_BORDERSTYLE, double strokeWidth=DEFAULT_SIMPLEFILL_BORDERWIDTH, Qt::PenJoinStyle penJoinStyle=DEFAULT_SIMPLEFILL_JOINSTYLE)
 
 ~QgsSimpleFillSymbolLayer () override
 
Qt::BrushStyle brushStyle () const
 
QgsSimpleFillSymbolLayerclone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
double dxfAngle (QgsSymbolRenderContext &context) const override
 Gets angle. More...
 
QColor dxfBrushColor (QgsSymbolRenderContext &context) const override
 Gets brush/fill color. More...
 
Qt::BrushStyle dxfBrushStyle () const override
 Gets brush/fill style. More...
 
QColor dxfColor (QgsSymbolRenderContext &context) const override
 Gets color. More...
 
Qt::PenStyle dxfPenStyle () const override
 Gets pen style. More...
 
double dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
 Gets line width. 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...
 
QColor fillColor () const override
 Returns the fill color for the symbol layer. More...
 
QString layerType () const override
 Returns a string that represents this layer type. More...
 
QgsMapUnitScale mapUnitScale () const override
 
QPointF offset () const
 Returns the offset by which polygons will be translated during rendering. More...
 
const QgsMapUnitScaleoffsetMapUnitScale () const
 Returns the map unit scale for the fill's offset. More...
 
QgsUnitTypes::RenderUnit offsetUnit () const
 Returns the units for the fill's offset. More...
 
QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const override
 
QgsUnitTypes::RenderUnit outputUnit () const override
 Returns the units to use for sizes and widths within the symbol layer. More...
 
Qt::PenJoinStyle penJoinStyle () const
 
QVariantMap 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, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context) override
 Renders the fill symbol layer for the polygon whose outer ring is defined by points, using the given render context. More...
 
void setBrushStyle (Qt::BrushStyle style)
 
void setFillColor (const QColor &color) override
 Sets the fill color for the symbol layer. More...
 
void setMapUnitScale (const QgsMapUnitScale &scale) override
 
void setOffset (QPointF offset)
 Sets an offset by which polygons will be translated during rendering. More...
 
void setOffsetMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for the fill's offset. More...
 
void setOffsetUnit (QgsUnitTypes::RenderUnit unit)
 Sets the unit for the fill's offset. More...
 
void setOutputUnit (QgsUnitTypes::RenderUnit unit) override
 Sets the units to use for sizes and widths within the symbol layer. More...
 
void setPenJoinStyle (Qt::PenJoinStyle style)
 
void setStrokeColor (const QColor &strokeColor) override
 Sets the stroke color for the symbol layer. More...
 
void setStrokeStyle (Qt::PenStyle strokeStyle)
 
void setStrokeWidth (double strokeWidth)
 
void setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale)
 
void setStrokeWidthUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units for the width of the fill's stroke. More...
 
void startRender (QgsSymbolRenderContext &context) override
 Called before a set of rendering operations commences on the supplied render context. More...
 
void stopRender (QgsSymbolRenderContext &context) override
 Called after a set of rendering operations has finished on the supplied render context. More...
 
QColor strokeColor () const override
 Returns the stroke color for the symbol layer. More...
 
Qt::PenStyle strokeStyle () const
 
double strokeWidth () const
 
const QgsMapUnitScalestrokeWidthMapUnitScale () const
 
QgsUnitTypes::RenderUnit strokeWidthUnit () const
 Returns the units for the width of the fill's stroke. More...
 
void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override
 Saves the symbol layer as SLD. More...
 
bool usesMapUnits () const override
 Returns true if the symbol layer has any components which use map unit based sizes. More...
 
- Public Member Functions inherited from QgsFillSymbolLayer
 QgsFillSymbolLayer (const QgsFillSymbolLayer &other)=delete
 QgsFillSymbolLayer cannot be copied. More...
 
double angle () const
 
void drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override
 
QgsFillSymbolLayeroperator= (const QgsFillSymbolLayer &other)=delete
 QgsFillSymbolLayer cannot be copied. More...
 
virtual void renderPolygon (const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context)=0
 Renders the fill symbol layer for the polygon whose outer ring is defined by points, using the given render context. More...
 
void setAngle (double angle)
 
- Public Member Functions inherited from QgsSymbolLayer
 QgsSymbolLayer (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied. More...
 
virtual ~QgsSymbolLayer ()
 
virtual bool canCauseArtifactsBetweenAdjacentTiles () const
 Returns true if the symbol layer rendering can cause visible artifacts across a single feature when the feature is rendered as a series of adjacent map tiles each containing a portion of the feature's geometry. More...
 
virtual QgsSymbolLayerclone () const =0
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
virtual QColor color () const
 Returns the "representative" color of the symbol layer. More...
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the symbol layer's property collection, used for data defined overrides. More...
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the symbol layer's property collection, used for data defined overrides. More...
 
virtual void drawPreviewIcon (QgsSymbolRenderContext &context, QSize size)=0
 
virtual double dxfAngle (QgsSymbolRenderContext &context) const
 Gets angle. More...
 
virtual QColor dxfBrushColor (QgsSymbolRenderContext &context) const
 Gets brush/fill color. More...
 
virtual Qt::BrushStyle dxfBrushStyle () const
 Gets brush/fill style. More...
 
virtual QColor dxfColor (QgsSymbolRenderContext &context) const
 Gets color. More...
 
virtual QVector< qreal > dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const
 Gets dash pattern. More...
 
virtual double dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets offset. More...
 
virtual Qt::PenStyle dxfPenStyle () const
 Gets pen style. More...
 
virtual double dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets line width. More...
 
bool enabled () const
 Returns true if symbol layer is enabled and will be drawn. More...
 
virtual double estimateMaxBleed (const QgsRenderContext &context) const
 Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context. More...
 
virtual QColor fillColor () const
 Returns the fill color for the symbol layer. More...
 
virtual Qgis::SymbolLayerFlags flags () const
 Returns flags which control the symbol layer's behavior. More...
 
virtual bool hasDataDefinedProperties () const
 Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. More...
 
virtual bool isCompatibleWithSymbol (QgsSymbol *symbol) const
 Returns if the layer can be used below the specified symbol. More...
 
bool isLocked () const
 Returns true if the symbol layer colors are locked and the layer will ignore any symbol-level color changes. More...
 
virtual QString layerType () const =0
 Returns a string that represents this layer type. More...
 
virtual QgsMapUnitScale mapUnitScale () const
 
virtual QList< QgsSymbolLayerReferencemasks () const
 Returns masks defined by this symbol layer. More...
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
QgsSymbolLayeroperator= (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied. More...
 
virtual QgsUnitTypes::RenderUnit outputUnit () const
 Returns the units to use for sizes and widths within the symbol layer. More...
 
QgsPaintEffectpaintEffect () 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...
 
virtual void prepareMasks (const QgsSymbolRenderContext &context)
 Prepares all mask internal objects according to what is defined in context This should be called prior to calling startRender() method. More...
 
virtual QVariantMap properties () const =0
 Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. More...
 
int renderingPass () const
 Specifies the rendering pass in which this symbol layer should be rendered. More...
 
virtual void setColor (const QColor &color)
 Sets the "representative" color for the symbol layer. 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)
 Sets the fill color for the symbol layer. More...
 
void setLocked (bool locked)
 Sets whether the layer's colors are locked. More...
 
virtual void setMapUnitScale (const QgsMapUnitScale &scale)
 
virtual void setOutputUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units to use for sizes and widths within the symbol layer. More...
 
void setPaintEffect (QgsPaintEffect *effect)
 Sets the current paint effect for the layer. More...
 
void setRenderingPass (int renderingPass)
 Specifies the rendering pass in which this symbol layer should be rendered. More...
 
virtual void setStrokeColor (const QColor &color)
 Sets the stroke color for the symbol layer. More...
 
virtual bool setSubSymbol (QgsSymbol *symbol)
 Sets layer's subsymbol. takes ownership of the passed symbol. More...
 
virtual void startFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
 Called before the layer will be rendered for a particular feature. More...
 
virtual void startRender (QgsSymbolRenderContext &context)=0
 Called before a set of rendering operations commences on the supplied render context. More...
 
virtual void stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
 Called after the layer has been rendered for a particular feature. More...
 
virtual void stopRender (QgsSymbolRenderContext &context)=0
 Called after a set of rendering operations has finished on the supplied render context. More...
 
virtual QColor strokeColor () const
 Returns the stroke color for the symbol layer. More...
 
virtual QgsSymbolsubSymbol ()
 Returns the symbol's sub symbol, if present. More...
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const
 Saves the symbol layer as SLD. More...
 
Qgis::SymbolType type () const
 
virtual QSet< QString > usedAttributes (const QgsRenderContext &context) const
 Returns the set of attributes referenced by the layer. More...
 
virtual bool usesMapUnits () const
 Returns true if the symbol layer has any components which use map unit based sizes. 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 QgsSymbolLayercreate (const QVariantMap &properties=QVariantMap())
 Creates a new QgsSimpleFillSymbolLayer using the specified properties map containing symbol properties (see properties()). More...
 
static QgsSymbolLayercreateFromSld (QDomElement &element)
 
- Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the symbol layer property definitions. More...
 

Protected Attributes

QBrush mBrush
 
Qt::BrushStyle mBrushStyle
 
QPointF mOffset
 
QgsMapUnitScale mOffsetMapUnitScale
 
QgsUnitTypes::RenderUnit mOffsetUnit = QgsUnitTypes::RenderMillimeters
 
QPen mPen
 
Qt::PenJoinStyle mPenJoinStyle
 
QBrush mSelBrush
 
QPen mSelPen
 
QColor mStrokeColor
 
Qt::PenStyle mStrokeStyle
 
double mStrokeWidth
 
QgsMapUnitScale mStrokeWidthMapUnitScale
 
QgsUnitTypes::RenderUnit mStrokeWidthUnit = QgsUnitTypes::RenderMillimeters
 
- Protected Attributes inherited from QgsFillSymbolLayer
double mAngle = 0.0
 
- Protected Attributes inherited from QgsSymbolLayer
QPainterPath mClipPath
 
QColor mColor
 
QgsPropertyCollection mDataDefinedProperties
 
bool mEnabled = true
 True if layer is enabled and should be drawn. More...
 
QgsFields mFields
 
bool mLocked = false
 
std::unique_ptr< QgsPaintEffectmPaintEffect
 
int mRenderingPass = 0
 
Qgis::SymbolType mType
 

Additional Inherited Members

- Public Types inherited from QgsSymbolLayer
enum  Property {
  PropertySize = 0 , PropertyAngle , PropertyName , PropertyFillColor ,
  PropertyStrokeColor , PropertyStrokeWidth , PropertyStrokeStyle , PropertyOffset ,
  PropertyCharacter , PropertyWidth , PropertyHeight , PropertyPreserveAspectRatio ,
  PropertyFillStyle , PropertyJoinStyle , PropertySecondaryColor , PropertyLineAngle ,
  PropertyLineDistance , PropertyGradientType , PropertyCoordinateMode , PropertyGradientSpread ,
  PropertyGradientReference1X , PropertyGradientReference1Y , PropertyGradientReference2X , PropertyGradientReference2Y ,
  PropertyGradientReference1IsCentroid , PropertyGradientReference2IsCentroid , PropertyBlurRadius , PropertyShapeburstUseWholeShape ,
  PropertyShapeburstMaxDistance , PropertyShapeburstIgnoreRings , PropertyFile , PropertyDistanceX ,
  PropertyDistanceY , PropertyDisplacementX , PropertyDisplacementY , PropertyOpacity ,
  PropertyCustomDash , PropertyCapStyle , PropertyPlacement , PropertyInterval ,
  PropertyOffsetAlongLine , PropertyAverageAngleLength , PropertyHorizontalAnchor , PropertyVerticalAnchor ,
  PropertyLayerEnabled , PropertyArrowWidth , PropertyArrowStartWidth , PropertyArrowHeadLength ,
  PropertyArrowHeadThickness , PropertyArrowHeadType , PropertyArrowType , PropertyOffsetX ,
  PropertyOffsetY , PropertyPointCount , PropertyRandomSeed , PropertyClipPoints ,
  PropertyDensityArea , PropertyFontFamily , PropertyFontStyle , PropertyDashPatternOffset ,
  PropertyTrimStart , PropertyTrimEnd , PropertyLineStartWidthValue , PropertyLineEndWidthValue ,
  PropertyLineStartColorValue , PropertyLineEndColorValue , PropertyMarkerClipping , PropertyRandomOffsetX ,
  PropertyRandomOffsetY , PropertyLineClipping
}
 Data definable properties. More...
 
- Protected Member Functions inherited from QgsFillSymbolLayer
 QgsFillSymbolLayer (bool locked=false)
 
void _renderPolygon (QPainter *p, const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context)
 Default method to render polygon. More...
 
- Protected Member Functions inherited from QgsSymbolLayer
 QgsSymbolLayer (Qgis::SymbolType type, bool locked=false)
 Constructor for QgsSymbolLayer. More...
 
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 QVariantMap &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...
 

Detailed Description

Definition at line 43 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsSimpleFillSymbolLayer()

QgsSimpleFillSymbolLayer::QgsSimpleFillSymbolLayer ( const QColor &  color = DEFAULT_SIMPLEFILL_COLOR,
Qt::BrushStyle  style = DEFAULT_SIMPLEFILL_STYLE,
const QColor &  strokeColor = DEFAULT_SIMPLEFILL_BORDERCOLOR,
Qt::PenStyle  strokeStyle = DEFAULT_SIMPLEFILL_BORDERSTYLE,
double  strokeWidth = DEFAULT_SIMPLEFILL_BORDERWIDTH,
Qt::PenJoinStyle  penJoinStyle = DEFAULT_SIMPLEFILL_JOINSTYLE 
)

Definition at line 55 of file qgsfillsymbollayer.cpp.

◆ ~QgsSimpleFillSymbolLayer()

QgsSimpleFillSymbolLayer::~QgsSimpleFillSymbolLayer ( )
overridedefault

Member Function Documentation

◆ brushStyle()

Qt::BrushStyle QgsSimpleFillSymbolLayer::brushStyle ( ) const
inline

Definition at line 84 of file qgsfillsymbollayer.h.

◆ clone()

QgsSimpleFillSymbolLayer * QgsSimpleFillSymbolLayer::clone ( ) const
overridevirtual

Shall be reimplemented by subclasses to create a deep copy of the instance.

Implements QgsSymbolLayer.

Definition at line 376 of file qgsfillsymbollayer.cpp.

◆ create()

QgsSymbolLayer * QgsSimpleFillSymbolLayer::create ( const QVariantMap &  properties = QVariantMap())
static

Creates a new QgsSimpleFillSymbolLayer using the specified properties map containing symbol properties (see properties()).

Caller takes ownership of the returned symbol layer.

Definition at line 171 of file qgsfillsymbollayer.cpp.

◆ createFromSld()

QgsSymbolLayer * QgsSimpleFillSymbolLayer::createFromSld ( QDomElement &  element)
static

Definition at line 453 of file qgsfillsymbollayer.cpp.

◆ dxfAngle()

double QgsSimpleFillSymbolLayer::dxfAngle ( QgsSymbolRenderContext context) const
overridevirtual

Gets angle.

Reimplemented from QgsSymbolLayer.

Definition at line 511 of file qgsfillsymbollayer.cpp.

◆ dxfBrushColor()

QColor QgsSimpleFillSymbolLayer::dxfBrushColor ( QgsSymbolRenderContext context) const
overridevirtual

Gets brush/fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 527 of file qgsfillsymbollayer.cpp.

◆ dxfBrushStyle()

Qt::BrushStyle QgsSimpleFillSymbolLayer::dxfBrushStyle ( ) const
overridevirtual

Gets brush/fill style.

Reimplemented from QgsSymbolLayer.

Definition at line 537 of file qgsfillsymbollayer.cpp.

◆ dxfColor()

QColor QgsSimpleFillSymbolLayer::dxfColor ( QgsSymbolRenderContext context) const
overridevirtual

Gets color.

Reimplemented from QgsSymbolLayer.

Definition at line 500 of file qgsfillsymbollayer.cpp.

◆ dxfPenStyle()

Qt::PenStyle QgsSimpleFillSymbolLayer::dxfPenStyle ( ) const
overridevirtual

Gets pen style.

Reimplemented from QgsSymbolLayer.

Definition at line 522 of file qgsfillsymbollayer.cpp.

◆ dxfWidth()

double QgsSimpleFillSymbolLayer::dxfWidth ( const QgsDxfExport e,
QgsSymbolRenderContext context 
) const
overridevirtual

Gets line width.

Reimplemented from QgsSymbolLayer.

Definition at line 489 of file qgsfillsymbollayer.cpp.

◆ estimateMaxBleed()

double QgsSimpleFillSymbolLayer::estimateMaxBleed ( const QgsRenderContext context) const
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 482 of file qgsfillsymbollayer.cpp.

◆ fillColor()

QColor QgsSimpleFillSymbolLayer::fillColor ( ) const
inlineoverridevirtual

Returns the fill color for the symbol layer.

This property is not supported by all symbol layer types, only those with a fill component. Symbol layers without a fill component will return an invalid QColor.

See also
setFillColor()
color()
strokeColor()
Since
QGIS 2.1

Reimplemented from QgsSymbolLayer.

Definition at line 90 of file qgsfillsymbollayer.h.

◆ layerType()

QString QgsSimpleFillSymbolLayer::layerType ( ) const
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 258 of file qgsfillsymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsSimpleFillSymbolLayer::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 96 of file qgsfillsymbollayer.cpp.

◆ offset()

QPointF QgsSimpleFillSymbolLayer::offset ( ) const
inline

Returns the offset by which polygons will be translated during rendering.

Units are specified by offsetUnit().

See also
setOffset()
offsetUnit()

Definition at line 120 of file qgsfillsymbollayer.h.

◆ offsetMapUnitScale()

const QgsMapUnitScale & QgsSimpleFillSymbolLayer::offsetMapUnitScale ( ) const
inline

Returns the map unit scale for the fill's offset.

See also
offset()
setOffsetMapUnitScale()

Definition at line 164 of file qgsfillsymbollayer.h.

◆ offsetUnit()

QgsUnitTypes::RenderUnit QgsSimpleFillSymbolLayer::offsetUnit ( ) const
inline

Returns the units for the fill's offset.

See also
setOffsetUnit()
offset()

Definition at line 150 of file qgsfillsymbollayer.h.

◆ ogrFeatureStyle()

QString QgsSimpleFillSymbolLayer::ogrFeatureStyle ( double  mmScaleFactor,
double  mapUnitScaleFactor 
) const
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 442 of file qgsfillsymbollayer.cpp.

◆ outputUnit()

QgsUnitTypes::RenderUnit QgsSimpleFillSymbolLayer::outputUnit ( ) const
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.

Returns
output unit, or QgsUnitTypes::RenderUnknownUnit if the symbol layer contains mixed units
See also
setOutputUnit()

Reimplemented from QgsSymbolLayer.

Definition at line 74 of file qgsfillsymbollayer.cpp.

◆ penJoinStyle()

Qt::PenJoinStyle QgsSimpleFillSymbolLayer::penJoinStyle ( ) const
inline

Definition at line 99 of file qgsfillsymbollayer.h.

◆ properties()

QVariantMap QgsSimpleFillSymbolLayer::properties ( ) const
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 359 of file qgsfillsymbollayer.cpp.

◆ renderPolygon()

void QgsSimpleFillSymbolLayer::renderPolygon ( const QPolygonF &  points,
const QVector< QPolygonF > *  rings,
QgsSymbolRenderContext context 
)
overridevirtual

Renders the fill symbol layer for the polygon whose outer ring is defined by points, using the given render context.

The rings argument optionally specifies a list of polygon rings to render as holes.

Implements QgsFillSymbolLayer.

Definition at line 293 of file qgsfillsymbollayer.cpp.

◆ setBrushStyle()

void QgsSimpleFillSymbolLayer::setBrushStyle ( Qt::BrushStyle  style)
inline

Definition at line 85 of file qgsfillsymbollayer.h.

◆ setFillColor()

void QgsSimpleFillSymbolLayer::setFillColor ( const QColor &  color)
inlineoverridevirtual

Sets the fill color for the symbol layer.

This property is not supported by all symbol layer types, only those with a fill component.

See also
fillColor()
setColor()
setStrokeColor()
Since
QGIS 2.1

Reimplemented from QgsSymbolLayer.

Definition at line 91 of file qgsfillsymbollayer.h.

◆ setMapUnitScale()

void QgsSimpleFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 90 of file qgsfillsymbollayer.cpp.

◆ setOffset()

void QgsSimpleFillSymbolLayer::setOffset ( QPointF  offset)
inline

Sets an offset by which polygons will be translated during rendering.

Units are specified by offsetUnit().

See also
offset()
setOffsetUnit()

Definition at line 110 of file qgsfillsymbollayer.h.

◆ setOffsetMapUnitScale()

void QgsSimpleFillSymbolLayer::setOffsetMapUnitScale ( const QgsMapUnitScale scale)
inline

Sets the map unit scale for the fill's offset.

See also
setOffset()
offsetMapUnitScale()

Definition at line 157 of file qgsfillsymbollayer.h.

◆ setOffsetUnit()

void QgsSimpleFillSymbolLayer::setOffsetUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the unit for the fill's offset.

See also
offset()
offsetUnit()

Definition at line 143 of file qgsfillsymbollayer.h.

◆ setOutputUnit()

void QgsSimpleFillSymbolLayer::setOutputUnit ( QgsUnitTypes::RenderUnit  unit)
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.

Parameters
unitoutput units
See also
outputUnit()

Reimplemented from QgsSymbolLayer.

Definition at line 68 of file qgsfillsymbollayer.cpp.

◆ setPenJoinStyle()

void QgsSimpleFillSymbolLayer::setPenJoinStyle ( Qt::PenJoinStyle  style)
inline

Definition at line 100 of file qgsfillsymbollayer.h.

◆ setStrokeColor()

void QgsSimpleFillSymbolLayer::setStrokeColor ( const QColor &  color)
inlineoverridevirtual

Sets the stroke color for the symbol layer.

This property is not supported by all symbol layer types, only those with a stroke component.

See also
strokeColor()
setColor()
setFillColor()
Since
QGIS 2.1

Reimplemented from QgsSymbolLayer.

Definition at line 88 of file qgsfillsymbollayer.h.

◆ setStrokeStyle()

void QgsSimpleFillSymbolLayer::setStrokeStyle ( Qt::PenStyle  strokeStyle)
inline

Definition at line 94 of file qgsfillsymbollayer.h.

◆ setStrokeWidth()

void QgsSimpleFillSymbolLayer::setStrokeWidth ( double  strokeWidth)
inline

Definition at line 97 of file qgsfillsymbollayer.h.

◆ setStrokeWidthMapUnitScale()

void QgsSimpleFillSymbolLayer::setStrokeWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 135 of file qgsfillsymbollayer.h.

◆ setStrokeWidthUnit()

void QgsSimpleFillSymbolLayer::setStrokeWidthUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the units for the width of the fill's stroke.

Parameters
unitwidth units
See also
strokeWidthUnit()

Definition at line 127 of file qgsfillsymbollayer.h.

◆ startRender()

void QgsSimpleFillSymbolLayer::startRender ( QgsSymbolRenderContext context)
overridevirtual

Called before a set of rendering operations commences on the supplied render context.

This is always followed by a call to stopRender() after all rendering operations have been completed.

Subclasses can use this method to prepare for a set of rendering operations, e.g. by pre-evaluating paths or images to render, and performing other one-time optimisations.

See also
startFeatureRender()
stopRender()

Implements QgsSymbolLayer.

Definition at line 263 of file qgsfillsymbollayer.cpp.

◆ stopRender()

void QgsSimpleFillSymbolLayer::stopRender ( QgsSymbolRenderContext context)
overridevirtual

Called after a set of rendering operations has finished on the supplied render context.

This is always preceded by a call to startRender() before all rendering operations are commenced.

Subclasses can use this method to cleanup after a set of rendering operations.

See also
startRender()
stopFeatureRender()

Implements QgsSymbolLayer.

Definition at line 288 of file qgsfillsymbollayer.cpp.

◆ strokeColor()

QColor QgsSimpleFillSymbolLayer::strokeColor ( ) const
inlineoverridevirtual

Returns the stroke color for the symbol layer.

This property is not supported by all symbol layer types, only those with a stroke component. Symbol layers without a stroke component will return an invalid QColor.

See also
setStrokeColor()
color()
fillColor()
Since
QGIS 2.1

Reimplemented from QgsSymbolLayer.

Definition at line 87 of file qgsfillsymbollayer.h.

◆ strokeStyle()

Qt::PenStyle QgsSimpleFillSymbolLayer::strokeStyle ( ) const
inline

Definition at line 93 of file qgsfillsymbollayer.h.

◆ strokeWidth()

double QgsSimpleFillSymbolLayer::strokeWidth ( ) const
inline

Definition at line 96 of file qgsfillsymbollayer.h.

◆ strokeWidthMapUnitScale()

const QgsMapUnitScale & QgsSimpleFillSymbolLayer::strokeWidthMapUnitScale ( ) const
inline

Definition at line 136 of file qgsfillsymbollayer.h.

◆ strokeWidthUnit()

QgsUnitTypes::RenderUnit QgsSimpleFillSymbolLayer::strokeWidthUnit ( ) const
inline

Returns the units for the width of the fill's stroke.

See also
setStrokeWidthUnit()

Definition at line 133 of file qgsfillsymbollayer.h.

◆ toSld()

void QgsSimpleFillSymbolLayer::toSld ( QDomDocument &  doc,
QDomElement &  element,
const QVariantMap &  props 
) const
overridevirtual

Saves the symbol layer as SLD.

Reimplemented from QgsSymbolLayer.

Definition at line 389 of file qgsfillsymbollayer.cpp.

◆ usesMapUnits()

bool QgsSimpleFillSymbolLayer::usesMapUnits ( ) const
overridevirtual

Returns true if the symbol layer has any components which use map unit based sizes.

Since
QGIS 3.18

Reimplemented from QgsSymbolLayer.

Definition at line 84 of file qgsfillsymbollayer.cpp.

Member Data Documentation

◆ mBrush

QBrush QgsSimpleFillSymbolLayer::mBrush
protected

Definition at line 184 of file qgsfillsymbollayer.h.

◆ mBrushStyle

Qt::BrushStyle QgsSimpleFillSymbolLayer::mBrushStyle
protected

Definition at line 186 of file qgsfillsymbollayer.h.

◆ mOffset

QPointF QgsSimpleFillSymbolLayer::mOffset
protected

Definition at line 196 of file qgsfillsymbollayer.h.

◆ mOffsetMapUnitScale

QgsMapUnitScale QgsSimpleFillSymbolLayer::mOffsetMapUnitScale
protected

Definition at line 198 of file qgsfillsymbollayer.h.

◆ mOffsetUnit

QgsUnitTypes::RenderUnit QgsSimpleFillSymbolLayer::mOffsetUnit = QgsUnitTypes::RenderMillimeters
protected

Definition at line 197 of file qgsfillsymbollayer.h.

◆ mPen

QPen QgsSimpleFillSymbolLayer::mPen
protected

Definition at line 193 of file qgsfillsymbollayer.h.

◆ mPenJoinStyle

Qt::PenJoinStyle QgsSimpleFillSymbolLayer::mPenJoinStyle
protected

Definition at line 192 of file qgsfillsymbollayer.h.

◆ mSelBrush

QBrush QgsSimpleFillSymbolLayer::mSelBrush
protected

Definition at line 185 of file qgsfillsymbollayer.h.

◆ mSelPen

QPen QgsSimpleFillSymbolLayer::mSelPen
protected

Definition at line 194 of file qgsfillsymbollayer.h.

◆ mStrokeColor

QColor QgsSimpleFillSymbolLayer::mStrokeColor
protected

Definition at line 187 of file qgsfillsymbollayer.h.

◆ mStrokeStyle

Qt::PenStyle QgsSimpleFillSymbolLayer::mStrokeStyle
protected

Definition at line 188 of file qgsfillsymbollayer.h.

◆ mStrokeWidth

double QgsSimpleFillSymbolLayer::mStrokeWidth
protected

Definition at line 189 of file qgsfillsymbollayer.h.

◆ mStrokeWidthMapUnitScale

QgsMapUnitScale QgsSimpleFillSymbolLayer::mStrokeWidthMapUnitScale
protected

Definition at line 191 of file qgsfillsymbollayer.h.

◆ mStrokeWidthUnit

QgsUnitTypes::RenderUnit QgsSimpleFillSymbolLayer::mStrokeWidthUnit = QgsUnitTypes::RenderMillimeters
protected

Definition at line 190 of file qgsfillsymbollayer.h.


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