QGIS API Documentation  2.17.0-Master (bf77d09)
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
QgsCentroidFillSymbolLayerV2 Class Reference

#include <qgsfillsymbollayerv2.h>

Inheritance diagram for QgsCentroidFillSymbolLayerV2:
Inheritance graph
[legend]

Public Member Functions

 QgsCentroidFillSymbolLayerV2 ()
 
 ~QgsCentroidFillSymbolLayerV2 ()
 
QgsCentroidFillSymbolLayerV2clone () 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
 
QgsSymbolV2::OutputUnit outputUnit () const override
 
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, QgsSymbolV2RenderContext &context) override
 
void setColor (const QColor &color) override
 The fill color. More...
 
void setMapUnitScale (const QgsMapUnitScale &scale) override
 
void setOutputUnit (QgsSymbolV2::OutputUnit unit) override
 
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 (QgsSymbolV2 *symbol) override
 set layer's subsymbol. takes ownership of the passed symbol More...
 
void startRender (QgsSymbolV2RenderContext &context) override
 
void stopRender (QgsSymbolV2RenderContext &context) override
 
QgsSymbolV2subSymbol () override
 
void toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override
 
virtual QSet< QStringusedAttributes () const override
 Returns the set of attributes referenced by the layer. More...
 
- Public Member Functions inherited from QgsFillSymbolLayerV2
double angle () const
 
void drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size) override
 
void setAngle (double angle)
 
- Public Member Functions inherited from QgsSymbolLayerV2
virtual ~QgsSymbolLayerV2 ()
 
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...
 
virtual bool isCompatibleWithSymbol (QgsSymbolV2 *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
 
virtual QColor outlineColor () const
 Get outline color. More...
 
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 setOutlineColor (const QColor &color)
 Set outline color. More...
 
void setPaintEffect (QgsPaintEffect *effect)
 Sets the current paint effect for the layer. More...
 
void setRenderingPass (int renderingPass)
 
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=QgsStringMap())
 
static QgsSymbolLayerV2createFromSld (QDomElement &element)
 

Protected Attributes

int mBiggestPartIndex
 
QgsFeatureId mCurrentFeatureId
 
QgsMarkerSymbolV2mMarker
 
bool mPointOnAllParts
 
bool mPointOnSurface
 
- Protected Attributes inherited from QgsFillSymbolLayerV2
double mAngle
 
- Protected Attributes inherited from QgsSymbolLayerV2
QColor mColor
 
QMap< QString, QgsDataDefined * > mDataDefinedProperties
 
QgsFields mFields
 
bool mLocked
 
QgsPaintEffectmPaintEffect
 
int mRenderingPass
 
QgsSymbolV2::SymbolType mType
 

Additional Inherited Members

- Protected Member Functions inherited from QgsFillSymbolLayerV2
 QgsFillSymbolLayerV2 (bool locked=false)
 
void _renderPolygon (QPainter *p, const QPolygonF &points, const QList< QPolygonF > *rings, QgsSymbolV2RenderContext &context)
 Default method to render polygon. More...
 
- 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...
 
- 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 1077 of file qgsfillsymbollayerv2.h.

Constructor & Destructor Documentation

QgsCentroidFillSymbolLayerV2::QgsCentroidFillSymbolLayerV2 ( )

Definition at line 3415 of file qgsfillsymbollayerv2.cpp.

QgsCentroidFillSymbolLayerV2::~QgsCentroidFillSymbolLayerV2 ( )

Definition at line 3425 of file qgsfillsymbollayerv2.cpp.

Member Function Documentation

QgsCentroidFillSymbolLayerV2 * QgsCentroidFillSymbolLayerV2::clone ( ) const
overridevirtual

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

Implements QgsSymbolLayerV2.

Definition at line 3524 of file qgsfillsymbollayerv2.cpp.

QColor QgsCentroidFillSymbolLayerV2::color ( ) const
overridevirtual

The fill color.

Reimplemented from QgsSymbolLayerV2.

Definition at line 3453 of file qgsfillsymbollayerv2.cpp.

QgsSymbolLayerV2 * QgsCentroidFillSymbolLayerV2::create ( const QgsStringMap properties = QgsStringMap())
static

Definition at line 3430 of file qgsfillsymbollayerv2.cpp.

QgsSymbolLayerV2 * QgsCentroidFillSymbolLayerV2::createFromSld ( QDomElement element)
static

Definition at line 3544 of file qgsfillsymbollayerv2.cpp.

QString QgsCentroidFillSymbolLayerV2::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 3442 of file qgsfillsymbollayerv2.cpp.

QgsMapUnitScale QgsCentroidFillSymbolLayerV2::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 3616 of file qgsfillsymbollayerv2.cpp.

QgsSymbolV2::OutputUnit QgsCentroidFillSymbolLayerV2::outputUnit ( ) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 3599 of file qgsfillsymbollayerv2.cpp.

bool QgsCentroidFillSymbolLayerV2::pointOnAllParts ( ) const
inline

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

Note
added in 2.16

Definition at line 1126 of file qgsfillsymbollayerv2.h.

bool QgsCentroidFillSymbolLayerV2::pointOnSurface ( ) const
inline

Definition at line 1119 of file qgsfillsymbollayerv2.h.

QgsStringMap QgsCentroidFillSymbolLayerV2::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 3516 of file qgsfillsymbollayerv2.cpp.

void QgsCentroidFillSymbolLayerV2::renderPolygon ( const QPolygonF points,
QList< QPolygonF > *  rings,
QgsSymbolV2RenderContext context 
)
overridevirtual

Implements QgsFillSymbolLayerV2.

Definition at line 3472 of file qgsfillsymbollayerv2.cpp.

void QgsCentroidFillSymbolLayerV2::setColor ( const QColor color)
overridevirtual

The fill color.

Reimplemented from QgsSymbolLayerV2.

Definition at line 3447 of file qgsfillsymbollayerv2.cpp.

void QgsCentroidFillSymbolLayerV2::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 3608 of file qgsfillsymbollayerv2.cpp.

void QgsCentroidFillSymbolLayerV2::setOutputUnit ( QgsSymbolV2::OutputUnit  unit)
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 3591 of file qgsfillsymbollayerv2.cpp.

void QgsCentroidFillSymbolLayerV2::setPointOnAllParts ( bool  pointOnAllParts)
inline

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

Note
added in 2.16

Definition at line 1123 of file qgsfillsymbollayerv2.h.

void QgsCentroidFillSymbolLayerV2::setPointOnSurface ( bool  pointOnSurface)
inline

Definition at line 1118 of file qgsfillsymbollayerv2.h.

bool QgsCentroidFillSymbolLayerV2::setSubSymbol ( QgsSymbolV2 symbol)
overridevirtual

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

Reimplemented from QgsSymbolLayerV2.

Definition at line 3567 of file qgsfillsymbollayerv2.cpp.

void QgsCentroidFillSymbolLayerV2::startRender ( QgsSymbolV2RenderContext context)
overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 3458 of file qgsfillsymbollayerv2.cpp.

void QgsCentroidFillSymbolLayerV2::stopRender ( QgsSymbolV2RenderContext context)
overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 3467 of file qgsfillsymbollayerv2.cpp.

QgsSymbolV2 * QgsCentroidFillSymbolLayerV2::subSymbol ( )
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 3562 of file qgsfillsymbollayerv2.cpp.

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

Reimplemented from QgsSymbolLayerV2.

Definition at line 3536 of file qgsfillsymbollayerv2.cpp.

QSet< QString > QgsCentroidFillSymbolLayerV2::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 3581 of file qgsfillsymbollayerv2.cpp.

Member Data Documentation

int QgsCentroidFillSymbolLayerV2::mBiggestPartIndex
protected

Definition at line 1134 of file qgsfillsymbollayerv2.h.

QgsFeatureId QgsCentroidFillSymbolLayerV2::mCurrentFeatureId
protected

Definition at line 1133 of file qgsfillsymbollayerv2.h.

QgsMarkerSymbolV2* QgsCentroidFillSymbolLayerV2::mMarker
protected

Definition at line 1129 of file qgsfillsymbollayerv2.h.

bool QgsCentroidFillSymbolLayerV2::mPointOnAllParts
protected

Definition at line 1131 of file qgsfillsymbollayerv2.h.

bool QgsCentroidFillSymbolLayerV2::mPointOnSurface
protected

Definition at line 1130 of file qgsfillsymbollayerv2.h.


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