qgsmasksymbollayer.h

Go to the documentation of this file.

/***************************************************************************
 qgsmasksymbollayer.h
 ---------------------
 begin                : July 2019
 copyright            : (C) 2019 by Hugo Mercier
 email                : hugo dot mercier at oslandia 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 QGSMASKSYMBOLLAYER_H
#define QGSMASKSYMBOLLAYER_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgssymbollayer.h"
 
class QgsPaintEffect;
class QgsMarkerSymbol;
class QgsSymbolLayerReference;

 
class CORE_EXPORT QgsMaskMarkerSymbolLayer : public QgsMarkerSymbolLayer
{
  public:
    QgsMaskMarkerSymbolLayer();
 
    ~QgsMaskMarkerSymbolLayer() override;

    static QgsSymbolLayer *create( const QVariantMap &properties = QVariantMap() ) SIP_FACTORY;
 
    QgsMaskMarkerSymbolLayer *clone() const override SIP_FACTORY;
    QgsSymbol *subSymbol() override;
    bool setSubSymbol( QgsSymbol *symbol SIP_TRANSFER ) override;
    QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;
    bool hasDataDefinedProperties() const override;
 
    QVariantMap properties() const override;
 
    QString layerType() const override;
    void startRender( QgsSymbolRenderContext &context ) override;
    void stopRender( QgsSymbolRenderContext &context ) override;
    void renderPoint( QPointF point, QgsSymbolRenderContext &context ) override;
    QRectF bounds( QPointF point, QgsSymbolRenderContext &context ) override;
    bool usesMapUnits() const override;
    void setOutputUnit( Qgis::RenderUnit unit ) override;
    QColor color() const override;
 
    void drawPreviewIcon( QgsSymbolRenderContext &context, QSize size ) override;
 
    // TODO QGIS 4.0 rename to avoid collision with base class member

    bool enabled() const; // cppcheck-suppress duplInheritedMember

    QList<QgsSymbolLayerReference> masks() const override;

    void clearMasks();

    void setMasks( const QList<QgsSymbolLayerReference> &maskedLayers );
 
  private:
#ifdef SIP_RUN
    QgsMaskMarkerSymbolLayer( const QgsMaskMarkerSymbolLayer & );
#endif

    std::unique_ptr<QgsMarkerSymbol> mSymbol;

    QList<QgsSymbolLayerReference> mMaskedSymbolLayers;
 
    std::unique_ptr<QgsPaintEffect> mEffect;
};
 
#endif