QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
QgsFontMarkerSymbolLayer Class Reference

#include <qgsmarkersymbollayer.h>

Inheritance diagram for QgsFontMarkerSymbolLayer:
Inheritance graph
[legend]

Public Member Functions

 QgsFontMarkerSymbolLayer (const QString &fontFamily=DEFAULT_FONTMARKER_FONT, QString chr=DEFAULT_FONTMARKER_CHR, double pointSize=DEFAULT_FONTMARKER_SIZE, const QColor &color=DEFAULT_FONTMARKER_COLOR, double angle=DEFAULT_FONTMARKER_ANGLE)
 Constructs a font marker symbol layer.
 
 ~QgsFontMarkerSymbolLayer () 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.
 
QString character () const
 Returns the character(s) used when rendering points.
 
QgsFontMarkerSymbolLayerclone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance.
 
Qgis::SymbolLayerFlags flags () const override
 Returns flags which control the symbol layer's behavior.
 
QString fontFamily () const
 Returns the font family name for the associated font which will be used to render the point.
 
QString fontStyle () const
 Returns the font style for the associated font which will be used to render the point.
 
QString layerType () const override
 Returns a string that represents this layer type.
 
Qt::PenJoinStyle penJoinStyle () const
 Returns the 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 setCharacter (QString chr)
 Sets the character(s) used when rendering points.
 
void setFontFamily (const QString &family)
 Sets the font family for the font which will be used to render the point.
 
void setFontStyle (const QString &style)
 Sets the font style for the font which will be used to render the point.
 
void setOutputUnit (Qgis::RenderUnit unit) override
 Sets the units to use for sizes and widths within the symbol layer.
 
void setPenJoinStyle (Qt::PenJoinStyle style)
 Sets the stroke join style.
 
void setStrokeColor (const QColor &color) override
 Sets the stroke color for the symbol layer.
 
void setStrokeWidth (double width)
 Set's the marker's stroke width.
 
void setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale)
 Sets the stroke width map unit scale.
 
void setStrokeWidthUnit (Qgis::RenderUnit unit)
 Sets the stroke width unit.
 
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.
 
double strokeWidth () const
 Returns the marker's stroke width.
 
const QgsMapUnitScalestrokeWidthMapUnitScale () const
 Returns the stroke width map unit scale.
 
Qgis::RenderUnit strokeWidthUnit () const
 Returns the stroke width unit.
 
bool usesMapUnits () const override
 Returns true if the symbol layer has any components which use map unit based sizes.
 
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
 
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 QgsMapUnitScaleoffsetMapUnitScale () const
 Returns the map unit scale for the symbol's offset.
 
Qgis::RenderUnit offsetUnit () const
 Returns the units for the symbol's offset.
 
QgsMarkerSymbolLayeroperator= (const QgsMarkerSymbolLayer &other)=delete
 
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.
 
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 QgsMapUnitScalesizeMapUnitScale () 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
 
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.
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the symbol layer's property collection, used for data defined overrides.
 
const QgsPropertyCollectiondataDefinedProperties () 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 QColor fillColor () const
 Returns the fill color for the symbol layer.
 
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.
 
bool installMasks (QgsRenderContext &context, bool recursive, const QRectF &rect=QRectF())
 When rendering, install masks on context painter.
 
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< QgsSymbolLayerReferencemasks () const
 Returns masks defined by this symbol layer.
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
QgsSymbolLayeroperator= (const QgsSymbolLayer &other)=delete
 
QgsPaintEffectpaintEffect () 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.
 
virtual void setFillColor (const QColor &color)
 Sets the fill color for the symbol layer.
 
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 QgsSymbolsubSymbol ()
 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.
 
virtual bool writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const
 write as DXF
 

Static Public Member Functions

static QgsSymbolLayercreate (const QVariantMap &properties=QVariantMap())
 Creates a new QgsFontMarkerSymbolLayer from a property map (see properties())
 
static QgsSymbolLayercreateFromSld (QDomElement &element)
 Creates a new QgsFontMarkerSymbolLayer from an SLD XML element.
 
static void resolveFonts (const QVariantMap &properties, const QgsReadWriteContext &context)
 Resolves fonts from a properties map, raising warnings in the specified context if the required fonts are not available on the system.
 
- Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the symbol layer property definitions.
 

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 , SkipMultiples , ShowMarker
}
 Data definable properties. More...
 
- 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 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< QgsPaintEffectmPaintEffect
 
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

Definition at line 852 of file qgsmarkersymbollayer.h.

Constructor & Destructor Documentation

◆ QgsFontMarkerSymbolLayer()

QgsFontMarkerSymbolLayer::QgsFontMarkerSymbolLayer ( const QString &  fontFamily = DEFAULT_FONTMARKER_FONT,
QString  chr = DEFAULT_FONTMARKER_CHR,
double  pointSize = DEFAULT_FONTMARKER_SIZE,
const QColor &  color = DEFAULT_FONTMARKER_COLOR,
double  angle = DEFAULT_FONTMARKER_ANGLE 
)

Constructs a font marker symbol layer.

Definition at line 3451 of file qgsmarkersymbollayer.cpp.

◆ ~QgsFontMarkerSymbolLayer()

QgsFontMarkerSymbolLayer::~QgsFontMarkerSymbolLayer ( )
overridedefault

Member Function Documentation

◆ bounds()

QRectF QgsFontMarkerSymbolLayer::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 3912 of file qgsmarkersymbollayer.cpp.

◆ character()

QString QgsFontMarkerSymbolLayer::character ( ) const
inline

Returns the character(s) used when rendering points.

See also
setCharacter()

Definition at line 941 of file qgsmarkersymbollayer.h.

◆ clone()

QgsFontMarkerSymbolLayer * QgsFontMarkerSymbolLayer::clone ( ) const
overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 3848 of file qgsmarkersymbollayer.cpp.

◆ create()

QgsSymbolLayer * QgsFontMarkerSymbolLayer::create ( const QVariantMap &  properties = QVariantMap())
static

Creates a new QgsFontMarkerSymbolLayer from a property map (see properties())

Definition at line 3470 of file qgsmarkersymbollayer.cpp.

◆ createFromSld()

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

Creates a new QgsFontMarkerSymbolLayer from an SLD XML element.

Definition at line 3950 of file qgsmarkersymbollayer.cpp.

◆ flags()

Qgis::SymbolLayerFlags QgsFontMarkerSymbolLayer::flags ( ) const
overridevirtual

Returns flags which control the symbol layer's behavior.

Since
QGIS 3.22

Reimplemented from QgsSymbolLayer.

Definition at line 3539 of file qgsmarkersymbollayer.cpp.

◆ fontFamily()

QString QgsFontMarkerSymbolLayer::fontFamily ( ) const
inline

Returns the font family name for the associated font which will be used to render the point.

See also
setFontFamily()

Definition at line 911 of file qgsmarkersymbollayer.h.

◆ fontStyle()

QString QgsFontMarkerSymbolLayer::fontStyle ( ) const
inline

Returns the font style for the associated font which will be used to render the point.

See also
setFontStyle()
Since
QGIS 3.14

Definition at line 926 of file qgsmarkersymbollayer.h.

◆ layerType()

QString QgsFontMarkerSymbolLayer::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 3534 of file qgsmarkersymbollayer.cpp.

◆ penJoinStyle()

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

Returns the stroke join style.

See also
setPenJoinStyle()

Definition at line 1018 of file qgsmarkersymbollayer.h.

◆ properties()

QVariantMap QgsFontMarkerSymbolLayer::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 3815 of file qgsmarkersymbollayer.cpp.

◆ renderPoint()

void QgsFontMarkerSymbolLayer::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 3695 of file qgsmarkersymbollayer.cpp.

◆ resolveFonts()

void QgsFontMarkerSymbolLayer::resolveFonts ( const QVariantMap &  properties,
const QgsReadWriteContext context 
)
static

Resolves fonts from a properties map, raising warnings in the specified context if the required fonts are not available on the system.

Since
QGIS 3.20

Definition at line 3998 of file qgsmarkersymbollayer.cpp.

◆ setCharacter()

void QgsFontMarkerSymbolLayer::setCharacter ( QString  chr)
inline

Sets the character(s) used when rendering points.

See also
character()

Definition at line 948 of file qgsmarkersymbollayer.h.

◆ setFontFamily()

void QgsFontMarkerSymbolLayer::setFontFamily ( const QString &  family)
inline

Sets the font family for the font which will be used to render the point.

See also
fontFamily()

Definition at line 918 of file qgsmarkersymbollayer.h.

◆ setFontStyle()

void QgsFontMarkerSymbolLayer::setFontStyle ( const QString &  style)
inline

Sets the font style for the font which will be used to render the point.

See also
fontStyle()
Since
QGIS 3.14

Definition at line 934 of file qgsmarkersymbollayer.h.

◆ setOutputUnit()

void QgsFontMarkerSymbolLayer::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
unitoutput units
See also
outputUnit()

Reimplemented from QgsSymbolLayer.

Definition at line 3906 of file qgsmarkersymbollayer.cpp.

◆ setPenJoinStyle()

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

Sets the stroke join style.

See also
penJoinStyle()

Definition at line 1026 of file qgsmarkersymbollayer.h.

◆ setStrokeColor()

void QgsFontMarkerSymbolLayer::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 951 of file qgsmarkersymbollayer.h.

◆ setStrokeWidth()

void QgsFontMarkerSymbolLayer::setStrokeWidth ( double  width)
inline

Set's the marker's stroke width.

Units are set by setStrokeWidthUnit().

See also
strokeWidth()
setStrokeWidthUnit()
setStrokeWidthMapUnitScale()

Definition at line 971 of file qgsmarkersymbollayer.h.

◆ setStrokeWidthMapUnitScale()

void QgsFontMarkerSymbolLayer::setStrokeWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Sets the stroke width map unit scale.

See also
strokeWidthMapUnitScale()
setStrokeWidth()
setStrokeWidthUnit()

Definition at line 1010 of file qgsmarkersymbollayer.h.

◆ setStrokeWidthUnit()

void QgsFontMarkerSymbolLayer::setStrokeWidthUnit ( Qgis::RenderUnit  unit)
inline

Sets the stroke width unit.

See also
strokeWidthUnit()
setStrokeWidth()
setStrokeWidthMapUnitScale()

Definition at line 990 of file qgsmarkersymbollayer.h.

◆ startRender()

void QgsFontMarkerSymbolLayer::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 3544 of file qgsmarkersymbollayer.cpp.

◆ stopRender()

void QgsFontMarkerSymbolLayer::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 3599 of file qgsmarkersymbollayer.cpp.

◆ strokeColor()

QColor QgsFontMarkerSymbolLayer::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 950 of file qgsmarkersymbollayer.h.

◆ strokeWidth()

double QgsFontMarkerSymbolLayer::strokeWidth ( ) const
inline

Returns the marker's stroke width.

Units are retrieved by strokeWidthUnit()

See also
setStrokeWidth()
strokeWidthUnit()
strokeWidthMapUnitScale()

Definition at line 961 of file qgsmarkersymbollayer.h.

◆ strokeWidthMapUnitScale()

const QgsMapUnitScale & QgsFontMarkerSymbolLayer::strokeWidthMapUnitScale ( ) const
inline

Returns the stroke width map unit scale.

See also
setStrokeWidthMapUnitScale()
strokeWidth()
strokeWidthUnit()

Definition at line 1000 of file qgsmarkersymbollayer.h.

◆ strokeWidthUnit()

Qgis::RenderUnit QgsFontMarkerSymbolLayer::strokeWidthUnit ( ) const
inline

Returns the stroke width unit.

See also
setStrokeWidthUnit()
strokeWidth()
strokeWidthMapUnitScale()

Definition at line 981 of file qgsmarkersymbollayer.h.

◆ usesMapUnits()

bool QgsFontMarkerSymbolLayer::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 3899 of file qgsmarkersymbollayer.cpp.

◆ writeSldMarker()

void QgsFontMarkerSymbolLayer::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 3869 of file qgsmarkersymbollayer.cpp.


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