QGIS API Documentation  3.17.0-Master (7a14973234)
Classes | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
QgsCentroidFillSymbolLayer Class Reference

#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsCentroidFillSymbolLayer:
Inheritance graph
[legend]

Public Member Functions

 QgsCentroidFillSymbolLayer ()
 
bool clipOnCurrentPartOnly () const
 Returns true if point markers should be clipped to the current part boundary only. More...
 
bool clipPoints () const
 Returns true if point markers should be clipped to the polygon boundary. More...
 
QgsCentroidFillSymbolLayerclone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
QColor color () const override
 The fill color. More...
 
bool hasDataDefinedProperties () const override
 Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. More...
 
QString layerType () const override
 Returns a string that represents this layer type. More...
 
QgsMapUnitScale mapUnitScale () const override
 
QgsUnitTypes::RenderUnit outputUnit () const override
 Returns the units to use for sizes and widths within the symbol layer. More...
 
bool pointOnAllParts () const
 Returns whether a point is drawn for all parts or only on the biggest part of multi-part features. More...
 
bool pointOnSurface () const
 
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, 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 setClipOnCurrentPartOnly (bool clipOnCurrentPartOnly)
 Sets whether point markers should be clipped to the current part boundary only. More...
 
void setClipPoints (bool clipPoints)
 Sets whether point markers should be clipped to the polygon boundary. More...
 
void setColor (const QColor &color) override
 The fill color. More...
 
void setMapUnitScale (const QgsMapUnitScale &scale) override
 
void setOutputUnit (QgsUnitTypes::RenderUnit unit) override
 Sets the units to use for sizes and widths within the symbol layer. More...
 
void setPointOnAllParts (bool pointOnAllParts)
 Sets whether a point is drawn for all parts or only on the biggest part of multi-part features. More...
 
void setPointOnSurface (bool pointOnSurface)
 
bool setSubSymbol (QgsSymbol *symbol) override
 Sets layer's subsymbol. takes ownership of the passed symbol. More...
 
void startFeatureRender (const QgsFeature &feature, QgsRenderContext &context) override
 Called before the layer will be rendered for a particular feature. More...
 
void startRender (QgsSymbolRenderContext &context) override
 Called before a set of rendering operations commences on the supplied render context. More...
 
void stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context) override
 Called after the layer has been rendered for a particular feature. More...
 
void stopRender (QgsSymbolRenderContext &context) override
 Called after a set of rendering operations has finished on the supplied render context. More...
 
QgsSymbolsubSymbol () override
 Returns the symbol's sub symbol, if present. More...
 
void toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override
 
QSet< QString > usedAttributes (const QgsRenderContext &context) const override
 Returns the set of attributes referenced by the layer. 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...
 
void setAngle (double angle)
 
- Public Member Functions inherited from QgsSymbolLayer
 QgsSymbolLayer (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied. More...
 
virtual ~QgsSymbolLayer ()
 
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 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
 Gets 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 QgsSymbolLayerReferenceList masks () 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...
 
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...
 
int renderingPass () const
 Specifies the rendering pass in which this symbol layer should be rendered. 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)
 Specifies the rendering pass in which this symbol layer should be rendered. More...
 
virtual void setStrokeColor (const QColor &color)
 Set stroke color. More...
 
virtual QColor strokeColor () const
 Gets stroke color. More...
 
QgsSymbol::SymbolType type () const
 
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 QgsStringMap &properties=QgsStringMap())
 Creates a new QgsCentroidFillSymbolLayer 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

int mBiggestPartIndex = -1
 
bool mClipOnCurrentPartOnly = false
 
bool mClipPoints = false
 
QgsFeatureId mCurrentFeatureId = -1
 
std::unique_ptr< QgsMarkerSymbolmMarker
 
bool mPointOnAllParts = true
 
bool mPointOnSurface = false
 
bool mRenderingFeature = false
 
- Protected Attributes inherited from QgsFillSymbolLayer
double mAngle = 0.0
 
- Protected Attributes inherited from QgsSymbolLayer
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
 
QgsSymbol::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
}
 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 (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...
 

Detailed Description

Definition at line 1999 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsCentroidFillSymbolLayer()

QgsCentroidFillSymbolLayer::QgsCentroidFillSymbolLayer ( )

Definition at line 3701 of file qgsfillsymbollayer.cpp.

Member Function Documentation

◆ clipOnCurrentPartOnly()

bool QgsCentroidFillSymbolLayer::clipOnCurrentPartOnly ( ) const
inline

Returns true if point markers should be clipped to the current part boundary only.

See also
setClipPoints()
Since
3.14

Definition at line 2084 of file qgsfillsymbollayer.h.

◆ clipPoints()

bool QgsCentroidFillSymbolLayer::clipPoints ( ) const
inline

Returns true if point markers should be clipped to the polygon boundary.

See also
setClipPoints()
Since
3.14

Definition at line 2068 of file qgsfillsymbollayer.h.

◆ clone()

QgsCentroidFillSymbolLayer * QgsCentroidFillSymbolLayer::clone ( ) const
overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 3881 of file qgsfillsymbollayer.cpp.

◆ color()

QColor QgsCentroidFillSymbolLayer::color ( ) const
overridevirtual

The fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 3735 of file qgsfillsymbollayer.cpp.

◆ create()

QgsSymbolLayer * QgsCentroidFillSymbolLayer::create ( const QgsStringMap properties = QgsStringMap())
static

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

Caller takes ownership of the returned symbol layer.

Definition at line 3706 of file qgsfillsymbollayer.cpp.

◆ createFromSld()

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

Definition at line 3904 of file qgsfillsymbollayer.cpp.

◆ hasDataDefinedProperties()

bool QgsCentroidFillSymbolLayer::hasDataDefinedProperties ( ) const
overridevirtual

Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties.

Since
QGIS 3.4.5

Reimplemented from QgsSymbolLayer.

Definition at line 3949 of file qgsfillsymbollayer.cpp.

◆ layerType()

QString QgsCentroidFillSymbolLayer::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 3724 of file qgsfillsymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsCentroidFillSymbolLayer::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 3983 of file qgsfillsymbollayer.cpp.

◆ outputUnit()

QgsUnitTypes::RenderUnit QgsCentroidFillSymbolLayer::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 3966 of file qgsfillsymbollayer.cpp.

◆ pointOnAllParts()

bool QgsCentroidFillSymbolLayer::pointOnAllParts ( ) const
inline

Returns whether a point is drawn for all parts or only on the biggest part of multi-part features.

See also
setPointOnAllParts()
Since
QGIS 2.16

Definition at line 2060 of file qgsfillsymbollayer.h.

◆ pointOnSurface()

bool QgsCentroidFillSymbolLayer::pointOnSurface ( ) const
inline

Definition at line 2046 of file qgsfillsymbollayer.h.

◆ properties()

QgsStringMap QgsCentroidFillSymbolLayer::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 3871 of file qgsfillsymbollayer.cpp.

◆ renderPolygon()

void QgsCentroidFillSymbolLayer::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 3754 of file qgsfillsymbollayer.cpp.

◆ setClipOnCurrentPartOnly()

void QgsCentroidFillSymbolLayer::setClipOnCurrentPartOnly ( bool  clipOnCurrentPartOnly)
inline

Sets whether point markers should be clipped to the current part boundary only.

See also
clipOnCurrentPartOnly()
Since
3.14

Definition at line 2092 of file qgsfillsymbollayer.h.

◆ setClipPoints()

void QgsCentroidFillSymbolLayer::setClipPoints ( bool  clipPoints)
inline

Sets whether point markers should be clipped to the polygon boundary.

See also
clipPoints()
Since
3.14

Definition at line 2076 of file qgsfillsymbollayer.h.

◆ setColor()

void QgsCentroidFillSymbolLayer::setColor ( const QColor &  color)
overridevirtual

The fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 3729 of file qgsfillsymbollayer.cpp.

◆ setMapUnitScale()

void QgsCentroidFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 3975 of file qgsfillsymbollayer.cpp.

◆ setOutputUnit()

void QgsCentroidFillSymbolLayer::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 3958 of file qgsfillsymbollayer.cpp.

◆ setPointOnAllParts()

void QgsCentroidFillSymbolLayer::setPointOnAllParts ( bool  pointOnAllParts)
inline

Sets whether a point is drawn for all parts or only on the biggest part of multi-part features.

See also
pointOnAllParts()
Since
QGIS 2.16

Definition at line 2053 of file qgsfillsymbollayer.h.

◆ setPointOnSurface()

void QgsCentroidFillSymbolLayer::setPointOnSurface ( bool  pointOnSurface)
inline

Definition at line 2045 of file qgsfillsymbollayer.h.

◆ setSubSymbol()

bool QgsCentroidFillSymbolLayer::setSubSymbol ( QgsSymbol symbol)
overridevirtual

Sets layer's subsymbol. takes ownership of the passed symbol.

Reimplemented from QgsSymbolLayer.

Definition at line 3926 of file qgsfillsymbollayer.cpp.

◆ startFeatureRender()

void QgsCentroidFillSymbolLayer::startFeatureRender ( const QgsFeature feature,
QgsRenderContext context 
)
overridevirtual

Called before the layer will be rendered for a particular feature.

This is always followed by a call to stopFeatureRender() after the feature has been completely rendered (i.e. all parts have been rendered).

The default implementation does nothing.

Note
In some circumstances, startFeatureRender() and stopFeatureRender() may not be called before a symbol layer is rendered. E.g., when a symbol layer is being rendered in isolation and not as a result of rendering a feature (for instance, when rendering a legend patch or other non-feature based shape).
See also
stopFeatureRender()
startRender()
Since
QGIS 3.12

Reimplemented from QgsSymbolLayer.

Definition at line 3774 of file qgsfillsymbollayer.cpp.

◆ startRender()

void QgsCentroidFillSymbolLayer::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 3740 of file qgsfillsymbollayer.cpp.

◆ stopFeatureRender()

void QgsCentroidFillSymbolLayer::stopFeatureRender ( const QgsFeature feature,
QgsRenderContext context 
)
overridevirtual

Called after the layer has been rendered for a particular feature.

This is always preceded by a call to startFeatureRender() just before the feature will be rendered.

The default implementation does nothing.

Note
In some circumstances, startFeatureRender() and stopFeatureRender() may not be called before a symbol layer is rendered. E.g., when a symbol layer is being rendered in isolation and not as a result of rendering a feature (for instance, when rendering a legend patch or other non-feature based shape).
See also
startFeatureRender()
stopRender()
Since
QGIS 3.12

Reimplemented from QgsSymbolLayer.

Definition at line 3780 of file qgsfillsymbollayer.cpp.

◆ stopRender()

void QgsCentroidFillSymbolLayer::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 3749 of file qgsfillsymbollayer.cpp.

◆ subSymbol()

QgsSymbol * QgsCentroidFillSymbolLayer::subSymbol ( )
overridevirtual

Returns the symbol's sub symbol, if present.

Reimplemented from QgsSymbolLayer.

Definition at line 3921 of file qgsfillsymbollayer.cpp.

◆ toSld()

void QgsCentroidFillSymbolLayer::toSld ( QDomDocument &  doc,
QDomElement &  element,
const QgsStringMap props 
) const
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 3896 of file qgsfillsymbollayer.cpp.

◆ usedAttributes()

QSet< QString > QgsCentroidFillSymbolLayer::usedAttributes ( const QgsRenderContext context) const
overridevirtual

Returns the set of attributes referenced by the layer.

This includes attributes required by any data defined properties associated with the layer.

Reimplemented from QgsSymbolLayer.

Definition at line 3939 of file qgsfillsymbollayer.cpp.

Member Data Documentation

◆ mBiggestPartIndex

int QgsCentroidFillSymbolLayer::mBiggestPartIndex = -1
protected

Definition at line 2108 of file qgsfillsymbollayer.h.

◆ mClipOnCurrentPartOnly

bool QgsCentroidFillSymbolLayer::mClipOnCurrentPartOnly = false
protected

Definition at line 2103 of file qgsfillsymbollayer.h.

◆ mClipPoints

bool QgsCentroidFillSymbolLayer::mClipPoints = false
protected

Definition at line 2102 of file qgsfillsymbollayer.h.

◆ mCurrentFeatureId

QgsFeatureId QgsCentroidFillSymbolLayer::mCurrentFeatureId = -1
protected

Definition at line 2107 of file qgsfillsymbollayer.h.

◆ mMarker

std::unique_ptr< QgsMarkerSymbol > QgsCentroidFillSymbolLayer::mMarker
protected

Definition at line 2099 of file qgsfillsymbollayer.h.

◆ mPointOnAllParts

bool QgsCentroidFillSymbolLayer::mPointOnAllParts = true
protected

Definition at line 2101 of file qgsfillsymbollayer.h.

◆ mPointOnSurface

bool QgsCentroidFillSymbolLayer::mPointOnSurface = false
protected

Definition at line 2100 of file qgsfillsymbollayer.h.

◆ mRenderingFeature

bool QgsCentroidFillSymbolLayer::mRenderingFeature = false
protected

Definition at line 2105 of file qgsfillsymbollayer.h.


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