api/qgsmarkersymbollayer_8h_source.html

/***************************************************************************

 qgsmarkersymbollayer.h

 ---------------------

 begin                : November 2009

 copyright            : (C) 2009 by Martin Dobias

 email                : wonder dot sk at gmail dot com

 ***************************************************************************

 *                                                                         *

 *   This program is free software; you can redistribute it and/or modify  *

 *   it under the terms of the GNU General Public License as published by  *

 *   the Free Software Foundation; either version 2 of the License, or     *

 *   (at your option) any later version.                                   *

 *                                                                         *

 ***************************************************************************/


#ifndef QGSMARKERSYMBOLLAYER_H

#define QGSMARKERSYMBOLLAYER_H


#include "qgis_core.h"

#include "qgis_sip.h"

#include "qgssymbollayer.h"


#define DEFAULT_SIMPLEMARKER_NAME         "circle"

#define DEFAULT_SIMPLEMARKER_COLOR        QColor(255,0,0)

#define DEFAULT_SIMPLEMARKER_BORDERCOLOR  QColor( 35, 35, 35 )

#define DEFAULT_SIMPLEMARKER_JOINSTYLE    Qt::BevelJoin

#define DEFAULT_SIMPLEMARKER_SIZE         Qgis::DEFAULT_POINT_SIZE

#define DEFAULT_SIMPLEMARKER_ANGLE        0


#include <QPen>

#include <QBrush>

#include <QPicture>

#include <QPolygonF>

#include <QFont>


class QgsFillSymbol;

class QgsPathResolver;


class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer

{


  public:


    static QList< Qgis::MarkerShape > availableShapes();


    static bool shapeIsFilled( Qgis::MarkerShape shape );


    QgsSimpleMarkerSymbolLayerBase( Qgis::MarkerShape shape = Qgis::MarkerShape::Circle,

                                    double size = DEFAULT_SIMPLEMARKER_SIZE,

                                    double angle = DEFAULT_SIMPLEMARKER_ANGLE,

                                    Qgis::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD );


    ~QgsSimpleMarkerSymbolLayerBase() override;


    Qgis::MarkerShape shape() const { return mShape; }


    void setShape( Qgis::MarkerShape shape ) { mShape = shape; }


    static Qgis::MarkerShape decodeShape( const QString &name, bool *ok = nullptr );


    static QString encodeShape( Qgis::MarkerShape shape );


    void startRender( QgsSymbolRenderContext &context ) override;

    void stopRender( QgsSymbolRenderContext &context ) override;

    void renderPoint( QPointF point, QgsSymbolRenderContext &context ) override;

    QRectF bounds( QPointF point, QgsSymbolRenderContext &context ) override;


  protected:


    bool prepareMarkerShape( Qgis::MarkerShape shape );


    bool prepareMarkerPath( Qgis::MarkerShape symbol );


    bool shapeToPolygon( Qgis::MarkerShape shape, QPolygonF &polygon ) const;


    double calculateSize( QgsSymbolRenderContext &context, bool &hasDataDefinedSize ) const;


    void calculateOffsetAndRotation( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedRotation, QPointF &offset, double &angle ) const;


    QPolygonF mPolygon;


    QPainterPath mPath;


    Qgis::MarkerShape mShape;


  private:


    virtual void draw( QgsSymbolRenderContext &context, Qgis::MarkerShape shape, const QPolygonF &polygon, const QPainterPath &path ) = 0 SIP_FORCE;

};


class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayerBase

{

  public:


    QgsSimpleMarkerSymbolLayer( Qgis::MarkerShape shape = Qgis::MarkerShape::Circle,

                                double size = DEFAULT_SIMPLEMARKER_SIZE,

                                double angle = DEFAULT_SIMPLEMARKER_ANGLE,

                                Qgis::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD,

                                const QColor &color = DEFAULT_SIMPLEMARKER_COLOR,

                                const QColor &strokeColor = DEFAULT_SIMPLEMARKER_BORDERCOLOR,

                                Qt::PenJoinStyle penJoinStyle = DEFAULT_SIMPLEMARKER_JOINSTYLE );


    ~QgsSimpleMarkerSymbolLayer() override;


    // static methods


    static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) SIP_FACTORY;


    static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;


    // reimplemented from base classes


    QString layerType() const override;

    Qgis::SymbolLayerFlags flags() const override;

    void startRender( QgsSymbolRenderContext &context ) override;

    void renderPoint( QPointF point, QgsSymbolRenderContext &context ) override;

    QVariantMap properties() const override;

    QgsSimpleMarkerSymbolLayer *clone() const override SIP_FACTORY;

    Q_DECL_DEPRECATED void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const override SIP_DEPRECATED;

    bool toSld( QDomDocument &doc, QDomElement &element, QgsSldExportContext &context ) const override;


    Q_DECL_DEPRECATED void writeSldMarker( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const override SIP_DEPRECATED;

    bool writeSldMarker( QDomDocument &doc, QDomElement &element, QgsSldExportContext &context ) const override;

    QString ogrFeatureStyle( double mmScaleFactor, double mapUnitScaleFactor ) const override;

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

    void setOutputUnit( Qgis::RenderUnit unit ) override;

    Qgis::RenderUnit outputUnit() const override;

    void setMapUnitScale( const QgsMapUnitScale &scale ) override;

    QgsMapUnitScale mapUnitScale() const override;

    bool usesMapUnits() const override;

    QRectF bounds( QPointF point, QgsSymbolRenderContext &context ) override;

    QColor fillColor() const override { return mColor; }

    void setFillColor( const QColor &color ) override { mColor = color; }

    void setColor( const QColor &color ) override;

    QColor color() const override;


    // new methods


    QColor strokeColor() const override { return mStrokeColor; }


    void setStrokeColor( const QColor &color ) override { mStrokeColor = color; }


    Qt::PenStyle strokeStyle() const { return mStrokeStyle; }


    void setStrokeStyle( Qt::PenStyle strokeStyle ) { mStrokeStyle = strokeStyle; }


    Qt::PenJoinStyle penJoinStyle() const { return mPenJoinStyle; }


    void setPenJoinStyle( Qt::PenJoinStyle style ) { mPenJoinStyle = style; }


    Qt::PenCapStyle penCapStyle() const { return mPenCapStyle; }


    void setPenCapStyle( Qt::PenCapStyle style ) { mPenCapStyle = style; }


    double strokeWidth() const { return mStrokeWidth; }


    void setStrokeWidth( double w ) { mStrokeWidth = w; }


    void setStrokeWidthUnit( Qgis::RenderUnit u ) { mStrokeWidthUnit = u; }


    Qgis::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; }


    void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale ) { mStrokeWidthMapUnitScale = scale; }


    const QgsMapUnitScale &strokeWidthMapUnitScale() const { return mStrokeWidthMapUnitScale; }


  protected:


    void drawMarker( QPainter *p, QgsSymbolRenderContext &context );


    bool prepareCache( QgsSymbolRenderContext &context );


    QColor mStrokeColor;

    Qt::PenStyle mStrokeStyle = Qt::SolidLine;

    double mStrokeWidth = 0;

    Qgis::RenderUnit mStrokeWidthUnit = Qgis::RenderUnit::Millimeters;

    QgsMapUnitScale mStrokeWidthMapUnitScale;

    Qt::PenJoinStyle mPenJoinStyle;

    Qt::PenCapStyle mPenCapStyle = Qt::SquareCap;

    QPen mPen;

    QBrush mBrush;


    QImage mCache;

    QPen mSelPen;

    QBrush mSelBrush;

    QImage mSelCache;


    bool mUsingCache = false;


    static const int MAXIMUM_CACHE_WIDTH = 3000;


  private:

    // cppcheck-suppress unusedPrivateFunction

    void draw( QgsSymbolRenderContext &context, Qgis::MarkerShape shape, const QPolygonF &polygon, const QPainterPath &path ) override SIP_FORCE;


    double mCachedOpacity = 1.0;


};


class CORE_EXPORT QgsFilledMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayerBase

{

  public:


    QgsFilledMarkerSymbolLayer( Qgis::MarkerShape shape = Qgis::MarkerShape::Circle,

                                double size = DEFAULT_SIMPLEMARKER_SIZE,

                                double angle = DEFAULT_SIMPLEMARKER_ANGLE,

                                Qgis::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD );


    ~QgsFilledMarkerSymbolLayer() override;


    static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) SIP_FACTORY;


    QString layerType() const override;

    void startRender( QgsSymbolRenderContext &context ) override;

    void stopRender( QgsSymbolRenderContext &context ) override;

    void startFeatureRender( const QgsFeature &feature, QgsRenderContext &context ) override;

    void stopFeatureRender( const QgsFeature &feature, QgsRenderContext &context ) override;

    QVariantMap properties() const override;

    QgsFilledMarkerSymbolLayer *clone() const override SIP_FACTORY;

    QgsSymbol *subSymbol() override;

    bool setSubSymbol( QgsSymbol *symbol SIP_TRANSFER ) override;

    double estimateMaxBleed( const QgsRenderContext &context ) const override;

    QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;

    bool hasDataDefinedProperties() const override;

    void setColor( const QColor &c ) override;

    QColor color() const override;

    bool usesMapUnits() const override;

    void setOutputUnit( Qgis::RenderUnit unit ) override;


  private:

#ifdef SIP_RUN

    QgsFilledMarkerSymbolLayer( const QgsFilledMarkerSymbolLayer & );

#endif


    // cppcheck-suppress unusedPrivateFunction

    void draw( QgsSymbolRenderContext &context, Qgis::MarkerShape shape, const QPolygonF &polygon, const QPainterPath &path ) override SIP_FORCE;


    std::unique_ptr< QgsFillSymbol > mFill;

};


#define DEFAULT_SVGMARKER_SIZE         ( 2 * Qgis::DEFAULT_POINT_SIZE )

#define DEFAULT_SVGMARKER_ANGLE        0


class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer

{

  public:

    QgsSvgMarkerSymbolLayer( const QString &path,

                             double size = DEFAULT_SVGMARKER_SIZE,

                             double angle = DEFAULT_SVGMARKER_ANGLE,

                             Qgis::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD );

    QgsSvgMarkerSymbolLayer( const QgsSvgMarkerSymbolLayer &other ) SIP_SKIP;


    ~QgsSvgMarkerSymbolLayer() override;


    // static stuff


    static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) SIP_FACTORY;

    static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;


    static void resolvePaths( QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving );


    // implemented from base classes


    QString layerType() const override;

    Qgis::SymbolLayerFlags flags() const override;

    void startRender( QgsSymbolRenderContext &context ) override;

    void stopRender( QgsSymbolRenderContext &context ) override;

    void renderPoint( QPointF point, QgsSymbolRenderContext &context ) override;

    QVariantMap properties() const override;

    bool usesMapUnits() const override;

    QgsSvgMarkerSymbolLayer *clone() const override SIP_FACTORY;

    Q_DECL_DEPRECATED void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const override SIP_DEPRECATED;

    bool toSld( QDomDocument &doc, QDomElement &element, QgsSldExportContext &context ) const override;

    Q_DECL_DEPRECATED void writeSldMarker( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const override SIP_DEPRECATED;

    bool writeSldMarker( QDomDocument &doc, QDomElement &element, QgsSldExportContext &context ) const override;


    QString path() const { return mPath; }


    void setPath( const QString &path );


    double defaultAspectRatio() const { return mDefaultAspectRatio; }


    double updateDefaultAspectRatio();


    bool preservedAspectRatio() const { return mFixedAspectRatio <= 0.0; }


    bool setPreservedAspectRatio( bool par );


    double fixedAspectRatio() const { return mFixedAspectRatio; }


    void setFixedAspectRatio( double ratio ) { mFixedAspectRatio = ratio; }


    QColor fillColor() const override { return color(); }

    void setFillColor( const QColor &color ) override { setColor( color ); }


    QColor strokeColor() const override { return mStrokeColor; }

    void setStrokeColor( const QColor &c ) override { mStrokeColor = c; }


    double strokeWidth() const { return mStrokeWidth; }

    void setStrokeWidth( double w ) { mStrokeWidth = w; }


    QMap<QString, QgsProperty> parameters() const { return mParameters; }


    void setParameters( const QMap<QString, QgsProperty> &parameters );


    void setStrokeWidthUnit( Qgis::RenderUnit unit ) { mStrokeWidthUnit = unit; }


    Qgis::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; }


    void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale ) { mStrokeWidthMapUnitScale = scale; }

    const QgsMapUnitScale &strokeWidthMapUnitScale() const { return mStrokeWidthMapUnitScale; }


    void setOutputUnit( Qgis::RenderUnit unit ) override;

    Qgis::RenderUnit outputUnit() const override;


    void setMapUnitScale( const QgsMapUnitScale &scale ) override;

    QgsMapUnitScale mapUnitScale() const override;


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


    QRectF bounds( QPointF point, QgsSymbolRenderContext &context ) override;


    void prepareExpressions( const QgsSymbolRenderContext &context ) override;


    QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;


  protected:


    double calculateAspectRatio( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedAspectRatio ) const;


    QString mPath;


    double mDefaultAspectRatio = 0.0;

    double mFixedAspectRatio = 0.0;

    //param(fill), param(stroke), param(stroke-width) are going

    //to be replaced in memory

    bool mHasFillParam = false;

    QColor mStrokeColor;

    double mStrokeWidth;

    QMap<QString, QgsProperty> mParameters;


    Qgis::RenderUnit mStrokeWidthUnit;

    QgsMapUnitScale mStrokeWidthMapUnitScale;


  private:

    double calculateSize( QgsSymbolRenderContext &context, bool &hasDataDefinedSize ) const;

    void calculateOffsetAndRotation( QgsSymbolRenderContext &context, double scaledWidth, double scaledHeight, QPointF &offset, double &angle ) const;


};


#define DEFAULT_RASTERMARKER_SIZE         ( 2 * Qgis::DEFAULT_POINT_SIZE )

#define DEFAULT_RASTERMARKER_ANGLE        0


class CORE_EXPORT QgsRasterMarkerSymbolLayer : public QgsMarkerSymbolLayer

{

  public:

    QgsRasterMarkerSymbolLayer( const QString &path = QString(),

                                double size = DEFAULT_SVGMARKER_SIZE,

                                double angle = DEFAULT_SVGMARKER_ANGLE,

                                Qgis::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD );


    ~QgsRasterMarkerSymbolLayer() override;


    // static stuff


    static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) SIP_FACTORY;


    static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;


    static void resolvePaths( QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving );


    // implemented from base classes


    QString layerType() const override;

    Qgis::SymbolLayerFlags flags() const override;

    void renderPoint( QPointF point, QgsSymbolRenderContext &context ) override;

    QVariantMap properties() const override;

    QgsRasterMarkerSymbolLayer *clone() const override SIP_FACTORY;

    bool usesMapUnits() const override;

    QColor color() const override;

    Q_DECL_DEPRECATED void writeSldMarker( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const override SIP_DEPRECATED;

    bool writeSldMarker( QDomDocument &doc, QDomElement &element, QgsSldExportContext &context ) const override;


    double calculateAspectRatio( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedAspectRatio ) const;


    QString path() const { return mPath; }


    void setPath( const QString &path );


    double opacity() const { return mOpacity; }


    void setOpacity( double opacity ) { mOpacity = opacity; }


    double defaultAspectRatio() const { return mDefaultAspectRatio; }


    double updateDefaultAspectRatio();


    bool preservedAspectRatio() const { return mFixedAspectRatio <= 0.0; }


    bool setPreservedAspectRatio( bool par );


    double fixedAspectRatio() const { return mFixedAspectRatio; }


    void setFixedAspectRatio( double ratio ) { mFixedAspectRatio = ratio; }


    void setMapUnitScale( const QgsMapUnitScale &scale ) override;

    QgsMapUnitScale mapUnitScale() const override;


    QRectF bounds( QPointF point, QgsSymbolRenderContext &context ) override;


  protected:


    void setCommonProperties( const QVariantMap &properties );


    void copyCommonProperties( QgsRasterMarkerSymbolLayer *other ) const;


    virtual QImage fetchImage( QgsRenderContext &context, const QString &path, QSize size, bool preserveAspectRatio, double opacity ) const SIP_SKIP;


    QString mPath;

    double mOpacity = 1.0;

    double mDefaultAspectRatio = 0.0;

    double mFixedAspectRatio = 0.0;


  private:

    double calculateSize( QgsSymbolRenderContext &context, bool &hasDataDefinedSize ) const;

    void calculateOffsetAndRotation( QgsSymbolRenderContext &context, double scaledWidth, double scaledHeight, QPointF &offset, double &angle ) const;


};


#define POINT2MM(x) ( (x) * 25.4 / 72 ) // point is 1/72 of inch

#define MM2POINT(x) ( (x) * 72 / 25.4 )


#define DEFAULT_FONTMARKER_FONT   "Dingbats"

#define DEFAULT_FONTMARKER_CHR    QChar('A')

#define DEFAULT_FONTMARKER_SIZE   POINT2MM(12)

#define DEFAULT_FONTMARKER_COLOR  QColor( 35, 35, 35 )

#define DEFAULT_FONTMARKER_BORDERCOLOR  QColor(Qt::white)

#define DEFAULT_FONTMARKER_JOINSTYLE    Qt::MiterJoin

#define DEFAULT_FONTMARKER_ANGLE  0


class CORE_EXPORT QgsFontMarkerSymbolLayer : public QgsMarkerSymbolLayer

{

  public:


    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 );


    ~QgsFontMarkerSymbolLayer() override;


    // static stuff


    static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) SIP_FACTORY;


    static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;


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


    // implemented from base classes


    QString layerType() const override;

    Qgis::SymbolLayerFlags flags() const override;


    void startRender( QgsSymbolRenderContext &context ) override;


    void stopRender( QgsSymbolRenderContext &context ) override;


    void renderPoint( QPointF point, QgsSymbolRenderContext &context ) override;


    QVariantMap properties() const override;


    QgsFontMarkerSymbolLayer *clone() const override SIP_FACTORY;

    Q_DECL_DEPRECATED void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const override SIP_DEPRECATED;

    bool toSld( QDomDocument &doc, QDomElement &element, QgsSldExportContext &context ) const override;

    Q_DECL_DEPRECATED void writeSldMarker( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const override SIP_DEPRECATED;

    bool writeSldMarker( QDomDocument &doc, QDomElement &element, QgsSldExportContext &context ) const override;

    bool usesMapUnits() const override;

    void setOutputUnit( Qgis::RenderUnit unit ) override;


    // new methods


    QString fontFamily() const { return mFontFamily; }


    void setFontFamily( const QString &family ) { mFontFamily = family; }


    QString fontStyle() const { return mFontStyle; }


    void setFontStyle( const QString &style ) { mFontStyle = style; }


    QString character() const { return mString; }


    void setCharacter( QString chr ) { mString = chr; }


    QColor strokeColor() const override { return mStrokeColor; }

    void setStrokeColor( const QColor &color ) override { mStrokeColor = color; }


    double strokeWidth() const { return mStrokeWidth; }


    void setStrokeWidth( double width ) { mStrokeWidth = width; }


    Qgis::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; }


    void setStrokeWidthUnit( Qgis::RenderUnit unit ) { mStrokeWidthUnit = unit; }


    const QgsMapUnitScale &strokeWidthMapUnitScale() const { return mStrokeWidthMapUnitScale; }


    void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale ) { mStrokeWidthMapUnitScale = scale; }


    Qt::PenJoinStyle penJoinStyle() const { return mPenJoinStyle; }


    void setPenJoinStyle( Qt::PenJoinStyle style ) { mPenJoinStyle = style; }


    QRectF bounds( QPointF point, QgsSymbolRenderContext &context ) override;


  private:


    QString mFontFamily;

    QString mFontStyle;

    QFont mFont;

    std::unique_ptr< QFontMetrics >mFontMetrics;


    QString mString;


    double mChrWidth = 0;

    QPointF mChrOffset;

    double mFontSizeScale = 1.0;

    double mOrigSize;


    QColor mStrokeColor;

    double mStrokeWidth;

    Qgis::RenderUnit mStrokeWidthUnit;

    QgsMapUnitScale mStrokeWidthMapUnitScale;

    Qt::PenJoinStyle mPenJoinStyle;


    QPen mPen;

    QBrush mBrush;


    bool mUseCachedPath = false;

    QPainterPath mCachedPath;


    // If font has a zero (or nearly zero) size, we skip rendering altogether..

    bool mNonZeroFontSize = true;


    QString characterToRender( QgsSymbolRenderContext &context, QPointF &charOffset, double &charWidth );

    void calculateOffsetAndRotation( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedRotation, QPointF &offset, double &angle ) const;

    double calculateSize( QgsSymbolRenderContext &context );

};


class CORE_EXPORT QgsAnimatedMarkerSymbolLayer : public QgsRasterMarkerSymbolLayer

{

  public:


    QgsAnimatedMarkerSymbolLayer( const QString &path = QString(),

                                  double size = DEFAULT_RASTERMARKER_SIZE,

                                  double angle = DEFAULT_RASTERMARKER_ANGLE );


    ~QgsAnimatedMarkerSymbolLayer() override;


    // static stuff


    static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) SIP_FACTORY; // cppcheck-suppress duplInheritedMember


    // implemented from base classes


    QString layerType() const override;

    QVariantMap properties() const override;

    QgsAnimatedMarkerSymbolLayer *clone() const override SIP_FACTORY;


    void setFrameRate( double rate ) { mFrameRateFps = rate; }


    double frameRate() const { return mFrameRateFps; }


    void startRender( QgsSymbolRenderContext &context ) override;


  protected:

    QImage fetchImage( QgsRenderContext &context, const QString &path, QSize size, bool preserveAspectRatio, double opacity ) const override SIP_SKIP;


  private:

    double mFrameRateFps = 10;

    bool mStaticPath = false;

    mutable QSet< QString > mPreparedPaths;


};


// clazy:excludeall=qstring-allocations


#endif


Qgis
Provides global constants and enumerations for use throughout the application.
Definition qgis.h:54

Qgis::ScaleMethod
ScaleMethod
Scale methods.
Definition qgis.h:588

Qgis::MarkerShape
MarkerShape
Marker shapes.
Definition qgis.h:3009

Qgis::MarkerShape::Circle
@ Circle
Circle.

Qgis::RenderUnit
RenderUnit
Rendering size units.
Definition qgis.h:5064

Qgis::RenderUnit::Millimeters
@ Millimeters
Millimeters.

QgsAnimatedMarkerSymbolLayer
Animated marker symbol layer class.
Definition qgsmarkersymbollayer.h:1104

QgsAnimatedMarkerSymbolLayer::~QgsAnimatedMarkerSymbolLayer
~QgsAnimatedMarkerSymbolLayer() override

QgsAnimatedMarkerSymbolLayer::frameRate
double frameRate() const
Returns the marker frame rate in frame per second.
Definition qgsmarkersymbollayer.h:1141

QgsDxfExport
Exports QGIS layers to the DXF format.
Definition qgsdxfexport.h:69

QgsFeature
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58

QgsFillSymbol
A fill symbol type, for rendering Polygon and MultiPolygon geometries.
Definition qgsfillsymbol.h:30

QgsFilledMarkerSymbolLayer
Filled marker symbol layer, consisting of a shape which is rendered using a QgsFillSymbol.
Definition qgsmarkersymbollayer.h:437

QgsFilledMarkerSymbolLayer::~QgsFilledMarkerSymbolLayer
~QgsFilledMarkerSymbolLayer() override

QgsFontMarkerSymbolLayer
A marker symbol layer which displays characters rendered using a font.
Definition qgsmarkersymbollayer.h:878

QgsFontMarkerSymbolLayer::setStrokeWidthUnit
void setStrokeWidthUnit(Qgis::RenderUnit unit)
Sets the stroke width unit.
Definition qgsmarkersymbollayer.h:1017

QgsFontMarkerSymbolLayer::~QgsFontMarkerSymbolLayer
~QgsFontMarkerSymbolLayer() override

QgsFontMarkerSymbolLayer::setStrokeColor
void setStrokeColor(const QColor &color) override
Sets the stroke color for the symbol layer.
Definition qgsmarkersymbollayer.h:978

QgsFontMarkerSymbolLayer::setStrokeWidthMapUnitScale
void setStrokeWidthMapUnitScale(const QgsMapUnitScale &scale)
Sets the stroke width map unit scale.
Definition qgsmarkersymbollayer.h:1037

QgsFontMarkerSymbolLayer::strokeWidthUnit
Qgis::RenderUnit strokeWidthUnit() const
Returns the stroke width unit.
Definition qgsmarkersymbollayer.h:1008

QgsFontMarkerSymbolLayer::strokeWidth
double strokeWidth() const
Returns the marker's stroke width.
Definition qgsmarkersymbollayer.h:988

QgsFontMarkerSymbolLayer::setFontStyle
void setFontStyle(const QString &style)
Sets the font style for the font which will be used to render the point.
Definition qgsmarkersymbollayer.h:961

QgsFontMarkerSymbolLayer::fontStyle
QString fontStyle() const
Returns the font style for the associated font which will be used to render the point.
Definition qgsmarkersymbollayer.h:953

QgsFontMarkerSymbolLayer::strokeColor
QColor strokeColor() const override
Returns the stroke color for the symbol layer.
Definition qgsmarkersymbollayer.h:977

QgsFontMarkerSymbolLayer::setCharacter
void setCharacter(QString chr)
Sets the character(s) used when rendering points.
Definition qgsmarkersymbollayer.h:975

QgsFontMarkerSymbolLayer::setFontFamily
void setFontFamily(const QString &family)
Sets the font family for the font which will be used to render the point.
Definition qgsmarkersymbollayer.h:945

QgsFontMarkerSymbolLayer::setStrokeWidth
void setStrokeWidth(double width)
Set's the marker's stroke width.
Definition qgsmarkersymbollayer.h:998

QgsFontMarkerSymbolLayer::setPenJoinStyle
void setPenJoinStyle(Qt::PenJoinStyle style)
Sets the stroke join style.
Definition qgsmarkersymbollayer.h:1053

QgsFontMarkerSymbolLayer::strokeWidthMapUnitScale
const QgsMapUnitScale & strokeWidthMapUnitScale() const
Returns the stroke width map unit scale.
Definition qgsmarkersymbollayer.h:1027

QgsFontMarkerSymbolLayer::penJoinStyle
Qt::PenJoinStyle penJoinStyle() const
Returns the stroke join style.
Definition qgsmarkersymbollayer.h:1045

QgsFontMarkerSymbolLayer::character
QString character() const
Returns the character(s) used when rendering points.
Definition qgsmarkersymbollayer.h:968

QgsMapUnitScale
Struct for storing maximum and minimum scales for measurements in map units.
Definition qgsmapunitscale.h:37

QgsMarkerSymbolLayer
Abstract base class for marker symbol layers.
Definition qgssymbollayer.h:779

QgsMarkerSymbolLayer::bounds
virtual QRectF bounds(QPointF point, QgsSymbolRenderContext &context)=0
Returns the approximate bounding box of the marker symbol layer, taking into account any data defined...

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

QgsMarkerSymbolLayer::renderPoint
virtual void renderPoint(QPointF point, QgsSymbolRenderContext &context)=0
Renders a marker at the specified point.

QgsMarkerSymbolLayer::mapUnitScale
QgsMapUnitScale mapUnitScale() const override
Definition qgssymbollayer.cpp:761

QgsMarkerSymbolLayer::stopRender
void stopRender(QgsSymbolRenderContext &context) override
Called after a set of rendering operations has finished on the supplied render context.
Definition qgssymbollayer.cpp:575

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

QgsMarkerSymbolLayer::startRender
void startRender(QgsSymbolRenderContext &context) override
Called before a set of rendering operations commences on the supplied render context.
Definition qgssymbollayer.cpp:570

QgsMarkerSymbolLayer::setMapUnitScale
void setMapUnitScale(const QgsMapUnitScale &scale) override
Definition qgssymbollayer.cpp:755

QgsPathResolver
Resolves relative paths into absolute paths and vice versa.
Definition qgspathresolver.h:32

QgsRasterMarkerSymbolLayer
Raster marker symbol layer class.
Definition qgsmarkersymbollayer.h:692

QgsRasterMarkerSymbolLayer::setOpacity
void setOpacity(double opacity)
Set the marker opacity.
Definition qgsmarkersymbollayer.h:770

QgsRasterMarkerSymbolLayer::defaultAspectRatio
double defaultAspectRatio() const
Returns the default marker aspect ratio between width and height, 0 if not yet calculated.
Definition qgsmarkersymbollayer.h:776

QgsRasterMarkerSymbolLayer::setFixedAspectRatio
void setFixedAspectRatio(double ratio)
Set the marker aspect ratio between width and height to be used in rendering, if the value set is low...
Definition qgsmarkersymbollayer.h:814

QgsRasterMarkerSymbolLayer::preservedAspectRatio
bool preservedAspectRatio() const
Returns the preserved aspect ratio value, true if fixed aspect ratio has been lower or equal to 0.
Definition qgsmarkersymbollayer.h:789

QgsRasterMarkerSymbolLayer::~QgsRasterMarkerSymbolLayer
~QgsRasterMarkerSymbolLayer() override

QgsRasterMarkerSymbolLayer::mPath
QString mPath
Definition qgsmarkersymbollayer.h:844

QgsRasterMarkerSymbolLayer::fixedAspectRatio
double fixedAspectRatio() const
Returns the marker aspect ratio between width and height to be used in rendering, if the value set is...
Definition qgsmarkersymbollayer.h:805

QgsRasterMarkerSymbolLayer::opacity
double opacity() const
Returns the marker opacity.
Definition qgsmarkersymbollayer.h:763

QgsReadWriteContext
A container for the context for various read/write operations on objects.
Definition qgsreadwritecontext.h:34

QgsRenderContext
Contains information about the context of a rendering operation.
Definition qgsrendercontext.h:62

QgsSimpleMarkerSymbolLayerBase
Abstract base class for simple marker symbol layers.
Definition qgsmarkersymbollayer.h:48

QgsSimpleMarkerSymbolLayerBase::mShape
Qgis::MarkerShape mShape
Symbol shape.
Definition qgsmarkersymbollayer.h:157

QgsSimpleMarkerSymbolLayerBase::mPath
QPainterPath mPath
Painter path representing shape. If mPolygon is empty then the shape is stored in mPath.
Definition qgsmarkersymbollayer.h:154

QgsSimpleMarkerSymbolLayerBase::~QgsSimpleMarkerSymbolLayerBase
~QgsSimpleMarkerSymbolLayerBase() override

QgsSimpleMarkerSymbolLayerBase::mPolygon
QPolygonF mPolygon
Polygon of points in shape. If polygon is empty then shape is using mPath.
Definition qgsmarkersymbollayer.h:151

QgsSimpleMarkerSymbolLayerBase::shape
Qgis::MarkerShape shape() const
Returns the shape for the rendered marker symbol.
Definition qgsmarkersymbollayer.h:80

QgsSimpleMarkerSymbolLayerBase::setShape
void setShape(Qgis::MarkerShape shape)
Sets the rendered marker shape.
Definition qgsmarkersymbollayer.h:87

QgsSimpleMarkerSymbolLayer
Simple marker symbol layer, consisting of a rendered shape with solid fill color and a stroke.
Definition qgsmarkersymbollayer.h:178

QgsSimpleMarkerSymbolLayer::mSelPen
QPen mSelPen
QPen to use as stroke of selected symbols.
Definition qgsmarkersymbollayer.h:407

QgsSimpleMarkerSymbolLayer::mStrokeColor
QColor mStrokeColor
Stroke color.
Definition qgsmarkersymbollayer.h:386

QgsSimpleMarkerSymbolLayer::mSelCache
QImage mSelCache
Cached image of selected marker, if using cached version.
Definition qgsmarkersymbollayer.h:411

QgsSimpleMarkerSymbolLayer::mCache
QImage mCache
Cached image of marker, if using cached version.
Definition qgsmarkersymbollayer.h:405

QgsSimpleMarkerSymbolLayer::mSelBrush
QBrush mSelBrush
QBrush to use as fill of selected symbols.
Definition qgsmarkersymbollayer.h:409

QgsSimpleMarkerSymbolLayer::setFillColor
void setFillColor(const QColor &color) override
Sets the fill color for the symbol layer.
Definition qgsmarkersymbollayer.h:239

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

QgsSimpleMarkerSymbolLayer::mPen
QPen mPen
QPen corresponding to marker's stroke style.
Definition qgsmarkersymbollayer.h:400

QgsSimpleMarkerSymbolLayer::setStrokeWidthUnit
void setStrokeWidthUnit(Qgis::RenderUnit u)
Sets the unit for the width of the marker's stroke.
Definition qgsmarkersymbollayer.h:342

QgsSimpleMarkerSymbolLayer::~QgsSimpleMarkerSymbolLayer
~QgsSimpleMarkerSymbolLayer() override

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

QgsSimpleMarkerSymbolLayer::setStrokeWidthMapUnitScale
void setStrokeWidthMapUnitScale(const QgsMapUnitScale &scale)
Sets the map scale for the width of the marker's stroke.
Definition qgsmarkersymbollayer.h:359

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

QgsSimpleMarkerSymbolLayer::strokeWidthMapUnitScale
const QgsMapUnitScale & strokeWidthMapUnitScale() const
Returns the map scale for the width of the marker's stroke.
Definition qgsmarkersymbollayer.h:367

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

QgsSimpleMarkerSymbolLayer::strokeColor
QColor strokeColor() const override
Returns the marker's stroke color.
Definition qgsmarkersymbollayer.h:251

QgsSimpleMarkerSymbolLayer::mBrush
QBrush mBrush
QBrush corresponding to marker's fill style.
Definition qgsmarkersymbollayer.h:402

QgsSimpleMarkerSymbolLayer::setStrokeWidth
void setStrokeWidth(double w)
Sets the width of the marker's stroke.
Definition qgsmarkersymbollayer.h:333

QgsSimpleMarkerSymbolLayer::setStrokeColor
void setStrokeColor(const QColor &color) override
Sets the marker's stroke color.
Definition qgsmarkersymbollayer.h:260

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

QgsSimpleMarkerSymbolLayer::strokeWidthUnit
Qgis::RenderUnit strokeWidthUnit() const
Returns the unit for the width of the marker's stroke.
Definition qgsmarkersymbollayer.h:350

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

QgsSimpleMarkerSymbolLayer::mStrokeWidthMapUnitScale
QgsMapUnitScale mStrokeWidthMapUnitScale
Stroke width map unit scale.
Definition qgsmarkersymbollayer.h:394

QgsSimpleMarkerSymbolLayer::strokeWidth
double strokeWidth() const
Returns the width of the marker's stroke.
Definition qgsmarkersymbollayer.h:324

QgsSimpleMarkerSymbolLayer::mPenJoinStyle
Qt::PenJoinStyle mPenJoinStyle
Stroke pen join style.
Definition qgsmarkersymbollayer.h:396

QgsSldExportContext
Holds SLD export options and other information related to SLD export of a QGIS layer style.
Definition qgssldexportcontext.h:29

QgsSvgMarkerSymbolLayer
A marker symbol layer which renders an SVG graphic.
Definition qgsmarkersymbollayer.h:501

QgsSvgMarkerSymbolLayer::fillColor
QColor fillColor() const override
Returns the fill color for the symbol layer.
Definition qgsmarkersymbollayer.h:596

QgsSvgMarkerSymbolLayer::strokeWidthMapUnitScale
const QgsMapUnitScale & strokeWidthMapUnitScale() const
Definition qgsmarkersymbollayer.h:631

QgsSvgMarkerSymbolLayer::setStrokeWidthMapUnitScale
void setStrokeWidthMapUnitScale(const QgsMapUnitScale &scale)
Definition qgsmarkersymbollayer.h:630

QgsSvgMarkerSymbolLayer::preservedAspectRatio
bool preservedAspectRatio() const
Returns the preserved aspect ratio value, true if fixed aspect ratio has been lower or equal to 0.
Definition qgsmarkersymbollayer.h:569

QgsSvgMarkerSymbolLayer::setStrokeWidth
void setStrokeWidth(double w)
Definition qgsmarkersymbollayer.h:603

QgsSvgMarkerSymbolLayer::mParameters
QMap< QString, QgsProperty > mParameters
Definition qgsmarkersymbollayer.h:668

QgsSvgMarkerSymbolLayer::mStrokeWidth
double mStrokeWidth
Definition qgsmarkersymbollayer.h:667

QgsSvgMarkerSymbolLayer::setStrokeWidthUnit
void setStrokeWidthUnit(Qgis::RenderUnit unit)
Sets the units for the stroke width.
Definition qgsmarkersymbollayer.h:622

QgsSvgMarkerSymbolLayer::fixedAspectRatio
double fixedAspectRatio() const
Returns the marker aspect ratio between width and height to be used in rendering, if the value set is...
Definition qgsmarkersymbollayer.h:585

QgsSvgMarkerSymbolLayer::setStrokeColor
void setStrokeColor(const QColor &c) override
Sets the stroke color for the symbol layer.
Definition qgsmarkersymbollayer.h:600

QgsSvgMarkerSymbolLayer::strokeColor
QColor strokeColor() const override
Returns the stroke color for the symbol layer.
Definition qgsmarkersymbollayer.h:599

QgsSvgMarkerSymbolLayer::setFillColor
void setFillColor(const QColor &color) override
Sets the fill color for the symbol layer.
Definition qgsmarkersymbollayer.h:597

QgsSvgMarkerSymbolLayer::strokeWidth
double strokeWidth() const
Definition qgsmarkersymbollayer.h:602

QgsSvgMarkerSymbolLayer::strokeWidthUnit
Qgis::RenderUnit strokeWidthUnit() const
Returns the units for the stroke width.
Definition qgsmarkersymbollayer.h:628

QgsSvgMarkerSymbolLayer::mStrokeColor
QColor mStrokeColor
Definition qgsmarkersymbollayer.h:666

QgsSvgMarkerSymbolLayer::mPath
QString mPath
Definition qgsmarkersymbollayer.h:657

QgsSvgMarkerSymbolLayer::~QgsSvgMarkerSymbolLayer
~QgsSvgMarkerSymbolLayer() override

QgsSvgMarkerSymbolLayer::parameters
QMap< QString, QgsProperty > parameters() const
Returns the dynamic SVG parameters.
Definition qgsmarkersymbollayer.h:609

QgsSvgMarkerSymbolLayer::mStrokeWidthMapUnitScale
QgsMapUnitScale mStrokeWidthMapUnitScale
Definition qgsmarkersymbollayer.h:671

QgsSvgMarkerSymbolLayer::mStrokeWidthUnit
Qgis::RenderUnit mStrokeWidthUnit
Definition qgsmarkersymbollayer.h:670

QgsSvgMarkerSymbolLayer::setFixedAspectRatio
void setFixedAspectRatio(double ratio)
Set the marker aspect ratio between width and height to be used in rendering, if the value set is low...
Definition qgsmarkersymbollayer.h:594

QgsSvgMarkerSymbolLayer::defaultAspectRatio
double defaultAspectRatio() const
Returns the default marker aspect ratio between width and height, 0 if not yet calculated.
Definition qgsmarkersymbollayer.h:556

QgsSymbolLayer
Abstract base class for symbol layers.
Definition qgssymbollayer.h:57

QgsSymbolLayer::usedAttributes
virtual QSet< QString > usedAttributes(const QgsRenderContext &context) const
Returns the set of attributes referenced by the layer.
Definition qgssymbollayer.cpp:353

QgsSymbolLayer::mColor
QColor mColor
Definition qgssymbollayer.h:706

QgsSymbolLayer::prepareExpressions
virtual void prepareExpressions(const QgsSymbolRenderContext &context)
Prepares all data defined property expressions for evaluation.
Definition qgssymbollayer.cpp:301

QgsSymbolLayer::setColor
virtual void setColor(const QColor &color)
Sets the "representative" color for the symbol layer.
Definition qgssymbollayer.cpp:277

QgsSymbolLayer::color
virtual QColor color() const
Returns the "representative" color of the symbol layer.
Definition qgssymbollayer.cpp:272

QgsSymbolLayer::writeDxf
virtual bool writeDxf(QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const
write as DXF
Definition qgssymbollayer.cpp:157

QgsSymbolRenderContext
Encapsulates the context in which a symbol is being rendered.
Definition qgssymbolrendercontext.h:35

QgsSymbol
Abstract base class for all rendered symbols.
Definition qgssymbol.h:231

c
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
Definition porting_processing.dox:1

qgis_sip.h

SIP_DEPRECATED
#define SIP_DEPRECATED
Definition qgis_sip.h:114

SIP_FORCE
#define SIP_FORCE
Definition qgis_sip.h:139

SIP_SKIP
#define SIP_SKIP
Definition qgis_sip.h:134

SIP_TRANSFER
#define SIP_TRANSFER
Definition qgis_sip.h:36

SIP_FACTORY
#define SIP_FACTORY
Definition qgis_sip.h:84

DEFAULT_RASTERMARKER_ANGLE
#define DEFAULT_RASTERMARKER_ANGLE
Definition qgsmarkersymbollayer.h:683

DEFAULT_RASTERMARKER_SIZE
#define DEFAULT_RASTERMARKER_SIZE
Definition qgsmarkersymbollayer.h:682

DEFAULT_SVGMARKER_ANGLE
#define DEFAULT_SVGMARKER_ANGLE
Definition qgsmarkersymbollayer.h:493

DEFAULT_SIMPLEMARKER_JOINSTYLE
#define DEFAULT_SIMPLEMARKER_JOINSTYLE
Definition qgsmarkersymbollayer.h:26

DEFAULT_FONTMARKER_CHR
#define DEFAULT_FONTMARKER_CHR
Definition qgsmarkersymbollayer.h:865

DEFAULT_SIMPLEMARKER_BORDERCOLOR
#define DEFAULT_SIMPLEMARKER_BORDERCOLOR
Definition qgsmarkersymbollayer.h:25

DEFAULT_SIMPLEMARKER_SIZE
#define DEFAULT_SIMPLEMARKER_SIZE
Definition qgsmarkersymbollayer.h:27

DEFAULT_SIMPLEMARKER_ANGLE
#define DEFAULT_SIMPLEMARKER_ANGLE
Definition qgsmarkersymbollayer.h:28

DEFAULT_SVGMARKER_SIZE
#define DEFAULT_SVGMARKER_SIZE
Definition qgsmarkersymbollayer.h:492

DEFAULT_FONTMARKER_FONT
#define DEFAULT_FONTMARKER_FONT
Definition qgsmarkersymbollayer.h:864

DEFAULT_FONTMARKER_ANGLE
#define DEFAULT_FONTMARKER_ANGLE
Definition qgsmarkersymbollayer.h:870

DEFAULT_FONTMARKER_COLOR
#define DEFAULT_FONTMARKER_COLOR
Definition qgsmarkersymbollayer.h:867

DEFAULT_FONTMARKER_SIZE
#define DEFAULT_FONTMARKER_SIZE
Definition qgsmarkersymbollayer.h:866

DEFAULT_SIMPLEMARKER_COLOR
#define DEFAULT_SIMPLEMARKER_COLOR
Definition qgsmarkersymbollayer.h:24

qgssymbollayer.h

DEFAULT_SCALE_METHOD
#define DEFAULT_SCALE_METHOD
Definition qgssymbollayer.h:19