Simple marker symbol layer, consisting of a rendered shape with solid fill color and an stroke. More...

#include <qgsmarkersymbollayer.h>

Inheritance diagram for QgsSimpleMarkerSymbolLayer:

[legend]

Public Member Functions
	QgsSimpleMarkerSymbolLayer (Qgis::MarkerShape shape=Qgis::MarkerShape::Circle, double size=DEFAULT_SIMPLEMARKER_SIZE, double angle=DEFAULT_SIMPLEMARKER_ANGLE, Qgis::ScaleMethod scaleMethod=DEFAULT_SCALE_METHOD, const QColor &color=DEFAULT_SIMPLEMARKER_COLOR, const QColor &strokeColor=DEFAULT_SIMPLEMARKER_BORDERCOLOR, Qt::PenJoinStyle penJoinStyle=DEFAULT_SIMPLEMARKER_JOINSTYLE)
	Constructor for QgsSimpleMarkerSymbolLayer.

	~QgsSimpleMarkerSymbolLayer () override

QRectF	bounds (QPointF point, QgsSymbolRenderContext &context) override
	Returns the approximate bounding box of the marker symbol layer, taking into account any data defined overrides and offsets which are set for the marker layer.

QgsSimpleMarkerSymbolLayer *	clone () const override
	Shall be reimplemented by subclasses to create a deep copy of the instance.

QColor	color () const override
	Returns the "representative" color of the symbol layer.

QColor	fillColor () const override
	Returns the fill color for the symbol layer.

QString	layerType () const override
	Returns a string that represents this layer type.

QgsMapUnitScale	mapUnitScale () const override

QString	ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const override

Qgis::RenderUnit	outputUnit () const override
	Returns the units to use for sizes and widths within the symbol layer.

Qt::PenCapStyle	penCapStyle () const
	Returns the marker's stroke cap style (e.g., flat, round, etc).

Qt::PenJoinStyle	penJoinStyle () const
	Returns the marker's stroke join style (e.g., miter, bevel, etc).

QVariantMap	properties () const override
	Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer.

void	renderPoint (QPointF point, QgsSymbolRenderContext &context) override
	Renders a marker at the specified point.

void	setColor (const QColor &color) override
	Sets the "representative" color for the symbol layer.

void	setFillColor (const QColor &color) override
	Sets the fill color for the symbol layer.

void	setMapUnitScale (const QgsMapUnitScale &scale) override

void	setOutputUnit (Qgis::RenderUnit unit) override
	Sets the units to use for sizes and widths within the symbol layer.

void	setPenCapStyle (Qt::PenCapStyle style)
	Sets the marker's stroke cap style (e.g., flat, round, etc).

void	setPenJoinStyle (Qt::PenJoinStyle style)
	Sets the marker's stroke join style (e.g., miter, bevel, etc).

void	setStrokeColor (const QColor &color) override
	Sets the marker's stroke color.

void	setStrokeStyle (Qt::PenStyle strokeStyle)
	Sets the marker's stroke style (e.g., solid, dashed, etc)

void	setStrokeWidth (double w)
	Sets the width of the marker's stroke.

void	setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map scale for the width of the marker's stroke.

void	setStrokeWidthUnit (Qgis::RenderUnit u)
	Sets the unit for the width of the marker's stroke.

void	startRender (QgsSymbolRenderContext &context) override
	Called before a set of rendering operations commences on the supplied render context.

QColor	strokeColor () const override
	Returns the marker's stroke color.

Qt::PenStyle	strokeStyle () const
	Returns the marker's stroke style (e.g., solid, dashed, etc)

double	strokeWidth () const
	Returns the width of the marker's stroke.

const QgsMapUnitScale &	strokeWidthMapUnitScale () const
	Returns the map scale for the width of the marker's stroke.

Qgis::RenderUnit	strokeWidthUnit () const
	Returns the unit for the width of the marker's stroke.

bool	usesMapUnits () const override
	Returns `true` if the symbol layer has any components which use map unit based sizes.

bool	writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const override
	write as DXF

void	writeSldMarker (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override
	Writes the symbol layer definition as a SLD XML element.

Public Member Functions inherited from QgsSimpleMarkerSymbolLayerBase
	QgsSimpleMarkerSymbolLayerBase (Qgis::MarkerShape shape=Qgis::MarkerShape::Circle, double size=DEFAULT_SIMPLEMARKER_SIZE, double angle=DEFAULT_SIMPLEMARKER_ANGLE, Qgis::ScaleMethod scaleMethod=DEFAULT_SCALE_METHOD)
	Constructor for QgsSimpleMarkerSymbolLayerBase.

	~QgsSimpleMarkerSymbolLayerBase () override

QRectF	bounds (QPointF point, QgsSymbolRenderContext &context) override
	Returns the approximate bounding box of the marker symbol layer, taking into account any data defined overrides and offsets which are set for the marker layer.

void	renderPoint (QPointF point, QgsSymbolRenderContext &context) override
	Renders a marker at the specified point.

void	setShape (Qgis::MarkerShape shape)
	Sets the rendered marker shape.

Qgis::MarkerShape	shape () const
	Returns the shape for the rendered marker symbol.

void	startRender (QgsSymbolRenderContext &context) override
	Called before a set of rendering operations commences on the supplied render context.

void	stopRender (QgsSymbolRenderContext &context) override
	Called after a set of rendering operations has finished on the supplied render context.

Public Member Functions inherited from QgsMarkerSymbolLayer
	QgsMarkerSymbolLayer (const QgsMarkerSymbolLayer &other)=delete
	QgsMarkerSymbolLayer cannot be copied.

double	angle () const
	Returns the rotation angle for the marker, in degrees clockwise from north.

void	drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override

virtual double	dxfAngle (QgsSymbolRenderContext &context) const override
	Gets angle.

virtual double	dxfSize (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
	Gets marker size.

HorizontalAnchorPoint	horizontalAnchorPoint () const
	Returns the horizontal anchor point for positioning the symbol.

QPointF	offset () const
	Returns the marker's offset, which is the horizontal and vertical displacement which the rendered marker will have from the original feature's geometry.

const QgsMapUnitScale &	offsetMapUnitScale () const
	Returns the map unit scale for the symbol's offset.

Qgis::RenderUnit	offsetUnit () const
	Returns the units for the symbol's offset.

QgsMarkerSymbolLayer &	operator= (const QgsMarkerSymbolLayer &other)=delete
	QgsMarkerSymbolLayer cannot be copied.

Qgis::ScaleMethod	scaleMethod () const
	Returns the method to use for scaling the marker's size.

void	setAngle (double angle)
	Sets the rotation angle for the marker.

void	setHorizontalAnchorPoint (HorizontalAnchorPoint h)
	Sets the horizontal anchor point for positioning the symbol.

void	setLineAngle (double lineAngle)
	Sets the line angle modification for the symbol's angle.

void	setOffset (QPointF offset)
	Sets the marker's offset, which is the horizontal and vertical displacement which the rendered marker should have from the original feature's geometry.

void	setOffsetMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale for the symbol's offset.

void	setOffsetUnit (Qgis::RenderUnit unit)
	Sets the units for the symbol's offset.

void	setScaleMethod (Qgis::ScaleMethod scaleMethod)
	Sets the method to use for scaling the marker's size.

virtual void	setSize (double size)
	Sets the symbol size.

void	setSizeMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale for the symbol's size.

void	setSizeUnit (Qgis::RenderUnit unit)
	Sets the units for the symbol's size.

void	setVerticalAnchorPoint (VerticalAnchorPoint v)
	Sets the vertical anchor point for positioning the symbol.

double	size () const
	Returns the symbol size.

const QgsMapUnitScale &	sizeMapUnitScale () const
	Returns the map unit scale for the symbol's size.

Qgis::RenderUnit	sizeUnit () const
	Returns the units for the symbol's size.

void	toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override
	Saves the symbol layer as SLD.

VerticalAnchorPoint	verticalAnchorPoint () const
	Returns the vertical anchor point for positioning the symbol.

Public Member Functions inherited from QgsSymbolLayer
	QgsSymbolLayer (const QgsSymbolLayer &other)=delete
	QgsSymbolLayer cannot be copied.

virtual	~QgsSymbolLayer ()

virtual bool	canCauseArtifactsBetweenAdjacentTiles () const
	Returns `true` if the symbol layer rendering can cause visible artifacts across a single feature when the feature is rendered as a series of adjacent map tiles each containing a portion of the feature's geometry.

QgsPropertyCollection &	dataDefinedProperties ()
	Returns a reference to the symbol layer's property collection, used for data defined overrides.

const QgsPropertyCollection &	dataDefinedProperties () const
	Returns a reference to the symbol layer's property collection, used for data defined overrides.

virtual QColor	dxfBrushColor (QgsSymbolRenderContext &context) const
	Gets brush/fill color.

virtual Qt::BrushStyle	dxfBrushStyle () const
	Gets brush/fill style.

virtual QColor	dxfColor (QgsSymbolRenderContext &context) const
	Gets color.

virtual QVector< qreal >	dxfCustomDashPattern (Qgis::RenderUnit &unit) const
	Gets dash pattern.

virtual double	dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
	Gets offset.

virtual Qt::PenStyle	dxfPenStyle () const
	Gets pen style.

virtual double	dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
	Gets line width.

bool	enabled () const
	Returns `true` if symbol layer is enabled and will be drawn.

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.

virtual Qgis::SymbolLayerFlags	flags () const
	Returns flags which control the symbol layer's behavior.

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

QString	id () const
	Returns symbol layer identifier This id is unique in the whole project.

virtual bool	isCompatibleWithSymbol (QgsSymbol *symbol) const
	Returns if the layer can be used below the specified symbol.

bool	isLocked () const
	Returns `true` if the symbol layer colors are locked and the layer will ignore any symbol-level color changes.

virtual QList< QgsSymbolLayerReference >	masks () const
	Returns masks defined by this symbol layer.

QgsSymbolLayer &	operator= (const QgsSymbolLayer &other)=delete
	QgsSymbolLayer cannot be copied.

QgsPaintEffect *	paintEffect () const
	Returns the current paint effect for the layer.

virtual void	prepareExpressions (const QgsSymbolRenderContext &context)
	Prepares all data defined property expressions for evaluation.

virtual void	prepareMasks (const QgsSymbolRenderContext &context)
	Prepares all mask internal objects according to what is defined in context This should be called prior to calling startRender() method.

int	renderingPass () const
	Specifies the rendering pass in which this symbol layer should be rendered.

void	setDataDefinedProperties (const QgsPropertyCollection &collection)
	Sets the symbol layer's property collection, used for data defined overrides.

virtual void	setDataDefinedProperty (Property key, const QgsProperty &property)
	Sets a data defined property for the layer.

void	setEnabled (bool enabled)
	Sets whether symbol layer is enabled and should be drawn.

void	setId (const QString &id)
	Set symbol layer identifier This id has to be unique in the whole project.

void	setLocked (bool locked)
	Sets whether the layer's colors are locked.

void	setPaintEffect (QgsPaintEffect *effect)
	Sets the current paint effect for the layer.

void	setRenderingPass (int renderingPass)
	Specifies the rendering pass in which this symbol layer should be rendered.

virtual bool	setSubSymbol (QgsSymbol *symbol)
	Sets layer's subsymbol. takes ownership of the passed symbol.

void	setUserFlags (Qgis::SymbolLayerUserFlags flags)
	Sets user-controlled flags which control the symbol layer's behavior.

virtual void	startFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
	Called before the layer will be rendered for a particular feature.

virtual void	stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
	Called after the layer has been rendered for a particular feature.

virtual QgsSymbol *	subSymbol ()
	Returns the symbol's sub symbol, if present.

Qgis::SymbolType	type () const

virtual QSet< QString >	usedAttributes (const QgsRenderContext &context) const
	Returns the set of attributes referenced by the layer.

Qgis::SymbolLayerUserFlags	userFlags () const
	Returns user-controlled flags which control the symbol layer's behavior.

Static Public Member Functions
static QgsSymbolLayer *	create (const QVariantMap &properties=QVariantMap())
	Creates a new QgsSimpleMarkerSymbolLayer.

static QgsSymbolLayer *	createFromSld (QDomElement &element)
	Creates a new QgsSimpleMarkerSymbolLayer from an SLD XML element.

Static Public Member Functions inherited from QgsSimpleMarkerSymbolLayerBase
static QList< Qgis::MarkerShape >	availableShapes ()
	Returns a list of all available shape types.

static Qgis::MarkerShape	decodeShape (const QString &name, bool *ok=nullptr)
	Attempts to decode a string representation of a shape name to the corresponding shape.

static QString	encodeShape (Qgis::MarkerShape shape)
	Encodes a shape to its string representation.

static bool	shapeIsFilled (Qgis::MarkerShape shape)
	Returns `true` if a symbol shape has a fill.

Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinition &	propertyDefinitions ()
	Returns the symbol layer property definitions.

Protected Member Functions
void	drawMarker (QPainter *p, QgsSymbolRenderContext &context)
	Draws the marker shape in the specified painter.

bool	prepareCache (QgsSymbolRenderContext &context)
	Prepares cache image.

Protected Member Functions inherited from QgsSimpleMarkerSymbolLayerBase
void	calculateOffsetAndRotation (QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedRotation, QPointF &offset, double &angle) const
	Calculates the marker offset and rotation.

double	calculateSize (QgsSymbolRenderContext &context, bool &hasDataDefinedSize) const
	Calculates the desired size of the marker, considering data defined size overrides.

bool	prepareMarkerPath (Qgis::MarkerShape symbol)
	Prepares the layer for drawing the specified shape (QPainterPath version)

bool	prepareMarkerShape (Qgis::MarkerShape shape)
	Prepares the layer for drawing the specified shape (QPolygonF version)

bool	shapeToPolygon (Qgis::MarkerShape shape, QPolygonF &polygon) const
	Creates a polygon representing the specified shape.

Protected Member Functions inherited from QgsMarkerSymbolLayer
	QgsMarkerSymbolLayer (bool locked=false)
	Constructor for QgsMarkerSymbolLayer.

void	markerOffset (QgsSymbolRenderContext &context, double &offsetX, double &offsetY) const
	Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point.

void	markerOffset (QgsSymbolRenderContext &context, double width, double height, double &offsetX, double &offsetY) const
	Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point.

void	markerOffset (QgsSymbolRenderContext &context, double width, double height, Qgis::RenderUnit widthUnit, Qgis::RenderUnit heightUnit, double &offsetX, double &offsetY, const QgsMapUnitScale &widthMapUnitScale, const QgsMapUnitScale &heightMapUnitScale) const

Protected Member Functions inherited from QgsSymbolLayer
	QgsSymbolLayer (Qgis::SymbolType type, bool locked=false)
	Constructor for QgsSymbolLayer.

void	copyDataDefinedProperties (QgsSymbolLayer *destLayer) const
	Copies all data defined properties of this layer to another symbol layer.

void	copyPaintEffect (QgsSymbolLayer *destLayer) const
	Copies paint effect of this layer to another symbol layer.

void	installMasks (QgsRenderContext &context, bool recursive)
	When rendering, install masks on context painter if recursive is `true` masks are installed recursively for all children symbol layers.

void	removeMasks (QgsRenderContext &context, bool recursive)
	When rendering, remove previously installed masks from context painter if recursive is `true` masks are removed recursively for all children symbol layers.

void	restoreOldDataDefinedProperties (const QVariantMap &stringMap)
	Restores older data defined properties from string map.

bool	shouldRenderUsingSelectionColor (const QgsSymbolRenderContext &context) const
	Returns `true` if the symbol layer should be rendered using the selection color from the render context.

Protected Attributes
QBrush	mBrush
	QBrush corresponding to marker's fill style.

QImage	mCache
	Cached image of marker, if using cached version.

QPen	mPen
	QPen corresponding to marker's stroke style.

Qt::PenCapStyle	mPenCapStyle = Qt::SquareCap
	Stroke pen cap style.

Qt::PenJoinStyle	mPenJoinStyle
	Stroke pen join style.

QBrush	mSelBrush
	QBrush to use as fill of selected symbols.

QImage	mSelCache
	Cached image of selected marker, if using cached version.

QPen	mSelPen
	QPen to use as stroke of selected symbols.

QColor	mStrokeColor
	Stroke color.

Qt::PenStyle	mStrokeStyle = Qt::SolidLine
	Stroke style.

double	mStrokeWidth = 0
	Stroke width.

QgsMapUnitScale	mStrokeWidthMapUnitScale
	Stroke width map unit scale.

Qgis::RenderUnit	mStrokeWidthUnit = Qgis::RenderUnit::Millimeters
	Stroke width units.

bool	mUsingCache = false
	`true` if using cached images of markers for drawing.

Protected Attributes inherited from QgsSimpleMarkerSymbolLayerBase
QPainterPath	mPath
	Painter path representing shape. If mPolygon is empty then the shape is stored in mPath.

QPolygonF	mPolygon
	Polygon of points in shape. If polygon is empty then shape is using mPath.

Qgis::MarkerShape	mShape
	Symbol shape.

Protected Attributes inherited from QgsMarkerSymbolLayer
double	mAngle = 0
	Marker rotation angle, in degrees clockwise from north.

HorizontalAnchorPoint	mHorizontalAnchorPoint = HCenter
	Horizontal anchor point.

double	mLineAngle = 0
	Line rotation angle (see setLineAngle() for details)

QPointF	mOffset
	Marker offset.

QgsMapUnitScale	mOffsetMapUnitScale
	Offset map unit scale.

Qgis::RenderUnit	mOffsetUnit = Qgis::RenderUnit::Millimeters
	Offset units.

Qgis::ScaleMethod	mScaleMethod = Qgis::ScaleMethod::ScaleDiameter
	Marker size scaling method.

double	mSize = 2.0
	Marker size.

QgsMapUnitScale	mSizeMapUnitScale
	Marker size map unit scale.

Qgis::RenderUnit	mSizeUnit = Qgis::RenderUnit::Millimeters
	Marker size unit.

VerticalAnchorPoint	mVerticalAnchorPoint = VCenter
	Vertical anchor point.

Protected Attributes inherited from QgsSymbolLayer
QPainterPath	mClipPath

QColor	mColor

QgsPropertyCollection	mDataDefinedProperties

bool	mEnabled = true
	True if layer is enabled and should be drawn.

QgsFields	mFields

QString	mId

bool	mLocked = false

std::unique_ptr< QgsPaintEffect >	mPaintEffect

int	mRenderingPass = 0

Qgis::SymbolType	mType

Qgis::SymbolLayerUserFlags	mUserFlags
	User controlled flags.

Static Protected Attributes
static const int	MAXIMUM_CACHE_WIDTH = 3000
	Maximum width/height of cache image.

Static Protected Attributes inherited from QgsSymbolLayer
static const bool	SELECT_FILL_BORDER = false
	Whether fill styles for selected features also highlight symbol stroke.

static const bool	SELECT_FILL_STYLE = false
	Whether fill styles for selected features uses symbol layer style.

static const bool	SELECTION_IS_OPAQUE = true
	Whether styles for selected features ignore symbol alpha.

Additional Inherited Members
Public Types inherited from QgsMarkerSymbolLayer
enum	HorizontalAnchorPoint { Left , HCenter , Right }
	Symbol horizontal anchor points. More...

enum	VerticalAnchorPoint { Top , VCenter , Bottom }
	Symbol vertical anchor points. More...

Public Types inherited from QgsSymbolLayer
enum class	Property : int { Size = 0 , Angle , Name , FillColor , StrokeColor , StrokeWidth , StrokeStyle , Offset , Character , Width , Height , PreserveAspectRatio , FillStyle , JoinStyle , SecondaryColor , LineAngle , LineDistance , GradientType , CoordinateMode , GradientSpread , GradientReference1X , GradientReference1Y , GradientReference2X , GradientReference2Y , GradientReference1IsCentroid , GradientReference2IsCentroid , BlurRadius , ShapeburstUseWholeShape , ShapeburstMaxDistance , ShapeburstIgnoreRings , File , DistanceX , DistanceY , DisplacementX , DisplacementY , Opacity , CustomDash , CapStyle , Placement , Interval , OffsetAlongLine , AverageAngleLength , HorizontalAnchor , VerticalAnchor , LayerEnabled , ArrowWidth , ArrowStartWidth , ArrowHeadLength , ArrowHeadThickness , ArrowHeadType , ArrowType , OffsetX , OffsetY , PointCount , RandomSeed , ClipPoints , DensityArea , FontFamily , FontStyle , DashPatternOffset , TrimStart , TrimEnd , LineStartWidthValue , LineEndWidthValue , LineStartColorValue , LineEndColorValue , MarkerClipping , RandomOffsetX , RandomOffsetY , LineClipping }
	Data definable properties. More...

Static Protected Member Functions inherited from QgsMarkerSymbolLayer
static QPointF	_rotatedOffset (QPointF offset, double angle)
	Adjusts a marker offset to account for rotation.

Detailed Description

Simple marker symbol layer, consisting of a rendered shape with solid fill color and an stroke.

Definition at line 175 of file qgsmarkersymbollayer.h.

Constructor & Destructor Documentation

◆ QgsSimpleMarkerSymbolLayer()

QgsSimpleMarkerSymbolLayer::QgsSimpleMarkerSymbolLayer	(	Qgis::MarkerShape	shape = `Qgis::MarkerShape::Circle`,
		double	size = `DEFAULT_SIMPLEMARKER_SIZE`,
		double	angle = `DEFAULT_SIMPLEMARKER_ANGLE`,
		Qgis::ScaleMethod	scaleMethod = `DEFAULT_SCALE_METHOD`,
		const QColor &	color = `DEFAULT_SIMPLEMARKER_COLOR`,
		const QColor &	strokeColor = `DEFAULT_SIMPLEMARKER_BORDERCOLOR`,
		Qt::PenJoinStyle	penJoinStyle = `DEFAULT_SIMPLEMARKER_JOINSTYLE`
	)

Constructor for QgsSimpleMarkerSymbolLayer.

Parameters

shape	symbol shape
size	symbol size (in mm)
angle	symbol rotation angle
scaleMethod	scaling method for data defined scaling
color	fill color for symbol
strokeColor	stroke color for symbol
penJoinStyle	join style for stroke pen

Definition at line 976 of file qgsmarkersymbollayer.cpp.

◆ ~QgsSimpleMarkerSymbolLayer()

QgsSimpleMarkerSymbolLayer::~QgsSimpleMarkerSymbolLayer ( )

overridedefault

Member Function Documentation

◆ bounds()

QRectF QgsSimpleMarkerSymbolLayer::bounds	(	QPointF	point,
		QgsSymbolRenderContext &	context
	)

overridevirtual

Returns the approximate bounding box of the marker symbol layer, taking into account any data defined overrides and offsets which are set for the marker layer.

Returns: approximate symbol bounds, in painter units

Implements QgsMarkerSymbolLayer.

Definition at line 1804 of file qgsmarkersymbollayer.cpp.

◆ clone()

QgsSimpleMarkerSymbolLayer * QgsSimpleMarkerSymbolLayer::clone ( ) const

overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 1394 of file qgsmarkersymbollayer.cpp.

◆ color()

QColor QgsSimpleMarkerSymbolLayer::color ( ) const

overridevirtual

Returns the "representative" color of the symbol layer.

Depending on the symbol layer type, this will have different meaning. For instance, a line symbol layer will generally return the stroke color of the layer, while a fill symbol layer will return the "fill" color instead of stroke.

Some symbol layer types will return an invalid QColor if they have no representative color associated (e.g. raster image based symbol layers).

See also: setColor(); strokeColor(); fillColor()

Reimplemented from QgsSymbolLayer.

Definition at line 1855 of file qgsmarkersymbollayer.cpp.

◆ create()

QgsSymbolLayer * QgsSimpleMarkerSymbolLayer::create ( const QVariantMap & properties = QVariantMap() )

static

Creates a new QgsSimpleMarkerSymbolLayer.

Parameters

properties a property map containing symbol properties (see properties())

Returns: new QgsSimpleMarkerSymbolLayer

Definition at line 986 of file qgsmarkersymbollayer.cpp.

◆ createFromSld()

QgsSymbolLayer * QgsSimpleMarkerSymbolLayer::createFromSld ( QDomElement & element )

static

Creates a new QgsSimpleMarkerSymbolLayer from an SLD XML element.

Parameters

element XML element containing SLD definition of symbol

Returns: new QgsSimpleMarkerSymbolLayer

Definition at line 1514 of file qgsmarkersymbollayer.cpp.

◆ drawMarker()

void QgsSimpleMarkerSymbolLayer::drawMarker	(	QPainter *	p,
		QgsSymbolRenderContext &	context
	)

protected

Draws the marker shape in the specified painter.

Parameters

p	destination QPainter
context	symbol context

Note: this method does not handle setting the painter pen or brush to match the symbol's fill or stroke

Definition at line 1563 of file qgsmarkersymbollayer.cpp.

◆ fillColor()

QColor QgsSimpleMarkerSymbolLayer::fillColor ( ) const

inlineoverridevirtual

Returns the fill color for the symbol layer.

This property is not supported by all symbol layer types, only those with a fill component. Symbol layers without a fill component will return an invalid QColor.

See also: setFillColor(); color(); strokeColor()

Reimplemented from QgsSymbolLayer.

Definition at line 231 of file qgsmarkersymbollayer.h.

◆ layerType()

QString QgsSimpleMarkerSymbolLayer::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 1087 of file qgsmarkersymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsSimpleMarkerSymbolLayer::mapUnitScale ( ) const

overridevirtual

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 1788 of file qgsmarkersymbollayer.cpp.

◆ ogrFeatureStyle()

QString QgsSimpleMarkerSymbolLayer::ogrFeatureStyle	(	double	mmScaleFactor,
		double	mapUnitScaleFactor
	)		const

overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 1452 of file qgsmarkersymbollayer.cpp.

◆ outputUnit()

Qgis::RenderUnit QgsSimpleMarkerSymbolLayer::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 QgsMarkerSymbolLayer.

Definition at line 1773 of file qgsmarkersymbollayer.cpp.

◆ penCapStyle()

Qt::PenCapStyle QgsSimpleMarkerSymbolLayer::penCapStyle ( ) const

inline

Returns the marker's stroke cap style (e.g., flat, round, etc).

See also: setPenCapStyle(); penJoinStyle(); strokeColor(); strokeStyle()

Since: QGIS 3.20

Definition at line 299 of file qgsmarkersymbollayer.h.

◆ penJoinStyle()

Qt::PenJoinStyle QgsSimpleMarkerSymbolLayer::penJoinStyle ( ) const

inline

Returns the marker's stroke join style (e.g., miter, bevel, etc).

See also: setPenJoinStyle(); penCapStyle(); strokeColor(); strokeStyle()

Definition at line 279 of file qgsmarkersymbollayer.h.

◆ prepareCache()

bool QgsSimpleMarkerSymbolLayer::prepareCache ( QgsSymbolRenderContext & context )

protected

Prepares cache image.

Returns: true in case of success, false if cache image size too large

Definition at line 1158 of file qgsmarkersymbollayer.cpp.

◆ properties()

QVariantMap QgsSimpleMarkerSymbolLayer::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 1369 of file qgsmarkersymbollayer.cpp.

◆ renderPoint()

void QgsSimpleMarkerSymbolLayer::renderPoint	(	QPointF	point,
		QgsSymbolRenderContext &	context
	)

overridevirtual

Renders a marker at the specified point.

Derived classes must implement this to handle drawing the point.

Parameters

point	position at which to render point, in painter units
context	symbol render context

Implements QgsMarkerSymbolLayer.

Definition at line 1334 of file qgsmarkersymbollayer.cpp.

◆ setColor()

void QgsSimpleMarkerSymbolLayer::setColor ( const QColor & color )

overridevirtual

Sets the "representative" color for the symbol layer.

Depending on the symbol layer type, this will have different meaning. For instance, a line symbol layer will generally set the stroke color of the layer, while a fill symbol layer will set the "fill" color instead of stroke.

See also: color(); setStrokeColor(); setFillColor()

Reimplemented from QgsSymbolLayer.

Definition at line 1843 of file qgsmarkersymbollayer.cpp.

◆ setFillColor()

void QgsSimpleMarkerSymbolLayer::setFillColor ( const QColor & color )

inlineoverridevirtual

Sets the fill color for the symbol layer.

This property is not supported by all symbol layer types, only those with a fill component.

See also: fillColor(); setColor(); setStrokeColor()

Reimplemented from QgsSymbolLayer.

Definition at line 232 of file qgsmarkersymbollayer.h.

◆ setMapUnitScale()

void QgsSimpleMarkerSymbolLayer::setMapUnitScale ( const QgsMapUnitScale & scale )

overridevirtual

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 1782 of file qgsmarkersymbollayer.cpp.

◆ setOutputUnit()

void QgsSimpleMarkerSymbolLayer::setOutputUnit ( Qgis::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

unit	output units

See also: outputUnit()

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 1767 of file qgsmarkersymbollayer.cpp.

◆ setPenCapStyle()

void QgsSimpleMarkerSymbolLayer::setPenCapStyle ( Qt::PenCapStyle style )

inline

Sets the marker's stroke cap style (e.g., flat, round, etc).

See also: penCapStyle(); penJoinStyle(); setStrokeColor(); setStrokeStyle()

Since: QGIS 3.20

Definition at line 309 of file qgsmarkersymbollayer.h.

◆ setPenJoinStyle()

void QgsSimpleMarkerSymbolLayer::setPenJoinStyle ( Qt::PenJoinStyle style )

inline

Sets the marker's stroke join style (e.g., miter, bevel, etc).

Parameters

style join style

See also: penJoinStyle(); setPenCapStyle(); setStrokeColor(); setStrokeStyle()

Definition at line 289 of file qgsmarkersymbollayer.h.

◆ setStrokeColor()

void QgsSimpleMarkerSymbolLayer::setStrokeColor ( const QColor & color )

inlineoverridevirtual

Sets the marker's stroke color.

Parameters

color stroke color

See also: strokeColor(); setStrokeStyle(); setPenJoinStyle()

Reimplemented from QgsSymbolLayer.

Definition at line 253 of file qgsmarkersymbollayer.h.

◆ setStrokeStyle()

void QgsSimpleMarkerSymbolLayer::setStrokeStyle ( Qt::PenStyle strokeStyle )

inline

Sets the marker's stroke style (e.g., solid, dashed, etc)

Parameters

strokeStyle style

See also: strokeStyle(); setStrokeColor(); setPenJoinStyle()

Definition at line 270 of file qgsmarkersymbollayer.h.

◆ setStrokeWidth()

void QgsSimpleMarkerSymbolLayer::setStrokeWidth ( double w )

inline

Sets the width of the marker's stroke.

Parameters

w	stroke width. See strokeWidthUnit() for units.

See also: strokeWidth(); setStrokeWidthUnit(); setStrokeWidthMapUnitScale()

Definition at line 326 of file qgsmarkersymbollayer.h.

◆ setStrokeWidthMapUnitScale()

void QgsSimpleMarkerSymbolLayer::setStrokeWidthMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the map scale for the width of the marker's stroke.

Parameters

scale stroke width map unit scale

See also: strokeWidthMapUnitScale(); setStrokeWidth(); setStrokeWidthUnit()

Definition at line 352 of file qgsmarkersymbollayer.h.

◆ setStrokeWidthUnit()

void QgsSimpleMarkerSymbolLayer::setStrokeWidthUnit ( Qgis::RenderUnit u )

inline

Sets the unit for the width of the marker's stroke.

Parameters

u	stroke width unit

See also: strokeWidthUnit(); setStrokeWidth(); setStrokeWidthMapUnitScale()

Definition at line 335 of file qgsmarkersymbollayer.h.

◆ startRender()

void QgsSimpleMarkerSymbolLayer::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()

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 1092 of file qgsmarkersymbollayer.cpp.

◆ strokeColor()

QColor QgsSimpleMarkerSymbolLayer::strokeColor ( ) const

inlineoverridevirtual

Returns the marker's stroke color.

See also: setStrokeColor(); strokeStyle(); penJoinStyle()

Reimplemented from QgsSymbolLayer.

Definition at line 244 of file qgsmarkersymbollayer.h.

◆ strokeStyle()

Qt::PenStyle QgsSimpleMarkerSymbolLayer::strokeStyle ( ) const

inline

Returns the marker's stroke style (e.g., solid, dashed, etc)

See also: setStrokeStyle(); strokeColor(); penJoinStyle()

Definition at line 261 of file qgsmarkersymbollayer.h.

◆ strokeWidth()

double QgsSimpleMarkerSymbolLayer::strokeWidth ( ) const

inline

Returns the width of the marker's stroke.

See also: setStrokeWidth(); strokeWidthUnit(); strokeWidthMapUnitScale()

Definition at line 317 of file qgsmarkersymbollayer.h.

◆ strokeWidthMapUnitScale()

const QgsMapUnitScale & QgsSimpleMarkerSymbolLayer::strokeWidthMapUnitScale ( ) const

inline

Returns the map scale for the width of the marker's stroke.

See also: setStrokeWidthMapUnitScale(); strokeWidth(); strokeWidthUnit()

Definition at line 360 of file qgsmarkersymbollayer.h.

◆ strokeWidthUnit()

Qgis::RenderUnit QgsSimpleMarkerSymbolLayer::strokeWidthUnit ( ) const

inline

Returns the unit for the width of the marker's stroke.

See also: setStrokeWidthUnit(); strokeWidth(); strokeWidthMapUnitScale()

Definition at line 343 of file qgsmarkersymbollayer.h.

◆ usesMapUnits()

bool QgsSimpleMarkerSymbolLayer::usesMapUnits ( ) const

overridevirtual

Returns true if the symbol layer has any components which use map unit based sizes.

Since: QGIS 3.18

Reimplemented from QgsSymbolLayer.

Definition at line 1797 of file qgsmarkersymbollayer.cpp.

◆ writeDxf()

bool QgsSimpleMarkerSymbolLayer::writeDxf	(	QgsDxfExport &	e,
		double	mmMapUnitScaleFactor,
		const QString &	layerName,
		QgsSymbolRenderContext &	context,
		QPointF	shift = `QPointF( 0.0, 0.0 )`
	)		const

overridevirtual

write as DXF

Reimplemented from QgsSymbolLayer.

Definition at line 1577 of file qgsmarkersymbollayer.cpp.

◆ writeSldMarker()

void QgsSimpleMarkerSymbolLayer::writeSldMarker	(	QDomDocument &	doc,
		QDomElement &	element,
		const QVariantMap &	props
	)		const

overridevirtual

Writes the symbol layer definition as a SLD XML element.

Parameters

doc	XML document
element	parent XML element
props	symbol layer definition (see properties())

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 1414 of file qgsmarkersymbollayer.cpp.

Member Data Documentation

◆ MAXIMUM_CACHE_WIDTH

const int QgsSimpleMarkerSymbolLayer::MAXIMUM_CACHE_WIDTH = 3000

staticprotected

Maximum width/height of cache image.

Definition at line 413 of file qgsmarkersymbollayer.h.

◆ mBrush

QBrush QgsSimpleMarkerSymbolLayer::mBrush

protected

QBrush corresponding to marker's fill style.

Definition at line 395 of file qgsmarkersymbollayer.h.

◆ mCache

QImage QgsSimpleMarkerSymbolLayer::mCache

protected

Cached image of marker, if using cached version.

Definition at line 398 of file qgsmarkersymbollayer.h.

◆ mPen

QPen QgsSimpleMarkerSymbolLayer::mPen

protected

QPen corresponding to marker's stroke style.

Definition at line 393 of file qgsmarkersymbollayer.h.

◆ mPenCapStyle

Qt::PenCapStyle QgsSimpleMarkerSymbolLayer::mPenCapStyle = Qt::SquareCap

protected

Stroke pen cap style.

Definition at line 391 of file qgsmarkersymbollayer.h.

◆ mPenJoinStyle

Qt::PenJoinStyle QgsSimpleMarkerSymbolLayer::mPenJoinStyle

protected

Stroke pen join style.

Definition at line 389 of file qgsmarkersymbollayer.h.

◆ mSelBrush

QBrush QgsSimpleMarkerSymbolLayer::mSelBrush

protected

QBrush to use as fill of selected symbols.

Definition at line 402 of file qgsmarkersymbollayer.h.

◆ mSelCache

QImage QgsSimpleMarkerSymbolLayer::mSelCache

protected

Cached image of selected marker, if using cached version.

Definition at line 404 of file qgsmarkersymbollayer.h.

◆ mSelPen

QPen QgsSimpleMarkerSymbolLayer::mSelPen

protected

QPen to use as stroke of selected symbols.

Definition at line 400 of file qgsmarkersymbollayer.h.

◆ mStrokeColor

QColor QgsSimpleMarkerSymbolLayer::mStrokeColor

protected

Stroke color.

Definition at line 379 of file qgsmarkersymbollayer.h.

◆ mStrokeStyle

Qt::PenStyle QgsSimpleMarkerSymbolLayer::mStrokeStyle = Qt::SolidLine

protected

Stroke style.

Definition at line 381 of file qgsmarkersymbollayer.h.

◆ mStrokeWidth

double QgsSimpleMarkerSymbolLayer::mStrokeWidth = 0

protected

Stroke width.

Definition at line 383 of file qgsmarkersymbollayer.h.

◆ mStrokeWidthMapUnitScale

QgsMapUnitScale QgsSimpleMarkerSymbolLayer::mStrokeWidthMapUnitScale

protected

Stroke width map unit scale.

Definition at line 387 of file qgsmarkersymbollayer.h.

◆ mStrokeWidthUnit

Qgis::RenderUnit QgsSimpleMarkerSymbolLayer::mStrokeWidthUnit = Qgis::RenderUnit::Millimeters

protected

Stroke width units.

Definition at line 385 of file qgsmarkersymbollayer.h.

◆ mUsingCache

bool QgsSimpleMarkerSymbolLayer::mUsingCache = false

protected

true if using cached images of markers for drawing.

This is faster, but cannot be used when data defined properties are present

Definition at line 410 of file qgsmarkersymbollayer.h.

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

/home/fischer/src/qgis-3.38/src/core/symbology/qgsmarkersymbollayer.h
/home/fischer/src/qgis-3.38/src/core/symbology/qgsmarkersymbollayer.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsSimpleMarkerSymbolLayer()

◆ ~QgsSimpleMarkerSymbolLayer()

Member Function Documentation

◆ bounds()

◆ clone()

◆ color()

◆ create()

◆ createFromSld()

◆ drawMarker()

◆ fillColor()

◆ layerType()

◆ mapUnitScale()

◆ ogrFeatureStyle()

◆ outputUnit()

◆ penCapStyle()

◆ penJoinStyle()

◆ prepareCache()

◆ properties()

◆ renderPoint()

◆ setColor()

◆ setFillColor()

◆ setMapUnitScale()

◆ setOutputUnit()

◆ setPenCapStyle()

◆ setPenJoinStyle()

◆ setStrokeColor()

◆ setStrokeStyle()

◆ setStrokeWidth()

◆ setStrokeWidthMapUnitScale()

◆ setStrokeWidthUnit()

◆ startRender()

◆ strokeColor()

◆ strokeStyle()

◆ strokeWidth()

◆ strokeWidthMapUnitScale()

◆ strokeWidthUnit()

◆ usesMapUnits()

◆ writeDxf()

◆ writeSldMarker()

Member Data Documentation

◆ MAXIMUM_CACHE_WIDTH

◆ mBrush

◆ mCache

◆ mPen

◆ mPenCapStyle

◆ mPenJoinStyle

◆ mSelBrush

◆ mSelCache

◆ mSelPen

◆ mStrokeColor

◆ mStrokeStyle

◆ mStrokeWidth

◆ mStrokeWidthMapUnitScale

◆ mStrokeWidthUnit

◆ mUsingCache