QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Public Member Functions | Static Public Member Functions | List of all members
QgsGeometryGeneratorSymbolLayerV2 Class Reference

#include <qgsgeometrygeneratorsymbollayerv2.h>

Inheritance diagram for QgsGeometryGeneratorSymbolLayerV2:
Inheritance graph
[legend]

Public Member Functions

 ~QgsGeometryGeneratorSymbolLayerV2 ()
 
QgsSymbolLayerV2clone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
void drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size) override
 
QString geometryExpression () const
 Get the expression to generate this geometry. More...
 
bool isCompatibleWithSymbol (QgsSymbolV2 *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 (QgsSymbolV2RenderContext &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...
 
virtual bool setSubSymbol (QgsSymbolV2 *symbol) override
 set layer's subsymbol. takes ownership of the passed symbol More...
 
void setSymbolType (QgsSymbolV2::SymbolType symbolType)
 Set the type of symbol which should be created. More...
 
void startRender (QgsSymbolV2RenderContext &context) override
 
void stopRender (QgsSymbolV2RenderContext &context) override
 
virtual QgsSymbolV2subSymbol () override
 
QgsSymbolV2::SymbolType symbolType () const
 Access the symbol type. More...
 
virtual QSet< QStringusedAttributes () const override
 Returns the set of attributes referenced by the layer. More...
 
- Public Member Functions inherited from QgsSymbolLayerV2
virtual ~QgsSymbolLayerV2 ()
 
virtual QColor color () const
 The fill color. More...
 
virtual Q_DECL_DEPRECATED const QgsExpressiondataDefinedProperty (const QString &property) const
 Returns a data defined expression for a property, if set. More...
 
virtual Q_DECL_DEPRECATED QString dataDefinedPropertyString (const QString &property) const
 Returns a data defined expression for a property, if set. More...
 
virtual double dxfAngle (QgsSymbolV2RenderContext &context) const
 get angle More...
 
virtual QColor dxfBrushColor (QgsSymbolV2RenderContext &context) const
 get brush/fill color More...
 
virtual Qt::BrushStyle dxfBrushStyle () const
 get brush/fill style More...
 
virtual QColor dxfColor (QgsSymbolV2RenderContext &context) const
 get color More...
 
virtual QVector< qreal > dxfCustomDashPattern (QgsSymbolV2::OutputUnit &unit) const
 get dash pattern More...
 
virtual double dxfOffset (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const
 get offset More...
 
virtual Qt::PenStyle dxfPenStyle () const
 get pen style More...
 
virtual double dxfWidth (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const
 get line width More...
 
virtual double estimateMaxBleed () const
 Returns the estimated maximum distance which the layer style will bleed outside the drawn shape. More...
 
virtual Q_DECL_DEPRECATED QVariant evaluateDataDefinedProperty (const QString &property, const QgsFeature *feature, const QVariant &defaultVal=QVariant(), bool *ok=nullptr) const
 Evaluates the matching data defined property and returns the calculated value. More...
 
virtual QVariant evaluateDataDefinedProperty (const QString &property, const QgsSymbolV2RenderContext &context, const QVariant &defaultVal=QVariant(), bool *ok=nullptr) const
 Evaluates the matching data defined property and returns the calculated value. More...
 
virtual QColor fillColor () const
 Get fill color. More...
 
virtual QgsDataDefinedgetDataDefinedProperty (const QString &property) const
 Returns the data defined property corresponding to the specified property key. More...
 
virtual bool hasDataDefinedProperties () const
 Checks whether the layer has any associated data defined properties. More...
 
virtual bool hasDataDefinedProperty (const QString &property) const
 Checks whether the layer has a matching data defined property and if that property is currently actived. More...
 
bool isLocked () const
 
virtual QgsMapUnitScale mapUnitScale () const
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
virtual QColor outlineColor () const
 Get outline color. More...
 
virtual QgsSymbolV2::OutputUnit outputUnit () const
 
QgsPaintEffectpaintEffect () const
 Returns the current paint effect for the layer. More...
 
virtual void removeDataDefinedProperties ()
 Removes all data defined properties from the layer and deletes associated objects. More...
 
virtual void removeDataDefinedProperty (const QString &property)
 Removes a data defined property from the layer. More...
 
int renderingPass () const
 
virtual Q_DECL_DEPRECATED void setDataDefinedProperty (const QString &property, const QString &expressionString)
 Sets a data defined expression for a property. More...
 
virtual void setDataDefinedProperty (const QString &property, QgsDataDefined *dataDefined)
 Sets a data defined property for the layer. More...
 
virtual void setFillColor (const QColor &color)
 Set fill color. More...
 
void setLocked (bool locked)
 
virtual void setMapUnitScale (const QgsMapUnitScale &scale)
 
virtual void setOutlineColor (const QColor &color)
 Set outline color. More...
 
virtual void setOutputUnit (QgsSymbolV2::OutputUnit unit)
 
void setPaintEffect (QgsPaintEffect *effect)
 Sets the current paint effect for the layer. More...
 
void setRenderingPass (int renderingPass)
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const
 Writes the SLD element following the SLD v1.1 specs. More...
 
QgsSymbolV2::SymbolType type () const
 
virtual bool writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolV2RenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const
 write as DXF More...
 

Static Public Member Functions

static QgsSymbolLayerV2create (const QgsStringMap &properties)
 

Additional Inherited Members

- Protected Member Functions inherited from QgsSymbolLayerV2
 QgsSymbolLayerV2 (QgsSymbolV2::SymbolType type, bool locked=false)
 
void copyDataDefinedProperties (QgsSymbolLayerV2 *destLayer) const
 Copies all data defined properties of this layer to another symbol layer. More...
 
void copyPaintEffect (QgsSymbolLayerV2 *destLayer) const
 Copies paint effect of this layer to another symbol layer. More...
 
virtual Q_DECL_DEPRECATED QgsExpressionexpression (const QString &property) const
 Returns the data defined expression associated with a property. More...
 
virtual Q_DECL_DEPRECATED void prepareExpressions (const QgsFields *fields, double scale=-1.0)
 Prepares all data defined property expressions for evaluation. More...
 
virtual void prepareExpressions (const QgsSymbolV2RenderContext &context)
 Prepares all data defined property expressions for evaluation. More...
 
void restoreDataDefinedProperties (const QgsStringMap &stringMap)
 Restores all data defined properties from string map. More...
 
void saveDataDefinedProperties (QgsStringMap &stringMap) const
 Saves all data defined properties to a string map. More...
 
- Protected Attributes inherited from QgsSymbolLayerV2
QColor mColor
 
QMap< QString, QgsDataDefined * > mDataDefinedProperties
 
QgsFields mFields
 
bool mLocked
 
QgsPaintEffectmPaintEffect
 
int mRenderingPass
 
QgsSymbolV2::SymbolType mType
 
- Static Protected Attributes inherited from QgsSymbolLayerV2
static const QString EXPR_ALPHA
 
static const QString EXPR_ANGLE
 
static const QString EXPR_BLUR_RADIUS
 
static const QString EXPR_BORDER_COLOR
 
static const QString EXPR_BORDER_STYLE
 
static const QString EXPR_CAPSTYLE
 
static const QString EXPR_CHAR
 
static const QString EXPR_COLOR
 
static const QString EXPR_COLOR2
 
static const QString EXPR_COLOR_BORDER
 
static const QString EXPR_COORDINATE_MODE
 
static const QString EXPR_CUSTOMDASH
 
static const QString EXPR_DISPLACEMENT_X
 
static const QString EXPR_DISPLACEMENT_Y
 
static const QString EXPR_DISTANCE
 
static const QString EXPR_DISTANCE_X
 
static const QString EXPR_DISTANCE_Y
 
static const QString EXPR_FILE
 
static const QString EXPR_FILL
 
static const QString EXPR_FILL_COLOR
 
static const QString EXPR_FILL_STYLE
 
static const QString EXPR_GRADIENT_TYPE
 
static const QString EXPR_HEIGHT
 
static const QString EXPR_HORIZONTAL_ANCHOR_POINT
 
static const QString EXPR_IGNORE_RINGS
 
static const QString EXPR_INTERVAL
 
static const QString EXPR_JOIN_STYLE
 
static const QString EXPR_JOINSTYLE
 
static const QString EXPR_LINE_STYLE
 
static const QString EXPR_LINEANGLE
 
static const QString EXPR_LINEWIDTH
 
static const QString EXPR_MAX_DISTANCE
 
static const QString EXPR_NAME
 
static const QString EXPR_OFFSET
 
static const QString EXPR_OFFSET_ALONG_LINE
 
static const QString EXPR_OUTLINE
 
static const QString EXPR_OUTLINE_COLOR
 
static const QString EXPR_OUTLINE_STYLE
 
static const QString EXPR_OUTLINE_WIDTH
 
static const QString EXPR_PLACEMENT
 
static const QString EXPR_REFERENCE1_ISCENTROID
 
static const QString EXPR_REFERENCE1_X
 
static const QString EXPR_REFERENCE1_Y
 
static const QString EXPR_REFERENCE2_ISCENTROID
 
static const QString EXPR_REFERENCE2_X
 
static const QString EXPR_REFERENCE2_Y
 
static const QString EXPR_ROTATION
 
static const QString EXPR_SIZE
 
static const QString EXPR_SPREAD
 
static const QString EXPR_SVG_FILE
 
static const QString EXPR_SVG_FILL_COLOR
 
static const QString EXPR_SVG_OUTLINE_COLOR
 
static const QString EXPR_SVG_OUTLINE_WIDTH
 
static const QString EXPR_SYMBOL_NAME
 
static const QString EXPR_USE_WHOLE_SHAPE
 
static const QString EXPR_VERTICAL_ANCHOR_POINT
 
static const QString EXPR_WIDTH
 
static const QString EXPR_WIDTH_BORDER
 
static const bool selectFillBorder = false
 
static const bool selectFillStyle = false
 
static const bool selectionIsOpaque = true
 

Detailed Description

Definition at line 24 of file qgsgeometrygeneratorsymbollayerv2.h.

Constructor & Destructor Documentation

QgsGeometryGeneratorSymbolLayerV2::~QgsGeometryGeneratorSymbolLayerV2 ( )

Definition at line 19 of file qgsgeometrygeneratorsymbollayerv2.cpp.

Member Function Documentation

QgsSymbolLayerV2 * QgsGeometryGeneratorSymbolLayerV2::clone ( ) const
overridevirtual

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

Implements QgsSymbolLayerV2.

Definition at line 107 of file qgsgeometrygeneratorsymbollayerv2.cpp.

QgsSymbolLayerV2 * QgsGeometryGeneratorSymbolLayerV2::create ( const QgsStringMap properties)
static

Definition at line 26 of file qgsgeometrygeneratorsymbollayerv2.cpp.

void QgsGeometryGeneratorSymbolLayerV2::drawPreviewIcon ( QgsSymbolV2RenderContext context,
QSize  size 
)
overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 145 of file qgsgeometrygeneratorsymbollayerv2.cpp.

QString QgsGeometryGeneratorSymbolLayerV2::geometryExpression ( ) const
inline

Get the expression to generate this geometry.

Definition at line 67 of file qgsgeometrygeneratorsymbollayerv2.h.

bool QgsGeometryGeneratorSymbolLayerV2::isCompatibleWithSymbol ( QgsSymbolV2 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 QgsSymbolLayerV2.

Definition at line 186 of file qgsgeometrygeneratorsymbollayerv2.cpp.

QString QgsGeometryGeneratorSymbolLayerV2::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 QgsSymbolLayerV2.

Definition at line 63 of file qgsgeometrygeneratorsymbollayerv2.cpp.

QgsStringMap QgsGeometryGeneratorSymbolLayerV2::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 QgsSymbolLayerV2.

Definition at line 125 of file qgsgeometrygeneratorsymbollayerv2.cpp.

void QgsGeometryGeneratorSymbolLayerV2::render ( QgsSymbolV2RenderContext 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 191 of file qgsgeometrygeneratorsymbollayerv2.cpp.

void QgsGeometryGeneratorSymbolLayerV2::setColor ( const QColor color)
overridevirtual

The fill color.

Reimplemented from QgsSymbolLayerV2.

Definition at line 209 of file qgsgeometrygeneratorsymbollayerv2.cpp.

void QgsGeometryGeneratorSymbolLayerV2::setGeometryExpression ( const QString exp)

Set the expression to generate this geometry.

Definition at line 151 of file qgsgeometrygeneratorsymbollayerv2.cpp.

bool QgsGeometryGeneratorSymbolLayerV2::setSubSymbol ( QgsSymbolV2 symbol)
overridevirtual

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

Reimplemented from QgsSymbolLayerV2.

Definition at line 156 of file qgsgeometrygeneratorsymbollayerv2.cpp.

void QgsGeometryGeneratorSymbolLayerV2::setSymbolType ( QgsSymbolV2::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 68 of file qgsgeometrygeneratorsymbollayerv2.cpp.

void QgsGeometryGeneratorSymbolLayerV2::startRender ( QgsSymbolV2RenderContext context)
overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 94 of file qgsgeometrygeneratorsymbollayerv2.cpp.

void QgsGeometryGeneratorSymbolLayerV2::stopRender ( QgsSymbolV2RenderContext context)
overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 101 of file qgsgeometrygeneratorsymbollayerv2.cpp.

virtual QgsSymbolV2* QgsGeometryGeneratorSymbolLayerV2::subSymbol ( )
inlineoverridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 69 of file qgsgeometrygeneratorsymbollayerv2.h.

QgsSymbolV2::SymbolType QgsGeometryGeneratorSymbolLayerV2::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 47 of file qgsgeometrygeneratorsymbollayerv2.h.

QSet< QString > QgsGeometryGeneratorSymbolLayerV2::usedAttributes ( ) 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 QgsSymbolLayerV2.

Definition at line 181 of file qgsgeometrygeneratorsymbollayerv2.cpp.


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