QGIS API Documentation 3.27.0-Master (95e00c50d2)
Public Types | Public Member Functions | Static Public Member Functions | List of all members
QgsEllipseSymbolLayer Class Reference

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

#include <qgsellipsesymbollayer.h>

Inheritance diagram for QgsEllipseSymbolLayer:
Inheritance graph
[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  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 , PropertyDashPatternOffset ,
  PropertyTrimStart , PropertyTrimEnd , PropertyLineStartWidthValue , PropertyLineEndWidthValue ,
  PropertyLineStartColorValue , PropertyLineEndColorValue , PropertyMarkerClipping , PropertyRandomOffsetX ,
  PropertyRandomOffsetY , PropertyLineClipping
}
 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. More...
 
QgsEllipseSymbolLayerclone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
QColor fillColor () const override
 Returns the fill color for the symbol layer. More...
 
QString layerType () const override
 Returns a string that represents this layer type. More...
 
QgsMapUnitScale mapUnitScale () const override
 
QgsUnitTypes::RenderUnit outputUnit () const override
 Returns the units to use for sizes and widths within the symbol layer. More...
 
Qt::PenCapStyle penCapStyle () const
 Returns the marker's stroke cap style (e.g., flat, round, etc). More...
 
Qt::PenJoinStyle penJoinStyle () const
 Gets stroke join style. More...
 
QVariantMap properties () const override
 Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. More...
 
void renderPoint (QPointF point, QgsSymbolRenderContext &context) override
 Renders a marker at the specified point. More...
 
void setFillColor (const QColor &c) override
 Sets the fill color for the symbol layer. More...
 
void setMapUnitScale (const QgsMapUnitScale &scale) override
 
void setOutputUnit (QgsUnitTypes::RenderUnit unit) override
 Sets the units to use for sizes and widths within the symbol layer. More...
 
void setPenCapStyle (Qt::PenCapStyle style)
 Sets the marker's stroke cap style (e.g., flat, round, etc). More...
 
void setPenJoinStyle (Qt::PenJoinStyle style)
 Set stroke join style. More...
 
void setShape (QgsEllipseSymbolLayer::Shape shape)
 Sets the rendered ellipse marker shape. More...
 
void setSize (double size) override
 Sets the symbol size. More...
 
void setStrokeColor (const QColor &c) override
 Sets the stroke color for the symbol layer. More...
 
void setStrokeStyle (Qt::PenStyle strokeStyle)
 
void setStrokeWidth (double w)
 
void setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale)
 
void setStrokeWidthUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units for the symbol's stroke width. More...
 
void setSymbolHeight (double h)
 
void setSymbolHeightMapUnitScale (const QgsMapUnitScale &scale)
 
void setSymbolHeightUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units for the symbol's height. More...
 
Q_DECL_DEPRECATED void setSymbolName (const QString &name)
 Sets the rendered ellipse marker shape using a symbol name. More...
 
void setSymbolWidth (double w)
 
void setSymbolWidthMapUnitScale (const QgsMapUnitScale &scale)
 
void setSymbolWidthUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units for the symbol's width. More...
 
QgsEllipseSymbolLayer::Shape shape () const
 Returns the shape for the rendered ellipse marker 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...
 
QColor strokeColor () const override
 Returns the stroke color for the symbol layer. More...
 
Qt::PenStyle strokeStyle () const
 
double strokeWidth () const
 
const QgsMapUnitScalestrokeWidthMapUnitScale () const
 
QgsUnitTypes::RenderUnit strokeWidthUnit () const
 Returns the units for the symbol's stroke width. More...
 
double symbolHeight () const
 
const QgsMapUnitScalesymbolHeightMapUnitScale () const
 
QgsUnitTypes::RenderUnit symbolHeightUnit () const
 Returns the units for the symbol's height. More...
 
Q_DECL_DEPRECATED QString symbolName () const
 Returns the shape name for the rendered ellipse marker symbol. More...
 
double symbolWidth () const
 
const QgsMapUnitScalesymbolWidthMapUnitScale () const
 
QgsUnitTypes::RenderUnit symbolWidthUnit () const
 Returns the units for the symbol's width. More...
 
void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override
 Saves the symbol layer as SLD. More...
 
bool usesMapUnits () const override
 Returns true if the symbol layer has any components which use map unit based sizes. More...
 
bool writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const override
 write as DXF More...
 
void writeSldMarker (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override
 Writes the symbol layer definition as a SLD XML element. More...
 
- Public Member Functions inherited from QgsMarkerSymbolLayer
 QgsMarkerSymbolLayer (const QgsMarkerSymbolLayer &other)=delete
 QgsMarkerSymbolLayer cannot be copied. More...
 
double angle () const
 Returns the rotation angle for the marker, in degrees clockwise from north. More...
 
virtual QRectF bounds (QPointF point, QgsSymbolRenderContext &context)=0
 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. More...
 
void drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override
 
HorizontalAnchorPoint horizontalAnchorPoint () const
 Returns the horizontal anchor point for positioning the symbol. More...
 
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. More...
 
const QgsMapUnitScaleoffsetMapUnitScale () const
 Returns the map unit scale for the symbol's offset. More...
 
QgsUnitTypes::RenderUnit offsetUnit () const
 Returns the units for the symbol's offset. More...
 
QgsMarkerSymbolLayeroperator= (const QgsMarkerSymbolLayer &other)=delete
 QgsMarkerSymbolLayer cannot be copied. More...
 
QgsUnitTypes::RenderUnit outputUnit () const override
 Returns the units to use for sizes and widths within the symbol layer. More...
 
virtual void renderPoint (QPointF point, QgsSymbolRenderContext &context)=0
 Renders a marker at the specified point. More...
 
Qgis::ScaleMethod scaleMethod () const
 Returns the method to use for scaling the marker's size. More...
 
void setAngle (double angle)
 Sets the rotation angle for the marker. More...
 
void setHorizontalAnchorPoint (HorizontalAnchorPoint h)
 Sets the horizontal anchor point for positioning the symbol. More...
 
void setLineAngle (double lineAngle)
 Sets the line angle modification for the symbol's angle. More...
 
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. More...
 
void setOffsetMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for the symbol's offset. More...
 
void setOffsetUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units for the symbol's offset. More...
 
void setOutputUnit (QgsUnitTypes::RenderUnit unit) override
 Sets the units to use for sizes and widths within the symbol layer. More...
 
void setScaleMethod (Qgis::ScaleMethod scaleMethod)
 Sets the method to use for scaling the marker's size. More...
 
virtual void setSize (double size)
 Sets the symbol size. More...
 
void setSizeMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for the symbol's size. More...
 
void setSizeUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units for the symbol's size. More...
 
void setVerticalAnchorPoint (VerticalAnchorPoint v)
 Sets the vertical anchor point for positioning the symbol. More...
 
double size () const
 Returns the symbol size. More...
 
const QgsMapUnitScalesizeMapUnitScale () const
 Returns the map unit scale for the symbol's size. More...
 
QgsUnitTypes::RenderUnit sizeUnit () const
 Returns the units for the symbol's size. 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...
 
void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override
 Saves the symbol layer as SLD. More...
 
VerticalAnchorPoint verticalAnchorPoint () const
 Returns the vertical anchor point for positioning the symbol. More...
 
virtual void writeSldMarker (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const
 Writes the symbol layer definition as a SLD XML element. More...
 
- Public Member Functions inherited from QgsSymbolLayer
 QgsSymbolLayer (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied. More...
 
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. More...
 
virtual QgsSymbolLayerclone () const =0
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
virtual QColor color () const
 Returns the "representative" color of the symbol layer. More...
 
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 void drawPreviewIcon (QgsSymbolRenderContext &context, QSize size)=0
 
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 QColor dxfColor (QgsSymbolRenderContext &context) const
 Gets color. 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...
 
virtual Qt::PenStyle dxfPenStyle () const
 Gets pen style. More...
 
virtual double dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets line width. More...
 
bool enabled () const
 Returns true if symbol layer is enabled and will be drawn. More...
 
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. More...
 
virtual QColor fillColor () const
 Returns the fill color for the symbol layer. More...
 
virtual Qgis::SymbolLayerFlags flags () const
 Returns flags which control the symbol layer's behavior. More...
 
virtual bool hasDataDefinedProperties () const
 Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. More...
 
virtual bool isCompatibleWithSymbol (QgsSymbol *symbol) const
 Returns if the layer can be used below the specified symbol. More...
 
bool isLocked () const
 Returns true if the symbol layer colors are locked and the layer will ignore any symbol-level color changes. More...
 
virtual QString layerType () const =0
 Returns a string that represents this layer type. More...
 
virtual QgsMapUnitScale mapUnitScale () const
 
virtual QList< QgsSymbolLayerReferencemasks () 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...
 
virtual QgsUnitTypes::RenderUnit outputUnit () const
 Returns the units to use for sizes and widths within the symbol layer. More...
 
QgsPaintEffectpaintEffect () const
 Returns the current paint effect for the layer. More...
 
virtual void prepareExpressions (const QgsSymbolRenderContext &context)
 Prepares all data defined property expressions for evaluation. More...
 
virtual 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. More...
 
virtual QVariantMap properties () const =0
 Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. More...
 
int renderingPass () const
 Specifies the rendering pass in which this symbol layer should be rendered. More...
 
virtual void setColor (const QColor &color)
 Sets the "representative" color for the symbol layer. 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)
 Sets the fill color for the symbol layer. More...
 
void setLocked (bool locked)
 Sets whether the layer's colors are locked. More...
 
virtual void setMapUnitScale (const QgsMapUnitScale &scale)
 
virtual void setOutputUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units to use for sizes and widths within the symbol layer. More...
 
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)
 Sets the stroke color for the symbol layer. More...
 
virtual bool setSubSymbol (QgsSymbol *symbol)
 Sets layer's subsymbol. takes ownership of the passed symbol. More...
 
virtual void startFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
 Called before the layer will be rendered for a particular feature. More...
 
virtual void startRender (QgsSymbolRenderContext &context)=0
 Called before a set of rendering operations commences on the supplied render context. More...
 
virtual void stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
 Called after the layer has been rendered for a particular feature. More...
 
virtual void stopRender (QgsSymbolRenderContext &context)=0
 Called after a set of rendering operations has finished on the supplied render context. More...
 
virtual QColor strokeColor () const
 Returns the stroke color for the symbol layer. More...
 
virtual QgsSymbolsubSymbol ()
 Returns the symbol's sub symbol, if present. More...
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const
 Saves the symbol layer as SLD. More...
 
Qgis::SymbolType type () const
 
virtual QSet< QString > usedAttributes (const QgsRenderContext &context) const
 Returns the set of attributes referenced by the layer. More...
 
virtual bool usesMapUnits () const
 Returns true if the symbol layer has any components which use map unit based sizes. More...
 
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 QList< QgsEllipseSymbolLayer::ShapeavailableShapes ()
 Returns a list of all available shape types. More...
 
static QgsSymbolLayercreate (const QVariantMap &properties=QVariantMap())
 Creates the symbol layer. More...
 
static QgsSymbolLayercreateFromSld (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. More...
 
static QString encodeShape (QgsEllipseSymbolLayer::Shape shape)
 Encodes a shape to its string representation. More...
 
static bool shapeIsFilled (const QgsEllipseSymbolLayer::Shape &shape)
 Returns true if a shape has a fill. More...
 
- Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the symbol layer property definitions. More...
 

Additional Inherited Members

- Protected Member Functions inherited from QgsMarkerSymbolLayer
 QgsMarkerSymbolLayer (bool locked=false)
 Constructor for QgsMarkerSymbolLayer. More...
 
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. More...
 
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. More...
 
void markerOffset (QgsSymbolRenderContext &context, double width, double height, QgsUnitTypes::RenderUnit widthUnit, QgsUnitTypes::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. More...
 
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 QVariantMap &stringMap)
 Restores older data defined properties from string map. More...
 
- Static Protected Member Functions inherited from QgsMarkerSymbolLayer
static QPointF _rotatedOffset (QPointF offset, double angle)
 Adjusts a marker offset to account for rotation. More...
 
- Protected Attributes inherited from QgsMarkerSymbolLayer
double mAngle = 0
 Marker rotation angle, in degrees clockwise from north. More...
 
HorizontalAnchorPoint mHorizontalAnchorPoint = HCenter
 Horizontal anchor point. More...
 
double mLineAngle = 0
 Line rotation angle (see setLineAngle() for details) More...
 
QPointF mOffset
 Marker offset. More...
 
QgsMapUnitScale mOffsetMapUnitScale
 Offset map unit scale. More...
 
QgsUnitTypes::RenderUnit mOffsetUnit = QgsUnitTypes::RenderMillimeters
 Offset units. More...
 
Qgis::ScaleMethod mScaleMethod = Qgis::ScaleMethod::ScaleDiameter
 Marker size scaling method. More...
 
double mSize = 2.0
 Marker size. More...
 
QgsMapUnitScale mSizeMapUnitScale
 Marker size map unit scale. More...
 
QgsUnitTypes::RenderUnit mSizeUnit = QgsUnitTypes::RenderMillimeters
 Marker size unit. More...
 
VerticalAnchorPoint mVerticalAnchorPoint = VCenter
 Vertical anchor point. More...
 
- Protected Attributes inherited from QgsSymbolLayer
QPainterPath mClipPath
 
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
 
Qgis::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 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

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 1172 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
Since
QGIS 2.14

Implements QgsMarkerSymbolLayer.

Definition at line 838 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 381 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 482 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
nameencoded shape name
okif specified, will be set to true if shape was successfully decoded
Returns
decoded name
See also
encodeShape()
Since
QGIS 3.20

Definition at line 1090 of file qgsellipsesymbollayer.cpp.

◆ encodeShape()

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

Encodes a shape to its string representation.

Parameters
shapeshape to encode
Returns
encoded string
See also
decodeShape()
Since
QGIS 3.20

Definition at line 1132 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()
Since
QGIS 2.1

Reimplemented from QgsSymbolLayer.

Definition at line 183 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 345 of file qgsellipsesymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsEllipseSymbolLayer::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 827 of file qgsellipsesymbollayer.cpp.

◆ outputUnit()

QgsUnitTypes::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 801 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 167 of file qgsellipsesymbollayer.h.

◆ penJoinStyle()

Qt::PenJoinStyle QgsEllipseSymbolLayer::penJoinStyle ( ) const
inline

Gets stroke join style.

Since
QGIS 2.16

Definition at line 151 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 540 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
pointposition at which to render point, in painter units
contextsymbol 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()
Since
QGIS 2.1

Reimplemented from QgsSymbolLayer.

Definition at line 182 of file qgsellipsesymbollayer.h.

◆ setMapUnitScale()

void QgsEllipseSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 819 of file qgsellipsesymbollayer.cpp.

◆ setOutputUnit()

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

Definition at line 793 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 177 of file qgsellipsesymbollayer.h.

◆ setPenJoinStyle()

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

Set stroke join style.

Since
QGIS 2.16

Definition at line 157 of file qgsellipsesymbollayer.h.

◆ setShape()

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

Sets the rendered ellipse marker shape.

Parameters
shapenew 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
sizesymbol size. Units are specified by sizeUnit().
See also
size()
setSizeUnit()
setSizeMapUnitScale()

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 766 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()
Since
QGIS 2.1

Reimplemented from QgsSymbolLayer.

Definition at line 185 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 179 of file qgsellipsesymbollayer.h.

◆ setStrokeWidthMapUnitScale()

void QgsEllipseSymbolLayer::setStrokeWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 237 of file qgsellipsesymbollayer.h.

◆ setStrokeWidthUnit()

void QgsEllipseSymbolLayer::setStrokeWidthUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the units for the symbol's stroke width.

Parameters
unitsymbol units
See also
strokeWidthUnit()

Definition at line 229 of file qgsellipsesymbollayer.h.

◆ setSymbolHeight()

void QgsEllipseSymbolLayer::setSymbolHeight ( double  h)

Definition at line 787 of file qgsellipsesymbollayer.cpp.

◆ setSymbolHeightMapUnitScale()

void QgsEllipseSymbolLayer::setSymbolHeightMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 221 of file qgsellipsesymbollayer.h.

◆ setSymbolHeightUnit()

void QgsEllipseSymbolLayer::setSymbolHeightUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the units for the symbol's height.

Parameters
unitsymbol units
See also
symbolHeightUnit()
setSymbolWidthUnit()

Definition at line 212 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 781 of file qgsellipsesymbollayer.cpp.

◆ setSymbolWidthMapUnitScale()

void QgsEllipseSymbolLayer::setSymbolWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 203 of file qgsellipsesymbollayer.h.

◆ setSymbolWidthUnit()

void QgsEllipseSymbolLayer::setSymbolWidthUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the units for the symbol's width.

Parameters
unitsymbol units
See also
symbolWidthUnit()
setSymbolHeightUnit()

Definition at line 194 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 738 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 350 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 377 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()
Since
QGIS 2.1

Reimplemented from QgsSymbolLayer.

Definition at line 186 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 180 of file qgsellipsesymbollayer.h.

◆ strokeWidthMapUnitScale()

const QgsMapUnitScale & QgsEllipseSymbolLayer::strokeWidthMapUnitScale ( ) const
inline

Definition at line 238 of file qgsellipsesymbollayer.h.

◆ strokeWidthUnit()

QgsUnitTypes::RenderUnit QgsEllipseSymbolLayer::strokeWidthUnit ( ) const
inline

Returns the units for the symbol's stroke width.

See also
setStrokeWidthUnit()

Definition at line 235 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 222 of file qgsellipsesymbollayer.h.

◆ symbolHeightUnit()

QgsUnitTypes::RenderUnit QgsEllipseSymbolLayer::symbolHeightUnit ( ) const
inline

Returns the units for the symbol's height.

See also
setSymbolHeightUnit()
symbolWidthUnit()

Definition at line 219 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 204 of file qgsellipsesymbollayer.h.

◆ symbolWidthUnit()

QgsUnitTypes::RenderUnit QgsEllipseSymbolLayer::symbolWidthUnit ( ) const
inline

Returns the units for the symbol's width.

See also
setSymbolWidthUnit()
symbolHeightUnit()

Definition at line 201 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 412 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 811 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 900 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
docXML document
elementparent XML element
propssymbol layer definition (see properties())

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 425 of file qgsellipsesymbollayer.cpp.


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