QGIS API Documentation  2.99.0-Master (6a61179)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsImageFillSymbolLayer Class Reference

Base class for polygon renderers generating texture images. More...

#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsImageFillSymbolLayer:
Inheritance graph
[legend]

Public Member Functions

 QgsImageFillSymbolLayer ()
 
virtual ~QgsImageFillSymbolLayer ()
 
QColor dxfColor (QgsSymbolRenderContext &context) const override
 get color More...
 
Qt::PenStyle dxfPenStyle () const override
 get pen style More...
 
double dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
 get line width More...
 
virtual double estimateMaxBleed () const override
 Returns the estimated maximum distance which the layer style will bleed outside the drawn shape. More...
 
QgsMapUnitScale mapUnitScale () const override
 
const QgsMapUnitScaleoutlineWidthMapUnitScale () const
 
QgsUnitTypes::RenderUnit outlineWidthUnit () const
 Returns the units for the symbol's outline width. More...
 
QgsUnitTypes::RenderUnit outputUnit () const override
 Returns the units to use for sizes and widths within the symbol layer. More...
 
void renderPolygon (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolRenderContext &context) override
 
void setMapUnitScale (const QgsMapUnitScale &scale) override
 
void setOutlineWidthMapUnitScale (const QgsMapUnitScale &scale)
 
void setOutlineWidthUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units for the symbol's outline width. More...
 
void setOutputUnit (QgsUnitTypes::RenderUnit unit) override
 Sets the units to use for sizes and widths within the symbol layer. More...
 
virtual bool setSubSymbol (QgsSymbol *symbol) override
 set layer's subsymbol. takes ownership of the passed symbol More...
 
virtual QgsSymbolsubSymbol () override
 
QSet< QString > usedAttributes () 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 ()
 
virtual QgsSymbolLayerclone () const =0
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
virtual QColor color () const
 The fill color. More...
 
virtual double dxfAngle (QgsSymbolRenderContext &context) const
 get angle More...
 
virtual QColor dxfBrushColor (QgsSymbolRenderContext &context) const
 get brush/fill color More...
 
virtual Qt::BrushStyle dxfBrushStyle () const
 get brush/fill style More...
 
virtual QVector< qreal > dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const
 get dash pattern More...
 
virtual double dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 get offset More...
 
bool enabled () const
 Returns true if symbol layer is enabled and will be drawn. More...
 
virtual QVariant evaluateDataDefinedProperty (const QString &property, const QgsSymbolRenderContext &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 (QgsSymbol *symbol) const
 Returns if the layer can be used below the specified symbol. More...
 
bool isLocked () const
 
virtual QString layerType () const =0
 Returns a string that represents this layer type. More...
 
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 prepareExpressions (const QgsSymbolRenderContext &context)
 Prepares all data defined property expressions for evaluation. More...
 
virtual QgsStringMap properties () const =0
 Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol 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 void setColor (const QColor &color)
 The fill color. More...
 
virtual void setDataDefinedProperty (const QString &property, QgsDataDefined *dataDefined)
 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 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)
 
virtual void startRender (QgsSymbolRenderContext &context)=0
 
virtual void stopRender (QgsSymbolRenderContext &context)=0
 
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...
 

Protected Member Functions

virtual void applyDataDefinedSettings (QgsSymbolRenderContext &context)
 
- 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 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

QBrush mBrush
 
double mNextAngle
 
QgsLineSymbolmOutline
 Custom outline. More...
 
double mOutlineWidth
 Outline width. More...
 
QgsMapUnitScale mOutlineWidthMapUnitScale
 
QgsUnitTypes::RenderUnit mOutlineWidthUnit
 
- Protected Attributes inherited from QgsFillSymbolLayer
double mAngle
 
- Protected Attributes inherited from QgsSymbolLayer
QColor mColor
 
QMap< QString, QgsDataDefined *> mDataDefinedProperties
 
bool mEnabled
 True if layer is enabled and should be drawn. More...
 
QgsFields mFields
 
bool mLocked
 
QgsPaintEffectmPaintEffect
 
int mRenderingPass
 
QgsSymbol::SymbolType mType
 

Additional Inherited Members

- Static Public Attributes inherited from QgsSymbolLayer
static const QString EXPR_LAYER_ENABLED
 Data defined layer enabled string. More...
 
- Static Protected Attributes inherited from QgsSymbolLayer
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

Base class for polygon renderers generating texture images.

Definition at line 585 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

§ QgsImageFillSymbolLayer()

QgsImageFillSymbolLayer::QgsImageFillSymbolLayer ( )

Definition at line 1575 of file qgsfillsymbollayer.cpp.

§ ~QgsImageFillSymbolLayer()

QgsImageFillSymbolLayer::~QgsImageFillSymbolLayer ( )
virtual

Definition at line 1584 of file qgsfillsymbollayer.cpp.

Member Function Documentation

§ applyDataDefinedSettings()

virtual void QgsImageFillSymbolLayer::applyDataDefinedSettings ( QgsSymbolRenderContext context)
inlineprotectedvirtual

§ dxfColor()

QColor QgsImageFillSymbolLayer::dxfColor ( QgsSymbolRenderContext context) const
overridevirtual

get color

Reimplemented from QgsSymbolLayer.

Definition at line 1713 of file qgsfillsymbollayer.cpp.

§ dxfPenStyle()

Qt::PenStyle QgsImageFillSymbolLayer::dxfPenStyle ( ) const
overridevirtual

get pen style

Reimplemented from QgsSymbolLayer.

Definition at line 1723 of file qgsfillsymbollayer.cpp.

§ dxfWidth()

double QgsImageFillSymbolLayer::dxfWidth ( const QgsDxfExport e,
QgsSymbolRenderContext context 
) const
overridevirtual

get line width

Reimplemented from QgsSymbolLayer.

Definition at line 1702 of file qgsfillsymbollayer.cpp.

§ estimateMaxBleed()

double QgsImageFillSymbolLayer::estimateMaxBleed ( ) const
overridevirtual

Returns the estimated maximum distance which the layer style will bleed outside the drawn shape.

Eg, polygons drawn with an outline will draw half the width of the outline outside of the polygon. This amount is estimated, since it may be affected by data defined symbology rules.

Reimplemented from QgsSymbolLayer.

Reimplemented in QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsRasterFillSymbolLayer.

Definition at line 1692 of file qgsfillsymbollayer.cpp.

§ mapUnitScale()

QgsMapUnitScale QgsImageFillSymbolLayer::mapUnitScale ( ) const
overridevirtual

§ outlineWidthMapUnitScale()

const QgsMapUnitScale& QgsImageFillSymbolLayer::outlineWidthMapUnitScale ( ) const
inline

Definition at line 608 of file qgsfillsymbollayer.h.

§ outlineWidthUnit()

QgsUnitTypes::RenderUnit QgsImageFillSymbolLayer::outlineWidthUnit ( ) const
inline

Returns the units for the symbol's outline width.

See also
setOutlineWidthUnit()

Definition at line 605 of file qgsfillsymbollayer.h.

§ outputUnit()

QgsUnitTypes::RenderUnit QgsImageFillSymbolLayer::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, eg 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.

Reimplemented in QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsSVGFillSymbolLayer.

Definition at line 1677 of file qgsfillsymbollayer.cpp.

§ renderPolygon()

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

Implements QgsFillSymbolLayer.

Reimplemented in QgsRasterFillSymbolLayer.

Definition at line 1588 of file qgsfillsymbollayer.cpp.

§ setMapUnitScale()

void QgsImageFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

§ setOutlineWidthMapUnitScale()

void QgsImageFillSymbolLayer::setOutlineWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 607 of file qgsfillsymbollayer.h.

§ setOutlineWidthUnit()

void QgsImageFillSymbolLayer::setOutlineWidthUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the units for the symbol's outline width.

Parameters
unitsymbol units
See also
outlineWidthUnit()

Definition at line 600 of file qgsfillsymbollayer.h.

§ setOutputUnit()

void QgsImageFillSymbolLayer::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, eg 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.

Reimplemented in QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsSVGFillSymbolLayer.

Definition at line 1672 of file qgsfillsymbollayer.cpp.

§ setSubSymbol()

bool QgsImageFillSymbolLayer::setSubSymbol ( QgsSymbol symbol)
overridevirtual

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

Reimplemented from QgsSymbolLayer.

Reimplemented in QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsRasterFillSymbolLayer.

Definition at line 1645 of file qgsfillsymbollayer.cpp.

§ subSymbol()

virtual QgsSymbol* QgsImageFillSymbolLayer::subSymbol ( )
inlineoverridevirtual

§ usedAttributes()

QSet< QString > QgsImageFillSymbolLayer::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 QgsSymbolLayer.

Reimplemented in QgsPointPatternFillSymbolLayer, and QgsLinePatternFillSymbolLayer.

Definition at line 1738 of file qgsfillsymbollayer.cpp.

Member Data Documentation

§ mBrush

QBrush QgsImageFillSymbolLayer::mBrush
protected

Definition at line 626 of file qgsfillsymbollayer.h.

§ mNextAngle

double QgsImageFillSymbolLayer::mNextAngle
protected

Definition at line 627 of file qgsfillsymbollayer.h.

§ mOutline

QgsLineSymbol* QgsImageFillSymbolLayer::mOutline
protected

Custom outline.

Definition at line 635 of file qgsfillsymbollayer.h.

§ mOutlineWidth

double QgsImageFillSymbolLayer::mOutlineWidth
protected

Outline width.

Definition at line 630 of file qgsfillsymbollayer.h.

§ mOutlineWidthMapUnitScale

QgsMapUnitScale QgsImageFillSymbolLayer::mOutlineWidthMapUnitScale
protected

Definition at line 632 of file qgsfillsymbollayer.h.

§ mOutlineWidthUnit

QgsUnitTypes::RenderUnit QgsImageFillSymbolLayer::mOutlineWidthUnit
protected

Definition at line 631 of file qgsfillsymbollayer.h.


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