A symbol layer for rendering objects with major and minor axis (e.g. More...

#include <qgsellipsesymbollayer.h>

Inheritance diagram for QgsEllipseSymbolLayer:

[legend]

Public Types
enum	Shape { Circle , Rectangle , Diamond , Cross , Arrow , HalfArc , Triangle , RightHalfTriangle , LeftHalfTriangle , SemiCircle , ThirdCircle , QuarterCircle , Pentagon , Hexagon , Octagon , Star }
	Marker symbol shapes. More...

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...

Public Member Functions
	QgsEllipseSymbolLayer ()

	~QgsEllipseSymbolLayer () 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.

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

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

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
	Gets stroke join style.

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	setFillColor (const QColor &c) 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)
	Set stroke join style.

void	setShape (QgsEllipseSymbolLayer::Shape shape)
	Sets the rendered ellipse marker shape.

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

void	setStrokeColor (const QColor &c) override
	Sets the stroke color for the symbol layer.

void	setStrokeStyle (Qt::PenStyle strokeStyle)

void	setStrokeWidth (double w)

void	setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale)

void	setStrokeWidthUnit (Qgis::RenderUnit unit)
	Sets the units for the symbol's stroke width.

void	setSymbolHeight (double h)

void	setSymbolHeightMapUnitScale (const QgsMapUnitScale &scale)

void	setSymbolHeightUnit (Qgis::RenderUnit unit)
	Sets the units for the symbol's height.

Q_DECL_DEPRECATED void	setSymbolName (const QString &name)
	Sets the rendered ellipse marker shape using a symbol name.

void	setSymbolWidth (double w)

void	setSymbolWidthMapUnitScale (const QgsMapUnitScale &scale)

void	setSymbolWidthUnit (Qgis::RenderUnit unit)
	Sets the units for the symbol's width.

QgsEllipseSymbolLayer::Shape	shape () const
	Returns the shape for the rendered ellipse 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.

QColor	strokeColor () const override
	Returns the stroke color for the symbol layer.

Qt::PenStyle	strokeStyle () const

double	strokeWidth () const

const QgsMapUnitScale &	strokeWidthMapUnitScale () const

Qgis::RenderUnit	strokeWidthUnit () const
	Returns the units for the symbol's stroke width.

double	symbolHeight () const

const QgsMapUnitScale &	symbolHeightMapUnitScale () const

Qgis::RenderUnit	symbolHeightUnit () const
	Returns the units for the symbol's height.

Q_DECL_DEPRECATED QString	symbolName () const
	Returns the shape name for the rendered ellipse marker symbol.

double	symbolWidth () const

const QgsMapUnitScale &	symbolWidthMapUnitScale () const

Qgis::RenderUnit	symbolWidthUnit () const
	Returns the units for the symbol's width.

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

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 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.

QgsMapUnitScale	mapUnitScale () const override

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::RenderUnit	outputUnit () const override
	Returns the units to use for sizes and widths within the symbol layer.

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	setMapUnitScale (const QgsMapUnitScale &scale) override

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	setOutputUnit (Qgis::RenderUnit unit) override
	Sets the units to use for sizes and widths within the symbol layer.

void	setScaleMethod (Qgis::ScaleMethod scaleMethod)
	Sets the method to use for scaling the marker's 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	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.

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.

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

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.

virtual QString	ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const

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.

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

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 QList< QgsEllipseSymbolLayer::Shape >	availableShapes ()
	Returns a list of all available shape types.

static QgsSymbolLayer *	create (const QVariantMap &properties=QVariantMap())
	Creates the symbol layer.

static QgsSymbolLayer *	createFromSld (QDomElement &element)

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

static QString	encodeShape (QgsEllipseSymbolLayer::Shape shape)
	Encodes a shape to its string representation.

static bool	shapeIsFilled (const QgsEllipseSymbolLayer::Shape &shape)
	Returns `true` if a shape has a fill.

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

Additional Inherited Members
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.

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

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 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.

Detailed Description

A symbol layer for rendering objects with major and minor axis (e.g.

ellipse, rectangle, etc).

Definition at line 31 of file qgsellipsesymbollayer.h.

Member Enumeration Documentation

◆ Shape

enum QgsEllipseSymbolLayer::Shape

Marker symbol shapes.

Enumerator
Circle	Circle.
Rectangle	Rectangle.
Diamond	Diamond.
Cross	Stroke-only cross.
Arrow	Stroke-only arrow (since QGIS 3.20)
HalfArc	Stroke-only half arc (since QGIS 3.20)
Triangle	Triangle.
RightHalfTriangle	Right half of a triangle.
LeftHalfTriangle	Left half of a triangle.
SemiCircle	Semi circle.
ThirdCircle	Third Circle (since QGIS 3.28)
QuarterCircle	Quarter Circle (since QGIS 3.28)
Pentagon	Pentagon (since QGIS 3.28)
Hexagon	Hexagon (since QGIS 3.28)
Octagon	Octagon (since QGIS 3.28)
Star	Star (since QGIS 3.28)

Definition at line 36 of file qgsellipsesymbollayer.h.

Constructor & Destructor Documentation

◆ QgsEllipseSymbolLayer()

QgsEllipseSymbolLayer::QgsEllipseSymbolLayer ( )

Definition at line 31 of file qgsellipsesymbollayer.cpp.

◆ ~QgsEllipseSymbolLayer()

QgsEllipseSymbolLayer::~QgsEllipseSymbolLayer ( )

overridedefault

Member Function Documentation

◆ availableShapes()

QList< QgsEllipseSymbolLayer::Shape > QgsEllipseSymbolLayer::availableShapes ( )

static

Returns a list of all available shape types.

Definition at line 1175 of file qgsellipsesymbollayer.cpp.

◆ bounds()

QRectF QgsEllipseSymbolLayer::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 841 of file qgsellipsesymbollayer.cpp.

◆ clone()

QgsEllipseSymbolLayer * QgsEllipseSymbolLayer::clone ( ) const

overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 382 of file qgsellipsesymbollayer.cpp.

◆ create()

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

static

Creates the symbol layer.

Definition at line 47 of file qgsellipsesymbollayer.cpp.

◆ createFromSld()

QgsSymbolLayer * QgsEllipseSymbolLayer::createFromSld ( QDomElement & element )

static

Definition at line 485 of file qgsellipsesymbollayer.cpp.

◆ decodeShape()

QgsEllipseSymbolLayer::Shape QgsEllipseSymbolLayer::decodeShape	(	const QString &	name,
		bool *	ok = `nullptr`
	)

static

Attempts to decode a string representation of a shape name to the corresponding shape.

Parameters

name	encoded shape name
ok	if specified, will be set to `true` if shape was successfully decoded

Returns: decoded name

See also: encodeShape()

Since: QGIS 3.20

Definition at line 1093 of file qgsellipsesymbollayer.cpp.

◆ encodeShape()

QString QgsEllipseSymbolLayer::encodeShape ( QgsEllipseSymbolLayer::Shape shape )

static

Encodes a shape to its string representation.

Parameters

shape shape to encode

Returns: encoded string

See also: decodeShape()

Since: QGIS 3.20

Definition at line 1135 of file qgsellipsesymbollayer.cpp.

◆ fillColor()

QColor QgsEllipseSymbolLayer::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 181 of file qgsellipsesymbollayer.h.

◆ layerType()

QString QgsEllipseSymbolLayer::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 346 of file qgsellipsesymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsEllipseSymbolLayer::mapUnitScale ( ) const

overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 830 of file qgsellipsesymbollayer.cpp.

◆ outputUnit()

Qgis::RenderUnit QgsEllipseSymbolLayer::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 QgsSymbolLayer.

Definition at line 804 of file qgsellipsesymbollayer.cpp.

◆ penCapStyle()

Qt::PenCapStyle QgsEllipseSymbolLayer::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 165 of file qgsellipsesymbollayer.h.

◆ penJoinStyle()

Qt::PenJoinStyle QgsEllipseSymbolLayer::penJoinStyle ( ) const

inline

Gets stroke join style.

Definition at line 150 of file qgsellipsesymbollayer.h.

◆ properties()

QVariantMap QgsEllipseSymbolLayer::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 543 of file qgsellipsesymbollayer.cpp.

◆ renderPoint()

void QgsEllipseSymbolLayer::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 174 of file qgsellipsesymbollayer.cpp.

◆ setFillColor()

void QgsEllipseSymbolLayer::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 180 of file qgsellipsesymbollayer.h.

◆ setMapUnitScale()

void QgsEllipseSymbolLayer::setMapUnitScale ( const QgsMapUnitScale & scale )

overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 822 of file qgsellipsesymbollayer.cpp.

◆ setOutputUnit()

void QgsEllipseSymbolLayer::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 QgsSymbolLayer.

Definition at line 796 of file qgsellipsesymbollayer.cpp.

◆ setPenCapStyle()

void QgsEllipseSymbolLayer::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 175 of file qgsellipsesymbollayer.h.

◆ setPenJoinStyle()

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

inline

Set stroke join style.

Definition at line 155 of file qgsellipsesymbollayer.h.

◆ setShape()

void QgsEllipseSymbolLayer::setShape ( QgsEllipseSymbolLayer::Shape shape )

inline

Sets the rendered ellipse marker shape.

Parameters

shape new ellipse marker shape

See also: shape()

Since: QGIS 3.20

Definition at line 114 of file qgsellipsesymbollayer.h.

◆ setSize()

void QgsEllipseSymbolLayer::setSize ( double size )

overridevirtual

Sets the symbol size.

Parameters

size	symbol size. Units are specified by sizeUnit().

See also: size(); setSizeUnit(); setSizeMapUnitScale()

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 769 of file qgsellipsesymbollayer.cpp.

◆ setStrokeColor()

void QgsEllipseSymbolLayer::setStrokeColor ( const QColor & color )

inlineoverridevirtual

Sets the stroke color for the symbol layer.

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

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

Reimplemented from QgsSymbolLayer.

Definition at line 183 of file qgsellipsesymbollayer.h.

◆ setStrokeStyle()

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

inline

Definition at line 145 of file qgsellipsesymbollayer.h.

◆ setStrokeWidth()

void QgsEllipseSymbolLayer::setStrokeWidth ( double w )

inline

Definition at line 177 of file qgsellipsesymbollayer.h.

◆ setStrokeWidthMapUnitScale()

void QgsEllipseSymbolLayer::setStrokeWidthMapUnitScale ( const QgsMapUnitScale & scale )

inline

Definition at line 235 of file qgsellipsesymbollayer.h.

◆ setStrokeWidthUnit()

void QgsEllipseSymbolLayer::setStrokeWidthUnit ( Qgis::RenderUnit unit )

inline

Sets the units for the symbol's stroke width.

Parameters

unit	symbol units

See also: strokeWidthUnit()

Definition at line 227 of file qgsellipsesymbollayer.h.

◆ setSymbolHeight()

void QgsEllipseSymbolLayer::setSymbolHeight ( double h )

Definition at line 790 of file qgsellipsesymbollayer.cpp.

◆ setSymbolHeightMapUnitScale()

void QgsEllipseSymbolLayer::setSymbolHeightMapUnitScale ( const QgsMapUnitScale & scale )

inline

Definition at line 219 of file qgsellipsesymbollayer.h.

◆ setSymbolHeightUnit()

void QgsEllipseSymbolLayer::setSymbolHeightUnit ( Qgis::RenderUnit unit )

inline

Sets the units for the symbol's height.

Parameters

unit	symbol units

See also: symbolHeightUnit(); setSymbolWidthUnit()

Definition at line 210 of file qgsellipsesymbollayer.h.

◆ setSymbolName()

Q_DECL_DEPRECATED void QgsEllipseSymbolLayer::setSymbolName ( const QString & name )

inline

Sets the rendered ellipse marker shape using a symbol name.

See also: setShape(); shape()

Deprecated:: since QGIS 3.20

Definition at line 91 of file qgsellipsesymbollayer.h.

◆ setSymbolWidth()

void QgsEllipseSymbolLayer::setSymbolWidth ( double w )

Definition at line 784 of file qgsellipsesymbollayer.cpp.

◆ setSymbolWidthMapUnitScale()

void QgsEllipseSymbolLayer::setSymbolWidthMapUnitScale ( const QgsMapUnitScale & scale )

inline

Definition at line 201 of file qgsellipsesymbollayer.h.

◆ setSymbolWidthUnit()

void QgsEllipseSymbolLayer::setSymbolWidthUnit ( Qgis::RenderUnit unit )

inline

Sets the units for the symbol's width.

Parameters

unit	symbol units

See also: symbolWidthUnit(); setSymbolHeightUnit()

Definition at line 192 of file qgsellipsesymbollayer.h.

◆ shape()

QgsEllipseSymbolLayer::Shape QgsEllipseSymbolLayer::shape ( ) const

inline

Returns the shape for the rendered ellipse marker symbol.

See also: setShape()

Since: QGIS 3.20

Definition at line 106 of file qgsellipsesymbollayer.h.

◆ shapeIsFilled()

bool QgsEllipseSymbolLayer::shapeIsFilled ( const QgsEllipseSymbolLayer::Shape & shape )

static

Returns true if a shape has a fill.

Returns: true if shape uses a fill, or false if shape uses lines only

Since: QGIS 3.20

Definition at line 741 of file qgsellipsesymbollayer.cpp.

◆ startRender()

void QgsEllipseSymbolLayer::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 351 of file qgsellipsesymbollayer.cpp.

◆ stopRender()

void QgsEllipseSymbolLayer::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 378 of file qgsellipsesymbollayer.cpp.

◆ strokeColor()

QColor QgsEllipseSymbolLayer::strokeColor ( ) const

inlineoverridevirtual

Returns the stroke color for the symbol layer.

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

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

Reimplemented from QgsSymbolLayer.

Definition at line 184 of file qgsellipsesymbollayer.h.

◆ strokeStyle()

Qt::PenStyle QgsEllipseSymbolLayer::strokeStyle ( ) const

inline

Definition at line 144 of file qgsellipsesymbollayer.h.

◆ strokeWidth()

double QgsEllipseSymbolLayer::strokeWidth ( ) const

inline

Definition at line 178 of file qgsellipsesymbollayer.h.

◆ strokeWidthMapUnitScale()

const QgsMapUnitScale & QgsEllipseSymbolLayer::strokeWidthMapUnitScale ( ) const

inline

Definition at line 236 of file qgsellipsesymbollayer.h.

◆ strokeWidthUnit()

Qgis::RenderUnit QgsEllipseSymbolLayer::strokeWidthUnit ( ) const

inline

Returns the units for the symbol's stroke width.

See also: setStrokeWidthUnit()

Definition at line 233 of file qgsellipsesymbollayer.h.

◆ symbolHeight()

double QgsEllipseSymbolLayer::symbolHeight ( ) const

inline

Definition at line 142 of file qgsellipsesymbollayer.h.

◆ symbolHeightMapUnitScale()

const QgsMapUnitScale & QgsEllipseSymbolLayer::symbolHeightMapUnitScale ( ) const

inline

Definition at line 220 of file qgsellipsesymbollayer.h.

◆ symbolHeightUnit()

Qgis::RenderUnit QgsEllipseSymbolLayer::symbolHeightUnit ( ) const

inline

Returns the units for the symbol's height.

See also: setSymbolHeightUnit(); symbolWidthUnit()

Definition at line 217 of file qgsellipsesymbollayer.h.

◆ symbolName()

Q_DECL_DEPRECATED QString QgsEllipseSymbolLayer::symbolName ( ) const

inline

Returns the shape name for the rendered ellipse marker symbol.

See also: shape(); setShape()

Deprecated:: since QGIS 3.20

Definition at line 99 of file qgsellipsesymbollayer.h.

◆ symbolWidth()

double QgsEllipseSymbolLayer::symbolWidth ( ) const

inline

Definition at line 139 of file qgsellipsesymbollayer.h.

◆ symbolWidthMapUnitScale()

const QgsMapUnitScale & QgsEllipseSymbolLayer::symbolWidthMapUnitScale ( ) const

inline

Definition at line 202 of file qgsellipsesymbollayer.h.

◆ symbolWidthUnit()

Qgis::RenderUnit QgsEllipseSymbolLayer::symbolWidthUnit ( ) const

inline

Returns the units for the symbol's width.

See also: setSymbolWidthUnit(); symbolHeightUnit()

Definition at line 199 of file qgsellipsesymbollayer.h.

◆ toSld()

void QgsEllipseSymbolLayer::toSld	(	QDomDocument &	doc,
		QDomElement &	element,
		const QVariantMap &	props
	)		const

overridevirtual

Saves the symbol layer as SLD.

Reimplemented from QgsSymbolLayer.

Definition at line 415 of file qgsellipsesymbollayer.cpp.

◆ usesMapUnits()

bool QgsEllipseSymbolLayer::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 814 of file qgsellipsesymbollayer.cpp.

◆ writeDxf()

bool QgsEllipseSymbolLayer::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 903 of file qgsellipsesymbollayer.cpp.

◆ writeSldMarker()

void QgsEllipseSymbolLayer::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 428 of file qgsellipsesymbollayer.cpp.

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

/build/qgis-3.36.0+99sid/src/core/symbology/qgsellipsesymbollayer.h
/build/qgis-3.36.0+99sid/src/core/symbology/qgsellipsesymbollayer.cpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Shape

Constructor & Destructor Documentation

◆ QgsEllipseSymbolLayer()

◆ ~QgsEllipseSymbolLayer()

Member Function Documentation

◆ availableShapes()

◆ bounds()

◆ clone()

◆ create()

◆ createFromSld()

◆ decodeShape()

◆ encodeShape()

◆ fillColor()

◆ layerType()

◆ mapUnitScale()

◆ outputUnit()

◆ penCapStyle()

◆ penJoinStyle()

◆ properties()

◆ renderPoint()

◆ setFillColor()

◆ setMapUnitScale()

◆ setOutputUnit()

◆ setPenCapStyle()

◆ setPenJoinStyle()

◆ setShape()

◆ setSize()

◆ setStrokeColor()

◆ setStrokeStyle()

◆ setStrokeWidth()

◆ setStrokeWidthMapUnitScale()

◆ setStrokeWidthUnit()

◆ setSymbolHeight()

◆ setSymbolHeightMapUnitScale()

◆ setSymbolHeightUnit()

◆ setSymbolName()

◆ setSymbolWidth()

◆ setSymbolWidthMapUnitScale()

◆ setSymbolWidthUnit()

◆ shape()

◆ shapeIsFilled()

◆ startRender()

◆ stopRender()

◆ strokeColor()

◆ strokeStyle()

◆ strokeWidth()

◆ strokeWidthMapUnitScale()

◆ strokeWidthUnit()

◆ symbolHeight()

◆ symbolHeightMapUnitScale()

◆ symbolHeightUnit()

◆ symbolName()

◆ symbolWidth()

◆ symbolWidthMapUnitScale()

◆ symbolWidthUnit()

◆ toSld()

◆ usesMapUnits()

◆ writeDxf()

◆ writeSldMarker()