qgsellipsesymbollayer.h

Go to the documentation of this file.

/***************************************************************************
 qgsellipsesymbollayer.h
 ---------------------
 begin                : June 2011
 copyright            : (C) 2011 by Marco Hugentobler
 email                : marco dot hugentobler at sourcepole dot ch
 ***************************************************************************
 *                                                                         *
 *   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 QGSELLIPSESYMBOLLAYER_H
#define QGSELLIPSESYMBOLLAYER_H
 
#define DEFAULT_ELLIPSE_JOINSTYLE    Qt::MiterJoin
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgsmarkersymbollayer.h"
 
#include <QPainterPath>
 
class QgsExpression;

class CORE_EXPORT QgsEllipseSymbolLayer: public QgsMarkerSymbolLayer
{
  public:

    enum Shape
    {
      Circle, 
      Rectangle, 
      Diamond, 
      Cross, 
      Arrow, 
      HalfArc, 
      Triangle, 
      RightHalfTriangle, 
      LeftHalfTriangle, 
      SemiCircle, 
      ThirdCircle, 
      QuarterCircle, 
      Pentagon, 
      Hexagon, 
      Octagon, 
      Star, 
    };

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

    static bool shapeIsFilled( const QgsEllipseSymbolLayer::Shape &shape );
 
    QgsEllipseSymbolLayer();
    ~QgsEllipseSymbolLayer() override;

    static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) SIP_FACTORY;
    static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;
 
    void renderPoint( QPointF point, QgsSymbolRenderContext &context ) override;
    QString layerType() const override;
    Qgis::SymbolLayerFlags flags() const override;
    void startRender( QgsSymbolRenderContext &context ) override;
    void stopRender( QgsSymbolRenderContext &context ) override;
    QgsEllipseSymbolLayer *clone() const override SIP_FACTORY;
    QVariantMap properties() const override;
    Q_DECL_DEPRECATED void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props = QVariantMap() ) 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 writeDxf( QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift = QPointF( 0.0, 0.0 ) ) const override;

    Q_DECL_DEPRECATED void setSymbolName( const QString &name ) SIP_DEPRECATED { mShape = decodeShape( name ); }

    Q_DECL_DEPRECATED QString symbolName() const SIP_DEPRECATED { return encodeShape( mShape ); }

    QgsEllipseSymbolLayer::Shape shape() const { return mShape; }

    void setShape( QgsEllipseSymbolLayer::Shape shape ) { mShape = shape; }

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

    static QString encodeShape( QgsEllipseSymbolLayer::Shape shape );
 
    void setSize( double size ) override;
 
    void setSymbolWidth( double w );
    double symbolWidth() const { return mSymbolWidth; }
 
    void setSymbolHeight( double h );
    double symbolHeight() const { return mSymbolHeight; }
 
    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; }
 
    void setStrokeWidth( double w ) { mStrokeWidth = w; }
    double strokeWidth() const { return mStrokeWidth; }
 
    void setFillColor( const QColor &c ) override { setColor( c ); }
    QColor fillColor() const override { return color(); }
 
    void setStrokeColor( const QColor &c ) override { mStrokeColor = c; }
    QColor strokeColor() const override { return mStrokeColor; }

    void setSymbolWidthUnit( Qgis::RenderUnit unit ) { mSymbolWidthUnit = unit; }

    Qgis::RenderUnit symbolWidthUnit() const { return mSymbolWidthUnit; }
 
    void setSymbolWidthMapUnitScale( const QgsMapUnitScale &scale ) { mSymbolWidthMapUnitScale = scale; }
    const QgsMapUnitScale &symbolWidthMapUnitScale() const { return mSymbolWidthMapUnitScale; }

    void setSymbolHeightUnit( Qgis::RenderUnit unit ) { mSymbolHeightUnit = unit; }

    Qgis::RenderUnit symbolHeightUnit() const { return mSymbolHeightUnit; }
 
    void setSymbolHeightMapUnitScale( const QgsMapUnitScale &scale ) { mSymbolHeightMapUnitScale = scale; }
    const QgsMapUnitScale &symbolHeightMapUnitScale() const { return mSymbolHeightMapUnitScale; }

    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;
    bool usesMapUnits() const override;
 
    void setMapUnitScale( const QgsMapUnitScale &scale ) override;
    QgsMapUnitScale mapUnitScale() const override;
 
    QRectF bounds( QPointF point, QgsSymbolRenderContext &context ) override;
 
  private:
    Shape mShape = Circle;
    double mSymbolWidth = 4;
    Qgis::RenderUnit mSymbolWidthUnit = Qgis::RenderUnit::Millimeters;
    QgsMapUnitScale mSymbolWidthMapUnitScale;
    double mSymbolHeight = 3;
    Qgis::RenderUnit mSymbolHeightUnit = Qgis::RenderUnit::Millimeters;
    QgsMapUnitScale mSymbolHeightMapUnitScale;
    QColor mStrokeColor;
    Qt::PenStyle mStrokeStyle = Qt::SolidLine;
    Qt::PenJoinStyle mPenJoinStyle = DEFAULT_ELLIPSE_JOINSTYLE;
    Qt::PenCapStyle mPenCapStyle = Qt::SquareCap;
    double mStrokeWidth = 0;
    Qgis::RenderUnit mStrokeWidthUnit = Qgis::RenderUnit::Millimeters;
    QgsMapUnitScale mStrokeWidthMapUnitScale;
 
    QPainterPath mPainterPath;
 
    QPen mPen;
    QBrush mBrush;
    QPen mSelPen;
    QBrush mSelBrush;

    void preparePath( const QgsEllipseSymbolLayer::Shape &shape, QgsSymbolRenderContext &context, double *scaledWidth = nullptr, double *scaledHeight = nullptr, const QgsFeature *f = nullptr );
    QSizeF calculateSize( QgsSymbolRenderContext &context, double *scaledWidth = nullptr, double *scaledHeight = nullptr );
    void calculateOffsetAndRotation( QgsSymbolRenderContext &context, double scaledWidth, double scaledHeight, bool &hasDataDefinedRotation, QPointF &offset, double &angle ) const;
};
 
// clazy:excludeall=qstring-allocations
 
#endif // QGSELLIPSESYMBOLLAYER_H