QGIS API Documentation  3.14.0-Pi (9f7028fd23)
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
QgsLinePatternFillSymbolLayer Class Reference

#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsLinePatternFillSymbolLayer:
Inheritance graph
[legend]

Public Member Functions

 QgsLinePatternFillSymbolLayer ()
 
 ~QgsLinePatternFillSymbolLayer () override
 
QgsLinePatternFillSymbolLayerclone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
QColor color () const override
 The fill color. More...
 
double distance () const
 Returns the distance between lines in the fill pattern. More...
 
const QgsMapUnitScaledistanceMapUnitScale () const
 Returns the map unit scale for the pattern's line distance. More...
 
QgsUnitTypes::RenderUnit distanceUnit () const
 Returns the units for the distance between lines in the fill pattern. More...
 
double estimateMaxBleed (const QgsRenderContext &context) const override
 Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context. More...
 
bool hasDataDefinedProperties () const override
 Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. More...
 
QString layerType () const override
 Returns a string that represents this layer type. More...
 
double lineAngle () const
 Returns the angle for the parallel lines used to fill the symbol. More...
 
double lineWidth () const
 Returns the width of the line subsymbol used to render the parallel lines in the fill. More...
 
const QgsMapUnitScalelineWidthMapUnitScale () const
 Returns the map unit scale for the pattern's line width. More...
 
QgsUnitTypes::RenderUnit lineWidthUnit () const
 Returns the units for the line's width. More...
 
QgsMapUnitScale mapUnitScale () const override
 
double offset () const
 Returns the offset distance for lines within the fill, which is the distance to offset the parallel lines from their normal position. More...
 
const QgsMapUnitScaleoffsetMapUnitScale () const
 Returns the map unit scale for the pattern's line offset. More...
 
QgsUnitTypes::RenderUnit offsetUnit () const
 Returns the units for the line pattern's offset. More...
 
QString ogrFeatureStyleWidth (double widthScaleFactor) const
 
QgsUnitTypes::RenderUnit outputUnit () const override
 Returns the units to use for sizes and widths within the symbol layer. 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...
 
void setColor (const QColor &c) override
 The fill color. More...
 
void setDistance (double d)
 Sets the distance between lines in the fill pattern. More...
 
void setDistanceMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for the pattern's line distance. More...
 
void setDistanceUnit (QgsUnitTypes::RenderUnit unit)
 Sets the unit for the distance between lines in the fill pattern. More...
 
void setLineAngle (double a)
 Sets the angle for the parallel lines used to fill the symbol. More...
 
void setLineWidth (double w)
 Sets the width of the line subsymbol used to render the parallel lines in the fill. More...
 
void setLineWidthMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for the pattern's line width. More...
 
void setLineWidthUnit (QgsUnitTypes::RenderUnit unit)
 Sets the unit for the line's width. More...
 
void setMapUnitScale (const QgsMapUnitScale &scale) override
 
void setOffset (double offset)
 Sets the offset distance for lines within the fill, which is the distance to offset the parallel lines from their normal position. More...
 
void setOffsetMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for the pattern's line offset. More...
 
void setOffsetUnit (QgsUnitTypes::RenderUnit unit)
 Sets the unit for the line pattern's offset. More...
 
void setOutputUnit (QgsUnitTypes::RenderUnit unit) override
 Sets the units to use for sizes and widths within the symbol layer. More...
 
bool setSubSymbol (QgsSymbol *symbol) override
 Sets layer's subsymbol. takes ownership of the passed symbol. More...
 
void startRender (QgsSymbolRenderContext &context) override
 Called before a set of rendering operations commences on the supplied render context. More...
 
void stopRender (QgsSymbolRenderContext &context) override
 Called after a set of rendering operations has finished on the supplied render context. More...
 
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 QgsImageFillSymbolLayer
 QgsImageFillSymbolLayer ()
 
QColor dxfColor (QgsSymbolRenderContext &context) const override
 Gets color. More...
 
Qt::PenStyle dxfPenStyle () const override
 Gets pen style. More...
 
double dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
 Gets line width. More...
 
void renderPolygon (const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context) override
 Renders the fill symbol layer for the polygon whose outer ring is defined by points, using the given render context. More...
 
void setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale)
 Sets the stroke width map unit scale. More...
 
void setStrokeWidthUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units fo the symbol's stroke width. More...
 
const QgsMapUnitScalestrokeWidthMapUnitScale () const
 Returns the stroke width map unit scale. More...
 
QgsUnitTypes::RenderUnit strokeWidthUnit () const
 Returns the units for the symbol's stroke width. More...
 
- Public Member Functions inherited from QgsFillSymbolLayer
 QgsFillSymbolLayer (const QgsFillSymbolLayer &other)=delete
 QgsFillSymbolLayer cannot be copied. More...
 
double angle () const
 
void drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override
 
QgsFillSymbolLayeroperator= (const QgsFillSymbolLayer &other)=delete
 QgsFillSymbolLayer cannot be copied. More...
 
void setAngle (double angle)
 
- Public Member Functions inherited from QgsSymbolLayer
 QgsSymbolLayer (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied. More...
 
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 QVector< qreal > dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const
 Gets dash pattern. More...
 
virtual double dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets offset. More...
 
bool enabled () const
 Returns true if symbol layer is enabled and will be drawn. 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 QgsSymbolLayerReferenceList masks () const
 Returns masks defined by this symbol layer. More...
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
QgsSymbolLayeroperator= (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied. 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
 Specifies the rendering pass in which this symbol layer should be rendered. More...
 
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)
 Specifies the rendering pass in which this symbol layer should be rendered. More...
 
virtual void setStrokeColor (const QColor &color)
 Set stroke color. More...
 
virtual void startFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
 Called before the layer will be rendered for a particular feature. More...
 
virtual void stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
 Called after the layer has been rendered for a particular feature. 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())
 Creates a new QgsLinePatternFillSymbolLayer from a properties map. More...
 
static QgsSymbolLayercreateFromSld (QDomElement &element)
 Creates a new QgsLinePatternFillSymbolLayer from a SLD element. More...
 
- Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the symbol layer property definitions. More...
 

Protected Member Functions

void applyDataDefinedSettings (QgsSymbolRenderContext &context) override
 
- Protected Member Functions inherited from QgsFillSymbolLayer
 QgsFillSymbolLayer (bool locked=false)
 
void _renderPolygon (QPainter *p, const QPolygonF &points, const QVector< 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...
 

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, PropertyAverageAngleLength, PropertyHorizontalAnchor, PropertyVerticalAnchor,
  PropertyLayerEnabled, PropertyArrowWidth, PropertyArrowStartWidth, PropertyArrowHeadLength,
  PropertyArrowHeadThickness, PropertyArrowHeadType, PropertyArrowType, PropertyOffsetX,
  PropertyOffsetY, PropertyPointCount, PropertyRandomSeed, PropertyClipPoints,
  PropertyDensityArea, PropertyFontFamily, PropertyFontStyle
}
 Data definable properties. More...
 
- Protected Attributes inherited from QgsImageFillSymbolLayer
QBrush mBrush
 
double mNextAngle = 0.0
 
std::unique_ptr< QgsLineSymbolmStroke
 Custom stroke. More...
 
double mStrokeWidth = 0.0
 Stroke width. More...
 
QgsMapUnitScale mStrokeWidthMapUnitScale
 
QgsUnitTypes::RenderUnit mStrokeWidthUnit = QgsUnitTypes::RenderMillimeters
 
- Protected Attributes inherited from QgsFillSymbolLayer
double mAngle = 0.0
 
- Protected Attributes inherited from QgsSymbolLayer
QColor mColor
 
QgsPropertyCollection mDataDefinedProperties
 
bool mEnabled = true
 True if layer is enabled and should be drawn. More...
 
QgsFields mFields
 
bool mLocked = false
 
std::unique_ptr< QgsPaintEffectmPaintEffect
 
int mRenderingPass = 0
 
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

A symbol fill consisting of repeated parallel lines.

Definition at line 1217 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsLinePatternFillSymbolLayer()

QgsLinePatternFillSymbolLayer::QgsLinePatternFillSymbolLayer ( )

Definition at line 2303 of file qgsfillsymbollayer.cpp.

◆ ~QgsLinePatternFillSymbolLayer()

QgsLinePatternFillSymbolLayer::~QgsLinePatternFillSymbolLayer ( )
override

Definition at line 2327 of file qgsfillsymbollayer.cpp.

Member Function Documentation

◆ applyDataDefinedSettings()

void QgsLinePatternFillSymbolLayer::applyDataDefinedSettings ( QgsSymbolRenderContext context)
overrideprotectedvirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 2926 of file qgsfillsymbollayer.cpp.

◆ clone()

QgsLinePatternFillSymbolLayer * QgsLinePatternFillSymbolLayer::clone ( ) const
overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 2853 of file qgsfillsymbollayer.cpp.

◆ color()

QColor QgsLinePatternFillSymbolLayer::color ( ) const
overridevirtual

The fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 2322 of file qgsfillsymbollayer.cpp.

◆ create()

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

Creates a new QgsLinePatternFillSymbolLayer from a properties map.

The caller takes ownership of the returned object.

Definition at line 2418 of file qgsfillsymbollayer.cpp.

◆ createFromSld()

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

Creates a new QgsLinePatternFillSymbolLayer from a SLD element.

The caller takes ownership of the returned object.

Definition at line 2949 of file qgsfillsymbollayer.cpp.

◆ distance()

double QgsLinePatternFillSymbolLayer::distance ( ) const
inline

Returns the distance between lines in the fill pattern.

Units are retrieved by distanceUnit().

See also
setDistance()
distanceUnit()

Definition at line 1276 of file qgsfillsymbollayer.h.

◆ distanceMapUnitScale()

const QgsMapUnitScale& QgsLinePatternFillSymbolLayer::distanceMapUnitScale ( ) const
inline

Returns the map unit scale for the pattern's line distance.

See also
setDistanceMapUnitScale()
distance()
distanceUnit()

Definition at line 1355 of file qgsfillsymbollayer.h.

◆ distanceUnit()

QgsUnitTypes::RenderUnit QgsLinePatternFillSymbolLayer::distanceUnit ( ) const
inline

Returns the units for the distance between lines in the fill pattern.

See also
setDistanceUnit()
distance()

Definition at line 1337 of file qgsfillsymbollayer.h.

◆ estimateMaxBleed()

double QgsLinePatternFillSymbolLayer::estimateMaxBleed ( const QgsRenderContext context) const
overridevirtual

Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context.

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

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 2376 of file qgsfillsymbollayer.cpp.

◆ hasDataDefinedProperties()

bool QgsLinePatternFillSymbolLayer::hasDataDefinedProperties ( ) const
overridevirtual

Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties.

Since
QGIS 3.4.5

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 2367 of file qgsfillsymbollayer.cpp.

◆ layerType()

QString QgsLinePatternFillSymbolLayer::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 2524 of file qgsfillsymbollayer.cpp.

◆ lineAngle()

double QgsLinePatternFillSymbolLayer::lineAngle ( ) const
inline

Returns the angle for the parallel lines used to fill the symbol.

Angles are in degrees, clockwise from North.

See also
setLineAngle()

Definition at line 1261 of file qgsfillsymbollayer.h.

◆ lineWidth()

double QgsLinePatternFillSymbolLayer::lineWidth ( ) const
inline

Returns the width of the line subsymbol used to render the parallel lines in the fill.

See also
setLineWidth()

Definition at line 1292 of file qgsfillsymbollayer.h.

◆ lineWidthMapUnitScale()

const QgsMapUnitScale& QgsLinePatternFillSymbolLayer::lineWidthMapUnitScale ( ) const
inline

Returns the map unit scale for the pattern's line width.

See also
setLineWidthMapUnitScale()
lineWidth()
lineWidthUnit()

Definition at line 1387 of file qgsfillsymbollayer.h.

◆ lineWidthUnit()

QgsUnitTypes::RenderUnit QgsLinePatternFillSymbolLayer::lineWidthUnit ( ) const
inline

Returns the units for the line's width.

See also
setLineWidthUnit()

Definition at line 1369 of file qgsfillsymbollayer.h.

◆ mapUnitScale()

QgsMapUnitScale QgsLinePatternFillSymbolLayer::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 2407 of file qgsfillsymbollayer.cpp.

◆ offset()

double QgsLinePatternFillSymbolLayer::offset ( ) const
inline

Returns the offset distance for lines within the fill, which is the distance to offset the parallel lines from their normal position.

Units are retrieved via offsetUnit().

See also
setOffset()
offsetUnit()
offsetMapUnitScale()

Definition at line 1321 of file qgsfillsymbollayer.h.

◆ offsetMapUnitScale()

const QgsMapUnitScale& QgsLinePatternFillSymbolLayer::offsetMapUnitScale ( ) const
inline

Returns the map unit scale for the pattern's line offset.

See also
setOffsetMapUnitScale()
offset()
offsetUnit()

Definition at line 1419 of file qgsfillsymbollayer.h.

◆ offsetUnit()

QgsUnitTypes::RenderUnit QgsLinePatternFillSymbolLayer::offsetUnit ( ) const
inline

Returns the units for the line pattern's offset.

See also
setOffsetUnit()

Definition at line 1401 of file qgsfillsymbollayer.h.

◆ ogrFeatureStyleWidth()

QString QgsLinePatternFillSymbolLayer::ogrFeatureStyleWidth ( double  widthScaleFactor) const

Definition at line 2911 of file qgsfillsymbollayer.cpp.

◆ outputUnit()

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

Definition at line 2389 of file qgsfillsymbollayer.cpp.

◆ properties()

QgsStringMap QgsLinePatternFillSymbolLayer::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 2834 of file qgsfillsymbollayer.cpp.

◆ setColor()

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

The fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 2316 of file qgsfillsymbollayer.cpp.

◆ setDistance()

void QgsLinePatternFillSymbolLayer::setDistance ( double  d)
inline

Sets the distance between lines in the fill pattern.

Parameters
ddistance. Units are specified by setDistanceUnit()
See also
distance()
setDistanceUnit()

Definition at line 1269 of file qgsfillsymbollayer.h.

◆ setDistanceMapUnitScale()

void QgsLinePatternFillSymbolLayer::setDistanceMapUnitScale ( const QgsMapUnitScale scale)
inline

Sets the map unit scale for the pattern's line distance.

See also
distanceMapUnitScale()
setDistance()
setDistanceUnit()

Definition at line 1346 of file qgsfillsymbollayer.h.

◆ setDistanceUnit()

void QgsLinePatternFillSymbolLayer::setDistanceUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the unit for the distance between lines in the fill pattern.

See also
distanceUnit()
setDistance()

Definition at line 1329 of file qgsfillsymbollayer.h.

◆ setLineAngle()

void QgsLinePatternFillSymbolLayer::setLineAngle ( double  a)
inline

Sets the angle for the parallel lines used to fill the symbol.

Angles are in degrees, clockwise from North.

See also
lineAngle()

Definition at line 1252 of file qgsfillsymbollayer.h.

◆ setLineWidth()

void QgsLinePatternFillSymbolLayer::setLineWidth ( double  w)

Sets the width of the line subsymbol used to render the parallel lines in the fill.

See also
lineWidth()

Definition at line 2310 of file qgsfillsymbollayer.cpp.

◆ setLineWidthMapUnitScale()

void QgsLinePatternFillSymbolLayer::setLineWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Sets the map unit scale for the pattern's line width.

See also
lineWidthMapUnitScale()
setLineWidth()
setLineWidthUnit()

Definition at line 1378 of file qgsfillsymbollayer.h.

◆ setLineWidthUnit()

void QgsLinePatternFillSymbolLayer::setLineWidthUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the unit for the line's width.

See also
lineWidthUnit()

Definition at line 1362 of file qgsfillsymbollayer.h.

◆ setMapUnitScale()

void QgsLinePatternFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 2399 of file qgsfillsymbollayer.cpp.

◆ setOffset()

void QgsLinePatternFillSymbolLayer::setOffset ( double  offset)
inline

Sets the offset distance for lines within the fill, which is the distance to offset the parallel lines from their normal position.

Units are specified via setOffsetUnit().

See also
offset()
setOffsetUnit()
setOffsetMapUnitScale()

Definition at line 1308 of file qgsfillsymbollayer.h.

◆ setOffsetMapUnitScale()

void QgsLinePatternFillSymbolLayer::setOffsetMapUnitScale ( const QgsMapUnitScale scale)
inline

Sets the map unit scale for the pattern's line offset.

See also
offsetMapUnitScale()
setOffset()
setOffsetUnit()

Definition at line 1410 of file qgsfillsymbollayer.h.

◆ setOffsetUnit()

void QgsLinePatternFillSymbolLayer::setOffsetUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the unit for the line pattern's offset.

See also
offsetUnit()

Definition at line 1394 of file qgsfillsymbollayer.h.

◆ setOutputUnit()

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

Definition at line 2381 of file qgsfillsymbollayer.cpp.

◆ setSubSymbol()

bool QgsLinePatternFillSymbolLayer::setSubSymbol ( QgsSymbol symbol)
overridevirtual

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

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 2332 of file qgsfillsymbollayer.cpp.

◆ startRender()

void QgsLinePatternFillSymbolLayer::startRender ( QgsSymbolRenderContext context)
overridevirtual

Called before a set of rendering operations commences on the supplied render context.

This is always followed by a call to stopRender() after all rendering operations have been completed.

Subclasses can use this method to prepare for a set of rendering operations, e.g. by pre-evaluating paths or images to render, and performing other one-time optimisations.

See also
startFeatureRender()
stopRender()

Implements QgsSymbolLayer.

Definition at line 2816 of file qgsfillsymbollayer.cpp.

◆ stopRender()

void QgsLinePatternFillSymbolLayer::stopRender ( QgsSymbolRenderContext context)
overridevirtual

Called after a set of rendering operations has finished on the supplied render context.

This is always preceded by a call to startRender() before all rendering operations are commenced.

Subclasses can use this method to cleanup after a set of rendering operations.

See also
startRender()
stopFeatureRender()

Implements QgsSymbolLayer.

Definition at line 2826 of file qgsfillsymbollayer.cpp.

◆ subSymbol()

QgsSymbol * QgsLinePatternFillSymbolLayer::subSymbol ( )
overridevirtual

Returns the symbol's sub symbol, if present.

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 2354 of file qgsfillsymbollayer.cpp.

◆ toSld()

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

Reimplemented from QgsSymbolLayer.

Definition at line 2865 of file qgsfillsymbollayer.cpp.

◆ usedAttributes()

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

Definition at line 2359 of file qgsfillsymbollayer.cpp.


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