QGIS API Documentation  3.2.0-Bonn (bc43194)
Public Member Functions | Static Public Member Functions | List of all members
QgsGeometryGeneratorSymbolLayer Class Reference

#include <qgsgeometrygeneratorsymbollayer.h>

Inheritance diagram for QgsGeometryGeneratorSymbolLayer:
Inheritance graph
[legend]

Public Member Functions

 ~QgsGeometryGeneratorSymbolLayer () override
 
QgsSymbolLayerclone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
void drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override
 
QString geometryExpression () const
 Gets the expression to generate this geometry. More...
 
bool isCompatibleWithSymbol (QgsSymbol *symbol) const override
 Will always return true. More...
 
QString layerType () const override
 Returns a string that represents this layer type. 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...
 
virtual void render (QgsSymbolRenderContext &context)
 Will render this symbol layer using the context. More...
 
void setColor (const QColor &color) override
 The fill color. More...
 
void setGeometryExpression (const QString &exp)
 Set the expression to generate this geometry. More...
 
bool setSubSymbol (QgsSymbol *symbol) override
 Sets layer's subsymbol. takes ownership of the passed symbol. More...
 
void setSymbolType (QgsSymbol::SymbolType symbolType)
 Set the type of symbol which should be created. More...
 
void startRender (QgsSymbolRenderContext &context) override
 
void stopRender (QgsSymbolRenderContext &context) override
 
QgsSymbolsubSymbol () override
 Returns the symbol's sub symbol, if present. More...
 
QgsSymbol::SymbolType symbolType () const
 Access the symbol type. More...
 
QSet< QString > usedAttributes (const QgsRenderContext &context) const override
 Returns the set of attributes referenced by the layer. More...
 
- Public Member Functions inherited from QgsSymbolLayer
virtual ~QgsSymbolLayer ()
 
virtual QColor color () const
 The fill color. 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 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...
 
bool isLocked () const
 
virtual QgsMapUnitScale mapUnitScale () const
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
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...
 
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)
 
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)
 
virtual void setStrokeColor (const QColor &color)
 Set stroke color. More...
 
virtual QColor strokeColor () const
 Gets stroke color. More...
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const
 
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)
 
- Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the symbol layer property definitions. More...
 

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 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...
 
- 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
 
- 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 26 of file qgsgeometrygeneratorsymbollayer.h.

Constructor & Destructor Documentation

◆ ~QgsGeometryGeneratorSymbolLayer()

QgsGeometryGeneratorSymbolLayer::~QgsGeometryGeneratorSymbolLayer ( )
override

Definition at line 19 of file qgsgeometrygeneratorsymbollayer.cpp.

Member Function Documentation

◆ clone()

QgsSymbolLayer * QgsGeometryGeneratorSymbolLayer::clone ( ) const
overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 104 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ create()

QgsSymbolLayer * QgsGeometryGeneratorSymbolLayer::create ( const QgsStringMap properties)
static

Definition at line 26 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ drawPreviewIcon()

void QgsGeometryGeneratorSymbolLayer::drawPreviewIcon ( QgsSymbolRenderContext context,
QSize  size 
)
overridevirtual

Implements QgsSymbolLayer.

Definition at line 142 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ geometryExpression()

QString QgsGeometryGeneratorSymbolLayer::geometryExpression ( ) const
inline

Gets the expression to generate this geometry.

Definition at line 69 of file qgsgeometrygeneratorsymbollayer.h.

◆ isCompatibleWithSymbol()

bool QgsGeometryGeneratorSymbolLayer::isCompatibleWithSymbol ( QgsSymbol symbol) const
overridevirtual

Will always return true.

This is a hybrid layer, it constructs its own geometry so it does not care about the geometry of its parents.

Reimplemented from QgsSymbolLayer.

Definition at line 185 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ layerType()

QString QgsGeometryGeneratorSymbolLayer::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 60 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ properties()

QgsStringMap QgsGeometryGeneratorSymbolLayer::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 123 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ render()

void QgsGeometryGeneratorSymbolLayer::render ( QgsSymbolRenderContext context)
virtual

Will render this symbol layer using the context.

In comparison to other symbols there is no geometry passed in, since the geometry will be created based on information from the context which contains a QgsRenderContext which in turn contains an expression context which is available to the evaluated expression.

Parameters
contextThe rendering context which will be used to render and to construct a geometry.

Definition at line 190 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ setColor()

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

The fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 208 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ setGeometryExpression()

void QgsGeometryGeneratorSymbolLayer::setGeometryExpression ( const QString &  exp)

Set the expression to generate this geometry.

Definition at line 148 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ setSubSymbol()

bool QgsGeometryGeneratorSymbolLayer::setSubSymbol ( QgsSymbol symbol)
overridevirtual

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

Reimplemented from QgsSymbolLayer.

Definition at line 153 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ setSymbolType()

void QgsGeometryGeneratorSymbolLayer::setSymbolType ( QgsSymbol::SymbolType  symbolType)

Set the type of symbol which should be created.

Should match with the return type of the expression.

Parameters
symbolTypeThe symbol type which shall be used below this symbol.

Definition at line 65 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ startRender()

void QgsGeometryGeneratorSymbolLayer::startRender ( QgsSymbolRenderContext context)
overridevirtual

Implements QgsSymbolLayer.

Definition at line 91 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ stopRender()

void QgsGeometryGeneratorSymbolLayer::stopRender ( QgsSymbolRenderContext context)
overridevirtual

Implements QgsSymbolLayer.

Definition at line 98 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ subSymbol()

QgsSymbol* QgsGeometryGeneratorSymbolLayer::subSymbol ( )
inlineoverridevirtual

Returns the symbol's sub symbol, if present.

Reimplemented from QgsSymbolLayer.

Definition at line 71 of file qgsgeometrygeneratorsymbollayer.h.

◆ symbolType()

QgsSymbol::SymbolType QgsGeometryGeneratorSymbolLayer::symbolType ( ) const
inline

Access the symbol type.

This defines the type of geometry that is created by this generator.

Returns
Symbol type

Definition at line 49 of file qgsgeometrygeneratorsymbollayer.h.

◆ usedAttributes()

QSet< QString > QgsGeometryGeneratorSymbolLayer::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 178 of file qgsgeometrygeneratorsymbollayer.cpp.


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