qgsmapclippingregion.h

Go to the documentation of this file.

/***************************************************************************
  qgsmapclippingregion.h
  --------------------------------------
  Date                 : June 2020
  Copyright            : (C) 2020 by Nyall Dawson
  Email                : nyall dot dawson 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 QGSMAPCLIPPINGREGION_H
#define QGSMAPCLIPPINGREGION_H
 
#include "qgis_core.h"
#include "qgsgeometry.h"
#include "qgsmaplayer.h"
 
#include <QPointer>

class CORE_EXPORT QgsMapClippingRegion
{
  public:
    enum class FeatureClippingType : int
    {
      ClipToIntersection, 
      ClipPainterOnly,    
      NoClipping,         
    };

    explicit QgsMapClippingRegion( const QgsGeometry &geometry )
      : mGeometry( geometry )
    {}

    QgsGeometry geometry() const;

    void setGeometry( const QgsGeometry &geometry );

    FeatureClippingType featureClip() const { return mFeatureClip; }

    void setFeatureClip( FeatureClippingType type ) { mFeatureClip = type; }

    bool restrictToLayers() const;

    void setRestrictToLayers( bool enabled );

    void setRestrictedLayers( const QList< QgsMapLayer * > &layers );

    QList< QgsMapLayer * > restrictedLayers() const;

    bool appliesToLayer( const QgsMapLayer *layer ) const;
 
  private:
    QgsGeometry mGeometry;
 
    bool mRestrictToLayers = false;
    QgsWeakMapLayerPointerList mRestrictToLayersList;
 
    FeatureClippingType mFeatureClip = FeatureClippingType::ClipToIntersection;
};
 
#endif // QGSMAPCLIPPINGREGION_H