QGIS API Documentation  3.3.0-Master (1bf63f1)
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 ()
 
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...
 
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, QList< QPolygonF > *rings, QgsSymbolRenderContext &context) override
 
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 startRender (QgsSymbolRenderContext &context) override
 
void stopRender (QgsSymbolRenderContext &context) override
 
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
double angle () const
 
void drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override
 
void setAngle (double angle)
 
- Public Member Functions inherited from QgsSymbolLayer
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 QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
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
 
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 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())
 
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
 
QgsFeatureId mCurrentFeatureId = -1
 
std::unique_ptr< QgsMarkerSymbolmMarker
 
bool mPointOnAllParts = true
 
bool mPointOnSurface = false
 
- 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
 
QgsPaintEffectmPaintEffect = nullptr
 
int mRenderingPass
 
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, PropertyHorizontalAnchor, PropertyVerticalAnchor, PropertyLayerEnabled,
  PropertyArrowWidth, PropertyArrowStartWidth, PropertyArrowHeadLength, PropertyArrowHeadThickness,
  PropertyArrowHeadType, PropertyArrowType
}
 Data definable properties. More...
 
- 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...
 

Detailed Description

Definition at line 1596 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsCentroidFillSymbolLayer()

QgsCentroidFillSymbolLayer::QgsCentroidFillSymbolLayer ( )

Definition at line 3354 of file qgsfillsymbollayer.cpp.

Member Function Documentation

◆ clone()

QgsCentroidFillSymbolLayer * QgsCentroidFillSymbolLayer::clone ( ) const
overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 3453 of file qgsfillsymbollayer.cpp.

◆ color()

QColor QgsCentroidFillSymbolLayer::color ( ) const
overridevirtual

The fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 3384 of file qgsfillsymbollayer.cpp.

◆ create()

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

Definition at line 3359 of file qgsfillsymbollayer.cpp.

◆ createFromSld()

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

Definition at line 3474 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 3373 of file qgsfillsymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsCentroidFillSymbolLayer::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 3543 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 3526 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.

Since
QGIS 2.16

Definition at line 1647 of file qgsfillsymbollayer.h.

◆ pointOnSurface()

bool QgsCentroidFillSymbolLayer::pointOnSurface ( ) const
inline

Definition at line 1637 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 3445 of file qgsfillsymbollayer.cpp.

◆ renderPolygon()

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

Implements QgsFillSymbolLayer.

Definition at line 3403 of file qgsfillsymbollayer.cpp.

◆ setColor()

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

The fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 3378 of file qgsfillsymbollayer.cpp.

◆ setMapUnitScale()

void QgsCentroidFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 3535 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 3518 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.

Since
QGIS 2.16

Definition at line 1642 of file qgsfillsymbollayer.h.

◆ setPointOnSurface()

void QgsCentroidFillSymbolLayer::setPointOnSurface ( bool  pointOnSurface)
inline

Definition at line 1636 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 3495 of file qgsfillsymbollayer.cpp.

◆ startRender()

void QgsCentroidFillSymbolLayer::startRender ( QgsSymbolRenderContext context)
overridevirtual

Implements QgsSymbolLayer.

Definition at line 3389 of file qgsfillsymbollayer.cpp.

◆ stopRender()

void QgsCentroidFillSymbolLayer::stopRender ( QgsSymbolRenderContext context)
overridevirtual

Implements QgsSymbolLayer.

Definition at line 3398 of file qgsfillsymbollayer.cpp.

◆ subSymbol()

QgsSymbol * QgsCentroidFillSymbolLayer::subSymbol ( )
overridevirtual

Returns the symbol's sub symbol, if present.

Reimplemented from QgsSymbolLayer.

Definition at line 3490 of file qgsfillsymbollayer.cpp.

◆ toSld()

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

Reimplemented from QgsSymbolLayer.

Definition at line 3466 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 3508 of file qgsfillsymbollayer.cpp.

Member Data Documentation

◆ mBiggestPartIndex

int QgsCentroidFillSymbolLayer::mBiggestPartIndex = -1
protected

Definition at line 1655 of file qgsfillsymbollayer.h.

◆ mCurrentFeatureId

QgsFeatureId QgsCentroidFillSymbolLayer::mCurrentFeatureId = -1
protected

Definition at line 1654 of file qgsfillsymbollayer.h.

◆ mMarker

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

Definition at line 1650 of file qgsfillsymbollayer.h.

◆ mPointOnAllParts

bool QgsCentroidFillSymbolLayer::mPointOnAllParts = true
protected

Definition at line 1652 of file qgsfillsymbollayer.h.

◆ mPointOnSurface

bool QgsCentroidFillSymbolLayer::mPointOnSurface = false
protected

Definition at line 1651 of file qgsfillsymbollayer.h.


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